mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_RO359B/TOOLCHAIN_ARM_STD/fsl_common.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_RO359B/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_MCU_K24F/drivers/fsl_common.h@156:ff21514d8981 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /*
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
AnnaBridge 156:ff21514d8981 3 * Copyright 2016-2017 NXP
AnnaBridge 156:ff21514d8981 4 *
AnnaBridge 156:ff21514d8981 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 156:ff21514d8981 6 * are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 156:ff21514d8981 9 * of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 156:ff21514d8981 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 156:ff21514d8981 13 * other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 156:ff21514d8981 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 156:ff21514d8981 17 * software without specific prior written permission.
AnnaBridge 156:ff21514d8981 18 *
AnnaBridge 156:ff21514d8981 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 156:ff21514d8981 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 156:ff21514d8981 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 156:ff21514d8981 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 156:ff21514d8981 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 156:ff21514d8981 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 156:ff21514d8981 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 156:ff21514d8981 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 156:ff21514d8981 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 29 */
AnnaBridge 156:ff21514d8981 30
AnnaBridge 156:ff21514d8981 31 #ifndef _FSL_COMMON_H_
AnnaBridge 156:ff21514d8981 32 #define _FSL_COMMON_H_
AnnaBridge 156:ff21514d8981 33
AnnaBridge 156:ff21514d8981 34 #include <assert.h>
AnnaBridge 156:ff21514d8981 35 #include <stdbool.h>
AnnaBridge 156:ff21514d8981 36 #include <stdint.h>
AnnaBridge 156:ff21514d8981 37 #include <string.h>
AnnaBridge 156:ff21514d8981 38
AnnaBridge 156:ff21514d8981 39 #if defined(__ICCARM__)
AnnaBridge 156:ff21514d8981 40 #include <stddef.h>
AnnaBridge 156:ff21514d8981 41 #endif
AnnaBridge 156:ff21514d8981 42
AnnaBridge 156:ff21514d8981 43 #include "fsl_device_registers.h"
AnnaBridge 156:ff21514d8981 44
AnnaBridge 156:ff21514d8981 45 /*!
AnnaBridge 156:ff21514d8981 46 * @addtogroup ksdk_common
AnnaBridge 156:ff21514d8981 47 * @{
AnnaBridge 156:ff21514d8981 48 */
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 /*******************************************************************************
AnnaBridge 156:ff21514d8981 51 * Definitions
AnnaBridge 156:ff21514d8981 52 ******************************************************************************/
AnnaBridge 156:ff21514d8981 53
AnnaBridge 156:ff21514d8981 54 /*! @brief Construct a status code value from a group and code number. */
AnnaBridge 156:ff21514d8981 55 #define MAKE_STATUS(group, code) ((((group)*100) + (code)))
AnnaBridge 156:ff21514d8981 56
AnnaBridge 156:ff21514d8981 57 /*! @brief Construct the version number for drivers. */
AnnaBridge 156:ff21514d8981 58 #define MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix))
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /* Debug console type definition. */
AnnaBridge 156:ff21514d8981 61 #define DEBUG_CONSOLE_DEVICE_TYPE_NONE 0U /*!< No debug console. */
AnnaBridge 156:ff21514d8981 62 #define DEBUG_CONSOLE_DEVICE_TYPE_UART 1U /*!< Debug console base on UART. */
AnnaBridge 156:ff21514d8981 63 #define DEBUG_CONSOLE_DEVICE_TYPE_LPUART 2U /*!< Debug console base on LPUART. */
AnnaBridge 156:ff21514d8981 64 #define DEBUG_CONSOLE_DEVICE_TYPE_LPSCI 3U /*!< Debug console base on LPSCI. */
AnnaBridge 156:ff21514d8981 65 #define DEBUG_CONSOLE_DEVICE_TYPE_USBCDC 4U /*!< Debug console base on USBCDC. */
AnnaBridge 156:ff21514d8981 66 #define DEBUG_CONSOLE_DEVICE_TYPE_FLEXCOMM 5U /*!< Debug console base on USBCDC. */
AnnaBridge 156:ff21514d8981 67 #define DEBUG_CONSOLE_DEVICE_TYPE_IUART 6U /*!< Debug console base on i.MX UART. */
AnnaBridge 156:ff21514d8981 68
AnnaBridge 156:ff21514d8981 69 /*! @brief Status group numbers. */
AnnaBridge 156:ff21514d8981 70 enum _status_groups
AnnaBridge 156:ff21514d8981 71 {
AnnaBridge 156:ff21514d8981 72 kStatusGroup_Generic = 0, /*!< Group number for generic status codes. */
AnnaBridge 156:ff21514d8981 73 kStatusGroup_FLASH = 1, /*!< Group number for FLASH status codes. */
AnnaBridge 156:ff21514d8981 74 kStatusGroup_LPSPI = 4, /*!< Group number for LPSPI status codes. */
AnnaBridge 156:ff21514d8981 75 kStatusGroup_FLEXIO_SPI = 5, /*!< Group number for FLEXIO SPI status codes. */
AnnaBridge 156:ff21514d8981 76 kStatusGroup_DSPI = 6, /*!< Group number for DSPI status codes. */
AnnaBridge 156:ff21514d8981 77 kStatusGroup_FLEXIO_UART = 7, /*!< Group number for FLEXIO UART status codes. */
AnnaBridge 156:ff21514d8981 78 kStatusGroup_FLEXIO_I2C = 8, /*!< Group number for FLEXIO I2C status codes. */
AnnaBridge 156:ff21514d8981 79 kStatusGroup_LPI2C = 9, /*!< Group number for LPI2C status codes. */
AnnaBridge 156:ff21514d8981 80 kStatusGroup_UART = 10, /*!< Group number for UART status codes. */
AnnaBridge 156:ff21514d8981 81 kStatusGroup_I2C = 11, /*!< Group number for UART status codes. */
AnnaBridge 156:ff21514d8981 82 kStatusGroup_LPSCI = 12, /*!< Group number for LPSCI status codes. */
AnnaBridge 156:ff21514d8981 83 kStatusGroup_LPUART = 13, /*!< Group number for LPUART status codes. */
AnnaBridge 156:ff21514d8981 84 kStatusGroup_SPI = 14, /*!< Group number for SPI status code.*/
AnnaBridge 156:ff21514d8981 85 kStatusGroup_XRDC = 15, /*!< Group number for XRDC status code.*/
AnnaBridge 156:ff21514d8981 86 kStatusGroup_SEMA42 = 16, /*!< Group number for SEMA42 status code.*/
AnnaBridge 156:ff21514d8981 87 kStatusGroup_SDHC = 17, /*!< Group number for SDHC status code */
AnnaBridge 156:ff21514d8981 88 kStatusGroup_SDMMC = 18, /*!< Group number for SDMMC status code */
AnnaBridge 156:ff21514d8981 89 kStatusGroup_SAI = 19, /*!< Group number for SAI status code */
AnnaBridge 156:ff21514d8981 90 kStatusGroup_MCG = 20, /*!< Group number for MCG status codes. */
AnnaBridge 156:ff21514d8981 91 kStatusGroup_SCG = 21, /*!< Group number for SCG status codes. */
AnnaBridge 156:ff21514d8981 92 kStatusGroup_SDSPI = 22, /*!< Group number for SDSPI status codes. */
AnnaBridge 156:ff21514d8981 93 kStatusGroup_FLEXIO_I2S = 23, /*!< Group number for FLEXIO I2S status codes */
AnnaBridge 156:ff21514d8981 94 kStatusGroup_FLEXIO_MCULCD = 24, /*!< Group number for FLEXIO LCD status codes */
AnnaBridge 156:ff21514d8981 95 kStatusGroup_FLASHIAP = 25, /*!< Group number for FLASHIAP status codes */
AnnaBridge 156:ff21514d8981 96 kStatusGroup_FLEXCOMM_I2C = 26, /*!< Group number for FLEXCOMM I2C status codes */
AnnaBridge 156:ff21514d8981 97 kStatusGroup_I2S = 27, /*!< Group number for I2S status codes */
AnnaBridge 156:ff21514d8981 98 kStatusGroup_IUART = 28, /*!< Group number for IUART status codes */
AnnaBridge 156:ff21514d8981 99 kStatusGroup_SDRAMC = 35, /*!< Group number for SDRAMC status codes. */
AnnaBridge 156:ff21514d8981 100 kStatusGroup_POWER = 39, /*!< Group number for POWER status codes. */
AnnaBridge 156:ff21514d8981 101 kStatusGroup_ENET = 40, /*!< Group number for ENET status codes. */
AnnaBridge 156:ff21514d8981 102 kStatusGroup_PHY = 41, /*!< Group number for PHY status codes. */
AnnaBridge 156:ff21514d8981 103 kStatusGroup_TRGMUX = 42, /*!< Group number for TRGMUX status codes. */
AnnaBridge 156:ff21514d8981 104 kStatusGroup_SMARTCARD = 43, /*!< Group number for SMARTCARD status codes. */
AnnaBridge 156:ff21514d8981 105 kStatusGroup_LMEM = 44, /*!< Group number for LMEM status codes. */
AnnaBridge 156:ff21514d8981 106 kStatusGroup_QSPI = 45, /*!< Group number for QSPI status codes. */
AnnaBridge 156:ff21514d8981 107 kStatusGroup_DMA = 50, /*!< Group number for DMA status codes. */
AnnaBridge 156:ff21514d8981 108 kStatusGroup_EDMA = 51, /*!< Group number for EDMA status codes. */
AnnaBridge 156:ff21514d8981 109 kStatusGroup_DMAMGR = 52, /*!< Group number for DMAMGR status codes. */
AnnaBridge 156:ff21514d8981 110 kStatusGroup_FLEXCAN = 53, /*!< Group number for FlexCAN status codes. */
AnnaBridge 156:ff21514d8981 111 kStatusGroup_LTC = 54, /*!< Group number for LTC status codes. */
AnnaBridge 156:ff21514d8981 112 kStatusGroup_FLEXIO_CAMERA = 55, /*!< Group number for FLEXIO CAMERA status codes. */
AnnaBridge 156:ff21514d8981 113 kStatusGroup_LPC_SPI = 56, /*!< Group number for LPC_SPI status codes. */
AnnaBridge 156:ff21514d8981 114 kStatusGroup_LPC_USART = 57, /*!< Group number for LPC_USART status codes. */
AnnaBridge 156:ff21514d8981 115 kStatusGroup_DMIC = 58, /*!< Group number for DMIC status codes. */
AnnaBridge 156:ff21514d8981 116 kStatusGroup_SDIF = 59, /*!< Group number for SDIF status codes.*/
AnnaBridge 156:ff21514d8981 117 kStatusGroup_SPIFI = 60, /*!< Group number for SPIFI status codes. */
AnnaBridge 156:ff21514d8981 118 kStatusGroup_OTP = 61, /*!< Group number for OTP status codes. */
AnnaBridge 156:ff21514d8981 119 kStatusGroup_MCAN = 62, /*!< Group number for MCAN status codes. */
AnnaBridge 156:ff21514d8981 120 kStatusGroup_CAAM = 63, /*!< Group number for CAAM status codes. */
AnnaBridge 156:ff21514d8981 121 kStatusGroup_ECSPI = 64, /*!< Group number for ECSPI status codes. */
AnnaBridge 156:ff21514d8981 122 kStatusGroup_USDHC = 65, /*!< Group number for USDHC status codes.*/
AnnaBridge 156:ff21514d8981 123 kStatusGroup_ESAI = 69, /*!< Group number for ESAI status codes. */
AnnaBridge 156:ff21514d8981 124 kStatusGroup_FLEXSPI = 70, /*!< Group number for FLEXSPI status codes. */
AnnaBridge 156:ff21514d8981 125 kStatusGroup_NOTIFIER = 98, /*!< Group number for NOTIFIER status codes. */
AnnaBridge 156:ff21514d8981 126 kStatusGroup_DebugConsole = 99, /*!< Group number for debug console status codes. */
AnnaBridge 156:ff21514d8981 127 kStatusGroup_ApplicationRangeStart = 100, /*!< Starting number for application groups. */
AnnaBridge 156:ff21514d8981 128 };
AnnaBridge 156:ff21514d8981 129
AnnaBridge 156:ff21514d8981 130 /*! @brief Generic status return codes. */
AnnaBridge 156:ff21514d8981 131 enum _generic_status
AnnaBridge 156:ff21514d8981 132 {
AnnaBridge 156:ff21514d8981 133 kStatus_Success = MAKE_STATUS(kStatusGroup_Generic, 0),
AnnaBridge 156:ff21514d8981 134 kStatus_Fail = MAKE_STATUS(kStatusGroup_Generic, 1),
AnnaBridge 156:ff21514d8981 135 kStatus_ReadOnly = MAKE_STATUS(kStatusGroup_Generic, 2),
AnnaBridge 156:ff21514d8981 136 kStatus_OutOfRange = MAKE_STATUS(kStatusGroup_Generic, 3),
AnnaBridge 156:ff21514d8981 137 kStatus_InvalidArgument = MAKE_STATUS(kStatusGroup_Generic, 4),
AnnaBridge 156:ff21514d8981 138 kStatus_Timeout = MAKE_STATUS(kStatusGroup_Generic, 5),
AnnaBridge 156:ff21514d8981 139 kStatus_NoTransferInProgress = MAKE_STATUS(kStatusGroup_Generic, 6),
AnnaBridge 156:ff21514d8981 140 };
AnnaBridge 156:ff21514d8981 141
AnnaBridge 156:ff21514d8981 142 /*! @brief Type used for all status and error return values. */
AnnaBridge 156:ff21514d8981 143 typedef int32_t status_t;
AnnaBridge 156:ff21514d8981 144
AnnaBridge 156:ff21514d8981 145 /*
AnnaBridge 156:ff21514d8981 146 * The fsl_clock.h is included here because it needs MAKE_VERSION/MAKE_STATUS/status_t
AnnaBridge 156:ff21514d8981 147 * defined in previous of this file.
AnnaBridge 156:ff21514d8981 148 */
AnnaBridge 156:ff21514d8981 149 #include "fsl_clock.h"
AnnaBridge 156:ff21514d8981 150
AnnaBridge 156:ff21514d8981 151 /*
AnnaBridge 156:ff21514d8981 152 * Chip level peripheral reset API, for MCUs that implement peripheral reset control external to a peripheral
AnnaBridge 156:ff21514d8981 153 */
AnnaBridge 156:ff21514d8981 154 #if ((defined(FSL_FEATURE_SOC_SYSCON_COUNT) && (FSL_FEATURE_SOC_SYSCON_COUNT > 0)) || \
AnnaBridge 156:ff21514d8981 155 (defined(FSL_FEATURE_SOC_ASYNC_SYSCON_COUNT) && (FSL_FEATURE_SOC_ASYNC_SYSCON_COUNT > 0)))
AnnaBridge 156:ff21514d8981 156 #include "fsl_reset.h"
AnnaBridge 156:ff21514d8981 157 #endif
AnnaBridge 156:ff21514d8981 158
AnnaBridge 156:ff21514d8981 159 /*! @name Min/max macros */
AnnaBridge 156:ff21514d8981 160 /* @{ */
AnnaBridge 156:ff21514d8981 161 #if !defined(MIN)
AnnaBridge 156:ff21514d8981 162 #define MIN(a, b) ((a) < (b) ? (a) : (b))
AnnaBridge 156:ff21514d8981 163 #endif
AnnaBridge 156:ff21514d8981 164
AnnaBridge 156:ff21514d8981 165 #if !defined(MAX)
AnnaBridge 156:ff21514d8981 166 #define MAX(a, b) ((a) > (b) ? (a) : (b))
AnnaBridge 156:ff21514d8981 167 #endif
AnnaBridge 156:ff21514d8981 168 /* @} */
AnnaBridge 156:ff21514d8981 169
AnnaBridge 156:ff21514d8981 170 /*! @brief Computes the number of elements in an array. */
AnnaBridge 156:ff21514d8981 171 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
AnnaBridge 156:ff21514d8981 172
AnnaBridge 156:ff21514d8981 173 /*! @name UINT16_MAX/UINT32_MAX value */
AnnaBridge 156:ff21514d8981 174 /* @{ */
AnnaBridge 156:ff21514d8981 175 #if !defined(UINT16_MAX)
AnnaBridge 156:ff21514d8981 176 #define UINT16_MAX ((uint16_t)-1)
AnnaBridge 156:ff21514d8981 177 #endif
AnnaBridge 156:ff21514d8981 178
AnnaBridge 156:ff21514d8981 179 #if !defined(UINT32_MAX)
AnnaBridge 156:ff21514d8981 180 #define UINT32_MAX ((uint32_t)-1)
AnnaBridge 156:ff21514d8981 181 #endif
AnnaBridge 156:ff21514d8981 182 /* @} */
AnnaBridge 156:ff21514d8981 183
AnnaBridge 156:ff21514d8981 184 /*! @name Timer utilities */
AnnaBridge 156:ff21514d8981 185 /* @{ */
AnnaBridge 156:ff21514d8981 186 /*! Macro to convert a microsecond period to raw count value */
AnnaBridge 156:ff21514d8981 187 #define USEC_TO_COUNT(us, clockFreqInHz) (uint64_t)((uint64_t)us * clockFreqInHz / 1000000U)
AnnaBridge 156:ff21514d8981 188 /*! Macro to convert a raw count value to microsecond */
AnnaBridge 156:ff21514d8981 189 #define COUNT_TO_USEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000000U / clockFreqInHz)
AnnaBridge 156:ff21514d8981 190
AnnaBridge 156:ff21514d8981 191 /*! Macro to convert a millisecond period to raw count value */
AnnaBridge 156:ff21514d8981 192 #define MSEC_TO_COUNT(ms, clockFreqInHz) (uint64_t)((uint64_t)ms * clockFreqInHz / 1000U)
AnnaBridge 156:ff21514d8981 193 /*! Macro to convert a raw count value to millisecond */
AnnaBridge 156:ff21514d8981 194 #define COUNT_TO_MSEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000U / clockFreqInHz)
AnnaBridge 156:ff21514d8981 195 /* @} */
AnnaBridge 156:ff21514d8981 196
AnnaBridge 156:ff21514d8981 197 /*******************************************************************************
AnnaBridge 156:ff21514d8981 198 * API
AnnaBridge 156:ff21514d8981 199 ******************************************************************************/
AnnaBridge 156:ff21514d8981 200
AnnaBridge 156:ff21514d8981 201 #if defined(__cplusplus)
AnnaBridge 156:ff21514d8981 202 extern "C" {
AnnaBridge 156:ff21514d8981 203 #endif
AnnaBridge 156:ff21514d8981 204
AnnaBridge 156:ff21514d8981 205 /*!
AnnaBridge 156:ff21514d8981 206 * @brief Enable specific interrupt.
AnnaBridge 156:ff21514d8981 207 *
AnnaBridge 156:ff21514d8981 208 * Enable the interrupt not routed from intmux.
AnnaBridge 156:ff21514d8981 209 *
AnnaBridge 156:ff21514d8981 210 * @param interrupt The IRQ number.
AnnaBridge 156:ff21514d8981 211 */
AnnaBridge 156:ff21514d8981 212 static inline void EnableIRQ(IRQn_Type interrupt)
AnnaBridge 156:ff21514d8981 213 {
AnnaBridge 156:ff21514d8981 214 if (NotAvail_IRQn == interrupt)
AnnaBridge 156:ff21514d8981 215 {
AnnaBridge 156:ff21514d8981 216 return;
AnnaBridge 156:ff21514d8981 217 }
AnnaBridge 156:ff21514d8981 218
AnnaBridge 156:ff21514d8981 219 #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0)
AnnaBridge 156:ff21514d8981 220 if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX)
AnnaBridge 156:ff21514d8981 221 #endif
AnnaBridge 156:ff21514d8981 222 {
AnnaBridge 156:ff21514d8981 223 #if defined(__GIC_PRIO_BITS)
AnnaBridge 156:ff21514d8981 224 GIC_EnableIRQ(interrupt);
AnnaBridge 156:ff21514d8981 225 #else
AnnaBridge 156:ff21514d8981 226 NVIC_EnableIRQ(interrupt);
AnnaBridge 156:ff21514d8981 227 #endif
AnnaBridge 156:ff21514d8981 228 }
AnnaBridge 156:ff21514d8981 229 }
AnnaBridge 156:ff21514d8981 230
AnnaBridge 156:ff21514d8981 231 /*!
AnnaBridge 156:ff21514d8981 232 * @brief Disable specific interrupt.
AnnaBridge 156:ff21514d8981 233 *
AnnaBridge 156:ff21514d8981 234 * Disable the interrupt not routed from intmux.
AnnaBridge 156:ff21514d8981 235 *
AnnaBridge 156:ff21514d8981 236 * @param interrupt The IRQ number.
AnnaBridge 156:ff21514d8981 237 */
AnnaBridge 156:ff21514d8981 238 static inline void DisableIRQ(IRQn_Type interrupt)
AnnaBridge 156:ff21514d8981 239 {
AnnaBridge 156:ff21514d8981 240 if (NotAvail_IRQn == interrupt)
AnnaBridge 156:ff21514d8981 241 {
AnnaBridge 156:ff21514d8981 242 return;
AnnaBridge 156:ff21514d8981 243 }
AnnaBridge 156:ff21514d8981 244
AnnaBridge 156:ff21514d8981 245 #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0)
AnnaBridge 156:ff21514d8981 246 if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX)
AnnaBridge 156:ff21514d8981 247 #endif
AnnaBridge 156:ff21514d8981 248 {
AnnaBridge 156:ff21514d8981 249 #if defined(__GIC_PRIO_BITS)
AnnaBridge 156:ff21514d8981 250 GIC_DisableIRQ(interrupt);
AnnaBridge 156:ff21514d8981 251 #else
AnnaBridge 156:ff21514d8981 252 NVIC_DisableIRQ(interrupt);
AnnaBridge 156:ff21514d8981 253 #endif
AnnaBridge 156:ff21514d8981 254 }
AnnaBridge 156:ff21514d8981 255 }
AnnaBridge 156:ff21514d8981 256
AnnaBridge 156:ff21514d8981 257 /*!
AnnaBridge 156:ff21514d8981 258 * @brief Disable the global IRQ
AnnaBridge 156:ff21514d8981 259 *
AnnaBridge 156:ff21514d8981 260 * Disable the global interrupt and return the current primask register. User is required to provided the primask
AnnaBridge 156:ff21514d8981 261 * register for the EnableGlobalIRQ().
AnnaBridge 156:ff21514d8981 262 *
AnnaBridge 156:ff21514d8981 263 * @return Current primask value.
AnnaBridge 156:ff21514d8981 264 */
AnnaBridge 156:ff21514d8981 265 static inline uint32_t DisableGlobalIRQ(void)
AnnaBridge 156:ff21514d8981 266 {
AnnaBridge 156:ff21514d8981 267 #if defined(CPSR_I_Msk)
AnnaBridge 156:ff21514d8981 268 uint32_t cpsr = __get_CPSR() & CPSR_I_Msk;
AnnaBridge 156:ff21514d8981 269
AnnaBridge 156:ff21514d8981 270 __disable_irq();
AnnaBridge 156:ff21514d8981 271
AnnaBridge 156:ff21514d8981 272 return cpsr;
AnnaBridge 156:ff21514d8981 273 #else
AnnaBridge 156:ff21514d8981 274 uint32_t regPrimask = __get_PRIMASK();
AnnaBridge 156:ff21514d8981 275
AnnaBridge 156:ff21514d8981 276 __disable_irq();
AnnaBridge 156:ff21514d8981 277
AnnaBridge 156:ff21514d8981 278 return regPrimask;
AnnaBridge 156:ff21514d8981 279 #endif
AnnaBridge 156:ff21514d8981 280 }
AnnaBridge 156:ff21514d8981 281
AnnaBridge 156:ff21514d8981 282 /*!
AnnaBridge 156:ff21514d8981 283 * @brief Enaable the global IRQ
AnnaBridge 156:ff21514d8981 284 *
AnnaBridge 156:ff21514d8981 285 * Set the primask register with the provided primask value but not just enable the primask. The idea is for the
AnnaBridge 156:ff21514d8981 286 * convinience of integration of RTOS. some RTOS get its own management mechanism of primask. User is required to
AnnaBridge 156:ff21514d8981 287 * use the EnableGlobalIRQ() and DisableGlobalIRQ() in pair.
AnnaBridge 156:ff21514d8981 288 *
AnnaBridge 156:ff21514d8981 289 * @param primask value of primask register to be restored. The primask value is supposed to be provided by the
AnnaBridge 156:ff21514d8981 290 * DisableGlobalIRQ().
AnnaBridge 156:ff21514d8981 291 */
AnnaBridge 156:ff21514d8981 292 static inline void EnableGlobalIRQ(uint32_t primask)
AnnaBridge 156:ff21514d8981 293 {
AnnaBridge 156:ff21514d8981 294 #if defined(CPSR_I_Msk)
AnnaBridge 156:ff21514d8981 295 __set_CPSR((__get_CPSR() & ~CPSR_I_Msk) | primask);
AnnaBridge 156:ff21514d8981 296 #else
AnnaBridge 156:ff21514d8981 297 __set_PRIMASK(primask);
AnnaBridge 156:ff21514d8981 298 #endif
AnnaBridge 156:ff21514d8981 299 }
AnnaBridge 156:ff21514d8981 300
AnnaBridge 156:ff21514d8981 301 /*!
AnnaBridge 156:ff21514d8981 302 * @brief install IRQ handler
AnnaBridge 156:ff21514d8981 303 *
AnnaBridge 156:ff21514d8981 304 * @param irq IRQ number
AnnaBridge 156:ff21514d8981 305 * @param irqHandler IRQ handler address
AnnaBridge 156:ff21514d8981 306 * @return The old IRQ handler address
AnnaBridge 156:ff21514d8981 307 */
AnnaBridge 156:ff21514d8981 308 void InstallIRQHandler(IRQn_Type irq, uint32_t irqHandler);
AnnaBridge 156:ff21514d8981 309
AnnaBridge 156:ff21514d8981 310 #if (defined(FSL_FEATURE_SOC_SYSCON_COUNT) && (FSL_FEATURE_SOC_SYSCON_COUNT > 0))
AnnaBridge 156:ff21514d8981 311 /*!
AnnaBridge 156:ff21514d8981 312 * @brief Enable specific interrupt for wake-up from deep-sleep mode.
AnnaBridge 156:ff21514d8981 313 *
AnnaBridge 156:ff21514d8981 314 * Enable the interrupt for wake-up from deep sleep mode.
AnnaBridge 156:ff21514d8981 315 * Some interrupts are typically used in sleep mode only and will not occur during
AnnaBridge 156:ff21514d8981 316 * deep-sleep mode because relevant clocks are stopped. However, it is possible to enable
AnnaBridge 156:ff21514d8981 317 * those clocks (significantly increasing power consumption in the reduced power mode),
AnnaBridge 156:ff21514d8981 318 * making these wake-ups possible.
AnnaBridge 156:ff21514d8981 319 *
AnnaBridge 156:ff21514d8981 320 * @note This function also enables the interrupt in the NVIC (EnableIRQ() is called internally).
AnnaBridge 156:ff21514d8981 321 *
AnnaBridge 156:ff21514d8981 322 * @param interrupt The IRQ number.
AnnaBridge 156:ff21514d8981 323 */
AnnaBridge 156:ff21514d8981 324 void EnableDeepSleepIRQ(IRQn_Type interrupt);
AnnaBridge 156:ff21514d8981 325
AnnaBridge 156:ff21514d8981 326 /*!
AnnaBridge 156:ff21514d8981 327 * @brief Disable specific interrupt for wake-up from deep-sleep mode.
AnnaBridge 156:ff21514d8981 328 *
AnnaBridge 156:ff21514d8981 329 * Disable the interrupt for wake-up from deep sleep mode.
AnnaBridge 156:ff21514d8981 330 * Some interrupts are typically used in sleep mode only and will not occur during
AnnaBridge 156:ff21514d8981 331 * deep-sleep mode because relevant clocks are stopped. However, it is possible to enable
AnnaBridge 156:ff21514d8981 332 * those clocks (significantly increasing power consumption in the reduced power mode),
AnnaBridge 156:ff21514d8981 333 * making these wake-ups possible.
AnnaBridge 156:ff21514d8981 334 *
AnnaBridge 156:ff21514d8981 335 * @note This function also disables the interrupt in the NVIC (DisableIRQ() is called internally).
AnnaBridge 156:ff21514d8981 336 *
AnnaBridge 156:ff21514d8981 337 * @param interrupt The IRQ number.
AnnaBridge 156:ff21514d8981 338 */
AnnaBridge 156:ff21514d8981 339 void DisableDeepSleepIRQ(IRQn_Type interrupt);
AnnaBridge 156:ff21514d8981 340 #endif /* FSL_FEATURE_SOC_SYSCON_COUNT */
AnnaBridge 156:ff21514d8981 341
AnnaBridge 156:ff21514d8981 342 #if defined(__cplusplus)
AnnaBridge 156:ff21514d8981 343 }
AnnaBridge 156:ff21514d8981 344 #endif
AnnaBridge 156:ff21514d8981 345
AnnaBridge 156:ff21514d8981 346 /*! @} */
AnnaBridge 156:ff21514d8981 347
AnnaBridge 156:ff21514d8981 348 #endif /* _FSL_COMMON_H_ */