| /* |
| * Copyright (c) 2015-2016, Freescale Semiconductor, Inc. |
| * Copyright 2016-2017 NXP |
| * |
| * Redistribution and use in source and binary forms, with or without modification, |
| * are permitted provided that the following conditions are met: |
| * |
| * o Redistributions of source code must retain the above copyright notice, this list |
| * of conditions and the following disclaimer. |
| * |
| * o Redistributions in binary form must reproduce the above copyright notice, this |
| * list of conditions and the following disclaimer in the documentation and/or |
| * other materials provided with the distribution. |
| * |
| * o Neither the name of the copyright holder nor the names of its |
| * contributors may be used to endorse or promote products derived from this |
| * software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
| * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #ifndef _FSL_COMMON_H_ |
| #define _FSL_COMMON_H_ |
| |
| #include <assert.h> |
| #include <stdbool.h> |
| #include <stdint.h> |
| #include <string.h> |
| |
| #if defined(__ICCARM__) |
| #include <stddef.h> |
| #endif |
| |
| #include "fsl_device_registers.h" |
| |
| /*! |
| * @addtogroup ksdk_common |
| * @{ |
| */ |
| |
| /******************************************************************************* |
| * Definitions |
| ******************************************************************************/ |
| |
| /*! @brief Construct a status code value from a group and code number. */ |
| #define MAKE_STATUS(group, code) ((((group)*100) + (code))) |
| |
| /*! @brief Construct the version number for drivers. */ |
| #define MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix)) |
| |
| /* Debug console type definition. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_NONE 0U /*!< No debug console. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_UART 1U /*!< Debug console base on UART. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_LPUART 2U /*!< Debug console base on LPUART. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_LPSCI 3U /*!< Debug console base on LPSCI. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_USBCDC 4U /*!< Debug console base on USBCDC. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_FLEXCOMM 5U /*!< Debug console base on USBCDC. */ |
| #define DEBUG_CONSOLE_DEVICE_TYPE_IUART 6U /*!< Debug console base on i.MX UART. */ |
| |
| /*! @brief Status group numbers. */ |
| enum _status_groups |
| { |
| kStatusGroup_Generic = 0, /*!< Group number for generic status codes. */ |
| kStatusGroup_FLASH = 1, /*!< Group number for FLASH status codes. */ |
| kStatusGroup_LPSPI = 4, /*!< Group number for LPSPI status codes. */ |
| kStatusGroup_FLEXIO_SPI = 5, /*!< Group number for FLEXIO SPI status codes. */ |
| kStatusGroup_DSPI = 6, /*!< Group number for DSPI status codes. */ |
| kStatusGroup_FLEXIO_UART = 7, /*!< Group number for FLEXIO UART status codes. */ |
| kStatusGroup_FLEXIO_I2C = 8, /*!< Group number for FLEXIO I2C status codes. */ |
| kStatusGroup_LPI2C = 9, /*!< Group number for LPI2C status codes. */ |
| kStatusGroup_UART = 10, /*!< Group number for UART status codes. */ |
| kStatusGroup_I2C = 11, /*!< Group number for UART status codes. */ |
| kStatusGroup_LPSCI = 12, /*!< Group number for LPSCI status codes. */ |
| kStatusGroup_LPUART = 13, /*!< Group number for LPUART status codes. */ |
| kStatusGroup_SPI = 14, /*!< Group number for SPI status code.*/ |
| kStatusGroup_XRDC = 15, /*!< Group number for XRDC status code.*/ |
| kStatusGroup_SEMA42 = 16, /*!< Group number for SEMA42 status code.*/ |
| kStatusGroup_SDHC = 17, /*!< Group number for SDHC status code */ |
| kStatusGroup_SDMMC = 18, /*!< Group number for SDMMC status code */ |
| kStatusGroup_SAI = 19, /*!< Group number for SAI status code */ |
| kStatusGroup_MCG = 20, /*!< Group number for MCG status codes. */ |
| kStatusGroup_SCG = 21, /*!< Group number for SCG status codes. */ |
| kStatusGroup_SDSPI = 22, /*!< Group number for SDSPI status codes. */ |
| kStatusGroup_FLEXIO_I2S = 23, /*!< Group number for FLEXIO I2S status codes */ |
| kStatusGroup_FLEXIO_MCULCD = 24, /*!< Group number for FLEXIO LCD status codes */ |
| kStatusGroup_FLASHIAP = 25, /*!< Group number for FLASHIAP status codes */ |
| kStatusGroup_FLEXCOMM_I2C = 26, /*!< Group number for FLEXCOMM I2C status codes */ |
| kStatusGroup_I2S = 27, /*!< Group number for I2S status codes */ |
| kStatusGroup_IUART = 28, /*!< Group number for IUART status codes */ |
| kStatusGroup_SDRAMC = 35, /*!< Group number for SDRAMC status codes. */ |
| kStatusGroup_POWER = 39, /*!< Group number for POWER status codes. */ |
| kStatusGroup_ENET = 40, /*!< Group number for ENET status codes. */ |
| kStatusGroup_PHY = 41, /*!< Group number for PHY status codes. */ |
| kStatusGroup_TRGMUX = 42, /*!< Group number for TRGMUX status codes. */ |
| kStatusGroup_SMARTCARD = 43, /*!< Group number for SMARTCARD status codes. */ |
| kStatusGroup_LMEM = 44, /*!< Group number for LMEM status codes. */ |
| kStatusGroup_QSPI = 45, /*!< Group number for QSPI status codes. */ |
| kStatusGroup_DMA = 50, /*!< Group number for DMA status codes. */ |
| kStatusGroup_EDMA = 51, /*!< Group number for EDMA status codes. */ |
| kStatusGroup_DMAMGR = 52, /*!< Group number for DMAMGR status codes. */ |
| kStatusGroup_FLEXCAN = 53, /*!< Group number for FlexCAN status codes. */ |
| kStatusGroup_LTC = 54, /*!< Group number for LTC status codes. */ |
| kStatusGroup_FLEXIO_CAMERA = 55, /*!< Group number for FLEXIO CAMERA status codes. */ |
| kStatusGroup_LPC_SPI = 56, /*!< Group number for LPC_SPI status codes. */ |
| kStatusGroup_LPC_USART = 57, /*!< Group number for LPC_USART status codes. */ |
| kStatusGroup_DMIC = 58, /*!< Group number for DMIC status codes. */ |
| kStatusGroup_SDIF = 59, /*!< Group number for SDIF status codes.*/ |
| kStatusGroup_SPIFI = 60, /*!< Group number for SPIFI status codes. */ |
| kStatusGroup_OTP = 61, /*!< Group number for OTP status codes. */ |
| kStatusGroup_MCAN = 62, /*!< Group number for MCAN status codes. */ |
| kStatusGroup_CAAM = 63, /*!< Group number for CAAM status codes. */ |
| kStatusGroup_ECSPI = 64, /*!< Group number for ECSPI status codes. */ |
| kStatusGroup_USDHC = 65, /*!< Group number for USDHC status codes.*/ |
| kStatusGroup_ESAI = 69, /*!< Group number for ESAI status codes. */ |
| kStatusGroup_FLEXSPI = 70, /*!< Group number for FLEXSPI status codes. */ |
| kStatusGroup_NOTIFIER = 98, /*!< Group number for NOTIFIER status codes. */ |
| kStatusGroup_DebugConsole = 99, /*!< Group number for debug console status codes. */ |
| kStatusGroup_ApplicationRangeStart = 100, /*!< Starting number for application groups. */ |
| }; |
| |
| /*! @brief Generic status return codes. */ |
| enum _generic_status |
| { |
| kStatus_Success = MAKE_STATUS(kStatusGroup_Generic, 0), |
| kStatus_Fail = MAKE_STATUS(kStatusGroup_Generic, 1), |
| kStatus_ReadOnly = MAKE_STATUS(kStatusGroup_Generic, 2), |
| kStatus_OutOfRange = MAKE_STATUS(kStatusGroup_Generic, 3), |
| kStatus_InvalidArgument = MAKE_STATUS(kStatusGroup_Generic, 4), |
| kStatus_Timeout = MAKE_STATUS(kStatusGroup_Generic, 5), |
| kStatus_NoTransferInProgress = MAKE_STATUS(kStatusGroup_Generic, 6), |
| }; |
| |
| /*! @brief Type used for all status and error return values. */ |
| typedef int32_t status_t; |
| |
| /* |
| * The fsl_clock.h is included here because it needs MAKE_VERSION/MAKE_STATUS/status_t |
| * defined in previous of this file. |
| */ |
| #include "fsl_clock.h" |
| |
| /* |
| * Chip level peripheral reset API, for MCUs that implement peripheral reset control external to a peripheral |
| */ |
| #if ((defined(FSL_FEATURE_SOC_SYSCON_COUNT) && (FSL_FEATURE_SOC_SYSCON_COUNT > 0)) || \ |
| (defined(FSL_FEATURE_SOC_ASYNC_SYSCON_COUNT) && (FSL_FEATURE_SOC_ASYNC_SYSCON_COUNT > 0))) |
| #include "fsl_reset.h" |
| #endif |
| |
| /*! @name Min/max macros */ |
| /* @{ */ |
| #if !defined(MIN) |
| #define MIN(a, b) ((a) < (b) ? (a) : (b)) |
| #endif |
| |
| #if !defined(MAX) |
| #define MAX(a, b) ((a) > (b) ? (a) : (b)) |
| #endif |
| /* @} */ |
| |
| /*! @brief Computes the number of elements in an array. */ |
| #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) |
| |
| /*! @name UINT16_MAX/UINT32_MAX value */ |
| /* @{ */ |
| #if !defined(UINT16_MAX) |
| #define UINT16_MAX ((uint16_t)-1) |
| #endif |
| |
| #if !defined(UINT32_MAX) |
| #define UINT32_MAX ((uint32_t)-1) |
| #endif |
| /* @} */ |
| |
| /*! @name Timer utilities */ |
| /* @{ */ |
| /*! Macro to convert a microsecond period to raw count value */ |
| #define USEC_TO_COUNT(us, clockFreqInHz) (uint64_t)((uint64_t)us * clockFreqInHz / 1000000U) |
| /*! Macro to convert a raw count value to microsecond */ |
| #define COUNT_TO_USEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000000U / clockFreqInHz) |
| |
| /*! Macro to convert a millisecond period to raw count value */ |
| #define MSEC_TO_COUNT(ms, clockFreqInHz) (uint64_t)((uint64_t)ms * clockFreqInHz / 1000U) |
| /*! Macro to convert a raw count value to millisecond */ |
| #define COUNT_TO_MSEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000U / clockFreqInHz) |
| /* @} */ |
| |
| /******************************************************************************* |
| * API |
| ******************************************************************************/ |
| |
| #if defined(__cplusplus) |
| extern "C" { |
| #endif |
| |
| /*! |
| * @brief Enable specific interrupt. |
| * |
| * Enable the interrupt not routed from intmux. |
| * |
| * @param interrupt The IRQ number. |
| */ |
| static inline void EnableIRQ(IRQn_Type interrupt) |
| { |
| if (NotAvail_IRQn == interrupt) |
| { |
| return; |
| } |
| |
| #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0) |
| if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX) |
| #endif |
| { |
| #if defined(__GIC_PRIO_BITS) |
| GIC_EnableIRQ(interrupt); |
| #else |
| NVIC_EnableIRQ(interrupt); |
| #endif |
| } |
| } |
| |
| /*! |
| * @brief Disable specific interrupt. |
| * |
| * Disable the interrupt not routed from intmux. |
| * |
| * @param interrupt The IRQ number. |
| */ |
| static inline void DisableIRQ(IRQn_Type interrupt) |
| { |
| if (NotAvail_IRQn == interrupt) |
| { |
| return; |
| } |
| |
| #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0) |
| if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX) |
| #endif |
| { |
| #if defined(__GIC_PRIO_BITS) |
| GIC_DisableIRQ(interrupt); |
| #else |
| NVIC_DisableIRQ(interrupt); |
| #endif |
| } |
| } |
| |
| /*! |
| * @brief Disable the global IRQ |
| * |
| * Disable the global interrupt and return the current primask register. User is required to provided the primask |
| * register for the EnableGlobalIRQ(). |
| * |
| * @return Current primask value. |
| */ |
| static inline uint32_t DisableGlobalIRQ(void) |
| { |
| #if defined(CPSR_I_Msk) |
| uint32_t cpsr = __get_CPSR() & CPSR_I_Msk; |
| |
| __disable_irq(); |
| |
| return cpsr; |
| #else |
| uint32_t regPrimask = __get_PRIMASK(); |
| |
| __disable_irq(); |
| |
| return regPrimask; |
| #endif |
| } |
| |
| /*! |
| * @brief Enaable the global IRQ |
| * |
| * Set the primask register with the provided primask value but not just enable the primask. The idea is for the |
| * convinience of integration of RTOS. some RTOS get its own management mechanism of primask. User is required to |
| * use the EnableGlobalIRQ() and DisableGlobalIRQ() in pair. |
| * |
| * @param primask value of primask register to be restored. The primask value is supposed to be provided by the |
| * DisableGlobalIRQ(). |
| */ |
| static inline void EnableGlobalIRQ(uint32_t primask) |
| { |
| #if defined(CPSR_I_Msk) |
| __set_CPSR((__get_CPSR() & ~CPSR_I_Msk) | primask); |
| #else |
| __set_PRIMASK(primask); |
| #endif |
| } |
| |
| /*! |
| * @brief install IRQ handler |
| * |
| * @param irq IRQ number |
| * @param irqHandler IRQ handler address |
| * @return The old IRQ handler address |
| */ |
| uint32_t InstallIRQHandler(IRQn_Type irq, uint32_t irqHandler); |
| |
| #if (defined(FSL_FEATURE_SOC_SYSCON_COUNT) && (FSL_FEATURE_SOC_SYSCON_COUNT > 0)) |
| /*! |
| * @brief Enable specific interrupt for wake-up from deep-sleep mode. |
| * |
| * Enable the interrupt for wake-up from deep sleep mode. |
| * Some interrupts are typically used in sleep mode only and will not occur during |
| * deep-sleep mode because relevant clocks are stopped. However, it is possible to enable |
| * those clocks (significantly increasing power consumption in the reduced power mode), |
| * making these wake-ups possible. |
| * |
| * @note This function also enables the interrupt in the NVIC (EnableIRQ() is called internally). |
| * |
| * @param interrupt The IRQ number. |
| */ |
| void EnableDeepSleepIRQ(IRQn_Type interrupt); |
| |
| /*! |
| * @brief Disable specific interrupt for wake-up from deep-sleep mode. |
| * |
| * Disable the interrupt for wake-up from deep sleep mode. |
| * Some interrupts are typically used in sleep mode only and will not occur during |
| * deep-sleep mode because relevant clocks are stopped. However, it is possible to enable |
| * those clocks (significantly increasing power consumption in the reduced power mode), |
| * making these wake-ups possible. |
| * |
| * @note This function also disables the interrupt in the NVIC (DisableIRQ() is called internally). |
| * |
| * @param interrupt The IRQ number. |
| */ |
| void DisableDeepSleepIRQ(IRQn_Type interrupt); |
| #endif /* FSL_FEATURE_SOC_SYSCON_COUNT */ |
| |
| #if defined(__cplusplus) |
| } |
| #endif |
| |
| /*! @} */ |
| |
| #endif /* _FSL_COMMON_H_ */ |
