git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MPU_M33F_NXP_LPC55S69_MCUXpresso/NXP_Code/drivers/fsl_flexcomm.h

   1 /*\r
   2  * Copyright (c) 2016, Freescale Semiconductor, Inc.\r
   3  * Copyright 2016-2019 NXP\r
   4  * All rights reserved.\r
   5  *\r
   6  * SPDX-License-Identifier: BSD-3-Clause\r
   7  */\r
   8 #ifndef _FSL_FLEXCOMM_H_\r
   9 #define _FSL_FLEXCOMM_H_\r
  10 \r
  11 #include "fsl_common.h"\r
  12 \r
  13 /*!\r
  14  * @addtogroup flexcomm_driver\r
  15  * @{\r
  16  */\r
  17 \r
  18 /*! @name Driver version */\r
  19 /*@{*/\r
  20 /*! @brief FlexCOMM driver version 2.0.2. */\r
  21 #define FSL_FLEXCOMM_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))\r
  22 /*@}*/\r
  23 \r
  24 /*! @brief FLEXCOMM peripheral modes. */\r
  25 typedef enum\r
  26 {\r
  27     FLEXCOMM_PERIPH_NONE,   /*!< No peripheral */\r
  28     FLEXCOMM_PERIPH_USART,  /*!< USART peripheral */\r
  29     FLEXCOMM_PERIPH_SPI,    /*!< SPI Peripheral */\r
  30     FLEXCOMM_PERIPH_I2C,    /*!< I2C Peripheral */\r
  31     FLEXCOMM_PERIPH_I2S_TX, /*!< I2S TX Peripheral */\r
  32     FLEXCOMM_PERIPH_I2S_RX, /*!< I2S RX Peripheral */\r
  33 } FLEXCOMM_PERIPH_T;\r
  34 \r
  35 /*! @brief Typedef for interrupt handler. */\r
  36 typedef void (*flexcomm_irq_handler_t)(void *base, void *handle);\r
  37 \r
  38 /*! @brief Array with IRQ number for each FLEXCOMM module. */\r
  39 extern IRQn_Type const kFlexcommIrqs[];\r
  40 \r
  41 /*******************************************************************************\r
  42  * API\r
  43  ******************************************************************************/\r
  44 #if defined(__cplusplus)\r
  45 extern "C" {\r
  46 #endif\r
  47 \r
  48 /*! @brief Returns instance number for FLEXCOMM module with given base address. */\r
  49 uint32_t FLEXCOMM_GetInstance(void *base);\r
  50 \r
  51 /*! @brief Initializes FLEXCOMM and selects peripheral mode according to the second parameter. */\r
  52 status_t FLEXCOMM_Init(void *base, FLEXCOMM_PERIPH_T periph);\r
  53 \r
  54 /*! @brief Sets IRQ handler for given FLEXCOMM module. It is used by drivers register IRQ handler according to FLEXCOMM\r
  55  * mode */\r
  56 void FLEXCOMM_SetIRQHandler(void *base, flexcomm_irq_handler_t handler, void *handle);\r
  57 \r
  58 #if defined(__cplusplus)\r
  59 }\r
  60 #endif\r
  61 \r
  62 /*@}*/\r
  63 \r
  64 #endif /* _FSL_FLEXCOMM_H_*/\r