raspiezo / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo_L432KC_Quadrature_Decoder_with_ADC_and_DAC

Fork of mbed-dev by mbed official

targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_KL43Z/drivers/fsl_common.h@161:bd0311f1ad86, 2017-05-27 (annotated)

Committer:
tonnyleonard
Date:
Sat May 27 01:26:18 2017 +0000
Revision:
161:bd0311f1ad86
Parent:
154:37f96f9d4de2 
Testing ADC with shunt

Who changed what in which revision?

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