LPC824#

Clock Driver#

enum _clock_ip_name#

Clock gate name used for CLOCK_EnableClock/CLOCK_DisableClock.

Values:

enumerator kCLOCK_Sys#: Clock gate name: Sys.

enumerator kCLOCK_Rom#: Clock gate name: Rom.

enumerator kCLOCK_Ram0_1#: Clock gate name: Ram0_1.

enumerator kCLOCK_Flashreg#: Clock gate name: Flashreg.

enumerator kCLOCK_Flash#: Clock gate name: Flash.

enumerator kCLOCK_I2c0#: Clock gate name: I2c0.

enumerator kCLOCK_Gpio0#: Clock gate name: Gpio0.

enumerator kCLOCK_Swm#: Clock gate name: Swm.

enumerator kCLOCK_Sct#: Clock gate name: Sct.

enumerator kCLOCK_Wkt#: Clock gate name: Wkt.

enumerator kCLOCK_Mrt#: Clock gate name: Mrt.

enumerator kCLOCK_Spi0#: Clock gate name: Spi0.

enumerator kCLOCK_Spi1#: Clock gate name: Spi1.

enumerator kCLOCK_Crc#: Clock gate name: Crc.

enumerator kCLOCK_Uart0#: Clock gate name: Uart0.

enumerator kCLOCK_Uart1#: Clock gate name: Uart1.

enumerator kCLOCK_Uart2#: Clock gate name: Uart2.

enumerator kCLOCK_Wwdt#: Clock gate name: Wwdt.

enumerator kCLOCK_Iocon#: Clock gate name: Iocon.

enumerator kCLOCK_Acmp#: Clock gate name: Acmp.

enumerator kCLOCK_I2c1#: Clock gate name: I2c1.

enumerator kCLOCK_I2c2#: Clock gate name: I2c2.

enumerator kCLOCK_I2c3#: Clock gate name: I2c3.

enumerator kCLOCK_Adc#: Clock gate name: Adc.

enumerator kCLOCK_Mtb#: Clock gate name: Mtb.

enumerator kCLOCK_Dma#: Clock gate name: Dma.

enum _clock_name#

Clock name used to get clock frequency.

Values:

enumerator kCLOCK_CoreSysClk#: Cpu/AHB/AHB matrix/Memories,etc

enumerator kCLOCK_MainClk#: Main clock

enumerator kCLOCK_SysOsc#: Crystal Oscillator

enumerator kCLOCK_Irc#: IRC12M

enumerator kCLOCK_ExtClk#: External Clock

enumerator kCLOCK_PllOut#: PLL Output

enumerator kCLOCK_Pllin#: PLL Input

enumerator kCLOCK_WdtOsc#: Watchdog Oscillator

enum _clock_select#

Clock Mux Switches CLK_MUX_DEFINE(reg, mux) reg is used to define the mux register mux is used to define the mux value.

Values:

enumerator kSYSPLL_From_Irc#: Mux SYSPLL from Irc.

enumerator kSYSPLL_From_SysOsc#: Mux SYSPLL from SysOsc.

enumerator kSYSPLL_From_ExtClk#: Mux SYSPLL from ExtClk.

enumerator kMAINCLK_From_Irc#: Mux MAINCLK from Irc.

enumerator kMAINCLK_From_SysPllIn#: Mux MAINCLK from SysPllIn.

enumerator kMAINCLK_From_WdtOsc#: Mux MAINCLK from WdtOsc.

enumerator kMAINCLK_From_SysPll#: Mux MAINCLK from SysPll.

enumerator kCLKOUT_From_Irc#: Mux CLKOUT from Irc.

enumerator kCLKOUT_From_SysOsc#: Mux CLKOUT from SysOsc.

enumerator kCLKOUT_From_WdtOsc#: Mux CLKOUT from WdtOsc.

enumerator kCLKOUT_From_MainClk#: Mux clock out from Main clock.

enum _clock_divider#

Clock divider.

Values:

enumerator kCLOCK_DivUsartClk#: Usart Clock Divider.

enumerator kCLOCK_DivClkOut#: Clk Out Divider.

enumerator kCLOCK_DivUartFrg#: Uart Frg Divider.

enumerator kCLOCK_IOCONCLKDiv6#: IOCON Clock Div6 Divider.

enumerator kCLOCK_IOCONCLKDiv5#: IOCON Clock Div5 Divider.

enumerator kCLOCK_IOCONCLKDiv4#: IOCON Clock Div4 Divider.

enumerator kCLOCK_IOCONCLKDiv3#: IOCON Clock Div3 Divider.

enumerator kCLOCK_IOCONCLKDiv2#: IOCON Clock Div2 Divider.

enumerator kCLOCK_IOCONCLKDiv1#: IOCON Clock Div1 Divider.

enumerator kCLOCK_IOCONCLKDiv0#: IOCON Clock Div0 Divider.

enum _clock_wdt_analog_freq#

watch dog analog output frequency

Values:

enumerator kCLOCK_WdtAnaFreq0HZ#: Watch dog analog output frequency is 0HZ.

enumerator kCLOCK_WdtAnaFreq600KHZ#: Watch dog analog output frequency is 600KHZ.

enumerator kCLOCK_WdtAnaFreq1050KHZ#: Watch dog analog output frequency is 1050KHZ.

enumerator kCLOCK_WdtAnaFreq1400KHZ#: Watch dog analog output frequency is 1400KHZ.

enumerator kCLOCK_WdtAnaFreq1750KHZ#: Watch dog analog output frequency is 1750KHZ.

enumerator kCLOCK_WdtAnaFreq2100KHZ#: Watch dog analog output frequency is 2100KHZ.

enumerator kCLOCK_WdtAnaFreq2400KHZ#: Watch dog analog output frequency is 2400KHZ.

enumerator kCLOCK_WdtAnaFreq2700KHZ#: Watch dog analog output frequency is 2700KHZ.

enumerator kCLOCK_WdtAnaFreq3000KHZ#: Watch dog analog output frequency is 3000KHZ.

enumerator kCLOCK_WdtAnaFreq3250KHZ#: Watch dog analog output frequency is 3250KHZ.

enumerator kCLOCK_WdtAnaFreq3500KHZ#: Watch dog analog output frequency is 3500KHZ.

enumerator kCLOCK_WdtAnaFreq3750KHZ#: Watch dog analog output frequency is 3750KHZ.

enumerator kCLOCK_WdtAnaFreq4000KHZ#: Watch dog analog output frequency is 4000KHZ.

enumerator kCLOCK_WdtAnaFreq4200KHZ#: Watch dog analog output frequency is 4200KHZ.

enumerator kCLOCK_WdtAnaFreq4400KHZ#: Watch dog analog output frequency is 4400KHZ.

enumerator kCLOCK_WdtAnaFreq4600KHZ#: Watch dog analog output frequency is 4600KHZ.

enum _clock_sys_pll_src#

PLL clock definition.

Values:

enumerator kCLOCK_SysPllSrcIrc#: system pll source from FRO

enumerator kCLOCK_SysPllSrcSysosc#: system pll source from system osc

enumerator kCLOCK_SysPllSrcExtClk#: system pll source from ext clkin

enum _clock_main_clk_src#

Main clock source definition.

Values:

enumerator kCLOCK_MainClkSrcIrc#: main clock source from FRO

enumerator kCLOCK_MainClkSrcSysPllin#: main clock source from pll input

enumerator kCLOCK_MainClkSrcWdtOsc#: main clock source from watchdog oscillator

enumerator kCLOCK_MainClkSrcSysPll#: main clock source from system pll

typedef enum _clock_ip_name clock_ip_name_t#: Clock gate name used for CLOCK_EnableClock/CLOCK_DisableClock.

typedef enum _clock_name clock_name_t#: Clock name used to get clock frequency.

typedef enum _clock_select clock_select_t#: Clock Mux Switches CLK_MUX_DEFINE(reg, mux) reg is used to define the mux register mux is used to define the mux value.

typedef enum _clock_divider clock_divider_t#: Clock divider.

typedef enum _clock_wdt_analog_freq clock_wdt_analog_freq_t#: watch dog analog output frequency

typedef enum _clock_sys_pll_src clock_sys_pll_src#: PLL clock definition.

typedef enum _clock_main_clk_src clock_main_clk_src_t#: Main clock source definition.

typedef struct _clock_sys_pll clock_sys_pll_t#: PLL configuration structure.

volatile uint32_t g_Wdt_Osc_Freq#

watchdog oscilltor clock frequency.

This variable is used to store the watchdog oscillator frequency which is set by CLOCK_InitWdtOsc, and it is returned by CLOCK_GetWdtOscFreq.

volatile uint32_t g_Ext_Clk_Freq#

external clock frequency.

This variable is used to store the external clock frequency which is include external oscillator clock and external clk in clock frequency value, it is set by CLOCK_InitExtClkin when CLK IN is used as external clock or by CLOCK_InitSysOsc when external oscillator is used as external clock ,and it is returned by CLOCK_GetExtClkFreq.

FSL_CLOCK_DRIVER_VERSION#: CLOCK driver version 2.4.4.

SDK_DEVICE_MAXIMUM_CPU_CLOCK_FREQUENCY#

ADC_CLOCKS#: Clock ip name array for ADC.

ACMP_CLOCKS#: Clock ip name array for ACMP.

SWM_CLOCKS#: Clock ip name array for SWM.

ROM_CLOCKS#: Clock ip name array for ROM.

SRAM_CLOCKS#: Clock ip name array for SRAM.

IOCON_CLOCKS#: Clock ip name array for IOCON.

GPIO_CLOCKS#: Clock ip name array for GPIO.

GPIO_INT_CLOCKS#: Clock ip name array for GPIO_INT.

DMA_CLOCKS#: Clock ip name array for DMA.

CRC_CLOCKS#: Clock ip name array for CRC.

WWDT_CLOCKS#: Clock ip name array for WWDT.

SCT_CLOCKS#: Clock ip name array for SCT0.

I2C_CLOCKS#: Clock ip name array for I2C.

USART_CLOCKS#: Clock ip name array for I2C.

SPI_CLOCKS#: Clock ip name array for SPI.

MTB_CLOCKS#: Clock ip name array for MTB.

MRT_CLOCKS#: Clock ip name array for MRT.

WKT_CLOCKS#: Clock ip name array for WKT.

CLK_GATE_DEFINE(reg, bit)#: Internal used Clock definition only.

CLK_GATE_GET_REG(x)#

CLK_GATE_GET_BITS_SHIFT(x)#

CLK_MUX_DEFINE(reg, mux)#

CLK_MUX_GET_REG(x)#

CLK_MUX_GET_MUX(x)#

CLK_MAIN_CLK_MUX_DEFINE(preMux, mux)#

CLK_MAIN_CLK_MUX_GET_PRE_MUX(x)#

CLK_MAIN_CLK_MUX_GET_MUX(x)#

CLK_DIV_DEFINE(reg)#

CLK_DIV_GET_REG(x)#

CLK_WDT_OSC_DEFINE(freq, regValue)#

CLK_WDT_OSC_GET_FREQ(x)#

CLK_WDT_OSC_GET_REG(x)#

SYS_AHB_CLK_CTRL#

static inline void CLOCK_EnableClock(clock_ip_name_t clk)#

static inline void CLOCK_DisableClock(clock_ip_name_t clk)#

static inline void CLOCK_Select(clock_select_t sel)#

static inline void CLOCK_SetClkDivider(clock_divider_t name, uint32_t value)#

static inline uint32_t CLOCK_GetClkDivider(clock_divider_t name)#

static inline void CLOCK_SetCoreSysClkDiv(uint32_t value)#

void CLOCK_SetMainClkSrc(clock_main_clk_src_t src)#

Set main clock reference source.

Parameters:

src – Refer to clock_main_clk_src_t to set the main clock source.

static inline void CLOCK_SetFRGClkMul(uint32_t mul)#

uint32_t CLOCK_GetMainClkFreq(void)#

Return Frequency of Main Clock.

Returns:: Frequency of Main Clock.

static inline uint32_t CLOCK_GetCoreSysClkFreq(void)#

Return Frequency of core.

Returns:: Frequency of core.

uint32_t CLOCK_GetClockOutClkFreq(void)#

Return Frequency of ClockOut.

Returns:: Frequency of ClockOut

uint32_t CLOCK_GetIrcFreq(void)#

Return Frequency of IRC.

Returns:: Frequency of IRC

uint32_t CLOCK_GetSysOscFreq(void)#

Return Frequency of SYSOSC.

Returns:: Frequency of SYSOSC

uint32_t CLOCK_GetUartClkFreq(void)#

Get UART0 frequency.

Return values:: UART0 – frequency value.

uint32_t CLOCK_GetUart0ClkFreq(void)#

Get UART0 frequency.

Return values:: UART0 – frequency value.

uint32_t CLOCK_GetUart1ClkFreq(void)#

Get UART1 frequency.

Return values:: UART1 – frequency value.

uint32_t CLOCK_GetUart2ClkFreq(void)#

Get UART2 frequency.

Return values:: UART2 – frequency value.

uint32_t CLOCK_GetFreq(clock_name_t clockName)#

Return Frequency of selected clock.

Returns:: Frequency of selected clock

uint32_t CLOCK_GetSystemPLLInClockRate(void)#

Return System PLL input clock rate.

Returns:: System PLL input clock rate

static inline uint32_t CLOCK_GetSystemPLLFreq(void)#

Return Frequency of System PLL.

Returns:: Frequency of PLL

static inline uint32_t CLOCK_GetWdtOscFreq(void)#

Get watch dog OSC frequency.

Return values:: watch – dog OSC frequency value.

static inline uint32_t CLOCK_GetExtClkFreq(void)#

Get external clock frequency.

Return values:: external – clock frequency value.

void CLOCK_InitSystemPll(const clock_sys_pll_t *config)#

System PLL initialize.

Parameters:

config – System PLL configurations.

static inline void CLOCK_DenitSystemPll(void)#: System PLL Deinitialize.

void CLOCK_InitExtClkin(uint32_t clkInFreq)#

Init external CLK IN, select the CLKIN as the external clock source.

Parameters:

clkInFreq – external clock in frequency.

void CLOCK_InitSysOsc(uint32_t oscFreq)#

Init SYS OSC.

Parameters:

oscFreq – oscillator frequency value.

void CLOCK_InitXtalin(uint32_t xtalInFreq)#

XTALIN init function system oscillator is bypassed, sys_osc_clk is fed driectly from the XTALIN.

Parameters:

xtalInFreq – XTALIN frequency value

Returns:

Frequency of PLL

static inline void CLOCK_DeinitSysOsc(void)#: Deinit SYS OSC.

void CLOCK_InitWdtOsc(clock_wdt_analog_freq_t wdtOscFreq, uint32_t wdtOscDiv)#

Init watch dog OSC Any setting of the FREQSEL bits will yield a Fclkana value within 40% of the listed frequency value. The watchdog oscillator is the clock source with the lowest power consumption. If accurate timing is required, use the FRO or system oscillator. The frequency of the watchdog oscillator is undefined after reset. The watchdog oscillator frequency must be programmed by writing to the WDTOSCCTRL register before using the watchdog oscillator. Watchdog osc output frequency = wdtOscFreq / wdtOscDiv, should in range 9.3KHZ to 2.3MHZ.

Parameters:

wdtOscFreq – watch dog analog part output frequency, reference _wdt_analog_output_freq.
wdtOscDiv – watch dog analog part output frequency divider, shoule be a value >= 2U and multiple of 2

static inline void CLOCK_DeinitWdtOsc(void)#: Deinit watch dog OSC.

bool CLOCK_SetUARTFRGClkFreq(uint32_t freq)#

Set UARTFRG.

Deprecated:: Do not use this function. Refer to CLOCK_SetFRGClkMul().

Parameters:

freq – UART clock src.

void CLOCK_UpdateClkOUTsrc(void)#: updates the clock source of the CLKOUT

static inline void CLOCK_SetUARTFRGMULT(uint32_t mul)#

Set UARTFRGMULT.

Parameters:

mul – UARTFRGMULT.

uint32_t targetFreq#: System pll fclk output frequency, the output frequency should be lower than 100MHZ

clock_sys_pll_src src#: System pll clock source

struct _clock_sys_pll#: #include <fsl_clock.h>

PLL configuration structure.

CRC: Cyclic Redundancy Check Driver#

FSL_CRC_DRIVER_VERSION#

CRC driver version. Version 2.1.1.

Current version: 2.1.1

Change log:

Version 2.0.0
- initial version
Version 2.0.1
- add explicit type cast when writing to WR_DATA
Version 2.0.2
- Fix MISRA issue
Version 2.1.0
- Add CRC_WriteSeed function
Version 2.1.1
- Fix MISRA issue

enum _crc_polynomial#

CRC polynomials to use.

Values:

enumerator kCRC_Polynomial_CRC_CCITT#: x^16+x^12+x^5+1

enumerator kCRC_Polynomial_CRC_16#: x^16+x^15+x^2+1

enumerator kCRC_Polynomial_CRC_32#: x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x+1

typedef enum _crc_polynomial crc_polynomial_t#: CRC polynomials to use.

typedef struct _crc_config crc_config_t#

CRC protocol configuration.

This structure holds the configuration for the CRC protocol.

void CRC_Init(CRC_Type *base, const crc_config_t *config)#

Enables and configures the CRC peripheral module.

This functions enables the CRC peripheral clock in the LPC SYSCON block. It also configures the CRC engine and starts checksum computation by writing the seed.

Parameters:

base – CRC peripheral address.
config – CRC module configuration structure.

static inline void CRC_Deinit(CRC_Type *base)#

Disables the CRC peripheral module.

This functions disables the CRC peripheral clock in the LPC SYSCON block.

Parameters:

base – CRC peripheral address.

void CRC_Reset(CRC_Type *base)#

resets CRC peripheral module.

Parameters:

base – CRC peripheral address.

void CRC_WriteSeed(CRC_Type *base, uint32_t seed)#

Write seed to CRC peripheral module.

Parameters:

base – CRC peripheral address.
seed – CRC Seed value.

void CRC_GetDefaultConfig(crc_config_t *config)#

Loads default values to CRC protocol configuration structure.

Loads default values to CRC protocol configuration structure. The default values are:

config->polynomial = kCRC_Polynomial_CRC_CCITT;
config->reverseIn = false;
config->complementIn = false;
config->reverseOut = false;
config->complementOut = false;
config->seed = 0xFFFFU;

Parameters:

config – CRC protocol configuration structure

void CRC_GetConfig(CRC_Type *base, crc_config_t *config)#

Loads actual values configured in CRC peripheral to CRC protocol configuration structure.

The values, including seed, can be used to resume CRC calculation later.

Parameters:

base – CRC peripheral address.
config – CRC protocol configuration structure

void CRC_WriteData(CRC_Type *base, const uint8_t *data, size_t dataSize)#

Writes data to the CRC module.

Writes input data buffer bytes to CRC data register.

Parameters:

base – CRC peripheral address.
data – Input data stream, MSByte in data[0].
dataSize – Size of the input data buffer in bytes.

static inline uint32_t CRC_Get32bitResult(CRC_Type *base)#

Reads 32-bit checksum from the CRC module.

Reads CRC data register.

Parameters:

base – CRC peripheral address.

Returns:

final 32-bit checksum, after configured bit reverse and complement operations.

static inline uint16_t CRC_Get16bitResult(CRC_Type *base)#

Reads 16-bit checksum from the CRC module.

Reads CRC data register.

Parameters:

base – CRC peripheral address.

Returns:

final 16-bit checksum, after configured bit reverse and complement operations.

CRC_DRIVER_USE_CRC16_CCITT_FALSE_AS_DEFAULT#: Default configuration structure filled by CRC_GetDefaultConfig(). Uses CRC-16/CCITT-FALSE as default.

struct _crc_config#

#include <fsl_crc.h>

CRC protocol configuration.

This structure holds the configuration for the CRC protocol.

Public Members

crc_polynomial_t polynomial#: CRC polynomial.

bool reverseIn#: Reverse bits on input.

bool complementIn#: Perform 1’s complement on input.

bool reverseOut#: Reverse bits on output.

bool complementOut#: Perform 1’s complement on output.

uint32_t seed#: Starting checksum value.

DMA: Direct Memory Access Controller Driver#

void DMA_Init(DMA_Type *base)#

Initializes DMA peripheral.

This function enable the DMA clock, set descriptor table and enable DMA peripheral.

Parameters:

base – DMA peripheral base address.

void DMA_Deinit(DMA_Type *base)#

Deinitializes DMA peripheral.

This function gates the DMA clock.

Parameters:

base – DMA peripheral base address.

void DMA_InstallDescriptorMemory(DMA_Type *base, void *addr)#

Install DMA descriptor memory.

This function used to register DMA descriptor memory for linked transfer, a typical case is ping pong transfer which will request more than one DMA descriptor memory space, althrough current DMA driver has a default DMA descriptor buffer, but it support one DMA descriptor for one channel only.

Parameters:

base – DMA base address.
addr – DMA descriptor address

static inline bool DMA_ChannelIsActive(DMA_Type *base, uint32_t channel)#

Return whether DMA channel is processing transfer.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

Returns:

True for active state, false otherwise.

static inline bool DMA_ChannelIsBusy(DMA_Type *base, uint32_t channel)#

Return whether DMA channel is busy.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

Returns:

True for busy state, false otherwise.

static inline void DMA_EnableChannelInterrupts(DMA_Type *base, uint32_t channel)#

Enables the interrupt source for the DMA transfer.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_DisableChannelInterrupts(DMA_Type *base, uint32_t channel)#

Disables the interrupt source for the DMA transfer.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_EnableChannel(DMA_Type *base, uint32_t channel)#

Enable DMA channel.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_DisableChannel(DMA_Type *base, uint32_t channel)#

Disable DMA channel.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_EnableChannelPeriphRq(DMA_Type *base, uint32_t channel)#

Set PERIPHREQEN of channel configuration register.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_DisableChannelPeriphRq(DMA_Type *base, uint32_t channel)#

Get PERIPHREQEN value of channel configuration register.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

Returns:

True for enabled PeriphRq, false for disabled.

void DMA_ConfigureChannelTrigger(DMA_Type *base, uint32_t channel, dma_channel_trigger_t *trigger)#

Set trigger settings of DMA channel.

Deprecated:: Do not use this function. It has been superceded by DMA_SetChannelConfig.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.
trigger – trigger configuration.

void DMA_SetChannelConfig(DMA_Type *base, uint32_t channel, dma_channel_trigger_t *trigger, bool isPeriph)#

set channel config.

This function provide a interface to configure channel configuration reisters.

Parameters:

base – DMA base address.
channel – DMA channel number.
trigger – channel configurations structure.
isPeriph – true is periph request, false is not.

static inline uint32_t DMA_SetChannelXferConfig(bool reload, bool clrTrig, bool intA, bool intB, uint8_t width, uint8_t srcInc, uint8_t dstInc, uint32_t bytes)#

DMA channel xfer transfer configurations.

Parameters:

reload – true is reload link descriptor after current exhaust, false is not
clrTrig – true is clear trigger status, wait software trigger, false is not
intA – enable interruptA
intB – enable interruptB
width – transfer width
srcInc – source address interleave size
dstInc – destination address interleave size
bytes – transfer bytes

Returns:

The vaule of xfer config

uint32_t DMA_GetRemainingBytes(DMA_Type *base, uint32_t channel)#

Gets the remaining bytes of the current DMA descriptor transfer.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

Returns:

The number of bytes which have not been transferred yet.

static inline void DMA_SetChannelPriority(DMA_Type *base, uint32_t channel, dma_priority_t priority)#

Set priority of channel configuration register.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.
priority – Channel priority value.

static inline dma_priority_t DMA_GetChannelPriority(DMA_Type *base, uint32_t channel)#

Get priority of channel configuration register.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

Returns:

Channel priority value.

static inline void DMA_SetChannelConfigValid(DMA_Type *base, uint32_t channel)#

Set channel configuration valid.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_DoChannelSoftwareTrigger(DMA_Type *base, uint32_t channel)#

Do software trigger for the channel.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.

static inline void DMA_LoadChannelTransferConfig(DMA_Type *base, uint32_t channel, uint32_t xfer)#

Load channel transfer configurations.

Parameters:

base – DMA peripheral base address.
channel – DMA channel number.
xfer – transfer configurations.

void DMA_CreateDescriptor(dma_descriptor_t *desc, dma_xfercfg_t *xfercfg, void *srcAddr, void *dstAddr, void *nextDesc)#

Create application specific DMA descriptor to be used in a chain in transfer.

Deprecated:: Do not use this function. It has been superceded by DMA_SetupDescriptor.

Parameters:

desc – DMA descriptor address.
xfercfg – Transfer configuration for DMA descriptor.
srcAddr – Address of last item to transmit
dstAddr – Address of last item to receive.
nextDesc – Address of next descriptor in chain.

void DMA_SetupDescriptor(dma_descriptor_t *desc, uint32_t xfercfg, void *srcStartAddr, void *dstStartAddr, void *nextDesc)#

setup dma descriptor

Note: This function do not support configure wrap descriptor.

Parameters:

desc – DMA descriptor address.
xfercfg – Transfer configuration for DMA descriptor.
srcStartAddr – Start address of source address.
dstStartAddr – Start address of destination address.
nextDesc – Address of next descriptor in chain.

void DMA_SetupChannelDescriptor(dma_descriptor_t *desc, uint32_t xfercfg, void *srcStartAddr, void *dstStartAddr, void *nextDesc, dma_burst_wrap_t wrapType, uint32_t burstSize)#

setup dma channel descriptor

Note: This function support configure wrap descriptor.

Parameters:

desc – DMA descriptor address.
xfercfg – Transfer configuration for DMA descriptor.
srcStartAddr – Start address of source address.
dstStartAddr – Start address of destination address.
nextDesc – Address of next descriptor in chain.
wrapType – burst wrap type.
burstSize – burst size, reference _dma_burst_size.

void DMA_LoadChannelDescriptor(DMA_Type *base, uint32_t channel, dma_descriptor_t *descriptor)#

load channel transfer decriptor.

This function can be used to load desscriptor to driver internal channel descriptor that is used to start DMA transfer, the head descriptor table is defined in DMA driver, it is useful for the case:

for the polling transfer, application can allocate a local descriptor memory table to prepare a descriptor firstly and then call this api to load the configured descriptor to driver descriptor table.

DMA_Init(DMA0);
DMA_EnableChannel(DMA0, DEMO_DMA_CHANNEL);
DMA_SetupDescriptor(desc, xferCfg, s_srcBuffer, &s_destBuffer[0], NULL);
DMA_LoadChannelDescriptor(DMA0, DEMO_DMA_CHANNEL, (dma_descriptor_t *)desc);
DMA_DoChannelSoftwareTrigger(DMA0, DEMO_DMA_CHANNEL);
while(DMA_ChannelIsBusy(DMA0, DEMO_DMA_CHANNEL))
{}

Parameters:

base – DMA base address.
channel – DMA channel.
descriptor – configured DMA descriptor.

void DMA_AbortTransfer(dma_handle_t *handle)#

Abort running transfer by handle.

This function aborts DMA transfer specified by handle.

Parameters:

handle – DMA handle pointer.

void DMA_CreateHandle(dma_handle_t *handle, DMA_Type *base, uint32_t channel)#

Creates the DMA handle.

This function is called if using transaction API for DMA. This function initializes the internal state of DMA handle.

Parameters:

handle – DMA handle pointer. The DMA handle stores callback function and parameters.
base – DMA peripheral base address.
channel – DMA channel number.

void DMA_SetCallback(dma_handle_t *handle, dma_callback callback, void *userData)#

Installs a callback function for the DMA transfer.

This callback is called in DMA IRQ handler. Use the callback to do something after the current major loop transfer completes.

Parameters:

handle – DMA handle pointer.
callback – DMA callback function pointer.
userData – Parameter for callback function.

void DMA_PrepareTransfer(dma_transfer_config_t *config, void *srcAddr, void *dstAddr, uint32_t byteWidth, uint32_t transferBytes, dma_transfer_type_t type, void *nextDesc)#

Prepares the DMA transfer structure.

Deprecated:: Do not use this function. It has been superceded by DMA_PrepareChannelTransfer. This function prepares the transfer configuration structure according to the user input.

Note

The data address and the data width must be consistent. For example, if the SRC is 4 bytes, so the source address must be 4 bytes aligned, or it shall result in source address error(SAE).

Parameters:

config – The user configuration structure of type dma_transfer_t.
srcAddr – DMA transfer source address.
dstAddr – DMA transfer destination address.
byteWidth – DMA transfer destination address width(bytes).
transferBytes – DMA transfer bytes to be transferred.
type – DMA transfer type.
nextDesc – Chain custom descriptor to transfer.

void DMA_PrepareChannelTransfer(dma_channel_config_t *config, void *srcStartAddr, void *dstStartAddr, uint32_t xferCfg, dma_transfer_type_t type, dma_channel_trigger_t *trigger, void *nextDesc)#

Prepare channel transfer configurations.

This function used to prepare channel transfer configurations.

Parameters:

config – Pointer to DMA channel transfer configuration structure.
srcStartAddr – source start address.
dstStartAddr – destination start address.
xferCfg – xfer configuration, user can reference DMA_CHANNEL_XFER about to how to get xferCfg value.
type – transfer type.
trigger – DMA channel trigger configurations.
nextDesc – address of next descriptor.

status_t DMA_SubmitTransfer(dma_handle_t *handle, dma_transfer_config_t *config)#

Submits the DMA transfer request.

Deprecated:: Do not use this function. It has been superceded by DMA_SubmitChannelTransfer.

This function submits the DMA transfer request according to the transfer configuration structure. If the user submits the transfer request repeatedly, this function packs an unprocessed request as a TCD and enables scatter/gather feature to process it in the next time.

Parameters:

handle – DMA handle pointer.
config – Pointer to DMA transfer configuration structure.

Return values:

kStatus_DMA_Success – It means submit transfer request succeed.
kStatus_DMA_QueueFull – It means TCD queue is full. Submit transfer request is not allowed.
kStatus_DMA_Busy – It means the given channel is busy, need to submit request later.

void DMA_SubmitChannelTransferParameter(dma_handle_t *handle, uint32_t xferCfg, void *srcStartAddr, void *dstStartAddr, void *nextDesc)#

Submit channel transfer paramter directly.

This function used to configue channel head descriptor that is used to start DMA transfer, the head descriptor table is defined in DMA driver, it is useful for the case:

for the single transfer, application doesn’t need to allocate descriptor table, the head descriptor can be used for it.

   DMA_SetChannelConfig(base, channel, trigger, isPeriph);
   DMA_CreateHandle(handle, base, channel)
   DMA_SubmitChannelTransferParameter(handle, DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc,
bytes), srcStartAddr, dstStartAddr, NULL);
   DMA_StartTransfer(handle)

for the linked transfer, application should responsible for link descriptor, for example, if 4 transfer is required, then application should prepare three descriptor table with macro , the head descriptor in driver can be used for the first transfer descriptor.

   define link descriptor table in application with macro
   DMA_ALLOCATE_LINK_DESCRIPTOR(nextDesc[3]);

   DMA_SetupDescriptor(nextDesc0,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc1);
   DMA_SetupDescriptor(nextDesc1,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc2);
   DMA_SetupDescriptor(nextDesc2,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, NULL);
   DMA_SetChannelConfig(base, channel, trigger, isPeriph);
   DMA_CreateHandle(handle, base, channel)
   DMA_SubmitChannelTransferParameter(handle, DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc,
bytes), srcStartAddr, dstStartAddr, nextDesc0);
   DMA_StartTransfer(handle);

Parameters:

handle – Pointer to DMA handle.
xferCfg – xfer configuration, user can reference DMA_CHANNEL_XFER about to how to get xferCfg value.
srcStartAddr – source start address.
dstStartAddr – destination start address.
nextDesc – address of next descriptor.

void DMA_SubmitChannelDescriptor(dma_handle_t *handle, dma_descriptor_t *descriptor)#

Submit channel descriptor.

This function used to configue channel head descriptor that is used to start DMA transfer, the head descriptor table is defined in DMA driver, this functiono is typical for the ping pong case:

for the ping pong case, application should responsible for the descriptor, for example, application should prepare two descriptor table with macro.

   define link descriptor table in application with macro
   DMA_ALLOCATE_LINK_DESCRIPTOR(nextDesc[2]);

   DMA_SetupDescriptor(nextDesc0,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc1);
   DMA_SetupDescriptor(nextDesc1,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc0);
   DMA_SetChannelConfig(base, channel, trigger, isPeriph);
   DMA_CreateHandle(handle, base, channel)
   DMA_SubmitChannelDescriptor(handle,  nextDesc0);
   DMA_StartTransfer(handle);

Parameters:

handle – Pointer to DMA handle.
descriptor – descriptor to submit.

status_t DMA_SubmitChannelTransfer(dma_handle_t *handle, dma_channel_config_t *config)#

Submits the DMA channel transfer request.

for the single transfer, application doesn’t need to allocate descriptor table, the head descriptor can be used for it.

DMA_CreateHandle(handle, base, channel)
DMA_PrepareChannelTransfer(config,srcStartAddr,dstStartAddr,xferCfg,type,trigger,NULL);
DMA_SubmitChannelTransfer(handle, config)
DMA_StartTransfer(handle)

   define link descriptor table in application with macro
   DMA_ALLOCATE_LINK_DESCRIPTOR(nextDesc);
   DMA_SetupDescriptor(nextDesc0,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc1);
   DMA_SetupDescriptor(nextDesc1,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc2);
   DMA_SetupDescriptor(nextDesc2,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, NULL);
   DMA_CreateHandle(handle, base, channel)
   DMA_PrepareChannelTransfer(config,srcStartAddr,dstStartAddr,xferCfg,type,trigger,nextDesc0);
   DMA_SubmitChannelTransfer(handle, config)
   DMA_StartTransfer(handle)

for the ping pong case, application should responsible for link descriptor, for example, application should prepare two descriptor table with macro , the head descriptor in driver can be used for the first transfer descriptor.

   define link descriptor table in application with macro
   DMA_ALLOCATE_LINK_DESCRIPTOR(nextDesc);

   DMA_SetupDescriptor(nextDesc0,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc1);
   DMA_SetupDescriptor(nextDesc1,  DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes),
srcStartAddr, dstStartAddr, nextDesc0);
   DMA_CreateHandle(handle, base, channel)
   DMA_PrepareChannelTransfer(config,srcStartAddr,dstStartAddr,xferCfg,type,trigger,nextDesc0);
   DMA_SubmitChannelTransfer(handle, config)
   DMA_StartTransfer(handle)

Parameters:

handle – DMA handle pointer.
config – Pointer to DMA transfer configuration structure.

Return values:

kStatus_DMA_Success – It means submit transfer request succeed.
kStatus_DMA_QueueFull – It means TCD queue is full. Submit transfer request is not allowed.
kStatus_DMA_Busy – It means the given channel is busy, need to submit request later.

void DMA_StartTransfer(dma_handle_t *handle)#

DMA start transfer.

This function enables the channel request. User can call this function after submitting the transfer request It will trigger transfer start with software trigger only when hardware trigger is not used.

Parameters:

handle – DMA handle pointer.

void DMA_IRQHandle(DMA_Type *base)#

DMA IRQ handler for descriptor transfer complete.

This function clears the channel major interrupt flag and call the callback function if it is not NULL.

Parameters:

base – DMA base address.

void DMA_DriverIRQHandler(uint32_t instance)#

DMA common IRQ handler entry for parameterized dispatch.

Parameters:

instance – DMA peripheral instance number.

FSL_DMA_DRIVER_VERSION#

DMA driver version.

Version 2.5.5.

_dma_transfer_status DMA transfer status

Values:

enumerator kStatus_DMA_Busy#: Channel is busy and can’t handle the transfer request.

_dma_addr_interleave_size dma address interleave size

Values:

enumerator kDMA_AddressInterleave0xWidth#: dma source/destination address no interleave

enumerator kDMA_AddressInterleave1xWidth#: dma source/destination address interleave 1xwidth

enumerator kDMA_AddressInterleave2xWidth#: dma source/destination address interleave 2xwidth

enumerator kDMA_AddressInterleave4xWidth#: dma source/destination address interleave 3xwidth

_dma_transfer_width dma transfer width

Values:

enumerator kDMA_Transfer8BitWidth#: dma channel transfer bit width is 8 bit

enumerator kDMA_Transfer16BitWidth#: dma channel transfer bit width is 16 bit

enumerator kDMA_Transfer32BitWidth#: dma channel transfer bit width is 32 bit

enum _dma_priority#

DMA channel priority.

Values:

enumerator kDMA_ChannelPriority0#: Highest channel priority - priority 0

enumerator kDMA_ChannelPriority1#: Channel priority 1

enumerator kDMA_ChannelPriority2#: Channel priority 2

enumerator kDMA_ChannelPriority3#: Channel priority 3

enumerator kDMA_ChannelPriority4#: Channel priority 4

enumerator kDMA_ChannelPriority5#: Channel priority 5

enumerator kDMA_ChannelPriority6#: Channel priority 6

enumerator kDMA_ChannelPriority7#: Lowest channel priority - priority 7

enum _dma_int#

DMA interrupt flags.

Values:

enumerator kDMA_IntA#: DMA interrupt flag A

enumerator kDMA_IntB#: DMA interrupt flag B

enumerator kDMA_IntError#: DMA interrupt flag error

enum _dma_trigger_type#

DMA trigger type.

Values:

enumerator kDMA_NoTrigger#: Trigger is disabled

enumerator kDMA_LowLevelTrigger#: Low level active trigger

enumerator kDMA_HighLevelTrigger#: High level active trigger

enumerator kDMA_FallingEdgeTrigger#: Falling edge active trigger

enumerator kDMA_RisingEdgeTrigger#: Rising edge active trigger

_dma_burst_size DMA burst size

Values:

enumerator kDMA_BurstSize1#: burst size 1 transfer

enumerator kDMA_BurstSize2#: burst size 2 transfer

enumerator kDMA_BurstSize4#: burst size 4 transfer

enumerator kDMA_BurstSize8#: burst size 8 transfer

enumerator kDMA_BurstSize16#: burst size 16 transfer

enumerator kDMA_BurstSize32#: burst size 32 transfer

enumerator kDMA_BurstSize64#: burst size 64 transfer

enumerator kDMA_BurstSize128#: burst size 128 transfer

enumerator kDMA_BurstSize256#: burst size 256 transfer

enumerator kDMA_BurstSize512#: burst size 512 transfer

enumerator kDMA_BurstSize1024#: burst size 1024 transfer

enum _dma_trigger_burst#

DMA trigger burst.

Values:

enumerator kDMA_SingleTransfer#: Single transfer

enumerator kDMA_LevelBurstTransfer#: Burst transfer driven by level trigger

enumerator kDMA_EdgeBurstTransfer1#: Perform 1 transfer by edge trigger

enumerator kDMA_EdgeBurstTransfer2#: Perform 2 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer4#: Perform 4 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer8#: Perform 8 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer16#: Perform 16 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer32#: Perform 32 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer64#: Perform 64 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer128#: Perform 128 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer256#: Perform 256 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer512#: Perform 512 transfers by edge trigger

enumerator kDMA_EdgeBurstTransfer1024#: Perform 1024 transfers by edge trigger

enum _dma_burst_wrap#

DMA burst wrapping.

Values:

enumerator kDMA_NoWrap#: Wrapping is disabled

enumerator kDMA_SrcWrap#: Wrapping is enabled for source

enumerator kDMA_DstWrap#: Wrapping is enabled for destination

enumerator kDMA_SrcAndDstWrap#: Wrapping is enabled for source and destination

enum _dma_transfer_type#

DMA transfer type.

Values:

enumerator kDMA_MemoryToMemory#: Transfer from memory to memory (increment source and destination)

enumerator kDMA_PeripheralToMemory#: Transfer from peripheral to memory (increment only destination)

enumerator kDMA_MemoryToPeripheral#: Transfer from memory to peripheral (increment only source)

enumerator kDMA_StaticToStatic#: Peripheral to static memory (do not increment source or destination)

typedef struct _dma_descriptor dma_descriptor_t#: DMA descriptor structure.

typedef struct _dma_xfercfg dma_xfercfg_t#: DMA transfer configuration.

typedef enum _dma_priority dma_priority_t#: DMA channel priority.

typedef enum _dma_int dma_irq_t#: DMA interrupt flags.

typedef enum _dma_trigger_type dma_trigger_type_t#: DMA trigger type.

typedef enum _dma_trigger_burst dma_trigger_burst_t#: DMA trigger burst.

typedef enum _dma_burst_wrap dma_burst_wrap_t#: DMA burst wrapping.

typedef enum _dma_transfer_type dma_transfer_type_t#: DMA transfer type.

typedef struct _dma_channel_trigger dma_channel_trigger_t#: DMA channel trigger.

typedef struct _dma_channel_config dma_channel_config_t#: DMA channel trigger.

typedef struct _dma_transfer_config dma_transfer_config_t#: DMA transfer configuration.

typedef void (*dma_callback)(struct _dma_handle *handle, void *userData, bool transferDone, uint32_t intmode)#: Define Callback function for DMA.

typedef struct _dma_handle dma_handle_t#: DMA transfer handle structure.

DMA_MAX_TRANSFER_COUNT#: DMA max transfer size.

FSL_FEATURE_DMA_NUMBER_OF_CHANNELSn(x)#: DMA channel numbers.

FSL_FEATURE_DMA_MAX_CHANNELS#

FSL_FEATURE_DMA_ALL_CHANNELS#

FSL_FEATURE_DMA_LINK_DESCRIPTOR_ALIGN_SIZE#: DMA head link descriptor table align size.

DMA_ALLOCATE_HEAD_DESCRIPTORS(name, number)#

DMA head descriptor table allocate macro To simplify user interface, this macro will help allocate descriptor memory, user just need to provide the name and the number for the allocate descriptor.

Parameters:

name – Allocate decriptor name.
number – Number of descriptor to be allocated.

DMA_ALLOCATE_HEAD_DESCRIPTORS_AT_NONCACHEABLE(name, number)#

DMA head descriptor table allocate macro at noncacheable section To simplify user interface, this macro will help allocate descriptor memory at noncacheable section, user just need to provide the name and the number for the allocate descriptor.

Parameters:

name – Allocate decriptor name.
number – Number of descriptor to be allocated.

DMA_ALLOCATE_LINK_DESCRIPTORS(name, number)#

DMA link descriptor table allocate macro To simplify user interface, this macro will help allocate descriptor memory, user just need to provide the name and the number for the allocate descriptor.

Parameters:

name – Allocate decriptor name.
number – Number of descriptor to be allocated.

DMA_ALLOCATE_LINK_DESCRIPTORS_AT_NONCACHEABLE(name, number)#

DMA link descriptor table allocate macro at noncacheable section To simplify user interface, this macro will help allocate descriptor memory at noncacheable section, user just need to provide the name and the number for the allocate descriptor.

Parameters:

name – Allocate decriptor name.
number – Number of descriptor to be allocated.

DMA_ALLOCATE_DATA_TRANSFER_BUFFER(name, width)#: DMA transfer buffer address need to align with the transfer width.

DMA_CHANNEL_GROUP(channel)#

DMA_CHANNEL_INDEX(base, channel)#

DMA_COMMON_REG_GET(base, channel, reg)#: DMA linked descriptor address algin size.

DMA_COMMON_CONST_REG_GET(base, channel, reg)#

DMA_COMMON_REG_SET(base, channel, reg, value)#

DMA_DESCRIPTOR_END_ADDRESS(start, inc, bytes, width)#

DMA descriptor end address calculate.

Parameters:

start – start address
inc – address interleave size
bytes – transfer bytes
width – transfer width

DMA_CHANNEL_XFER(reload, clrTrig, intA, intB, width, srcInc, dstInc, bytes)#

struct _dma_descriptor#

#include <fsl_dma.h>

DMA descriptor structure.

Public Members

volatile uint32_t xfercfg#: Transfer configuration

void *srcEndAddr#: Last source address of DMA transfer

void *dstEndAddr#: Last destination address of DMA transfer

void *linkToNextDesc#: Address of next DMA descriptor in chain

struct _dma_xfercfg#

#include <fsl_dma.h>

DMA transfer configuration.

Public Members

bool valid#: Descriptor is ready to transfer

bool reload#: Reload channel configuration register after current descriptor is exhausted

bool swtrig#: Perform software trigger. Transfer if fired when ‘valid’ is set

bool clrtrig#: Clear trigger

bool intA#: Raises IRQ when transfer is done and set IRQA status register flag

bool intB#: Raises IRQ when transfer is done and set IRQB status register flag

uint8_t byteWidth#: Byte width of data to transfer

uint8_t srcInc#: Increment source address by ‘srcInc’ x ‘byteWidth’

uint8_t dstInc#: Increment destination address by ‘dstInc’ x ‘byteWidth’

uint16_t transferCount#: Number of transfers

struct _dma_channel_trigger#

#include <fsl_dma.h>

DMA channel trigger.

Public Members

dma_trigger_type_t type#: Select hardware trigger as edge triggered or level triggered.

dma_trigger_burst_t burst#: Select whether hardware triggers cause a single or burst transfer.

dma_burst_wrap_t wrap#: Select wrap type, source wrap or dest wrap, or both.

struct _dma_channel_config#

#include <fsl_dma.h>

DMA channel trigger.

Public Members

void *srcStartAddr#: Source data address

void *dstStartAddr#: Destination data address

void *nextDesc#: Chain custom descriptor

uint32_t xferCfg#: channel transfer configurations

dma_channel_trigger_t *trigger#: DMA trigger type

bool isPeriph#: select the request type

struct _dma_transfer_config#

#include <fsl_dma.h>

DMA transfer configuration.

Public Members

uint8_t *srcAddr#: Source data address

uint8_t *dstAddr#: Destination data address

uint8_t *nextDesc#: Chain custom descriptor

dma_xfercfg_t xfercfg#: Transfer options

bool isPeriph#: DMA transfer is driven by peripheral

struct _dma_handle#

#include <fsl_dma.h>

DMA transfer handle structure.

Public Members

dma_callback callback#: Callback function. Invoked when transfer of descriptor with interrupt flag finishes

void *userData#: Callback function parameter

DMA_Type *base#: DMA peripheral base address

uint8_t channel#: DMA channel number

I2C: Inter-Integrated Circuit Driver#

I2C Driver#

FSL_I2C_DRIVER_VERSION#: I2C driver version.

I2C status return codes.

Values:

enumerator kStatus_I2C_Busy#: The master is already performing a transfer.

enumerator kStatus_I2C_Idle#: The slave driver is idle.

enumerator kStatus_I2C_Nak#: The slave device sent a NAK in response to a byte.

enumerator kStatus_I2C_InvalidParameter#: Unable to proceed due to invalid parameter.

enumerator kStatus_I2C_BitError#: Transferred bit was not seen on the bus.

enumerator kStatus_I2C_ArbitrationLost#: Arbitration lost error.

enumerator kStatus_I2C_NoTransferInProgress#: Attempt to abort a transfer when one is not in progress.

enumerator kStatus_I2C_DmaRequestFail#: DMA request failed.

enumerator kStatus_I2C_StartStopError#: Start and stop error.

enumerator kStatus_I2C_UnexpectedState#: Unexpected state.

enumerator kStatus_I2C_Addr_Nak#: NAK received during the address probe.

enumerator kStatus_I2C_Timeout#: Timeout polling status flags.

I2C_RETRY_TIMES#: Retry times for waiting flag.

I2C_STAT_MSTCODE_IDLE#: Master Idle State Code

I2C_STAT_MSTCODE_RXREADY#: Master Receive Ready State Code

I2C_STAT_MSTCODE_TXREADY#: Master Transmit Ready State Code

I2C_STAT_MSTCODE_NACKADR#: Master NACK by slave on address State Code

I2C_STAT_MSTCODE_NACKDAT#: Master NACK by slave on data State Code

I2C_STAT_SLVST_ADDR#

I2C_STAT_SLVST_RX#

I2C_STAT_SLVST_TX#

I2C Master Driver#

void I2C_MasterGetDefaultConfig(i2c_master_config_t *masterConfig)#

Provides a default configuration for the I2C master peripheral.

This function provides the following default configuration for the I2C master peripheral:

masterConfig->enableMaster            = true;
masterConfig->baudRate_Bps            = 100000U;
masterConfig->enableTimeout           = false;

After calling this function, you can override any settings in order to customize the configuration, prior to initializing the master driver with I2C_MasterInit().

Parameters:

masterConfig – [out] User provided configuration structure for default values. Refer to i2c_master_config_t.

void I2C_MasterInit(I2C_Type *base, const i2c_master_config_t *masterConfig, uint32_t srcClock_Hz)#

Initializes the I2C master peripheral.

This function enables the peripheral clock and initializes the I2C master peripheral as described by the user provided configuration. A software reset is performed prior to configuration.

Parameters:

base – The I2C peripheral base address.
masterConfig – User provided peripheral configuration. Use I2C_MasterGetDefaultConfig() to get a set of defaults that you can override.
srcClock_Hz – Frequency in Hertz of the I2C functional clock. Used to calculate the baud rate divisors, filter widths, and timeout periods.

void I2C_MasterDeinit(I2C_Type *base)#

Deinitializes the I2C master peripheral.

This function disables the I2C master peripheral and gates the clock. It also performs a software reset to restore the peripheral to reset conditions.

Parameters:

base – The I2C peripheral base address.

uint32_t I2C_GetInstance(I2C_Type *base)#

Returns an instance number given a base address.

If an invalid base address is passed, debug builds will assert. Release builds will just return instance number 0.

Parameters:

base – The I2C peripheral base address.

Returns:

I2C instance number starting from 0.

static inline void I2C_MasterReset(I2C_Type *base)#

Performs a software reset.

Restores the I2C master peripheral to reset conditions.

Parameters:

base – The I2C peripheral base address.

static inline void I2C_MasterEnable(I2C_Type *base, bool enable)#

Enables or disables the I2C module as master.

Parameters:

base – The I2C peripheral base address.
enable – Pass true to enable or false to disable the specified I2C as master.

static inline uint32_t I2C_GetStatusFlags(I2C_Type *base)#

Gets the I2C status flags.

A bit mask with the state of all I2C status flags is returned. For each flag, the corresponding bit in the return value is set if the flag is asserted.

See also

_i2c_master_flags

Parameters:

base – The I2C peripheral base address.

Returns:

State of the status flags:

1: related status flag is set.
0: related status flag is not set.

static inline void I2C_MasterClearStatusFlags(I2C_Type *base, uint32_t statusMask)#

Clears the I2C master status flag state.

The following status register flags can be cleared:

kI2C_MasterArbitrationLostFlag
kI2C_MasterStartStopErrorFlag

Attempts to clear other flags has no effect.

See also

_i2c_master_flags.

Parameters:

base – The I2C peripheral base address.
statusMask – A bitmask of status flags that are to be cleared. The mask is composed of _i2c_master_flags enumerators OR’d together. You may pass the result of a previous call to I2C_GetStatusFlags().

static inline void I2C_EnableInterrupts(I2C_Type *base, uint32_t interruptMask)#

Enables the I2C master interrupt requests.

Parameters:

base – The I2C peripheral base address.
interruptMask – Bit mask of interrupts to enable. See _i2c_master_flags for the set of constants that should be OR’d together to form the bit mask.

static inline void I2C_DisableInterrupts(I2C_Type *base, uint32_t interruptMask)#

Disables the I2C master interrupt requests.

Parameters:

base – The I2C peripheral base address.
interruptMask – Bit mask of interrupts to disable. See _i2c_master_flags for the set of constants that should be OR’d together to form the bit mask.

static inline uint32_t I2C_GetEnabledInterrupts(I2C_Type *base)#

Returns the set of currently enabled I2C master interrupt requests.

Parameters:

base – The I2C peripheral base address.

Returns:

A bitmask composed of _i2c_master_flags enumerators OR’d together to indicate the set of enabled interrupts.

void I2C_MasterSetBaudRate(I2C_Type *base, uint32_t baudRate_Bps, uint32_t srcClock_Hz)#

Sets the I2C bus frequency for master transactions.

The I2C master is automatically disabled and re-enabled as necessary to configure the baud rate. Do not call this function during a transfer, or the transfer is aborted.

Parameters:

base – The I2C peripheral base address.
srcClock_Hz – I2C functional clock frequency in Hertz.
baudRate_Bps – Requested bus frequency in bits per second.

static inline bool I2C_MasterGetBusIdleState(I2C_Type *base)#

Returns whether the bus is idle.

Requires the master mode to be enabled.

Parameters:

base – The I2C peripheral base address.

Return values:

true – Bus is busy.
false – Bus is idle.

status_t I2C_MasterStart(I2C_Type *base, uint8_t address, i2c_direction_t direction)#

Sends a START on the I2C bus.

This function is used to initiate a new master mode transfer by sending the START signal. The slave address is sent following the I2C START signal.

Parameters:

base – I2C peripheral base pointer
address – 7-bit slave device address.
direction – Master transfer directions(transmit/receive).

Return values:

kStatus_Success – Successfully send the start signal.
kStatus_I2C_Busy – Current bus is busy.

status_t I2C_MasterStop(I2C_Type *base)#

Sends a STOP signal on the I2C bus.

Return values:

kStatus_Success – Successfully send the stop signal.
kStatus_I2C_Timeout – Send stop signal failed, timeout.

static inline status_t I2C_MasterRepeatedStart(I2C_Type *base, uint8_t address, i2c_direction_t direction)#

Sends a REPEATED START on the I2C bus.

Parameters:

base – I2C peripheral base pointer
address – 7-bit slave device address.
direction – Master transfer directions(transmit/receive).

Return values:

kStatus_Success – Successfully send the start signal.
kStatus_I2C_Busy – Current bus is busy but not occupied by current I2C master.

status_t I2C_MasterWriteBlocking(I2C_Type *base, const void *txBuff, size_t txSize, uint32_t flags)#

Performs a polling send transfer on the I2C bus.

Sends up to txSize number of bytes to the previously addressed slave device. The slave may reply with a NAK to any byte in order to terminate the transfer early. If this happens, this function returns kStatus_I2C_Nak.

Parameters:

base – The I2C peripheral base address.
txBuff – The pointer to the data to be transferred.
txSize – The length in bytes of the data to be transferred.
flags – Transfer control flag to control special behavior like suppressing start or stop, for normal transfers use kI2C_TransferDefaultFlag

Return values:

kStatus_Success – Data was sent successfully.
kStatus_I2C_Busy – Another master is currently utilizing the bus.
kStatus_I2C_Nak – The slave device sent a NAK in response to a byte.
kStatus_I2C_ArbitrationLost – Arbitration lost error.

status_t I2C_MasterReadBlocking(I2C_Type *base, void *rxBuff, size_t rxSize, uint32_t flags)#

Performs a polling receive transfer on the I2C bus.

Parameters:

base – The I2C peripheral base address.
rxBuff – The pointer to the data to be transferred.
rxSize – The length in bytes of the data to be transferred.
flags – Transfer control flag to control special behavior like suppressing start or stop, for normal transfers use kI2C_TransferDefaultFlag

Return values:

kStatus_Success – Data was received successfully.
kStatus_I2C_Busy – Another master is currently utilizing the bus.
kStatus_I2C_Nak – The slave device sent a NAK in response to a byte.
kStatus_I2C_ArbitrationLost – Arbitration lost error.

status_t I2C_MasterTransferBlocking(I2C_Type *base, i2c_master_transfer_t *xfer)#

Performs a master polling transfer on the I2C bus.

Note

The API does not return until the transfer succeeds or fails due to arbitration lost or receiving a NAK.

Parameters:

base – I2C peripheral base address.
xfer – Pointer to the transfer structure.

Return values:

kStatus_Success – Successfully complete the data transmission.
kStatus_I2C_Busy – Previous transmission still not finished.
kStatus_I2C_Timeout – Transfer error, wait signal timeout.
kStatus_I2C_ArbitrationLost – Transfer error, arbitration lost.
kStataus_I2C_Nak – Transfer error, receive NAK during transfer.

void I2C_MasterTransferCreateHandle(I2C_Type *base, i2c_master_handle_t *handle, i2c_master_transfer_callback_t callback, void *userData)#

Creates a new handle for the I2C master non-blocking APIs.

The creation of a handle is for use with the non-blocking APIs. Once a handle is created, there is not a corresponding destroy handle. If the user wants to terminate a transfer, the I2C_MasterTransferAbort() API shall be called.

Parameters:

base – The I2C peripheral base address.
handle – [out] Pointer to the I2C master driver handle.
callback – User provided pointer to the asynchronous callback function.
userData – User provided pointer to the application callback data.

status_t I2C_MasterTransferNonBlocking(I2C_Type *base, i2c_master_handle_t *handle, i2c_master_transfer_t *xfer)#

Performs a non-blocking transaction on the I2C bus.

Parameters:

base – The I2C peripheral base address.
handle – Pointer to the I2C master driver handle.
xfer – The pointer to the transfer descriptor.

Return values:

kStatus_Success – The transaction was started successfully.
kStatus_I2C_Busy – Either another master is currently utilizing the bus, or a non-blocking transaction is already in progress.

status_t I2C_MasterTransferGetCount(I2C_Type *base, i2c_master_handle_t *handle, size_t *count)#

Returns number of bytes transferred so far.

Parameters:

base – The I2C peripheral base address.
handle – Pointer to the I2C master driver handle.
count – [out] Number of bytes transferred so far by the non-blocking transaction.

Return values:

kStatus_Success –
kStatus_I2C_Busy –

status_t I2C_MasterTransferAbort(I2C_Type *base, i2c_master_handle_t *handle)#

Terminates a non-blocking I2C master transmission early.

Note

It is not safe to call this function from an IRQ handler that has a higher priority than the I2C peripheral’s IRQ priority.

Parameters:

base – The I2C peripheral base address.
handle – Pointer to the I2C master driver handle.

Return values:

kStatus_Success – A transaction was successfully aborted.
kStatus_I2C_Timeout – Abort failure due to flags polling timeout.

void I2C_MasterTransferHandleIRQ(I2C_Type *base, void *i2cHandle)#

Reusable routine to handle master interrupts.

Note

This function does not need to be called unless you are reimplementing the nonblocking API’s interrupt handler routines to add special functionality.

Parameters:

base – The I2C peripheral base address.
i2cHandle – Pointer to the I2C master driver handle i2c_master_handle_t.

void I2C_DriverIRQHandler(uint32_t instance)#

I2C common IRQ handler entry for parameterized dispatch.

Parameters:

instance – I2C peripheral instance number.

enum _i2c_master_flags#

I2C master peripheral flags.

Note

These enums are meant to be OR’d together to form a bit mask.

Values:

enumerator kI2C_MasterPendingFlag#: The I2C module is waiting for software interaction.

enumerator kI2C_MasterArbitrationLostFlag#: The arbitration of the bus was lost. There was collision on the bus

enumerator kI2C_MasterStartStopErrorFlag#: There was an error during start or stop phase of the transaction.

enum _i2c_direction#

Direction of master and slave transfers.

Values:

enumerator kI2C_Write#: Master transmit.

enumerator kI2C_Read#: Master receive.

enum _i2c_master_transfer_flags#

Transfer option flags.

Note

These enumerations are intended to be OR’d together to form a bit mask of options for the _i2c_master_transfer::flags field.

Values:

enumerator kI2C_TransferDefaultFlag#: Transfer starts with a start signal, stops with a stop signal.

enumerator kI2C_TransferNoStartFlag#: Don’t send a start condition, address, and sub address

enumerator kI2C_TransferRepeatedStartFlag#: Send a repeated start condition

enumerator kI2C_TransferNoStopFlag#: Don’t send a stop condition.

enum _i2c_transfer_states#

States for the state machine used by transactional APIs.

Values:

enumerator kIdleState#

enumerator kTransmitSubaddrState#

enumerator kTransmitDataState#

enumerator kReceiveDataBeginState#

enumerator kReceiveDataState#

enumerator kReceiveLastDataState#

enumerator kStartState#

enumerator kStopState#

enumerator kWaitForCompletionState#

typedef enum _i2c_direction i2c_direction_t#: Direction of master and slave transfers.

typedef struct _i2c_master_config i2c_master_config_t#

Structure with settings to initialize the I2C master module.

This structure holds configuration settings for the I2C peripheral. To initialize this structure to reasonable defaults, call the I2C_MasterGetDefaultConfig() function and pass a pointer to your configuration structure instance.

The configuration structure can be made constant so it resides in flash.

typedef struct _i2c_master_transfer i2c_master_transfer_t#: I2C master transfer typedef.

typedef struct _i2c_master_handle i2c_master_handle_t#: I2C master handle typedef.

typedef void (*i2c_master_transfer_callback_t)(I2C_Type *base, i2c_master_handle_t *handle, status_t completionStatus, void *userData)#

Master completion callback function pointer type.

This callback is used only for the non-blocking master transfer API. Specify the callback you wish to use in the call to I2C_MasterTransferCreateHandle().

Param base:: The I2C peripheral base address.
Param completionStatus:: Either kStatus_Success or an error code describing how the transfer completed.
Param userData:: Arbitrary pointer-sized value passed from the application.

struct _i2c_master_config#

#include <fsl_i2c.h>

Structure with settings to initialize the I2C master module.

The configuration structure can be made constant so it resides in flash.

Public Members

bool enableMaster#: Whether to enable master mode.

uint32_t baudRate_Bps#: Desired baud rate in bits per second.

bool enableTimeout#: Enable internal timeout function.

struct _i2c_master_transfer#

#include <fsl_i2c.h>

Non-blocking transfer descriptor structure.

This structure is used to pass transaction parameters to the I2C_MasterTransferNonBlocking() API.

Public Members

uint32_t flags#: Bit mask of options for the transfer. See enumeration _i2c_master_transfer_flags for available options. Set to 0 or kI2C_TransferDefaultFlag for normal transfers.

uint16_t slaveAddress#: The 7-bit slave address.

i2c_direction_t direction#: Either kI2C_Read or kI2C_Write.

uint32_t subaddress#: Sub address. Transferred MSB first.

size_t subaddressSize#: Length of sub address to send in bytes. Maximum size is 4 bytes.

void *data#: Pointer to data to transfer.

size_t dataSize#: Number of bytes to transfer.

struct _i2c_master_handle#

#include <fsl_i2c.h>

Driver handle for master non-blocking APIs.

Note

The contents of this structure are private and subject to change.

Public Members

uint8_t state#: Transfer state machine current state.

uint32_t transferCount#: Indicates progress of the transfer

uint32_t remainingBytes#: Remaining byte count in current state.

uint8_t *buf#: Buffer pointer for current state.

i2c_master_transfer_t transfer#: Copy of the current transfer info.

i2c_master_transfer_callback_t completionCallback#: Callback function pointer.

void *userData#: Application data passed to callback.

I2C Slave Driver#

void I2C_SlaveGetDefaultConfig(i2c_slave_config_t *slaveConfig)#

Provides a default configuration for the I2C slave peripheral.

This function provides the following default configuration for the I2C slave peripheral:

slaveConfig->enableSlave = true;
slaveConfig->address0.disable = false;
slaveConfig->address0.address = 0u;
slaveConfig->address1.disable = true;
slaveConfig->address2.disable = true;
slaveConfig->address3.disable = true;
slaveConfig->busSpeed = kI2C_SlaveStandardMode;

After calling this function, override any settings to customize the configuration, prior to initializing the master driver with I2C_SlaveInit(). Be sure to override at least the address0.address member of the configuration structure with the desired slave address.

Parameters:

slaveConfig – [out] User provided configuration structure that is set to default values. Refer to i2c_slave_config_t.

status_t I2C_SlaveInit(I2C_Type *base, const i2c_slave_config_t *slaveConfig, uint32_t srcClock_Hz)#

Initializes the I2C slave peripheral.

This function enables the peripheral clock and initializes the I2C slave peripheral as described by the user provided configuration.

Parameters:

base – The I2C peripheral base address.
slaveConfig – User provided peripheral configuration. Use I2C_SlaveGetDefaultConfig() to get a set of defaults that you can override.
srcClock_Hz – Frequency in Hertz of the I2C functional clock. Used to calculate CLKDIV value to provide enough data setup time for master when slave stretches the clock.

void I2C_SlaveSetAddress(I2C_Type *base, i2c_slave_address_register_t addressRegister, uint8_t address, bool addressDisable)#

Configures Slave Address n register.

This function writes new value to Slave Address register.

Parameters:

base – The I2C peripheral base address.
addressRegister – The module supports multiple address registers. The parameter determines which one shall be changed.
address – The slave address to be stored to the address register for matching.
addressDisable – Disable matching of the specified address register.

void I2C_SlaveDeinit(I2C_Type *base)#

Deinitializes the I2C slave peripheral.

This function disables the I2C slave peripheral and gates the clock. It also performs a software reset to restore the peripheral to reset conditions.

Parameters:

base – The I2C peripheral base address.

static inline void I2C_SlaveEnable(I2C_Type *base, bool enable)#

Enables or disables the I2C module as slave.

Parameters:

base – The I2C peripheral base address.
enable – True to enable or flase to disable.

static inline void I2C_SlaveClearStatusFlags(I2C_Type *base, uint32_t statusMask)#

Clears the I2C status flag state.

The following status register flags can be cleared:

slave deselected flag

Attempts to clear other flags has no effect.

See also

_i2c_slave_flags.

Parameters:

base – The I2C peripheral base address.
statusMask – A bitmask of status flags that are to be cleared. The mask is composed of _i2c_slave_flags enumerators OR’d together. You may pass the result of a previous call to I2C_SlaveGetStatusFlags().

status_t I2C_SlaveWriteBlocking(I2C_Type *base, const uint8_t *txBuff, size_t txSize)#

Performs a polling send transfer on the I2C bus.

The function executes blocking address phase and blocking data phase.

Parameters:

base – The I2C peripheral base address.
txBuff – The pointer to the data to be transferred.
txSize – The length in bytes of the data to be transferred.

Returns:

kStatus_Success Data has been sent.

Returns:

kStatus_Fail Unexpected slave state (master data write while master read from slave is expected).

status_t I2C_SlaveReadBlocking(I2C_Type *base, uint8_t *rxBuff, size_t rxSize)#

Performs a polling receive transfer on the I2C bus.

The function executes blocking address phase and blocking data phase.

Parameters:

base – The I2C peripheral base address.
rxBuff – The pointer to the data to be transferred.
rxSize – The length in bytes of the data to be transferred.

Returns:

kStatus_Success Data has been received.

Returns:

kStatus_Fail Unexpected slave state (master data read while master write to slave is expected).

void I2C_SlaveTransferCreateHandle(I2C_Type *base, i2c_slave_handle_t *handle, i2c_slave_transfer_callback_t callback, void *userData)#

Creates a new handle for the I2C slave non-blocking APIs.

Parameters:

base – The I2C peripheral base address.
handle – [out] Pointer to the I2C slave driver handle.
callback – User provided pointer to the asynchronous callback function.
userData – User provided pointer to the application callback data.

status_t I2C_SlaveTransferNonBlocking(I2C_Type *base, i2c_slave_handle_t *handle, uint32_t eventMask)#

Starts accepting slave transfers.

Call this API after calling I2C_SlaveInit() and I2C_SlaveTransferCreateHandle() to start processing transactions driven by an I2C master. The slave monitors the I2C bus and pass events to the callback that was passed into the call to I2C_SlaveTransferCreateHandle(). The callback is always invoked from the interrupt context.

If no slave Tx transfer is busy, a master read from slave request invokes kI2C_SlaveTransmitEvent callback. If no slave Rx transfer is busy, a master write to slave request invokes kI2C_SlaveReceiveEvent callback.

The set of events received by the callback is customizable. To do so, set the eventMask parameter to the OR’d combination of i2c_slave_transfer_event_t enumerators for the events you wish to receive. The kI2C_SlaveTransmitEvent and kI2C_SlaveReceiveEvent events are always enabled and do not need to be included in the mask. Alternatively, you can pass 0 to get a default set of only the transmit and receive events that are always enabled. In addition, the kI2C_SlaveAllEvents constant is provided as a convenient way to enable all events.

Parameters:

base – The I2C peripheral base address.
handle – Pointer to i2c_slave_handle_t structure which stores the transfer state.
eventMask – Bit mask formed by OR’ing together i2c_slave_transfer_event_t enumerators to specify which events to send to the callback. Other accepted values are 0 to get a default set of only the transmit and receive events, and kI2C_SlaveAllEvents to enable all events.

Return values:

kStatus_Success – Slave transfers were successfully started.
kStatus_I2C_Busy – Slave transfers have already been started on this handle.

status_t I2C_SlaveSetSendBuffer(I2C_Type *base, volatile i2c_slave_transfer_t *transfer, const void *txData, size_t txSize, uint32_t eventMask)#

Starts accepting master read from slave requests.

The function can be called in response to kI2C_SlaveTransmitEvent callback to start a new slave Tx transfer from within the transfer callback.

Parameters:

base – The I2C peripheral base address.
transfer – Pointer to i2c_slave_transfer_t structure.
txData – Pointer to data to send to master.
txSize – Size of txData in bytes.
eventMask – Bit mask formed by OR’ing together i2c_slave_transfer_event_t enumerators to specify which events to send to the callback. Other accepted values are 0 to get a default set of only the transmit and receive events, and kI2C_SlaveAllEvents to enable all events.

Return values:

kStatus_Success – Slave transfers were successfully started.
kStatus_I2C_Busy – Slave transfers have already been started on this handle.

status_t I2C_SlaveSetReceiveBuffer(I2C_Type *base, volatile i2c_slave_transfer_t *transfer, void *rxData, size_t rxSize, uint32_t eventMask)#

Starts accepting master write to slave requests.

The function can be called in response to kI2C_SlaveReceiveEvent callback to start a new slave Rx transfer from within the transfer callback.

Parameters:

base – The I2C peripheral base address.
transfer – Pointer to i2c_slave_transfer_t structure.
rxData – Pointer to data to store data from master.
rxSize – Size of rxData in bytes.
eventMask – Bit mask formed by OR’ing together i2c_slave_transfer_event_t enumerators to specify which events to send to the callback. Other accepted values are 0 to get a default set of only the transmit and receive events, and kI2C_SlaveAllEvents to enable all events.

Return values:

kStatus_Success – Slave transfers were successfully started.
kStatus_I2C_Busy – Slave transfers have already been started on this handle.

static inline uint32_t I2C_SlaveGetReceivedAddress(I2C_Type *base, volatile i2c_slave_transfer_t *transfer)#

Returns the slave address sent by the I2C master.

This function should only be called from the address match event callback kI2C_SlaveAddressMatchEvent.

Parameters:

base – The I2C peripheral base address.
transfer – The I2C slave transfer.

Returns:

The 8-bit address matched by the I2C slave. Bit 0 contains the R/w direction bit, and the 7-bit slave address is in the upper 7 bits.

void I2C_SlaveTransferAbort(I2C_Type *base, i2c_slave_handle_t *handle)#

Aborts the slave non-blocking transfers.

Note

This API could be called at any time to stop slave for handling the bus events.

Parameters:

base – The I2C peripheral base address.
handle – Pointer to i2c_slave_handle_t structure which stores the transfer state.

Return values:

kStatus_Success –
kStatus_I2C_Idle –

status_t I2C_SlaveTransferGetCount(I2C_Type *base, i2c_slave_handle_t *handle, size_t *count)#

Gets the slave transfer remaining bytes during a interrupt non-blocking transfer.

Parameters:

base – I2C base pointer.
handle – pointer to i2c_slave_handle_t structure.
count – Number of bytes transferred so far by the non-blocking transaction.

Return values:

kStatus_InvalidArgument – count is Invalid.
kStatus_Success – Successfully return the count.

void I2C_SlaveTransferHandleIRQ(I2C_Type *base, void *i2cHandle)#

Reusable routine to handle slave interrupts.

Note

This function does not need to be called unless you are reimplementing the non blocking API’s interrupt handler routines to add special functionality.

Parameters:

base – The I2C peripheral base address.
i2cHandle – Pointer to i2c_slave_handle_t structure which stores the transfer state.

enum _i2c_slave_flags#

I2C slave peripheral flags.

Note

These enums are meant to be OR’d together to form a bit mask.

Values:

enumerator kI2C_SlavePendingFlag#: The I2C module is waiting for software interaction.

enumerator kI2C_SlaveNotStretching#: Indicates whether the slave is currently stretching clock (0 = yes, 1 = no).

enumerator kI2C_SlaveSelected#: Indicates whether the slave is selected by an address match.

enumerator kI2C_SaveDeselected#: Indicates that slave was previously deselected (deselect event took place, w1c).

enum _i2c_slave_address_register#

I2C slave address register.

Values:

enumerator kI2C_SlaveAddressRegister0#: Slave Address 0 register.

enumerator kI2C_SlaveAddressRegister1#: Slave Address 1 register.

enumerator kI2C_SlaveAddressRegister2#: Slave Address 2 register.

enumerator kI2C_SlaveAddressRegister3#: Slave Address 3 register.

enum _i2c_slave_address_qual_mode#

I2C slave address match options.

Values:

enumerator kI2C_QualModeMask#: The SLVQUAL0 field (qualAddress) is used as a logical mask for matching address0.

enumerator kI2C_QualModeExtend#: The SLVQUAL0 (qualAddress) field is used to extend address 0 matching in a range of addresses.

enum _i2c_slave_bus_speed#

I2C slave bus speed options.

Values:

enumerator kI2C_SlaveStandardMode#

enumerator kI2C_SlaveFastMode#

enumerator kI2C_SlaveFastModePlus#

enumerator kI2C_SlaveHsMode#

enum _i2c_slave_transfer_event#

Set of events sent to the callback for non blocking slave transfers.

These event enumerations are used for two related purposes. First, a bit mask created by OR’ing together events is passed to I2C_SlaveTransferNonBlocking() in order to specify which events to enable. Then, when the slave callback is invoked, it is passed the current event through its transfer parameter.

Note

These enumerations are meant to be OR’d together to form a bit mask of events.

Values:

enumerator kI2C_SlaveAddressMatchEvent#: Received the slave address after a start or repeated start.

enumerator kI2C_SlaveTransmitEvent#: Callback is requested to provide data to transmit (slave-transmitter role).

enumerator kI2C_SlaveReceiveEvent#: Callback is requested to provide a buffer in which to place received data (slave-receiver role).

enumerator kI2C_SlaveCompletionEvent#: All data in the active transfer have been consumed.

enumerator kI2C_SlaveDeselectedEvent#: The slave function has become deselected (SLVSEL flag changing from 1 to 0.

enumerator kI2C_SlaveAllEvents#: Bit mask of all available events.

enum _i2c_slave_fsm#

I2C slave software finite state machine states.

Values:

enumerator kI2C_SlaveFsmAddressMatch#

enumerator kI2C_SlaveFsmReceive#

enumerator kI2C_SlaveFsmTransmit#

typedef enum _i2c_slave_address_register i2c_slave_address_register_t#: I2C slave address register.

typedef struct _i2c_slave_address i2c_slave_address_t#: Data structure with 7-bit Slave address and Slave address disable.

typedef enum _i2c_slave_address_qual_mode i2c_slave_address_qual_mode_t#: I2C slave address match options.

typedef enum _i2c_slave_bus_speed i2c_slave_bus_speed_t#: I2C slave bus speed options.

typedef struct _i2c_slave_config i2c_slave_config_t#

Structure with settings to initialize the I2C slave module.

This structure holds configuration settings for the I2C slave peripheral. To initialize this structure to reasonable defaults, call the I2C_SlaveGetDefaultConfig() function and pass a pointer to your configuration structure instance.

The configuration structure can be made constant so it resides in flash.

typedef enum _i2c_slave_transfer_event i2c_slave_transfer_event_t#

Set of events sent to the callback for non blocking slave transfers.

Note

These enumerations are meant to be OR’d together to form a bit mask of events.

typedef struct _i2c_slave_handle i2c_slave_handle_t#: I2C slave handle typedef.

typedef struct _i2c_slave_transfer i2c_slave_transfer_t#: I2C slave transfer structure.

typedef void (*i2c_slave_transfer_callback_t)(I2C_Type *base, volatile i2c_slave_transfer_t *transfer, void *userData)#

Slave event callback function pointer type.

This callback is used only for the slave non-blocking transfer API. To install a callback, use the I2C_SlaveSetCallback() function after you have created a handle.

Param base:: Base address for the I2C instance on which the event occurred.
Param transfer:: Pointer to transfer descriptor containing values passed to and/or from the callback.
Param userData:: Arbitrary pointer-sized value passed from the application.

typedef enum _i2c_slave_fsm i2c_slave_fsm_t#: I2C slave software finite state machine states.

typedef void (*i2c_isr_t)(I2C_Type *base, void *i2cHandle)#: Typedef for interrupt handler.

struct _i2c_slave_address#

#include <fsl_i2c.h>

Data structure with 7-bit Slave address and Slave address disable.

Public Members

uint8_t address#: 7-bit Slave address SLVADR.

bool addressDisable#: Slave address disable SADISABLE.

struct _i2c_slave_config#

#include <fsl_i2c.h>

Structure with settings to initialize the I2C slave module.

The configuration structure can be made constant so it resides in flash.

Public Members

i2c_slave_address_t address0#: Slave’s 7-bit address and disable.

i2c_slave_address_t address1#: Alternate slave 7-bit address and disable.

i2c_slave_address_t address2#: Alternate slave 7-bit address and disable.

i2c_slave_address_t address3#: Alternate slave 7-bit address and disable.

i2c_slave_address_qual_mode_t qualMode#: Qualify mode for slave address 0.

uint8_t qualAddress#: Slave address qualifier for address 0.

i2c_slave_bus_speed_t busSpeed#: Slave bus speed mode. If the slave function stretches SCL to allow for software response, it must provide sufficient data setup time to the master before releasing the stretched clock. This is accomplished by inserting one clock time of CLKDIV at that point. The busSpeed value is used to configure CLKDIV such that one clock time is greater than the tSU;DAT value noted in the I2C bus specification for the I2C mode that is being used. If the busSpeed mode is unknown at compile time, use the longest data setup time kI2C_SlaveStandardMode (250 ns)

bool enableSlave#: Enable slave mode.

struct _i2c_slave_transfer#

#include <fsl_i2c.h>

I2C slave transfer structure.

Public Members

i2c_slave_handle_t *handle#: Pointer to handle that contains this transfer.

i2c_slave_transfer_event_t event#: Reason the callback is being invoked.

uint8_t receivedAddress#: Matching address send by master. 7-bits plus R/nW bit0

uint32_t eventMask#: Mask of enabled events.

uint8_t *rxData#: Transfer buffer for receive data

const uint8_t *txData#: Transfer buffer for transmit data

size_t txSize#: Transfer size

size_t rxSize#: Transfer size

size_t transferredCount#: Number of bytes transferred during this transfer.

status_t completionStatus#: Success or error code describing how the transfer completed. Only applies for kI2C_SlaveCompletionEvent.

struct _i2c_slave_handle#

#include <fsl_i2c.h>

I2C slave handle structure.

Note

The contents of this structure are private and subject to change.

Public Members

volatile i2c_slave_transfer_t transfer#: I2C slave transfer.

volatile bool isBusy#: Whether transfer is busy.

volatile i2c_slave_fsm_t slaveFsm#: slave transfer state machine.

i2c_slave_transfer_callback_t callback#: Callback function called at transfer event.

void *userData#: Callback parameter passed to callback.

IAP: In Application Programming Driver#

status_t IAP_ReadPartID(uint32_t *partID)#

Read part identification number.

This function is used to read the part identification number.

Parameters:

partID – Address to store the part identification number.

Return values:

kStatus_IAP_Success – Api has been executed successfully.

status_t IAP_ReadBootCodeVersion(uint32_t *bootCodeVersion)#

Read boot code version number.

This function is used to read the boot code version number.

note Boot code version is two 32-bit words. Word 0 is the major version, word 1 is the minor version.

Parameters:

bootCodeVersion – Address to store the boot code version.

Return values:

kStatus_IAP_Success – Api has been executed successfully.

void IAP_ReinvokeISP(uint8_t ispType, uint32_t *status)#

Reinvoke ISP.

This function is used to invoke the boot loader in ISP mode. It maps boot vectors and configures the peripherals for ISP.

note The error response will be returned when IAP is disabled or an invalid ISP type selection appears. The call won’t return unless an error occurs, so there can be no status code.

Parameters:

ispType – ISP type selection.
status – store the possible status.

Return values:

kStatus_IAP_ReinvokeISPConfig – reinvoke configuration error.

status_t IAP_ReadUniqueID(uint32_t *uniqueID)#

Read unique identification.

This function is used to read the unique id.

Parameters:

uniqueID – store the uniqueID.

Return values:

kStatus_IAP_Success – Api has been executed successfully.

status_t IAP_PrepareSectorForWrite(uint32_t startSector, uint32_t endSector)#

Prepare sector for write operation.

This function prepares sector(s) for write/erase operation. This function must be called before calling the IAP_CopyRamToFlash() or IAP_EraseSector() or IAP_ErasePage() function. The end sector number must be greater than or equal to the start sector number.

Parameters:

startSector – Start sector number.
endSector – End sector number.

Return values:

kStatus_IAP_Success – Api has been executed successfully.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_InvalidSector – Sector number is invalid or end sector number is greater than start sector number.
kStatus_IAP_Busy – Flash programming hardware interface is busy.

status_t IAP_CopyRamToFlash(uint32_t dstAddr, uint32_t *srcAddr, uint32_t numOfBytes, uint32_t systemCoreClock)#

Copy RAM to flash.

This function programs the flash memory. Corresponding sectors must be prepared via IAP_PrepareSectorForWrite before calling this function.

Parameters:

dstAddr – Destination flash address where data bytes are to be written, the address should be multiples of FSL_FEATURE_SYSCON_FLASH_PAGE_SIZE_BYTES boundary.
srcAddr – Source ram address from where data bytes are to be read.
numOfBytes – Number of bytes to be written, it should be multiples of FSL_FEATURE_SYSCON_FLASH_PAGE_SIZE_BYTES, and ranges from FSL_FEATURE_SYSCON_FLASH_PAGE_SIZE_BYTES to FSL_FEATURE_SYSCON_FLASH_SECTOR_SIZE_BYTES.
systemCoreClock – SystemCoreClock in Hz. It is converted to KHz before calling the rom IAP function. When the flash controller has a fixed reference clock, this parameter is bypassed.

Return values:

kStatus_IAP_Success – Api has been executed successfully.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_SrcAddrError – Source address is not on word boundary.
kStatus_IAP_DstAddrError – Destination address is not on a correct boundary.
kStatus_IAP_SrcAddrNotMapped – Source address is not mapped in the memory map.
kStatus_IAP_DstAddrNotMapped – Destination address is not mapped in the memory map.
kStatus_IAP_CountError – Byte count is not multiple of 4 or is not a permitted value.
kStatus_IAP_NotPrepared – Command to prepare sector for write operation has not been executed.
kStatus_IAP_Busy – Flash programming hardware interface is busy.

status_t IAP_EraseSector(uint32_t startSector, uint32_t endSector, uint32_t systemCoreClock)#

Erase sector.

This function erases sector(s). The end sector number must be greater than or equal to the start sector number.

Parameters:

startSector – Start sector number.
endSector – End sector number.
systemCoreClock – SystemCoreClock in Hz. It is converted to KHz before calling the rom IAP function. When the flash controller has a fixed reference clock, this parameter is bypassed.

Return values:

kStatus_IAP_Success – Api has been executed successfully.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_InvalidSector – Sector number is invalid or end sector number is greater than start sector number.
kStatus_IAP_NotPrepared – Command to prepare sector for write operation has not been executed.
kStatus_IAP_Busy – Flash programming hardware interface is busy.

status_t IAP_ErasePage(uint32_t startPage, uint32_t endPage, uint32_t systemCoreClock)#

Erase page.

This function erases page(s). The end page number must be greater than or equal to the start page number.

Parameters:

startPage – Start page number.
endPage – End page number.
systemCoreClock – SystemCoreClock in Hz. It is converted to KHz before calling the rom IAP function. When the flash controller has a fixed reference clock, this parameter is bypassed.

Return values:

kStatus_IAP_Success – Api has been executed successfully.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_InvalidSector – Page number is invalid or end page number is greater than start page number.
kStatus_IAP_NotPrepared – Command to prepare sector for write operation has not been executed.
kStatus_IAP_Busy – Flash programming hardware interface is busy.

status_t IAP_BlankCheckSector(uint32_t startSector, uint32_t endSector)#

Blank check sector(s)

Blank check single or multiples sectors of flash memory. The end sector number must be greater than or equal to the start sector number. It can be used to verify the sector erasure after IAP_EraseSector call.

Parameters:

startSector – Start sector number.
endSector – End sector number.

Return values:

kStatus_IAP_Success – One or more sectors are in erased state.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_SectorNotblank – One or more sectors are not blank.

status_t IAP_Compare(uint32_t dstAddr, uint32_t *srcAddr, uint32_t numOfBytes)#

Compare memory contents of flash with ram.

This function compares the contents of flash and ram. It can be used to verify the flash memory contents after IAP_CopyRamToFlash call.

Parameters:

dstAddr – Destination flash address.
srcAddr – Source ram address.
numOfBytes – Number of bytes to be compared.

Return values:

kStatus_IAP_Success – Contents of flash and ram match.
kStatus_IAP_NoPower – Flash memory block is powered down.
kStatus_IAP_NoClock – Flash memory block or controller is not clocked.
kStatus_IAP_AddrError – Address is not on word boundary.
kStatus_IAP_AddrNotMapped – Address is not mapped in the memory map.
kStatus_IAP_CountError – Byte count is not multiple of 4 or is not a permitted value.
kStatus_IAP_CompareError – Destination and source memory contents do not match.

FSL_IAP_DRIVER_VERSION#

iap status codes.

Values:

enumerator kStatus_IAP_Success#: Api is executed successfully

enumerator kStatus_IAP_InvalidCommand#: Invalid command

enumerator kStatus_IAP_SrcAddrError#: Source address is not on word boundary

enumerator kStatus_IAP_DstAddrError#: Destination address is not on a correct boundary

enumerator kStatus_IAP_SrcAddrNotMapped#: Source address is not mapped in the memory map

enumerator kStatus_IAP_DstAddrNotMapped#: Destination address is not mapped in the memory map

enumerator kStatus_IAP_CountError#: Byte count is not multiple of 4 or is not a permitted value

enumerator kStatus_IAP_InvalidSector#: Sector/page number is invalid or end sector/page number is greater than start sector/page number

enumerator kStatus_IAP_SectorNotblank#: One or more sectors are not blank

enumerator kStatus_IAP_NotPrepared#: Command to prepare sector for write operation has not been executed

enumerator kStatus_IAP_CompareError#: Destination and source memory contents do not match

enumerator kStatus_IAP_Busy#: Flash programming hardware interface is busy

enumerator kStatus_IAP_ParamError#: Insufficient number of parameters or invalid parameter

enumerator kStatus_IAP_AddrError#: Address is not on word boundary

enumerator kStatus_IAP_AddrNotMapped#: Address is not mapped in the memory map

enumerator kStatus_IAP_NoPower#: Flash memory block is powered down

enumerator kStatus_IAP_NoClock#: Flash memory block or controller is not clocked

enumerator kStatus_IAP_ReinvokeISPConfig#: Reinvoke configuration error

enum _iap_commands#

iap command codes.

Values:

enumerator kIapCmd_IAP_ReadFactorySettings#: Read the factory settings

enumerator kIapCmd_IAP_PrepareSectorforWrite#: Prepare Sector for write

enumerator kIapCmd_IAP_CopyRamToFlash#: Copy RAM to flash

enumerator kIapCmd_IAP_EraseSector#: Erase Sector

enumerator kIapCmd_IAP_BlankCheckSector#: Blank check sector

enumerator kIapCmd_IAP_ReadPartId#: Read part id

enumerator kIapCmd_IAP_Read_BootromVersion#: Read bootrom version

enumerator kIapCmd_IAP_Compare#: Compare

enumerator kIapCmd_IAP_ReinvokeISP#: Reinvoke ISP

enumerator kIapCmd_IAP_ReadUid#: Read Uid

enumerator kIapCmd_IAP_ErasePage#: Erase Page

enumerator kIapCmd_IAP_ReadSignature#: Read Signature

enumerator kIapCmd_IAP_ExtendedReadSignature#: Extended Read Signature

enumerator kIapCmd_IAP_ReadEEPROMPage#: Read EEPROM page

enumerator kIapCmd_IAP_WriteEEPROMPage#: Write EEPROM page

enum _flash_access_time#

Flash memory access time.

Values:

enumerator kFlash_IAP_OneSystemClockTime#

enumerator kFlash_IAP_TwoSystemClockTime#: 1 system clock flash access time

enumerator kFlash_IAP_ThreeSystemClockTime#: 2 system clock flash access time

INPUTMUX: Input Multiplexing Driver#

enum _inputmux_connection_t#

INPUTMUX connections type.

Values:

enumerator kINPUTMUX_AdcASeqaIrqToDma#: DMA ITRIG INMUX.

enumerator kINPUTMUX_AdcBSeqbIrqToDma#

enumerator kINPUTMUX_SctDma0ToDma#

enumerator kINPUTMUX_SctDma1ToDma#

enumerator kINPUTMUX_AcmpOToDma#

enumerator kINPUTMUX_PinInt0ToDma#

enumerator kINPUTMUX_PinInt1ToDma#

enumerator kINPUTMUX_DmaTriggerMux0ToDma#

enumerator kINPUTMUX_DmaTriggerMux1ToDma#: DMA INMUX.

enumerator kINPUTMUX_DmaChannel0TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel1TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel2TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel3TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel4TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel5TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel6TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel7TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel8TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel9TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel10TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel11TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel12TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel13TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel14TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel15TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel16TrigoutToTriginChannels#

enumerator kINPUTMUX_DmaChannel17TrigoutToTriginChannels#: SCT INMUX.

enumerator kINPUTMUX_SctPin0ToSct0#

enumerator kINPUTMUX_SctPin1ToSct0#

enumerator kINPUTMUX_SctPin2ToSct0#

enumerator kINPUTMUX_SctPin3ToSct0#

enumerator kINPUTMUX_AdcThcmpIrqToSct0#

enumerator kINPUTMUX_AcmpOToSct0#

enumerator kINPUTMUX_ArmTxevToSct0#

enumerator kINPUTMUX_DebugHaltedToSct0#

typedef enum _inputmux_connection_t inputmux_connection_t#: INPUTMUX connections type.

DMA_ITRIG_INMUX_ID#: Periphinmux IDs.

DMA_OTRIG_PMUX_ID#

SCT0_INMUX_ID#

PMUX_SHIFT#

FSL_INPUTMUX_DRIVER_VERSION#: Group interrupt driver version for SDK.

void INPUTMUX_Init(void *base)#

Initialize INPUTMUX peripheral.

This function enables the INPUTMUX clock.

Parameters:

base – Base address of the INPUTMUX peripheral.

void INPUTMUX_AttachSignal(void *base, uint16_t index, inputmux_connection_t connection)#

Attaches a signal.

This function writes a source signal selection into an INPUTMUX multiplexer register. The target register address is computed as:

target address = base + pmux_id + index * 4

Each inputmux_connection_t enum value encodes two fields via PMUX_SHIFT (20):

31          20 19                    0
+------------+------------------------+
|  pmux_id   |       output_id        |
+------------+------------------------+
     |                   |
group base          signal value
addr offset         to write

When N consecutive registers all accept the same set of source signals (same pmux_id), only one set of enum values is defined for the whole group; index (0 ~ N-1) selects which register to write, avoiding duplicate enum entries.

Example: SCT0 has 8 input mux registers sharing SCT0_INMUX0 = 0x000 as the group base:

base
 |
 +--[+0x000] SCT0_INMUX0  <-- index=0
 +--[+0x004] SCT0_INMUX1  <-- index=1
 +--[+0x008] SCT0_INMUX2  <-- index=2
 :   ...
 +--[+0x014] SCT0_INMUX5  <-- index=5  (write target for the call below)
 :   ...
 +--[+0x01C] SCT0_INMUX7  <-- index=7

To connect CMP0 output to SCT0 input 5:

INPUTMUX_AttachSignal(INPUTMUX, 5, kINPUTMUX_Cmp0OutToSct0);
// write address = base + 0x000 + 5*4 = base + 0x014  (SCT0_INMUX5)

For peripherals with only a single register per function (e.g. FREQMEAS_REF_REG = 0x180, FREQMEAS_TAR_REG = 0x184), each register has its own unique pmux_id and index must be 0. The two registers are distinguished by their different pmux_id values, not by index:

base
 |
 +--[+0x180] FREQMEAS_REF_REG  (pmux_id=0x180, index=0)
 +--[+0x184] FREQMEAS_TAR_REG  (pmux_id=0x184, index=0)

Parameters:

base – Base address of the INPUTMUX peripheral.
index – Zero-based index of the destination register within its group. Each increment advances the address by 4 bytes. Use 0 for single-register groups.
connection – Encodes the group base offset (bits [31:PMUX_SHIFT]) and the source signal value (bits [PMUX_SHIFT-1:0]).

void INPUTMUX_Deinit(void *base)#

Deinitialize INPUTMUX peripheral.

This function disables the INPUTMUX clock.

Parameters:

base – Base address of the INPUTMUX peripheral.

Common Driver#

FSL_COMMON_DRIVER_VERSION#: common driver version.

DEBUG_CONSOLE_DEVICE_TYPE_NONE#: No debug console.

DEBUG_CONSOLE_DEVICE_TYPE_UART#: Debug console based on UART.

DEBUG_CONSOLE_DEVICE_TYPE_LPUART#: Debug console based on LPUART.

DEBUG_CONSOLE_DEVICE_TYPE_LPSCI#: Debug console based on LPSCI.

DEBUG_CONSOLE_DEVICE_TYPE_USBCDC#: Debug console based on USBCDC.

DEBUG_CONSOLE_DEVICE_TYPE_FLEXCOMM#: Debug console based on FLEXCOMM.

DEBUG_CONSOLE_DEVICE_TYPE_IUART#: Debug console based on i.MX UART.

DEBUG_CONSOLE_DEVICE_TYPE_VUSART#: Debug console based on LPC_VUSART.

DEBUG_CONSOLE_DEVICE_TYPE_MINI_USART#: Debug console based on LPC_USART.

DEBUG_CONSOLE_DEVICE_TYPE_SWO#: Debug console based on SWO.

DEBUG_CONSOLE_DEVICE_TYPE_QSCI#: Debug console based on QSCI.

MIN(a, b)#: Computes the minimum of a and b.

MAX(a, b)#: Computes the maximum of a and b.

UINT16_MAX#: Max value of uint16_t type.

UINT32_MAX#: Max value of uint32_t type.

UINTPTR_SIZE#

UINT64_H(X)#: Macro to get upper 32 bits of a 64-bit value

UINT64_L(X)#: Macro to get lower 32 bits of a 64-bit value

MCUX_MASK_INVERT_8(mask)#: 8-bit mask inversion.

MCUX_MASK_INVERT_16(mask)#: 16-bit mask inversion.

MCUX_MASK_INVERT_32(mask)#: 32-bit mask inversion for completeness.

MCUX_REG_WRITE8(reg, value)#: 8-bit register write macro

MCUX_REG_WRITE16(reg, value)#: 16-bit register write macro

MCUX_REG_WRITE32(reg, value)#: 32-bit register write macro

MCUX_REG_READ8(reg)#: 8-bit register read macro

MCUX_REG_READ16(reg)#: 16-bit register read macro

MCUX_REG_READ32(reg)#: 32-bit register read macro

MCUX_REG_BIT_SET8(reg, mask)#: 8-bit register bit set macro

MCUX_REG_BIT_SET16(reg, mask)#: 16-bit register bit set macro

MCUX_REG_BIT_SET32(reg, mask)#: 32-bit register bit set macro

MCUX_REG_BIT_CLEAR8(reg, mask)#: 8-bit register bit clear macro

MCUX_REG_BIT_CLEAR16(reg, mask)#: 16-bit register bit clear macro

MCUX_REG_BIT_CLEAR32(reg, mask)#: 32-bit register bit clear macro

MCUX_REG_BIT_GET8(reg, mask)#: 8-bit register bit get macro

MCUX_REG_BIT_GET16(reg, mask)#: 16-bit register bit get macro

MCUX_REG_BIT_GET32(reg, mask)#: 32-bit register bit get macro

MCUX_REG_MODIFY8(reg, mask, value)#: 32-bit register read-modify-write macro

MCUX_REG_MODIFY16(reg, mask, value)#: 16-bit register read-modify-write macro

MCUX_REG_MODIFY32(reg, mask, value)#: 32-bit register read-modify-write macro

SDK_ATOMIC_LOCAL_ADD(addr, val)#: Add value val from the variable at address address.

SDK_ATOMIC_LOCAL_SUB(addr, val)#: Subtract value val to the variable at address address.

SDK_ATOMIC_LOCAL_SET(addr, bits)#: Set the bits specifiled by bits to the variable at address address.

SDK_ATOMIC_LOCAL_CLEAR(addr, bits)#: Clear the bits specifiled by bits to the variable at address address.

SDK_ATOMIC_LOCAL_TOGGLE(addr, bits)#: Toggle the bits specifiled by bits to the variable at address address.

SDK_ATOMIC_LOCAL_CLEAR_AND_SET(addr, clearBits, setBits)#: For the variable at address address, clear the bits specifiled by clearBits and set the bits specifiled by setBits.

SDK_ATOMIC_LOCAL_COMPARE_AND_SET(addr, expected, newValue)#: For the variable at address address, check whether the value equal to expected. If value same as expected then update newValue to address and return true , else return false .

SDK_ATOMIC_LOCAL_TEST_AND_SET(addr, newValue)#: For the variable at address address, set as newValue value and return old value.

USEC_TO_COUNT(us, clockFreqInHz)#: Macro to convert a microsecond period to raw count value

COUNT_TO_USEC(count, clockFreqInHz)#: Macro to convert a raw count value to microsecond

MSEC_TO_COUNT(ms, clockFreqInHz)#: Macro to convert a millisecond period to raw count value

COUNT_TO_MSEC(count, clockFreqInHz)#: Macro to convert a raw count value to millisecond

SDK_ISR_EXIT_BARRIER#

SDK_ALIGN(var, alignbytes)#: Macro to define a variable with alignbytes alignment

SDK_SIZEALIGN(var, alignbytes)#

Macro to define a variable with L1 d-cache line size alignment

Macro to define a variable with L2 cache line size alignment

Macro to change a value to a given size aligned value (rounded up)

SDK_SIZEALIGN_UP(var, alignbytes)#: Macro to change a value to a given size aligned value (rounded up), the wrapper of SDK_SIZEALIGN

SDK_SIZEALIGN_DOWN(var, alignbytes)#: Macro to change a value to a given size aligned value (rounded down)

SDK_IS_ALIGNED(var, alignbytes)#: Macro to check if a value is aligned to a given size

AT_NONCACHEABLE_SECTION(var)#: Define a variable var, and place it in non-cacheable section.

AT_NONCACHEABLE_SECTION_ALIGN(var, alignbytes)#: Define a variable var, and place it in non-cacheable section, the start address of the variable is aligned to alignbytes.

AT_NONCACHEABLE_SECTION_INIT(var)#: Define a variable var with initial value, and place it in non-cacheable section.

AT_NONCACHEABLE_SECTION_ALIGN_INIT(var, alignbytes)#: Define a variable var with initial value, and place it in non-cacheable section, the start address of the variable is aligned to alignbytes.

AT_CACHE_LINE_SECTION(var)#: Define a variable var, which is cache line size aligned and be placed in CacheLineData section.

AT_CACHE_LINE_SECTION_INIT(var)#: Define a variable var with initial value, which is cache line size aligned and be placed in CacheLineData.init section.

AT_QUICKACCESS_SECTION_CODE(func)#: Place function in a section which can be accessed quickly by core.

AT_QUICKACCESS_SECTION_DATA(var)#: Place data in a section which can be accessed quickly by core.

AT_QUICKACCESS_SECTION_DATA_ALIGN(var, alignbytes)#: Place data in a section which can be accessed quickly by core, and the variable address is set to align with alignbytes.

MCUX_RAMFUNC#

Function attribute to place function in RAM. For example, to place function my_func in ram, use like:

MCUX_RAMFUNC my_func

RAMFUNCTION_SECTION_CODE(func)#: Place function in ram.

MCUX_DEPRECATED#: Deprecated APIs.

MCUX_DEPRECATED_MACRO#: Deprecated macros.

MCUX_EXPERIMENTAL#: Experimental APIs.

MCUX_EXPERIMENTAL_MACRO#: Experimental macros.

enum _status_groups#

Status group numbers.

Values:

enumerator kStatusGroup_Generic#: Group number for generic status codes.

enumerator kStatusGroup_FLASH#: Group number for FLASH status codes.

enumerator kStatusGroup_LPSPI#: Group number for LPSPI status codes.

enumerator kStatusGroup_FLEXIO_SPI#: Group number for FLEXIO SPI status codes.

enumerator kStatusGroup_DSPI#: Group number for DSPI status codes.

enumerator kStatusGroup_FLEXIO_UART#: Group number for FLEXIO UART status codes.

enumerator kStatusGroup_FLEXIO_I2C#: Group number for FLEXIO I2C status codes.

enumerator kStatusGroup_LPI2C#: Group number for LPI2C status codes.

enumerator kStatusGroup_UART#: Group number for UART status codes.

enumerator kStatusGroup_I2C#: Group number for UART status codes.

enumerator kStatusGroup_LPSCI#: Group number for LPSCI status codes.

enumerator kStatusGroup_LPUART#: Group number for LPUART status codes.

enumerator kStatusGroup_SPI#: Group number for SPI status code.

enumerator kStatusGroup_XRDC#: Group number for XRDC status code.

enumerator kStatusGroup_SEMA42#: Group number for SEMA42 status code.

enumerator kStatusGroup_SDHC#: Group number for SDHC status code

enumerator kStatusGroup_SDMMC#: Group number for SDMMC status code

enumerator kStatusGroup_SAI#: Group number for SAI status code

enumerator kStatusGroup_MCG#: Group number for MCG status codes.

enumerator kStatusGroup_SCG#: Group number for SCG status codes.

enumerator kStatusGroup_SDSPI#: Group number for SDSPI status codes.

enumerator kStatusGroup_FLEXIO_I2S#: Group number for FLEXIO I2S status codes

enumerator kStatusGroup_FLEXIO_MCULCD#: Group number for FLEXIO LCD status codes

enumerator kStatusGroup_FLASHIAP#: Group number for FLASHIAP status codes

enumerator kStatusGroup_FLEXCOMM_I2C#: Group number for FLEXCOMM I2C status codes

enumerator kStatusGroup_I2S#: Group number for I2S status codes

enumerator kStatusGroup_IUART#: Group number for IUART status codes

enumerator kStatusGroup_CSI#: Group number for CSI status codes

enumerator kStatusGroup_MIPI_DSI#: Group number for MIPI DSI status codes

enumerator kStatusGroup_SDRAMC#: Group number for SDRAMC status codes.

enumerator kStatusGroup_POWER#: Group number for POWER status codes.

enumerator kStatusGroup_ENET#: Group number for ENET status codes.

enumerator kStatusGroup_PHY#: Group number for PHY status codes.

enumerator kStatusGroup_TRGMUX#: Group number for TRGMUX status codes.

enumerator kStatusGroup_SMARTCARD#: Group number for SMARTCARD status codes.

enumerator kStatusGroup_LMEM#: Group number for LMEM status codes.

enumerator kStatusGroup_QSPI#: Group number for QSPI status codes.

enumerator kStatusGroup_DMA#: Group number for DMA status codes.

enumerator kStatusGroup_EDMA#: Group number for EDMA status codes.

enumerator kStatusGroup_DMAMGR#: Group number for DMAMGR status codes.

enumerator kStatusGroup_FLEXCAN#: Group number for FlexCAN status codes.

enumerator kStatusGroup_LTC#: Group number for LTC status codes.

enumerator kStatusGroup_FLEXIO_CAMERA#: Group number for FLEXIO CAMERA status codes.

enumerator kStatusGroup_LPC_SPI#: Group number for LPC_SPI status codes.

enumerator kStatusGroup_LPC_USART#: Group number for LPC_USART status codes.

enumerator kStatusGroup_DMIC#: Group number for DMIC status codes.

enumerator kStatusGroup_SDIF#: Group number for SDIF status codes.

enumerator kStatusGroup_SPIFI#: Group number for SPIFI status codes.

enumerator kStatusGroup_OTP#: Group number for OTP status codes.

enumerator kStatusGroup_MCAN#: Group number for MCAN status codes.

enumerator kStatusGroup_CAAM#: Group number for CAAM status codes.

enumerator kStatusGroup_ECSPI#: Group number for ECSPI status codes.

enumerator kStatusGroup_USDHC#: Group number for USDHC status codes.

enumerator kStatusGroup_LPC_I2C#: Group number for LPC_I2C status codes.

enumerator kStatusGroup_DCP#: Group number for DCP status codes.

enumerator kStatusGroup_MSCAN#: Group number for MSCAN status codes.

enumerator kStatusGroup_ESAI#: Group number for ESAI status codes.

enumerator kStatusGroup_FLEXSPI#: Group number for FLEXSPI status codes.

enumerator kStatusGroup_MMDC#: Group number for MMDC status codes.

enumerator kStatusGroup_PDM#: Group number for MIC status codes.

enumerator kStatusGroup_SDMA#: Group number for SDMA status codes.

enumerator kStatusGroup_ICS#: Group number for ICS status codes.

enumerator kStatusGroup_SPDIF#: Group number for SPDIF status codes.

enumerator kStatusGroup_LPC_MINISPI#: Group number for LPC_MINISPI status codes.

enumerator kStatusGroup_HASHCRYPT#: Group number for Hashcrypt status codes

enumerator kStatusGroup_LPC_SPI_SSP#: Group number for LPC_SPI_SSP status codes.

enumerator kStatusGroup_I3C#: Group number for I3C status codes

enumerator kStatusGroup_LPC_I2C_1#: Group number for LPC_I2C_1 status codes.

enumerator kStatusGroup_NOTIFIER#: Group number for NOTIFIER status codes.

enumerator kStatusGroup_DebugConsole#: Group number for debug console status codes.

enumerator kStatusGroup_SEMC#: Group number for SEMC status codes.

enumerator kStatusGroup_ApplicationRangeStart#: Starting number for application groups.

enumerator kStatusGroup_IAP#: Group number for IAP status codes

enumerator kStatusGroup_SFA#: Group number for SFA status codes

enumerator kStatusGroup_SPC#: Group number for SPC status codes.

enumerator kStatusGroup_PUF#: Group number for PUF status codes.

enumerator kStatusGroup_TOUCH_PANEL#: Group number for touch panel status codes

enumerator kStatusGroup_VBAT#: Group number for VBAT status codes

enumerator kStatusGroup_XSPI#: Group number for XSPI status codes

enumerator kStatusGroup_PNGDEC#: Group number for PNGDEC status codes

enumerator kStatusGroup_JPEGDEC#: Group number for JPEGDEC status codes

enumerator kStatusGroup_AUDMIX#: Group number for AUDMIX status codes

enumerator kStatusGroup_HAL_GPIO#: Group number for HAL GPIO status codes.

enumerator kStatusGroup_HAL_UART#: Group number for HAL UART status codes.

enumerator kStatusGroup_HAL_TIMER#: Group number for HAL TIMER status codes.

enumerator kStatusGroup_HAL_SPI#: Group number for HAL SPI status codes.

enumerator kStatusGroup_HAL_I2C#: Group number for HAL I2C status codes.

enumerator kStatusGroup_HAL_FLASH#: Group number for HAL FLASH status codes.

enumerator kStatusGroup_HAL_PWM#: Group number for HAL PWM status codes.

enumerator kStatusGroup_HAL_RNG#: Group number for HAL RNG status codes.

enumerator kStatusGroup_HAL_I2S#: Group number for HAL I2S status codes.

enumerator kStatusGroup_HAL_ADC_SENSOR#: Group number for HAL ADC SENSOR status codes.

enumerator kStatusGroup_TIMERMANAGER#: Group number for TiMER MANAGER status codes.

enumerator kStatusGroup_SERIALMANAGER#: Group number for SERIAL MANAGER status codes.

enumerator kStatusGroup_LED#: Group number for LED status codes.

enumerator kStatusGroup_BUTTON#: Group number for BUTTON status codes.

enumerator kStatusGroup_EXTERN_EEPROM#: Group number for EXTERN EEPROM status codes.

enumerator kStatusGroup_SHELL#: Group number for SHELL status codes.

enumerator kStatusGroup_MEM_MANAGER#: Group number for MEM MANAGER status codes.

enumerator kStatusGroup_LIST#: Group number for List status codes.

enumerator kStatusGroup_OSA#: Group number for OSA status codes.

enumerator kStatusGroup_COMMON_TASK#: Group number for Common task status codes.

enumerator kStatusGroup_MSG#: Group number for messaging status codes.

enumerator kStatusGroup_SDK_OCOTP#: Group number for OCOTP status codes.

enumerator kStatusGroup_SDK_FLEXSPINOR#: Group number for FLEXSPINOR status codes.

enumerator kStatusGroup_CODEC#: Group number for codec status codes.

enumerator kStatusGroup_ASRC#: Group number for codec status ASRC.

enumerator kStatusGroup_OTFAD#: Group number for codec status codes.

enumerator kStatusGroup_SDIOSLV#: Group number for SDIOSLV status codes.

enumerator kStatusGroup_MECC#: Group number for MECC status codes.

enumerator kStatusGroup_ENET_QOS#: Group number for ENET_QOS status codes.

enumerator kStatusGroup_LOG#: Group number for LOG status codes.

enumerator kStatusGroup_I3CBUS#: Group number for I3CBUS status codes.

enumerator kStatusGroup_QSCI#: Group number for QSCI status codes.

enumerator kStatusGroup_ELEMU#: Group number for ELEMU status codes.

enumerator kStatusGroup_QUEUEDSPI#: Group number for QSPI status codes.

enumerator kStatusGroup_POWER_MANAGER#: Group number for POWER_MANAGER status codes.

enumerator kStatusGroup_IPED#: Group number for IPED status codes.

enumerator kStatusGroup_ELS_PKC#: Group number for ELS PKC status codes.

enumerator kStatusGroup_CSS_PKC#: Group number for CSS PKC status codes.

enumerator kStatusGroup_HOSTIF#: Group number for HOSTIF status codes.

enumerator kStatusGroup_CLIF#: Group number for CLIF status codes.

enumerator kStatusGroup_BMA#: Group number for BMA status codes.

enumerator kStatusGroup_NETC#: Group number for NETC status codes.

enumerator kStatusGroup_ELE#: Group number for ELE status codes.

enumerator kStatusGroup_GLIKEY#: Group number for GLIKEY status codes.

enumerator kStatusGroup_AON_POWER#: Group number for AON_POWER status codes.

enumerator kStatusGroup_AON_COMMON#: Group number for AON_COMMON status codes.

enumerator kStatusGroup_ENDAT3#: Group number for ENDAT3 status codes.

enumerator kStatusGroup_HIPERFACE#: Group number for HIPERFACE status codes.

enumerator kStatusGroup_NPX#: Group number for NPX status codes.

enumerator kStatusGroup_ELA_CSEC#: Group number for ELA_CSEC status codes.

enumerator kStatusGroup_FLEXIO_T_FORMAT#: Group number for T-format status codes.

enumerator kStatusGroup_FLEXIO_A_FORMAT#: Group number for A-format status codes.

enumerator kStatusGroup_LPC_QSPI#: Group number for LPC QSPI status codes.

enumerator kStatusGroup_EVENT_CTRL#: Group number for Event controller status codes.

Generic status return codes.

Values:

enumerator kStatus_Success#: Generic status for Success.

enumerator kStatus_Fail#: Generic status for Fail.

enumerator kStatus_ReadOnly#: Generic status for read only failure.

enumerator kStatus_OutOfRange#: Generic status for out of range access.

enumerator kStatus_InvalidArgument#: Generic status for invalid argument check.

enumerator kStatus_Timeout#: Generic status for timeout.

enumerator kStatus_NoTransferInProgress#: Generic status for no transfer in progress.

enumerator kStatus_Busy#: Generic status for module is busy.

enumerator kStatus_NoData#: Generic status for no data is found for the operation.

typedef int32_t status_t#: Type used for all status and error return values.

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.

void SDK_Free(void *ptr)#

Free memory.

Parameters:

ptr – The memory to be release.

void SDK_DelayAtLeastUs(uint32_t delayTime_us, uint32_t coreClock_Hz)#

Delay at least for some time. Please note that, this API uses while loop for delay, different run-time environments make the time not precise, if precise delay count was needed, please implement a new delay function with hardware timer.

Parameters:

delayTime_us – Delay time in unit of microsecond.
coreClock_Hz – Core clock frequency with Hz.

static inline status_t EnableIRQ(IRQn_Type interrupt)#

Enable specific interrupt.

Enable LEVEL1 interrupt. For some devices, there might be multiple interrupt levels. For example, there are NVIC and intmux. Here the interrupts connected to NVIC are the LEVEL1 interrupts, because they are routed to the core directly. The interrupts connected to intmux are the LEVEL2 interrupts, they are routed to NVIC first then routed to core.

This function only enables the LEVEL1 interrupts. The number of LEVEL1 interrupts is indicated by the feature macro FSL_FEATURE_NUMBER_OF_LEVEL1_INT_VECTORS.

Parameters:

interrupt – The IRQ number.

Return values:

kStatus_Success – Interrupt enabled successfully
kStatus_Fail – Failed to enable the interrupt

static inline status_t DisableIRQ(IRQn_Type interrupt)#

Disable specific interrupt.

Disable LEVEL1 interrupt. For some devices, there might be multiple interrupt levels. For example, there are NVIC and intmux. Here the interrupts connected to NVIC are the LEVEL1 interrupts, because they are routed to the core directly. The interrupts connected to intmux are the LEVEL2 interrupts, they are routed to NVIC first then routed to core.

This function only disables the LEVEL1 interrupts. The number of LEVEL1 interrupts is indicated by the feature macro FSL_FEATURE_NUMBER_OF_LEVEL1_INT_VECTORS.

Parameters:

interrupt – The IRQ number.

Return values:

kStatus_Success – Interrupt disabled successfully
kStatus_Fail – Failed to disable the interrupt

static inline status_t EnableIRQWithPriority(IRQn_Type interrupt, uint8_t priNum)#

Enable the IRQ, and also set the interrupt priority.

Only handle LEVEL1 interrupt. For some devices, there might be multiple interrupt levels. For example, there are NVIC and intmux. Here the interrupts connected to NVIC are the LEVEL1 interrupts, because they are routed to the core directly. The interrupts connected to intmux are the LEVEL2 interrupts, they are routed to NVIC first then routed to core.

This function only handles the LEVEL1 interrupts. The number of LEVEL1 interrupts is indicated by the feature macro FSL_FEATURE_NUMBER_OF_LEVEL1_INT_VECTORS.

Parameters:

interrupt – The IRQ to Enable.
priNum – Priority number set to interrupt controller register.

Return values:

kStatus_Success – Interrupt priority set successfully
kStatus_Fail – Failed to set the interrupt priority.

static inline status_t IRQ_SetPriority(IRQn_Type interrupt, uint8_t priNum)#

Set the IRQ priority.

This function only handles the LEVEL1 interrupts. The number of LEVEL1 interrupts is indicated by the feature macro FSL_FEATURE_NUMBER_OF_LEVEL1_INT_VECTORS.

Parameters:

interrupt – The IRQ to set.
priNum – Priority number set to interrupt controller register.

Return values:

kStatus_Success – Interrupt priority set successfully
kStatus_Fail – Failed to set the interrupt priority.

static inline status_t IRQ_ClearPendingIRQ(IRQn_Type interrupt)#

Clear the pending IRQ flag.

This function only handles the LEVEL1 interrupts. The number of LEVEL1 interrupts is indicated by the feature macro FSL_FEATURE_NUMBER_OF_LEVEL1_INT_VECTORS.

Parameters:

interrupt – The flag which IRQ to clear.

Return values:

kStatus_Success – Interrupt priority set successfully
kStatus_Fail – Failed to set the interrupt priority.

static inline uint32_t DisableGlobalIRQ(void)#

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

Returns:: Current primask value.

static inline void EnableGlobalIRQ(uint32_t primask)#

Enable the global IRQ.

Set the primask register with the provided primask value but not just enable the primask. The idea is for the convenience of integration of RTOS. some RTOS get its own management mechanism of primask. User is required to use the EnableGlobalIRQ() and DisableGlobalIRQ() in pair.

Parameters:

primask – value of primask register to be restored. The primask value is supposed to be provided by the DisableGlobalIRQ().

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.

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.

static inline bool _SDK_AtomicLocalCompareAndSet(uint32_t *addr, uint32_t expected, uint32_t newValue)#

static inline uint32_t _SDK_AtomicTestAndSet(uint32_t *addr, uint32_t newValue)#

FSL_DRIVER_TRANSFER_DOUBLE_WEAK_IRQ#: Macro to use the default weak IRQ handler in drivers.

MAKE_STATUS(group, code)#: Construct a status code value from a group and code number.

MAKE_VERSION(major, minor, bugfix)#

Construct the version number for drivers.

The driver version is a 32-bit number, for both 32-bit platforms(such as Cortex M) and 16-bit platforms(such as DSC).

| Unused    || Major Version || Minor Version ||  Bug Fix    |
31        25  24           17  16            9  8            0

ARRAY_SIZE(x)#: Computes the number of elements in an array.

SUPPRESS_FALL_THROUGH_WARNING()#: For switch case code block, if case section ends without “break;” statement, there wil be fallthrough warning with compiler flag -Wextra or -Wimplicit-fallthrough=n when using armgcc. To suppress this warning, “SUPPRESS_FALL_THROUGH_WARNING();” need to be added at the end of each case section which misses “break;”statement.

MSDK_REG_SECURE_ADDR(x)#: Convert the register address to the one used in secure mode.

MSDK_REG_NONSECURE_ADDR(x)#: Convert the register address to the one used in non-secure mode.

MSDK_HAS_DWT_CYCCNT#: The chip supports DWT CYCCNT or not.

MSDK_INVALID_IRQ_HANDLER#: Invalid IRQ handler address.

LPC_ACOMP: Analog comparator Driver#

void ACOMP_Init(ACOMP_Type *base, const acomp_config_t *config)#

Initialize the ACOMP module.

Parameters:

base – ACOMP peripheral base address.
config – Pointer to “acomp_config_t” structure.

void ACOMP_Deinit(ACOMP_Type *base)#

De-initialize the ACOMP module.

Parameters:

base – ACOMP peripheral base address.

void ACOMP_GetDefaultConfig(acomp_config_t *config)#

Gets an available pre-defined settings for the ACOMP’s configuration.

This function initializes the converter configuration structure with available settings. The default values are:

config->enableSyncToBusClk = false;
config->hysteresisSelection = kACOMP_hysteresisNoneSelection;

In default configuration, the ACOMP’s output would be used directly and switch as the voltages cross.

Parameters:

config – Pointer to the configuration structure.

void ACOMP_EnableInterrupts(ACOMP_Type *base, acomp_interrupt_enable_t enable)#

Enable ACOMP interrupts.

Parameters:

base – ACOMP peripheral base address.
enable – Enable/Disable interrupt feature.

static inline bool ACOMP_GetInterruptsStatusFlags(ACOMP_Type *base)#

Get interrupts status flags.

Parameters:

base – ACOMP peripheral base address.

Returns:

Reflect the state ACOMP edge-detect status, true or false.

static inline void ACOMP_ClearInterruptsStatusFlags(ACOMP_Type *base)#

Clear the ACOMP interrupts status flags.

Parameters:

base – ACOMP peripheral base address.

static inline bool ACOMP_GetOutputStatusFlags(ACOMP_Type *base)#

Get ACOMP output status flags.

Parameters:

base – ACOMP peripheral base address.

Returns:

Reflect the state of the comparator output, true or false.

static inline void ACOMP_SetInputChannel(ACOMP_Type *base, uint32_t postiveInputChannel, uint32_t negativeInputChannel)#

Set the ACOMP postive and negative input channel.

Parameters:

base – ACOMP peripheral base address.
postiveInputChannel – The index of postive input channel.
negativeInputChannel – The index of negative input channel.

void ACOMP_SetLadderConfig(ACOMP_Type *base, const acomp_ladder_config_t *config)#

Set the voltage ladder configuration.

Parameters:

base – ACOMP peripheral base address.
config – The structure for voltage ladder. If the config is NULL, voltage ladder would be diasbled, otherwise the voltage ladder would be configured and enabled.

FSL_ACOMP_DRIVER_VERSION#: ACOMP driver version 2.1.0.

enum _acomp_ladder_reference_voltage#

The ACOMP ladder reference voltage.

Values:

enumerator kACOMP_LadderRefVoltagePinVDD#: Supply from pin VDD.

enumerator kACOMP_LadderRefVoltagePinVDDCMP#: Supply from pin VDDCMP.

enum _acomp_interrupt_enable#

The ACOMP interrupts enable.

Values:

enumerator kACOMP_InterruptsFallingEdgeEnable#: Enable the falling edge interrupts.

enumerator kACOMP_InterruptsRisingEdgeEnable#: Enable the rising edge interrupts.

enumerator kACOMP_InterruptsBothEdgesEnable#: Enable the both edges interrupts.

enumerator kACOMP_InterruptsDisable#: Disable the interrupts.

enum _acomp_hysteresis_selection#

The ACOMP hysteresis selection.

Values:

enumerator kACOMP_HysteresisNoneSelection#: None (the output will switch as the voltages cross).

enumerator kACOMP_Hysteresis5MVSelection#: 5mV.

enumerator kACOMP_Hysteresis10MVSelection#: 10mV.

enumerator kACOMP_Hysteresis20MVSelection#: 20mV.

typedef enum _acomp_ladder_reference_voltage acomp_ladder_reference_voltage_t#: The ACOMP ladder reference voltage.

typedef enum _acomp_interrupt_enable acomp_interrupt_enable_t#: The ACOMP interrupts enable.

typedef enum _acomp_hysteresis_selection acomp_hysteresis_selection_t#: The ACOMP hysteresis selection.

typedef struct _acomp_config acomp_config_t#: The structure for ACOMP basic configuration.

typedef struct _acomp_ladder_config acomp_ladder_config_t#: The structure for ACOMP voltage ladder.

struct _acomp_config#

#include <fsl_acomp.h>

The structure for ACOMP basic configuration.

Public Members

bool enableSyncToBusClk#: If true, Comparator output is synchronized to the bus clock for output to other modules. If false, Comparator output is used directly.

acomp_hysteresis_selection_t hysteresisSelection#: Controls the hysteresis of the comparator.

struct _acomp_ladder_config#

#include <fsl_acomp.h>

The structure for ACOMP voltage ladder.

Public Members

uint8_t ladderValue#: Voltage ladder value. 00000 = Vss, 00001 = 1*Vref/31, …, 11111 = Vref.

acomp_ladder_reference_voltage_t referenceVoltage#: Selects the reference voltage(Vref) for the voltage ladder.

ADC: 12-bit SAR Analog-to-Digital Converter Driver#

void ADC_Init(ADC_Type *base, const adc_config_t *config)#

Initialize the ADC module.

Parameters:

base – ADC peripheral base address.
config – Pointer to configuration structure, see to adc_config_t.

void ADC_Deinit(ADC_Type *base)#

Deinitialize the ADC module.

Parameters:

base – ADC peripheral base address.

void ADC_GetDefaultConfig(adc_config_t *config)#

Gets an available pre-defined settings for initial configuration.

This function initializes the initial configuration structure with an available settings. The default values are:

config->clockMode = kADC_ClockSynchronousMode;
config->clockDividerNumber = 0U;
config->resolution = kADC_Resolution12bit;
config->enableBypassCalibration = false;
config->sampleTimeNumber = 0U;
config->extendSampleTimeNumber = kADC_ExtendSampleTimeNotUsed;

Parameters:

config – Pointer to configuration structure.

bool ADC_DoSelfCalibration(ADC_Type *base)#

Do the hardware self-calibration.

Deprecated:: Do not use this function. It has been superceded by ADC_DoOffsetCalibration.

To calibrate the ADC, set the ADC clock to 500 kHz. In order to achieve the specified ADC accuracy, the A/D converter must be recalibrated, at a minimum, following every chip reset before initiating normal ADC operation.

Parameters:

base – ADC peripheral base address.

Return values:

true – Calibration succeed.
false – Calibration failed.

bool ADC_DoOffsetCalibration(ADC_Type *base, uint32_t frequency)#

Do the hardware offset-calibration.

To calibrate the ADC, set the ADC clock to no more then 30 MHz. In order to achieve the specified ADC accuracy, the A/D converter must be recalibrated, at a minimum, following every chip reset before initiating normal ADC operation.

Parameters:

base – ADC peripheral base address.
frequency – The clock frequency that ADC operates at.

Return values:

true – Calibration succeed.
false – Calibration failed.

static inline void ADC_EnableConvSeqA(ADC_Type *base, bool enable)#

Enable the conversion sequence A.

In order to avoid spuriously triggering the sequence, the trigger to conversion sequence should be ready before the sequence is ready. when the sequence is disabled, the trigger would be ignored. Also, it is suggested to disable the sequence during changing the sequence’s setting.

Parameters:

base – ADC peripheral base address.
enable – Switcher to enable the feature or not.

void ADC_SetConvSeqAConfig(ADC_Type *base, const adc_conv_seq_config_t *config)#

Configure the conversion sequence A.

Parameters:

base – ADC peripheral base address.
config – Pointer to configuration structure, see to adc_conv_seq_config_t.

static inline void ADC_DoSoftwareTriggerConvSeqA(ADC_Type *base)#

Do trigger the sequence’s conversion by software.

Parameters:

base – ADC peripheral base address.

static inline void ADC_EnableConvSeqABurstMode(ADC_Type *base, bool enable)#

Enable the burst conversion of sequence A.

Enable the burst mode would cause the conversion sequence to be cntinuously cycled through. Other triggers would be ignored while this mode is enabled. Repeated conversions could be halted by disabling this mode. And the sequence currently in process will be completed before cnversions are terminated. Note that a new sequence could begin just before the burst mode is disabled.

Parameters:

base – ADC peripheral base address.
enable – Switcher to enable this feature.

static inline void ADC_SetConvSeqAHighPriority(ADC_Type *base)#

Set the high priority for conversion sequence A.

Parameters:

base – ADC peripheral bass address.

static inline void ADC_EnableConvSeqB(ADC_Type *base, bool enable)#

Enable the conversion sequence B.

Parameters:

base – ADC peripheral base address.
enable – Switcher to enable the feature or not.

void ADC_SetConvSeqBConfig(ADC_Type *base, const adc_conv_seq_config_t *config)#

Configure the conversion sequence B.

Parameters:

base – ADC peripheral base address.
config – Pointer to configuration structure, see to adc_conv_seq_config_t.

static inline void ADC_DoSoftwareTriggerConvSeqB(ADC_Type *base)#

Do trigger the sequence’s conversion by software.

Parameters:

base – ADC peripheral base address.

static inline void ADC_EnableConvSeqBBurstMode(ADC_Type *base, bool enable)#

Enable the burst conversion of sequence B.

Enable the burst mode would cause the conversion sequence to be continuously cycled through. Other triggers would be ignored while this mode is enabled. Repeated conversions could be halted by disabling this mode. And the sequence currently in process will be completed before cnversions are terminated. Note that a new sequence could begin just before the burst mode is disabled.

Parameters:

base – ADC peripheral base address.
enable – Switcher to enable this feature.

static inline void ADC_SetConvSeqBHighPriority(ADC_Type *base)#

Set the high priority for conversion sequence B.

Parameters:

base – ADC peripheral bass address.

bool ADC_GetConvSeqAGlobalConversionResult(ADC_Type *base, adc_result_info_t *info)#

Get the global ADC conversion infomation of sequence A.

Parameters:

base – ADC peripheral base address.
info – Pointer to information structure, see to adc_result_info_t;

Return values:

true – The conversion result is ready.
false – The conversion result is not ready yet.

bool ADC_GetConvSeqBGlobalConversionResult(ADC_Type *base, adc_result_info_t *info)#

Get the global ADC conversion infomation of sequence B.

Parameters:

base – ADC peripheral base address.
info – Pointer to information structure, see to adc_result_info_t;

Return values:

true – The conversion result is ready.
false – The conversion result is not ready yet.

bool ADC_GetChannelConversionResult(ADC_Type *base, uint32_t channel, adc_result_info_t *info)#

Get the channel’s ADC conversion completed under each conversion sequence.

Parameters:

base – ADC peripheral base address.
channel – The indicated channel number.
info – Pointer to information structure, see to adc_result_info_t;

Return values:

true – The conversion result is ready.
false – The conversion result is not ready yet.

static inline void ADC_SetThresholdPair0(ADC_Type *base, uint32_t lowValue, uint32_t highValue)#

Set the threshhold pair 0 with low and high value.

Parameters:

base – ADC peripheral base address.
lowValue – LOW threshold value.
highValue – HIGH threshold value.

static inline void ADC_SetThresholdPair1(ADC_Type *base, uint32_t lowValue, uint32_t highValue)#

Set the threshhold pair 1 with low and high value.

Parameters:

base – ADC peripheral base address.
lowValue – LOW threshold value. The available value is with 12-bit.
highValue – HIGH threshold value. The available value is with 12-bit.

static inline void ADC_SetChannelWithThresholdPair0(ADC_Type *base, uint32_t channelMask)#

Set given channels to apply the threshold pare 0.

Parameters:

base – ADC peripheral base address.
channelMask – Indicated channels’ mask.

static inline void ADC_SetChannelWithThresholdPair1(ADC_Type *base, uint32_t channelMask)#

Set given channels to apply the threshold pare 1.

Parameters:

base – ADC peripheral base address.
channelMask – Indicated channels’ mask.

static inline void ADC_EnableInterrupts(ADC_Type *base, uint32_t mask)#

Enable interrupts for conversion sequences.

Parameters:

base – ADC peripheral base address.
mask – Mask of interrupt mask value for global block except each channal, see to _adc_interrupt_enable.

static inline void ADC_DisableInterrupts(ADC_Type *base, uint32_t mask)#

Disable interrupts for conversion sequence.

Parameters:

base – ADC peripheral base address.
mask – Mask of interrupt mask value for global block except each channel, see to _adc_interrupt_enable.

static inline void ADC_EnableThresholdCompareInterrupt(ADC_Type *base, uint32_t channel, adc_threshold_interrupt_mode_t mode)#

Enable the interrupt of threshold compare event for each channel.

Parameters:

base – ADC peripheral base address.
channel – Channel number.
mode – Interrupt mode for threshold compare event, see to adc_threshold_interrupt_mode_t.

static inline uint32_t ADC_GetStatusFlags(ADC_Type *base)#

Get status flags of ADC module.

Parameters:

base – ADC peripheral base address.

Returns:

Mask of status flags of module, see to _adc_status_flags.

static inline void ADC_ClearStatusFlags(ADC_Type *base, uint32_t mask)#

Clear status flags of ADC module.

Parameters:

base – ADC peripheral base address.
mask – Mask of status flags of module, see to _adc_status_flags.

FSL_ADC_DRIVER_VERSION#: ADC driver version 2.6.0.

enum _adc_status_flags#

Flags.

Values:

enumerator kADC_ThresholdCompareFlagOnChn0#: Threshold comparison event on Channel 0.

enumerator kADC_ThresholdCompareFlagOnChn1#: Threshold comparison event on Channel 1.

enumerator kADC_ThresholdCompareFlagOnChn2#: Threshold comparison event on Channel 2.

enumerator kADC_ThresholdCompareFlagOnChn3#: Threshold comparison event on Channel 3.

enumerator kADC_ThresholdCompareFlagOnChn4#: Threshold comparison event on Channel 4.

enumerator kADC_ThresholdCompareFlagOnChn5#: Threshold comparison event on Channel 5.

enumerator kADC_ThresholdCompareFlagOnChn6#: Threshold comparison event on Channel 6.

enumerator kADC_ThresholdCompareFlagOnChn7#: Threshold comparison event on Channel 7.

enumerator kADC_ThresholdCompareFlagOnChn8#: Threshold comparison event on Channel 8.

enumerator kADC_ThresholdCompareFlagOnChn9#: Threshold comparison event on Channel 9.

enumerator kADC_ThresholdCompareFlagOnChn10#: Threshold comparison event on Channel 10.

enumerator kADC_ThresholdCompareFlagOnChn11#: Threshold comparison event on Channel 11.

enumerator kADC_OverrunFlagForChn0#: Mirror the OVERRUN status flag from the result register for ADC channel 0.

enumerator kADC_OverrunFlagForChn1#: Mirror the OVERRUN status flag from the result register for ADC channel 1.

enumerator kADC_OverrunFlagForChn2#: Mirror the OVERRUN status flag from the result register for ADC channel 2.

enumerator kADC_OverrunFlagForChn3#: Mirror the OVERRUN status flag from the result register for ADC channel 3.

enumerator kADC_OverrunFlagForChn4#: Mirror the OVERRUN status flag from the result register for ADC channel 4.

enumerator kADC_OverrunFlagForChn5#: Mirror the OVERRUN status flag from the result register for ADC channel 5.

enumerator kADC_OverrunFlagForChn6#: Mirror the OVERRUN status flag from the result register for ADC channel 6.

enumerator kADC_OverrunFlagForChn7#: Mirror the OVERRUN status flag from the result register for ADC channel 7.

enumerator kADC_OverrunFlagForChn8#: Mirror the OVERRUN status flag from the result register for ADC channel 8.

enumerator kADC_OverrunFlagForChn9#: Mirror the OVERRUN status flag from the result register for ADC channel 9.

enumerator kADC_OverrunFlagForChn10#: Mirror the OVERRUN status flag from the result register for ADC channel 10.

enumerator kADC_OverrunFlagForChn11#: Mirror the OVERRUN status flag from the result register for ADC channel 11.

enumerator kADC_GlobalOverrunFlagForSeqA#: Mirror the glabal OVERRUN status flag for conversion sequence A.

enumerator kADC_GlobalOverrunFlagForSeqB#: Mirror the global OVERRUN status flag for conversion sequence B.

enumerator kADC_ConvSeqAInterruptFlag#: Sequence A interrupt/DMA trigger.

enumerator kADC_ConvSeqBInterruptFlag#: Sequence B interrupt/DMA trigger.

enumerator kADC_ThresholdCompareInterruptFlag#: Threshold comparision interrupt flag.

enumerator kADC_OverrunInterruptFlag#: Overrun interrupt flag.

enum _adc_interrupt_enable#

Interrupts.

Note

Not all the interrupt options are listed here

Values:

enumerator kADC_ConvSeqAInterruptEnable#: Enable interrupt upon completion of each individual conversion in sequence A, or entire sequence.

enumerator kADC_ConvSeqBInterruptEnable#: Enable interrupt upon completion of each individual conversion in sequence B, or entire sequence.

enumerator kADC_OverrunInterruptEnable#: Enable the detection of an overrun condition on any of the channel data registers will cause an overrun interrupt/DMA trigger.

enum _adc_clock_mode#

Define selection of clock mode.

Values:

enumerator kADC_ClockSynchronousMode#: The ADC clock would be derived from the system clock based on “clockDividerNumber”.

enumerator kADC_ClockAsynchronousMode#: The ADC clock would be based on the SYSCON block’s divider.

enum _adc_resolution#

Define selection of resolution.

Values:

enumerator kADC_Resolution6bit#: 6-bit resolution.

enumerator kADC_Resolution8bit#: 8-bit resolution.

enumerator kADC_Resolution10bit#: 10-bit resolution.

enumerator kADC_Resolution12bit#: 12-bit resolution.

enum _adc_voltage_range#

Definfe range of the analog supply voltage VDDA.

Values:

enumerator kADC_HighVoltageRange#

enumerator kADC_LowVoltageRange#

enum _adc_trigger_polarity#

Define selection of polarity of selected input trigger for conversion sequence.

Values:

enumerator kADC_TriggerPolarityNegativeEdge#: A negative edge launches the conversion sequence on the trigger(s).

enumerator kADC_TriggerPolarityPositiveEdge#: A positive edge launches the conversion sequence on the trigger(s).

enum _adc_priority#

Define selection of conversion sequence’s priority.

Values:

enumerator kADC_PriorityLow#: This sequence would be preempted when another sequence is started.

enumerator kADC_PriorityHigh#: This sequence would preempt other sequence even when it is started.

enum _adc_seq_interrupt_mode#

Define selection of conversion sequence’s interrupt.

Values:

enumerator kADC_InterruptForEachConversion#: The sequence interrupt/DMA trigger will be set at the end of each individual ADC conversion inside this conversion sequence.

enumerator kADC_InterruptForEachSequence#: The sequence interrupt/DMA trigger will be set when the entire set of this sequence conversions completes.

enum _adc_threshold_compare_status#

Define status of threshold compare result.

Values:

enumerator kADC_ThresholdCompareInRange#: LOW threshold <= conversion value <= HIGH threshold.

enumerator kADC_ThresholdCompareBelowRange#: conversion value < LOW threshold.

enumerator kADC_ThresholdCompareAboveRange#: conversion value > HIGH threshold.

enum _adc_threshold_crossing_status#

Define status of threshold crossing detection result.

Values:

enumerator kADC_ThresholdCrossingNoDetected#: No threshold Crossing detected.

enumerator kADC_ThresholdCrossingDownward#: Downward Threshold Crossing detected.

enumerator kADC_ThresholdCrossingUpward#: Upward Threshold Crossing Detected.

enum _adc_threshold_interrupt_mode#

Define interrupt mode for threshold compare event.

Values:

enumerator kADC_ThresholdInterruptDisabled#: Threshold comparison interrupt is disabled.

enumerator kADC_ThresholdInterruptOnOutside#: Threshold comparison interrupt is enabled on outside threshold.

enumerator kADC_ThresholdInterruptOnCrossing#: Threshold comparison interrupt is enabled on crossing threshold.

enum _adc_inforesultshift#

Define the info result mode of different resolution.

Values:

enumerator kADC_Resolution12bitInfoResultShift#: Info result shift of Resolution12bit.

enumerator kADC_Resolution10bitInfoResultShift#: Info result shift of Resolution10bit.

enumerator kADC_Resolution8bitInfoResultShift#: Info result shift of Resolution8bit.

enumerator kADC_Resolution6bitInfoResultShift#: Info result shift of Resolution6bit.

enum _adc_tempsensor_common_mode#

Define common modes for Temerature sensor.

Values:

enumerator kADC_HighNegativeOffsetAdded#: Temperature sensor common mode: high negative offset added.

enumerator kADC_IntermediateNegativeOffsetAdded#: Temperature sensor common mode: intermediate negative offset added.

enumerator kADC_NoOffsetAdded#: Temperature sensor common mode: no offset added.

enumerator kADC_LowPositiveOffsetAdded#: Temperature sensor common mode: low positive offset added.

enum _adc_second_control#

Define source impedance modes for GPADC control.

Values:

enumerator kADC_Impedance621Ohm#: Extand ADC sampling time according to source impedance 1: 0.621 kOhm.

enumerator kADC_Impedance55kOhm#: Extand ADC sampling time according to source impedance 20 (default): 55 kOhm.

enumerator kADC_Impedance87kOhm#: Extand ADC sampling time according to source impedance 31: 87 kOhm.

enumerator kADC_NormalFunctionalMode#: TEST mode: Normal functional mode.

enumerator kADC_MultiplexeTestMode#: TEST mode: Multiplexer test mode.

enumerator kADC_ADCInUnityGainMode#: TEST mode: ADC in unity gain mode.

typedef enum _adc_clock_mode adc_clock_mode_t#: Define selection of clock mode.

typedef enum _adc_resolution adc_resolution_t#: Define selection of resolution.

typedef enum _adc_voltage_range adc_vdda_range_t#: Definfe range of the analog supply voltage VDDA.

typedef enum _adc_trigger_polarity adc_trigger_polarity_t#: Define selection of polarity of selected input trigger for conversion sequence.

typedef enum _adc_priority adc_priority_t#: Define selection of conversion sequence’s priority.

typedef enum _adc_seq_interrupt_mode adc_seq_interrupt_mode_t#: Define selection of conversion sequence’s interrupt.

typedef enum _adc_threshold_compare_status adc_threshold_compare_status_t#: Define status of threshold compare result.

typedef enum _adc_threshold_crossing_status adc_threshold_crossing_status_t#: Define status of threshold crossing detection result.

typedef enum _adc_threshold_interrupt_mode adc_threshold_interrupt_mode_t#: Define interrupt mode for threshold compare event.

typedef enum _adc_inforesultshift adc_inforesult_t#: Define the info result mode of different resolution.

typedef enum _adc_tempsensor_common_mode adc_tempsensor_common_mode_t#: Define common modes for Temerature sensor.

typedef enum _adc_second_control adc_second_control_t#: Define source impedance modes for GPADC control.

typedef struct _adc_config adc_config_t#: Define structure for configuring the block.

typedef struct _adc_conv_seq_config adc_conv_seq_config_t#: Define structure for configuring conversion sequence.

typedef struct _adc_result_info adc_result_info_t#: Define structure of keeping conversion result information.

struct _adc_config#

#include <fsl_adc.h>

Define structure for configuring the block.

Public Members

adc_clock_mode_t clockMode#: Select the clock mode for ADC converter.

uint32_t clockDividerNumber#: This field is only available when using kADC_ClockSynchronousMode for “clockMode” field. The divider would be plused by 1 based on the value in this field. The available range is in 8 bits.

adc_resolution_t resolution#: Select the conversion bits.

bool enableBypassCalibration#: By default, a calibration cycle must be performed each time the chip is powered-up. Re-calibration may be warranted periodically - especially if operating conditions have changed. To enable this option would avoid the need to calibrate if offset error is not a concern in the application.

uint32_t sampleTimeNumber#: By default, with value as “0U”, the sample period would be 2.5 ADC clocks. Then, to plus the “sampleTimeNumber” value here. The available value range is in 3 bits.

bool enableLowPowerMode#: If disable low-power mode, ADC remains activated even when no conversions are requested. If enable low-power mode, The ADC is automatically powered-down when no conversions are taking place.

adc_vdda_range_t voltageRange#: Configure the ADC for the appropriate operating range of the analog supply voltage VDDA. Failure to set the area correctly causes the ADC to return incorrect conversion results.

struct _adc_conv_seq_config#

#include <fsl_adc.h>

Define structure for configuring conversion sequence.

Public Members

uint32_t channelMask#: Selects which one or more of the ADC channels will be sampled and converted when this sequence is launched. The masked channels would be involved in current conversion sequence, beginning with the lowest-order. The available range is in 12-bit.

uint32_t triggerMask#: Selects which one or more of the available hardware trigger sources will cause this conversion sequence to be initiated. The available range is 6-bit.

adc_trigger_polarity_t triggerPolarity#: Select the trigger to launch conversion sequence.

bool enableSyncBypass#: To enable this feature allows the hardware trigger input to bypass synchronization flip-flop stages and therefore shorten the time between the trigger input signal and the start of a conversion.

bool enableSingleStep#: When enabling this feature, a trigger will launch a single conversion on the next channel in the sequence instead of the default response of launching an entire sequence of conversions.

adc_seq_interrupt_mode_t interruptMode#: Select the interrpt/DMA trigger mode.

struct _adc_result_info#

#include <fsl_adc.h>

Define structure of keeping conversion result information.

Public Members

uint32_t result#: Keep the conversion data value.

adc_threshold_compare_status_t thresholdCompareStatus#: Keep the threshold compare status.

adc_threshold_crossing_status_t thresholdCorssingStatus#: Keep the threshold crossing status.

uint32_t channelNumber#: Keep the channel number for this conversion.

bool overrunFlag#: Keep the status whether the conversion is overrun or not.

GPIO: General Purpose I/O#

void GPIO_PortInit(GPIO_Type *base, uint32_t port)#

Initializes the GPIO peripheral.

This function ungates the GPIO clock.

Parameters:

base – GPIO peripheral base pointer.
port – GPIO port number.

void GPIO_PinInit(GPIO_Type *base, uint32_t port, uint32_t pin, const gpio_pin_config_t *config)#

Initializes a GPIO pin used by the board.

To initialize the GPIO, define a pin configuration, either input or output, in the user file. Then, call the GPIO_PinInit() function.

This is an example to define an input pin or output pin configuration:

Define a digital input pin configuration,
gpio_pin_config_t config =
{
  kGPIO_DigitalInput,
  0,
}
Define a digital output pin configuration,
gpio_pin_config_t config =
{
  kGPIO_DigitalOutput,
  0,
}

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
pin – GPIO pin number
config – GPIO pin configuration pointer

static inline void GPIO_PinWrite(GPIO_Type *base, uint32_t port, uint32_t pin, uint8_t output)#

Sets the output level of the one GPIO pin to the logic 1 or 0.

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
pin – GPIO pin number
output – GPIO pin output logic level.
- 0: corresponding pin output low-logic level.
- 1: corresponding pin output high-logic level.

static inline uint32_t GPIO_PinRead(GPIO_Type *base, uint32_t port, uint32_t pin)#

Reads the current input value of the GPIO PIN.

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
pin – GPIO pin number

Return values:

GPIO – port input value

0: corresponding pin input low-logic level.
1: corresponding pin input high-logic level.

FSL_GPIO_DRIVER_VERSION#: LPC GPIO driver version.

enum _gpio_pin_direction#

LPC GPIO direction definition.

Values:

enumerator kGPIO_DigitalInput#: Set current pin as digital input

enumerator kGPIO_DigitalOutput#: Set current pin as digital output

typedef enum _gpio_pin_direction gpio_pin_direction_t#: LPC GPIO direction definition.

typedef struct _gpio_pin_config gpio_pin_config_t#

The GPIO pin configuration structure.

Every pin can only be configured as either output pin or input pin at a time. If configured as a input pin, then leave the outputConfig unused.

static inline void GPIO_PortSet(GPIO_Type *base, uint32_t port, uint32_t mask)#

Sets the output level of the multiple GPIO pins to the logic 1.

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
mask – GPIO pin number macro

static inline void GPIO_PortClear(GPIO_Type *base, uint32_t port, uint32_t mask)#

Sets the output level of the multiple GPIO pins to the logic 0.

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
mask – GPIO pin number macro

static inline void GPIO_PortToggle(GPIO_Type *base, uint32_t port, uint32_t mask)#

Reverses current output logic of the multiple GPIO pins.

Parameters:

base – GPIO peripheral base pointer(Typically GPIO)
port – GPIO port number
mask – GPIO pin number macro

struct _gpio_pin_config#

#include <fsl_gpio.h>

The GPIO pin configuration structure.

Every pin can only be configured as either output pin or input pin at a time. If configured as a input pin, then leave the outputConfig unused.

Public Members

gpio_pin_direction_t pinDirection#: GPIO direction, input or output

uint8_t outputLogic#: Set default output logic, no use in input

IOCON: I/O pin configuration#

LPC_IOCON_DRIVER_VERSION#: IOCON driver version 2.0.2.

typedef struct _iocon_group iocon_group_t#: Array of IOCON pin definitions passed to IOCON_SetPinMuxing() must be in this format.

__STATIC_INLINE void IOCON_PinMuxSet (IOCON_Type *base, uint8_t ionumber, uint32_t modefunc)

IOCON function and mode selection definitions.

Sets I/O Control pin mux

Note

See the User Manual for specific modes and functions supported by the various pins.

Parameters:

base – : The base of IOCON peripheral on the chip
ionumber – : GPIO number to mux
modefunc – : OR’ed values of type IOCON_*

Returns:

Nothing

__STATIC_INLINE void IOCON_SetPinMuxing (IOCON_Type *base, const iocon_group_t *pinArray, uint32_t arrayLength)

Set all I/O Control pin muxing.

Parameters:

base – : The base of IOCON peripheral on the chip
pinArray – : Pointer to array of pin mux selections
arrayLength – : Number of entries in pinArray

Returns:

Nothing

FSL_COMPONENT_ID#

struct _iocon_group#: #include <fsl_iocon.h>

Array of IOCON pin definitions passed to IOCON_SetPinMuxing() must be in this format.

MRT: Multi-Rate Timer#

void MRT_Init(MRT_Type *base, const mrt_config_t *config)#

Ungates the MRT clock and configures the peripheral for basic operation.

Note

This API should be called at the beginning of the application using the MRT driver.

Parameters:

base – Multi-Rate timer peripheral base address
config – Pointer to user’s MRT config structure. If MRT has MULTITASK bit field in MODCFG reigster, param config is useless.

void MRT_Deinit(MRT_Type *base)#

Gate the MRT clock.

Parameters:

base – Multi-Rate timer peripheral base address

static inline void MRT_GetDefaultConfig(mrt_config_t *config)#

Fill in the MRT config struct with the default settings.

The default values are:

config->enableMultiTask = false;

Parameters:

config – Pointer to user’s MRT config structure.

static inline void MRT_SetupChannelMode(MRT_Type *base, mrt_chnl_t channel, const mrt_timer_mode_t mode)#

Sets up an MRT channel mode.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Channel that is being configured.
mode – Timer mode to use for the channel.

static inline void MRT_EnableInterrupts(MRT_Type *base, mrt_chnl_t channel, uint32_t mask)#

Enables the MRT interrupt.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number
mask – The interrupts to enable. This is a logical OR of members of the enumeration mrt_interrupt_enable_t

static inline void MRT_DisableInterrupts(MRT_Type *base, mrt_chnl_t channel, uint32_t mask)#

Disables the selected MRT interrupt.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number
mask – The interrupts to disable. This is a logical OR of members of the enumeration mrt_interrupt_enable_t

static inline uint32_t MRT_GetEnabledInterrupts(MRT_Type *base, mrt_chnl_t channel)#

Gets the enabled MRT interrupts.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number

Returns:

The enabled interrupts. This is the logical OR of members of the enumeration mrt_interrupt_enable_t

static inline uint32_t MRT_GetStatusFlags(MRT_Type *base, mrt_chnl_t channel)#

Gets the MRT status flags.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number

Returns:

The status flags. This is the logical OR of members of the enumeration mrt_status_flags_t

static inline void MRT_ClearStatusFlags(MRT_Type *base, mrt_chnl_t channel, uint32_t mask)#

Clears the MRT status flags.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number
mask – The status flags to clear. This is a logical OR of members of the enumeration mrt_status_flags_t

void MRT_UpdateTimerPeriod(MRT_Type *base, mrt_chnl_t channel, uint32_t count, bool immediateLoad)#

Used to update the timer period in units of count.

The new value will be immediately loaded or will be loaded at the end of the current time interval. For one-shot interrupt mode the new value will be immediately loaded.

Note

User can call the utility macros provided in fsl_common.h to convert to ticks

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number
count – Timer period in units of ticks
immediateLoad – true: Load the new value immediately into the TIMER register; false: Load the new value at the end of current timer interval

static inline uint32_t MRT_GetCurrentTimerCount(MRT_Type *base, mrt_chnl_t channel)#

Reads the current timer counting value.

This function returns the real-time timer counting value, in a range from 0 to a timer period.

Note

User can call the utility macros provided in fsl_common.h to convert ticks to usec or msec

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number

Returns:

Current timer counting value in ticks

static inline void MRT_StartTimer(MRT_Type *base, mrt_chnl_t channel, uint32_t count)#

Starts the timer counting.

After calling this function, timers load period value, counts down to 0 and depending on the timer mode it will either load the respective start value again or stop.

Note

User can call the utility macros provided in fsl_common.h to convert to ticks

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number.
count – Timer period in units of ticks. Count can contain the LOAD bit, which control the force load feature.

static inline void MRT_StopTimer(MRT_Type *base, mrt_chnl_t channel)#

Stops the timer counting.

This function stops the timer from counting.

Parameters:

base – Multi-Rate timer peripheral base address
channel – Timer channel number.

static inline uint32_t MRT_GetIdleChannel(MRT_Type *base)#

Find the available channel.

This function returns the lowest available channel number.

Parameters:

base – Multi-Rate timer peripheral base address

FSL_MRT_DRIVER_VERSION#

enum _mrt_chnl#

List of MRT channels.

Values:

enumerator kMRT_Channel_0#: MRT channel number 0

enumerator kMRT_Channel_1#: MRT channel number 1

enumerator kMRT_Channel_2#: MRT channel number 2

enumerator kMRT_Channel_3#: MRT channel number 3

enum _mrt_timer_mode#

List of MRT timer modes.

Values:

enumerator kMRT_RepeatMode#: Repeat Interrupt mode

enumerator kMRT_OneShotMode#: One-shot Interrupt mode

enumerator kMRT_OneShotStallMode#: One-shot stall mode

enum _mrt_interrupt_enable#

List of MRT interrupts.

Values:

enumerator kMRT_TimerInterruptEnable#: Timer interrupt enable

enum _mrt_status_flags#

List of MRT status flags.

Values:

enumerator kMRT_TimerInterruptFlag#: Timer interrupt flag

enumerator kMRT_TimerRunFlag#: Indicates state of the timer

typedef enum _mrt_chnl mrt_chnl_t#: List of MRT channels.

typedef enum _mrt_timer_mode mrt_timer_mode_t#: List of MRT timer modes.

typedef enum _mrt_interrupt_enable mrt_interrupt_enable_t#: List of MRT interrupts.

typedef enum _mrt_status_flags mrt_status_flags_t#: List of MRT status flags.

typedef struct _mrt_config mrt_config_t#

MRT configuration structure.

This structure holds the configuration settings for the MRT peripheral. To initialize this structure to reasonable defaults, call the MRT_GetDefaultConfig() function and pass a pointer to your config structure instance.

The config struct can be made const so it resides in flash

struct _mrt_config#

#include <fsl_mrt.h>

MRT configuration structure.

The config struct can be made const so it resides in flash

Public Members

bool enableMultiTask#: true: Timers run in multi-task mode; false: Timers run in hardware status mode

PINT: Pin Interrupt and Pattern Match Driver#

FSL_PINT_DRIVER_VERSION#

enum _pint_pin_enable#

PINT Pin Interrupt enable type.

Values:

enumerator kPINT_PinIntEnableNone#: Do not generate Pin Interrupt

enumerator kPINT_PinIntEnableRiseEdge#: Generate Pin Interrupt on rising edge

enumerator kPINT_PinIntEnableFallEdge#: Generate Pin Interrupt on falling edge

enumerator kPINT_PinIntEnableBothEdges#: Generate Pin Interrupt on both edges

enumerator kPINT_PinIntEnableLowLevel#: Generate Pin Interrupt on low level

enumerator kPINT_PinIntEnableHighLevel#: Generate Pin Interrupt on high level

enum _pint_int#

PINT Pin Interrupt type.

Values:

enumerator kPINT_PinInt0#: Pin Interrupt 0

enum _pint_pmatch_input_src#

PINT Pattern Match bit slice input source type.

Values:

enumerator kPINT_PatternMatchInp0Src#: Input source 0

enumerator kPINT_PatternMatchInp1Src#: Input source 1

enumerator kPINT_PatternMatchInp2Src#: Input source 2

enumerator kPINT_PatternMatchInp3Src#: Input source 3

enumerator kPINT_PatternMatchInp4Src#: Input source 4

enumerator kPINT_PatternMatchInp5Src#: Input source 5

enumerator kPINT_PatternMatchInp6Src#: Input source 6

enumerator kPINT_PatternMatchInp7Src#: Input source 7

enumerator kPINT_SecPatternMatchInp0Src#: Input source 0

enumerator kPINT_SecPatternMatchInp1Src#: Input source 1

enum _pint_pmatch_bslice#

PINT Pattern Match bit slice type.

Values:

enumerator kPINT_PatternMatchBSlice0#: Bit slice 0

enum _pint_pmatch_bslice_cfg#

PINT Pattern Match configuration type.

Values:

enumerator kPINT_PatternMatchAlways#: Always Contributes to product term match

enumerator kPINT_PatternMatchStickyRise#: Sticky Rising edge

enumerator kPINT_PatternMatchStickyFall#: Sticky Falling edge

enumerator kPINT_PatternMatchStickyBothEdges#: Sticky Rising or Falling edge

enumerator kPINT_PatternMatchHigh#: High level

enumerator kPINT_PatternMatchLow#: Low level

enumerator kPINT_PatternMatchNever#: Never contributes to product term match

enumerator kPINT_PatternMatchBothEdges#: Either rising or falling edge

typedef enum _pint_pin_enable pint_pin_enable_t#: PINT Pin Interrupt enable type.

typedef enum _pint_int pint_pin_int_t#: PINT Pin Interrupt type.

typedef enum _pint_pmatch_input_src pint_pmatch_input_src_t#: PINT Pattern Match bit slice input source type.

typedef enum _pint_pmatch_bslice pint_pmatch_bslice_t#: PINT Pattern Match bit slice type.

typedef enum _pint_pmatch_bslice_cfg pint_pmatch_bslice_cfg_t#: PINT Pattern Match configuration type.

typedef struct _pint_status pint_status_t#: PINT event status.

typedef void (*pint_cb_t)(pint_pin_int_t pintr, pint_status_t *status)#: PINT Callback function.

typedef struct _pint_pmatch_cfg pint_pmatch_cfg_t#

void PINT_Init(PINT_Type *base)#

Initialize PINT peripheral.

This function initializes the PINT peripheral and enables the clock.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

void PINT_SetCallback(PINT_Type *base, pint_cb_t callback)#

Set PINT callback.

This function set the callback for PINT interupt handler.

Parameters:

base – Base address of the PINT peripheral.
callback – Callback.

Return values:

None. –

void PINT_PinInterruptConfig(PINT_Type *base, pint_pin_int_t intr, pint_pin_enable_t enable)#

Configure PINT peripheral pin interrupt.

This function configures a given pin interrupt.

Parameters:

base – Base address of the PINT peripheral.
intr – Pin interrupt.
enable – Selects detection logic.

Return values:

None. –

void PINT_PinInterruptGetConfig(PINT_Type *base, pint_pin_int_t pintr, pint_pin_enable_t *enable)#

Get PINT peripheral pin interrupt configuration.

This function returns the configuration of a given pin interrupt.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.
enable – Pointer to store the detection logic.

Return values:

None. –

void PINT_PinInterruptClrStatus(PINT_Type *base, pint_pin_int_t pintr)#

Clear Selected pin interrupt status only when the pin was triggered by edge-sensitive.

This function clears the selected pin interrupt status.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetStatus(PINT_Type *base, pint_pin_int_t pintr)#

Get Selected pin interrupt status.

This function returns the selected pin interrupt status.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

status – = 0 No pin interrupt request. = 1 Selected Pin interrupt request active.

void PINT_PinInterruptClrStatusAll(PINT_Type *base)#

Clear all pin interrupts status only when pins were triggered by edge-sensitive.

This function clears the status of all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetStatusAll(PINT_Type *base)#

Get all pin interrupts status.

This function returns the status of all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

status – Each bit position indicates the status of corresponding pin interrupt. = 0 No pin interrupt request. = 1 Pin interrupt request active.

static inline void PINT_PinInterruptClrFallFlag(PINT_Type *base, pint_pin_int_t pintr)#

Clear Selected pin interrupt fall flag.

This function clears the selected pin interrupt fall flag.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetFallFlag(PINT_Type *base, pint_pin_int_t pintr)#

Get selected pin interrupt fall flag.

This function returns the selected pin interrupt fall flag.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

flag – = 0 Falling edge has not been detected. = 1 Falling edge has been detected.

static inline void PINT_PinInterruptClrFallFlagAll(PINT_Type *base)#

Clear all pin interrupt fall flags.

This function clears the fall flag for all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetFallFlagAll(PINT_Type *base)#

Get all pin interrupt fall flags.

This function returns the fall flag of all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

flags – Each bit position indicates the falling edge detection of the corresponding pin interrupt. 0 Falling edge has not been detected. = 1 Falling edge has been detected.

static inline void PINT_PinInterruptClrRiseFlag(PINT_Type *base, pint_pin_int_t pintr)#

Clear Selected pin interrupt rise flag.

This function clears the selected pin interrupt rise flag.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetRiseFlag(PINT_Type *base, pint_pin_int_t pintr)#

Get selected pin interrupt rise flag.

This function returns the selected pin interrupt rise flag.

Parameters:

base – Base address of the PINT peripheral.
pintr – Pin interrupt.

Return values:

flag – = 0 Rising edge has not been detected. = 1 Rising edge has been detected.

static inline void PINT_PinInterruptClrRiseFlagAll(PINT_Type *base)#

Clear all pin interrupt rise flags.

This function clears the rise flag for all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline uint32_t PINT_PinInterruptGetRiseFlagAll(PINT_Type *base)#

Get all pin interrupt rise flags.

This function returns the rise flag of all pin interrupts.

Parameters:

base – Base address of the PINT peripheral.

Return values:

flags – Each bit position indicates the rising edge detection of the corresponding pin interrupt. 0 Rising edge has not been detected. = 1 Rising edge has been detected.

void PINT_PatternMatchConfig(PINT_Type *base, pint_pmatch_bslice_t bslice, pint_pmatch_cfg_t *cfg)#

Configure PINT pattern match.

This function configures a given pattern match bit slice.

Parameters:

base – Base address of the PINT peripheral.
bslice – Pattern match bit slice number.
cfg – Pointer to bit slice configuration.

Return values:

None. –

void PINT_PatternMatchGetConfig(PINT_Type *base, pint_pmatch_bslice_t bslice, pint_pmatch_cfg_t *cfg)#

Get PINT pattern match configuration.

This function returns the configuration of a given pattern match bit slice.

Parameters:

base – Base address of the PINT peripheral.
bslice – Pattern match bit slice number.
cfg – Pointer to bit slice configuration.

Return values:

None. –

static inline uint32_t PINT_PatternMatchGetStatus(PINT_Type *base, pint_pmatch_bslice_t bslice)#

Get pattern match bit slice status.

This function returns the status of selected bit slice.

Parameters:

base – Base address of the PINT peripheral.
bslice – Pattern match bit slice number.

Return values:

status – = 0 Match has not been detected. = 1 Match has been detected.

static inline uint32_t PINT_PatternMatchGetStatusAll(PINT_Type *base)#

Get status of all pattern match bit slices.

This function returns the status of all bit slices.

Parameters:

base – Base address of the PINT peripheral.

Return values:

status – Each bit position indicates the match status of corresponding bit slice. = 0 Match has not been detected. = 1 Match has been detected.

uint32_t PINT_PatternMatchResetDetectLogic(PINT_Type *base)#

Reset pattern match detection logic.

This function resets the pattern match detection logic if any of the product term is matching.

Parameters:

base – Base address of the PINT peripheral.

Return values:

pmstatus – Each bit position indicates the match status of corresponding bit slice. = 0 Match was detected. = 1 Match was not detected.

static inline void PINT_PatternMatchEnable(PINT_Type *base)#

Enable pattern match function.

This function enables the pattern match function.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline void PINT_PatternMatchDisable(PINT_Type *base)#

Disable pattern match function.

This function disables the pattern match function.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline void PINT_PatternMatchEnableRXEV(PINT_Type *base)#

Enable RXEV output.

This function enables the pattern match RXEV output.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

static inline void PINT_PatternMatchDisableRXEV(PINT_Type *base)#

Disable RXEV output.

This function disables the pattern match RXEV output.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

void PINT_EnableCallback(PINT_Type *base)#

Enable callback.

This function enables the interrupt for the selected PINT peripheral. Although the pin(s) are monitored as soon as they are enabled, the callback function is not enabled until this function is called.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

void PINT_DisableCallback(PINT_Type *base)#

Disable callback.

This function disables the interrupt for the selected PINT peripheral. Although the pins are still being monitored but the callback function is not called.

Parameters:

base – Base address of the peripheral.

Return values:

None. –

void PINT_Deinit(PINT_Type *base)#

Deinitialize PINT peripheral.

This function disables the PINT clock.

Parameters:

base – Base address of the PINT peripheral.

Return values:

None. –

void PINT_EnableCallbackByIndex(PINT_Type *base, pint_pin_int_t pintIdx)#

enable callback by pin index.

This function enables callback by pin index instead of enabling all pins.

Parameters:

base – Base address of the peripheral.
pintIdx – pin index.

Return values:

None. –

void PINT_EnableInterruptByIndex(PINT_Type *base, pint_pin_int_t pintIdx)#

enable interrupt in NVIC by pin index.

This function enables the interrupt in the NVIC. The difference with PINT_EnableCallbackByIndex() is that PINT_EnableCallbackByIndex() not only enables the interrupt in the NVIC but also clears pending interrupts. Use this function together with PINT_DisableInterruptByIndex() to temporarily disable/enable the pin interrupt. Use PINT_EnableCallbackByIndex() to enable the interrupt after installing the callback.

Parameters:

base – Base address of the peripheral.
pinIdx – pin index.

Return values:

None. –

void PINT_DisableInterruptByIndex(PINT_Type *base, pint_pin_int_t pintIdx)#

disable interrupt in NVIC by pin index.

This function disables the interrupt in the NVIC. The difference with PINT_DisableCallbackByIndex() is that PINT_DisableCallbackByIndex() not only disables the interrupt in the NVIC but also clears pending interrupts. Use this function together with PINT_EnableInterruptByIndex() to temporarily disable/enable the pin interrupt. Use PINT_DisableCallbackByIndex() to disable the interrupt in a de-init function.

Parameters:

base – Base address of the peripheral.
pinIdx – pin index.

Return values:

None. –

void PINT_DisableCallbackByIndex(PINT_Type *base, pint_pin_int_t pintIdx)#

disable callback by pin index.

This function disables callback by pin index instead of disabling all pins.

Parameters:

base – Base address of the peripheral.
pintIdx – pin index.

Return values:

None. –

void PINT_DriverIRQHandler(uint32_t instance)#

PINT parameterized IRQ handler entry.

Parameters:

instance – PINT instance index.

PINT_USE_LEGACY_CALLBACK#

PININT_BITSLICE_SRC_START#

PININT_BITSLICE_SRC_MASK#

PININT_BITSLICE_CFG_START#

PININT_BITSLICE_CFG_MASK#

PININT_BITSLICE_ENDP_MASK#

PINT_PIN_INT_LEVEL#

PINT_PIN_INT_EDGE#

PINT_PIN_INT_FALL_OR_HIGH_LEVEL#

PINT_PIN_INT_RISE#

PINT_PIN_RISE_EDGE#

PINT_PIN_FALL_EDGE#

PINT_PIN_BOTH_EDGE#

PINT_PIN_LOW_LEVEL#

PINT_PIN_HIGH_LEVEL#

struct _pint_status#: #include <fsl_pint.h>

PINT event status.

struct _pint_pmatch_cfg#

Power Driver#

enum pd_bits#

Values:

enumerator kPDRUNCFG_PD_IRC_OUT#

enumerator kPDRUNCFG_PD_IRC#

enumerator kPDRUNCFG_PD_FLASH#

enumerator kPDRUNCFG_PD_BOD#

enumerator kPDRUNCFG_PD_ADC0#

enumerator kPDRUNCFG_PD_SYSOSC#

enumerator kPDRUNCFG_PD_WDT_OSC#

enumerator kPDRUNCFG_PD_SYSPLL#

enumerator kPDRUNCFG_PD_ACMP#

enumerator kPDRUNCFG_ForceUnsigned#

enum _power_wakeup#

Deep sleep and power down mode wake up configurations.

Values:

enumerator kPDAWAKECFG_Wakeup_IRC_OUT#

enumerator kPDAWAKECFG_Wakeup_IRC#

enumerator kPDAWAKECFG_Wakeup_FLASH#

enumerator kPDAWAKECFG_Wakeup_BOD#

enumerator kPDAWAKECFG_Wakeup_ADC#

enumerator kPDAWAKECFG_Wakeup_SYSOSC#

enumerator kPDAWAKECFG_Wakeup_WDT_OSC#

enumerator kPDAWAKECFG_Wakeup_SYSPLL#

enumerator kPDAWAKECFG_Wakeup_ACMP#

enum _power_deep_sleep_active#

Deep sleep/power down mode active part.

Values:

enumerator kPDSLEEPCFG_DeepSleepBODActive#

enumerator kPDSLEEPCFG_DeepSleepWDTOscActive#

enum _power_gen_reg#

pmu general purpose register index

Values:

enumerator kPmu_GenReg0#: general purpose register0

enumerator kPmu_GenReg1#: general purpose register1

enumerator kPmu_GenReg2#: general purpose register2

enumerator kPmu_GenReg3#: general purpose register3

enumerator kPmu_GenReg4#: DPDCTRL bit 31-4

enum _power_mode_config#

Values:

enumerator kPmu_Sleep#

enumerator kPmu_Deep_Sleep#

enumerator kPmu_PowerDown#

enumerator kPmu_Deep_PowerDown#

enum _power_bod_reset_level#

BOD reset level, if VDD below reset level value, the reset will be asserted.

Values:

enumerator kBod_ResetLevelReserved#: BOD Reset Level reserved.

enumerator kBod_ResetLevel1#: BOD Reset Level1: 2.05V

enumerator kBod_ResetLevel2#: BOD Reset Level2: 2.34V

enumerator kBod_ResetLevel3#: BOD Reset Level3: 2.63V

enum _power_bod_interrupt_level#

BOD interrupt level, if VDD below interrupt level value, the BOD interrupt will be asserted.

Values:

enumerator kBod_InterruptLevelReserved#: BOD interrupt level reserved.

enumerator kBod_InterruptLevel1#: BOD interrupt level1: 2.25V.

enumerator kBod_InterruptLevel2#: BOD interrupt level2: 2.54V.

enumerator kBod_InterruptLevel3#: BOD interrupt level3: 2.85V.

typedef enum pd_bits pd_bit_t#

typedef enum _power_gen_reg power_gen_reg_t#: pmu general purpose register index

typedef enum _power_mode_config power_mode_cfg_t#

typedef enum _power_bod_reset_level power_bod_reset_level_t#: BOD reset level, if VDD below reset level value, the reset will be asserted.

typedef enum _power_bod_interrupt_level power_bod_interrupt_level_t#: BOD interrupt level, if VDD below interrupt level value, the BOD interrupt will be asserted.

FSL_POWER_DRIVER_VERSION#: power driver version 2.1.0.

PMUC_PCON_RESERVED_MASK#: PMU PCON reserved mask, used to clear reserved field which should not write 1.

POWER_EnbaleLPO#

POWER_EnbaleLPOInDeepPowerDownMode#

static inline void POWER_EnablePD(pd_bit_t en)#

API to enable PDRUNCFG bit in the Syscon. Note that enabling the bit powers down the peripheral.

Parameters:

en – peripheral for which to enable the PDRUNCFG bit

Returns:

none

static inline void POWER_DisablePD(pd_bit_t en)#

API to disable PDRUNCFG bit in the Syscon. Note that disabling the bit powers up the peripheral.

Parameters:

en – peripheral for which to disable the PDRUNCFG bit

Returns:

none

static inline void POWER_WakeUpConfig(uint32_t mask, bool powerDown)#

API to config wakeup configurations for deep sleep mode and power down mode.

Parameters:

mask – wake up configurations for deep sleep mode and power down mode, reference _power_wakeup.
powerDown – true is power down the mask part, false is powered part.

static inline void POWER_DeepSleepConfig(uint32_t mask, bool powerDown)#

API to config active part for deep sleep mode and power down mode.

Parameters:

mask – active part configurations for deep sleep mode and power down mode, reference _power_deep_sleep_active.
powerDown – true is power down the mask part, false is powered part.

static inline void POWER_EnableDeepSleep(void)#

API to enable deep sleep bit in the ARM Core.

Returns:: none

static inline void POWER_DisableDeepSleep(void)#

API to disable deep sleep bit in the ARM Core.

Returns:: none

void POWER_EnterSleep(void)#

API to enter sleep power mode.

Returns:: none

void POWER_EnterDeepSleep(uint32_t activePart)#

API to enter deep sleep power mode.

Parameters:

activePart – should be a single or combine value of _power_deep_sleep_active .

Returns:

none

void POWER_EnterPowerDown(uint32_t activePart)#

API to enter power down mode.

Parameters:

activePart – should be a single or combine value of _power_deep_sleep_active .

Returns:

none

void POWER_EnterDeepPowerDownMode(void)#

API to enter deep power down mode.

Returns:: none

static inline uint32_t POWER_GetSleepModeFlag(void)#

API to get sleep mode flag.

Returns:: sleep mode flag: 0 is active mode, 1 is sleep mode entered.

static inline void POWER_ClrSleepModeFlag(void)#: API to clear sleep mode flag.

static inline uint32_t POWER_GetDeepPowerDownModeFlag(void)#

API to get deep power down mode flag.

Returns:: sleep mode flag: 0 not deep power down, 1 is deep power down mode entered.

static inline void POWER_ClrDeepPowerDownModeFlag(void)#: API to clear deep power down mode flag.

static inline void POWER_EnableNonDpd(bool enable)#

API to enable non deep power down mode.

Parameters:

enable – true is enable non deep power down, otherwise disable.

static inline void POWER_EnableLPO(bool enable)#

API to enable LPO.

Parameters:

enable – true to enable LPO, false to disable LPO.

static inline void POWER_EnableLPOInDeepPowerDownMode(bool enable)#

API to enable LPO in deep power down mode.

Parameters:

enable – true to enable LPO, false to disable LPO.

static inline void POWER_SetRetainData(power_gen_reg_t index, uint32_t data)#

API to retore data to general purpose register which can be retain during deep power down mode. Note the kPMU_GenReg4 can retore 3 byte data only, so the general purpose register can store 19bytes data.

Parameters:

index – general purpose data register index.
data – data to restore.

static inline uint32_t POWER_GetRetainData(power_gen_reg_t index)#

API to get data from general purpose register which retain during deep power down mode. Note the kPMU_GenReg4 can retore 3 byte data only, so the general purpose register can store 19bytes data.

Parameters:

index – general purpose data register index.

Returns:

data stored in the general purpose register.

static inline void POWER_EnableWktClkIn(bool enable, bool enHysteresis)#

API to enable external clock input for self wake up timer.

Parameters:

enable – true is enable external clock input for self-wake-up timer, otherwise disable.
enHysteresis – true is enable Hysteresis for the pin, otherwise disable.

static inline void POWER_EnableWakeupPinForDeepPowerDown(bool enable, bool enHysteresis)#

API to enable wake up pin for deep power down mode.

Parameters:

enable – true is enable, otherwise disable.
enHysteresis – true is enable Hysteresis for the pin, otherwise disable.

static inline void POWER_SetBodLevel(power_bod_reset_level_t resetLevel, power_bod_interrupt_level_t interruptLevel, bool enable)#

Set Bod interrupt level and reset level.

Parameters:

resetLevel – BOD reset threshold level, please refer to power_bod_reset_level_t.
interruptLevel – BOD interrupt threshold level, please refer to power_bod_interrupt_level_t.
enable – Used to enable/disable the BOD interrupt and BOD reset.

Reset Driver#

enum _SYSCON_RSTn#

Enumeration for peripheral reset control bits.

Defines the enumeration for peripheral reset control bits in PRESETCTRL/ASYNCPRESETCTRL registers

Values:

enumerator kSPI0_RST_N_SHIFT_RSTn#: SPI0 reset control.

enumerator kSPI1_RST_N_SHIFT_RSTn#: SPI1 reset control

enumerator kUARTFRG_RST_N_SHIFT_RSTn#: UARTFRG reset control

enumerator kUART0_RST_N_SHIFT_RSTn#: UART0 reset control

enumerator kUART1_RST_N_SHIFT_RSTn#: UART1 reset control

enumerator kUART2_RST_N_SHIFT_RSTn#: UART2 reset control

enumerator kI2C0_RST_N_SHIFT_RSTn#: I2C0 reset control

enumerator kMRT_RST_N_SHIFT_RSTn#: Multi-rate timer(MRT) reset control

enumerator kSCT_RST_N_SHIFT_RSTn#: SCT reset control

enumerator kWKT_RST_N_SHIFT_RSTn#: Self-wake-up timer(WKT) reset control

enumerator kGPIO0_RST_N_SHIFT_RSTn#: GPIO0 reset control

enumerator kFLASH_RST_N_SHIFT_RSTn#: Flash controller reset control

enumerator kACMP_RST_N_SHIFT_RSTn#: Analog comparator reset control

enumerator kCRC_RST_SHIFT_RSTn#: CRC reset control

enumerator kI2C1_RST_N_SHIFT_RSTn#: I2C1 reset control

enumerator kI2C2_RST_N_SHIFT_RSTn#: I2C2 reset control

enumerator kI2C3_RST_N_SHIFT_RSTn#: I2C3 reset control

enumerator kADC_RST_N_SHIFT_RSTn#: ADC reset control

enumerator kDMA_RST_N_SHIFT_RSTn#: DMA reset control

typedef enum _SYSCON_RSTn SYSCON_RSTn_t#

Enumeration for peripheral reset control bits.

Defines the enumeration for peripheral reset control bits in PRESETCTRL/ASYNCPRESETCTRL registers

typedef SYSCON_RSTn_t reset_ip_name_t#

void RESET_SetPeripheralReset(reset_ip_name_t peripheral)#

Assert reset to peripheral.

Asserts reset signal to specified peripheral module.

Parameters:

peripheral – Assert reset to this peripheral. The enum argument contains encoding of reset register and reset bit position in the reset register.

void RESET_ClearPeripheralReset(reset_ip_name_t peripheral)#

Clear reset to peripheral.

Clears reset signal to specified peripheral module, allows it to operate.

Parameters:

peripheral – Clear reset to this peripheral. The enum argument contains encoding of reset register and reset bit position in the reset register.

void RESET_PeripheralReset(reset_ip_name_t peripheral)#

Reset peripheral module.

Parameters:

peripheral – Peripheral to reset. The enum argument contains encoding of reset register and reset bit position in the reset register.

static inline void RESET_ReleasePeripheralReset(reset_ip_name_t peripheral)#

Release peripheral module.

Parameters:

peripheral – Peripheral to release. The enum argument contains encoding of reset register and reset bit position in the reset register.

FSL_RESET_DRIVER_VERSION#: reset driver version 2.4.0

FLASH_RSTS_N#: Array initializers with peripheral reset bits

I2C_RSTS_N#

GPIO_RSTS_N#

SWM_RSTS_N#

SCT_RSTS_N#

WKT_RSTS_N#

MRT_RSTS_N#

SPI_RSTS_N#

UART_RSTS_N#

ACMP_RSTS_N#

ADC_RSTS_N#

DAC_RSTS_N#

DMA_RSTS_N#

SCTimer: SCTimer/PWM (SCT)#

status_t SCTIMER_Init(SCT_Type *base, const sctimer_config_t *config)#

Ungates the SCTimer clock and configures the peripheral for basic operation.

Note

This API should be called at the beginning of the application using the SCTimer driver.

Parameters:

base – SCTimer peripheral base address
config – Pointer to the user configuration structure.

Returns:

kStatus_Success indicates success; Else indicates failure.

void SCTIMER_Deinit(SCT_Type *base)#

Gates the SCTimer clock.

Parameters:

base – SCTimer peripheral base address

void SCTIMER_GetDefaultConfig(sctimer_config_t *config)#

Fills in the SCTimer configuration structure with the default settings.

The default values are:

config->enableCounterUnify = true;
config->clockMode = kSCTIMER_System_ClockMode;
config->clockSelect = kSCTIMER_Clock_On_Rise_Input_0;
config->enableBidirection_l = false;
config->enableBidirection_h = false;
config->prescale_l = 0U;
config->prescale_h = 0U;
config->outInitState = 0U;
config->inputsync  = 0xFU;

Parameters:

config – Pointer to the user configuration structure.

status_t SCTIMER_SetupPwm(SCT_Type *base, const sctimer_pwm_signal_param_t *pwmParams, sctimer_pwm_mode_t mode, uint32_t pwmFreq_Hz, uint32_t srcClock_Hz, uint32_t *event)#

Configures the PWM signal parameters.

Deprecated:: Use SCTIMER_SetupSharedPeriodPwm() instead. That function configures one channel per call and reuses a single shared period/limit event across same-frequency channels (N + 1 events for N channels instead of 2 * N), and returns the pulse event explicitly so the duty cycle can be updated with SCTIMER_UpdatePwmDutycycleByEvent(). This function remains functional for backward compatibility.

Call this function to configure the PWM signal period, mode, duty cycle, and edge. This function will create 2 events; one of the events will trigger on match with the pulse value and the other will trigger when the counter matches the PWM period. The PWM period event is also used as a limit event to reset the counter or change direction. Both events are enabled for the same state. The state number can be retrieved by calling the function SCTIMER_GetCurrentStateNumber(). The counter is set to operate as one 32-bit counter (unify bit is set to 1). The counter operates in bi-directional mode when generating a center-aligned PWM.

Note

When setting PWM output from multiple output pins, they all should use the same PWM mode i.e all PWM’s should be either edge-aligned or center-aligned. When using this API, the PWM signal frequency of all the initialized channels must be the same. Otherwise all the initialized channels’ PWM signal frequency is equal to the last call to the API’s pwmFreq_Hz.

Parameters:

base – SCTimer peripheral base address
pwmParams – PWM parameters to configure the output
mode – PWM operation mode, options available in enumeration sctimer_pwm_mode_t
pwmFreq_Hz – PWM signal frequency in Hz
srcClock_Hz – SCTimer counter clock in Hz
event – Pointer to a variable where the PWM period event number is stored

Returns:

kStatus_Success on success kStatus_Fail If we have hit the limit in terms of number of events created or if an incorrect PWM dutycylce is passed in.

void SCTIMER_UpdatePwmDutycycle(SCT_Type *base, sctimer_out_t output, uint8_t dutyCyclePercent, uint32_t event)#

Updates the duty cycle of an active PWM signal.

Deprecated:: Use SCTIMER_UpdatePwmDutycycleByEvent() instead. That function takes the period and pulse events explicitly (it does not assume the pulse event is event + 1), so it works with channels created by SCTIMER_SetupSharedPeriodPwm(), and it can update immediately or glitchlessly at the next period. This function remains functional for backward compatibility.

Before calling this function, the counter is set to operate as one 32-bit counter (unify bit is set to 1).

Parameters:

base – SCTimer peripheral base address
output – The output to configure
dutyCyclePercent – New PWM pulse width; the value should be between 1 to 100
event – Event number associated with this PWM signal. This was returned to the user by the function SCTIMER_SetupPwm().

status_t SCTIMER_SetupSharedPeriodPwm(SCT_Type *base, const sctimer_pwm_signal_param_t *pwmParam, sctimer_pwm_mode_t mode, uint32_t pwmFreq_Hz, uint32_t srcClock_Hz, uint32_t *periodEvent, uint32_t *pulseEvent)#

Configures one PWM channel that shares an auto-detected period event across calls.

Unlike SCTIMER_SetupPwm() (which spends two events per channel and recreates a period event each call), this function configures a single channel and reuses one shared period/limit event for all same-frequency channels. On each call it inspects the unified-counter limit mask (LIMIT[LIMMSK_L]) for an existing period/limit event:

none present -> it creates the shared period/limit event (1 period + 1 pulse event), or
one present whose period (its MATCH value) and alignment (CTRL[BIDIR_L] set <=> center-aligned) match the requested pwmFreq_Hz/mode -> it reuses that event and only creates this channel’s pulse event (1 pulse event), or
one present whose period or alignment differs -> it returns kStatus_InvalidArgument without creating or modifying anything (two periods cannot share one unified counter).

So K same-frequency channels built by K calls consume K + 1 events / K + 1 match registers instead of 2 * K. A period/limit event left by a prior SCTIMER_SetupPwm() at the same period/alignment is also reusable. The counter must already be configured as one unified 32-bit counter (CONFIG[UNIFY] = 1).

Note

Period detection assumes the shared PWM period/limit is the lowest-numbered unified-counter limit event (the only limit events created by this function and SCTIMER_SetupPwm()). If the application created other unified-counter limit events before calling this function, detection may match the wrong event; in that case create the PWM channels before any unrelated limit events.

Note

Each call configures exactly one channel and is atomic for that channel only (on failure it creates nothing). Building a multi-channel group is a sequence of independent calls; this API does NOT roll the whole group back if a later call fails.

Note

The channel is enabled in the current state only. In a multi-state design the caller must re-enable the returned periodEvent and each channel’s pulseEvent in every state that should run the group (via SCTIMER_ScheduleEvent()). Because the period event is shared, failing to re-schedule it in a state disrupts ALL channels in that state, not just one.

Parameters:

base – SCTimer peripheral base address
pwmParam – Pointer to this channel’s PWM parameters (output, level, duty)
mode – PWM operation mode (all sharing channels must use the same mode), see sctimer_pwm_mode_t
pwmFreq_Hz – Common PWM signal frequency in Hz (all sharing channels must use the same frequency)
srcClock_Hz – SCTimer counter clock in Hz
periodEvent – Pointer to a variable where the shared period event number (new or reused) is stored
pulseEvent – Pointer to a variable where this channel’s pulse event number is stored

Returns:

kStatus_Success on success kStatus_InvalidArgument if arguments are invalid, the counter is not in unified mode, or an existing shared period event has a different frequency/alignment kStatus_OutOfRange if the event or match-register budget would be exceeded

void SCTIMER_UpdatePwmDutycycleByEvent(SCT_Type *base, sctimer_out_t output, uint8_t dutyCyclePercent, uint32_t periodEvent, uint32_t pulseEvent, sctimer_pwm_update_mode_t updateMode)#

Updates the duty cycle of a PWM signal using explicit period and pulse events.

Unlike SCTIMER_UpdatePwmDutycycle(), this function does not assume the pulse event is periodEvent + 1, so it works for channels created by SCTIMER_SetupSharedPeriodPwm() where the pulse events are not adjacent to the shared period event. The counter must be in unified 32-bit mode.

Parameters:

base – SCTimer peripheral base address
output – The output to configure
dutyCyclePercent – New PWM pulse width; the value should be between 0 and 100
periodEvent – The shared period event (as returned by SCTIMER_SetupSharedPeriodPwm())
pulseEvent – The channel’s pulse event (as returned by SCTIMER_SetupSharedPeriodPwm())
updateMode – When the new duty cycle takes effect, see sctimer_pwm_update_mode_t

status_t SCTIMER_SetupComplementaryPwm(SCT_Type *base, sctimer_out_t outHigh, sctimer_out_t outLow, uint8_t dutyCyclePercent, uint32_t deadTimeTicks, sctimer_pwm_mode_t mode, uint32_t pwmFreq_Hz, uint32_t srcClock_Hz, sctimer_complementary_pwm_handle_t *handle)#

Configures a complementary PWM output pair with programmable dead time.

Builds a high-side/low-side complementary pair on the unified 32-bit counter from one duty value plus a dead time expressed in SCT counter clock ticks. Dead time is inserted by delaying each output’s turn-on by deadTimeTicks while keeping turn-off immediate, which guarantees a non-overlap (dead-time) gap at both switching edges so the two outputs are never simultaneously active (no shoot-through).

The shared period event also limits (resets) the counter. The returned handle is used to update the pair’s duty cycle later with SCTIMER_UpdateComplementaryPwmDutycycle().

Note

Dead time is inserted by delaying the relevant turn-on edge - the high side in edge-aligned mode, the low side in center-aligned mode - so that output’s active width shrinks by deadTimeTicks (the usual cost of dead time).

Note

For a switching duty the valid range is 0 < duty < 100 (needs deadTimeTicks < duty and duty + deadTimeTicks < period); deadTimeTicks = 0 is allowed (strict complementary). 0 % and 100 % are accepted as constant complementary levels (high-side fully off / fully on): the pair is driven to static opposite levels with no switching and no dead-time window. A both-off fault state is not expressible as a duty - use a separate output force/disable path for that.

Note

Call this function once per complementary pair. To drive several pairs on the same SCTimer (for example the three half-bridges of a 3-phase inverter), call it once for each pair — but all pairs MUST use the same pwmFreq_Hz and the same mode, because they share one unified counter (a single count direction and period). Mixing frequencies or alignments across pairs creates conflicting limit events on the counter and produces an incorrect waveform.

Parameters:

base – SCTimer peripheral base address
outHigh – High-side output pin
outLow – Low-side output pin (complement of outHigh)
dutyCyclePercent – High-side duty cycle, value should be between 0 and 100
deadTimeTicks – Dead time in SCT counter clock ticks, inserted at both edges; 0 = no dead time (strict complementary)
mode – PWM operation mode, see sctimer_pwm_mode_t
pwmFreq_Hz – PWM signal frequency in Hz
srcClock_Hz – SCTimer counter clock in Hz
handle – Pointer to a handle that receives the pair’s event numbers and parameters

Returns:

kStatus_Success on success kStatus_InvalidArgument if arguments are invalid, the counter is not unified, or the dead time does not fit the requested duty/period without causing overlap kStatus_OutOfRange if the event or match-register budget would be exceeded

status_t SCTIMER_UpdateComplementaryPwmDutycycle(SCT_Type *base, const sctimer_complementary_pwm_handle_t *handle, uint8_t dutyCyclePercent, sctimer_pwm_update_mode_t updateMode)#

Updates the duty cycle of a complementary PWM pair, preserving dead time.

Recomputes both moving switching edges (high-side turn-off and low-side turn-on) from the new duty cycle while keeping the dead-time offset, and writes them so the no-overlap guarantee holds across the update. In kSCTIMER_UpdateOnNextPeriod mode both edges reload together at the next counter cycle, so the dead-time relationship is updated atomically and glitchlessly.

Note

A switching duty must keep the dead time inside the period (deadTimeTicks < duty and duty + deadTimeTicks < period). 0 % and 100 % are accepted as constant complementary levels: the pair is driven to static opposite levels (no switching, no dead time). Switching between a constant level and a switching duty briefly halts the counter to re-bind the outputs. A both-off fault state is not a duty - use a separate output force/disable path.

Note

updateMode is honored only for a switching duty (0 < duty < 100). A 0 % or 100 % update is always applied immediately (counter briefly halted), regardless of updateMode, because a constant level cannot be loaded through the glitchless reload-register (MATCHREL) path: it requires detaching the events and forcing the output levels, which needs a halt. kSCTIMER_UpdateOnNextPeriod therefore does not defer a 0 %/100 % change to the next period boundary.

Parameters:

base – SCTimer peripheral base address
handle – Handle returned by SCTIMER_SetupComplementaryPwm()
dutyCyclePercent – New high-side duty cycle, value should be between 0 and 100
updateMode – When the new duty cycle takes effect, see sctimer_pwm_update_mode_t. Ignored for a 0 %/100 % update, which is always immediate; see the note above.

Returns:

kStatus_Success on success kStatus_InvalidArgument if the dead time does not fit the requested duty/period

static inline void SCTIMER_EnableInterrupts(SCT_Type *base, uint32_t mask)#

Enables the selected SCTimer interrupts.

Parameters:

base – SCTimer peripheral base address
mask – The interrupts to enable. This is a logical OR of members of the enumeration sctimer_interrupt_enable_t

static inline void SCTIMER_DisableInterrupts(SCT_Type *base, uint32_t mask)#

Disables the selected SCTimer interrupts.

Parameters:

base – SCTimer peripheral base address
mask – The interrupts to enable. This is a logical OR of members of the enumeration sctimer_interrupt_enable_t

static inline uint32_t SCTIMER_GetEnabledInterrupts(SCT_Type *base)#

Gets the enabled SCTimer interrupts.

Parameters:

base – SCTimer peripheral base address

Returns:

The enabled interrupts. This is the logical OR of members of the enumeration sctimer_interrupt_enable_t

static inline uint32_t SCTIMER_GetStatusFlags(SCT_Type *base)#

Gets the SCTimer status flags.

Parameters:

base – SCTimer peripheral base address

Returns:

The status flags. This is the logical OR of members of the enumeration sctimer_status_flags_t

static inline void SCTIMER_ClearStatusFlags(SCT_Type *base, uint32_t mask)#

Clears the SCTimer status flags.

Parameters:

base – SCTimer peripheral base address
mask – The status flags to clear. This is a logical OR of members of the enumeration sctimer_status_flags_t

static inline void SCTIMER_StartTimer(SCT_Type *base, uint32_t countertoStart)#

Starts the SCTimer counter.

Note

In 16-bit mode, we can enable both Counter_L and Counter_H, In 32-bit mode, we only can select Counter_U.

Parameters:

base – SCTimer peripheral base address
countertoStart – The SCTimer counters to enable. This is a logical OR of members of the enumeration sctimer_counter_t.

static inline void SCTIMER_StopTimer(SCT_Type *base, uint32_t countertoStop)#

Halts the SCTimer counter.

Parameters:

base – SCTimer peripheral base address
countertoStop – The SCTimer counters to stop. This is a logical OR of members of the enumeration sctimer_counter_t.

status_t SCTIMER_CreateAndScheduleEvent(SCT_Type *base, sctimer_event_t howToMonitor, uint32_t matchValue, uint32_t whichIO, sctimer_counter_t whichCounter, uint32_t *event)#

Create an event that is triggered on a match or IO and schedule in current state.

This function will configure an event using the options provided by the user. If the event type uses the counter match, then the function will set the user provided match value into a match register and put this match register number into the event control register. The event is enabled for the current state and the event number is increased by one at the end. The function returns the event number; this event number can be used to configure actions to be done when this event is triggered.

Parameters:

base – SCTimer peripheral base address
howToMonitor – Event type; options are available in the enumeration sctimer_interrupt_enable_t
matchValue – The match value that will be programmed to a match register
whichIO – The input or output that will be involved in event triggering. This field is ignored if the event type is “match only”
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
event – Pointer to a variable where the new event number is stored

Returns:

kStatus_Success on success kStatus_Error if we have hit the limit in terms of number of events created or if we have reached the limit in terms of number of match registers

void SCTIMER_ScheduleEvent(SCT_Type *base, uint32_t event)#

Enable an event in the current state.

This function will allow the event passed in to trigger in the current state. The event must be created earlier by either calling the function SCTIMER_SetupPwm() or function SCTIMER_CreateAndScheduleEvent() .

Parameters:

base – SCTimer peripheral base address
event – Event number to enable in the current state

status_t SCTIMER_IncreaseState(SCT_Type *base)#

Increase the state by 1.

All future events created by calling the function SCTIMER_ScheduleEvent() will be enabled in this new state.

Parameters:

base – SCTimer peripheral base address

Returns:

kStatus_Success on success kStatus_Error if we have hit the limit in terms of states used

uint32_t SCTIMER_GetCurrentState(SCT_Type *base)#

Provides the current state.

User can use this to set the next state by calling the function SCTIMER_SetupNextStateAction().

Parameters:

base – SCTimer peripheral base address

Returns:

The current state

static inline void SCTIMER_SetCounterState(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t state)#

Set the counter current state.

The function is to set the state variable bit field of STATE register. Writing to the STATE_L, STATE_H, or unified register is only allowed when the corresponding counter is halted (HALT bits are set to 1 in the CTRL register).

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
state – The counter current state number (only support range from 0~31).

static inline uint16_t SCTIMER_GetCounterState(SCT_Type *base, sctimer_counter_t whichCounter)#

Get the counter current state value.

The function is to get the state variable bit field of STATE register.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.

Returns:

The the counter current state value.

status_t SCTIMER_SetupCaptureAction(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t *captureRegister, uint32_t event)#

Setup capture of the counter value on trigger of a selected event.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
captureRegister – Pointer to a variable where the capture register number will be returned. User can read the captured value from this register when the specified event is triggered.
event – Event number that will trigger the capture

Returns:

kStatus_Success on success kStatus_Error if we have hit the limit in terms of number of match/capture registers available

void SCTIMER_SetCallback(SCT_Type *base, sctimer_event_callback_t callback, uint32_t event)#

Receive noticification when the event trigger an interrupt.

If the interrupt for the event is enabled by the user, then a callback can be registered which will be invoked when the event is triggered

Parameters:

base – SCTimer peripheral base address
event – Event number that will trigger the interrupt
callback – Function to invoke when the event is triggered

static inline void SCTIMER_SetupStateLdMethodAction(SCT_Type *base, uint32_t event, bool fgLoad)#

Change the load method of transition to the specified state.

Change the load method of transition, it will be triggered by the event number that is passed in by the user.

Parameters:

base – SCTimer peripheral base address
event – Event number that will change the method to trigger the state transition
fgLoad – The method to load highest-numbered event occurring for that state to the STATE register.
- true: Load the STATEV value to STATE when the event occurs to be the next state.
- false: Add the STATEV value to STATE when the event occurs to be the next state.

static inline void SCTIMER_SetupNextStateActionwithLdMethod(SCT_Type *base, uint32_t nextState, uint32_t event, bool fgLoad)#

Transition to the specified state with Load method.

This transition will be triggered by the event number that is passed in by the user, the method decide how to load the highest-numbered event occurring for that state to the STATE register.

Parameters:

base – SCTimer peripheral base address
nextState – The next state SCTimer will transition to
event – Event number that will trigger the state transition
fgLoad – The method to load the highest-numbered event occurring for that state to the STATE register.
- true: Load the STATEV value to STATE when the event occurs to be the next state.
- false: Add the STATEV value to STATE when the event occurs to be the next state.

static inline void SCTIMER_SetupNextStateAction(SCT_Type *base, uint32_t nextState, uint32_t event)#

Transition to the specified state.

Deprecated:: Do not use this function. It has been superceded by SCTIMER_SetupNextStateActionwithLdMethod

This transition will be triggered by the event number that is passed in by the user.

Parameters:

base – SCTimer peripheral base address
nextState – The next state SCTimer will transition to
event – Event number that will trigger the state transition

static inline void SCTIMER_SetupEventActiveDirection(SCT_Type *base, sctimer_event_active_direction_t activeDirection, uint32_t event)#

Setup event active direction when the counters are operating in BIDIR mode.

Parameters:

base – SCTimer peripheral base address
activeDirection – Event generation active direction, see sctimer_event_active_direction_t.
event – Event number that need setup the active direction.

static inline void SCTIMER_SetupOutputSetAction(SCT_Type *base, uint32_t whichIO, uint32_t event)#

Set the Output.

This output will be set when the event number that is passed in by the user is triggered.

Parameters:

base – SCTimer peripheral base address
whichIO – The output to set
event – Event number that will trigger the output change

static inline void SCTIMER_SetupOutputClearAction(SCT_Type *base, uint32_t whichIO, uint32_t event)#

Clear the Output.

This output will be cleared when the event number that is passed in by the user is triggered.

Parameters:

base – SCTimer peripheral base address
whichIO – The output to clear
event – Event number that will trigger the output change

void SCTIMER_SetupOutputToggleAction(SCT_Type *base, uint32_t whichIO, uint32_t event)#

Toggle the output level.

This change in the output level is triggered by the event number that is passed in by the user.

Parameters:

base – SCTimer peripheral base address
whichIO – The output to toggle
event – Event number that will trigger the output change

static inline void SCTIMER_SetupCounterLimitAction(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t event)#

Limit the running counter.

The counter is limited when the event number that is passed in by the user is triggered.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
event – Event number that will trigger the counter to be limited

static inline void SCTIMER_SetupCounterStopAction(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t event)#

Stop the running counter.

The counter is stopped when the event number that is passed in by the user is triggered.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
event – Event number that will trigger the counter to be stopped

static inline void SCTIMER_SetupCounterStartAction(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t event)#

Re-start the stopped counter.

The counter will re-start when the event number that is passed in by the user is triggered.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
event – Event number that will trigger the counter to re-start

static inline void SCTIMER_SetupCounterHaltAction(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t event)#

Halt the running counter.

The counter is disabled (halted) when the event number that is passed in by the user is triggered. When the counter is halted, all further events are disabled. The HALT condition can only be removed by calling the SCTIMER_StartTimer() function.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
event – Event number that will trigger the counter to be halted

static inline void SCTIMER_SetupDmaTriggerAction(SCT_Type *base, uint32_t dmaNumber, uint32_t event)#

Generate a DMA request.

DMA request will be triggered by the event number that is passed in by the user.

Parameters:

base – SCTimer peripheral base address
dmaNumber – The DMA request to generate
event – Event number that will trigger the DMA request

static inline void SCTIMER_SetCOUNTValue(SCT_Type *base, sctimer_counter_t whichCounter, uint32_t value)#

Set the value of counter.

The function is to set the value of Count register, Writing to the COUNT_L, COUNT_H, or unified register is only allowed when the corresponding counter is halted (HALT bits are set to 1 in the CTRL register).

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
value – the counter value update to the COUNT register.

static inline uint32_t SCTIMER_GetCOUNTValue(SCT_Type *base, sctimer_counter_t whichCounter)#

Get the value of counter.

The function is to read the value of Count register, software can read the counter registers at any time..

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.

Returns:

The value of counter selected.

static inline void SCTIMER_SetEventInState(SCT_Type *base, uint32_t event, uint32_t state)#

Set the state mask bit field of EV_STATE register.

Parameters:

base – SCTimer peripheral base address
event – The EV_STATE register be set.
state – The state value in which the event is enabled to occur.

static inline void SCTIMER_ClearEventInState(SCT_Type *base, uint32_t event, uint32_t state)#

Clear the state mask bit field of EV_STATE register.

Parameters:

base – SCTimer peripheral base address
event – The EV_STATE register be clear.
state – The state value in which the event is disabled to occur.

static inline bool SCTIMER_GetEventInState(SCT_Type *base, uint32_t event, uint32_t state)#

Get the state mask bit field of EV_STATE register.

Note

This function is to check whether the event is enabled in a specific state.

Parameters:

base – SCTimer peripheral base address
event – The EV_STATE register be read.
state – The state value.

Returns:

The the state mask bit field of EV_STATE register.

true: The event is enable in state.
false: The event is disable in state.

static inline uint32_t SCTIMER_GetCaptureValue(SCT_Type *base, sctimer_counter_t whichCounter, uint8_t capChannel)#

Get the value of capture register.

This function returns the captured value upon occurrence of the events selected by the corresponding Capture Control registers occurred.

Parameters:

base – SCTimer peripheral base address
whichCounter – SCTimer counter to use. In 16-bit mode, we can select Counter_L and Counter_H, In 32-bit mode, we can select Counter_U.
capChannel – SCTimer capture register of capture channel.

Returns:

The SCTimer counter value at which this register was last captured.

void SCTIMER_EventHandleIRQ(SCT_Type *base)#

SCTimer interrupt handler.

Parameters:

base – SCTimer peripheral base address.

void SCTIMER_DriverIRQHandler(uint32_t instance)#

Common IRQ handler for SCTimer, which can be used for SCTimer IRQ remapping.

Parameters:

instance – SCTimer instance number.

FSL_SCTIMER_DRIVER_VERSION#: Version

enum _sctimer_pwm_mode#

SCTimer PWM operation modes.

Values:

enumerator kSCTIMER_EdgeAlignedPwm#: Edge-aligned PWM

enumerator kSCTIMER_CenterAlignedPwm#: Center-aligned PWM

enum _sctimer_counter#

SCTimer counters type.

Values:

enumerator kSCTIMER_Counter_L#: 16-bit Low counter.

enumerator kSCTIMER_Counter_H#: 16-bit High counter.

enumerator kSCTIMER_Counter_U#: 32-bit Unified counter.

enum _sctimer_input#

List of SCTimer input pins.

Values:

enumerator kSCTIMER_Input_0#: SCTIMER input 0

enumerator kSCTIMER_Input_1#: SCTIMER input 1

enumerator kSCTIMER_Input_2#: SCTIMER input 2

enumerator kSCTIMER_Input_3#: SCTIMER input 3

enumerator kSCTIMER_Input_4#: SCTIMER input 4

enumerator kSCTIMER_Input_5#: SCTIMER input 5

enumerator kSCTIMER_Input_6#: SCTIMER input 6

enumerator kSCTIMER_Input_7#: SCTIMER input 7

enum _sctimer_out#

List of SCTimer output pins.

Values:

enumerator kSCTIMER_Out_0#: SCTIMER output 0

enumerator kSCTIMER_Out_1#: SCTIMER output 1

enumerator kSCTIMER_Out_2#: SCTIMER output 2

enumerator kSCTIMER_Out_3#: SCTIMER output 3

enumerator kSCTIMER_Out_4#: SCTIMER output 4

enumerator kSCTIMER_Out_5#: SCTIMER output 5

enumerator kSCTIMER_Out_6#: SCTIMER output 6

enumerator kSCTIMER_Out_7#: SCTIMER output 7

enumerator kSCTIMER_Out_8#: SCTIMER output 8

enumerator kSCTIMER_Out_9#: SCTIMER output 9

enum _sctimer_pwm_level_select#

SCTimer PWM output pulse mode: high-true, low-true or no output.

Values:

enumerator kSCTIMER_LowTrue#: Low true pulses

enumerator kSCTIMER_HighTrue#: High true pulses

enum _sctimer_pwm_update_mode#

When an updated PWM duty cycle takes effect.

Values:

enumerator kSCTIMER_UpdateImmediately#: Halt the counter, write the active MATCH register (and its reload), then restart: the new duty cycle takes effect at once. Writing the active MATCH register requires the counter halted.

enumerator kSCTIMER_UpdateOnNextPeriod#: Write only the MATCH reload register while the counter keeps running: the new duty cycle takes effect at the next counter cycle (glitchless, no counter stall). Requires CONFIG[NORELOAD] clear for the affected counter.

enum _sctimer_clock_mode#

SCTimer clock mode options.

Values:

enumerator kSCTIMER_System_ClockMode#: System Clock Mode

enumerator kSCTIMER_Sampled_ClockMode#: Sampled System Clock Mode

enumerator kSCTIMER_Input_ClockMode#: SCT Input Clock Mode

enumerator kSCTIMER_Asynchronous_ClockMode#: Asynchronous Mode

enum _sctimer_clock_select#

SCTimer clock select options.

Values:

enumerator kSCTIMER_Clock_On_Rise_Input_0#: Rising edges on input 0

enumerator kSCTIMER_Clock_On_Fall_Input_0#: Falling edges on input 0

enumerator kSCTIMER_Clock_On_Rise_Input_1#: Rising edges on input 1

enumerator kSCTIMER_Clock_On_Fall_Input_1#: Falling edges on input 1

enumerator kSCTIMER_Clock_On_Rise_Input_2#: Rising edges on input 2

enumerator kSCTIMER_Clock_On_Fall_Input_2#: Falling edges on input 2

enumerator kSCTIMER_Clock_On_Rise_Input_3#: Rising edges on input 3

enumerator kSCTIMER_Clock_On_Fall_Input_3#: Falling edges on input 3

enumerator kSCTIMER_Clock_On_Rise_Input_4#: Rising edges on input 4

enumerator kSCTIMER_Clock_On_Fall_Input_4#: Falling edges on input 4

enumerator kSCTIMER_Clock_On_Rise_Input_5#: Rising edges on input 5

enumerator kSCTIMER_Clock_On_Fall_Input_5#: Falling edges on input 5

enumerator kSCTIMER_Clock_On_Rise_Input_6#: Rising edges on input 6

enumerator kSCTIMER_Clock_On_Fall_Input_6#: Falling edges on input 6

enumerator kSCTIMER_Clock_On_Rise_Input_7#: Rising edges on input 7

enumerator kSCTIMER_Clock_On_Fall_Input_7#: Falling edges on input 7

enum _sctimer_conflict_resolution#

SCTimer output conflict resolution options.

Specifies what action should be taken if multiple events dictate that a given output should be both set and cleared at the same time

Values:

enumerator kSCTIMER_ResolveNone#: No change

enumerator kSCTIMER_ResolveSet#: Set output

enumerator kSCTIMER_ResolveClear#: Clear output

enumerator kSCTIMER_ResolveToggle#: Toggle output

enum _sctimer_event_active_direction#

List of SCTimer event generation active direction when the counters are operating in BIDIR mode.

Values:

enumerator kSCTIMER_ActiveIndependent#: This event is triggered regardless of the count direction.

enumerator kSCTIMER_ActiveInCountUp#: This event is triggered only during up-counting when BIDIR = 1.

enumerator kSCTIMER_ActiveInCountDown#: This event is triggered only during down-counting when BIDIR = 1.

enum _sctimer_event#

List of SCTimer event types.

Values:

enumerator kSCTIMER_InputLowOrMatchEvent#

enumerator kSCTIMER_InputRiseOrMatchEvent#

enumerator kSCTIMER_InputFallOrMatchEvent#

enumerator kSCTIMER_InputHighOrMatchEvent#

enumerator kSCTIMER_MatchEventOnly#

enumerator kSCTIMER_InputLowEvent#

enumerator kSCTIMER_InputRiseEvent#

enumerator kSCTIMER_InputFallEvent#

enumerator kSCTIMER_InputHighEvent#

enumerator kSCTIMER_InputLowAndMatchEvent#

enumerator kSCTIMER_InputRiseAndMatchEvent#

enumerator kSCTIMER_InputFallAndMatchEvent#

enumerator kSCTIMER_InputHighAndMatchEvent#

enumerator kSCTIMER_OutputLowOrMatchEvent#

enumerator kSCTIMER_OutputRiseOrMatchEvent#

enumerator kSCTIMER_OutputFallOrMatchEvent#

enumerator kSCTIMER_OutputHighOrMatchEvent#

enumerator kSCTIMER_OutputLowEvent#

enumerator kSCTIMER_OutputRiseEvent#

enumerator kSCTIMER_OutputFallEvent#

enumerator kSCTIMER_OutputHighEvent#

enumerator kSCTIMER_OutputLowAndMatchEvent#

enumerator kSCTIMER_OutputRiseAndMatchEvent#

enumerator kSCTIMER_OutputFallAndMatchEvent#

enumerator kSCTIMER_OutputHighAndMatchEvent#

enum _sctimer_interrupt_enable#

List of SCTimer interrupts.

Values:

enumerator kSCTIMER_Event0InterruptEnable#: Event 0 interrupt

enumerator kSCTIMER_Event1InterruptEnable#: Event 1 interrupt

enumerator kSCTIMER_Event2InterruptEnable#: Event 2 interrupt

enumerator kSCTIMER_Event3InterruptEnable#: Event 3 interrupt

enumerator kSCTIMER_Event4InterruptEnable#: Event 4 interrupt

enumerator kSCTIMER_Event5InterruptEnable#: Event 5 interrupt

enumerator kSCTIMER_Event6InterruptEnable#: Event 6 interrupt

enumerator kSCTIMER_Event7InterruptEnable#: Event 7 interrupt

enumerator kSCTIMER_Event8InterruptEnable#: Event 8 interrupt

enumerator kSCTIMER_Event9InterruptEnable#: Event 9 interrupt

enumerator kSCTIMER_Event10InterruptEnable#: Event 10 interrupt

enumerator kSCTIMER_Event11InterruptEnable#: Event 11 interrupt

enumerator kSCTIMER_Event12InterruptEnable#: Event 12 interrupt

enum _sctimer_status_flags#

List of SCTimer flags.

Values:

enumerator kSCTIMER_Event0Flag#: Event 0 Flag

enumerator kSCTIMER_Event1Flag#: Event 1 Flag

enumerator kSCTIMER_Event2Flag#: Event 2 Flag

enumerator kSCTIMER_Event3Flag#: Event 3 Flag

enumerator kSCTIMER_Event4Flag#: Event 4 Flag

enumerator kSCTIMER_Event5Flag#: Event 5 Flag

enumerator kSCTIMER_Event6Flag#: Event 6 Flag

enumerator kSCTIMER_Event7Flag#: Event 7 Flag

enumerator kSCTIMER_Event8Flag#: Event 8 Flag

enumerator kSCTIMER_Event9Flag#: Event 9 Flag

enumerator kSCTIMER_Event10Flag#: Event 10 Flag

enumerator kSCTIMER_Event11Flag#: Event 11 Flag

enumerator kSCTIMER_Event12Flag#: Event 12 Flag

enumerator kSCTIMER_BusErrorLFlag#: Bus error due to write when L counter was not halted

enumerator kSCTIMER_BusErrorHFlag#: Bus error due to write when H counter was not halted

typedef enum _sctimer_pwm_mode sctimer_pwm_mode_t#: SCTimer PWM operation modes.

typedef enum _sctimer_counter sctimer_counter_t#: SCTimer counters type.

typedef enum _sctimer_input sctimer_input_t#: List of SCTimer input pins.

typedef enum _sctimer_out sctimer_out_t#: List of SCTimer output pins.

typedef enum _sctimer_pwm_level_select sctimer_pwm_level_select_t#: SCTimer PWM output pulse mode: high-true, low-true or no output.

typedef struct _sctimer_pwm_signal_param sctimer_pwm_signal_param_t#: Options to configure a SCTimer PWM signal.

typedef struct _sctimer_complementary_pwm_handle sctimer_complementary_pwm_handle_t#

Handle for a complementary PWM output pair created by SCTIMER_SetupComplementaryPwm().

The handle stores the event numbers and parameters needed to update the pair’s duty cycle later with SCTIMER_UpdateComplementaryPwmDutycycle(). Dead time is inserted by delaying the relevant turn-on edge (the high side in edge-aligned mode, the low side in center-aligned mode) by deadTimeTicks, which guarantees a non-overlap gap at both switching edges.

typedef enum _sctimer_pwm_update_mode sctimer_pwm_update_mode_t#: When an updated PWM duty cycle takes effect.

typedef enum _sctimer_clock_mode sctimer_clock_mode_t#: SCTimer clock mode options.

typedef enum _sctimer_clock_select sctimer_clock_select_t#: SCTimer clock select options.

typedef enum _sctimer_conflict_resolution sctimer_conflict_resolution_t#

SCTimer output conflict resolution options.

Specifies what action should be taken if multiple events dictate that a given output should be both set and cleared at the same time

typedef enum _sctimer_event_active_direction sctimer_event_active_direction_t#: List of SCTimer event generation active direction when the counters are operating in BIDIR mode.

typedef enum _sctimer_event sctimer_event_t#: List of SCTimer event types.

typedef void (*sctimer_event_callback_t)(void)#: SCTimer callback typedef.

typedef enum _sctimer_interrupt_enable sctimer_interrupt_enable_t#: List of SCTimer interrupts.

typedef enum _sctimer_status_flags sctimer_status_flags_t#: List of SCTimer flags.

typedef struct _sctimer_config sctimer_config_t#

SCTimer configuration structure.

This structure holds the configuration settings for the SCTimer peripheral. To initialize this structure to reasonable defaults, call the SCTMR_GetDefaultConfig() function and pass a pointer to the configuration structure instance.

The configuration structure can be made constant so as to reside in flash.

SCT_EV_STATE_STATEMSKn(x)#

struct _sctimer_pwm_signal_param#

#include <fsl_sctimer.h>

Options to configure a SCTimer PWM signal.

Public Members

sctimer_out_t output#: The output pin to use to generate the PWM signal

sctimer_pwm_level_select_t level#: PWM output active level select.

uint8_t dutyCyclePercent#: PWM pulse width, value should be between 0 to 100 0 = always inactive signal (0% duty cycle) 100 = always active signal (100% duty cycle).

struct _sctimer_complementary_pwm_handle#

#include <fsl_sctimer.h>

Handle for a complementary PWM output pair created by SCTIMER_SetupComplementaryPwm().

Public Members

uint32_t periodEvent#: Shared period/limit event; match = period. Set by frequency, constant across duty updates.

uint32_t highRiseEvent#: Edge-aligned mode: the high-side turn-on event, match = deadTimeTicks (constant across duty updates). Center-aligned mode: there is no separate rise event, so this field is set equal to periodEvent and drives no output - do not treat it as a distinct event in that mode.

uint32_t highFallEvent#: High-side turn-off event; match = pulse (= period * duty / 100). Rewritten on each duty update.

uint32_t lowRiseEvent#: Low-side turn-on event; match = pulse + deadTimeTicks. Rewritten on each duty update.

uint32_t deadTimeTicks#: Dead time in SCT counter clock ticks.

sctimer_out_t outHigh#: High-side output pin.

sctimer_out_t outLow#: Low-side output pin.

struct _sctimer_config#

#include <fsl_sctimer.h>

SCTimer configuration structure.

The configuration structure can be made constant so as to reside in flash.

Public Members

bool enableCounterUnify#: true: SCT operates as a unified 32-bit counter; false: SCT operates as two 16-bit counters. User can use the 16-bit low counter and the 16-bit high counters at the same time; for Hardware limit, user can not use unified 32-bit counter and any 16-bit low/high counter at the same time.

sctimer_clock_mode_t clockMode#: SCT clock mode value

sctimer_clock_select_t clockSelect#: SCT clock select value

bool enableBidirection_l#: true: Up-down count mode for the L or unified counter false: Up count mode only for the L or unified counter

bool enableBidirection_h#: true: Up-down count mode for the H or unified counter false: Up count mode only for the H or unified counter. This field is used only if the enableCounterUnify is set to false

uint8_t prescale_l#: Prescale value to produce the L or unified counter clock

uint8_t prescale_h#: Prescale value to produce the H counter clock. This field is used only if the enableCounterUnify is set to false

uint8_t outInitState#: Defines the initial output value

uint8_t inputsync#: SCT INSYNC value, INSYNC field in the CONFIG register, from bit9 to bit 16. it is used to define synchronization for input N: bit 9 = input 0 bit 10 = input 1 bit 11 = input 2 bit 12 = input 3 All other bits are reserved (bit13 ~bit 16). How User to set the the value for the member inputsync. IE: delay for input0, and input 1, bypasses for input 2 and input 3 MACRO definition in user level. #define INPUTSYNC0 (0U) #define INPUTSYNC1 (1U) #define INPUTSYNC2 (2U) #define INPUTSYNC3 (3U) User Code. sctimerInfo.inputsync = (1 << INPUTSYNC2) | (1 << INPUTSYNC3);

SPI: Serial Peripheral Interface Driver#

SPI Driver#

void SPI_MasterGetDefaultConfig(spi_master_config_t *config)#

Sets the SPI master configuration structure to default values.

The purpose of this API is to get the configuration structure initialized for use in SPI_MasterInit(). User may use the initialized structure unchanged in SPI_MasterInit(), or modify some fields of the structure before calling SPI_MasterInit(). After calling this API, the master is ready to transfer. Example:

spi_master_config_t config;
SPI_MasterGetDefaultConfig(&config);

Parameters:

config – pointer to master config structure

status_t SPI_MasterInit(SPI_Type *base, const spi_master_config_t *config, uint32_t srcClock_Hz)#

Initializes the SPI with master configuration.

The configuration structure can be filled by user from scratch, or be set with default values by SPI_MasterGetDefaultConfig(). After calling this API, the slave is ready to transfer. Example

spi_master_config_t config = {
.baudRate_Bps = 500000,
...
};
SPI_MasterInit(SPI0, &config);

Parameters:

base – SPI base pointer
config – pointer to master configuration structure
srcClock_Hz – Source clock frequency.

void SPI_SlaveGetDefaultConfig(spi_slave_config_t *config)#

Sets the SPI slave configuration structure to default values.

The purpose of this API is to get the configuration structure initialized for use in SPI_SlaveInit(). Modify some fields of the structure before calling SPI_SlaveInit(). Example:

spi_slave_config_t config;
SPI_SlaveGetDefaultConfig(&config);

Parameters:

config – pointer to slave configuration structure

status_t SPI_SlaveInit(SPI_Type *base, const spi_slave_config_t *config)#

Initializes the SPI with slave configuration.

The configuration structure can be filled by user from scratch or be set with default values by SPI_SlaveGetDefaultConfig(). After calling this API, the slave is ready to transfer. Example

spi_slave_config_t config = {
.polarity = kSPI_ClockPolarityActiveHigh;
.phase = kSPI_ClockPhaseFirstEdge;
.direction = kSPI_MsbFirst;
...
};
SPI_SlaveInit(SPI0, &config);

Parameters:

base – SPI base pointer
config – pointer to slave configuration structure

void SPI_Deinit(SPI_Type *base)#

De-initializes the SPI.

Calling this API resets the SPI module, gates the SPI clock. Disable the fifo if enabled. The SPI module can’t work unless calling the SPI_MasterInit/SPI_SlaveInit to initialize module.

Parameters:

base – SPI base pointer

static inline void SPI_Enable(SPI_Type *base, bool enable)#

Enable or disable the SPI Master or Slave.

Parameters:

base – SPI base pointer
enable – or disable ( true = enable, false = disable)

static inline uint32_t SPI_GetStatusFlags(SPI_Type *base)#

Gets the status flag.

Parameters:

base – SPI base pointer

Returns:

SPI Status, use status flag to AND _spi_status_flags could get the related status.

static inline void SPI_ClearStatusFlags(SPI_Type *base, uint32_t mask)#

Clear the status flag.

Parameters:

base – SPI base pointer
mask – SPI Status, use status flag to AND _spi_status_flags could get the related status.

static inline void SPI_EnableInterrupts(SPI_Type *base, uint32_t irqs)#

Enables the interrupt for the SPI.

Parameters:

base – SPI base pointer
irqs – SPI interrupt source. The parameter can be any combination of the following values:
- kSPI_RxReadyInterruptEnable
- kSPI_TxReadyInterruptEnable

static inline void SPI_DisableInterrupts(SPI_Type *base, uint32_t irqs)#

Disables the interrupt for the SPI.

Parameters:

base – SPI base pointer
irqs – SPI interrupt source. The parameter can be any combination of the following values:
- kSPI_RxReadyInterruptEnable
- kSPI_TxReadyInterruptEnable

static inline bool SPI_IsMaster(SPI_Type *base)#

Returns whether the SPI module is in master mode.

Parameters:

base – SPI peripheral address.

Returns:

Returns true if the module is in master mode or false if the module is in slave mode.

status_t SPI_MasterSetBaudRate(SPI_Type *base, uint32_t baudrate_Bps, uint32_t srcClock_Hz)#

Sets the baud rate for SPI transfer. This is only used in master.

Parameters:

base – SPI base pointer
baudrate_Bps – baud rate needed in Hz.
srcClock_Hz – SPI source clock frequency in Hz.

static inline void SPI_WriteData(SPI_Type *base, uint16_t data)#

Writes a data into the SPI data register directly.

Parameters:

base – SPI base pointer
data – needs to be write.

static inline void SPI_WriteConfigFlags(SPI_Type *base, uint32_t configFlags)#

Writes a data into the SPI TXCTL register directly.

Parameters:

base – SPI base pointer
configFlags – control command needs to be written.

void SPI_WriteDataWithConfigFlags(SPI_Type *base, uint16_t data, uint32_t configFlags)#

Writes a data control info and data into the SPI TX register directly.

Parameters:

base – SPI base pointer
data – value needs to be written.
configFlags – control command needs to be written.

static inline uint32_t SPI_ReadData(SPI_Type *base)#

Gets a data from the SPI data register.

Parameters:

base – SPI base pointer

Returns:

Data in the register.

void SPI_SetTransferDelay(SPI_Type *base, const spi_delay_config_t *config)#

Set delay time for transfer. the delay uint is SPI clock time, maximum value is 0xF.

Parameters:

base – SPI base pointer
config – configuration for delay option spi_delay_config_t.

void SPI_SetDummyData(SPI_Type *base, uint16_t dummyData)#

Set up the dummy data. This API can change the default data to be transferred when users set the tx buffer to NULL.

Parameters:

base – SPI peripheral address.
dummyData – Data to be transferred when tx buffer is NULL.

status_t SPI_MasterTransferBlocking(SPI_Type *base, spi_transfer_t *xfer)#

Transfers a block of data using a polling method.

Parameters:

base – SPI base pointer
xfer – pointer to spi_xfer_config_t structure

Return values:

kStatus_Success – Successfully start a transfer.
kStatus_InvalidArgument – Input argument is invalid.
kStatus_SPI_Timeout – The transfer timed out and was aborted.

status_t SPI_MasterTransferCreateHandle(SPI_Type *base, spi_master_handle_t *handle, spi_master_callback_t callback, void *userData)#

Initializes the SPI master handle.

This function initializes the SPI master handle which can be used for other SPI master transactional APIs. Usually, for a specified SPI instance, call this API once to get the initialized handle.

Parameters:

base – SPI peripheral base address.
handle – SPI handle pointer.
callback – Callback function.
userData – User data.

status_t SPI_MasterTransferNonBlocking(SPI_Type *base, spi_master_handle_t *handle, spi_transfer_t *xfer)#

Performs a non-blocking SPI interrupt transfer.

Parameters:

base – SPI peripheral base address.
handle – pointer to spi_master_handle_t structure which stores the transfer state
xfer – pointer to spi_xfer_config_t structure

Return values:

kStatus_Success – Successfully start a transfer.
kStatus_InvalidArgument – Input argument is invalid.
kStatus_SPI_Busy – SPI is not idle, is running another transfer.

status_t SPI_MasterTransferGetCount(SPI_Type *base, spi_master_handle_t *handle, size_t *count)#

Gets the master transfer count.

This function gets the master transfer count.

Parameters:

base – SPI peripheral base address.
handle – Pointer to the spi_master_handle_t structure which stores the transfer state.
count – The number of bytes transferred by using the non-blocking transaction.

Returns:

status of status_t.

void SPI_MasterTransferAbort(SPI_Type *base, spi_master_handle_t *handle)#

SPI master aborts a transfer using an interrupt.

This function aborts a transfer using an interrupt.

Parameters:

base – SPI peripheral base address.
handle – Pointer to the spi_master_handle_t structure which stores the transfer state.

void SPI_MasterTransferHandleIRQ(SPI_Type *base, spi_master_handle_t *handle)#

Interrupts the handler for the SPI.

Parameters:

base – SPI peripheral base address.
handle – pointer to spi_master_handle_t structure which stores the transfer state.

status_t SPI_SlaveTransferCreateHandle(SPI_Type *base, spi_slave_handle_t *handle, spi_slave_callback_t callback, void *userData)#

Initializes the SPI slave handle.

This function initializes the SPI slave handle which can be used for other SPI slave transactional APIs. Usually, for a specified SPI instance, call this API once to get the initialized handle.

Parameters:

base – SPI peripheral base address.
handle – SPI handle pointer.
callback – Callback function.
userData – User data.

status_t SPI_SlaveTransferNonBlocking(SPI_Type *base, spi_slave_handle_t *handle, spi_transfer_t *xfer)#

Performs a non-blocking SPI slave interrupt transfer.

Note

The API returns immediately after the transfer initialization is finished.

Parameters:

base – SPI peripheral base address.
handle – pointer to spi_master_handle_t structure which stores the transfer state
xfer – pointer to spi_xfer_config_t structure

Return values:

kStatus_Success – Successfully start a transfer.
kStatus_InvalidArgument – Input argument is invalid.
kStatus_SPI_Busy – SPI is not idle, is running another transfer.

static inline status_t SPI_SlaveTransferGetCount(SPI_Type *base, spi_slave_handle_t *handle, size_t *count)#

Gets the slave transfer count.

This function gets the slave transfer count.

Parameters:

base – SPI peripheral base address.
handle – Pointer to the spi_master_handle_t structure which stores the transfer state.
count – The number of bytes transferred by using the non-blocking transaction.

Returns:

status of status_t.

static inline void SPI_SlaveTransferAbort(SPI_Type *base, spi_slave_handle_t *handle)#

SPI slave aborts a transfer using an interrupt.

This function aborts a transfer using an interrupt.

Parameters:

base – SPI peripheral base address.
handle – Pointer to the spi_slave_handle_t structure which stores the transfer state.

void SPI_SlaveTransferHandleIRQ(SPI_Type *base, spi_slave_handle_t *handle)#

Interrupts a handler for the SPI slave.

Parameters:

base – SPI peripheral base address.
handle – pointer to spi_slave_handle_t structure which stores the transfer state

void SPI_DriverIRQHandler(uint32_t instance)#

Common IRQ handler entry for SPI, dispatches to the registered ISR.

Parameters:

instance – SPI peripheral instance number.

FSL_SPI_DRIVER_VERSION#: SPI driver version.

enum _spi_xfer_option#

SPI transfer option.

Values:

enumerator kSPI_EndOfFrame#: Add delay at the end of each frame(the last clk edge).

enumerator kSPI_EndOfTransfer#: Re-assert the CS signal after transfer finishes to deselect slave.

enumerator kSPI_ReceiveIgnore#: Ignore the receive data.

enum _spi_shift_direction#

SPI data shifter direction options.

Values:

enumerator kSPI_MsbFirst#: Data transfers start with most significant bit.

enumerator kSPI_LsbFirst#: Data transfers start with least significant bit.

enum _spi_clock_polarity#

SPI clock polarity configuration.

Values:

enumerator kSPI_ClockPolarityActiveHigh#: Active-high SPI clock (idles low).

enumerator kSPI_ClockPolarityActiveLow#: Active-low SPI clock (idles high).

enum _spi_clock_phase#

SPI clock phase configuration.

Values:

enumerator kSPI_ClockPhaseFirstEdge#: First edge on SCK occurs at the middle of the first cycle of a data transfer.

enumerator kSPI_ClockPhaseSecondEdge#: First edge on SCK occurs at the start of the first cycle of a data transfer.

enum _spi_ssel#

Slave select.

Values:

enumerator kSPI_Ssel0Assert#: Slave select 0

enumerator kSPI_SselDeAssertAll#

enum _spi_spol#

ssel polarity

Values:

enumerator kSPI_Spol0ActiveHigh#

enumerator kSPI_Spol1ActiveHigh#

enumerator kSPI_Spol2ActiveHigh#

enumerator kSPI_Spol3ActiveHigh#

enumerator kSPI_SpolActiveAllHigh#

enumerator kSPI_SpolActiveAllLow#

enum _spi_data_width#

Transfer data width.

Values:

enumerator kSPI_Data4Bits#: 4 bits data width

enumerator kSPI_Data5Bits#: 5 bits data width

enumerator kSPI_Data6Bits#: 6 bits data width

enumerator kSPI_Data7Bits#: 7 bits data width

enumerator kSPI_Data8Bits#: 8 bits data width

enumerator kSPI_Data9Bits#: 9 bits data width

enumerator kSPI_Data10Bits#: 10 bits data width

enumerator kSPI_Data11Bits#: 11 bits data width

enumerator kSPI_Data12Bits#: 12 bits data width

enumerator kSPI_Data13Bits#: 13 bits data width

enumerator kSPI_Data14Bits#: 14 bits data width

enumerator kSPI_Data15Bits#: 15 bits data width

enumerator kSPI_Data16Bits#: 16 bits data width

SPI transfer status.

Values:

enumerator kStatus_SPI_Busy#: SPI bus is busy

enumerator kStatus_SPI_Idle#: SPI is idle

enumerator kStatus_SPI_Error#: SPI error

enumerator kStatus_SPI_BaudrateNotSupport#: Baudrate is not support in current clock source

enumerator kStatus_SPI_Timeout#: SPI Timeout polling status flags.

enum _spi_interrupt_enable#

SPI interrupt sources.

Values:

enumerator kSPI_RxReadyInterruptEnable#: Rx ready interrupt

enumerator kSPI_TxReadyInterruptEnable#: Tx ready interrupt

enumerator kSPI_RxOverrunInterruptEnable#: Rx overrun interrupt

enumerator kSPI_TxUnderrunInterruptEnable#: Tx underrun interrupt

enumerator kSPI_SlaveSelectAssertInterruptEnable#: Slave select assert interrupt

enumerator kSPI_SlaveSelectDeassertInterruptEnable#: Slave select deassert interrupt

enumerator kSPI_AllInterruptEnable#

enum _spi_status_flags#

SPI status flags.

Values:

enumerator kSPI_RxReadyFlag#: Receive ready flag.

enumerator kSPI_TxReadyFlag#: Transmit ready flag.

enumerator kSPI_RxOverrunFlag#: Receive overrun flag.

enumerator kSPI_TxUnderrunFlag#: Transmit underrun flag.

enumerator kSPI_SlaveSelectAssertFlag#: Slave select assert flag.

enumerator kSPI_SlaveSelectDeassertFlag#: slave select deassert flag.

enumerator kSPI_StallFlag#: Stall flag.

enumerator kSPI_EndTransferFlag#: End transfer bit.

enumerator kSPI_MasterIdleFlag#: Master in idle status flag.

typedef enum _spi_shift_direction spi_shift_direction_t#: SPI data shifter direction options.

typedef enum _spi_clock_polarity spi_clock_polarity_t#: SPI clock polarity configuration.

typedef enum _spi_clock_phase spi_clock_phase_t#: SPI clock phase configuration.

typedef enum _spi_ssel spi_ssel_t#: Slave select.

typedef enum _spi_spol spi_spol_t#: ssel polarity

typedef enum _spi_data_width spi_data_width_t#: Transfer data width.

typedef struct _spi_delay_config spi_delay_config_t#: SPI delay time configure structure.

typedef struct _spi_master_config spi_master_config_t#: SPI master user configure structure.

typedef struct _spi_slave_config spi_slave_config_t#: SPI slave user configure structure.

typedef struct _spi_transfer spi_transfer_t#: SPI transfer structure.

typedef struct _spi_master_handle spi_master_handle_t#: Master handle type.

typedef spi_master_handle_t spi_slave_handle_t#: Slave handle type.

typedef void (*spi_master_callback_t)(SPI_Type *base, spi_master_handle_t *handle, status_t status, void *userData)#: SPI master callback for finished transmit.

typedef void (*spi_slave_callback_t)(SPI_Type *base, spi_slave_handle_t *handle, status_t status, void *userData)#: SPI slave callback for finished transmit.

volatile uint16_t s_dummyData[]#

uint32_t SPI_GetInstance(SPI_Type *base)#: Returns instance number for SPI peripheral base address.

SPI_DUMMYDATA#: SPI dummy transfer data, the data is sent while txBuff is NULL.

FSL_SDK_ENABLE_SPI_DRIVER_TRANSACTIONAL_APIS#

SPI_RETRY_TIMES#: Retry times for waiting flag.

struct _spi_delay_config#

#include <fsl_spi.h>

SPI delay time configure structure.

Public Members

uint8_t preDelay#: Delay between SSEL assertion and the beginning of transfer.

uint8_t postDelay#: Delay between the end of transfer and SSEL deassertion.

uint8_t frameDelay#: Delay between frame to frame.

uint8_t transferDelay#: Delay between transfer to transfer.

struct _spi_master_config#

#include <fsl_spi.h>

SPI master user configure structure.

Public Members

bool enableLoopback#: Enable loopback for test purpose

bool enableMaster#: Enable SPI at initialization time

uint32_t baudRate_Bps#: Baud Rate for SPI in Hz

spi_clock_polarity_t clockPolarity#: Clock polarity

spi_clock_phase_t clockPhase#: Clock phase

spi_shift_direction_t direction#: MSB or LSB

uint8_t dataWidth#: Width of the data

spi_ssel_t sselNumber#: Slave select number

spi_spol_t sselPolarity#: Configure active CS polarity

spi_delay_config_t delayConfig#: Configure for delay time.

struct _spi_slave_config#

#include <fsl_spi.h>

SPI slave user configure structure.

Public Members

bool enableSlave#: Enable SPI at initialization time

spi_clock_polarity_t clockPolarity#: Clock polarity

spi_clock_phase_t clockPhase#: Clock phase

spi_shift_direction_t direction#: MSB or LSB

uint8_t dataWidth#: Width of the data

spi_spol_t sselPolarity#: Configure active CS polarity

struct _spi_transfer#

#include <fsl_spi.h>

SPI transfer structure.

Public Members

const uint8_t *txData#: Send buffer

uint8_t *rxData#: Receive buffer

size_t dataSize#: Transfer bytes

uint32_t configFlags#: Additional option to control transfer _spi_xfer_option.

struct _spi_master_handle#

#include <fsl_spi.h>

SPI transfer handle structure.

Public Members

const uint8_t *volatile txData#: Transfer buffer

uint8_t *volatile rxData#: Receive buffer

volatile size_t txRemainingBytes#: Number of data to be transmitted [in bytes]

volatile size_t rxRemainingBytes#: Number of data to be received [in bytes]

size_t totalByteCount#: A number of transfer bytes

volatile uint32_t state#: SPI internal state

spi_master_callback_t callback#: SPI callback

void *userData#: Callback parameter

uint8_t dataWidth#: Width of the data [Valid values: 1 to 16]

uint32_t lastCommand#: Last command for transfer.

SWM: Switch Matrix Module#

enum _swm_port_pin_type_t#

SWM port_pin number.

Values:

enumerator kSWM_PortPin_P0_0#: port_pin number P0_0.

enumerator kSWM_PortPin_P0_1#: port_pin number P0_1.

enumerator kSWM_PortPin_P0_2#: port_pin number P0_2.

enumerator kSWM_PortPin_P0_3#: port_pin number P0_3.

enumerator kSWM_PortPin_P0_4#: port_pin number P0_4.

enumerator kSWM_PortPin_P0_5#: port_pin number P0_5.

enumerator kSWM_PortPin_P0_6#: port_pin number P0_6.

enumerator kSWM_PortPin_P0_7#: port_pin number P0_7.

enumerator kSWM_PortPin_P0_8#: port_pin number P0_8.

enumerator kSWM_PortPin_P0_9#: port_pin number P0_9.

enumerator kSWM_PortPin_P0_10#: port_pin number P0_10.

enumerator kSWM_PortPin_P0_11#: port_pin number P0_11.

enumerator kSWM_PortPin_P0_12#: port_pin number P0_12.

enumerator kSWM_PortPin_P0_13#: port_pin number P0_13.

enumerator kSWM_PortPin_P0_14#: port_pin number P0_14.

enumerator kSWM_PortPin_P0_15#: port_pin number P0_15.

enumerator kSWM_PortPin_P0_16#: port_pin number P0_16.

enumerator kSWM_PortPin_P0_17#: port_pin number P0_17.

enumerator kSWM_PortPin_P0_18#: port_pin number P0_18.

enumerator kSWM_PortPin_P0_19#: port_pin number P0_19.

enumerator kSWM_PortPin_P0_20#: port_pin number P0_20.

enumerator kSWM_PortPin_P0_21#: port_pin number P0_21.

enumerator kSWM_PortPin_P0_22#: port_pin number P0_22.

enumerator kSWM_PortPin_P0_23#: port_pin number P0_23.

enumerator kSWM_PortPin_P0_24#: port_pin number P0_24.

enumerator kSWM_PortPin_P0_25#: port_pin number P0_25.

enumerator kSWM_PortPin_P0_26#: port_pin number P0_26.

enumerator kSWM_PortPin_P0_27#: port_pin number P0_27.

enumerator kSWM_PortPin_P0_28#: port_pin number P0_28.

enumerator kSWM_PortPin_Reset#: port_pin reset number.

enum _swm_select_movable_t#

SWM movable selection.

Values:

enumerator kSWM_USART0_TXD#: Movable function as USART0_TXD.

enumerator kSWM_USART0_RXD#: Movable function as USART0_RXD.

enumerator kSWM_USART0_RTS#: Movable function as USART0_RTS.

enumerator kSWM_USART0_CTS#: Movable function as USART0_CTS.

enumerator kSWM_USART0_SCLK#: Movable function as USART0_SCLK.

enumerator kSWM_USART1_TXD#: Movable function as USART1_TXD.

enumerator kSWM_USART1_RXD#: Movable function as USART1_RXD.

enumerator kSWM_USART1_RTS#: Movable function as USART1_RTS.

enumerator kSWM_USART1_CTS#: Movable function as USART1_CTS.

enumerator kSWM_USART1_SCLK#: Movable function as USART1_SCLK.

enumerator kSWM_USART2_TXD#: Movable function as USART2_TXD.

enumerator kSWM_USART2_RXD#: Movable function as USART2_RXD.

enumerator kSWM_USART2_RTS#: Movable function as USART2_RTS.

enumerator kSWM_USART2_CTS#: Movable function as USART2_CTS.

enumerator kSWM_USART2_SCLK#: Movable function as USART2_SCLK.

enumerator kSWM_SPI0_SCK#: Movable function as SPI0_SCK.

enumerator kSWM_SPI0_MOSI#: Movable function as SPI0_MOSI.

enumerator kSWM_SPI0_MISO#: Movable function as SPI0_MISO.

enumerator kSWM_SPI0_SSEL0#: Movable function as SPI0_SSEL0.

enumerator kSWM_SPI0_SSEL1#: Movable function as SPI0_SSEL1.

enumerator kSWM_SPI0_SSEL2#: Movable function as SPI0_SSEL2.

enumerator kSWM_SPI0_SSEL3#: Movable function as SPI0_SSEL3.

enumerator kSWM_SPI1_SCK#: Movable function as SPI1_SCK.

enumerator kSWM_SPI1_MOSI#: Movable function as SPI1_MOSI.

enumerator kSWM_SPI1_MISO#: Movable function as SPI1_MISO.

enumerator kSWM_SPI1_SSEL0#: Movable function as SPI1_SSEL0.

enumerator kSWM_SPI1_SSEL1#: Movable function as SPI1_SSEL1.

enumerator kSWM_SCT_PIN0#: Movable function as SCT_PIN0.

enumerator kSWM_SCT_PIN1#: Movable function as SCT_PIN1.

enumerator kSWM_SCT_PIN2#: Movable function as SCT_PIN2.

enumerator kSWM_SCT_PIN3#: Movable function as SCT_PIN3.

enumerator kSWM_SCT_OUT0#: Movable function as SCT_OUT0.

enumerator kSWM_SCT_OUT1#: Movable function as SCT_OUT1.

enumerator kSWM_SCT_OUT2#: Movable function as SCT_OUT2.

enumerator kSWM_SCT_OUT3#: Movable function as SCT_OUT3.

enumerator kSWM_SCT_OUT4#: Movable function as SCT_OUT4.

enumerator kSWM_SCT_OUT5#: Movable function as SCT_OUT5.

enumerator kSWM_I2C1_SDA#: Movable function as I2C1_SDA.

enumerator kSWM_I2C1_SCL#: Movable function as I2C1_SCL.

enumerator kSWM_I2C2_SDA#: Movable function as I2C2_SDA.

enumerator kSWM_I2C2_SCL#: Movable function as I2C2_SCL.

enumerator kSWM_I2C3_SDA#: Movable function as I2C3_SDA.

enumerator kSWM_I2C3_SCL#: Movable function as I2C3_SCL.

enumerator kSWM_ADC_PINTRIG0#: Movable function as PINTRIG0.

enumerator kSWM_ADC_PINTRIG1#: Movable function as PINTRIG1.

enumerator kSWM_ACMP_OUT#: Movable function as ACMP_OUT.

enumerator kSWM_CLKOUT#: Movable function as CLKOUT.

enumerator kSWM_GPIO_INT_BMAT#: Movable function as GPIO_INT_BMAT.

enumerator kSWM_MOVABLE_NUM_FUNCS#: Movable function number.

enum _swm_select_fixed_pin_t#

SWM fixed pin selection.

Values:

enumerator kSWM_ACMP_INPUT1#: Fixed-pin function as ACMP_INPUT1.

enumerator kSWM_ACMP_INPUT2#: Fixed-pin function as ACMP_INPUT2.

enumerator kSWM_ACMP_INPUT3#: Fixed-pin function as ACMP_INPUT3.

enumerator kSWM_ACMP_INPUT4#: Fixed-pin function as ACMP_INPUT4.

enumerator kSWM_SWCLK#: Fixed-pin function as SWCLK.

enumerator kSWM_SWDIO#: Fixed-pin function as SWDIO.

enumerator kSWM_XTALIN#: Fixed-pin function as XTALIN.

enumerator kSWM_XTALOUT#: Fixed-pin function as XTALOUT.

enumerator kSWM_RESETN#: Fixed-pin function as RESETN.

enumerator kSWM_CLKIN#: Fixed-pin function as CLKIN.

enumerator kSWM_VDDCMP#: Fixed-pin function as VDDCMP.

enumerator kSWM_I2C0_SDA#: Fixed-pin function as I2C0_SDA.

enumerator kSWM_I2C0_SCL#: Fixed-pin function as I2C0_SCL.

enumerator kSWM_ADC_CHN0#: Fixed-pin function as ADC_CHN0.

enumerator kSWM_ADC_CHN1#: Fixed-pin function as ADC_CHN1.

enumerator kSWM_ADC_CHN2#: Fixed-pin function as ADC_CHN2.

enumerator kSWM_ADC_CHN3#: Fixed-pin function as ADC_CHN3.

enumerator kSWM_ADC_CHN4#: Fixed-pin function as ADC_CHN4.

enumerator kSWM_ADC_CHN5#: Fixed-pin function as ADC_CHN5.

enumerator kSWM_ADC_CHN6#: Fixed-pin function as ADC_CHN6.

enumerator kSWM_ADC_CHN7#: Fixed-pin function as ADC_CHN7.

enumerator kSWM_ADC_CHN8#: Fixed-pin function as ADC_CHN8.

enumerator kSWM_ADC_CHN9#: Fixed-pin function as ADC_CHN9.

enumerator kSWM_ADC_CHN10#: Fixed-pin function as ADC_CHN10.

enumerator kSWM_ADC_CHN11#: Fixed-pin function as ADC_CHN11.

enumerator kSWM_FIXEDPIN_NUM_FUNCS#: Fixed-pin function number.

typedef enum _swm_port_pin_type_t swm_port_pin_type_t#: SWM port_pin number.

typedef enum _swm_select_movable_t swm_select_movable_t#: SWM movable selection.

typedef enum _swm_select_fixed_pin_t swm_select_fixed_pin_t#: SWM fixed pin selection.

FSL_SWM_DRIVER_VERSION#: LPC SWM driver version.

void SWM_SetMovablePinSelect(SWM_Type *base, swm_select_movable_t func, swm_port_pin_type_t swm_port_pin)#

Assignment of digital peripheral functions to pins.

This function will selects a pin (designated by its GPIO port and bit numbers) to a function.

Parameters:

base – SWM peripheral base address.
func – any function name that is movable.
swm_port_pin – any pin which has a GPIO port number and bit number.

void SWM_SetFixedPinSelect(SWM_Type *base, swm_select_fixed_pin_t func, bool enable)#

Enable the fixed-pin function.

This function will enables a fixed-pin function in PINENABLE0 or PINENABLE1.

Parameters:

base – SWM peripheral base address.
func – any function name that is fixed pin.
enable – enable or disable.

SYSCON: System Configuration#

enum _syscon_connection_t#

SYSCON connections type.

Values:

enumerator kSYSCON_GpioPort0Pin0ToPintsel#: Pin Interrupt.

enumerator kSYSCON_GpioPort0Pin1ToPintsel#

enumerator kSYSCON_GpioPort0Pin2ToPintsel#

enumerator kSYSCON_GpioPort0Pin3ToPintsel#

enumerator kSYSCON_GpioPort0Pin4ToPintsel#

enumerator kSYSCON_GpioPort0Pin5ToPintsel#

enumerator kSYSCON_GpioPort0Pin6ToPintsel#

enumerator kSYSCON_GpioPort0Pin7ToPintsel#

enumerator kSYSCON_GpioPort0Pin8ToPintsel#

enumerator kSYSCON_GpioPort0Pin9ToPintsel#

enumerator kSYSCON_GpioPort0Pin10ToPintsel#

enumerator kSYSCON_GpioPort0Pin11ToPintsel#

enumerator kSYSCON_GpioPort0Pin12ToPintsel#

enumerator kSYSCON_GpioPort0Pin13ToPintsel#

enumerator kSYSCON_GpioPort0Pin14ToPintsel#

enumerator kSYSCON_GpioPort0Pin15ToPintsel#

enumerator kSYSCON_GpioPort0Pin16ToPintsel#

enumerator kSYSCON_GpioPort0Pin17ToPintsel#

enumerator kSYSCON_GpioPort0Pin18ToPintsel#

enumerator kSYSCON_GpioPort0Pin19ToPintsel#

enumerator kSYSCON_GpioPort0Pin20ToPintsel#

enumerator kSYSCON_GpioPort0Pin21ToPintsel#

enumerator kSYSCON_GpioPort0Pin22ToPintsel#

enumerator kSYSCON_GpioPort0Pin23ToPintsel#

enumerator kSYSCON_GpioPort0Pin24ToPintsel#

enumerator kSYSCON_GpioPort0Pin25ToPintsel#

enumerator kSYSCON_GpioPort0Pin26ToPintsel#

enumerator kSYSCON_GpioPort0Pin27ToPintsel#

enumerator kSYSCON_GpioPort0Pin28ToPintsel#

typedef enum _syscon_connection_t syscon_connection_t#: SYSCON connections type.

PINTSEL_ID#: Periphinmux IDs.

SYSCON_SHIFT#

FSL_SYSON_DRIVER_VERSION#: Group syscon driver version for SDK.

void SYSCON_AttachSignal(SYSCON_Type *base, uint16_t index, syscon_connection_t connection)#

Attaches a signal.

This function gates the SYSCON clock.

Parameters:

base – Base address of the SYSCON peripheral.
index – Destination peripheral to attach the signal to.
connection – Selects connection.

Return values:

None. –

USART: Universal Asynchronous Receiver/Transmitter Driver#

USART Driver#

uint32_t USART_GetInstance(USART_Type *base)#: Returns instance number for USART peripheral base address.

status_t USART_Init(USART_Type *base, const usart_config_t *config, uint32_t srcClock_Hz)#

Initializes a USART instance with user configuration structure and peripheral clock.

This function configures the USART module with the user-defined settings. The user can configure the configuration structure and also get the default configuration by using the USART_GetDefaultConfig() function. Example below shows how to use this API to configure USART.

usart_config_t usartConfig;
usartConfig.baudRate_Bps = 115200U;
usartConfig.parityMode = kUSART_ParityDisabled;
usartConfig.stopBitCount = kUSART_OneStopBit;
USART_Init(USART1, &usartConfig, 20000000U);

Parameters:

base – USART peripheral base address.
config – Pointer to user-defined configuration structure.
srcClock_Hz – USART clock source frequency in HZ.

Return values:

kStatus_USART_BaudrateNotSupport – Baudrate is not support in current clock source.
kStatus_InvalidArgument – USART base address is not valid
kStatus_Success – Status USART initialize succeed

void USART_Deinit(USART_Type *base)#

Deinitializes a USART instance.

This function waits for TX complete, disables the USART clock.

Parameters:

base – USART peripheral base address.

void USART_GetDefaultConfig(usart_config_t *config)#

Gets the default configuration structure.

This function initializes the USART configuration structure to a default value. The default values are: usartConfig->baudRate_Bps = 9600U; usartConfig->parityMode = kUSART_ParityDisabled; usartConfig->stopBitCount = kUSART_OneStopBit; usartConfig->bitCountPerChar = kUSART_8BitsPerChar; usartConfig->loopback = false; usartConfig->enableTx = false; usartConfig->enableRx = false; …

Parameters:

config – Pointer to configuration structure.

status_t USART_SetBaudRate(USART_Type *base, uint32_t baudrate_Bps, uint32_t srcClock_Hz)#

Sets the USART instance baud rate.

This function configures the USART module baud rate. This function is used to update the USART module baud rate after the USART module is initialized by the USART_Init.

USART_SetBaudRate(USART1, 115200U, 20000000U);

Parameters:

base – USART peripheral base address.
baudrate_Bps – USART baudrate to be set.
srcClock_Hz – USART clock source frequency in HZ.

Return values:

kStatus_USART_BaudrateNotSupport – Baudrate is not support in current clock source.
kStatus_Success – Set baudrate succeed.
kStatus_InvalidArgument – One or more arguments are invalid.

static inline uint32_t USART_GetStatusFlags(USART_Type *base)#

Get USART status flags.

This function get all USART status flags, the flags are returned as the logical OR value of the enumerators _usart_flags. To check a specific status, compare the return value with enumerators in _usart_flags. For example, to check whether the RX is ready:

if (kUSART_RxReady & USART_GetStatusFlags(USART1))
{
    ...
}

Parameters:

base – USART peripheral base address.

Returns:

USART status flags which are ORed by the enumerators in the _usart_flags.

static inline void USART_ClearStatusFlags(USART_Type *base, uint32_t mask)#

Clear USART status flags.

This function clear supported USART status flags For example:

USART_ClearStatusFlags(USART1, kUSART_HardwareOverrunFlag)

Parameters:

base – USART peripheral base address.
mask – status flags to be cleared.

static inline void USART_EnableInterrupts(USART_Type *base, uint32_t mask)#

Enables USART interrupts according to the provided mask.

This function enables the USART interrupts according to the provided mask. The mask is a logical OR of enumeration members. See _usart_interrupt_enable. For example, to enable TX ready interrupt and RX ready interrupt:

USART_EnableInterrupts(USART1, kUSART_RxReadyInterruptEnable | kUSART_TxReadyInterruptEnable);

Parameters:

base – USART peripheral base address.
mask – The interrupts to enable. Logical OR of _usart_interrupt_enable.

static inline void USART_DisableInterrupts(USART_Type *base, uint32_t mask)#

Disables USART interrupts according to a provided mask.

This function disables the USART interrupts according to a provided mask. The mask is a logical OR of enumeration members. See _usart_interrupt_enable. This example shows how to disable the TX ready interrupt and RX ready interrupt:

USART_DisableInterrupts(USART1, kUSART_TxReadyInterruptEnable | kUSART_RxReadyInterruptEnable);

Parameters:

base – USART peripheral base address.
mask – The interrupts to disable. Logical OR of _usart_interrupt_enable.

static inline uint32_t USART_GetEnabledInterrupts(USART_Type *base)#

Returns enabled USART interrupts.

This function returns the enabled USART interrupts.

Parameters:

base – USART peripheral base address.

static inline void USART_EnableContinuousSCLK(USART_Type *base, bool enable)#

Continuous Clock generation. By default, SCLK is only output while data is being transmitted in synchronous mode. Enable this funciton, SCLK will run continuously in synchronous mode, allowing characters to be received on Un_RxD independently from transmission on Un_TXD).

Parameters:

base – USART peripheral base address.
enable – Enable Continuous Clock generation mode or not, true for enable and false for disable.

static inline void USART_EnableAutoClearSCLK(USART_Type *base, bool enable)#

Enable Continuous Clock generation bit auto clear. While enable this cuntion, the Continuous Clock bit is automatically cleared when a complete character has been received. This bit is cleared at the same time.

Parameters:

base – USART peripheral base address.
enable – Enable auto clear or not, true for enable and false for disable.

static inline void USART_EnableCTS(USART_Type *base, bool enable)#

Enable CTS. This function will determine whether CTS is used for flow control.

Parameters:

base – USART peripheral base address.
enable – Enable CTS or not, true for enable and false for disable.

static inline void USART_EnableTx(USART_Type *base, bool enable)#

Enable the USART transmit.

This function will enable or disable the USART transmit.

Parameters:

base – USART peripheral base address.
enable – true for enable and false for disable.

static inline void USART_EnableRx(USART_Type *base, bool enable)#

Enable the USART receive.

This function will enable or disable the USART receive. Note: if the transmit is enabled, the receive will not be disabled.

Parameters:

base – USART peripheral base address.
enable – true for enable and false for disable.

static inline void USART_WriteByte(USART_Type *base, uint8_t data)#

Writes to the TXDAT register.

This function will writes data to the TXDAT automatly.The upper layer must ensure that TXDATA has space for data to write before calling this function.

Parameters:

base – USART peripheral base address.
data – The byte to write.

static inline uint8_t USART_ReadByte(USART_Type *base)#

Reads the RXDAT directly.

This function reads data from the RXDAT automatly. The upper layer must ensure that the RXDAT is not empty before calling this function.

Parameters:

base – USART peripheral base address.

Returns:

The byte read from USART data register.

status_t USART_WriteBlocking(USART_Type *base, const uint8_t *data, size_t length)#

Writes to the TX register using a blocking method.

This function polls the TX register, waits for the TX register to be empty.

Parameters:

base – USART peripheral base address.
data – Start address of the data to write.
length – Size of the data to write.

Return values:

kStatus_USART_Timeout – Transmission timed out and was aborted.
kStatus_Success – Successfully wrote all data.

status_t USART_ReadBlocking(USART_Type *base, uint8_t *data, size_t length)#

Read RX data register using a blocking method.

This function polls the RX register, waits for the RX register to be full.

Parameters:

base – USART peripheral base address.
data – Start address of the buffer to store the received data.
length – Size of the buffer.

Return values:

kStatus_USART_FramingError – Receiver overrun happened while receiving data.
kStatus_USART_ParityError – Noise error happened while receiving data.
kStatus_USART_NoiseError – Framing error happened while receiving data.
kStatus_USART_RxError – Overflow or underflow happened.
kStatus_USART_Timeout – Transmission timed out and was aborted.
kStatus_Success – Successfully received all data.

status_t USART_TransferCreateHandle(USART_Type *base, usart_handle_t *handle, usart_transfer_callback_t callback, void *userData)#

Initializes the USART handle.

This function initializes the USART handle which can be used for other USART transactional APIs. Usually, for a specified USART instance, call this API once to get the initialized handle.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
callback – The callback function.
userData – The parameter of the callback function.

status_t USART_TransferSendNonBlocking(USART_Type *base, usart_handle_t *handle, usart_transfer_t *xfer)#

Transmits a buffer of data using the interrupt method.

This function sends data using an interrupt method. This is a non-blocking function, which returns directly without waiting for all data to be written to the TX register. When all data is written to the TX register in the IRQ handler, the USART driver calls the callback function and passes the kStatus_USART_TxIdle as status parameter.

Note

The kStatus_USART_TxIdle is passed to the upper layer when all data is written to the TX register. However it does not ensure that all data are sent out. Before disabling the TX, check the kUSART_TransmissionCompleteFlag to ensure that the TX is finished.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
xfer – USART transfer structure. See usart_transfer_t.

Return values:

kStatus_Success – Successfully start the data transmission.
kStatus_USART_TxBusy – Previous transmission still not finished, data not all written to TX register yet.
kStatus_InvalidArgument – Invalid argument.

void USART_TransferStartRingBuffer(USART_Type *base, usart_handle_t *handle, uint8_t *ringBuffer, size_t ringBufferSize)#

Sets up the RX ring buffer.

This function sets up the RX ring buffer to a specific USART handle.

When the RX ring buffer is used, data received are stored into the ring buffer even when the user doesn’t call the USART_TransferReceiveNonBlocking() API. If there is already data received in the ring buffer, the user can get the received data from the ring buffer directly.

Note

When using the RX ring buffer, one byte is reserved for internal use. In other words, if ringBufferSize is 32, then only 31 bytes are used for saving data.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
ringBuffer – Start address of the ring buffer for background receiving. Pass NULL to disable the ring buffer.
ringBufferSize – size of the ring buffer.

void USART_TransferStopRingBuffer(USART_Type *base, usart_handle_t *handle)#

Aborts the background transfer and uninstalls the ring buffer.

This function aborts the background transfer and uninstalls the ring buffer.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.

size_t USART_TransferGetRxRingBufferLength(usart_handle_t *handle)#

Get the length of received data in RX ring buffer.

Parameters:

handle – USART handle pointer.

Returns:

Length of received data in RX ring buffer.

void USART_TransferAbortSend(USART_Type *base, usart_handle_t *handle)#

Aborts the interrupt-driven data transmit.

This function aborts the interrupt driven data sending. The user can get the remainBtyes to find out how many bytes are still not sent out.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.

status_t USART_TransferGetSendCount(USART_Type *base, usart_handle_t *handle, uint32_t *count)#

Get the number of bytes that have been written to USART TX register.

This function gets the number of bytes that have been written to USART TX register by interrupt method.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
count – Send bytes count.

Return values:

kStatus_NoTransferInProgress – No send in progress.
kStatus_InvalidArgument – Parameter is invalid.
kStatus_Success – Get successfully through the parameter count;

status_t USART_TransferReceiveNonBlocking(USART_Type *base, usart_handle_t *handle, usart_transfer_t *xfer, size_t *receivedBytes)#

Receives a buffer of data using an interrupt method.

This function receives data using an interrupt method. This is a non-blocking function, which returns without waiting for all data to be received. If the RX ring buffer is used and not empty, the data in the ring buffer is copied and the parameter receivedBytes shows how many bytes are copied from the ring buffer. After copying, if the data in the ring buffer is not enough to read, the receive request is saved by the USART driver. When the new data arrives, the receive request is serviced first. When all data is received, the USART driver notifies the upper layer through a callback function and passes the status parameter kStatus_USART_RxIdle. For example, the upper layer needs 10 bytes but there are only 5 bytes in the ring buffer. The 5 bytes are copied to the xfer->data and this function returns with the parameter receivedBytes set to 5. For the left 5 bytes, newly arrived data is saved from the xfer->data[5]. When 5 bytes are received, the USART driver notifies the upper layer. If the RX ring buffer is not enabled, this function enables the RX and RX interrupt to receive data to the xfer->data. When all data is received, the upper layer is notified.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
xfer – USART transfer structure, see usart_transfer_t.
receivedBytes – Bytes received from the ring buffer directly.

Return values:

kStatus_Success – Successfully queue the transfer into transmit queue.
kStatus_USART_RxBusy – Previous receive request is not finished.
kStatus_InvalidArgument – Invalid argument.

void USART_TransferAbortReceive(USART_Type *base, usart_handle_t *handle)#

Aborts the interrupt-driven data receiving.

This function aborts the interrupt-driven data receiving. The user can get the remainBytes to find out how many bytes not received yet.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.

status_t USART_TransferGetReceiveCount(USART_Type *base, usart_handle_t *handle, uint32_t *count)#

Get the number of bytes that have been received.

This function gets the number of bytes that have been received.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.
count – Receive bytes count.

Return values:

kStatus_NoTransferInProgress – No receive in progress.
kStatus_InvalidArgument – Parameter is invalid.
kStatus_Success – Get successfully through the parameter count;

void USART_TransferHandleIRQ(USART_Type *base, usart_handle_t *handle)#

USART IRQ handle function.

This function handles the USART transmit and receive IRQ request.

Parameters:

base – USART peripheral base address.
handle – USART handle pointer.

void USART_DriverIRQHandler(uint32_t instance)#

Common IRQ handler entry for USART, dispatches to the registered ISR.

Parameters:

instance – USART peripheral instance number.

FSL_USART_DRIVER_VERSION#: USART driver version.

Error codes for the USART driver.

Values:

enumerator kStatus_USART_TxBusy#: Transmitter is busy.

enumerator kStatus_USART_RxBusy#: Receiver is busy.

enumerator kStatus_USART_TxIdle#: USART transmitter is idle.

enumerator kStatus_USART_RxIdle#: USART receiver is idle.

enumerator kStatus_USART_TxError#: Error happens on tx.

enumerator kStatus_USART_RxError#: Error happens on rx.

enumerator kStatus_USART_RxRingBufferOverrun#: Error happens on rx ring buffer

enumerator kStatus_USART_NoiseError#: USART noise error.

enumerator kStatus_USART_FramingError#: USART framing error.

enumerator kStatus_USART_ParityError#: USART parity error.

enumerator kStatus_USART_HardwareOverrun#: USART hardware over flow.

enumerator kStatus_USART_BaudrateNotSupport#: Baudrate is not support in current clock source

enumerator kStatus_USART_Timeout#: USART times out.

enum _usart_parity_mode#

USART parity mode.

Values:

enumerator kUSART_ParityDisabled#: Parity disabled

enumerator kUSART_ParityEven#: Parity enabled, type even, bit setting: PARITYSEL = 10

enumerator kUSART_ParityOdd#: Parity enabled, type odd, bit setting: PARITYSEL = 11

enum _usart_sync_mode#

USART synchronous mode.

Values:

enumerator kUSART_SyncModeDisabled#: Asynchronous mode.

enumerator kUSART_SyncModeSlave#: Synchronous slave mode.

enumerator kUSART_SyncModeMaster#: Synchronous master mode.

enum _usart_stop_bit_count#

USART stop bit count.

Values:

enumerator kUSART_OneStopBit#: One stop bit

enumerator kUSART_TwoStopBit#: Two stop bits

enum _usart_data_len#

USART data size.

Values:

enumerator kUSART_7BitsPerChar#: Seven bit mode

enumerator kUSART_8BitsPerChar#: Eight bit mode

enum _usart_clock_polarity#

USART clock polarity configuration, used in sync mode.

Values:

enumerator kUSART_RxSampleOnFallingEdge#: Un_RXD is sampled on the falling edge of SCLK.

enumerator kUSART_RxSampleOnRisingEdge#: Un_RXD is sampled on the rising edge of SCLK.

enum _usart_interrupt_enable#

USART interrupt configuration structure, default settings all disabled.

Values:

enumerator kUSART_RxReadyInterruptEnable#: Receive ready interrupt.

enumerator kUSART_TxReadyInterruptEnable#: Transmit ready interrupt.

enumerator kUSART_TxIdleInterruptEnable#: Transmit idle interrupt.

enumerator kUSART_DeltaCtsInterruptEnable#: Cts pin change interrupt.

enumerator kUSART_TxDisableInterruptEnable#: Transmit disable interrupt.

enumerator kUSART_HardwareOverRunInterruptEnable#: hardware ove run interrupt.

enumerator kUSART_RxBreakInterruptEnable#: Receive break interrupt.

enumerator kUSART_RxStartInterruptEnable#: Receive ready interrupt.

enumerator kUSART_FramErrorInterruptEnable#: Receive start interrupt.

enumerator kUSART_ParityErrorInterruptEnable#: Receive frame error interrupt.

enumerator kUSART_RxNoiseInterruptEnable#: Receive noise error interrupt.

enumerator kUSART_AutoBaudErrorInterruptEnable#: Receive auto baud error interrupt.

enumerator kUSART_AllInterruptEnable#: All interrupt.

enum _usart_flags#

USART status flags.

This provides constants for the USART status flags for use in the USART functions.

Values:

enumerator kUSART_RxReady#: Receive ready flag.

enumerator kUSART_RxIdleFlag#: Receive IDLE flag.

enumerator kUSART_TxReady#: Transmit ready flag.

enumerator kUSART_TxIdleFlag#: Transmit idle flag.

enumerator kUSART_CtsState#: Cts pin status.

enumerator kUSART_DeltaCtsFlag#: Cts pin change flag.

enumerator kUSART_TxDisableFlag#: Transmit disable flag.

enumerator kUSART_HardwareOverrunFlag#: Hardware over run flag.

enumerator kUSART_RxBreakFlag#: Receive break flag.

enumerator kUSART_RxStartFlag#: receive start flag.

enumerator kUSART_FramErrorFlag#: Frame error flag.

enumerator kUSART_ParityErrorFlag#: Parity error flag.

enumerator kUSART_RxNoiseFlag#: Receive noise flag.

enumerator kUSART_AutoBaudErrorFlag#: Auto baud error flag.

typedef enum _usart_parity_mode usart_parity_mode_t#: USART parity mode.

typedef enum _usart_sync_mode usart_sync_mode_t#: USART synchronous mode.

typedef enum _usart_stop_bit_count usart_stop_bit_count_t#: USART stop bit count.

typedef enum _usart_data_len usart_data_len_t#: USART data size.

typedef enum _usart_clock_polarity usart_clock_polarity_t#: USART clock polarity configuration, used in sync mode.

typedef struct _usart_config usart_config_t#: USART configuration structure.

typedef struct _usart_transfer usart_transfer_t#: USART transfer structure.

typedef struct _usart_handle usart_handle_t#

typedef void (*usart_transfer_callback_t)(USART_Type *base, usart_handle_t *handle, status_t status, void *userData)#: USART transfer callback function.

FSL_SDK_ENABLE_USART_DRIVER_TRANSACTIONAL_APIS#: Macro gate for enable transaction API. 1 for enable, 0 for disable.

FSL_SDK_USART_DRIVER_ENABLE_BAUDRATE_AUTO_GENERATE#: USART baud rate auto generate switch gate. 1 for enable, 0 for disable.

UART_RETRY_TIMES#

Retry times for waiting flag.

Defining to zero means to keep waiting for the flag until it is assert/deassert.

struct _usart_config#

#include <fsl_usart.h>

USART configuration structure.

Public Members

uint32_t baudRate_Bps#: USART baud rate

bool enableRx#: USART receive enable.

bool enableTx#: USART transmit enable.

bool loopback#: Enable peripheral loopback

bool enableContinuousSCLK#: USART continuous Clock generation enable in synchronous master mode.

bool enableHardwareFlowControl#: Enable hardware control RTS/CTS

usart_parity_mode_t parityMode#: Parity mode, disabled (default), even, odd

usart_stop_bit_count_t stopBitCount#: Number of stop bits, 1 stop bit (default) or 2 stop bits

usart_data_len_t bitCountPerChar#: Data length - 7 bit, 8 bit

usart_sync_mode_t syncMode#: Transfer mode - asynchronous, synchronous master, synchronous slave.

usart_clock_polarity_t clockPolarity#: Selects the clock polarity and sampling edge in sync mode.

struct _usart_transfer#

#include <fsl_usart.h>

USART transfer structure.

Public Members

size_t dataSize#: The byte count to be transfer.

struct _usart_handle#

#include <fsl_usart.h>

USART handle structure.

Public Members

const uint8_t *volatile txData#: Address of remaining data to send.

volatile size_t txDataSize#: Size of the remaining data to send.

size_t txDataSizeAll#: Size of the data to send out.

uint8_t *volatile rxData#: Address of remaining data to receive.

volatile size_t rxDataSize#: Size of the remaining data to receive.

size_t rxDataSizeAll#: Size of the data to receive.

uint8_t *rxRingBuffer#: Start address of the receiver ring buffer.

size_t rxRingBufferSize#: Size of the ring buffer.

volatile uint16_t rxRingBufferHead#: Index for the driver to store received data into ring buffer.

volatile uint16_t rxRingBufferTail#: Index for the user to get data from the ring buffer.

usart_transfer_callback_t callback#: Callback function.

void *userData#: USART callback function parameter.

volatile uint8_t txState#: TX transfer state.

volatile uint8_t rxState#: RX transfer state

union __unnamed10__#

Public Members

uint8_t *data#: The buffer of data to be transfer.

uint8_t *rxData#: The buffer to receive data.

const uint8_t *txData#: The buffer of data to be sent.

WKT: Self-wake-up Timer#

void WKT_Init(WKT_Type *base, const wkt_config_t *config)#

Ungates the WKT clock and configures the peripheral for basic operation.

Note

This API should be called at the beginning of the application using the WKT driver.

Parameters:

base – WKT peripheral base address
config – Pointer to user’s WKT config structure.

void WKT_Deinit(WKT_Type *base)#

Gate the WKT clock.

Parameters:

base – WKT peripheral base address

static inline void WKT_GetDefaultConfig(wkt_config_t *config)#

Initializes the WKT configuration structure.

This function initializes the WKT configuration structure to default values. The default values are as follows.

config->clockSource = kWKT_DividedFROClockSource;

See also

wkt_config_t

Parameters:

config – Pointer to the WKT configuration structure.

static inline uint32_t WKT_GetCounterValue(WKT_Type *base)#

Read actual WKT counter value.

Parameters:

base – WKT peripheral base address

static inline uint32_t WKT_GetStatusFlags(WKT_Type *base)#

Gets the WKT status flags.

Parameters:

base – WKT peripheral base address

Returns:

The status flags. This is the logical OR of members of the enumeration wkt_status_flags_t

static inline void WKT_ClearStatusFlags(WKT_Type *base, uint32_t mask)#

Clears the WKT status flags.

Parameters:

base – WKT peripheral base address
mask – The status flags to clear. This is a logical OR of members of the enumeration wkt_status_flags_t

static inline void WKT_StartTimer(WKT_Type *base, uint32_t count)#

Starts the timer counting.

After calling this function, timer loads a count value, counts down to 0, then stops.

Note

User can call the utility macros provided in fsl_common.h to convert to ticks Do not write to Counter register while the counting is in progress

Parameters:

base – WKT peripheral base address.
count – The value to be loaded into the WKT Count register

static inline void WKT_StopTimer(WKT_Type *base)#

Stops the timer counting.

This function Clears the counter and stops the timer from counting.

Parameters:

base – WKT peripheral base address

FSL_WKT_DRIVER_VERSION#: Version 2.0.2

enum _wkt_clock_source#

Describes WKT clock source.

Values:

enumerator kWKT_DividedFROClockSource#: WKT clock sourced from the divided FRO clock

enumerator kWKT_LowPowerClockSource#: WKT clock sourced from the Low power clock Use this clock, LPOSCEN bit of DPDCTRL register must be enabled

enumerator kWKT_ExternalClockSource#: WKT clock sourced from the Low power clock Use this clock, WAKECLKPAD_DISABLE bit of DPDCTRL register must be enabled

enum _wkt_status_flags#

List of WKT flags.

Values:

enumerator kWKT_AlarmFlag#: Alarm flag

typedef enum _wkt_clock_source wkt_clock_source_t#: Describes WKT clock source.

typedef struct _wkt_config wkt_config_t#: Describes WKT configuration structure.

typedef enum _wkt_status_flags wkt_status_flags_t#: List of WKT flags.

struct _wkt_config#

#include <fsl_wkt.h>

Describes WKT configuration structure.

Public Members

wkt_clock_source_t clockSource#: External or internal clock source select

WWDT: Windowed Watchdog Timer Driver#

void WWDT_GetDefaultConfig(wwdt_config_t *config)#

Initializes WWDT configure structure.

This function initializes the WWDT configure structure to default value. The default value are:

config->enableWwdt = true;
config->enableWatchdogReset = false;
config->enableWatchdogProtect = false;
config->enableLockOscillator = false;
config->windowValue = 0xFFFFFFU;
config->timeoutValue = 0xFFFFFFU;
config->warningValue = 0;

See also

wwdt_config_t

Parameters:

config – Pointer to WWDT config structure.

void WWDT_Init(WWDT_Type *base, const wwdt_config_t *config)#

Initializes the WWDT.

This function initializes the WWDT. When called, the WWDT runs according to the configuration.

Example:

wwdt_config_t config;
WWDT_GetDefaultConfig(&config);
config.timeoutValue = 0x7ffU;
WWDT_Init(wwdt_base,&config);

Parameters:

base – WWDT peripheral base address
config – The configuration of WWDT

void WWDT_Deinit(WWDT_Type *base)#

Shuts down the WWDT.

This function shuts down the WWDT.

Parameters:

base – WWDT peripheral base address

static inline void WWDT_Enable(WWDT_Type *base)#

Enables the WWDT module.

This function write value into WWDT_MOD register to enable the WWDT, it is a write-once bit; once this bit is set to one and a watchdog feed is performed, the watchdog timer will run permanently.

Parameters:

base – WWDT peripheral base address

static inline void WWDT_Disable(WWDT_Type *base)#

Disables the WWDT module.

Deprecated:: Do not use this function. It will be deleted in next release version, for once the bit field of WDEN written with a 1, it can not be re-written with a 0.

This function write value into WWDT_MOD register to disable the WWDT.

Parameters:

base – WWDT peripheral base address

static inline uint32_t WWDT_GetStatusFlags(WWDT_Type *base)#

Gets all WWDT status flags.

This function gets all status flags.

Example for getting Timeout Flag:

uint32_t status;
status = WWDT_GetStatusFlags(wwdt_base) & kWWDT_TimeoutFlag;

Parameters:

base – WWDT peripheral base address

Returns:

The status flags. This is the logical OR of members of the enumeration _wwdt_status_flags_t

void WWDT_ClearStatusFlags(WWDT_Type *base, uint32_t mask)#

Clear WWDT flag.

This function clears WWDT status flag.

Example for clearing warning flag:

WWDT_ClearStatusFlags(wwdt_base, kWWDT_WarningFlag);

Parameters:

base – WWDT peripheral base address
mask – The status flags to clear. This is a logical OR of members of the enumeration _wwdt_status_flags_t

static inline void WWDT_SetWarningValue(WWDT_Type *base, uint32_t warningValue)#

Set the WWDT warning value.

The WDWARNINT register determines the watchdog timer counter value that will generate a watchdog interrupt. When the watchdog timer counter is no longer greater than the value defined by WARNINT, an interrupt will be generated after the subsequent WDCLK.

Parameters:

base – WWDT peripheral base address
warningValue – WWDT warning value.

static inline void WWDT_SetTimeoutValue(WWDT_Type *base, uint32_t timeoutCount)#

Set the WWDT timeout value.

This function sets the timeout value. Every time a feed sequence occurs the value in the TC register is loaded into the Watchdog timer. Writing a value below 0xFF will cause 0xFF to be loaded into the TC register. Thus the minimum time-out interval is TWDCLK*256*4. If enableWatchdogProtect flag is true in wwdt_config_t config structure, any attempt to change the timeout value before the watchdog counter is below the warning and window values will cause a watchdog reset and set the WDTOF flag.

Parameters:

base – WWDT peripheral base address
timeoutCount – WWDT timeout value, count of WWDT clock tick.

static inline void WWDT_SetWindowValue(WWDT_Type *base, uint32_t windowValue)#

Sets the WWDT window value.

The WINDOW register determines the highest TV value allowed when a watchdog feed is performed. If a feed sequence occurs when timer value is greater than the value in WINDOW, a watchdog event will occur. To disable windowing, set windowValue to 0xFFFFFF (maximum possible timer value) so windowing is not in effect.

Parameters:

base – WWDT peripheral base address
windowValue – WWDT window value.

void WWDT_Refresh(WWDT_Type *base)#

Refreshes the WWDT timer.

This function feeds the WWDT. This function should be called before WWDT timer is in timeout. Otherwise, a reset is asserted.

Parameters:

base – WWDT peripheral base address

FSL_WWDT_DRIVER_VERSION#: Defines WWDT driver version.

WWDT_FIRST_WORD_OF_REFRESH#: First word of refresh sequence

WWDT_SECOND_WORD_OF_REFRESH#: Second word of refresh sequence

enum _wwdt_status_flags_t#

WWDT status flags.

This structure contains the WWDT status flags for use in the WWDT functions.

Values:

enumerator kWWDT_TimeoutFlag#: Time-out flag, set when the timer times out

enumerator kWWDT_WarningFlag#: Warning interrupt flag, set when timer is below the value WDWARNINT

typedef struct _wwdt_config wwdt_config_t#: Describes WWDT configuration structure.

struct _wwdt_config#

#include <fsl_wwdt.h>

Describes WWDT configuration structure.

Public Members

bool enableWwdt#: Enables or disables WWDT

bool enableWatchdogReset#: true: Watchdog timeout will cause a chip reset false: Watchdog timeout will not cause a chip reset

bool enableWatchdogProtect#: true: Enable watchdog protect i.e timeout value can only be changed after counter is below warning & window values false: Disable watchdog protect; timeout value can be changed at any time

uint32_t windowValue#: Window value, set this to 0xFFFFFF if windowing is not in effect

uint32_t timeoutValue#: Timeout value

uint32_t warningValue#: Watchdog time counter value that will generate a warning interrupt. Set this to 0 for no warning

uint32_t clockFreq_Hz#: Watchdog clock source frequency.

LPC824

Contents

LPC824#

Clock Driver#

CRC: Cyclic Redundancy Check Driver#

DMA: Direct Memory Access Controller Driver#

I2C: Inter-Integrated Circuit Driver#

I2C Driver#

I2C Master Driver#

I2C Slave Driver#

IAP: In Application Programming Driver#

INPUTMUX: Input Multiplexing Driver#

Common Driver#

LPC_ACOMP: Analog comparator Driver#

ADC: 12-bit SAR Analog-to-Digital Converter Driver#

GPIO: General Purpose I/O#

IOCON: I/O pin configuration#

MRT: Multi-Rate Timer#

PINT: Pin Interrupt and Pattern Match Driver#

Power Driver#

Reset Driver#

SCTimer: SCTimer/PWM (SCT)#

SPI: Serial Peripheral Interface Driver#

SPI Driver#

SWM: Switch Matrix Module#

SYSCON: System Configuration#

USART: Universal Asynchronous Receiver/Transmitter Driver#

USART Driver#

WKT: Self-wake-up Timer#

WWDT: Windowed Watchdog Timer Driver#