Ksdk_common

Driver version
enum	_status_groups {   kStatusGroup_Generic = 0 , kStatusGroup_FLASH = 1 , kStatusGroup_LPSPI = 4 , kStatusGroup_FLEXIO_SPI = 5 ,   kStatusGroup_DSPI = 6 , kStatusGroup_FLEXIO_UART = 7 , kStatusGroup_FLEXIO_I2C = 8 , kStatusGroup_LPI2C = 9 ,   kStatusGroup_UART = 10 , kStatusGroup_I2C = 11 , kStatusGroup_LPSCI = 12 , kStatusGroup_LPUART = 13 ,   kStatusGroup_SPI = 14 , kStatusGroup_XRDC = 15 , kStatusGroup_SEMA42 = 16 , kStatusGroup_SDHC = 17 ,   kStatusGroup_SDMMC = 18 , kStatusGroup_SAI = 19 , kStatusGroup_MCG = 20 , kStatusGroup_SCG = 21 ,   kStatusGroup_SDSPI = 22 , kStatusGroup_FLEXIO_I2S = 23 , kStatusGroup_FLEXIO_MCULCD = 24 , kStatusGroup_FLASHIAP = 25 ,   kStatusGroup_FLEXCOMM_I2C = 26 , kStatusGroup_I2S = 27 , kStatusGroup_IUART = 28 , kStatusGroup_CSI = 29 ,   kStatusGroup_MIPI_DSI = 30 , kStatusGroup_SDRAMC = 35 , kStatusGroup_POWER = 39 , kStatusGroup_ENET = 40 ,   kStatusGroup_PHY = 41 , kStatusGroup_TRGMUX = 42 , kStatusGroup_SMARTCARD = 43 , kStatusGroup_LMEM = 44 ,   kStatusGroup_QSPI = 45 , kStatusGroup_DMA = 50 , kStatusGroup_EDMA = 51 , kStatusGroup_DMAMGR = 52 ,   kStatusGroup_FLEXCAN = 53 , kStatusGroup_LTC = 54 , kStatusGroup_FLEXIO_CAMERA = 55 , kStatusGroup_LPC_SPI = 56 ,   kStatusGroup_LPC_USART = 57 , kStatusGroup_DMIC = 58 , kStatusGroup_SDIF = 59 , kStatusGroup_SPIFI = 60 ,   kStatusGroup_OTP = 61 , kStatusGroup_MCAN = 62 , kStatusGroup_CAAM = 63 , kStatusGroup_ECSPI = 64 ,   kStatusGroup_USDHC = 65 , kStatusGroup_LPC_I2C = 66 , kStatusGroup_DCP = 67 , kStatusGroup_MSCAN = 68 ,   kStatusGroup_ESAI = 69 , kStatusGroup_FLEXSPI = 70 , kStatusGroup_MMDC = 71 , kStatusGroup_PDM = 72 ,   kStatusGroup_SDMA = 73 , kStatusGroup_ICS = 74 , kStatusGroup_SPDIF = 75 , kStatusGroup_LPC_MINISPI = 76 ,   kStatusGroup_HASHCRYPT = 77 , kStatusGroup_LPC_SPI_SSP = 78 , kStatusGroup_LPC_I2C_1 = 97 , kStatusGroup_NOTIFIER = 98 ,   kStatusGroup_DebugConsole = 99 , kStatusGroup_SEMC = 100 , kStatusGroup_ApplicationRangeStart = 101 , kStatusGroup_IAP = 102 ,   kStatusGroup_HAL_GPIO = 121 , kStatusGroup_HAL_UART = 122 , kStatusGroup_HAL_TIMER = 123 , kStatusGroup_HAL_SPI = 124 ,   kStatusGroup_HAL_I2C = 125 , kStatusGroup_HAL_FLASH = 126 , kStatusGroup_HAL_PWM = 127 , kStatusGroup_HAL_RNG = 128 ,   kStatusGroup_TIMERMANAGER = 135 , kStatusGroup_SERIALMANAGER = 136 , kStatusGroup_LED = 137 , kStatusGroup_BUTTON = 138 ,   kStatusGroup_EXTERN_EEPROM = 139 , kStatusGroup_SHELL = 140 , kStatusGroup_MEM_MANAGER = 141 , kStatusGroup_LIST = 142 ,   kStatusGroup_OSA = 143 , kStatusGroup_COMMON_TASK = 144 , kStatusGroup_MSG = 145 }
	Status group numbers. More...
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) }
	Generic status return codes. More...
typedef int32_t	status_t
	Type used for all status and error return values.

Alignment variable definition macros
in your projects to define	them
in your projects to define for zero inited non cacheable	variables
	_Pragma ("diag_suppress=Pm120") _Pragma("diag_error
or *	AT_NONCACHEABLE_SECTION_ALIGN_INIT (var)
or	AT_NONCACHEABLE_SECTION_ALIGN (var)

Ram Function
	C
void	EnableDeepSleepIRQ (IRQn_Type interrupt)
	Enable specific interrupt for wake-up from deep-sleep mode.
void	DisableDeepSleepIRQ (IRQn_Type interrupt)
	Disable specific interrupt for wake-up from deep-sleep mode.
void *	SDK_Malloc (size_t size, size_t alignbytes)
	Allocate memory with given alignment and aligned size.
void	SDK_Free (void *ptr)
	Free memory.

Detailed Description

Typedef Documentation

status_t

typedef int32_t status_t

Type used for all status and error return values.

Definition at line 169 of file fsl_common.h.

Enumeration Type Documentation

_generic_status

enum _generic_status

Generic status return codes.

Enumerator
kStatus_Success
kStatus_Fail
kStatus_ReadOnly
kStatus_OutOfRange
kStatus_InvalidArgument
kStatus_Timeout
kStatus_NoTransferInProgress

Definition at line 157 of file fsl_common.h.

{
    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),
};

_status_groups

enum _status_groups

Status group numbers.

Enumerator
kStatusGroup_Generic	Group number for generic status codes.
kStatusGroup_FLASH	Group number for FLASH status codes.
kStatusGroup_LPSPI	Group number for LPSPI status codes.
kStatusGroup_FLEXIO_SPI	Group number for FLEXIO SPI status codes.
kStatusGroup_DSPI	Group number for DSPI status codes.
kStatusGroup_FLEXIO_UART	Group number for FLEXIO UART status codes.
kStatusGroup_FLEXIO_I2C	Group number for FLEXIO I2C status codes.
kStatusGroup_LPI2C	Group number for LPI2C status codes.
kStatusGroup_UART	Group number for UART status codes.
kStatusGroup_I2C	Group number for UART status codes.
kStatusGroup_LPSCI	Group number for LPSCI status codes.
kStatusGroup_LPUART	Group number for LPUART status codes.
kStatusGroup_SPI	Group number for SPI status code.
kStatusGroup_XRDC	Group number for XRDC status code.
kStatusGroup_SEMA42	Group number for SEMA42 status code.
kStatusGroup_SDHC	Group number for SDHC status code
kStatusGroup_SDMMC	Group number for SDMMC status code
kStatusGroup_SAI	Group number for SAI status code
kStatusGroup_MCG	Group number for MCG status codes.
kStatusGroup_SCG	Group number for SCG status codes.
kStatusGroup_SDSPI	Group number for SDSPI status codes.
kStatusGroup_FLEXIO_I2S	Group number for FLEXIO I2S status codes
kStatusGroup_FLEXIO_MCULCD	Group number for FLEXIO LCD status codes
kStatusGroup_FLASHIAP	Group number for FLASHIAP status codes
kStatusGroup_FLEXCOMM_I2C	Group number for FLEXCOMM I2C status codes
kStatusGroup_I2S	Group number for I2S status codes
kStatusGroup_IUART	Group number for IUART status codes
kStatusGroup_CSI	Group number for CSI status codes
kStatusGroup_MIPI_DSI	Group number for MIPI DSI status codes
kStatusGroup_SDRAMC	Group number for SDRAMC status codes.
kStatusGroup_POWER	Group number for POWER status codes.
kStatusGroup_ENET	Group number for ENET status codes.
kStatusGroup_PHY	Group number for PHY status codes.
kStatusGroup_TRGMUX	Group number for TRGMUX status codes.
kStatusGroup_SMARTCARD	Group number for SMARTCARD status codes.
kStatusGroup_LMEM	Group number for LMEM status codes.
kStatusGroup_QSPI	Group number for QSPI status codes.
kStatusGroup_DMA	Group number for DMA status codes.
kStatusGroup_EDMA	Group number for EDMA status codes.
kStatusGroup_DMAMGR	Group number for DMAMGR status codes.
kStatusGroup_FLEXCAN	Group number for FlexCAN status codes.
kStatusGroup_LTC	Group number for LTC status codes.
kStatusGroup_FLEXIO_CAMERA	Group number for FLEXIO CAMERA status codes.
kStatusGroup_LPC_SPI	Group number for LPC_SPI status codes.
kStatusGroup_LPC_USART	Group number for LPC_USART status codes.
kStatusGroup_DMIC	Group number for DMIC status codes.
kStatusGroup_SDIF	Group number for SDIF status codes.
kStatusGroup_SPIFI	Group number for SPIFI status codes.
kStatusGroup_OTP	Group number for OTP status codes.
kStatusGroup_MCAN	Group number for MCAN status codes.
kStatusGroup_CAAM	Group number for CAAM status codes.
kStatusGroup_ECSPI	Group number for ECSPI status codes.
kStatusGroup_USDHC	Group number for USDHC status codes.
kStatusGroup_LPC_I2C	Group number for LPC_I2C status codes.
kStatusGroup_DCP	Group number for DCP status codes.
kStatusGroup_MSCAN	Group number for MSCAN status codes.
kStatusGroup_ESAI	Group number for ESAI status codes.
kStatusGroup_FLEXSPI	Group number for FLEXSPI status codes.
kStatusGroup_MMDC	Group number for MMDC status codes.
kStatusGroup_PDM	Group number for MIC status codes.
kStatusGroup_SDMA	Group number for SDMA status codes.
kStatusGroup_ICS	Group number for ICS status codes.
kStatusGroup_SPDIF	Group number for SPDIF status codes.
kStatusGroup_LPC_MINISPI	Group number for LPC_MINISPI status codes.
kStatusGroup_HASHCRYPT	Group number for Hashcrypt status codes
kStatusGroup_LPC_SPI_SSP	Group number for LPC_SPI_SSP status codes.
kStatusGroup_LPC_I2C_1	Group number for LPC_I2C_1 status codes.
kStatusGroup_NOTIFIER	Group number for NOTIFIER status codes.
kStatusGroup_DebugConsole	Group number for debug console status codes.
kStatusGroup_SEMC	Group number for SEMC status codes.
kStatusGroup_ApplicationRangeStart	Starting number for application groups.
kStatusGroup_IAP	Group number for IAP status codes
kStatusGroup_HAL_GPIO	Group number for HAL GPIO status codes.
kStatusGroup_HAL_UART	Group number for HAL UART status codes.
kStatusGroup_HAL_TIMER	Group number for HAL TIMER status codes.
kStatusGroup_HAL_SPI	Group number for HAL SPI status codes.
kStatusGroup_HAL_I2C	Group number for HAL I2C status codes.
kStatusGroup_HAL_FLASH	Group number for HAL FLASH status codes.
kStatusGroup_HAL_PWM	Group number for HAL PWM status codes.
kStatusGroup_HAL_RNG	Group number for HAL RNG status codes.
kStatusGroup_TIMERMANAGER	Group number for TiMER MANAGER status codes.
kStatusGroup_SERIALMANAGER	Group number for SERIAL MANAGER status codes.
kStatusGroup_LED	Group number for LED status codes.
kStatusGroup_BUTTON	Group number for BUTTON status codes.
kStatusGroup_EXTERN_EEPROM	Group number for EXTERN EEPROM status codes.
kStatusGroup_SHELL	Group number for SHELL status codes.
kStatusGroup_MEM_MANAGER	Group number for MEM MANAGER status codes.
kStatusGroup_LIST	Group number for List status codes.
kStatusGroup_OSA	Group number for OSA status codes.
kStatusGroup_COMMON_TASK	Group number for Common task status codes.
kStatusGroup_MSG	Group number for messaging status codes.

Definition at line 60 of file fsl_common.h.

{
    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_CSI = 29,                    /*!< Group number for CSI status codes */
    kStatusGroup_MIPI_DSI = 30,               /*!< Group number for MIPI DSI 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_LPC_I2C = 66,                /*!< Group number for LPC_I2C status codes.*/
    kStatusGroup_DCP = 67,                    /*!< Group number for DCP status codes.*/
    kStatusGroup_MSCAN = 68,                  /*!< Group number for MSCAN status codes.*/
    kStatusGroup_ESAI = 69,                   /*!< Group number for ESAI status codes. */
    kStatusGroup_FLEXSPI = 70,                /*!< Group number for FLEXSPI status codes. */
    kStatusGroup_MMDC = 71,                   /*!< Group number for MMDC status codes. */
    kStatusGroup_PDM = 72,                    /*!< Group number for MIC status codes. */
    kStatusGroup_SDMA = 73,                   /*!< Group number for SDMA status codes. */
    kStatusGroup_ICS = 74,                    /*!< Group number for ICS status codes. */
    kStatusGroup_SPDIF = 75,                  /*!< Group number for SPDIF status codes. */
    kStatusGroup_LPC_MINISPI = 76,            /*!< Group number for LPC_MINISPI status codes. */
    kStatusGroup_HASHCRYPT = 77,              /*!< Group number for Hashcrypt status codes */
    kStatusGroup_LPC_SPI_SSP = 78,            /*!< Group number for LPC_SPI_SSP status codes. */
    kStatusGroup_LPC_I2C_1 = 97,              /*!< Group number for LPC_I2C_1 status codes. */
    kStatusGroup_NOTIFIER = 98,               /*!< Group number for NOTIFIER status codes. */
    kStatusGroup_DebugConsole = 99,           /*!< Group number for debug console status codes. */
    kStatusGroup_SEMC = 100,                  /*!< Group number for SEMC status codes. */    
    kStatusGroup_ApplicationRangeStart = 101, /*!< Starting number for application groups. */
    kStatusGroup_IAP = 102,                   /*!< Group number for IAP status codes */
 
    kStatusGroup_HAL_GPIO = 121,              /*!< Group number for HAL GPIO status codes. */
    kStatusGroup_HAL_UART = 122,              /*!< Group number for HAL UART status codes. */
    kStatusGroup_HAL_TIMER = 123,             /*!< Group number for HAL TIMER status codes. */
    kStatusGroup_HAL_SPI = 124,               /*!< Group number for HAL SPI status codes. */
    kStatusGroup_HAL_I2C = 125,               /*!< Group number for HAL I2C status codes. */
    kStatusGroup_HAL_FLASH = 126,             /*!< Group number for HAL FLASH status codes. */
    kStatusGroup_HAL_PWM = 127,               /*!< Group number for HAL PWM status codes. */
    kStatusGroup_HAL_RNG = 128,               /*!< Group number for HAL RNG status codes. */
    kStatusGroup_TIMERMANAGER = 135,          /*!< Group number for TiMER MANAGER status codes. */
    kStatusGroup_SERIALMANAGER = 136,         /*!< Group number for SERIAL MANAGER status codes. */
    kStatusGroup_LED = 137,                   /*!< Group number for LED status codes. */
    kStatusGroup_BUTTON = 138,                /*!< Group number for BUTTON status codes. */
    kStatusGroup_EXTERN_EEPROM = 139,         /*!< Group number for EXTERN EEPROM status codes. */
    kStatusGroup_SHELL = 140,                 /*!< Group number for SHELL status codes. */
    kStatusGroup_MEM_MANAGER = 141,           /*!< Group number for MEM MANAGER status codes. */
    kStatusGroup_LIST = 142,                  /*!< Group number for List status codes. */
    kStatusGroup_OSA = 143,                   /*!< Group number for OSA status codes. */
    kStatusGroup_COMMON_TASK = 144,           /*!< Group number for Common task status codes. */
    kStatusGroup_MSG = 145,                   /*!< Group number for messaging status codes. */
};

Function Documentation

_Pragma()

_Pragma

(

)

Workaround to disable MISRA C message suppress warnings for IAR compiler. http://supp.iar.com/Support/?note=24725

AT_NONCACHEABLE_SECTION_ALIGN()

or AT_NONCACHEABLE_SECTION_ALIGN

(

var

)

AT_NONCACHEABLE_SECTION_ALIGN_INIT()

or * AT_NONCACHEABLE_SECTION_ALIGN_INIT

(

var

)

DisableDeepSleepIRQ()

void DisableDeepSleepIRQ

(

IRQn_Type

interrupt

)

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 internaly).

Parameters

interrupt

The IRQ number.

EnableDeepSleepIRQ()

void EnableDeepSleepIRQ

(

IRQn_Type

interrupt

)

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 internaly).

Parameters

interrupt

The IRQ number.

SDK_Free()

void SDK_Free

(

void *

ptr

)

Free memory.

Parameters

ptr	The memory to be release.

SDK_Malloc()

void * SDK_Malloc	(	size_t	size,
		size_t	alignbytes
	)

Allocate memory with given alignment and aligned size.

This is provided to support the dynamically allocated memory used in cache-able region.

Parameters

size	The length required to malloc.
alignbytes	The alignment size.

Return values

The	allocated memory.

Variable Documentation

C

C

extern

Referenced by HellenBoardIdFinderBase::calc(), HellenBoardIdFinderBase::calcEstimatedResistance(), and detectHellenBoardId().

them

to define them

Definition at line 292 of file fsl_common.h.

variables

in your projects to define for zero inited non cacheable variables

Definition at line 292 of file fsl_common.h.