mbed official / mbed-dev

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_COMMON_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_COMMON_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include <assert.h>
AnnaBridge 189:f392fc9709a3 35 #include <stdbool.h>
AnnaBridge 189:f392fc9709a3 36 #include <stdint.h>
AnnaBridge 189:f392fc9709a3 37 #include <stddef.h>
AnnaBridge 189:f392fc9709a3 38 #include <string.h>
AnnaBridge 189:f392fc9709a3 39 #include "fsl_device_registers.h"
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /*!
AnnaBridge 189:f392fc9709a3 42 * @addtogroup ksdk_common
AnnaBridge 189:f392fc9709a3 43 * @{
AnnaBridge 189:f392fc9709a3 44 */
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46
AnnaBridge 189:f392fc9709a3 47 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 48 * Definitions
AnnaBridge 189:f392fc9709a3 49 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @brief Construct a status code value from a group and code number. */
AnnaBridge 189:f392fc9709a3 52 #define MAKE_STATUS(group, code) ((((group)*100) + (code)))
AnnaBridge 189:f392fc9709a3 53
AnnaBridge 189:f392fc9709a3 54 /*! @brief Construct the version number for drivers. */
AnnaBridge 189:f392fc9709a3 55 #define MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix))
AnnaBridge 189:f392fc9709a3 56
AnnaBridge 189:f392fc9709a3 57 /* Debug console type definition. */
AnnaBridge 189:f392fc9709a3 58 #define DEBUG_CONSOLE_DEVICE_TYPE_NONE 0U /*!< No debug console. */
AnnaBridge 189:f392fc9709a3 59 #define DEBUG_CONSOLE_DEVICE_TYPE_UART 1U /*!< Debug console base on UART. */
AnnaBridge 189:f392fc9709a3 60 #define DEBUG_CONSOLE_DEVICE_TYPE_LPUART 2U /*!< Debug console base on LPUART. */
AnnaBridge 189:f392fc9709a3 61 #define DEBUG_CONSOLE_DEVICE_TYPE_LPSCI 3U /*!< Debug console base on LPSCI. */
AnnaBridge 189:f392fc9709a3 62 #define DEBUG_CONSOLE_DEVICE_TYPE_USBCDC 4U /*!< Debug console base on USBCDC. */
AnnaBridge 189:f392fc9709a3 63
AnnaBridge 189:f392fc9709a3 64 /*! @brief Status group numbers. */
AnnaBridge 189:f392fc9709a3 65 enum _status_groups
AnnaBridge 189:f392fc9709a3 66 {
AnnaBridge 189:f392fc9709a3 67 kStatusGroup_Generic = 0, /*!< Group number for generic status codes. */
AnnaBridge 189:f392fc9709a3 68 kStatusGroup_FLASH = 1, /*!< Group number for FLASH status codes. */
AnnaBridge 189:f392fc9709a3 69 kStatusGroup_LPSPI = 4, /*!< Group number for LPSPI status codes. */
AnnaBridge 189:f392fc9709a3 70 kStatusGroup_FLEXIO_SPI = 5, /*!< Group number for FLEXIO SPI status codes. */
AnnaBridge 189:f392fc9709a3 71 kStatusGroup_DSPI = 6, /*!< Group number for DSPI status codes. */
AnnaBridge 189:f392fc9709a3 72 kStatusGroup_FLEXIO_UART = 7, /*!< Group number for FLEXIO UART status codes. */
AnnaBridge 189:f392fc9709a3 73 kStatusGroup_FLEXIO_I2C = 8, /*!< Group number for FLEXIO I2C status codes. */
AnnaBridge 189:f392fc9709a3 74 kStatusGroup_LPI2C = 9, /*!< Group number for LPI2C status codes. */
AnnaBridge 189:f392fc9709a3 75 kStatusGroup_UART = 10, /*!< Group number for UART status codes. */
AnnaBridge 189:f392fc9709a3 76 kStatusGroup_I2C = 11, /*!< Group number for UART status codes. */
AnnaBridge 189:f392fc9709a3 77 kStatusGroup_LPSCI = 12, /*!< Group number for LPSCI status codes. */
AnnaBridge 189:f392fc9709a3 78 kStatusGroup_LPUART = 13, /*!< Group number for LPUART status codes. */
AnnaBridge 189:f392fc9709a3 79 kStatusGroup_SPI = 14, /*!< Group number for SPI status code.*/
AnnaBridge 189:f392fc9709a3 80 kStatusGroup_XRDC = 15, /*!< Group number for XRDC status code.*/
AnnaBridge 189:f392fc9709a3 81 kStatusGroup_SEMA42 = 16, /*!< Group number for SEMA42 status code.*/
AnnaBridge 189:f392fc9709a3 82 kStatusGroup_SDHC = 17, /*!< Group number for SDHC status code */
AnnaBridge 189:f392fc9709a3 83 kStatusGroup_SDMMC = 18, /*!< Group number for SDMMC status code */
AnnaBridge 189:f392fc9709a3 84 kStatusGroup_SAI = 19, /*!< Group number for SAI status code */
AnnaBridge 189:f392fc9709a3 85 kStatusGroup_MCG = 20, /*!< Group number for MCG status codes. */
AnnaBridge 189:f392fc9709a3 86 kStatusGroup_SCG = 21, /*!< Group number for SCG status codes. */
AnnaBridge 189:f392fc9709a3 87 kStatusGroup_SDSPI = 22, /*!< Group number for SDSPI status codes. */
AnnaBridge 189:f392fc9709a3 88 kStatusGroup_FLEXIO_I2S = 23, /*!< Group number for FLEXIO I2S status codes */
AnnaBridge 189:f392fc9709a3 89 kStatusGroup_SDRAMC = 35, /*!< Group number for SDRAMC status codes. */
AnnaBridge 189:f392fc9709a3 90 kStatusGroup_POWER = 39, /*!< Group number for POWER status codes. */
AnnaBridge 189:f392fc9709a3 91 kStatusGroup_ENET = 40, /*!< Group number for ENET status codes. */
AnnaBridge 189:f392fc9709a3 92 kStatusGroup_PHY = 41, /*!< Group number for PHY status codes. */
AnnaBridge 189:f392fc9709a3 93 kStatusGroup_TRGMUX = 42, /*!< Group number for TRGMUX status codes. */
AnnaBridge 189:f392fc9709a3 94 kStatusGroup_SMARTCARD = 43, /*!< Group number for SMARTCARD status codes. */
AnnaBridge 189:f392fc9709a3 95 kStatusGroup_LMEM = 44, /*!< Group number for LMEM status codes. */
AnnaBridge 189:f392fc9709a3 96 kStatusGroup_QSPI = 45, /*!< Group number for QSPI status codes. */
AnnaBridge 189:f392fc9709a3 97 kStatusGroup_DMA = 50, /*!< Group number for DMA status codes. */
AnnaBridge 189:f392fc9709a3 98 kStatusGroup_EDMA = 51, /*!< Group number for EDMA status codes. */
AnnaBridge 189:f392fc9709a3 99 kStatusGroup_DMAMGR = 52, /*!< Group number for DMAMGR status codes. */
AnnaBridge 189:f392fc9709a3 100 kStatusGroup_FLEXCAN = 53, /*!< Group number for FlexCAN status codes. */
AnnaBridge 189:f392fc9709a3 101 kStatusGroup_LTC = 54, /*!< Group number for LTC status codes. */
AnnaBridge 189:f392fc9709a3 102 kStatusGroup_FLEXIO_CAMERA = 55, /*!< Group number for FLEXIO CAMERA status codes. */
AnnaBridge 189:f392fc9709a3 103 kStatusGroup_NOTIFIER = 98, /*!< Group number for NOTIFIER status codes. */
AnnaBridge 189:f392fc9709a3 104 kStatusGroup_DebugConsole = 99, /*!< Group number for debug console status codes. */
AnnaBridge 189:f392fc9709a3 105 kStatusGroup_ApplicationRangeStart = 100, /*!< Starting number for application groups. */
AnnaBridge 189:f392fc9709a3 106 };
AnnaBridge 189:f392fc9709a3 107
AnnaBridge 189:f392fc9709a3 108 /*! @brief Generic status return codes. */
AnnaBridge 189:f392fc9709a3 109 enum _generic_status
AnnaBridge 189:f392fc9709a3 110 {
AnnaBridge 189:f392fc9709a3 111 kStatus_Success = MAKE_STATUS(kStatusGroup_Generic, 0),
AnnaBridge 189:f392fc9709a3 112 kStatus_Fail = MAKE_STATUS(kStatusGroup_Generic, 1),
AnnaBridge 189:f392fc9709a3 113 kStatus_ReadOnly = MAKE_STATUS(kStatusGroup_Generic, 2),
AnnaBridge 189:f392fc9709a3 114 kStatus_OutOfRange = MAKE_STATUS(kStatusGroup_Generic, 3),
AnnaBridge 189:f392fc9709a3 115 kStatus_InvalidArgument = MAKE_STATUS(kStatusGroup_Generic, 4),
AnnaBridge 189:f392fc9709a3 116 kStatus_Timeout = MAKE_STATUS(kStatusGroup_Generic, 5),
AnnaBridge 189:f392fc9709a3 117 kStatus_NoTransferInProgress = MAKE_STATUS(kStatusGroup_Generic, 6),
AnnaBridge 189:f392fc9709a3 118 };
AnnaBridge 189:f392fc9709a3 119
AnnaBridge 189:f392fc9709a3 120 /*! @brief Type used for all status and error return values. */
AnnaBridge 189:f392fc9709a3 121 typedef int32_t status_t;
AnnaBridge 189:f392fc9709a3 122
AnnaBridge 189:f392fc9709a3 123 /*
AnnaBridge 189:f392fc9709a3 124 * The fsl_clock.h is included here because it needs MAKE_VERSION/MAKE_STATUS/status_t
AnnaBridge 189:f392fc9709a3 125 * defined in previous of this file.
AnnaBridge 189:f392fc9709a3 126 */
AnnaBridge 189:f392fc9709a3 127 #include "fsl_clock.h"
AnnaBridge 189:f392fc9709a3 128
AnnaBridge 189:f392fc9709a3 129 /*! @name Min/max macros */
AnnaBridge 189:f392fc9709a3 130 /* @{ */
AnnaBridge 189:f392fc9709a3 131 #if !defined(MIN)
AnnaBridge 189:f392fc9709a3 132 #define MIN(a, b) ((a) < (b) ? (a) : (b))
AnnaBridge 189:f392fc9709a3 133 #endif
AnnaBridge 189:f392fc9709a3 134
AnnaBridge 189:f392fc9709a3 135 #if !defined(MAX)
AnnaBridge 189:f392fc9709a3 136 #define MAX(a, b) ((a) > (b) ? (a) : (b))
AnnaBridge 189:f392fc9709a3 137 #endif
AnnaBridge 189:f392fc9709a3 138 /* @} */
AnnaBridge 189:f392fc9709a3 139
AnnaBridge 189:f392fc9709a3 140 /*! @brief Computes the number of elements in an array. */
AnnaBridge 189:f392fc9709a3 141 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
AnnaBridge 189:f392fc9709a3 142
AnnaBridge 189:f392fc9709a3 143 /*! @name UINT16_MAX/UINT32_MAX value */
AnnaBridge 189:f392fc9709a3 144 /* @{ */
AnnaBridge 189:f392fc9709a3 145 #if !defined(UINT16_MAX)
AnnaBridge 189:f392fc9709a3 146 #define UINT16_MAX ((uint16_t)-1)
AnnaBridge 189:f392fc9709a3 147 #endif
AnnaBridge 189:f392fc9709a3 148
AnnaBridge 189:f392fc9709a3 149 #if !defined(UINT32_MAX)
AnnaBridge 189:f392fc9709a3 150 #define UINT32_MAX ((uint32_t)-1)
AnnaBridge 189:f392fc9709a3 151 #endif
AnnaBridge 189:f392fc9709a3 152 /* @} */
AnnaBridge 189:f392fc9709a3 153
AnnaBridge 189:f392fc9709a3 154 /*! @name Timer utilities */
AnnaBridge 189:f392fc9709a3 155 /* @{ */
AnnaBridge 189:f392fc9709a3 156 /*! Macro to convert a microsecond period to raw count value */
AnnaBridge 189:f392fc9709a3 157 #define USEC_TO_COUNT(us, clockFreqInHz) (uint64_t)((uint64_t)us * clockFreqInHz / 1000000U)
AnnaBridge 189:f392fc9709a3 158 /*! Macro to convert a raw count value to microsecond */
AnnaBridge 189:f392fc9709a3 159 #define COUNT_TO_USEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000000U / clockFreqInHz)
AnnaBridge 189:f392fc9709a3 160
AnnaBridge 189:f392fc9709a3 161 /*! Macro to convert a millisecond period to raw count value */
AnnaBridge 189:f392fc9709a3 162 #define MSEC_TO_COUNT(ms, clockFreqInHz) (uint64_t)((uint64_t)ms * clockFreqInHz / 1000U)
AnnaBridge 189:f392fc9709a3 163 /*! Macro to convert a raw count value to millisecond */
AnnaBridge 189:f392fc9709a3 164 #define COUNT_TO_MSEC(count, clockFreqInHz) (uint64_t)((uint64_t)count * 1000U / clockFreqInHz)
AnnaBridge 189:f392fc9709a3 165 /* @} */
AnnaBridge 189:f392fc9709a3 166
AnnaBridge 189:f392fc9709a3 167 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 168 * API
AnnaBridge 189:f392fc9709a3 169 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 170
AnnaBridge 189:f392fc9709a3 171 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 172 extern "C" {
AnnaBridge 189:f392fc9709a3 173 #endif
AnnaBridge 189:f392fc9709a3 174
AnnaBridge 189:f392fc9709a3 175 /*!
AnnaBridge 189:f392fc9709a3 176 * @brief Enable specific interrupt.
AnnaBridge 189:f392fc9709a3 177 *
AnnaBridge 189:f392fc9709a3 178 * Enable the interrupt not routed from intmux.
AnnaBridge 189:f392fc9709a3 179 *
AnnaBridge 189:f392fc9709a3 180 * @param interrupt The IRQ number.
AnnaBridge 189:f392fc9709a3 181 */
AnnaBridge 189:f392fc9709a3 182 static inline void EnableIRQ(IRQn_Type interrupt)
AnnaBridge 189:f392fc9709a3 183 {
AnnaBridge 189:f392fc9709a3 184 #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0)
AnnaBridge 189:f392fc9709a3 185 if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX)
AnnaBridge 189:f392fc9709a3 186 #endif
AnnaBridge 189:f392fc9709a3 187 {
AnnaBridge 189:f392fc9709a3 188 NVIC_EnableIRQ(interrupt);
AnnaBridge 189:f392fc9709a3 189 }
AnnaBridge 189:f392fc9709a3 190 }
AnnaBridge 189:f392fc9709a3 191
AnnaBridge 189:f392fc9709a3 192 /*!
AnnaBridge 189:f392fc9709a3 193 * @brief Disable specific interrupt.
AnnaBridge 189:f392fc9709a3 194 *
AnnaBridge 189:f392fc9709a3 195 * Disable the interrupt not routed from intmux.
AnnaBridge 189:f392fc9709a3 196 *
AnnaBridge 189:f392fc9709a3 197 * @param interrupt The IRQ number.
AnnaBridge 189:f392fc9709a3 198 */
AnnaBridge 189:f392fc9709a3 199 static inline void DisableIRQ(IRQn_Type interrupt)
AnnaBridge 189:f392fc9709a3 200 {
AnnaBridge 189:f392fc9709a3 201 #if defined(FSL_FEATURE_SOC_INTMUX_COUNT) && (FSL_FEATURE_SOC_INTMUX_COUNT > 0)
AnnaBridge 189:f392fc9709a3 202 if (interrupt < FSL_FEATURE_INTMUX_IRQ_START_INDEX)
AnnaBridge 189:f392fc9709a3 203 #endif
AnnaBridge 189:f392fc9709a3 204 {
AnnaBridge 189:f392fc9709a3 205 NVIC_DisableIRQ(interrupt);
AnnaBridge 189:f392fc9709a3 206 }
AnnaBridge 189:f392fc9709a3 207 }
AnnaBridge 189:f392fc9709a3 208
AnnaBridge 189:f392fc9709a3 209 /*!
AnnaBridge 189:f392fc9709a3 210 * @brief Disable the global IRQ
AnnaBridge 189:f392fc9709a3 211 *
AnnaBridge 189:f392fc9709a3 212 * Disable the global interrupt and return the current primask register. User is required to provided the primask
AnnaBridge 189:f392fc9709a3 213 * register for the EnableGlobalIRQ().
AnnaBridge 189:f392fc9709a3 214 *
AnnaBridge 189:f392fc9709a3 215 * @return Current primask value.
AnnaBridge 189:f392fc9709a3 216 */
AnnaBridge 189:f392fc9709a3 217 static inline uint32_t DisableGlobalIRQ(void)
AnnaBridge 189:f392fc9709a3 218 {
AnnaBridge 189:f392fc9709a3 219 uint32_t regPrimask = __get_PRIMASK();
AnnaBridge 189:f392fc9709a3 220
AnnaBridge 189:f392fc9709a3 221 __disable_irq();
AnnaBridge 189:f392fc9709a3 222
AnnaBridge 189:f392fc9709a3 223 return regPrimask;
AnnaBridge 189:f392fc9709a3 224 }
AnnaBridge 189:f392fc9709a3 225
AnnaBridge 189:f392fc9709a3 226 /*!
AnnaBridge 189:f392fc9709a3 227 * @brief Enaable the global IRQ
AnnaBridge 189:f392fc9709a3 228 *
AnnaBridge 189:f392fc9709a3 229 * Set the primask register with the provided primask value but not just enable the primask. The idea is for the
AnnaBridge 189:f392fc9709a3 230 * convinience of integration of RTOS. some RTOS get its own management mechanism of primask. User is required to
AnnaBridge 189:f392fc9709a3 231 * use the EnableGlobalIRQ() and DisableGlobalIRQ() in pair.
AnnaBridge 189:f392fc9709a3 232 *
AnnaBridge 189:f392fc9709a3 233 * @param primask value of primask register to be restored. The primask value is supposed to be provided by the
AnnaBridge 189:f392fc9709a3 234 * DisableGlobalIRQ().
AnnaBridge 189:f392fc9709a3 235 */
AnnaBridge 189:f392fc9709a3 236 static inline void EnableGlobalIRQ(uint32_t primask)
AnnaBridge 189:f392fc9709a3 237 {
AnnaBridge 189:f392fc9709a3 238 __set_PRIMASK(primask);
AnnaBridge 189:f392fc9709a3 239 }
AnnaBridge 189:f392fc9709a3 240
AnnaBridge 189:f392fc9709a3 241 /*!
AnnaBridge 189:f392fc9709a3 242 * @brief install IRQ handler
AnnaBridge 189:f392fc9709a3 243 *
AnnaBridge 189:f392fc9709a3 244 * @param irq IRQ number
AnnaBridge 189:f392fc9709a3 245 * @param irqHandler IRQ handler address
AnnaBridge 189:f392fc9709a3 246 */
AnnaBridge 189:f392fc9709a3 247 void InstallIRQHandler(IRQn_Type irq, uint32_t irqHandler);
AnnaBridge 189:f392fc9709a3 248
AnnaBridge 189:f392fc9709a3 249 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 250 }
AnnaBridge 189:f392fc9709a3 251 #endif
AnnaBridge 189:f392fc9709a3 252
AnnaBridge 189:f392fc9709a3 253 /*! @} */
AnnaBridge 189:f392fc9709a3 254
AnnaBridge 189:f392fc9709a3 255 #endif /* _FSL_COMMON_H_ */