LPC55S06

ANACTRL: Analog Control Driver

void ANACTRL_Init(ANACTRL_Type *base)

Initializes the ANACTRL mode, the module’s clock will be enabled by invoking this function.

Parameters:

base – ANACTRL peripheral base address.

void ANACTRL_Deinit(ANACTRL_Type *base)

De-initializes ANACTRL module, the module’s clock will be disabled by invoking this function.

Parameters:

base – ANACTRL peripheral base address.

void ANACTRL_SetFro192M(ANACTRL_Type *base, const anactrl_fro192M_config_t *config)

Configs the on-chip high-speed Free Running Oscillator(FRO192M), such as enabling/disabling 12 MHZ clock output and enable/disable 96MHZ clock output.

Parameters:

base – ANACTRL peripheral base address.
config – Pointer to FRO192M configuration structure. Refer to anactrl_fro192M_config_t structure.

void ANACTRL_GetDefaultFro192MConfig(anactrl_fro192M_config_t *config)

Gets the default configuration of FRO192M. The default values are:

config->enable12MHzClk = true;
config->enable96MHzClk = false;

Parameters:

config – Pointer to FRO192M configuration structure. Refer to anactrl_fro192M_config_t structure.

void ANACTRL_SetXo32M(ANACTRL_Type *base, const anactrl_xo32M_config_t *config)

Configs the 32 MHz Crystal oscillator(High-speed crystal oscillator), such as enable/disable output to CPU system, and so on.

Parameters:

base – ANACTRL peripheral base address.
config – Pointer to XO32M configuration structure. Refer to anactrl_xo32M_config_t structure.

void ANACTRL_GetDefaultXo32MConfig(anactrl_xo32M_config_t *config)

Gets the default configuration of XO32M. The default values are:

config->enableSysCLkOutput = false;
config->enableACBufferBypass = false;

Parameters:

config – Pointer to XO32M configuration structure. Refer to anactrl_xo32M_config_t structure.

uint32_t ANACTRL_MeasureFrequency(ANACTRL_Type *base, uint8_t scale, uint32_t refClkFreq)

Measures the frequency of the target clock source.

This function measures target frequency according to a accurate reference frequency.The formula is: Ftarget = (CAPVAL * Freference) / ((1<<SCALE)-1)

Note

Both tartget and reference clocks are selectable by programming the target clock select FREQMEAS_TARGET register in INPUTMUX and reference clock select FREQMEAS_REF register in INPUTMUX.

Parameters:

base – ANACTRL peripheral base address.
scale – Define the power of 2 count that ref counter counts to during measurement, ranges from 2 to 31.
refClkFreq – frequency of the reference clock.

Returns:

frequency of the target clock.

static inline void ANACTRL_EnableInterrupts(ANACTRL_Type *base, uint32_t mask)

Enables the ANACTRL interrupts.

Parameters:

base – ANACTRL peripheral base address.
mask – The interrupt mask. Refer to “_anactrl_interrupt” enumeration.

static inline void ANACTRL_DisableInterrupts(ANACTRL_Type *base, uint32_t mask)

Disables the ANACTRL interrupts.

Parameters:

base – ANACTRL peripheral base address.
mask – The interrupt mask. Refer to “_anactrl_interrupt” enumeration.

static inline void ANACTRL_ClearInterrupts(ANACTRL_Type *base, uint32_t mask)

Clears the ANACTRL interrupts.

Parameters:

base – ANACTRL peripheral base address.
mask – The interrupt mask. Refer to “_anactrl_interrupt” enumeration.

static inline uint32_t ANACTRL_GetStatusFlags(ANACTRL_Type *base)

Gets ANACTRL status flags.

This function gets Analog control status flags. The flags are returned as the logical OR value of the enumerators _anactrl_flags. To check for a specific status, compare the return value with enumerators in the _anactrl_flags. For example, to check whether the flash is in power down mode:

if (kANACTRL_FlashPowerDownFlag & ANACTRL_ANACTRL_GetStatusFlags(ANACTRL))
{
    ...
}

Parameters:

base – ANACTRL peripheral base address.

Returns:

ANACTRL status flags which are given in the enumerators in the _anactrl_flags.

static inline uint32_t ANACTRL_GetOscStatusFlags(ANACTRL_Type *base)

Gets ANACTRL oscillators status flags.

This function gets Anactrl oscillators status flags. The flags are returned as the logical OR value of the enumerators _anactrl_osc_flags. To check for a specific status, compare the return value with enumerators in the _anactrl_osc_flags. For example, to check whether the FRO192M clock output is valid:

if (kANACTRL_OutputClkValidFlag & ANACTRL_ANACTRL_GetOscStatusFlags(ANACTRL))
{
    ...
}

Parameters:

base – ANACTRL peripheral base address.

Returns:

ANACTRL oscillators status flags which are given in the enumerators in the _anactrl_osc_flags.

static inline uint32_t ANACTRL_GetInterruptStatusFlags(ANACTRL_Type *base)

Gets ANACTRL interrupt status flags.

This function gets Anactrl interrupt status flags. The flags are returned as the logical OR value of the enumerators _anactrl_interrupt_flags. To check for a specific status, compare the return value with enumerators in the _anactrl_interrupt_flags. For example, to check whether the VBAT voltage level is above the threshold:

if (kANACTRL_BodVbatPowerFlag & ANACTRL_ANACTRL_GetInterruptStatusFlags(ANACTRL))
{
    ...
}

Parameters:

base – ANACTRL peripheral base address.

Returns:

ANACTRL oscillators status flags which are given in the enumerators in the _anactrl_osc_flags.

static inline void ANACTRL_EnableVref1V(ANACTRL_Type *base, bool enable)

Aux_Bias Control Interfaces.

Enables/disabless 1V reference voltage buffer.

Parameters:

base – ANACTRL peripheral base address.
enable – Used to enable or disable 1V reference voltage buffer.

enum _anactrl_interrupt_flags

ANACTRL interrupt flags.

Values:

enumerator kANACTRL_BodVbatFlag: BOD VBAT Interrupt status before Interrupt Enable.

enumerator kANACTRL_BodVbatInterruptFlag: BOD VBAT Interrupt status after Interrupt Enable.

enumerator kANACTRL_BodVbatPowerFlag: Current value of BOD VBAT power status output.

enumerator kANACTRL_BodCoreFlag: BOD CORE Interrupt status before Interrupt Enable.

enumerator kANACTRL_BodCoreInterruptFlag: BOD CORE Interrupt status after Interrupt Enable.

enumerator kANACTRL_BodCorePowerFlag: Current value of BOD CORE power status output.

enumerator kANACTRL_DcdcFlag: DCDC Interrupt status before Interrupt Enable.

enumerator kANACTRL_DcdcInterruptFlag: DCDC Interrupt status after Interrupt Enable.

enumerator kANACTRL_DcdcPowerFlag: Current value of DCDC power status output.

enum _anactrl_interrupt

ANACTRL interrupt control.

Values:

enumerator kANACTRL_BodVbatInterruptEnable: BOD VBAT interrupt control.

enumerator kANACTRL_BodCoreInterruptEnable: BOD CORE interrupt control.

enumerator kANACTRL_DcdcInterruptEnable: DCDC interrupt control.

enum _anactrl_flags

ANACTRL status flags.

Values:

enumerator kANACTRL_FlashPowerDownFlag: Flash power-down status.

enumerator kANACTRL_FlashInitErrorFlag: Flash initialization error status.

enum _anactrl_osc_flags

ANACTRL FRO192M and XO32M status flags.

Values:

enumerator kANACTRL_OutputClkValidFlag: Output clock valid signal.

enumerator kANACTRL_CCOThresholdVoltageFlag: CCO threshold voltage detector output (signal vcco_ok).

enumerator kANACTRL_XO32MOutputReadyFlag: Indicates XO out frequency statibilty.

typedef struct _anactrl_fro192M_config anactrl_fro192M_config_t

Configuration for FRO192M.

This structure holds the configuration settings for the on-chip high-speed Free Running Oscillator. To initialize this structure to reasonable defaults, call the ANACTRL_GetDefaultFro192MConfig() function and pass a pointer to your config structure instance.

typedef struct _anactrl_xo32M_config anactrl_xo32M_config_t

Configuration for XO32M.

This structure holds the configuration settings for the 32 MHz crystal oscillator. To initialize this structure to reasonable defaults, call the ANACTRL_GetDefaultXo32MConfig() function and pass a pointer to your config structure instance.

FSL_ANACTRL_DRIVER_VERSION: ANACTRL driver version.

struct _anactrl_fro192M_config

#include <fsl_anactrl.h>

Configuration for FRO192M.

This structure holds the configuration settings for the on-chip high-speed Free Running Oscillator. To initialize this structure to reasonable defaults, call the ANACTRL_GetDefaultFro192MConfig() function and pass a pointer to your config structure instance.

Public Members

bool enable12MHzClk: Enable 12MHz clock.

bool enable96MHzClk: Enable 96MHz clock.

struct _anactrl_xo32M_config

#include <fsl_anactrl.h>

Configuration for XO32M.

This structure holds the configuration settings for the 32 MHz crystal oscillator. To initialize this structure to reasonable defaults, call the ANACTRL_GetDefaultXo32MConfig() function and pass a pointer to your config structure instance.

Public Members

bool enableACBufferBypass: Enable XO AC buffer bypass in pll and top level.

bool enableSysCLkOutput: Enable XO 32 MHz output to CPU system, SCT, and CLKOUT

bool enableADCOutput: Enable High speed crystal oscillator output to ADC.

casper_driver

FSL_CASPER_DRIVER_VERSION

CASPER driver version. Version 2.2.4.

Current version: 2.2.4

Change log:

Version 2.0.0
- Initial version
Version 2.0.1
- Bug fix KPSDK-24531 double_scalar_multiplication() result may be all zeroes for some specific input
Version 2.0.2
- Bug fix KPSDK-25015 CASPER_MEMCPY hard-fault on LPC55xx when both source and destination buffers are outside of CASPER_RAM
Version 2.0.3
- Bug fix KPSDK-28107 RSUB, FILL and ZERO operations not implemented in enum _casper_operation.
Version 2.0.4
- For GCC compiler, enforce O1 optimize level, specifically to remove strict-aliasing option. This driver is very specific and requires -fno-strict-aliasing.
Version 2.0.5
- Fix sign-compare warning.
Version 2.0.6
- Fix IAR Pa082 warning.
Version 2.0.7
- Fix MISRA-C 2012 issue.
Version 2.0.8
- Add feature macro for CASPER_RAM_OFFSET.
Version 2.0.9
- Remove unused function Jac_oncurve().
- Fix ECC384 build.
Version 2.0.10
- Fix MISRA-C 2012 issue.
Version 2.1.0
- Add ECC NIST P-521 elliptic curve.
Version 2.2.0
- Rework driver to support multiple curves at once.
Version 2.2.1
- Fix MISRA-C 2012 issue.
Version 2.2.2
- Enable hardware interleaving to RAMX0 and RAMX1 for CASPER by feature macro FSL_FEATURE_CASPER_RAM_HW_INTERLEAVE
Version 2.2.3
- Added macro into CASPER_Init and CASPER_Deinit to support devices without clock and reset control.
Version 2.2.4
- Fix MISRA-C 2012 issue.

enum _casper_operation

CASPER operation.

Values:

enumerator kCASPER_OpMul6464NoSum

enumerator kCASPER_OpMul6464Sum: Walking 1 or more of J loop, doing r=a*b using 64x64=128

enumerator kCASPER_OpMul6464FullSum: Walking 1 or more of J loop, doing c,r=r+a*b using 64x64=128, but assume inner j loop

enumerator kCASPER_OpMul6464Reduce: Walking 1 or more of J loop, doing c,r=r+a*b using 64x64=128, but sum all of w.

enumerator kCASPER_OpAdd64: Walking 1 or more of J loop, doing c,r[-1]=r+a*b using 64x64=128, but skip 1st write

enumerator kCASPER_OpSub64: Walking add with off_AB, and in/out off_RES doing c,r=r+a+c using 64+64=65

enumerator kCASPER_OpDouble64: Walking subtract with off_AB, and in/out off_RES doing r=r-a using 64-64=64, with last borrow implicit if any

enumerator kCASPER_OpXor64: Walking add to self with off_RES doing c,r=r+r+c using 64+64=65

enumerator kCASPER_OpRSub64: Walking XOR with off_AB, and in/out off_RES doing r=r^a using 64^64=64

enumerator kCASPER_OpShiftLeft32: Walking subtract with off_AB, and in/out off_RES using r=a-r

enumerator kCASPER_OpShiftRight32: Walking shift left doing r1,r=(b*D)|r1, where D is 2^amt and is loaded by app (off_CD not used)

enumerator kCASPER_OpCopy: Walking shift right doing r,r1=(b*D)|r1, where D is 2^(32-amt) and is loaded by app (off_CD not used) and off_RES starts at MSW

enumerator kCASPER_OpRemask: Copy from ABoff to resoff, 64b at a time

enumerator kCASPER_OpFill: Copy and mask from ABoff to resoff, 64b at a time

enumerator kCASPER_OpZero: Fill RESOFF using 64 bits at a time with value in A and B

enumerator kCASPER_OpCompare: Fill RESOFF using 64 bits at a time of 0s

enumerator kCASPER_OpCompareFast: Compare two arrays, running all the way to the end

enum _casper_algo_t

Algorithm used for CASPER operation.

Values:

enumerator kCASPER_ECC_P256: ECC_P256

enumerator kCASPER_ECC_P384: ECC_P384

enumerator kCASPER_ECC_P521: ECC_P521

Values:

enumerator kCASPER_RamOffset_Result

enumerator kCASPER_RamOffset_Base

enumerator kCASPER_RamOffset_TempBase

enumerator kCASPER_RamOffset_Modulus

enumerator kCASPER_RamOffset_M64

typedef enum _casper_operation casper_operation_t: CASPER operation.

typedef enum _casper_algo_t casper_algo_t: Algorithm used for CASPER operation.

void CASPER_Init(CASPER_Type *base)

Enables clock and disables reset for CASPER peripheral.

Enable clock and disable reset for CASPER.

Parameters:

base – CASPER base address

void CASPER_Deinit(CASPER_Type *base)

Disables clock for CASPER peripheral.

Disable clock and enable reset.

Parameters:

base – CASPER base address

CASPER_CP

CASPER_CP_CTRL0

CASPER_CP_CTRL1

CASPER_CP_LOADER

CASPER_CP_STATUS

CASPER_CP_INTENSET

CASPER_CP_INTENCLR

CASPER_CP_INTSTAT

CASPER_CP_AREG

CASPER_CP_BREG

CASPER_CP_CREG

CASPER_CP_DREG

CASPER_CP_RES0

CASPER_CP_RES1

CASPER_CP_RES2

CASPER_CP_RES3

CASPER_CP_MASK

CASPER_CP_REMASK

CASPER_CP_LOCK

CASPER_CP_ID

CASPER_Wr32b(value, off)

CASPER_Wr64b(value, off)

CASPER_Rd32b(off)

N_wordlen_max

casper_driver_pkha

void CASPER_ModExp(CASPER_Type *base, const uint8_t *signature, const uint8_t *pubN, size_t wordLen, uint32_t pubE, uint8_t *plaintext)

Performs modular exponentiation - (A^E) mod N.

This function performs modular exponentiation.

Parameters:

base – CASPER base address
signature – first addend (in little endian format)
pubN – modulus (in little endian format)
wordLen – Size of pubN in bytes
pubE – exponent
plaintext – [out] Output array to store result of operation (in little endian format)

void CASPER_ecc_init(casper_algo_t curve)

Initialize prime modulus mod in Casper memory .

Set the prime modulus mod in Casper memory and set N_wordlen according to selected algorithm.

Parameters:

curve – elliptic curve algoritm

void CASPER_ECC_SECP256R1_Mul(CASPER_Type *base, uint32_t resX[8], uint32_t resY[8], uint32_t X[8], uint32_t Y[8], uint32_t scalar[8])

Performs ECC secp256r1 point single scalar multiplication.

This function performs ECC secp256r1 point single scalar multiplication [resX; resY] = scalar * [X; Y] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate in normal form, little endian.
resY – [out] Output Y affine coordinate in normal form, little endian.
X – Input X affine coordinate in normal form, little endian.
Y – Input Y affine coordinate in normal form, little endian.
scalar – Input scalar integer, in normal form, little endian.

void CASPER_ECC_SECP256R1_MulAdd(CASPER_Type *base, uint32_t resX[8], uint32_t resY[8], uint32_t X1[8], uint32_t Y1[8], uint32_t scalar1[8], uint32_t X2[8], uint32_t Y2[8], uint32_t scalar2[8])

Performs ECC secp256r1 point double scalar multiplication.

This function performs ECC secp256r1 point double scalar multiplication [resX; resY] = scalar1 * [X1; Y1] + scalar2 * [X2; Y2] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate.
resY – [out] Output Y affine coordinate.
X1 – Input X1 affine coordinate.
Y1 – Input Y1 affine coordinate.
scalar1 – Input scalar1 integer.
X2 – Input X2 affine coordinate.
Y2 – Input Y2 affine coordinate.
scalar2 – Input scalar2 integer.

void CASPER_ECC_SECP384R1_Mul(CASPER_Type *base, uint32_t resX[12], uint32_t resY[12], uint32_t X[12], uint32_t Y[12], uint32_t scalar[12])

Performs ECC secp384r1 point single scalar multiplication.

This function performs ECC secp384r1 point single scalar multiplication [resX; resY] = scalar * [X; Y] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate in normal form, little endian.
resY – [out] Output Y affine coordinate in normal form, little endian.
X – Input X affine coordinate in normal form, little endian.
Y – Input Y affine coordinate in normal form, little endian.
scalar – Input scalar integer, in normal form, little endian.

void CASPER_ECC_SECP384R1_MulAdd(CASPER_Type *base, uint32_t resX[12], uint32_t resY[12], uint32_t X1[12], uint32_t Y1[12], uint32_t scalar1[12], uint32_t X2[12], uint32_t Y2[12], uint32_t scalar2[12])

Performs ECC secp384r1 point double scalar multiplication.

This function performs ECC secp384r1 point double scalar multiplication [resX; resY] = scalar1 * [X1; Y1] + scalar2 * [X2; Y2] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate.
resY – [out] Output Y affine coordinate.
X1 – Input X1 affine coordinate.
Y1 – Input Y1 affine coordinate.
scalar1 – Input scalar1 integer.
X2 – Input X2 affine coordinate.
Y2 – Input Y2 affine coordinate.
scalar2 – Input scalar2 integer.

void CASPER_ECC_SECP521R1_Mul(CASPER_Type *base, uint32_t resX[18], uint32_t resY[18], uint32_t X[18], uint32_t Y[18], uint32_t scalar[18])

Performs ECC secp521r1 point single scalar multiplication.

This function performs ECC secp521r1 point single scalar multiplication [resX; resY] = scalar * [X; Y] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate in normal form, little endian.
resY – [out] Output Y affine coordinate in normal form, little endian.
X – Input X affine coordinate in normal form, little endian.
Y – Input Y affine coordinate in normal form, little endian.
scalar – Input scalar integer, in normal form, little endian.

void CASPER_ECC_SECP521R1_MulAdd(CASPER_Type *base, uint32_t resX[18], uint32_t resY[18], uint32_t X1[18], uint32_t Y1[18], uint32_t scalar1[18], uint32_t X2[18], uint32_t Y2[18], uint32_t scalar2[18])

Performs ECC secp521r1 point double scalar multiplication.

This function performs ECC secp521r1 point double scalar multiplication [resX; resY] = scalar1 * [X1; Y1] + scalar2 * [X2; Y2] Coordinates are affine in normal form, little endian. Scalars are little endian. All arrays are little endian byte arrays, uint32_t type is used only to enforce the 32-bit alignment (0-mod-4 address).

Parameters:

base – CASPER base address
resX – [out] Output X affine coordinate.
resY – [out] Output Y affine coordinate.
X1 – Input X1 affine coordinate.
Y1 – Input Y1 affine coordinate.
scalar1 – Input scalar1 integer.
X2 – Input X2 affine coordinate.
Y2 – Input Y2 affine coordinate.
scalar2 – Input scalar2 integer.

void CASPER_ECC_equal(int *res, uint32_t *op1, uint32_t *op2)

void CASPER_ECC_equal_to_zero(int *res, uint32_t *op1)

CDOG

status_t CDOG_Init(CDOG_Type *base, cdog_config_t *conf)

Initialize CDOG.

This function initializes CDOG block and setting.

Parameters:

base – CDOG peripheral base address
conf – CDOG configuration structure

Returns:

Status of the init operation

void CDOG_Deinit(CDOG_Type *base)

Deinitialize CDOG.

This function deinitializes CDOG secure counter.

Parameters:

base – CDOG peripheral base address

void CDOG_GetDefaultConfig(cdog_config_t *conf)

Sets the default configuration of CDOG.

This function initialize CDOG config structure to default values.

Parameters:

conf – CDOG configuration structure

void CDOG_Stop(CDOG_Type *base, uint32_t stop)

Stops secure counter and instruction timer.

This function stops instruction timer and secure counter. This also change state od CDOG to IDLE.

Parameters:

base – CDOG peripheral base address
stop – expected value which will be compared with value of secure counter

void CDOG_Start(CDOG_Type *base, uint32_t reload, uint32_t start)

Sets secure counter and instruction timer values.

This function sets value in RELOAD and START registers for instruction timer and secure counter

Parameters:

base – CDOG peripheral base address
reload – reload value
start – start value

void CDOG_Check(CDOG_Type *base, uint32_t check)

Checks secure counter.

This function compares stop value in handler with secure counter value by writting to RELOAD refister.

Parameters:

base – CDOG peripheral base address
check – expected (stop) value

void CDOG_Set(CDOG_Type *base, uint32_t stop, uint32_t reload, uint32_t start)

Sets secure counter and instruction timer values.

This function sets value in STOP, RELOAD and START registers for instruction timer and secure counter.

Parameters:

base – CDOG peripheral base address
stop – expected value which will be compared with value of secure counter
reload – reload value for instruction timer
start – start value for secure timer

void CDOG_Add(CDOG_Type *base, uint32_t add)

Add value to secure counter.

This function add specified value to secure counter.

Parameters:

base – CDOG peripheral base address.
add – Value to be added.

void CDOG_Add1(CDOG_Type *base)

Add 1 to secure counter.

This function add 1 to secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_Add16(CDOG_Type *base)

Add 16 to secure counter.

This function add 16 to secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_Add256(CDOG_Type *base)

Add 256 to secure counter.

This function add 256 to secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_Sub(CDOG_Type *base, uint32_t sub)

brief Substract value to secure counter

This function substract specified value to secure counter.

param base CDOG peripheral base address. param sub Value to be substracted.

void CDOG_Sub1(CDOG_Type *base)

Substract 1 from secure counter.

This function substract specified 1 from secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_Sub16(CDOG_Type *base)

Substract 16 from secure counter.

This function substract specified 16 from secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_Sub256(CDOG_Type *base)

Substract 256 from secure counter.

This function substract specified 256 from secure counter.

Parameters:

base – CDOG peripheral base address.

void CDOG_WritePersistent(CDOG_Type *base, uint32_t value)

Set the CDOG persistent word.

Parameters:

base – CDOG peripheral base address.
value – The value to be written.

uint32_t CDOG_ReadPersistent(CDOG_Type *base)

Get the CDOG persistent word.

Parameters:

base – CDOG peripheral base address.

Returns:

The persistent word.

FSL_CDOG_DRIVER_VERSION

Defines CDOG driver version 2.1.3.

Change log:

Version 2.1.3
- Re-design multiple instance IRQs and Clocks
- Add fix for RESTART command errata
Version 2.1.2
- Support multiple IRQs
- Fix default CONTROL values
Version 2.1.1
- Remove bit CONTROL[CONTROL_CTRL]
Version 2.1.0
- Rename CWT to CDOG
Version 2.0.2
- Fix MISRA-2012 issues
Version 2.0.1
- Fix doxygen issues
Version 2.0.0
- initial version

enum __cdog_debug_Action_ctrl_enum

Values:

enumerator kCDOG_DebugHaltCtrl_Run

enumerator kCDOG_DebugHaltCtrl_Pause

enum __cdog_irq_pause_ctrl_enum

Values:

enumerator kCDOG_IrqPauseCtrl_Run

enumerator kCDOG_IrqPauseCtrl_Pause

enum __cdog_fault_ctrl_enum

Values:

enumerator kCDOG_FaultCtrl_EnableReset

enumerator kCDOG_FaultCtrl_EnableInterrupt

enumerator kCDOG_FaultCtrl_NoAction

enum __code_lock_ctrl_enum

Values:

enumerator kCDOG_LockCtrl_Lock

enumerator kCDOG_LockCtrl_Unlock

typedef uint32_t secure_counter_t

SC_ADD(add)

SC_ADD1

SC_ADD16

SC_ADD256

SC_SUB(sub)

SC_SUB1

SC_SUB16

SC_SUB256

SC_CHECK(val)

struct cdog_config_t: #include <fsl_cdog.h>

Clock Driver

enum _clock_ip_name

Clock gate name used for CLOCK_EnableClock/CLOCK_DisableClock.

Values:

enumerator kCLOCK_IpInvalid: Invalid Ip Name.

enumerator kCLOCK_Rom: Clock gate name: Rom.

enumerator kCLOCK_Sram1: Clock gate name: Sram1.

enumerator kCLOCK_Sram2: Clock gate name: Sram2.

enumerator kCLOCK_Flash: Clock gate name: Flash.

enumerator kCLOCK_Fmc: Clock gate name: Fmc.

enumerator kCLOCK_InputMux: Clock gate name: InputMux.

enumerator kCLOCK_Iocon: Clock gate name: Iocon.

enumerator kCLOCK_Gpio0: Clock gate name: Gpio0.

enumerator kCLOCK_Gpio1: Clock gate name: Gpio1.

enumerator kCLOCK_Pint: Clock gate name: Pint.

enumerator kCLOCK_Gint: Clock gate name: Gint.

enumerator kCLOCK_Dma0: Clock gate name: Dma0.

enumerator kCLOCK_Crc: Clock gate name: Crc.

enumerator kCLOCK_Wwdt: Clock gate name: Wwdt.

enumerator kCLOCK_Rtc: Clock gate name: Rtc.

enumerator kCLOCK_Mailbox: Clock gate name: Mailbox.

enumerator kCLOCK_Adc0: Clock gate name: Adc0.

enumerator kCLOCK_Mrt: Clock gate name: Mrt.

enumerator kCLOCK_OsTimer0: Clock gate name: OsTimer0.

enumerator kCLOCK_Sct0: Clock gate name: Sct0.

enumerator kCLOCK_Mcan: Clock gate name: Mcan.

enumerator kCLOCK_Utick0: Clock gate name: Utick0.

enumerator kCLOCK_FlexComm0: Clock gate name: FlexComm0.

enumerator kCLOCK_FlexComm1: Clock gate name: FlexComm1.

enumerator kCLOCK_FlexComm2: Clock gate name: FlexComm2.

enumerator kCLOCK_FlexComm3: Clock gate name: FlexComm3.

enumerator kCLOCK_FlexComm4: Clock gate name: FlexComm4.

enumerator kCLOCK_FlexComm5: Clock gate name: FlexComm5.

enumerator kCLOCK_FlexComm6: Clock gate name: FlexComm6.

enumerator kCLOCK_FlexComm7: Clock gate name: FlexComm7.

enumerator kCLOCK_MinUart0: Clock gate name: MinUart0.

enumerator kCLOCK_MinUart1: Clock gate name: MinUart1.

enumerator kCLOCK_MinUart2: Clock gate name: MinUart2.

enumerator kCLOCK_MinUart3: Clock gate name: MinUart3.

enumerator kCLOCK_MinUart4: Clock gate name: MinUart4.

enumerator kCLOCK_MinUart5: Clock gate name: MinUart5.

enumerator kCLOCK_MinUart6: Clock gate name: MinUart6.

enumerator kCLOCK_MinUart7: Clock gate name: MinUart7.

enumerator kCLOCK_LSpi0: Clock gate name: LSpi0.

enumerator kCLOCK_LSpi1: Clock gate name: LSpi1.

enumerator kCLOCK_LSpi2: Clock gate name: LSpi2.

enumerator kCLOCK_LSpi3: Clock gate name: LSpi3.

enumerator kCLOCK_LSpi4: Clock gate name: LSpi4.

enumerator kCLOCK_LSpi5: Clock gate name: LSpi5.

enumerator kCLOCK_LSpi6: Clock gate name: LSpi6.

enumerator kCLOCK_LSpi7: Clock gate name: LSpi7.

enumerator kCLOCK_BI2c0: Clock gate name: BI2c0.

enumerator kCLOCK_BI2c1: Clock gate name: BI2c1.

enumerator kCLOCK_BI2c2: Clock gate name: BI2c2.

enumerator kCLOCK_BI2c3: Clock gate name: BI2c3.

enumerator kCLOCK_BI2c4: Clock gate name: BI2c4.

enumerator kCLOCK_BI2c5: Clock gate name: BI2c5.

enumerator kCLOCK_BI2c6: Clock gate name: BI2c6.

enumerator kCLOCK_BI2c7: Clock gate name: BI2c7.

enumerator kCLOCK_FlexI2s0: Clock gate name: FlexI2s0.

enumerator kCLOCK_FlexI2s1: Clock gate name: FlexI2s1.

enumerator kCLOCK_FlexI2s2: Clock gate name: FlexI2s2.

enumerator kCLOCK_FlexI2s3: Clock gate name: FlexI2s3.

enumerator kCLOCK_FlexI2s4: Clock gate name: FlexI2s4.

enumerator kCLOCK_FlexI2s5: Clock gate name: FlexI2s5.

enumerator kCLOCK_FlexI2s6: Clock gate name: FlexI2s6.

enumerator kCLOCK_FlexI2s7: Clock gate name: FlexI2s7.

enumerator kCLOCK_Timer2: Clock gate name: Timer2.

enumerator kCLOCK_Timer0: Clock gate name: Timer0.

enumerator kCLOCK_Timer1: Clock gate name: Timer1.

enumerator kCLOCK_Dma1: Clock gate name: Dma1.

enumerator kCLOCK_Comp: Clock gate name: Comp.

enumerator kCLOCK_Sram3: Clock gate name: Sram3.

enumerator kCLOCK_Freqme: Clock gate name: Freqme.

enumerator kCLOCK_Cdog: Clock gate name: Cdog.

enumerator kCLOCK_Rng: Clock gate name: Rng.

enumerator kCLOCK_Sysctl: Clock gate name: Sysctl.

enumerator kCLOCK_HashCrypt: Clock gate name: HashCrypt.

enumerator kCLOCK_PluLut: Clock gate name: PluLut.

enumerator kCLOCK_Timer3: Clock gate name: Timer3.

enumerator kCLOCK_Timer4: Clock gate name: Timer4.

enumerator kCLOCK_Puf: Clock gate name: Puf.

enumerator kCLOCK_Casper: Clock gate name: Casper.

enumerator kCLOCK_AnalogCtrl: Clock gate name: AnalogCtrl.

enumerator kCLOCK_Hs_Lspi: Clock gate name: Lspi.

enumerator kCLOCK_Gpio_Sec: Clock gate name: GPIO Sec.

enumerator kCLOCK_Gpio_Sec_Int: Clock gate name: Gpio Sec Int

enum _clock_name

Clock name used to get clock frequency.

Values:

enumerator kCLOCK_CoreSysClk: Core/system clock (aka MAIN_CLK)

enumerator kCLOCK_BusClk: Bus clock (AHB clock)

enumerator kCLOCK_ClockOut: CLOCKOUT

enumerator kCLOCK_FroHf: FRO48/96

enumerator kCLOCK_Pll1Out: PLL1 Output

enumerator kCLOCK_Mclk: MCLK

enumerator kCLOCK_Fro12M: FRO12M

enumerator kCLOCK_Fro1M: FRO1M

enumerator kCLOCK_ExtClk: External Clock

enumerator kCLOCK_Pll0Out: PLL0 Output

enumerator kCLOCK_FlexI2S: FlexI2S clock

enum _clock_attach_id

The enumerator of clock attach Id.

Values:

enumerator kFRO12M_to_MAIN_CLK: Attach FRO12M to MAIN_CLK.

enumerator kEXT_CLK_to_MAIN_CLK: Attach EXT_CLK to MAIN_CLK.

enumerator kFRO1M_to_MAIN_CLK: Attach FRO1M to MAIN_CLK.

enumerator kFRO_HF_to_MAIN_CLK: Attach FRO_HF to MAIN_CLK.

enumerator kPLL0_to_MAIN_CLK: Attach PLL0 to MAIN_CLK.

enumerator kPLL1_to_MAIN_CLK: Attach PLL1 to MAIN_CLK.

enumerator kOSC32K_to_MAIN_CLK: Attach OSC32K to MAIN_CLK.

enumerator kMAIN_CLK_to_CLKOUT: Attach MAIN_CLK to CLKOUT.

enumerator kPLL0_to_CLKOUT: Attach PLL0 to CLKOUT.

enumerator kEXT_CLK_to_CLKOUT: Attach EXT_CLK to CLKOUT.

enumerator kFRO_HF_to_CLKOUT: Attach FRO_HF to CLKOUT.

enumerator kFRO1M_to_CLKOUT: Attach FRO1M to CLKOUT.

enumerator kPLL1_to_CLKOUT: Attach PLL1 to CLKOUT.

enumerator kOSC32K_to_CLKOUT: Attach OSC32K to CLKOUT.

enumerator kNONE_to_SYS_CLKOUT: Attach NONE to SYS_CLKOUT.

enumerator kFRO12M_to_PLL0: Attach FRO12M to PLL0.

enumerator kEXT_CLK_to_PLL0: Attach EXT_CLK to PLL0.

enumerator kFRO1M_to_PLL0: Attach FRO1M to PLL0.

enumerator kOSC32K_to_PLL0: Attach OSC32K to PLL0.

enumerator kNONE_to_PLL0: Attach NONE to PLL0.

enumerator kMCAN_DIV_to_MCAN: Attach MCAN_DIV to MCAN.

enumerator kFRO1M_to_MCAN: Attach FRO1M to MCAN.

enumerator kOSC32K_to_MCAN: Attach OSC32K to MCAN.

enumerator kNONE_to_MCAN: Attach NONE to MCAN.

enumerator kMAIN_CLK_to_ADC_CLK: Attach MAIN_CLK to ADC_CLK.

enumerator kPLL0_to_ADC_CLK: Attach PLL0 to ADC_CLK.

enumerator kFRO_HF_to_ADC_CLK: Attach FRO_HF to ADC_CLK.

enumerator kEXT_CLK_to_ADC_CLK: Attach EXT_CLK to ADC_CLK.

enumerator kNONE_to_ADC_CLK: Attach NONE to ADC_CLK.

enumerator kOSC32K_to_CLK32K: Attach OSC32K to CLK32K.

enumerator kFRO1MDIV_to_CLK32K: Attach FRO1MDIV to CLK32K.

enumerator kNONE_to_CLK32K: Attach NONE to CLK32K.

enumerator kMAIN_CLK_to_FLEXCOMM0: Attach MAIN_CLK to FLEXCOMM0.

enumerator kPLL0_DIV_to_FLEXCOMM0: Attach PLL0_DIV to FLEXCOMM0.

enumerator kFRO12M_to_FLEXCOMM0: Attach FRO12M to FLEXCOMM0.

enumerator kFRO_HF_DIV_to_FLEXCOMM0: Attach FRO_HF_DIV to FLEXCOMM0.

enumerator kFRO1M_to_FLEXCOMM0: Attach FRO1M to FLEXCOMM0.

enumerator kMCLK_to_FLEXCOMM0: Attach MCLK to FLEXCOMM0.

enumerator kOSC32K_to_FLEXCOMM0: Attach OSC32K to FLEXCOMM0.

enumerator kNONE_to_FLEXCOMM0: Attach NONE to FLEXCOMM0.

enumerator kMAIN_CLK_to_FLEXCOMM1: Attach MAIN_CLK to FLEXCOMM1.

enumerator kPLL0_DIV_to_FLEXCOMM1: Attach PLL0_DIV to FLEXCOMM1.

enumerator kFRO12M_to_FLEXCOMM1: Attach FRO12M to FLEXCOMM1.

enumerator kFRO_HF_DIV_to_FLEXCOMM1: Attach FRO_HF_DIV to FLEXCOMM1.

enumerator kFRO1M_to_FLEXCOMM1: Attach FRO1M to FLEXCOMM1.

enumerator kMCLK_to_FLEXCOMM1: Attach MCLK to FLEXCOMM1.

enumerator kOSC32K_to_FLEXCOMM1: Attach OSC32K to FLEXCOMM1.

enumerator kNONE_to_FLEXCOMM1: Attach NONE to FLEXCOMM1.

enumerator kMAIN_CLK_to_FLEXCOMM2: Attach MAIN_CLK to FLEXCOMM2.

enumerator kPLL0_DIV_to_FLEXCOMM2: Attach PLL0_DIV to FLEXCOMM2.

enumerator kFRO12M_to_FLEXCOMM2: Attach FRO12M to FLEXCOMM2.

enumerator kFRO_HF_DIV_to_FLEXCOMM2: Attach FRO_HF_DIV to FLEXCOMM2.

enumerator kFRO1M_to_FLEXCOMM2: Attach FRO1M to FLEXCOMM2.

enumerator kMCLK_to_FLEXCOMM2: Attach MCLK to FLEXCOMM2.

enumerator kOSC32K_to_FLEXCOMM2: Attach OSC32K to FLEXCOMM2.

enumerator kNONE_to_FLEXCOMM2: Attach NONE to FLEXCOMM2.

enumerator kMAIN_CLK_to_FLEXCOMM3: Attach MAIN_CLK to FLEXCOMM3.

enumerator kPLL0_DIV_to_FLEXCOMM3: Attach PLL0_DIV to FLEXCOMM3.

enumerator kFRO12M_to_FLEXCOMM3: Attach FRO12M to FLEXCOMM3.

enumerator kFRO_HF_DIV_to_FLEXCOMM3: Attach FRO_HF_DIV to FLEXCOMM3.

enumerator kFRO1M_to_FLEXCOMM3: Attach FRO1M to FLEXCOMM3.

enumerator kMCLK_to_FLEXCOMM3: Attach MCLK to FLEXCOMM3.

enumerator kOSC32K_to_FLEXCOMM3: Attach OSC32K to FLEXCOMM3.

enumerator kNONE_to_FLEXCOMM3: Attach NONE to FLEXCOMM3.

enumerator kMAIN_CLK_to_FLEXCOMM4: Attach MAIN_CLK to FLEXCOMM4.

enumerator kPLL0_DIV_to_FLEXCOMM4: Attach PLL0_DIV to FLEXCOMM4.

enumerator kFRO12M_to_FLEXCOMM4: Attach FRO12M to FLEXCOMM4.

enumerator kFRO_HF_DIV_to_FLEXCOMM4: Attach FRO_HF_DIV to FLEXCOMM4.

enumerator kFRO1M_to_FLEXCOMM4: Attach FRO1M to FLEXCOMM4.

enumerator kMCLK_to_FLEXCOMM4: Attach MCLK to FLEXCOMM4.

enumerator kOSC32K_to_FLEXCOMM4: Attach OSC32K to FLEXCOMM4.

enumerator kNONE_to_FLEXCOMM4: Attach NONE to FLEXCOMM4.

enumerator kMAIN_CLK_to_FLEXCOMM5: Attach MAIN_CLK to FLEXCOMM5.

enumerator kPLL0_DIV_to_FLEXCOMM5: Attach PLL0_DIV to FLEXCOMM5.

enumerator kFRO12M_to_FLEXCOMM5: Attach FRO12M to FLEXCOMM5.

enumerator kFRO_HF_DIV_to_FLEXCOMM5: Attach FRO_HF_DIV to FLEXCOMM5.

enumerator kFRO1M_to_FLEXCOMM5: Attach FRO1M to FLEXCOMM5.

enumerator kMCLK_to_FLEXCOMM5: Attach MCLK to FLEXCOMM5.

enumerator kOSC32K_to_FLEXCOMM5: Attach OSC32K to FLEXCOMM5.

enumerator kNONE_to_FLEXCOMM5: Attach NONE to FLEXCOMM5.

enumerator kMAIN_CLK_to_FLEXCOMM6: Attach MAIN_CLK to FLEXCOMM6.

enumerator kPLL0_DIV_to_FLEXCOMM6: Attach PLL0_DIV to FLEXCOMM6.

enumerator kFRO12M_to_FLEXCOMM6: Attach FRO12M to FLEXCOMM6.

enumerator kFRO_HF_DIV_to_FLEXCOMM6: Attach FRO_HF_DIV to FLEXCOMM6.

enumerator kFRO1M_to_FLEXCOMM6: Attach FRO1M to FLEXCOMM6.

enumerator kMCLK_to_FLEXCOMM6: Attach MCLK to FLEXCOMM6.

enumerator kOSC32K_to_FLEXCOMM6: Attach OSC32K to FLEXCOMM6.

enumerator kNONE_to_FLEXCOMM6: Attach NONE to FLEXCOMM6.

enumerator kMAIN_CLK_to_FLEXCOMM7: Attach MAIN_CLK to FLEXCOMM7.

enumerator kPLL0_DIV_to_FLEXCOMM7: Attach PLL0_DIV to FLEXCOMM7.

enumerator kFRO12M_to_FLEXCOMM7: Attach FRO12M to FLEXCOMM7.

enumerator kFRO_HF_DIV_to_FLEXCOMM7: Attach FRO_HF_DIV to FLEXCOMM7.

enumerator kFRO1M_to_FLEXCOMM7: Attach FRO1M to FLEXCOMM7.

enumerator kMCLK_to_FLEXCOMM7: Attach MCLK to FLEXCOMM7.

enumerator kOSC32K_to_FLEXCOMM7: Attach OSC32K to FLEXCOMM7.

enumerator kNONE_to_FLEXCOMM7: Attach NONE to FLEXCOMM7.

enumerator kMAIN_CLK_to_HSLSPI: Attach MAIN_CLK to HSLSPI.

enumerator kPLL0_DIV_to_HSLSPI: Attach PLL0_DIV to HSLSPI.

enumerator kFRO12M_to_HSLSPI: Attach FRO12M to HSLSPI.

enumerator kFRO_HF_DIV_to_HSLSPI: Attach FRO_HF_DIV to HSLSPI.

enumerator kFRO1M_to_HSLSPI: Attach FRO1M to HSLSPI.

enumerator kOSC32K_to_HSLSPI: Attach OSC32K to HSLSPI.

enumerator kNONE_to_HSLSPI: Attach NONE to HSLSPI.

enumerator kFRO_HF_to_MCLK: Attach FRO_HF to MCLK.

enumerator kPLL0_to_MCLK: Attach PLL0 to MCLK.

enumerator kNONE_to_MCLK: Attach NONE to MCLK.

enumerator kMAIN_CLK_to_SCT_CLK: Attach MAIN_CLK to SCT_CLK.

enumerator kPLL0_to_SCT_CLK: Attach PLL0 to SCT_CLK.

enumerator kEXT_CLK_to_SCT_CLK: Attach EXT_CLK to SCT_CLK.

enumerator kFRO_HF_to_SCT_CLK: Attach FRO_HF to SCT_CLK.

enumerator kMCLK_to_SCT_CLK: Attach MCLK to SCT_CLK.

enumerator kNONE_to_SCT_CLK: Attach NONE to SCT_CLK.

enumerator kFRO32K_to_OSC32K: Attach FRO32K to OSC32K.

enumerator kXTAL32K_to_OSC32K: Attach XTAL32K to OSC32K.

enumerator kOSC32K_to_OSTIMER: Attach OSC32K to OSTIMER.

enumerator kFRO1M_to_OSTIMER: Attach FRO1M to OSTIMER.

enumerator kMAIN_CLK_to_OSTIMER: Attach MAIN_CLK to OSTIMER.

enumerator kTRACE_DIV_to_TRACE: Attach TRACE_DIV to TRACE.

enumerator kFRO1M_to_TRACE: Attach FRO1M to TRACE.

enumerator kOSC32K_to_TRACE: Attach OSC32K to TRACE.

enumerator kNONE_to_TRACE: Attach NONE to TRACE.

enumerator kSYSTICK_DIV0_to_SYSTICK0: Attach SYSTICK_DIV0 to SYSTICK0.

enumerator kFRO1M_to_SYSTICK0: Attach FRO1M to SYSTICK0.

enumerator kOSC32K_to_SYSTICK0: Attach OSC32K to SYSTICK0.

enumerator kNONE_to_SYSTICK0: Attach NONE to SYSTICK0.

enumerator kFRO12M_to_PLL1: Attach FRO12M to PLL1.

enumerator kEXT_CLK_to_PLL1: Attach EXT_CLK to PLL1.

enumerator kFRO1M_to_PLL1: Attach FRO1M to PLL1.

enumerator kOSC32K_to_PLL1: Attach OSC32K to PLL1.

enumerator kNONE_to_PLL1: Attach NONE to PLL1.

enumerator kMAIN_CLK_to_CTIMER0: Attach MAIN_CLK to CTIMER0.

enumerator kPLL0_to_CTIMER0: Attach PLL0 to CTIMER0.

enumerator kFRO_HF_to_CTIMER0: Attach FRO_HF to CTIMER0.

enumerator kFRO1M_to_CTIMER0: Attach FRO1M to CTIMER0.

enumerator kMCLK_to_CTIMER0: Attach MCLK to CTIMER0.

enumerator kOSC32K_to_CTIMER0: Attach OSC32K to CTIMER0.

enumerator kNONE_to_CTIMER0: Attach NONE to CTIMER0.

enumerator kMAIN_CLK_to_CTIMER1: Attach MAIN_CLK to CTIMER1.

enumerator kPLL0_to_CTIMER1: Attach PLL0 to CTIMER1.

enumerator kFRO_HF_to_CTIMER1: Attach FRO_HF to CTIMER1.

enumerator kFRO1M_to_CTIMER1: Attach FRO1M to CTIMER1.

enumerator kMCLK_to_CTIMER1: Attach MCLK to CTIMER1.

enumerator kOSC32K_to_CTIMER1: Attach OSC32K to CTIMER1.

enumerator kNONE_to_CTIMER1: Attach NONE to CTIMER1.

enumerator kMAIN_CLK_to_CTIMER2: Attach MAIN_CLK to CTIMER2.

enumerator kPLL0_to_CTIMER2: Attach PLL0 to CTIMER2.

enumerator kFRO_HF_to_CTIMER2: Attach FRO_HF to CTIMER2.

enumerator kFRO1M_to_CTIMER2: Attach FRO1M to CTIMER2.

enumerator kMCLK_to_CTIMER2: Attach MCLK to CTIMER2.

enumerator kOSC32K_to_CTIMER2: Attach OSC32K to CTIMER2.

enumerator kNONE_to_CTIMER2: Attach NONE to CTIMER2.

enumerator kMAIN_CLK_to_CTIMER3: Attach MAIN_CLK to CTIMER3.

enumerator kPLL0_to_CTIMER3: Attach PLL0 to CTIMER3.

enumerator kFRO_HF_to_CTIMER3: Attach FRO_HF to CTIMER3.

enumerator kFRO1M_to_CTIMER3: Attach FRO1M to CTIMER3.

enumerator kMCLK_to_CTIMER3: Attach MCLK to CTIMER3.

enumerator kOSC32K_to_CTIMER3: Attach OSC32K to CTIMER3.

enumerator kNONE_to_CTIMER3: Attach NONE to CTIMER3.

enumerator kMAIN_CLK_to_CTIMER4: Attach MAIN_CLK to CTIMER4.

enumerator kPLL0_to_CTIMER4: Attach PLL0 to CTIMER4.

enumerator kFRO_HF_to_CTIMER4: Attach FRO_HF to CTIMER4.

enumerator kFRO1M_to_CTIMER4: Attach FRO1M to CTIMER4.

enumerator kMCLK_to_CTIMER4: Attach MCLK to CTIMER4.

enumerator kOSC32K_to_CTIMER4: Attach OSC32K to CTIMER4.

enumerator kNONE_to_CTIMER4: Attach NONE to CTIMER4.

enumerator kNONE_to_NONE: Attach NONE to NONE.

enum _clock_div_name

Clock dividers.

Values:

enumerator kCLOCK_DivSystickClk0: Systick Clk0 Divider.

enumerator kCLOCK_DivArmTrClkDiv: Arm Tr Clk Div Divider.

enumerator kCLOCK_DivCanClk: Can Clock Divider.

enumerator kCLOCK_DivFlexFrg0: Flex Frg0 Divider.

enumerator kCLOCK_DivFlexFrg1: Flex Frg1 Divider.

enumerator kCLOCK_DivFlexFrg2: Flex Frg2 Divider.

enumerator kCLOCK_DivFlexFrg3: Flex Frg3 Divider.

enumerator kCLOCK_DivFlexFrg4: Flex Frg4 Divider.

enumerator kCLOCK_DivFlexFrg5: Flex Frg5 Divider.

enumerator kCLOCK_DivFlexFrg6: Flex Frg6 Divider.

enumerator kCLOCK_DivFlexFrg7: Flex Frg7 Divider.

enumerator kCLOCK_DivAhbClk: Ahb Clock Divider.

enumerator kCLOCK_DivClkOut: Clk Out Divider.

enumerator kCLOCK_DivFrohfClk: Frohf Clock Divider.

enumerator kCLOCK_DivWdtClk: Wdt Clock Divider.

enumerator kCLOCK_DivAdcAsyncClk: Adc Async Clock Divider.

enumerator kCLOCK_DivFro1mClk: Fro1m Clock Divider.

enumerator kCLOCK_DivMClk: I2S MCLK Clock Divider.

enumerator kCLOCK_DivSctClk: Sct Clock Divider.

enumerator kCLOCK_DivPll0Clk: PLL0 clock divider.

enum _ss_progmodfm

PLL Spread Spectrum (SS) Programmable modulation frequency See (MF) field in the PLL0SSCG1 register in the UM.

Values:

enumerator kSS_MF_512: Nss = 512 (fm ? 3.9 - 7.8 kHz)

enumerator kSS_MF_384: Nss ?= 384 (fm ? 5.2 - 10.4 kHz)

enumerator kSS_MF_256: Nss = 256 (fm ? 7.8 - 15.6 kHz)

enumerator kSS_MF_128: Nss = 128 (fm ? 15.6 - 31.3 kHz)

enumerator kSS_MF_64: Nss = 64 (fm ? 32.3 - 64.5 kHz)

enumerator kSS_MF_32: Nss = 32 (fm ? 62.5- 125 kHz)

enumerator kSS_MF_24: Nss ?= 24 (fm ? 83.3- 166.6 kHz)

enumerator kSS_MF_16: Nss = 16 (fm ? 125- 250 kHz)

enum _ss_progmoddp

PLL Spread Spectrum (SS) Programmable frequency modulation depth See (MR) field in the PLL0SSCG1 register in the UM.

Values:

enumerator kSS_MR_K0: k = 0 (no spread spectrum)

enumerator kSS_MR_K1: k = 1

enumerator kSS_MR_K1_5: k = 1.5

enumerator kSS_MR_K2: k = 2

enumerator kSS_MR_K3: k = 3

enumerator kSS_MR_K4: k = 4

enumerator kSS_MR_K6: k = 6

enumerator kSS_MR_K8: k = 8

enum _ss_modwvctrl

PLL Spread Spectrum (SS) Modulation waveform control See (MC) field in the PLL0SSCG1 register in the UM.

Compensation for low pass filtering of the PLL to get a triangular modulation at the output of the PLL, giving a flat frequency spectrum.

Values:

enumerator kSS_MC_NOC: no compensation

enumerator kSS_MC_RECC: recommended setting

enumerator kSS_MC_MAXC: max. compensation

enum _pll_error

PLL status definitions.

Values:

enumerator kStatus_PLL_Success: PLL operation was successful

enumerator kStatus_PLL_OutputTooLow: PLL output rate request was too low

enumerator kStatus_PLL_OutputTooHigh: PLL output rate request was too high

enumerator kStatus_PLL_InputTooLow: PLL input rate is too low

enumerator kStatus_PLL_InputTooHigh: PLL input rate is too high

enumerator kStatus_PLL_OutsideIntLimit: Requested output rate isn’t possible

enumerator kStatus_PLL_CCOTooLow: Requested CCO rate isn’t possible

enumerator kStatus_PLL_CCOTooHigh: Requested CCO rate isn’t possible

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_attach_id clock_attach_id_t: The enumerator of clock attach Id.

typedef enum _clock_div_name clock_div_name_t: Clock dividers.

typedef enum _ss_progmodfm ss_progmodfm_t: PLL Spread Spectrum (SS) Programmable modulation frequency See (MF) field in the PLL0SSCG1 register in the UM.

typedef enum _ss_progmoddp ss_progmoddp_t: PLL Spread Spectrum (SS) Programmable frequency modulation depth See (MR) field in the PLL0SSCG1 register in the UM.

typedef enum _ss_modwvctrl ss_modwvctrl_t

PLL Spread Spectrum (SS) Modulation waveform control See (MC) field in the PLL0SSCG1 register in the UM.

Compensation for low pass filtering of the PLL to get a triangular modulation at the output of the PLL, giving a flat frequency spectrum.

typedef struct _pll_config pll_config_t

PLL configuration structure.

This structure can be used to configure the settings for a PLL setup structure. Fill in the desired configuration for the PLL and call the PLL setup function to fill in a PLL setup structure.

typedef struct _pll_setup pll_setup_t: PLL0 setup structure This structure can be used to pre-build a PLL setup configuration at run-time and quickly set the PLL to the configuration. It can be populated with the PLL setup function. If powering up or waiting for PLL lock, the PLL input clock source should be configured prior to PLL setup.

typedef enum _pll_error pll_error_t: PLL status definitions.

static inline void CLOCK_EnableClock(clock_ip_name_t clk)

Enable the clock for specific IP.

Parameters:

clk – : Clock to be enabled.

Returns:

Nothing

static inline void CLOCK_DisableClock(clock_ip_name_t clk)

Disable the clock for specific IP.

Parameters:

clk – : Clock to be Disabled.

Returns:

Nothing

status_t CLOCK_SetupFROClocking(uint32_t iFreq)

Initialize the Core clock to given frequency (12, 48 or 96 MHz). Turns on FRO and uses default CCO, if freq is 12000000, then high speed output is off, else high speed output is enabled.

Parameters:

iFreq – : Desired frequency (must be one of CLK_FRO_12MHZ or CLK_FRO_48MHZ or CLK_FRO_96MHZ)

Returns:

returns success or fail status.

void CLOCK_SetFLASHAccessCyclesForFreq(uint32_t system_freq_hz)

Set the flash wait states for the input freuqency.

Parameters:

system_freq_hz – : Input frequency

Returns:

Nothing

status_t CLOCK_SetupExtClocking(uint32_t iFreq)

Initialize the external osc clock to given frequency.

Parameters:

iFreq – : Desired frequency (must be equal to exact rate in Hz)

Returns:

returns success or fail status.

status_t CLOCK_SetupI2SMClkClocking(uint32_t iFreq)

Initialize the I2S MCLK clock to given frequency.

Parameters:

iFreq – : Desired frequency (must be equal to exact rate in Hz)

Returns:

returns success or fail status.

status_t CLOCK_SetupPLUClkInClocking(uint32_t iFreq)

Initialize the PLU CLKIN clock to given frequency.

Parameters:

iFreq – : Desired frequency (must be equal to exact rate in Hz)

Returns:

returns success or fail status.

void CLOCK_AttachClk(clock_attach_id_t connection)

Configure the clock selection muxes.

Parameters:

connection – : Clock to be configured.

Returns:

Nothing

clock_attach_id_t CLOCK_GetClockAttachId(clock_attach_id_t attachId)

Get the actual clock attach id. This fuction uses the offset in input attach id, then it reads the actual source value in the register and combine the offset to obtain an actual attach id.

Parameters:

attachId – : Clock attach id to get.

Returns:

Clock source value.

void CLOCK_SetClkDiv(clock_div_name_t div_name, uint32_t divided_by_value, bool reset)

Setup peripheral clock dividers.

Parameters:

div_name – : Clock divider name
divided_by_value – Value to be divided
reset – : Whether to reset the divider counter.

Returns:

Nothing

void CLOCK_SetRtc1khzClkDiv(uint32_t divided_by_value)

Setup rtc 1khz clock divider.

Parameters:

divided_by_value – Value to be divided

Returns:

Nothing

void CLOCK_SetRtc1hzClkDiv(uint32_t divided_by_value)

Setup rtc 1hz clock divider.

Parameters:

divided_by_value – Value to be divided

Returns:

Nothing

uint32_t CLOCK_SetFlexCommClock(uint32_t id, uint32_t freq)

Set the flexcomm output frequency.

Parameters:

id – : flexcomm instance id
freq – : output frequency

Returns:

0 : the frequency range is out of range. 1 : switch successfully.

uint32_t CLOCK_GetFlexCommInputClock(uint32_t id)

Return Frequency of flexcomm input clock.

Parameters:

id – : flexcomm instance id

Returns:

Frequency value

uint32_t CLOCK_GetFreq(clock_name_t clockName)

Return Frequency of selected clock.

Returns:: Frequency of selected clock

uint32_t CLOCK_GetFro12MFreq(void)

Return Frequency of FRO 12MHz.

Returns:: Frequency of FRO 12MHz

uint32_t CLOCK_GetFro1MFreq(void)

Return Frequency of FRO 1MHz.

Returns:: Frequency of FRO 1MHz

uint32_t CLOCK_GetClockOutClkFreq(void)

Return Frequency of ClockOut.

Returns:: Frequency of ClockOut

uint32_t CLOCK_GetMCanClkFreq(void)

Return Frequency of Can Clock.

Returns:: Frequency of Can.

uint32_t CLOCK_GetAdcClkFreq(void)

Return Frequency of Adc Clock.

Returns:: Frequency of Adc.

uint32_t CLOCK_GetMclkClkFreq(void)

Return Frequency of MClk Clock.

Returns:: Frequency of MClk Clock.

uint32_t CLOCK_GetSctClkFreq(void)

Return Frequency of SCTimer Clock.

Returns:: Frequency of SCTimer Clock.

uint32_t CLOCK_GetExtClkFreq(void)

Return Frequency of External Clock.

Returns:: Frequency of External Clock. If no external clock is used returns 0.

uint32_t CLOCK_GetWdtClkFreq(void)

Return Frequency of Watchdog.

Returns:: Frequency of Watchdog

uint32_t CLOCK_GetFroHfFreq(void)

Return Frequency of High-Freq output of FRO.

Returns:: Frequency of High-Freq output of FRO

uint32_t CLOCK_GetPll0OutFreq(void)

Return Frequency of PLL.

Returns:: Frequency of PLL

uint32_t CLOCK_GetPll1OutFreq(void)

Return Frequency of USB PLL.

Returns:: Frequency of PLL

uint32_t CLOCK_GetOsc32KFreq(void)

Return Frequency of 32kHz osc.

Returns:: Frequency of 32kHz osc

uint32_t CLOCK_GetCoreSysClkFreq(void)

Return Frequency of Core System.

Returns:: Frequency of Core System

uint32_t CLOCK_GetI2SMClkFreq(void)

Return Frequency of I2S MCLK Clock.

Returns:: Frequency of I2S MCLK Clock

uint32_t CLOCK_GetPLUClkInFreq(void)

Return Frequency of PLU CLKIN Clock.

Returns:: Frequency of PLU CLKIN Clock

uint32_t CLOCK_GetFlexCommClkFreq(uint32_t id)

Return Frequency of FlexComm Clock.

Returns:: Frequency of FlexComm Clock

uint32_t CLOCK_GetHsLspiClkFreq(void)

Return Frequency of High speed SPI Clock.

Returns:: Frequency of High speed SPI Clock

uint32_t CLOCK_GetCTimerClkFreq(uint32_t id)

Return Frequency of CTimer functional Clock.

Returns:: Frequency of CTimer functional Clock

uint32_t CLOCK_GetSystickClkFreq(uint32_t id)

Return Frequency of SystickClock.

Returns:: Frequency of Systick Clock

uint32_t CLOCK_GetPLL0InClockRate(void)

Return PLL0 input clock rate.

Returns:: PLL0 input clock rate

uint32_t CLOCK_GetPLL1InClockRate(void)

Return PLL1 input clock rate.

Returns:: PLL1 input clock rate

uint32_t CLOCK_GetPLL0OutClockRate(bool recompute)

Return PLL0 output clock rate.

Note

The PLL rate is cached in the driver in a variable as the rate computation function can take some time to perform. It is recommended to use ‘false’ with the ‘recompute’ parameter.

Parameters:

recompute – : Forces a PLL rate recomputation if true

Returns:

PLL0 output clock rate

uint32_t CLOCK_GetPLL1OutClockRate(bool recompute)

Return PLL1 output clock rate.

Note

The PLL rate is cached in the driver in a variable as the rate computation function can take some time to perform. It is recommended to use ‘false’ with the ‘recompute’ parameter.

Parameters:

recompute – : Forces a PLL rate recomputation if true

Returns:

PLL1 output clock rate

__STATIC_INLINE void CLOCK_SetBypassPLL0 (bool bypass)

Enables and disables PLL0 bypass mode.

bypass : true to bypass PLL0 (PLL0 output = PLL0 input, false to disable bypass

Returns:: PLL0 output clock rate

__STATIC_INLINE void CLOCK_SetBypassPLL1 (bool bypass)

Enables and disables PLL1 bypass mode.

bypass : true to bypass PLL1 (PLL1 output = PLL1 input, false to disable bypass

Returns:: PLL1 output clock rate

__STATIC_INLINE bool CLOCK_IsPLL0Locked (void)

Check if PLL is locked or not.

Returns:: true if the PLL is locked, false if not locked

__STATIC_INLINE bool CLOCK_IsPLL1Locked (void)

Check if PLL1 is locked or not.

Returns:: true if the PLL1 is locked, false if not locked

void CLOCK_SetStoredPLL0ClockRate(uint32_t rate)

Store the current PLL0 rate.

Parameters:

rate – Current rate of the PLL0

Returns:

Nothing

uint32_t CLOCK_GetPLL0OutFromSetup(pll_setup_t *pSetup)

Return PLL0 output clock rate from setup structure.

Parameters:

pSetup – : Pointer to a PLL setup structure

Returns:

System PLL output clock rate the setup structure will generate

uint32_t CLOCK_GetPLL1OutFromSetup(pll_setup_t *pSetup)

Return PLL1 output clock rate from setup structure.

Parameters:

pSetup – : Pointer to a PLL setup structure

Returns:

PLL0 output clock rate the setup structure will generate

pll_error_t CLOCK_SetupPLL0Data(pll_config_t *pControl, pll_setup_t *pSetup)

Set PLL0 output based on the passed PLL setup data.

Note

Actual frequency for setup may vary from the desired frequency based on the accuracy of input clocks, rounding, non-fractional PLL mode, etc.

Parameters:

pControl – : Pointer to populated PLL control structure to generate setup with
pSetup – : Pointer to PLL setup structure to be filled

Returns:

PLL_ERROR_SUCCESS on success, or PLL setup error code

pll_error_t CLOCK_SetupPLL0Prec(pll_setup_t *pSetup, uint32_t flagcfg)

Set PLL output from PLL setup structure (precise frequency)

Note

This function will power off the PLL, setup the PLL with the new setup data, and then optionally powerup the PLL, wait for PLL lock, and adjust system voltages to the new PLL rate. The function will not alter any source clocks (ie, main systen clock) that may use the PLL, so these should be setup prior to and after exiting the function.

Parameters:

pSetup – : Pointer to populated PLL setup structure
flagcfg – : Flag configuration for PLL config structure

Returns:

PLL_ERROR_SUCCESS on success, or PLL setup error code

pll_error_t CLOCK_SetPLL0Freq(const pll_setup_t *pSetup)

Set PLL output from PLL setup structure (precise frequency)

Note

This function will power off the PLL, setup the PLL with the new setup data, and then optionally powerup the PLL, wait for PLL lock, and adjust system voltages to the new PLL rate. The function will not alter any source clocks (ie, main systen clock) that may use the PLL, so these should be setup prior to and after exiting the function.

Parameters:

pSetup – : Pointer to populated PLL setup structure

Returns:

kStatus_PLL_Success on success, or PLL setup error code

pll_error_t CLOCK_SetPLL1Freq(const pll_setup_t *pSetup)

Set PLL output from PLL setup structure (precise frequency)

Note

This function will power off the PLL, setup the PLL with the new setup data, and then optionally powerup the PLL, wait for PLL lock, and adjust system voltages to the new PLL rate. The function will not alter any source clocks (ie, main systen clock) that may use the PLL, so these should be setup prior to and after exiting the function.

Parameters:

pSetup – : Pointer to populated PLL setup structure

Returns:

kStatus_PLL_Success on success, or PLL setup error code

void CLOCK_SetupPLL0Mult(uint32_t multiply_by, uint32_t input_freq)

Set PLL0 output based on the multiplier and input frequency.

Note

Unlike the Chip_Clock_SetupSystemPLLPrec() function, this function does not disable or enable PLL power, wait for PLL lock, or adjust system voltages. These must be done in the application. The function will not alter any source clocks (ie, main systen clock) that may use the PLL, so these should be setup prior to and after exiting the function.

Parameters:

multiply_by – : multiplier
input_freq – : Clock input frequency of the PLL

Returns:

Nothing

void CLOCK_EnableOstimer32kClock(void)

Enable the OSTIMER 32k clock.

Returns:: Nothing

FSL_CLOCK_DRIVER_VERSION: CLOCK driver version 2.3.8.

FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL

Configure whether driver controls clock.

When set to 0, peripheral drivers will enable clock in initialize function and disable clock in de-initialize function. When set to 1, peripheral driver will not control the clock, application could control the clock out of the driver.

Note

All drivers share this feature switcher. If it is set to 1, application should handle clock enable and disable for all drivers.

CLOCK_USR_CFG_PLL_CONFIG_CACHE_COUNT

User-defined the size of cache for CLOCK_PllGetConfig() function.

Once define this MACRO to be non-zero value, CLOCK_PllGetConfig() function would cache the recent calulation and accelerate the execution to get the right settings.

SDK_DEVICE_MAXIMUM_CPU_CLOCK_FREQUENCY

ROM_CLOCKS: Clock ip name array for ROM.

SRAM_CLOCKS: Clock ip name array for SRAM.

FLASH_CLOCKS: Clock ip name array for FLASH.

FMC_CLOCKS: Clock ip name array for FMC.

INPUTMUX_CLOCKS: Clock ip name array for INPUTMUX.

IOCON_CLOCKS: Clock ip name array for IOCON.

GPIO_CLOCKS: Clock ip name array for GPIO.

PINT_CLOCKS: Clock ip name array for PINT.

GINT_CLOCKS: Clock ip name array for GINT.

DMA_CLOCKS: Clock ip name array for DMA.

CRC_CLOCKS: Clock ip name array for CRC.

WWDT_CLOCKS: Clock ip name array for WWDT.

RTC_CLOCKS: Clock ip name array for RTC.

MAILBOX_CLOCKS: Clock ip name array for Mailbox.

LPADC_CLOCKS: Clock ip name array for LPADC.

MRT_CLOCKS: Clock ip name array for MRT.

OSTIMER_CLOCKS: Clock ip name array for OSTIMER.

SCT_CLOCKS: Clock ip name array for SCT0.

MCAN_CLOCKS: Clock ip name array for MCAN.

UTICK_CLOCKS: Clock ip name array for UTICK.

FLEXCOMM_CLOCKS: Clock ip name array for FLEXCOMM.

LPUART_CLOCKS: Clock ip name array for LPUART.

BI2C_CLOCKS: Clock ip name array for BI2C.

LPSPI_CLOCKS: Clock ip name array for LSPI.

FLEXI2S_CLOCKS: Clock ip name array for FLEXI2S.

CTIMER_CLOCKS: Clock ip name array for CTIMER.

COMP_CLOCKS: Clock ip name array for COMP.

FREQME_CLOCKS: Clock ip name array for FREQME.

CDOG_CLOCKS: Clock ip name array for CDOG.

RNG_CLOCKS: Clock ip name array for RNG.

HASHCRYPT_CLOCKS: Clock ip name array for HashCrypt.

PLULUT_CLOCKS: Clock ip name array for PLULUT.

PUF_CLOCKS: Clock ip name array for PUF.

CASPER_CLOCKS: Clock ip name array for CASPER.

ANALOGCTRL_CLOCKS: Clock ip name array for ANALOGCTRL.

HS_LSPI_CLOCKS: Clock ip name array for HS_LSPI.

GPIO_SEC_CLOCKS: Clock ip name array for GPIO_SEC.

GPIO_SEC_INT_CLOCKS: Clock ip name array for GPIO_SEC_INT.

PLU_CLOCKS

SYSCTL_CLOCKS

CLK_GATE_REG_OFFSET_SHIFT: Clock gate name used for CLOCK_EnableClock/CLOCK_DisableClock.

CLK_GATE_REG_OFFSET_MASK

CLK_GATE_BIT_SHIFT_SHIFT

CLK_GATE_BIT_SHIFT_MASK

CLK_GATE_DEFINE(reg_offset, bit_shift)

CLK_GATE_ABSTRACT_REG_OFFSET(x)

CLK_GATE_ABSTRACT_BITS_SHIFT(x)

AHB_CLK_CTRL0

AHB_CLK_CTRL1

AHB_CLK_CTRL2

BUS_CLK: Peripherals clock source definition.

I2C0_CLK_SRC

CLK_ATTACH_ID(mux, sel, pos)

Clock Mux Switches The encoding is as follows each connection identified is 32bits wide while 24bits are valuable starting from LSB upwards.

[4 bits for choice, 0 means invalid choice] [8 bits mux ID]*

MUX_A(mux, sel)

MUX_B(mux, sel, selector)

GET_ID_ITEM(connection)

GET_ID_NEXT_ITEM(connection)

GET_ID_ITEM_MUX(connection)

GET_ID_ITEM_SEL(connection)

GET_ID_SELECTOR(connection)

CM_SYSTICKCLKSEL0

CM_TRACECLKSEL

CM_CTIMERCLKSEL0

CM_CTIMERCLKSEL1

CM_CTIMERCLKSEL2

CM_CTIMERCLKSEL3

CM_CTIMERCLKSEL4

CM_MAINCLKSELA

CM_MAINCLKSELB

CM_CLKOUTCLKSEL

CM_PLL0CLKSEL

CM_PLL1CLKSEL

CM_MCANCLKSEL

CM_ADCASYNCCLKSEL

CM_CLK32KCLKSEL

CM_FXCOMCLKSEL0

CM_FXCOMCLKSEL1

CM_FXCOMCLKSEL2

CM_FXCOMCLKSEL3

CM_FXCOMCLKSEL4

CM_FXCOMCLKSEL5

CM_FXCOMCLKSEL6

CM_FXCOMCLKSEL7

CM_HSLSPICLKSEL

CM_MCLKCLKSEL

CM_SCTCLKSEL

CM_OSTIMERCLKSEL

CM_RTCOSC32KCLKSEL

PLL_CONFIGFLAG_USEINRATE

PLL configuration structure flags for ‘flags’ field These flags control how the PLL configuration function sets up the PLL setup structure.

When the PLL_CONFIGFLAG_USEINRATE flag is selected, the ‘InputRate’ field in the configuration structure must be assigned with the expected PLL frequency. If the PLL_CONFIGFLAG_USEINRATE is not used, ‘InputRate’ is ignored in the configuration function and the driver will determine the PLL rate from the currently selected PLL source. This flag might be used to configure the PLL input clock more accurately when using the WDT oscillator or a more dyanmic CLKIN source.

When the PLL_CONFIGFLAG_FORCENOFRACT flag is selected, the PLL hardware for the automatic bandwidth selection, Spread Spectrum (SS) support, and fractional M-divider are not used.

Flag to use InputRate in PLL configuration structure for setup

PLL_CONFIGFLAG_FORCENOFRACT: Force non-fractional output mode, PLL output will not use the fractional, automatic bandwidth, or SS hardware

PLL_SETUPFLAG_POWERUP

PLL setup structure flags for ‘flags’ field These flags control how the PLL setup function sets up the PLL.

Setup will power on the PLL after setup

PLL_SETUPFLAG_WAITLOCK: Setup will wait for PLL lock, implies the PLL will be pwoered on

PLL_SETUPFLAG_ADGVOLT: Optimize system voltage for the new PLL rate

PLL_SETUPFLAG_USEFEEDBACKDIV2: Use feedback divider by 2 in divider path

uint32_t desiredRate: Desired PLL rate in Hz

uint32_t inputRate: PLL input clock in Hz, only used if PLL_CONFIGFLAG_USEINRATE flag is set

uint32_t flags: PLL configuration flags, Or’ed value of PLL_CONFIGFLAG_* definitions

ss_progmodfm_t ss_mf: SS Programmable modulation frequency, only applicable when not using PLL_CONFIGFLAG_FORCENOFRACT flag

ss_progmoddp_t ss_mr: SS Programmable frequency modulation depth, only applicable when not using PLL_CONFIGFLAG_FORCENOFRACT flag

ss_modwvctrl_t ss_mc: SS Modulation waveform control, only applicable when not using PLL_CONFIGFLAG_FORCENOFRACT flag

bool mfDither: false for fixed modulation frequency or true for dithering, only applicable when not using PLL_CONFIGFLAG_FORCENOFRACT flag

uint32_t pllctrl: PLL control register PLL0CTRL

uint32_t pllndec: PLL NDEC register PLL0NDEC

uint32_t pllpdec: PLL PDEC register PLL0PDEC

uint32_t pllmdec: PLL MDEC registers PLL0PDEC

uint32_t pllsscg[2]: PLL SSCTL registers PLL0SSCG

uint32_t pllRate: Acutal PLL rate

uint32_t flags: PLL setup flags, Or’ed value of PLL_SETUPFLAG_* definitions

struct _pll_config

#include <fsl_clock.h>

PLL configuration structure.

This structure can be used to configure the settings for a PLL setup structure. Fill in the desired configuration for the PLL and call the PLL setup function to fill in a PLL setup structure.

struct _pll_setup: #include <fsl_clock.h>

PLL0 setup structure This structure can be used to pre-build a PLL setup configuration at run-time and quickly set the PLL to the configuration. It can be populated with the PLL setup function. If powering up or waiting for PLL lock, the PLL input clock source should be configured prior to PLL setup.

CMP: Analog Comparator Driver

void CMP_Init(const cmp_config_t *config)

CMP initialization.

This function enables the CMP module and do necessary settings.

Parameters:

config – Pointer to the configuration structure.

void CMP_Deinit(void)

CMP deinitialization.

This function gates the clock for CMP module.

void CMP_GetDefaultConfig(cmp_config_t *config)

Initializes the CMP user configuration structure.

This function initializes the user configuration structure to these default values.

config->enableHysteresis    = true;
config->enableLowPower      = true;
config->filterClockDivider  = kCMP_FilterClockDivide1;
config->filterSampleMode    = kCMP_FilterSampleMode0;

Parameters:

config – Pointer to the configuration structure.

static inline void CMP_SetInputChannels(uint8_t positiveChannel, uint8_t negativeChannel)

void CMP_SetVREF(const cmp_vref_config_t *config)

Configures the VREFINPUT.

Parameters:

config – Pointer to the configuration structure.

static inline bool CMP_GetOutput(void)

Get CMP compare output.

Returns:: The output result. true: voltage on positive side is greater than negative side. false: voltage on positive side is lower than negative side.

static inline void CMP_EnableInterrupt(uint32_t type)

CMP enable interrupt.

Parameters:

type – CMP interrupt type. See “_cmp_interrupt_type”.

static inline void CMP_DisableInterrupt(void): CMP disable interrupt.

static inline void CMP_ClearInterrupt(void): CMP clear interrupt.

static inline void CMP_EnableFilteredInterruptSource(bool enable)

Select which Analog comparator output (filtered or un-filtered) is used for interrupt detection.

Note

: When CMP is configured as the wakeup source in power down mode, this function must use the raw output as the interupt source, that is, call this function and set parameter enable to false.

Parameters:

enable – false: Select Analog Comparator raw output (unfiltered) as input for interrupt detection. true: Select Analog Comparator filtered output as input for interrupt detection.

static inline bool CMP_GetPreviousInterruptStatus(void)

Get CMP interrupt status before interupt enable.

Returns:: Interrupt status. true: interrupt pending, false: no interrupt pending.

static inline bool CMP_GetInterruptStatus(void)

Get CMP interrupt status after interupt enable.

Returns:: Interrupt status. true: interrupt pending, false: no interrupt pending.

static inline void CMP_FilterSampleConfig(cmp_filtercgf_samplemode_t filterSampleMode, cmp_filtercgf_clkdiv_t filterClockDivider)

CMP Filter Sample Config.

This function allows the users to configure the sampling mode and clock divider of the CMP Filter.

Parameters:

filterSampleMode – CMP Select filter sample mode
filterClockDivider – CMP Set fileter clock divider

FSL_CMP_DRIVER_VERSION: Driver version 2.2.1.

enum _cmp_input_mux

CMP input mux for positive and negative sides.

Values:

enumerator kCMP_InputVREF: Cmp input from VREF.

enumerator kCMP_Input1: Cmp input source 1.

enumerator kCMP_Input2: Cmp input source 2.

enumerator kCMP_Input3: Cmp input source 3.

enumerator kCMP_Input4: Cmp input source 4.

enumerator kCMP_Input5: Cmp input source 5.

enum _cmp_interrupt_type

CMP interrupt type.

Values:

enumerator kCMP_EdgeDisable: Disable edge interupt.

enumerator kCMP_EdgeRising: Interrupt on falling edge.

enumerator kCMP_EdgeFalling: Interrupt on rising edge.

enumerator kCMP_EdgeRisingFalling: Interrupt on both rising and falling edges.

enumerator kCMP_LevelDisable: Disable level interupt.

enumerator kCMP_LevelHigh: Interrupt on high level.

enumerator kCMP_LevelLow: Interrupt on low level.

enum _cmp_vref_source

CMP Voltage Reference source.

Values:

enumerator KCMP_VREFSourceVDDA: Select VDDA as VREF.

enumerator KCMP_VREFSourceInternalVREF: Select internal VREF as VREF.

enum _cmp_filtercgf_samplemode

CMP Filter sample mode.

Values:

enumerator kCMP_FilterSampleMode0: Bypass mode. Filtering is disabled.

enumerator kCMP_FilterSampleMode1: Filter 1 clock period.

enumerator kCMP_FilterSampleMode2: Filter 2 clock period.

enumerator kCMP_FilterSampleMode3: Filter 3 clock period.

enum _cmp_filtercgf_clkdiv

CMP Filter clock divider.

Values:

enumerator kCMP_FilterClockDivide1: Filter clock period duration equals 1 analog comparator clock period.

enumerator kCMP_FilterClockDivide2: Filter clock period duration equals 2 analog comparator clock period.

enumerator kCMP_FilterClockDivide4: Filter clock period duration equals 4 analog comparator clock period.

enumerator kCMP_FilterClockDivide8: Filter clock period duration equals 8 analog comparator clock period.

enumerator kCMP_FilterClockDivide16: Filter clock period duration equals 16 analog comparator clock period.

enumerator kCMP_FilterClockDivide32: Filter clock period duration equals 32 analog comparator clock period.

enumerator kCMP_FilterClockDivide64: Filter clock period duration equals 64 analog comparator clock period.

typedef enum _cmp_vref_source cmp_vref_source_t: CMP Voltage Reference source.

typedef struct _cmp_vref_config cmp_vref_config_t

typedef enum _cmp_filtercgf_samplemode cmp_filtercgf_samplemode_t: CMP Filter sample mode.

typedef enum _cmp_filtercgf_clkdiv cmp_filtercgf_clkdiv_t: CMP Filter clock divider.

typedef struct _cmp_config cmp_config_t: CMP configuration structure.

struct _cmp_vref_config

#include <fsl_cmp.h>

Public Members

cmp_vref_source_t vrefSource: Reference voltage source.

uint8_t vrefValue: Reference voltage step. Available range is 0-31. Per step equals to VREFINPUT/31.

struct _cmp_config

#include <fsl_cmp.h>

CMP configuration structure.

Public Members

bool enableHysteresis: Enable hysteresis.

bool enableLowPower: Enable low power mode.

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.

CTIMER: Standard counter/timers

void CTIMER_Init(CTIMER_Type *base, const ctimer_config_t *config)

Ungates the clock and configures the peripheral for basic operation.

Note

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

Parameters:

base – Ctimer peripheral base address
config – Pointer to the user configuration structure.

void CTIMER_Deinit(CTIMER_Type *base)

Gates the timer clock.

Parameters:

base – Ctimer peripheral base address

void CTIMER_GetDefaultConfig(ctimer_config_t *config)

Fills in the timers configuration structure with the default settings.

The default values are:

config->mode = kCTIMER_TimerMode;
config->input = kCTIMER_Capture_0;
config->prescale = 0;

Parameters:

config – Pointer to the user configuration structure.

status_t CTIMER_SetupPwmPeriod(CTIMER_Type *base, const ctimer_match_t pwmPeriodChannel, ctimer_match_t matchChannel, uint32_t pwmPeriod, uint32_t pulsePeriod, bool enableInt)

Configures the PWM signal parameters.

Enables PWM mode on the match channel passed in and will then setup the match value and other match parameters to generate a PWM signal. This function can manually assign the specified channel to set the PWM cycle.

Note

When setting PWM output from multiple output pins, all should use the same PWM period

Parameters:

base – Ctimer peripheral base address
pwmPeriodChannel – Specify the channel to control the PWM period
matchChannel – Match pin to be used to output the PWM signal
pwmPeriod – PWM period match value
pulsePeriod – Pulse width match value
enableInt – Enable interrupt when the timer value reaches the match value of the PWM pulse, if it is 0 then no interrupt will be generated.

Returns:

kStatus_Success on success kStatus_Fail If matchChannel is equal to pwmPeriodChannel; this channel is reserved to set the PWM cycle If PWM pulse width register value is larger than 0xFFFFFFFF.

status_t CTIMER_SetupPwm(CTIMER_Type *base, const ctimer_match_t pwmPeriodChannel, ctimer_match_t matchChannel, uint8_t dutyCyclePercent, uint32_t pwmFreq_Hz, uint32_t srcClock_Hz, bool enableInt)

Configures the PWM signal parameters.

Enables PWM mode on the match channel passed in and will then setup the match value and other match parameters to generate a PWM signal. This function can manually assign the specified channel to set the PWM cycle.

Note

When setting PWM output from multiple output pins, all should use the same PWM frequency. Please use CTIMER_SetupPwmPeriod to set up the PWM with high resolution.

Parameters:

base – Ctimer peripheral base address
pwmPeriodChannel – Specify the channel to control the PWM period
matchChannel – Match pin to be used to output the PWM signal
dutyCyclePercent – PWM pulse width; the value should be between 0 to 100
pwmFreq_Hz – PWM signal frequency in Hz
srcClock_Hz – Timer counter clock in Hz
enableInt – Enable interrupt when the timer value reaches the match value of the PWM pulse, if it is 0 then no interrupt will be generated.

static inline void CTIMER_UpdatePwmPulsePeriod(CTIMER_Type *base, ctimer_match_t matchChannel, uint32_t pulsePeriod)

Updates the pulse period of an active PWM signal.

Parameters:

base – Ctimer peripheral base address
matchChannel – Match pin to be used to output the PWM signal
pulsePeriod – New PWM pulse width match value

status_t CTIMER_UpdatePwmDutycycle(CTIMER_Type *base, const ctimer_match_t pwmPeriodChannel, ctimer_match_t matchChannel, uint8_t dutyCyclePercent)

Updates the duty cycle of an active PWM signal.

Note

Please use CTIMER_SetupPwmPeriod to update the PWM with high resolution. This function can manually assign the specified channel to set the PWM cycle.

Parameters:

base – Ctimer peripheral base address
pwmPeriodChannel – Specify the channel to control the PWM period
matchChannel – Match pin to be used to output the PWM signal
dutyCyclePercent – New PWM pulse width; the value should be between 0 to 100

Returns:

kStatus_Success on success kStatus_Fail If PWM pulse width register value is larger than 0xFFFFFFFF.

static inline void CTIMER_EnableInterrupts(CTIMER_Type *base, uint32_t mask)

Enables the selected Timer interrupts.

Parameters:

base – Ctimer peripheral base address
mask – The interrupts to enable. This is a logical OR of members of the enumeration ctimer_interrupt_enable_t

static inline void CTIMER_DisableInterrupts(CTIMER_Type *base, uint32_t mask)

Disables the selected Timer interrupts.

Parameters:

base – Ctimer peripheral base address
mask – The interrupts to enable. This is a logical OR of members of the enumeration ctimer_interrupt_enable_t

static inline uint32_t CTIMER_GetEnabledInterrupts(CTIMER_Type *base)

Gets the enabled Timer interrupts.

Parameters:

base – Ctimer peripheral base address

Returns:

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

static inline uint32_t CTIMER_GetStatusFlags(CTIMER_Type *base)

Gets the Timer status flags.

Parameters:

base – Ctimer peripheral base address

Returns:

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

static inline void CTIMER_ClearStatusFlags(CTIMER_Type *base, uint32_t mask)

Clears the Timer status flags.

Parameters:

base – Ctimer peripheral base address
mask – The status flags to clear. This is a logical OR of members of the enumeration ctimer_status_flags_t

static inline void CTIMER_StartTimer(CTIMER_Type *base)

Starts the Timer counter.

Parameters:

base – Ctimer peripheral base address

static inline void CTIMER_StopTimer(CTIMER_Type *base)

Stops the Timer counter.

Parameters:

base – Ctimer peripheral base address

FSL_CTIMER_DRIVER_VERSION: Version 2.3.3

enum _ctimer_capture_channel

List of Timer capture channels.

Values:

enumerator kCTIMER_Capture_0: Timer capture channel 0

enumerator kCTIMER_Capture_1: Timer capture channel 1

enumerator kCTIMER_Capture_3: Timer capture channel 3

enum _ctimer_capture_edge

List of capture edge options.

Values:

enumerator kCTIMER_Capture_RiseEdge: Capture on rising edge

enumerator kCTIMER_Capture_FallEdge: Capture on falling edge

enumerator kCTIMER_Capture_BothEdge: Capture on rising and falling edge

enum _ctimer_match

List of Timer match registers.

Values:

enumerator kCTIMER_Match_0: Timer match register 0

enumerator kCTIMER_Match_1: Timer match register 1

enumerator kCTIMER_Match_2: Timer match register 2

enumerator kCTIMER_Match_3: Timer match register 3

enum _ctimer_external_match

List of external match.

Values:

enumerator kCTIMER_External_Match_0: External match 0

enumerator kCTIMER_External_Match_1: External match 1

enumerator kCTIMER_External_Match_2: External match 2

enumerator kCTIMER_External_Match_3: External match 3

enum _ctimer_match_output_control

List of output control options.

Values:

enumerator kCTIMER_Output_NoAction: No action is taken

enumerator kCTIMER_Output_Clear: Clear the EM bit/output to 0

enumerator kCTIMER_Output_Set: Set the EM bit/output to 1

enumerator kCTIMER_Output_Toggle: Toggle the EM bit/output

enum _ctimer_timer_mode

List of Timer modes.

Values:

enumerator kCTIMER_TimerMode

enumerator kCTIMER_IncreaseOnRiseEdge

enumerator kCTIMER_IncreaseOnFallEdge

enumerator kCTIMER_IncreaseOnBothEdge

enum _ctimer_interrupt_enable

List of Timer interrupts.

Values:

enumerator kCTIMER_Match0InterruptEnable: Match 0 interrupt

enumerator kCTIMER_Match1InterruptEnable: Match 1 interrupt

enumerator kCTIMER_Match2InterruptEnable: Match 2 interrupt

enumerator kCTIMER_Match3InterruptEnable: Match 3 interrupt

enum _ctimer_status_flags

List of Timer flags.

Values:

enumerator kCTIMER_Match0Flag: Match 0 interrupt flag

enumerator kCTIMER_Match1Flag: Match 1 interrupt flag

enumerator kCTIMER_Match2Flag: Match 2 interrupt flag

enumerator kCTIMER_Match3Flag: Match 3 interrupt flag

enum ctimer_callback_type_t

Callback type when registering for a callback. When registering a callback an array of function pointers is passed the size could be 1 or 8, the callback type will tell that.

Values:

enumerator kCTIMER_SingleCallback: Single Callback type where there is only one callback for the timer. based on the status flags different channels needs to be handled differently

enumerator kCTIMER_MultipleCallback: Multiple Callback type where there can be 8 valid callbacks, one per channel. for both match/capture

typedef enum _ctimer_capture_channel ctimer_capture_channel_t: List of Timer capture channels.

typedef enum _ctimer_capture_edge ctimer_capture_edge_t: List of capture edge options.

typedef enum _ctimer_match ctimer_match_t: List of Timer match registers.

typedef enum _ctimer_external_match ctimer_external_match_t: List of external match.

typedef enum _ctimer_match_output_control ctimer_match_output_control_t: List of output control options.

typedef enum _ctimer_timer_mode ctimer_timer_mode_t: List of Timer modes.

typedef enum _ctimer_interrupt_enable ctimer_interrupt_enable_t: List of Timer interrupts.

typedef enum _ctimer_status_flags ctimer_status_flags_t: List of Timer flags.

typedef void (*ctimer_callback_t)(uint32_t flags)

typedef struct _ctimer_match_config ctimer_match_config_t

Match configuration.

This structure holds the configuration settings for each match register.

typedef struct _ctimer_config ctimer_config_t

Timer configuration structure.

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

The configuration structure can be made constant so as to reside in flash.

void CTIMER_SetupMatch(CTIMER_Type *base, ctimer_match_t matchChannel, const ctimer_match_config_t *config)

Setup the match register.

User configuration is used to setup the match value and action to be taken when a match occurs.

Parameters:

base – Ctimer peripheral base address
matchChannel – Match register to configure
config – Pointer to the match configuration structure

uint32_t CTIMER_GetOutputMatchStatus(CTIMER_Type *base, uint32_t matchChannel)

Get the status of output match.

This function gets the status of output MAT, whether or not this output is connected to a pin. This status is driven to the MAT pins if the match function is selected via IOCON. 0 = LOW. 1 = HIGH.

Parameters:

base – Ctimer peripheral base address
matchChannel – External match channel, user can obtain the status of multiple match channels at the same time by using the logic of “|” enumeration ctimer_external_match_t

Returns:

The mask of external match channel status flags. Users need to use the _ctimer_external_match type to decode the return variables.

void CTIMER_SetupCapture(CTIMER_Type *base, ctimer_capture_channel_t capture, ctimer_capture_edge_t edge, bool enableInt)

Setup the capture.

Parameters:

base – Ctimer peripheral base address
capture – Capture channel to configure
edge – Edge on the channel that will trigger a capture
enableInt – Flag to enable channel interrupts, if enabled then the registered call back is called upon capture

static inline uint32_t CTIMER_GetTimerCountValue(CTIMER_Type *base)

Get the timer count value from TC register.

Parameters:

base – Ctimer peripheral base address.

Returns:

return the timer count value.

void CTIMER_RegisterCallBack(CTIMER_Type *base, ctimer_callback_t *cb_func, ctimer_callback_type_t cb_type)

Register callback.

Parameters:

base – Ctimer peripheral base address
cb_func – callback function
cb_type – callback function type, singular or multiple

static inline void CTIMER_Reset(CTIMER_Type *base)

Reset the counter.

The timer counter and prescale counter are reset on the next positive edge of the APB clock.

Parameters:

base – Ctimer peripheral base address

static inline void CTIMER_SetPrescale(CTIMER_Type *base, uint32_t prescale)

Setup the timer prescale value.

Specifies the maximum value for the Prescale Counter.

Parameters:

base – Ctimer peripheral base address
prescale – Prescale value

static inline uint32_t CTIMER_GetCaptureValue(CTIMER_Type *base, ctimer_capture_channel_t capture)

Get capture channel value.

Get the counter/timer value on the corresponding capture channel.

Parameters:

base – Ctimer peripheral base address
capture – Select capture channel

Returns:

The timer count capture value.

static inline void CTIMER_EnableResetMatchChannel(CTIMER_Type *base, ctimer_match_t match, bool enable)

Enable reset match channel.

Set the specified match channel reset operation.

Parameters:

base – Ctimer peripheral base address
match – match channel used
enable – Enable match channel reset operation.

static inline void CTIMER_EnableStopMatchChannel(CTIMER_Type *base, ctimer_match_t match, bool enable)

Enable stop match channel.

Set the specified match channel stop operation.

Parameters:

base – Ctimer peripheral base address.
match – match channel used.
enable – Enable match channel stop operation.

static inline void CTIMER_EnableMatchChannelReload(CTIMER_Type *base, ctimer_match_t match, bool enable)

Enable reload channel falling edge.

Enable the specified match channel reload match shadow value.

Parameters:

base – Ctimer peripheral base address.
match – match channel used.
enable – Enable .

static inline void CTIMER_EnableRisingEdgeCapture(CTIMER_Type *base, ctimer_capture_channel_t capture, bool enable)

Enable capture channel rising edge.

Sets the specified capture channel for rising edge capture.

Parameters:

base – Ctimer peripheral base address.
capture – capture channel used.
enable – Enable rising edge capture.

static inline void CTIMER_EnableFallingEdgeCapture(CTIMER_Type *base, ctimer_capture_channel_t capture, bool enable)

Enable capture channel falling edge.

Sets the specified capture channel for falling edge capture.

Parameters:

base – Ctimer peripheral base address.
capture – capture channel used.
enable – Enable falling edge capture.

static inline void CTIMER_SetShadowValue(CTIMER_Type *base, ctimer_match_t match, uint32_t matchvalue)

Set the specified match shadow channel.

Parameters:

base – Ctimer peripheral base address.
match – match channel used.
matchvalue – Reload the value of the corresponding match register.

struct _ctimer_match_config

#include <fsl_ctimer.h>

Match configuration.

This structure holds the configuration settings for each match register.

Public Members

uint32_t matchValue: This is stored in the match register

bool enableCounterReset: true: Match will reset the counter false: Match will not reser the counter

bool enableCounterStop: true: Match will stop the counter false: Match will not stop the counter

ctimer_match_output_control_t outControl: Action to be taken on a match on the EM bit/output

bool outPinInitState: Initial value of the EM bit/output

bool enableInterrupt: true: Generate interrupt upon match false: Do not generate interrupt on match

struct _ctimer_config

#include <fsl_ctimer.h>

Timer configuration structure.

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

The configuration structure can be made constant so as to reside in flash.

Public Members

ctimer_timer_mode_t mode: Timer mode

ctimer_capture_channel_t input: Input channel to increment the timer, used only in timer modes that rely on this input signal to increment TC

uint32_t prescale: Prescale 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.

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. It is used for the case:

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)

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

FSL_DMA_DRIVER_VERSION

DMA driver version.

Version 2.5.3.

_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

IAP: In Application Programming Driver

enum _flash_driver_version_constants

Flash driver version for ROM.

Values:

enumerator kFLASH_DriverVersionName: Flash driver version name.

enumerator kFLASH_DriverVersionMajor: Major flash driver version.

enumerator kFLASH_DriverVersionMinor: Minor flash driver version.

enumerator kFLASH_DriverVersionBugfix: Bugfix for flash driver version.

MAKE_VERSION(major, minor, bugfix): Constructs the version number for drivers.

FSL_FLASH_DRIVER_VERSION

Flash driver version for SDK.

Version 2.1.5.

enum _flash_status

Flash driver status codes.

Values:

enumerator kStatus_FLASH_Success: API is executed successfully

enumerator kStatus_FLASH_InvalidArgument: Invalid argument

enumerator kStatus_FLASH_SizeError: Error size

enumerator kStatus_FLASH_AlignmentError: Parameter is not aligned with the specified baseline

enumerator kStatus_FLASH_AddressError: Address is out of range

enumerator kStatus_FLASH_AccessError: Invalid instruction codes and out-of bound addresses

enumerator kStatus_FLASH_ProtectionViolation: The program/erase operation is requested to execute on protected areas

enumerator kStatus_FLASH_CommandFailure: Run-time error during command execution.

enumerator kStatus_FLASH_UnknownProperty: Unknown property.

enumerator kStatus_FLASH_EraseKeyError: API erase key is invalid.

enumerator kStatus_FLASH_RegionExecuteOnly: The current region is execute-only.

enumerator kStatus_FLASH_ExecuteInRamFunctionNotReady: Execute-in-RAM function is not available.

enumerator kStatus_FLASH_CommandNotSupported: Flash API is not supported.

enumerator kStatus_FLASH_ReadOnlyProperty: The flash property is read-only.

enumerator kStatus_FLASH_InvalidPropertyValue: The flash property value is out of range.

enumerator kStatus_FLASH_InvalidSpeculationOption: The option of flash prefetch speculation is invalid.

enumerator kStatus_FLASH_EccError: A correctable or uncorrectable error during command execution.

enumerator kStatus_FLASH_CompareError: Destination and source memory contents do not match.

enumerator kStatus_FLASH_RegulationLoss: A loss of regulation during read.

enumerator kStatus_FLASH_InvalidWaitStateCycles: The wait state cycle set to r/w mode is invalid.

enumerator kStatus_FLASH_OutOfDateCfpaPage: CFPA page version is out of date.

enumerator kStatus_FLASH_BlankIfrPageData: Blank page cannnot be read.

enumerator kStatus_FLASH_EncryptedRegionsEraseNotDoneAtOnce: Encrypted flash subregions are not erased at once.

enumerator kStatus_FLASH_ProgramVerificationNotAllowed: Program verification is not allowed when the encryption is enabled.

enumerator kStatus_FLASH_HashCheckError: Hash check of page data is failed.

enumerator kStatus_FLASH_SealedFfrRegion: The FFR region is sealed.

enumerator kStatus_FLASH_FfrRegionWriteBroken: The FFR Spec region is not allowed to be written discontinuously.

enumerator kStatus_FLASH_NmpaAccessNotAllowed: The NMPA region is not allowed to be read/written/erased.

enumerator kStatus_FLASH_CmpaCfgDirectEraseNotAllowed: The CMPA Cfg region is not allowed to be erased directly.

enumerator kStatus_FLASH_FfrBankIsLocked: The FFR bank region is locked.

enumerator kStatus_FLASH_EraseFrequencyError: Core frequency is over 100MHZ.

enumerator kStatus_FLASH_ProgramFrequencyError: Core frequency is over 100MHZ.

kStatusGroupGeneric: Flash driver status group.

kStatusGroupFlashDriver

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

enum _flash_driver_api_keys

Enumeration for Flash driver API keys.

Note

The resulting value is built with a byte order such that the string being readable in expected order when viewed in a hex editor, if the value is treated as a 32-bit little endian value.

Values:

enumerator kFLASH_ApiEraseKey: Key value used to validate all flash erase APIs.

FOUR_CHAR_CODE(a, b, c, d): Constructs the four character code for the Flash driver API key.

status_t FLASH_Init(flash_config_t *config)

Initializes the global flash properties structure members.

This function checks and initializes the Flash module for the other Flash APIs.

Parameters:

config – Pointer to the storage for the driver runtime state.

Return values:

kStatus_FLASH_Success – API was executed successfully.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

status_t FLASH_Erase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key)

Erases the flash sectors encompassed by parameters passed into function.

This function erases the appropriate number of flash sectors based on the desired start address and length.

Parameters:

config – The pointer to the storage for the driver runtime state.
start – The start address of the desired flash memory to be erased. The start address need to be 512bytes-aligned.
lengthInBytes – The length, given in bytes (not words or long-words) to be erased. Must be 512bytes-aligned.
key – The value used to validate all flash erase APIs.

Return values:

kStatus_FLASH_Success – API was executed successfully; the appropriate number of flash sectors based on the desired start address and length were erased successfully.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_AlignmentError – The parameter is not aligned with the specified baseline.
kStatus_FLASH_AddressError – The address is out of range.
kStatus_FLASH_EraseKeyError – The API erase key is invalid.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

status_t FLASH_Program(flash_config_t *config, uint32_t start, const uint8_t *src, uint32_t lengthInBytes)

Programs flash with data at locations passed in through parameters.

This function programs the flash memory with the desired data for a given flash area as determined by the start address and the length.

Parameters:

config – A pointer to the storage for the driver runtime state.
start – The start address of the desired flash memory to be programmed. Must be 512bytes-aligned.
src – A pointer to the source buffer of data that is to be programmed into the flash.
lengthInBytes – The length, given in bytes (not words or long-words), to be programmed. Must be 512bytes-aligned.

Return values:

kStatus_FLASH_Success – API was executed successfully; the desired data were programed successfully into flash based on desired start address and length.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_AlignmentError – Parameter is not aligned with the specified baseline.
kStatus_FLASH_AddressError – Address is out of range.
kStatus_FLASH_AccessError – Invalid instruction codes and out-of bounds addresses.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

status_t FLASH_VerifyErase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes)

Verifies an erasure of the desired flash area at a specified margin level.

This function checks the appropriate number of flash sectors based on the desired start address and length to check whether the flash is erased to the specified read margin level.

Parameters:

config – A pointer to the storage for the driver runtime state.
start – The start address of the desired flash memory to be verified. The start address need to be 512bytes-aligned.
lengthInBytes – The length, given in bytes (not words or long-words), to be verified. Must be 512bytes-aligned.

Return values:

kStatus_FLASH_Success – API was executed successfully; the specified FLASH region has been erased.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_AlignmentError – Parameter is not aligned with specified baseline.
kStatus_FLASH_AddressError – Address is out of range.
kStatus_FLASH_AccessError – Invalid instruction codes and out-of bounds addresses.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

status_t FLASH_VerifyProgram(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, const uint8_t *expectedData, uint32_t *failedAddress, uint32_t *failedData)

Verifies programming of the desired flash area at a specified margin level.

This function verifies the data programed in the flash memory using the Flash Program Check Command and compares it to the expected data for a given flash area as determined by the start address and length.

Parameters:

config – A pointer to the storage for the driver runtime state.
start – The start address of the desired flash memory to be verified. need be 512bytes-aligned.
lengthInBytes – The length, given in bytes (not words or long-words), to be verified. need be 512bytes-aligned.
expectedData – A pointer to the expected data that is to be verified against.
failedAddress – A pointer to the returned failing address.
failedData – A pointer to the returned failing data. Some derivatives do not include failed data as part of the FCCOBx registers. In this case, zeros are returned upon failure.

Return values:

kStatus_FLASH_Success – API was executed successfully; the desired data have been successfully programed into specified FLASH region.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_AlignmentError – Parameter is not aligned with specified baseline.
kStatus_FLASH_AddressError – Address is out of range.
kStatus_FLASH_AccessError – Invalid instruction codes and out-of bounds addresses.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

status_t FLASH_GetProperty(flash_config_t *config, flash_property_tag_t whichProperty, uint32_t *value)

Returns the desired flash property.

Parameters:

config – A pointer to the storage for the driver runtime state.
whichProperty – The desired property from the list of properties in enum flash_property_tag_t
value – A pointer to the value returned for the desired flash property.

Return values:

kStatus_FLASH_Success – API was executed successfully; the flash property was stored to value.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_UnknownProperty – An unknown property tag.

void BOOTLOADER_UserEntry(void *arg)

Run the Bootloader API to force into the ISP mode base on the user arg.

Parameters:

arg – Indicates API prototype fields definition. Refer to the above user_app_boot_invoke_option_t structure

FSL_FEATURE_FLASH_IP_IS_C040HD_ATFC: Flash IP Type.

FSL_FEATURE_FLASH_IP_IS_C040HD_FC

enum _flash_property_tag

Enumeration for various flash properties.

Values:

enumerator kFLASH_PropertyPflashSectorSize: Pflash sector size property.

enumerator kFLASH_PropertyPflashTotalSize: Pflash total size property.

enumerator kFLASH_PropertyPflashBlockSize: Pflash block size property.

enumerator kFLASH_PropertyPflashBlockCount: Pflash block count property.

enumerator kFLASH_PropertyPflashBlockBaseAddr: Pflash block base address property.

enumerator kFLASH_PropertyPflashPageSize: Pflash page size property.

enumerator kFLASH_PropertyPflashSystemFreq: System Frequency System Frequency.

enumerator kFLASH_PropertyFfrSectorSize: FFR sector size property.

enumerator kFLASH_PropertyFfrTotalSize: FFR total size property.

enumerator kFLASH_PropertyFfrBlockBaseAddr: FFR block base address property.

enumerator kFLASH_PropertyFfrPageSize: FFR page size property.

enum _flash_max_erase_page_value

Enumeration for flash max pages to erase.

Values:

enumerator kFLASH_MaxPagesToErase: The max value in pages to erase.

enum _flash_alignment_property

Enumeration for flash alignment property.

Values:

enumerator kFLASH_AlignementUnitVerifyErase: The alignment unit in bytes used for verify erase operation.

enumerator kFLASH_AlignementUnitProgram: The alignment unit in bytes used for program operation.

enumerator kFLASH_AlignementUnitSingleWordRead: The alignment unit in bytes used for verify program operation. The alignment unit in bytes used for SingleWordRead command.

enum _flash_read_ecc_option

Enumeration for flash read ecc option.

Values:

enumerator kFLASH_ReadWithEccOn

enumerator kFLASH_ReadWithEccOff: ECC is on

enum _flash_freq_tag

Values:

enumerator kSysToFlashFreq_lowInMHz

enumerator kSysToFlashFreq_defaultInMHz

enum _flash_read_margin_option

Enumeration for flash read margin option.

Values:

enumerator kFLASH_ReadMarginNormal: Normal read

enumerator kFLASH_ReadMarginVsProgram: Margin vs. program

enumerator kFLASH_ReadMarginVsErase: Margin vs. erase

enumerator kFLASH_ReadMarginIllegalBitCombination: Illegal bit combination

enum _flash_read_dmacc_option

Enumeration for flash read dmacc option.

Values:

enumerator kFLASH_ReadDmaccDisabled: Memory word

enumerator kFLASH_ReadDmaccEnabled: DMACC word

enum _flash_ramp_control_option

Enumeration for flash ramp control option.

Values:

enumerator kFLASH_RampControlDivisionFactorReserved: Reserved

enumerator kFLASH_RampControlDivisionFactor256: clk48mhz / 256 = 187.5KHz

enumerator kFLASH_RampControlDivisionFactor128: clk48mhz / 128 = 375KHz

enumerator kFLASH_RampControlDivisionFactor64: clk48mhz / 64 = 750KHz

typedef enum _flash_property_tag flash_property_tag_t: Enumeration for various flash properties.

typedef struct _flash_ecc_log flash_ecc_log_t: Flash ECC log info.

typedef struct _flash_mode_config flash_mode_config_t: Flash controller paramter config.

typedef struct _flash_ffr_config flash_ffr_config_t: Flash controller paramter config.

typedef struct _flash_config flash_config_t

Flash driver state information.

An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.

status_t FLASH_Read(flash_config_t *config, uint32_t start, uint8_t *dest, uint32_t lengthInBytes)

Reads flash at locations passed in through parameters.

This function read the flash memory from a given flash area as determined by the start address and the length.

Parameters:

config – A pointer to the storage for the driver runtime state.
start – The start address of the desired flash memory to be read.
dest – A pointer to the dest buffer of data that is to be read from the flash.
lengthInBytes – The length, given in bytes (not words or long-words), to be read.

Return values:

kStatus_FLASH_Success – API was executed successfully.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FLASH_AlignmentError – Parameter is not aligned with the specified baseline.
kStatus_FLASH_AddressError – Address is out of range.
kStatus_FLASH_AccessError – Invalid instruction codes and out-of bounds addresses.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandFailure – Run-time error during the command execution.
kStatus_FLASH_CommandNotSupported – Flash API is not supported.
kStatus_FLASH_EccError – A correctable or uncorrectable error during command execution.

struct _flash_ecc_log: #include <fsl_iap.h>

Flash ECC log info.

struct _flash_mode_config: #include <fsl_iap.h>

Flash controller paramter config.

struct _flash_ffr_config: #include <fsl_iap.h>

Flash controller paramter config.

struct _flash_config

#include <fsl_iap.h>

Flash driver state information.

An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.

Public Members

uint32_t PFlashBlockBase: A base address of the first PFlash block

uint32_t PFlashTotalSize: The size of the combined PFlash block.

uint32_t PFlashBlockCount: A number of PFlash blocks.

uint32_t PFlashPageSize: The size in bytes of a page of PFlash.

uint32_t PFlashSectorSize: The size in bytes of a sector of PFlash.

struct user_app_boot_invoke_option_t: #include <fsl_iap.h>

struct readSingleWord

struct setWriteMode

struct setReadMode

union option

Public Members

struct user_app_boot_invoke_option_t B

uint32_t U

struct B

IAP_FFR Driver

status_t FFR_Init(flash_config_t *config)

Initializes the global FFR properties structure members.

Parameters:

config – A pointer to the storage for the driver runtime state.

Return values:

kStatus_FLASH_Success – API was executed successfully.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.

status_t FFR_Lock_All(flash_config_t *config)

Enable firewall for all flash banks.

CFPA, CMPA, and NMPA flash areas region will be locked, After this function executed; Unless the board is reset again.

Parameters:

config – A pointer to the storage for the driver runtime state.

Return values:

kStatus_FLASH_Success – An invalid argument is provided.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.

status_t FFR_InfieldPageWrite(flash_config_t *config, uint8_t *page_data, uint32_t valid_len)

APIs to access CFPA pages.

This routine will erase CFPA and program the CFPA page with passed data.

Parameters:

config – A pointer to the storage for the driver runtime state.
page_data – A pointer to the source buffer of data that is to be programmed into the CFPA.
valid_len – The length, given in bytes, to be programmed.

Return values:

kStatus_FLASH_Success – The desire page-data were programed successfully into CFPA.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FTFx_AddressError – Address is out of range.
kStatus_FLASH_FfrBankIsLocked – The CFPA was locked.
kStatus_FLASH_OutOfDateCfpaPage – It is not newest CFPA page.

status_t FFR_GetCustomerInfieldData(flash_config_t *config, uint8_t *pData, uint32_t offset, uint32_t len)

APIs to access CFPA pages.

Generic read function, used by customer to read data stored in ‘Customer In-field Page’.

Parameters:

config – A pointer to the storage for the driver runtime state.
pData – A pointer to the dest buffer of data that is to be read from ‘Customer In-field Page’.
offset – An offset from the ‘Customer In-field Page’ start address.
len – The length, given in bytes, to be read.

Return values:

kStatus_FLASH_Success – Get data from ‘Customer In-field Page’.
kStatus_FLASH_InvalidArgument – An invalid argument is provided.
kStatus_FTFx_AddressError – Address is out of range.
kStatus_FLASH_CommandFailure – access error.

status_t FFR_CustFactoryPageWrite(flash_config_t *config, uint8_t *page_data, bool seal_part)

APIs to access CMPA pages.

This routine will erase “customer factory page” and program the page with passed data. If ‘seal_part’ parameter is TRUE then the routine will compute SHA256 hash of the page contents and then programs the pages. 1.During development customer code uses this API with ‘seal_part’ set to FALSE. 2.During manufacturing this parameter should be set to TRUE to seal the part from further modifications 3.This routine checks if the page is sealed or not. A page is said to be sealed if the SHA256 value in the page has non-zero value. On boot ROM locks the firewall for the region if hash is programmed anyways. So, write/erase commands will fail eventually.

Parameters:

config – A pointer to the storage for the driver runtime state.
page_data – A pointer to the source buffer of data that is to be programmed into the “customer factory page”.
seal_part – Set fasle for During development customer code.

Return values:

kStatus_FLASH_Success – The desire page-data were programed successfully into CMPA.
kStatus_FLASH_InvalidArgument – Parameter is not aligned with the specified baseline.
kStatus_FTFx_AddressError – Address is out of range.
kStatus_FLASH_CommandFailure – access error.

status_t FFR_GetCustomerData(flash_config_t *config, uint8_t *pData, uint32_t offset, uint32_t len)

APIs to access CMPA page.

Read data stored in ‘Customer Factory CFG Page’.

Parameters:

config – A pointer to the storage for the driver runtime state.
pData – A pointer to the dest buffer of data that is to be read from the Customer Factory CFG Page.
offset – Address offset relative to the CMPA area.
len – The length, given in bytes to be read.

Return values:

kStatus_FLASH_Success – Get data from ‘Customer Factory CFG Page’.
kStatus_FLASH_InvalidArgument – Parameter is not aligned with the specified baseline.
kStatus_FTFx_AddressError – Address is out of range.
kStatus_FLASH_CommandFailure – access error.

status_t FFR_GetUUID(flash_config_t *config, uint8_t *uuid)

APIs to access CMPA page.

1.SW should use this API routine to get the UUID of the chip. 2.Calling routine should pass a pointer to buffer which can hold 128-bit value.

status_t FFR_KeystoreWrite(flash_config_t *config, ffr_key_store_t *pKeyStore)

This routine writes the 3 pages allocated for Key store data,.

1.Used during manufacturing. Should write pages when ‘customer factory page’ is not in sealed state. 2.Optional routines to set individual data members (activation code, key codes etc) to construct the key store structure in RAM before committing it to IFR/FFR.

Parameters:

config – A pointer to the storage for the driver runtime state.
pKeyStore – A Pointer to the 3 pages allocated for Key store data. that will be written to ‘customer factory page’.

Return values:

kStatus_FLASH_Success – The key were programed successfully into FFR.
kStatus_FLASH_InvalidArgument – Parameter is not aligned with the specified baseline.
kStatus_FTFx_AddressError – Address is out of range.
kStatus_FLASH_CommandFailure – access error.

status_t FFR_KeystoreGetAC(flash_config_t *config, uint8_t *pActivationCode)

Get/Read Key store code routines.

Calling code should pass buffer pointer which can hold activation code 1192 bytes.
Check if flash aperture is small or regular and read the data appropriately.

status_t FFR_KeystoreGetKC(flash_config_t *config, uint8_t *pKeyCode, ffr_key_type_t keyIndex)

Get/Read Key store code routines.

Calling code should pass buffer pointer which can hold key code 52 bytes.
Check if flash aperture is small or regular and read the data appropriately.
keyIndex specifies which key code is read.

FSL_FLASH_IFR_DRIVER_VERSION

Flash IFR driver version for SDK.

Version 2.1.0.

enum _flash_ffr_page_offset

flash ffr page offset.

Values:

enumerator kFfrPageOffset_CFPA: Customer In-Field programmed area

enumerator kFfrPageOffset_CFPA_Scratch: CFPA Scratch page

enumerator kFfrPageOffset_CFPA_Cfg: CFPA Configuration area (Ping page)

enumerator kFfrPageOffset_CFPA_CfgPong: Same as CFPA page (Pong page)

enumerator kFfrPageOffset_CMPA: Customer Manufacturing programmed area

enumerator kFfrPageOffset_CMPA_Cfg: CMPA Configuration area (Part of CMPA)

enumerator kFfrPageOffset_CMPA_Key: Key Store area (Part of CMPA)

enumerator kFfrPageOffset_NMPA: NXP Manufacturing programmed area

enumerator kFfrPageOffset_NMPA_Romcp: ROM patch area (Part of NMPA)

enumerator kFfrPageOffset_NMPA_Repair: Repair area (Part of NMPA)

enumerator kFfrPageOffset_NMPA_Cfg: NMPA configuration area (Part of NMPA)

enumerator kFfrPageOffset_NMPA_End: Reserved (Part of NMPA)

enum _flash_ffr_page_num

flash ffr page number.

Values:

enumerator kFfrPageNum_CFPA: Customer In-Field programmed area

enumerator kFfrPageNum_CMPA: Customer Manufacturing programmed area

enumerator kFfrPageNum_NMPA: NXP Manufacturing programmed area

enumerator kFfrPageNum_CMPA_Cfg

enumerator kFfrPageNum_CMPA_Key

enumerator kFfrPageNum_NMPA_Romcp

enumerator kFfrPageNum_SpecArea

enumerator kFfrPageNum_Total

enum _flash_ffr_block_size

Values:

enumerator kFfrBlockSize_Key

enumerator kFfrBlockSize_ActivationCode

enum _cfpa_cfg_cmpa_prog_process

Values:

enumerator kFfrCmpaProgProcess_Pre

enumerator kFfrCmpaProgProcess_Post

enum _ffr_key_type

Values:

enumerator kFFR_KeyTypeSbkek

enumerator kFFR_KeyTypeUser

enumerator kFFR_KeyTypeUds

enumerator kFFR_KeyTypePrinceRegion0

enumerator kFFR_KeyTypePrinceRegion1

enumerator kFFR_KeyTypePrinceRegion2

enum _ffr_bank_type

Values:

enumerator kFFR_BankTypeBank0_NMPA

enumerator kFFR_BankTypeBank1_CMPA

enumerator kFFR_BankTypeBank2_CFPA

typedef enum _cfpa_cfg_cmpa_prog_process cmpa_prog_process_t

typedef struct _cfpa_cfg_iv_code cfpa_cfg_iv_code_t

typedef struct _cfpa_cfg_info cfpa_cfg_info_t

typedef struct _cmpa_cfg_info cmpa_cfg_info_t

typedef struct _cmpa_key_store_header cmpa_key_store_header_t

typedef struct _nmpa_cfg_info nmpa_cfg_info_t

typedef struct _ffr_key_store ffr_key_store_t

typedef enum _ffr_key_type ffr_key_type_t

typedef enum _ffr_bank_type ffr_bank_type_t

ALIGN_DOWN(x, a): Alignment(down) utility.

ALIGN_UP(x, a): Alignment(up) utility.

FLASH_FFR_MAX_PAGE_SIZE

FLASH_FFR_HASH_DIGEST_SIZE

FLASH_FFR_IV_CODE_SIZE

FFR_BOOTCFG_BOOTSPEED_MASK

FFR_BOOTCFG_BOOTSPEED_SHIFT

FFR_BOOTCFG_BOOTSPEED_48MHZ

FFR_BOOTCFG_BOOTSPEED_96MHZ

FFR_USBID_VENDORID_MASK

FFR_USBID_VENDORID_SHIFT

FFR_USBID_PRODUCTID_MASK

FFR_USBID_PRODUCTID_SHIFT

FFR_SYSTEM_SPEED_CODE_MASK

FFR_SYSTEM_SPEED_CODE_SHIFT

FFR_SYSTEM_SPEED_CODE_FRO12MHZ_12MHZ

FFR_SYSTEM_SPEED_CODE_FROHF96MHZ_24MHZ

FFR_SYSTEM_SPEED_CODE_FROHF96MHZ_48MHZ

FFR_SYSTEM_SPEED_CODE_FROHF96MHZ_96MHZ

FFR_PERIPHERALCFG_PERI_MASK

FFR_PERIPHERALCFG_PERI_SHIFT

FFR_PERIPHERALCFG_COREEN_MASK

FFR_PERIPHERALCFG_COREEN_SHIFT

struct _cfpa_cfg_iv_code: #include <fsl_iap_ffr.h>

struct _cfpa_cfg_info

#include <fsl_iap_ffr.h>

Public Members

uint32_t header: [0x000-0x003]

uint32_t version: [0x004-0x007

uint32_t secureFwVersion: [0x008-0x00b

uint32_t nsFwVersion: [0x00c-0x00f]

uint32_t imageKeyRevoke: [0x010-0x013]

uint8_t reserved0[4]: [0x014-0x017]

uint32_t rotkhRevoke: [0x018-0x01b]

uint32_t vendorUsage: [0x01c-0x01f]

uint32_t dcfgNsPin: [0x020-0x013]

uint32_t dcfgNsDflt: [0x024-0x017]

uint32_t enableFaMode: [0x028-0x02b]

uint8_t reserved1[4]: [0x02c-0x02f]

cfpa_cfg_iv_code_t ivCodePrinceRegion[3]: [0x030-0x0d7]

uint8_t reserved2[264]: [0x0d8-0x1df]

uint8_t sha256[32]: [0x1e0-0x1ff]

struct _cmpa_cfg_info

#include <fsl_iap_ffr.h>

Public Members

uint32_t bootCfg: [0x000-0x003]

uint32_t spiFlashCfg: [0x004-0x007]

struct _cmpa_cfg_info usbId: [0x008-0x00b]

uint32_t sdioCfg: [0x00c-0x00f]

uint32_t dcfgPin: [0x010-0x013]

uint32_t dcfgDflt: [0x014-0x017]

uint32_t dapVendorUsage: [0x018-0x01b]

uint32_t secureBootCfg: [0x01c-0x01f]

uint32_t princeBaseAddr: [0x020-0x023]

uint32_t princeSr[3]: [0x024-0x02f]

uint8_t reserved0[32]: [0x030-0x04f]

uint32_t rotkh[8]: [0x050-0x06f]

uint8_t reserved1[368]: [0x070-0x1df]

uint8_t sha256[32]: [0x1e0-0x1ff]

struct _cmpa_key_store_header: #include <fsl_iap_ffr.h>

struct _nmpa_cfg_info

#include <fsl_iap_ffr.h>

Public Members

uint16_t fro32kCfg: [0x000-0x001]

uint8_t reserved0[6]: [0x002-0x007]

uint8_t sysCfg: [0x008-0x008]

uint8_t reserved1[7]: [0x009-0x00f]

struct _nmpa_cfg_info GpoInitData[3]: [0x010-0x03f]

uint32_t GpoDataChecksum[4]: [0x040-0x04f]

uint32_t finalTestBatchId[4]: [0x050-0x05f]

uint32_t deviceType: [0x060-0x063]

uint32_t finalTestProgVersion: [0x064-0x067]

uint32_t finalTestDate: [0x068-0x06b]

uint32_t finalTestTime: [0x06c-0x06f]

uint32_t uuid[4]: [0x070-0x07f]

uint8_t reserved2[32]: [0x080-0x09f]

uint32_t peripheralCfg: [0x0a0-0x0a3]

uint32_t ramSizeCfg: [0x0a4-0x0a7]

uint32_t flashSizeCfg: [0x0a8-0x0ab]

uint8_t reserved3[36]: [0x0ac-0x0cf]

uint8_t fro1mCfg: [0x0d0-0x0d0]

uint8_t reserved4[15]: [0x0d1-0x0df]

uint32_t dcdc[4]: [0x0e0-0x0ef]

uint32_t bod: [0x0f0-0x0f3]

uint8_t reserved5[12]: [0x0f4-0x0ff]

uint8_t calcHashReserved[192]: [0x100-0x1bf]

uint8_t sha256[32]: [0x1c0-0x1df]

uint32_t ecidBackup[4]: [0x1e0-0x1ef]

uint32_t pageChecksum[4]: [0x1f0-0x1ff]

struct _ffr_key_store: #include <fsl_iap_ffr.h>

struct usbId

struct GpoInitData

FLEXCOMM: FLEXCOMM Driver

FLEXCOMM Driver

FSL_FLEXCOMM_DRIVER_VERSION: FlexCOMM driver version 2.0.2.

enum FLEXCOMM_PERIPH_T

FLEXCOMM peripheral modes.

Values:

enumerator FLEXCOMM_PERIPH_NONE: No peripheral

enumerator FLEXCOMM_PERIPH_USART: USART peripheral

enumerator FLEXCOMM_PERIPH_SPI: SPI Peripheral

enumerator FLEXCOMM_PERIPH_I2C: I2C Peripheral

enumerator FLEXCOMM_PERIPH_I2S_TX: I2S TX Peripheral

enumerator FLEXCOMM_PERIPH_I2S_RX: I2S RX Peripheral

typedef void (*flexcomm_irq_handler_t)(void *base, void *handle): Typedef for interrupt handler.

IRQn_Type const kFlexcommIrqs[]: Array with IRQ number for each FLEXCOMM module.

uint32_t FLEXCOMM_GetInstance(void *base): Returns instance number for FLEXCOMM module with given base address.

status_t FLEXCOMM_Init(void *base, FLEXCOMM_PERIPH_T periph): Initializes FLEXCOMM and selects peripheral mode according to the second parameter.

void FLEXCOMM_SetIRQHandler(void *base, flexcomm_irq_handler_t handler, void *flexcommHandle): Sets IRQ handler for given FLEXCOMM module. It is used by drivers register IRQ handler according to FLEXCOMM mode.

GINT: Group GPIO Input Interrupt Driver

FSL_GINT_DRIVER_VERSION: Driver version.

enum _gint_comb

GINT combine inputs type.

Values:

enumerator kGINT_CombineOr: A grouped interrupt is generated when any one of the enabled inputs is active

enumerator kGINT_CombineAnd: A grouped interrupt is generated when all enabled inputs are active

enum _gint_trig

GINT trigger type.

Values:

enumerator kGINT_TrigEdge: Edge triggered based on polarity

enumerator kGINT_TrigLevel: Level triggered based on polarity

enum _gint_port

Values:

enumerator kGINT_Port0

typedef enum _gint_comb gint_comb_t: GINT combine inputs type.

typedef enum _gint_trig gint_trig_t: GINT trigger type.

typedef enum _gint_port gint_port_t

typedef void (*gint_cb_t)(void): GINT Callback function.

void GINT_Init(GINT_Type *base)

Initialize GINT peripheral.

This function initializes the GINT peripheral and enables the clock.

Parameters:

base – Base address of the GINT peripheral.

Return values:

None. –

void GINT_SetCtrl(GINT_Type *base, gint_comb_t comb, gint_trig_t trig, gint_cb_t callback)

Setup GINT peripheral control parameters.

This function sets the control parameters of GINT peripheral.

Parameters:

base – Base address of the GINT peripheral.
comb – Controls if the enabled inputs are logically ORed or ANDed for interrupt generation.
trig – Controls if the enabled inputs are level or edge sensitive based on polarity.
callback – This function is called when configured group interrupt is generated.

Return values:

None. –

void GINT_GetCtrl(GINT_Type *base, gint_comb_t *comb, gint_trig_t *trig, gint_cb_t *callback)

Get GINT peripheral control parameters.

This function returns the control parameters of GINT peripheral.

Parameters:

base – Base address of the GINT peripheral.
comb – Pointer to store combine input value.
trig – Pointer to store trigger value.
callback – Pointer to store callback function.

Return values:

None. –

void GINT_ConfigPins(GINT_Type *base, gint_port_t port, uint32_t polarityMask, uint32_t enableMask)

Configure GINT peripheral pins.

This function enables and controls the polarity of enabled pin(s) of a given port.

Parameters:

base – Base address of the GINT peripheral.
port – Port number.
polarityMask – Each bit position selects the polarity of the corresponding enabled pin. 0 = The pin is active LOW. 1 = The pin is active HIGH.
enableMask – Each bit position selects if the corresponding pin is enabled or not. 0 = The pin is disabled. 1 = The pin is enabled.

Return values:

None. –

void GINT_GetConfigPins(GINT_Type *base, gint_port_t port, uint32_t *polarityMask, uint32_t *enableMask)

Get GINT peripheral pin configuration.

This function returns the pin configuration of a given port.

Parameters:

base – Base address of the GINT peripheral.
port – Port number.
polarityMask – Pointer to store the polarity mask Each bit position indicates the polarity of the corresponding enabled pin. 0 = The pin is active LOW. 1 = The pin is active HIGH.
enableMask – Pointer to store the enable mask. Each bit position indicates if the corresponding pin is enabled or not. 0 = The pin is disabled. 1 = The pin is enabled.

Return values:

None. –

void GINT_EnableCallback(GINT_Type *base)

Enable callback.

This function enables the interrupt for the selected GINT 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 GINT peripheral.

Return values:

None. –

void GINT_DisableCallback(GINT_Type *base)

Disable callback.

This function disables the interrupt for the selected GINT 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. –

static inline void GINT_ClrStatus(GINT_Type *base)

Clear GINT status.

This function clears the GINT status bit.

Parameters:

base – Base address of the GINT peripheral.

Return values:

None. –

static inline uint32_t GINT_GetStatus(GINT_Type *base)

Get GINT status.

This function returns the GINT status.

Parameters:

base – Base address of the GINT peripheral.

Return values:

status – = 0 No group interrupt request. = 1 Group interrupt request active.

void GINT_Deinit(GINT_Type *base)

Deinitialize GINT peripheral.

This function disables the GINT clock.

Parameters:

base – Base address of the GINT peripheral.

Return values:

None. –

Hashcrypt: The Cryptographic Accelerator

Hashcrypt Background HASH

void HASHCRYPT_SHA_SetCallback(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, hashcrypt_callback_t callback, void *userData)

Initializes the HASHCRYPT handle for background hashing.

This function initializes the hash context for background hashing (Non-blocking) APIs. This is less typical interface to hash function, but can be used for parallel processing, when main CPU has something else to do. Example is digital signature RSASSA-PKCS1-V1_5-VERIFY((n,e),M,S) algorithm, where background hashing of M can be started, then CPU can compute S^e mod n (in parallel with background hashing) and once the digest becomes available, CPU can proceed to comparison of EM with EM’.

Parameters:

base – HASHCRYPT peripheral base address.
ctx – [out] Hash context.
callback – Callback function.
userData – User data (to be passed as an argument to callback function, once callback is invoked from isr).

status_t HASHCRYPT_SHA_UpdateNonBlocking(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, const uint8_t *input, size_t inputSize)

Create running hash on given data.

Configures the HASHCRYPT to compute new running hash as AHB master and returns immediately. HASHCRYPT AHB Master mode supports only aligned input address and can be called only once per continuous block of data. Every call to this function must be preceded with HASHCRYPT_SHA_Init() and finished with HASHCRYPT_SHA_Finish(). Once callback function is invoked by HASHCRYPT isr, it should set a flag for the main application to finalize the hashing (padding) and to read out the final digest by calling HASHCRYPT_SHA_Finish().

Parameters:

base – HASHCRYPT peripheral base address
ctx – Specifies callback. Last incomplete 512-bit block of the input is copied into clear buffer for padding.
input – 32-bit word aligned pointer to Input data.
inputSize – Size of input data in bytes (must be word aligned)

Returns:

Status of the hash update operation.

Hashcrypt common functions

FSL_HASHCRYPT_DRIVER_VERSION

HASHCRYPT driver version. Version 2.2.16.

Current version: 2.2.16

Change log:

Version 2.0.0
- Initial version
Version 2.0.1
- Support loading AES key from unaligned address
Version 2.0.2
- Support loading AES key from unaligned address for different compiler and core variants
Version 2.0.3
- Remove SHA512 and AES ICB algorithm definitions
Version 2.0.4
- Add SHA context switch support
Version 2.1.0
- Update the register name and macro to align with new header.
Version 2.1.1
- Fix MISRA C-2012.
Version 2.1.2
- Support loading AES input data from unaligned address.
Version 2.1.3
- Fix MISRA C-2012.
Version 2.1.4
- Fix context switch cannot work when switching from AES.
Version 2.1.5
- Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() to prevent possible optimization issue.
Version 2.2.0
- Add AES-OFB and AES-CFB mixed IP/SW modes.
Version 2.2.1
- Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() prevent compiler from reordering memory write when -O2 or higher is used.
Version 2.2.2
- Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() to fix optimization issue
Version 2.2.3
- Added check for size in hashcrypt_aes_one_block to prevent overflowing COUNT field in MEMCTRL register, if its bigger than COUNT field do a multiple runs.
Version 2.2.4
- In all HASHCRYPT_AES_xx functions have been added setting CTRL_MODE bitfield to 0 after processing data, which decreases power consumption.
Version 2.2.5
- Add data synchronization barrier and instruction synchronization barrier inside hashcrypt_sha_process_message_data() to fix optimization issue
Version 2.2.6
- Add data synchronization barrier inside HASHCRYPT_SHA_Update() and hashcrypt_get_data() function to fix optimization issue on MDK and ARMGCC release targets
Version 2.2.7
- Add data synchronization barrier inside HASHCRYPT_SHA_Update() to fix optimization issue on MCUX IDE release target
Version 2.2.8
- Unify hashcrypt hashing behavior between aligned and unaligned input data
Version 2.2.9
- Add handling of set ERROR bit in the STATUS register
Version 2.2.10
- Fix missing error statement in hashcrypt_save_running_hash()
Version 2.2.11
- Fix incorrect SHA-256 calculation for long messages with reload
Version 2.2.12
- Fix hardfault issue on the Keil compiler due to unaligned memcpy() input on some optimization levels
Version 2.2.13
- Added function hashcrypt_seed_prng() which loading random number into PRNG_SEED register before AES operation for SCA protection
Version 2.2.14
- Modify function hashcrypt_get_data() to prevent issue with unaligned access
Version 2.2.15
- Add wait on DIGEST BIT inside hashcrypt_sha_one_block() to fix issues with some optimization flags
Version 2.2.16
- Add DSB instruction inside hashcrypt_sha_ldm_stm_16_words() to fix issues with some optimization flags

enum _hashcrypt_algo_t

Algorithm used for Hashcrypt operation.

Values:

enumerator kHASHCRYPT_Sha1: SHA_1

enumerator kHASHCRYPT_Sha256: SHA_256

enumerator kHASHCRYPT_Aes: AES

typedef enum _hashcrypt_algo_t hashcrypt_algo_t: Algorithm used for Hashcrypt operation.

void HASHCRYPT_Init(HASHCRYPT_Type *base)

Enables clock and disables reset for HASHCRYPT peripheral.

Enable clock and disable reset for HASHCRYPT.

Parameters:

base – HASHCRYPT base address

void HASHCRYPT_Deinit(HASHCRYPT_Type *base)

Disables clock for HASHCRYPT peripheral.

Disable clock and enable reset.

Parameters:

base – HASHCRYPT base address

HASHCRYPT_MODE_SHA1: Algorithm definitions correspond with the values for Mode field in Control register !

HASHCRYPT_MODE_SHA256

HASHCRYPT_MODE_AES

Hashcrypt AES

enum _hashcrypt_aes_mode_t

AES mode.

Values:

enumerator kHASHCRYPT_AesEcb: AES ECB mode

enumerator kHASHCRYPT_AesCbc: AES CBC mode

enumerator kHASHCRYPT_AesCtr: AES CTR mode

enum _hashcrypt_aes_keysize_t

Size of AES key.

Values:

enumerator kHASHCRYPT_Aes128: AES 128 bit key

enumerator kHASHCRYPT_Aes192: AES 192 bit key

enumerator kHASHCRYPT_Aes256: AES 256 bit key

enumerator kHASHCRYPT_InvalidKey: AES invalid key

enum _hashcrypt_key

HASHCRYPT key source selection.

Values:

enumerator kHASHCRYPT_UserKey: HASHCRYPT user key

enumerator kHASHCRYPT_SecretKey: HASHCRYPT secret key (dedicated hw bus from PUF)

typedef enum _hashcrypt_aes_mode_t hashcrypt_aes_mode_t: AES mode.

typedef enum _hashcrypt_aes_keysize_t hashcrypt_aes_keysize_t: Size of AES key.

typedef enum _hashcrypt_key hashcrypt_key_t: HASHCRYPT key source selection.

typedef struct _hashcrypt_handle hashcrypt_handle_t

struct _hashcrypt_handle __attribute__ ((aligned))

status_t HASHCRYPT_AES_SetKey(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *key, size_t keySize)

Set AES key to hashcrypt_handle_t struct and optionally to HASHCRYPT.

Sets the AES key for encryption/decryption with the hashcrypt_handle_t structure. The hashcrypt_handle_t input argument specifies key source.

Parameters:

base – HASHCRYPT peripheral base address.
handle – Handle used for the request.
key – 0-mod-4 aligned pointer to AES key.
keySize – AES key size in bytes. Shall equal 16, 24 or 32.

Returns:

status from set key operation

status_t HASHCRYPT_AES_EncryptEcb(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *plaintext, uint8_t *ciphertext, size_t size)

Encrypts AES on one or multiple 128-bit block(s).

Encrypts AES. The source plaintext and destination ciphertext can overlap in system memory.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
plaintext – Input plain text to encrypt
ciphertext – [out] Output cipher text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.

Returns:

Status from encrypt operation

status_t HASHCRYPT_AES_DecryptEcb(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *ciphertext, uint8_t *plaintext, size_t size)

Decrypts AES on one or multiple 128-bit block(s).

Decrypts AES. The source ciphertext and destination plaintext can overlap in system memory.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
ciphertext – Input plain text to encrypt
plaintext – [out] Output cipher text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.

Returns:

Status from decrypt operation

status_t HASHCRYPT_AES_EncryptCbc(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *plaintext, uint8_t *ciphertext, size_t size, const uint8_t iv[16])

Encrypts AES using CBC block mode.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
plaintext – Input plain text to encrypt
ciphertext – [out] Output cipher text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.
iv – Input initial vector to combine with the first input block.

Returns:

Status from encrypt operation

status_t HASHCRYPT_AES_DecryptCbc(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *ciphertext, uint8_t *plaintext, size_t size, const uint8_t iv[16])

Decrypts AES using CBC block mode.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
ciphertext – Input cipher text to decrypt
plaintext – [out] Output plain text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.
iv – Input initial vector to combine with the first input block.

Returns:

Status from decrypt operation

status_t HASHCRYPT_AES_CryptCtr(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *input, uint8_t *output, size_t size, uint8_t counter[16U], uint8_t counterlast[16U], size_t *szLeft)

Encrypts or decrypts AES using CTR block mode.

Encrypts or decrypts AES using CTR block mode. AES CTR mode uses only forward AES cipher and same algorithm for encryption and decryption. The only difference between encryption and decryption is that, for encryption, the input argument is plain text and the output argument is cipher text. For decryption, the input argument is cipher text and the output argument is plain text.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
input – Input data for CTR block mode
output – [out] Output data for CTR block mode
size – Size of input and output data in bytes
counter – [inout] Input counter (updates on return)
counterlast – [out] Output cipher of last counter, for chained CTR calls (statefull encryption). NULL can be passed if chained calls are not used.
szLeft – [out] Output number of bytes in left unused in counterlast block. NULL can be passed if chained calls are not used.

Returns:

Status from encrypt operation

status_t HASHCRYPT_AES_CryptOfb(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *input, uint8_t *output, size_t size, const uint8_t iv[16U])

Encrypts or decrypts AES using OFB block mode.

Encrypts or decrypts AES using OFB block mode. AES OFB mode uses only forward AES cipher and same algorithm for encryption and decryption. The only difference between encryption and decryption is that, for encryption, the input argument is plain text and the output argument is cipher text. For decryption, the input argument is cipher text and the output argument is plain text.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
input – Input data for OFB block mode
output – [out] Output data for OFB block mode
size – Size of input and output data in bytes
iv – Input initial vector to combine with the first input block.

Returns:

Status from encrypt operation

status_t HASHCRYPT_AES_EncryptCfb(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *plaintext, uint8_t *ciphertext, size_t size, const uint8_t iv[16])

Encrypts AES using CFB block mode.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
plaintext – Input plain text to encrypt
ciphertext – [out] Output cipher text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.
iv – Input initial vector to combine with the first input block.

Returns:

Status from encrypt operation

status_t HASHCRYPT_AES_DecryptCfb(HASHCRYPT_Type *base, hashcrypt_handle_t *handle, const uint8_t *ciphertext, uint8_t *plaintext, size_t size, const uint8_t iv[16])

Decrypts AES using CFB block mode.

Parameters:

base – HASHCRYPT peripheral base address
handle – Handle used for this request.
ciphertext – Input cipher text to decrypt
plaintext – [out] Output plaintext text
size – Size of input and output data in bytes. Must be multiple of 16 bytes.
iv – Input initial vector to combine with the first input block.

Returns:

Status from encrypt operation

HASHCRYPT_AES_BLOCK_SIZE: AES block size in bytes

AES_ENCRYPT

AES_DECRYPT

struct _hashcrypt_handle

#include <fsl_hashcrypt.h>

Specify HASHCRYPT’s key resource.

Public Members

uint32_t keyWord[8]: Copy of user key (set by HASHCRYPT_AES_SetKey().

hashcrypt_key_t keyType: For operations with key (such as AES encryption/decryption), specify key type.

Hashcrypt HASH

typedef struct _hashcrypt_hash_ctx_t hashcrypt_hash_ctx_t: Storage type used to save hash context.

typedef void (*hashcrypt_callback_t)(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, status_t status, void *userData): HASHCRYPT background hash callback function.

status_t HASHCRYPT_SHA(HASHCRYPT_Type *base, hashcrypt_algo_t algo, const uint8_t *input, size_t inputSize, uint8_t *output, size_t *outputSize)

Create HASH on given data.

Perform the full SHA in one function call. The function is blocking.

Parameters:

base – HASHCRYPT peripheral base address
algo – Underlaying algorithm to use for hash computation.
input – Input data
inputSize – Size of input data in bytes
output – [out] Output hash data
outputSize – [out] Output parameter storing the size of the output hash in bytes

Returns:

Status of the one call hash operation.

status_t HASHCRYPT_SHA_Init(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, hashcrypt_algo_t algo)

Initialize HASH context.

This function initializes the HASH.

Parameters:

base – HASHCRYPT peripheral base address
ctx – [out] Output hash context
algo – Underlaying algorithm to use for hash computation.

Returns:

Status of initialization

status_t HASHCRYPT_SHA_Update(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, const uint8_t *input, size_t inputSize)

Add data to current HASH.

Add data to current HASH. This can be called repeatedly with an arbitrary amount of data to be hashed. The functions blocks. If it returns kStatus_Success, the running hash has been updated (HASHCRYPT has processed the input data), so the memory at input pointer can be released back to system. The HASHCRYPT context buffer is updated with the running hash and with all necessary information to support possible context switch.

Parameters:

base – HASHCRYPT peripheral base address
ctx – [inout] HASH context
input – Input data
inputSize – Size of input data in bytes

Returns:

Status of the hash update operation

status_t HASHCRYPT_SHA_Finish(HASHCRYPT_Type *base, hashcrypt_hash_ctx_t *ctx, uint8_t *output, size_t *outputSize)

Finalize hashing.

Outputs the final hash (computed by HASHCRYPT_HASH_Update()) and erases the context.

Parameters:

base – HASHCRYPT peripheral base address
ctx – [inout] Input hash context
output – [out] Output hash data
outputSize – [inout] Optional parameter (can be passed as NULL). On function entry, it specifies the size of output[] buffer. On function return, it stores the number of updated output bytes.

Returns:

Status of the hash finish operation

HASHCRYPT_HASH_CTX_SIZE: HASHCRYPT HASH Context size.

struct _hashcrypt_hash_ctx_t

#include <fsl_hashcrypt.h>

Storage type used to save hash context.

Public Members

uint32_t x[30]: storage

I2C: Inter-Integrated Circuit Driver

I2C DMA Driver

void I2C_MasterTransferCreateHandleDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, i2c_master_dma_transfer_callback_t callback, void *userData, dma_handle_t *dmaHandle)

Init the I2C handle which is used in transactional functions.

Parameters:

base – I2C peripheral base address
handle – pointer to i2c_master_dma_handle_t structure
callback – pointer to user callback function
userData – user param passed to the callback function
dmaHandle – DMA handle pointer

status_t I2C_MasterTransferDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, i2c_master_transfer_t *xfer)

Performs a master dma non-blocking transfer on the I2C bus.

Parameters:

base – I2C peripheral base address
handle – pointer to i2c_master_dma_handle_t structure
xfer – pointer to transfer structure of i2c_master_transfer_t

Return values:

kStatus_Success – Sucessully 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.

status_t I2C_MasterTransferGetCountDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, size_t *count)

Get master transfer status during a dma non-blocking transfer.

Parameters:

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

void I2C_MasterTransferAbortDMA(I2C_Type *base, i2c_master_dma_handle_t *handle)

Abort a master dma non-blocking transfer in a early time.

Parameters:

base – I2C peripheral base address
handle – pointer to i2c_master_dma_handle_t structure

FSL_I2C_DMA_DRIVER_VERSION: I2C DMA driver version.

typedef struct _i2c_master_dma_handle i2c_master_dma_handle_t: I2C master dma handle typedef.

typedef void (*i2c_master_dma_transfer_callback_t)(I2C_Type *base, i2c_master_dma_handle_t *handle, status_t status, void *userData): I2C master dma transfer callback typedef.

typedef void (*flexcomm_i2c_dma_master_irq_handler_t)(I2C_Type *base, i2c_master_dma_handle_t *handle): Typedef for master dma handler.

I2C_MAX_DMA_TRANSFER_COUNT: Maximum lenght of single DMA transfer (determined by capability of the DMA engine)

struct _i2c_master_dma_handle

#include <fsl_i2c_dma.h>

I2C master dma transfer structure.

Public Members

uint8_t state: Transfer state machine current state.

uint32_t transferCount: Indicates progress of the transfer

uint32_t remainingBytesDMA: Remaining byte count to be transferred using DMA.

uint8_t *buf: Buffer pointer for current state.

bool checkAddrNack: Whether to check the nack signal is detected during addressing.

dma_handle_t *dmaHandle: The DMA handler used.

i2c_master_transfer_t transfer: Copy of the current transfer info.

i2c_master_dma_transfer_callback_t completionCallback: Callback function called after dma transfer finished.

void *userData: Callback parameter passed to callback function.

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_Timeout: Timeout when waiting for I2C master/slave pending status to set to continue transfer.

enumerator kStatus_I2C_Addr_Nak: NAK received for Address

enumerator kStatus_I2C_EventTimeout: Timeout waiting for bus event.

enumerator kStatus_I2C_SclLowTimeout: Timeout SCL signal remains low.

enum _i2c_status_flags

I2C status 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. bit 0

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

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

enumerator kI2C_MasterIdleFlag: The I2C master idle status. bit 5

enumerator kI2C_MasterRxReadyFlag: The I2C master rx ready status. bit 1

enumerator kI2C_MasterTxReadyFlag: The I2C master tx ready status. bit 2

enumerator kI2C_MasterAddrNackFlag: The I2C master address nack status. bit 7

enumerator kI2C_MasterDataNackFlag: The I2C master data nack status. bit 3

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

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

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

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

enumerator kI2C_SlaveAddressedFlag: One of the I2C slave’s 4 addresses is matched. bit 22

enumerator kI2C_SlaveReceiveFlag: Slave receive data available. bit 9

enumerator kI2C_SlaveTransmitFlag: Slave data can be transmitted. bit 10

enumerator kI2C_SlaveAddress0MatchFlag: Slave address0 match. bit 20

enumerator kI2C_SlaveAddress1MatchFlag: Slave address1 match. bit 12

enumerator kI2C_SlaveAddress2MatchFlag: Slave address2 match. bit 13

enumerator kI2C_SlaveAddress3MatchFlag: Slave address3 match. bit 21

enumerator kI2C_MonitorReadyFlag: The I2C monitor ready interrupt. bit 16

enumerator kI2C_MonitorOverflowFlag: The monitor data overrun interrupt. bit 17

enumerator kI2C_MonitorActiveFlag: The monitor is active. bit 18

enumerator kI2C_MonitorIdleFlag: The monitor idle interrupt. bit 19

enumerator kI2C_EventTimeoutFlag: The bus event timeout interrupt. bit 24

enumerator kI2C_SclTimeoutFlag: The SCL timeout interrupt. bit 25

enumerator kI2C_MasterAllClearFlags

enumerator kI2C_SlaveAllClearFlags

enumerator kI2C_CommonAllClearFlags

enum _i2c_interrupt_enable

I2C interrupt enable.

Note

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

Values:

enumerator kI2C_MasterPendingInterruptEnable: The I2C master communication pending interrupt.

enumerator kI2C_MasterArbitrationLostInterruptEnable: The I2C master arbitration lost interrupt.

enumerator kI2C_MasterStartStopErrorInterruptEnable: The I2C master start/stop timing error interrupt.

enumerator kI2C_SlavePendingInterruptEnable: The I2C slave communication pending interrupt.

enumerator kI2C_SlaveNotStretchingInterruptEnable: The I2C slave not streching interrupt, deep-sleep mode can be entered only when this interrupt occurs.

enumerator kI2C_SlaveDeselectedInterruptEnable: The I2C slave deselection interrupt.

enumerator kI2C_MonitorReadyInterruptEnable: The I2C monitor ready interrupt.

enumerator kI2C_MonitorOverflowInterruptEnable: The monitor data overrun interrupt.

enumerator kI2C_MonitorIdleInterruptEnable: The monitor idle interrupt.

enumerator kI2C_EventTimeoutInterruptEnable: The bus event timeout interrupt.

enumerator kI2C_SclTimeoutInterruptEnable: The SCL timeout interrupt.

enumerator kI2C_MasterAllInterruptEnable

enumerator kI2C_SlaveAllInterruptEnable

enumerator kI2C_CommonAllInterruptEnable

I2C_RETRY_TIMES: Retry times for waiting flag.

I2C_MASTER_TRANSMIT_IGNORE_LAST_NACK: Whether to ignore the nack signal of the last byte during master transmit.

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.

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_status_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_ClearStatusFlags(I2C_Type *base, uint32_t statusMask)

Clears the I2C status flag state.

Refer to kI2C_CommonAllClearStatusFlags, kI2C_MasterAllClearStatusFlags and kI2C_SlaveAllClearStatusFlags to see the clearable flags. Attempts to clear other flags has no effect.

See also

_i2c_status_flags, _i2c_master_status_flags and _i2c_slave_status_flags.

Parameters:

base – The I2C peripheral base address.
statusMask – A bitmask of status flags that are to be cleared. The mask is composed of the members in kI2C_CommonAllClearStatusFlags, kI2C_MasterAllClearStatusFlags and kI2C_SlaveAllClearStatusFlags. You may pass the result of a previous call to I2C_GetStatusFlags().

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

Clears the I2C master status flag state.

Deprecated:

Do not use this function. It has been superceded by I2C_ClearStatusFlags The following status register flags can be cleared:

kI2C_MasterArbitrationLostFlag
kI2C_MasterStartStopErrorFlag

Attempts to clear other flags has no effect.

See also

_i2c_status_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_status_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 interrupt requests.

Parameters:

base – The I2C peripheral base address.
interruptMask – Bit mask of interrupts to enable. See _i2c_interrupt_enable 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 interrupt requests.

Parameters:

base – The I2C peripheral base address.
interruptMask – Bit mask of interrupts to disable. See _i2c_interrupt_enable 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 interrupt requests.

Parameters:

base – The I2C peripheral base address.

Returns:

A bitmask composed of _i2c_interrupt_enable 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.

void I2C_MasterSetTimeoutValue(I2C_Type *base, uint8_t timeout_Ms, uint32_t srcClock_Hz)

Sets the I2C bus timeout value.

If the SCL signal remains low or bus does not have event longer than the timeout value, kI2C_SclTimeoutFlag or kI2C_EventTimeoutFlag is set. This can indicete the bus is held by slave or any fault occurs to the I2C module.

Parameters:

base – The I2C peripheral base address.
timeout_Ms – Timeout value in millisecond.
srcClock_Hz – I2C functional clock frequency in Hertz.

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.
kStataus_I2C_Addr_Nak – Transfer error, receive NAK during addressing.

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 – Timeout during polling for flags.

void I2C_MasterTransferHandleIRQ(I2C_Type *base, i2c_master_handle_t *handle)

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.
handle – Pointer to the I2C master driver handle.

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.

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.

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.

uint8_t timeout_Ms: Event timeout and SCL low timeout value.

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.

uint8_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.

bool checkAddrNack: Whether to check the nack signal is detected during addressing.

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.

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_SlaveTransferAbort() API shall be called.

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.

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

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.
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, i2c_slave_handle_t *handle)

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.
handle – Pointer to i2c_slave_handle_t structure which stores the transfer state.

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.

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.

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 (*flexcomm_i2c_master_irq_handler_t)(I2C_Type *base, i2c_master_handle_t *handle): Typedef for master interrupt handler.

typedef void (*flexcomm_i2c_slave_irq_handler_t)(I2C_Type *base, i2c_slave_handle_t *handle): Typedef for slave 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.

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.

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.

I2S: I2S Driver

I2S DMA Driver

void I2S_TxTransferCreateHandleDMA(I2S_Type *base, i2s_dma_handle_t *handle, dma_handle_t *dmaHandle, i2s_dma_transfer_callback_t callback, void *userData)

Initializes handle for transfer of audio data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
dmaHandle – pointer to dma handle structure.
callback – function to be called back when transfer is done or fails.
userData – pointer to data passed to callback.

status_t I2S_TxTransferSendDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t transfer)

Begins or queue sending of the given data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
transfer – data buffer.

Return values:

kStatus_Success –
kStatus_I2S_Busy – if all queue slots are occupied with unsent buffers.

void I2S_TransferAbortDMA(I2S_Type *base, i2s_dma_handle_t *handle)

Aborts transfer of data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.

void I2S_RxTransferCreateHandleDMA(I2S_Type *base, i2s_dma_handle_t *handle, dma_handle_t *dmaHandle, i2s_dma_transfer_callback_t callback, void *userData)

Initializes handle for reception of audio data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
dmaHandle – pointer to dma handle structure.
callback – function to be called back when transfer is done or fails.
userData – pointer to data passed to callback.

status_t I2S_RxTransferReceiveDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t transfer)

Begins or queue reception of data into given buffer.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
transfer – data buffer.

Return values:

kStatus_Success –
kStatus_I2S_Busy – if all queue slots are occupied with buffers which are not full.

void I2S_DMACallback(dma_handle_t *handle, void *userData, bool transferDone, uint32_t tcds)

Invoked from DMA interrupt handler.

Parameters:

handle – pointer to DMA handle structure.
userData – argument for user callback.
transferDone – if transfer was done.
tcds –

void I2S_TransferInstallLoopDMADescriptorMemory(i2s_dma_handle_t *handle, void *dmaDescriptorAddr, size_t dmaDescriptorNum)

Install DMA descriptor memory for loop transfer only.

This function used to register DMA descriptor memory for the i2s loop dma transfer.

It must be callbed before I2S_TransferSendLoopDMA/I2S_TransferReceiveLoopDMA and after I2S_RxTransferCreateHandleDMA/I2S_TxTransferCreateHandleDMA.

User should be take care about the address of DMA descriptor pool which required align with 16BYTE at least.

Parameters:

handle – Pointer to i2s DMA transfer handle.
dmaDescriptorAddr – DMA descriptor start address.
dmaDescriptorNum – DMA descriptor number.

status_t I2S_TransferSendLoopDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t *xfer, uint32_t loopTransferCount)

Send link transfer data using DMA.

This function receives data using DMA. This is a non-blocking function, which returns right away. When all data is received, the receive callback function is called.

This function support loop transfer, such as A->B->…->A, the loop transfer chain will be converted into a chain of descriptor and submit to dma. Application must be aware of that the more counts of the loop transfer, then more DMA descriptor memory required, user can use function I2S_InstallDMADescriptorMemory to register the dma descriptor memory.

As the DMA support maximum 1024 transfer count, so application must be aware of that this transfer function support maximum 1024 samples in each transfer, otherwise assert error or error status will be returned. Once the loop transfer start, application can use function I2S_TransferAbortDMA to stop the loop transfer.

Parameters:

base – I2S peripheral base address.
handle – Pointer to usart_dma_handle_t structure.
xfer – I2S DMA transfer structure. See i2s_transfer_t.
loopTransferCount – loop count

Return values:

kStatus_Success –

status_t I2S_TransferReceiveLoopDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t *xfer, uint32_t loopTransferCount)

Receive link transfer data using DMA.

This function receives data using DMA. This is a non-blocking function, which returns right away. When all data is received, the receive callback function is called.

This function support loop transfer, such as A->B->…->A, the loop transfer chain will be converted into a chain of descriptor and submit to dma. Application must be aware of that the more counts of the loop transfer, then more DMA descriptor memory required, user can use function I2S_InstallDMADescriptorMemory to register the dma descriptor memory.

As the DMA support maximum 1024 transfer count, so application must be aware of that this transfer function support maximum 1024 samples in each transfer, otherwise assert error or error status will be returned. Once the loop transfer start, application can use function I2S_TransferAbortDMA to stop the loop transfer.

Parameters:

base – I2S peripheral base address.
handle – Pointer to usart_dma_handle_t structure.
xfer – I2S DMA transfer structure. See i2s_transfer_t.
loopTransferCount – loop count

Return values:

kStatus_Success –

FSL_I2S_DMA_DRIVER_VERSION: I2S DMA driver version 2.3.3.

typedef struct _i2s_dma_handle i2s_dma_handle_t: Members not to be accessed / modified outside of the driver.

typedef void (*i2s_dma_transfer_callback_t)(I2S_Type *base, i2s_dma_handle_t *handle, status_t completionStatus, void *userData)

Callback function invoked from DMA API on completion.

Param base:: I2S base pointer.
Param handle:: pointer to I2S transaction.
Param completionStatus:: status of the transaction.
Param userData:: optional pointer to user arguments data.

struct _i2s_dma_handle

#include <fsl_i2s_dma.h>

i2s dma handle

Public Members

uint32_t state: Internal state of I2S DMA transfer

uint8_t bytesPerFrame: bytes per frame

i2s_dma_transfer_callback_t completionCallback: Callback function pointer

void *userData: Application data passed to callback

dma_handle_t *dmaHandle: DMA handle

volatile i2s_transfer_t i2sQueue[(4U)]: Transfer queue storing transfer buffers

volatile uint8_t queueUser: Queue index where user’s next transfer will be stored

volatile uint8_t queueDriver: Queue index of buffer actually used by the driver

dma_descriptor_t *i2sLoopDMADescriptor: descriptor pool pointer

size_t i2sLoopDMADescriptorNum: number of descriptor in descriptors pool

I2S Driver

void I2S_TxInit(I2S_Type *base, const i2s_config_t *config)

Initializes the FLEXCOMM peripheral for I2S transmit functionality.

Ungates the FLEXCOMM clock and configures the module for I2S transmission using a configuration structure. The configuration structure can be custom filled or set with default values by I2S_TxGetDefaultConfig().

Note

This API should be called at the beginning of the application to use the I2S driver.

Parameters:

base – I2S base pointer.
config – pointer to I2S configuration structure.

void I2S_RxInit(I2S_Type *base, const i2s_config_t *config)

Initializes the FLEXCOMM peripheral for I2S receive functionality.

Ungates the FLEXCOMM clock and configures the module for I2S receive using a configuration structure. The configuration structure can be custom filled or set with default values by I2S_RxGetDefaultConfig().

Note

This API should be called at the beginning of the application to use the I2S driver.

Parameters:

base – I2S base pointer.
config – pointer to I2S configuration structure.

void I2S_TxGetDefaultConfig(i2s_config_t *config)

Sets the I2S Tx configuration structure to default values.

This API initializes the configuration structure for use in I2S_TxInit(). The initialized structure can remain unchanged in I2S_TxInit(), or it can be modified before calling I2S_TxInit(). Example:

i2s_config_t config;
I2S_TxGetDefaultConfig(&config);

Default values:

config->masterSlave = kI2S_MasterSlaveNormalMaster;
config->mode = kI2S_ModeI2sClassic;
config->rightLow = false;
config->leftJust = false;
config->pdmData = false;
config->sckPol = false;
config->wsPol = false;
config->divider = 1;
config->oneChannel = false;
config->dataLength = 16;
config->frameLength = 32;
config->position = 0;
config->watermark = 4;
config->txEmptyZero = true;
config->pack48 = false;

Parameters:

config – pointer to I2S configuration structure.

void I2S_RxGetDefaultConfig(i2s_config_t *config)

Sets the I2S Rx configuration structure to default values.

This API initializes the configuration structure for use in I2S_RxInit(). The initialized structure can remain unchanged in I2S_RxInit(), or it can be modified before calling I2S_RxInit(). Example:

i2s_config_t config;
I2S_RxGetDefaultConfig(&config);

Default values:

config->masterSlave = kI2S_MasterSlaveNormalSlave;
config->mode = kI2S_ModeI2sClassic;
config->rightLow = false;
config->leftJust = false;
config->pdmData = false;
config->sckPol = false;
config->wsPol = false;
config->divider = 1;
config->oneChannel = false;
config->dataLength = 16;
config->frameLength = 32;
config->position = 0;
config->watermark = 4;
config->txEmptyZero = false;
config->pack48 = false;

Parameters:

config – pointer to I2S configuration structure.

void I2S_Deinit(I2S_Type *base)

De-initializes the I2S peripheral.

This API gates the FLEXCOMM clock. The I2S module can’t operate unless I2S_TxInit or I2S_RxInit is called to enable the clock.

Parameters:

base – I2S base pointer.

void I2S_SetBitClockRate(I2S_Type *base, uint32_t sourceClockHz, uint32_t sampleRate, uint32_t bitWidth, uint32_t channelNumbers)

Transmitter/Receiver bit clock rate configurations.

Parameters:

base – SAI base pointer.
sourceClockHz – bit clock source frequency.
sampleRate – audio data sample rate.
bitWidth – audio data bitWidth.
channelNumbers – audio channel numbers.

void I2S_TxTransferCreateHandle(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_callback_t callback, void *userData)

Initializes handle for transfer of audio data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
callback – function to be called back when transfer is done or fails.
userData – pointer to data passed to callback.

status_t I2S_TxTransferNonBlocking(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_t transfer)

Begins or queue sending of the given data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
transfer – data buffer.

Return values:

kStatus_Success –
kStatus_I2S_Busy – if all queue slots are occupied with unsent buffers.

void I2S_TxTransferAbort(I2S_Type *base, i2s_handle_t *handle)

Aborts sending of data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.

void I2S_RxTransferCreateHandle(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_callback_t callback, void *userData)

Initializes handle for reception of audio data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
callback – function to be called back when transfer is done or fails.
userData – pointer to data passed to callback.

status_t I2S_RxTransferNonBlocking(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_t transfer)

Begins or queue reception of data into given buffer.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
transfer – data buffer.

Return values:

kStatus_Success –
kStatus_I2S_Busy – if all queue slots are occupied with buffers which are not full.

void I2S_RxTransferAbort(I2S_Type *base, i2s_handle_t *handle)

Aborts receiving of data.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.

status_t I2S_TransferGetCount(I2S_Type *base, i2s_handle_t *handle, size_t *count)

Returns number of bytes transferred so far.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
count – [out] number of bytes transferred so far by the non-blocking transaction.

Return values:

kStatus_Success –
kStatus_NoTransferInProgress – there is no non-blocking transaction currently in progress.

status_t I2S_TransferGetErrorCount(I2S_Type *base, i2s_handle_t *handle, size_t *count)

Returns number of buffer underruns or overruns.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.
count – [out] number of transmit errors encountered so far by the non-blocking transaction.

Return values:

kStatus_Success –
kStatus_NoTransferInProgress – there is no non-blocking transaction currently in progress.

static inline void I2S_Enable(I2S_Type *base)

Enables I2S operation.

Parameters:

base – I2S base pointer.

void I2S_EnableSecondaryChannel(I2S_Type *base, uint32_t channel, bool oneChannel, uint32_t position)

Enables I2S secondary channel.

Parameters:

base – I2S base pointer.
channel – seondary channel channel number, reference _i2s_secondary_channel.
oneChannel – true is treated as single channel, functionality left channel for this pair.
position – define the location within the frame of the data, should not bigger than 0x1FFU.

static inline void I2S_DisableSecondaryChannel(I2S_Type *base, uint32_t channel)

Disables I2S secondary channel.

Parameters:

base – I2S base pointer.
channel – seondary channel channel number, reference _i2s_secondary_channel.

static inline void I2S_Disable(I2S_Type *base)

Disables I2S operation.

Parameters:

base – I2S base pointer.

static inline void I2S_EnableInterrupts(I2S_Type *base, uint32_t interruptMask)

Enables I2S FIFO interrupts.

Parameters:

base – I2S base pointer.
interruptMask – bit mask of interrupts to enable. See i2s_flags_t for the set of constants that should be OR’d together to form the bit mask.

static inline void I2S_DisableInterrupts(I2S_Type *base, uint32_t interruptMask)

Disables I2S FIFO interrupts.

Parameters:

base – I2S base pointer.
interruptMask – bit mask of interrupts to enable. See i2s_flags_t for the set of constants that should be OR’d together to form the bit mask.

static inline uint32_t I2S_GetEnabledInterrupts(I2S_Type *base)

Returns the set of currently enabled I2S FIFO interrupts.

Parameters:

base – I2S base pointer.

Returns:

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

status_t I2S_EmptyTxFifo(I2S_Type *base)

Flush the valid data in TX fifo.

Parameters:

base – I2S base pointer.

Returns:

kStatus_Fail empty TX fifo failed, kStatus_Success empty tx fifo success.

void I2S_TxHandleIRQ(I2S_Type *base, i2s_handle_t *handle)

Invoked from interrupt handler when transmit FIFO level decreases.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.

void I2S_RxHandleIRQ(I2S_Type *base, i2s_handle_t *handle)

Invoked from interrupt handler when receive FIFO level decreases.

Parameters:

base – I2S base pointer.
handle – pointer to handle structure.

FSL_I2S_DRIVER_VERSION: I2S driver version 2.3.2.

_i2s_status I2S status codes.

Values:

enumerator kStatus_I2S_BufferComplete: Transfer from/into a single buffer has completed

enumerator kStatus_I2S_Done: All buffers transfers have completed

enumerator kStatus_I2S_Busy: Already performing a transfer and cannot queue another buffer

enum _i2s_flags

I2S flags.

Note

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

Values:

enumerator kI2S_TxErrorFlag: TX error interrupt

enumerator kI2S_TxLevelFlag: TX level interrupt

enumerator kI2S_RxErrorFlag: RX error interrupt

enumerator kI2S_RxLevelFlag: RX level interrupt

enum _i2s_master_slave

Master / slave mode.

Values:

enumerator kI2S_MasterSlaveNormalSlave: Normal slave

enumerator kI2S_MasterSlaveWsSyncMaster: WS synchronized master

enumerator kI2S_MasterSlaveExtSckMaster: Master using existing SCK

enumerator kI2S_MasterSlaveNormalMaster: Normal master

enum _i2s_mode

I2S mode.

Values:

enumerator kI2S_ModeI2sClassic: I2S classic mode

enumerator kI2S_ModeDspWs50: DSP mode, WS having 50% duty cycle

enumerator kI2S_ModeDspWsShort: DSP mode, WS having one clock long pulse

enumerator kI2S_ModeDspWsLong: DSP mode, WS having one data slot long pulse

_i2s_secondary_channel I2S secondary channel.

Values:

enumerator kI2S_SecondaryChannel1: secondary channel 1

enumerator kI2S_SecondaryChannel2: secondary channel 2

enumerator kI2S_SecondaryChannel3: secondary channel 3

typedef enum _i2s_flags i2s_flags_t: I2S flags.

Note

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

typedef enum _i2s_master_slave i2s_master_slave_t: Master / slave mode.

typedef enum _i2s_mode i2s_mode_t: I2S mode.

typedef struct _i2s_config i2s_config_t: I2S configuration structure.

typedef struct _i2s_transfer i2s_transfer_t: Buffer to transfer from or receive audio data into.

typedef struct _i2s_handle i2s_handle_t: Transactional state of the intialized transfer or receive I2S operation.

typedef void (*i2s_transfer_callback_t)(I2S_Type *base, i2s_handle_t *handle, status_t completionStatus, void *userData)

Callback function invoked from transactional API on completion of a single buffer transfer.

Param base:: I2S base pointer.
Param handle:: pointer to I2S transaction.
Param completionStatus:: status of the transaction.
Param userData:: optional pointer to user arguments data.

I2S_NUM_BUFFERS: Number of buffers .

struct _i2s_config

#include <fsl_i2s.h>

I2S configuration structure.

Public Members

i2s_master_slave_t masterSlave: Master / slave configuration

i2s_mode_t mode: I2S mode

bool rightLow: Right channel data in low portion of FIFO

bool leftJust: Left justify data in FIFO

bool pdmData: Data source is the D-Mic subsystem

bool sckPol: SCK polarity

bool wsPol: WS polarity

uint16_t divider: Flexcomm function clock divider (1 - 4096)

bool oneChannel: true mono, false stereo

uint8_t dataLength: Data length (4 - 32)

uint16_t frameLength: Frame width (4 - 512)

uint16_t position: Data position in the frame

uint8_t watermark: FIFO trigger level

bool txEmptyZero: Transmit zero when buffer becomes empty or last item

bool pack48: Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit values)

struct _i2s_transfer

#include <fsl_i2s.h>

Buffer to transfer from or receive audio data into.

Public Members

uint8_t *data: Pointer to data buffer.

size_t dataSize: Buffer size in bytes.

struct _i2s_handle

#include <fsl_i2s.h>

Members not to be accessed / modified outside of the driver.

Public Members

volatile uint32_t state: State of transfer

i2s_transfer_callback_t completionCallback: Callback function pointer

void *userData: Application data passed to callback

bool oneChannel: true mono, false stereo

uint8_t dataLength: Data length (4 - 32)

bool pack48: Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit values)

uint8_t watermark: FIFO trigger level

bool useFifo48H: When dataLength 17-24: true use FIFOWR48H, false use FIFOWR

volatile i2s_transfer_t i2sQueue[(4U)]: Transfer queue storing transfer buffers

volatile uint8_t queueUser: Queue index where user’s next transfer will be stored

volatile uint8_t queueDriver: Queue index of buffer actually used by the driver

volatile uint32_t errorCount: Number of buffer underruns/overruns

volatile uint32_t transferCount: Number of bytes transferred

INPUTMUX: Input Multiplexing Driver

enum _inputmux_connection_t

INPUTMUX connections type.

Values:

enumerator kINPUTMUX_SctGpi0ToSct0: SCT0 INMUX.

enumerator kINPUTMUX_SctGpi1ToSct0

enumerator kINPUTMUX_SctGpi2ToSct0

enumerator kINPUTMUX_SctGpi3ToSct0

enumerator kINPUTMUX_SctGpi4ToSct0

enumerator kINPUTMUX_SctGpi5ToSct0

enumerator kINPUTMUX_SctGpi6ToSct0

enumerator kINPUTMUX_SctGpi7ToSct0

enumerator kINPUTMUX_Ctimer0M0ToSct0

enumerator kINPUTMUX_Ctimer1M0ToSct0

enumerator kINPUTMUX_Ctimer2M0ToSct0

enumerator kINPUTMUX_Ctimer3M0ToSct0

enumerator kINPUTMUX_Ctimer4M0ToSct0

enumerator kINPUTMUX_AdcIrqToSct0

enumerator kINPUTMUX_GpiointBmatchToSct0

enumerator kINPUTMUX_CompOutToSct0

enumerator kINPUTMUX_I2sSharedSck0ToSct0

enumerator kINPUTMUX_I2sSharedSck1ToSct0

enumerator kINPUTMUX_I2sSharedWs0ToSct0

enumerator kINPUTMUX_I2sSharedWs1ToSct0

enumerator kINPUTMUX_ArmTxevToSct0

enumerator kINPUTMUX_DebugHaltedToSct0: TIMER0 CAPTSEL.

enumerator kINPUTMUX_CtimerInp0ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp1ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp2ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp3ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp4ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp5ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp6ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp7ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp8ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp9ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp10ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp11ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp12ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp13ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp14ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp15ToTimer0Captsel

enumerator kINPUTMUX_CtimerInp16ToTimer0Captsel

enumerator kINPUTMUX_CompOutToTimer0Captsel

enumerator kINPUTMUX_I2sSharedWs0ToTimer0Captsel

enumerator kINPUTMUX_I2sSharedWs1ToTimer0Captsel: TIMER1 CAPTSEL.

enumerator kINPUTMUX_CtimerInp0ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp1ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp2ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp3ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp4ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp5ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp6ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp7ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp8ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp9ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp10ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp11ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp12ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp13ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp14ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp15ToTimer1Captsel

enumerator kINPUTMUX_CtimerInp16ToTimer1Captsel

enumerator kINPUTMUX_CompOutToTimer1Captsel

enumerator kINPUTMUX_I2sSharedWs0ToTimer1Captsel

enumerator kINPUTMUX_I2sSharedWs1ToTimer1Captsel: TIMER2 CAPTSEL.

enumerator kINPUTMUX_CtimerInp0ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp1ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp2ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp3ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp4ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp5ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp6ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp7ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp8ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp9ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp10ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp11ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp12ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp13ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp14ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp15ToTimer2Captsel

enumerator kINPUTMUX_CtimerInp16ToTimer2Captsel

enumerator kINPUTMUX_CompOutToTimer2Captsel

enumerator kINPUTMUX_I2sSharedWs0ToTimer2Captsel

enumerator kINPUTMUX_I2sSharedWs1ToTimer2Captsel: Pin interrupt select.

enumerator kINPUTMUX_GpioPort0Pin0ToPintsel

enumerator kINPUTMUX_GpioPort0Pin1ToPintsel

enumerator kINPUTMUX_GpioPort0Pin2ToPintsel

enumerator kINPUTMUX_GpioPort0Pin3ToPintsel

enumerator kINPUTMUX_GpioPort0Pin4ToPintsel

enumerator kINPUTMUX_GpioPort0Pin5ToPintsel

enumerator kINPUTMUX_GpioPort0Pin6ToPintsel

enumerator kINPUTMUX_GpioPort0Pin7ToPintsel

enumerator kINPUTMUX_GpioPort0Pin8ToPintsel

enumerator kINPUTMUX_GpioPort0Pin9ToPintsel

enumerator kINPUTMUX_GpioPort0Pin10ToPintsel

enumerator kINPUTMUX_GpioPort0Pin11ToPintsel

enumerator kINPUTMUX_GpioPort0Pin12ToPintsel

enumerator kINPUTMUX_GpioPort0Pin13ToPintsel

enumerator kINPUTMUX_GpioPort0Pin14ToPintsel

enumerator kINPUTMUX_GpioPort0Pin15ToPintsel

enumerator kINPUTMUX_GpioPort0Pin16ToPintsel

enumerator kINPUTMUX_GpioPort0Pin17ToPintsel

enumerator kINPUTMUX_GpioPort0Pin18ToPintsel

enumerator kINPUTMUX_GpioPort0Pin19ToPintsel

enumerator kINPUTMUX_GpioPort0Pin20ToPintsel

enumerator kINPUTMUX_GpioPort0Pin21ToPintsel

enumerator kINPUTMUX_GpioPort0Pin22ToPintsel

enumerator kINPUTMUX_GpioPort0Pin23ToPintsel

enumerator kINPUTMUX_GpioPort0Pin24ToPintsel

enumerator kINPUTMUX_GpioPort0Pin25ToPintsel

enumerator kINPUTMUX_GpioPort0Pin26ToPintsel

enumerator kINPUTMUX_GpioPort0Pin27ToPintsel

enumerator kINPUTMUX_GpioPort0Pin28ToPintsel

enumerator kINPUTMUX_GpioPort0Pin29ToPintsel

enumerator kINPUTMUX_GpioPort0Pin30ToPintsel

enumerator kINPUTMUX_GpioPort0Pin31ToPintsel

enumerator kINPUTMUX_GpioPort1Pin0ToPintsel

enumerator kINPUTMUX_GpioPort1Pin1ToPintsel

enumerator kINPUTMUX_GpioPort1Pin2ToPintsel

enumerator kINPUTMUX_GpioPort1Pin3ToPintsel

enumerator kINPUTMUX_GpioPort1Pin4ToPintsel

enumerator kINPUTMUX_GpioPort1Pin5ToPintsel

enumerator kINPUTMUX_GpioPort1Pin6ToPintsel

enumerator kINPUTMUX_GpioPort1Pin7ToPintsel

enumerator kINPUTMUX_GpioPort1Pin8ToPintsel

enumerator kINPUTMUX_GpioPort1Pin9ToPintsel

enumerator kINPUTMUX_GpioPort1Pin10ToPintsel

enumerator kINPUTMUX_GpioPort1Pin11ToPintsel

enumerator kINPUTMUX_GpioPort1Pin12ToPintsel

enumerator kINPUTMUX_GpioPort1Pin13ToPintsel

enumerator kINPUTMUX_GpioPort1Pin14ToPintsel

enumerator kINPUTMUX_GpioPort1Pin15ToPintsel

enumerator kINPUTMUX_GpioPort1Pin16ToPintsel

enumerator kINPUTMUX_GpioPort1Pin17ToPintsel

enumerator kINPUTMUX_GpioPort1Pin18ToPintsel

enumerator kINPUTMUX_GpioPort1Pin19ToPintsel

enumerator kINPUTMUX_GpioPort1Pin20ToPintsel

enumerator kINPUTMUX_GpioPort1Pin21ToPintsel

enumerator kINPUTMUX_GpioPort1Pin22ToPintsel

enumerator kINPUTMUX_GpioPort1Pin23ToPintsel

enumerator kINPUTMUX_GpioPort1Pin24ToPintsel

enumerator kINPUTMUX_GpioPort1Pin25ToPintsel

enumerator kINPUTMUX_GpioPort1Pin26ToPintsel

enumerator kINPUTMUX_GpioPort1Pin27ToPintsel

enumerator kINPUTMUX_GpioPort1Pin28ToPintsel

enumerator kINPUTMUX_GpioPort1Pin29ToPintsel

enumerator kINPUTMUX_GpioPort1Pin30ToPintsel

enumerator kINPUTMUX_GpioPort1Pin31ToPintsel: DMA0 Input trigger.

enumerator kINPUTMUX_PinInt0ToDma0

enumerator kINPUTMUX_PinInt1ToDma0

enumerator kINPUTMUX_PinInt2ToDma0

enumerator kINPUTMUX_PinInt3ToDma0

enumerator kINPUTMUX_Ctimer0M0ToDma0

enumerator kINPUTMUX_Ctimer0M1ToDma0

enumerator kINPUTMUX_Ctimer1M0ToDma0

enumerator kINPUTMUX_Ctimer1M1ToDma0

enumerator kINPUTMUX_Ctimer2M0ToDma0

enumerator kINPUTMUX_Ctimer2M1ToDma0

enumerator kINPUTMUX_Ctimer3M0ToDma0

enumerator kINPUTMUX_Ctimer3M1ToDma0

enumerator kINPUTMUX_Ctimer4M0ToDma0

enumerator kINPUTMUX_Ctimer4M1ToDma0

enumerator kINPUTMUX_CompOutToDma0

enumerator kINPUTMUX_Otrig0ToDma0

enumerator kINPUTMUX_Otrig1ToDma0

enumerator kINPUTMUX_Otrig2ToDma0

enumerator kINPUTMUX_Otrig3ToDma0

enumerator kINPUTMUX_Sct0DmaReq0ToDma0

enumerator kINPUTMUX_Sct0DmaReq1ToDma0

enumerator kINPUTMUX_HashDmaRxToDma0: DMA0 output trigger.

enumerator kINPUTMUX_Dma0Hash0TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0HsLspiRxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0HsLspiTxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm0RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm0TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm1RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm1TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm3RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm3TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm2RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm2TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm4RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm4TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm5RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm5TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm6RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm6TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm7RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Flexcomm7TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Adc0Ch0TrigoutToTriginChannels

enumerator kINPUTMUX_Dma0Adc0Ch1TrigoutToTriginChannels: Selection for frequency measurement reference clock.

enumerator kINPUTMUX_ExternOscToFreqmeasRef

enumerator kINPUTMUX_Fro12MhzToFreqmeasRef

enumerator kINPUTMUX_Fro96MhzToFreqmeasRef

enumerator kINPUTMUX_WdtOscToFreqmeasRef

enumerator kINPUTMUX_32KhzOscToFreqmeasRef

enumerator kINPUTMUX_MainClkToFreqmeasRef

enumerator kINPUTMUX_FreqmeGpioClk_aRef

enumerator kINPUTMUX_FreqmeGpioClk_bRef: Selection for frequency measurement target clock.

enumerator kINPUTMUX_ExternOscToFreqmeasTarget

enumerator kINPUTMUX_Fro12MhzToFreqmeasTarget

enumerator kINPUTMUX_Fro96MhzToFreqmeasTarget

enumerator kINPUTMUX_WdtOscToFreqmeasTarget

enumerator kINPUTMUX_32KhzOscToFreqmeasTarget

enumerator kINPUTMUX_MainClkToFreqmeasTarget

enumerator kINPUTMUX_FreqmeGpioClk_aTarget

enumerator kINPUTMUX_FreqmeGpioClk_bTarget: TIMER3 CAPTSEL.

enumerator kINPUTMUX_CtimerInp0ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp1ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp2ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp3ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp4ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp5ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp6ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp7ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp8ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp9ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp10ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp11ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp12ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp13ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp14ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp15ToTimer3Captsel

enumerator kINPUTMUX_CtimerInp16ToTimer3Captsel

enumerator kINPUTMUX_CompOutToTimer3Captsel

enumerator kINPUTMUX_I2sSharedWs0ToTimer3Captsel

enumerator kINPUTMUX_I2sSharedWs1ToTimer3Captsel: Timer4 CAPTSEL.

enumerator kINPUTMUX_CtimerInp0ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp1ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp2ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp3ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp4ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp5ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp6ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp7ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp8ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp9ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp10ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp11ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp12ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp13ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp14ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp15ToTimer4Captsel

enumerator kINPUTMUX_CtimerInp16ToTimer4Captsel

enumerator kINPUTMUX_CompOutToTimer4Captsel

enumerator kINPUTMUX_I2sSharedWs0ToTimer4Captsel

enumerator kINPUTMUX_I2sSharedWs1ToTimer4Captsel

enumerator kINPUTMUX_GpioPort0Pin0ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin1ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin2ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin3ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin4ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin5ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin6ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin7ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin8ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin9ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin10ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin11ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin12ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin13ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin14ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin15ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin16ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin17ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin18ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin19ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin20ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin21ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin22ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin23ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin24ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin25ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin26ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin27ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin28ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin29ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin30ToPintSecsel

enumerator kINPUTMUX_GpioPort0Pin31ToPintSecsel: DMA1 Input trigger.

enumerator kINPUTMUX_PinInt0ToDma1

enumerator kINPUTMUX_PinInt1ToDma1

enumerator kINPUTMUX_PinInt2ToDma1

enumerator kINPUTMUX_PinInt3ToDma1

enumerator kINPUTMUX_Ctimer0M0ToDma1

enumerator kINPUTMUX_Ctimer0M1ToDma1

enumerator kINPUTMUX_Ctimer2M0ToDma1

enumerator kINPUTMUX_Ctimer4M0ToDma1

enumerator kINPUTMUX_Otrig0ToDma1

enumerator kINPUTMUX_Otrig1ToDma1

enumerator kINPUTMUX_Otrig2ToDma1

enumerator kINPUTMUX_Otrig3ToDma1

enumerator kINPUTMUX_Sct0DmaReq0ToDma1

enumerator kINPUTMUX_Sct0DmaReq1ToDma1

enumerator kINPUTMUX_HashDmaRxToDma1: DMA1 output trigger.

enumerator kINPUTMUX_Dma1Hash0TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1HsLspiRxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1HsLspiTxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm0RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm0TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm1RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm1TxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm3RxTrigoutToTriginChannels

enumerator kINPUTMUX_Dma1Flexcomm3TxTrigoutToTriginChannels

enum _inputmux_signal_t

INPUTMUX signal enable/disable type.

Values:

enumerator kINPUTMUX_HashCryptToDmac0Ch0RequestEna: DMA0 REQ signal.

enumerator kINPUTMUX_Flexcomm8RxToDmac0Ch2RequestEna

enumerator kINPUTMUX_Flexcomm8TxToDmac0Ch3RequestEna

enumerator kINPUTMUX_Flexcomm0RxToDmac0Ch4RequestEna

enumerator kINPUTMUX_Flexcomm0TxToDmac0Ch5RequestEna

enumerator kINPUTMUX_Flexcomm1RxToDmac0Ch6RequestEna

enumerator kINPUTMUX_Flexcomm1TxToDmac0Ch7RequestEna

enumerator kINPUTMUX_Flexcomm3RxToDmac0Ch8RequestEna

enumerator kINPUTMUX_Flexcomm3TxToDmac0Ch9RequestEna

enumerator kINPUTMUX_Flexcomm2RxToDmac0Ch10RequestEna

enumerator kINPUTMUX_Flexcomm2TxToDmac0Ch11RequestEna

enumerator kINPUTMUX_Flexcomm4RxToDmac0Ch12RequestEna

enumerator kINPUTMUX_Flexcomm4TxToDmac0Ch13RequestEna

enumerator kINPUTMUX_Flexcomm5RxToDmac0Ch14RequestEna

enumerator kINPUTMUX_Flexcomm5TxToDmac0Ch15RequestEna

enumerator kINPUTMUX_Flexcomm6RxToDmac0Ch16RequestEna

enumerator kINPUTMUX_Flexcomm6TxToDmac0Ch17RequestEna

enumerator kINPUTMUX_Flexcomm7RxToDmac0Ch18RequestEna

enumerator kINPUTMUX_Flexcomm7TxToDmac0Ch19RequestEna

enumerator kINPUTMUX_Adc0FIFO0ToDmac0Ch21RequestEna

enumerator kINPUTMUX_Adc0FIFO1ToDmac0Ch22RequestEna: DMA1 REQ signal.

enumerator kINPUTMUX_HashCryptToDmac1Ch0RequestEna

enumerator kINPUTMUX_Flexcomm8RxToDmac1Ch2RequestEna

enumerator kINPUTMUX_Flexcomm8TxToDmac1Ch3RequestEna

enumerator kINPUTMUX_Flexcomm0RxToDmac1Ch4RequestEna

enumerator kINPUTMUX_Flexcomm0TxToDmac1Ch5RequestEna

enumerator kINPUTMUX_Flexcomm1RxToDmac1Ch6RequestEna

enumerator kINPUTMUX_Flexcomm1TxToDmac1Ch7RequestEna

enumerator kINPUTMUX_Flexcomm3RxToDmac1Ch8RequestEna

enumerator kINPUTMUX_Flexcomm3TxToDmac1Ch9RequestEna: DMA0 input trigger source enable.

enumerator kINPUTMUX_Dmac0InputTriggerPint0Ena

enumerator kINPUTMUX_Dmac0InputTriggerPint1Ena

enumerator kINPUTMUX_Dmac0InputTriggerPint2Ena

enumerator kINPUTMUX_Dmac0InputTriggerPint3Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer0M0Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer0M1Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer1M0Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer1M1Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer2M0Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer2M1Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer3M0Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer3M1Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer4M0Ena

enumerator kINPUTMUX_Dmac0InputTriggerCtimer4M1Ena

enumerator kINPUTMUX_Dmac0InputTriggerCompOutEna

enumerator kINPUTMUX_Dmac0InputTriggerDma0Out0Ena

enumerator kINPUTMUX_Dmac0InputTriggerDma0Out1Ena

enumerator kINPUTMUX_Dmac0InputTriggerDma0Out2Ena

enumerator kINPUTMUX_Dmac0InputTriggerDma0Out3Ena

enumerator kINPUTMUX_Dmac0InputTriggerSctDmac0Ena

enumerator kINPUTMUX_Dmac0InputTriggerSctDmac1Ena

enumerator kINPUTMUX_Dmac0InputTriggerHashOutEna: DMA1 input trigger source enable.

enumerator kINPUTMUX_Dmac1InputTriggerPint0Ena

enumerator kINPUTMUX_Dmac1InputTriggerPint1Ena

enumerator kINPUTMUX_Dmac1InputTriggerPint2Ena

enumerator kINPUTMUX_Dmac1InputTriggerPint3Ena

enumerator kINPUTMUX_Dmac1InputTriggerCtimer0M0Ena

enumerator kINPUTMUX_Dmac1InputTriggerCtimer0M1Ena

enumerator kINPUTMUX_Dmac1InputTriggerCtimer2M0Ena

enumerator kINPUTMUX_Dmac1InputTriggerCtimer4M0Ena

enumerator kINPUTMUX_Dmac1InputTriggerDma1Out0Ena

enumerator kINPUTMUX_Dmac1InputTriggerDma1Out1Ena

enumerator kINPUTMUX_Dmac1InputTriggerDma1Out2Ena

enumerator kINPUTMUX_Dmac1InputTriggerDma1Out3Ena

enumerator kINPUTMUX_Dmac1InputTriggerSctDmac0Ena

enumerator kINPUTMUX_Dmac1InputTriggerSctDmac1Ena

enumerator kINPUTMUX_Dmac1InputTriggerHashOutEna

typedef enum _inputmux_connection_t inputmux_connection_t: INPUTMUX connections type.

typedef enum _inputmux_signal_t inputmux_signal_t: INPUTMUX signal enable/disable type.

SCT0_INMUX0: Periphinmux IDs.

TIMER0CAPTSEL0

TIMER1CAPTSEL0

TIMER2CAPTSEL0

PINTSEL_PMUX_ID

PINTSEL0

DMA0_ITRIG_INMUX0

DMA0_OTRIG_INMUX0

FREQMEAS_REF_REG

FREQMEAS_TARGET_REG

TIMER3CAPTSEL0

TIMER4CAPTSEL0

PINTSECSEL0

DMA1_ITRIG_INMUX0

DMA1_OTRIG_INMUX0

DMA0_REQ_ENA_ID

DMA1_REQ_ENA_ID

DMA0_ITRIG_ENA_ID

DMA1_ITRIG_ENA_ID

ENA_SHIFT

PMUX_SHIFT

FSL_INPUTMUX_DRIVER_VERSION: Group interrupt driver version for SDK.

void INPUTMUX_Init(INPUTMUX_Type *base)

Initialize INPUTMUX peripheral.

This function enables the INPUTMUX clock.

Parameters:

base – Base address of the INPUTMUX peripheral.

Return values:

None. –

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

Attaches a signal.

This function attaches multiplexed signals from INPUTMUX to target signals. For example, to attach GPIO PORT0 Pin 5 to PINT peripheral, do the following:

INPUTMUX_AttachSignal(INPUTMUX, 2, kINPUTMUX_GpioPort0Pin5ToPintsel);

In this example, INTMUX has 8 registers for PINT, PINT_SEL0~PINT_SEL7. With parameter index specified as 2, this function configures register PINT_SEL2.

Parameters:

base – Base address of the INPUTMUX peripheral.
index – The serial number of destination register in the group of INPUTMUX registers with same name.
connection – Applies signal from source signals collection to target signal.

Return values:

None. –

void INPUTMUX_EnableSignal(INPUTMUX_Type *base, inputmux_signal_t signal, bool enable)

Enable/disable a signal.

This function gates the INPUTPMUX clock.

Parameters:

base – Base address of the INPUTMUX peripheral.
signal – Enable signal register id and bit offset.
enable – Selects enable or disable.

Return values:

None. –

void INPUTMUX_Deinit(INPUTMUX_Type *base)

Deinitialize INPUTMUX peripheral.

This function disables the INPUTMUX clock.

Parameters:

base – Base address of the INPUTMUX peripheral.

Return values:

None. –

IAP_KBP Driver

ROM API status codes.

Values:

enumerator kStatus_RomApiExecuteCompleted: ROM successfully process the whole sb file/boot image.

enumerator kStatus_RomApiNeedMoreData: ROM needs more data to continue processing the boot image.

enumerator kStatus_RomApiBufferSizeNotEnough: The user buffer is not enough for use by Kboot during execution of the operation.

enumerator kStatus_RomApiInvalidBuffer: The user buffer is not ok for sbloader or authentication.

enum _kb_operation

Details of the operation to be performed by the ROM.

The kRomAuthenticateImage operation requires the entire signed image to be available to the application.

Values:

enumerator kRomAuthenticateImage: Authenticate a signed image.

enumerator kRomLoadImage: Load SB file.

enumerator kRomOperationCount

enum _kb_security_profile

Security constraint flags, Security profile flags.

Values:

enumerator kKbootMinRSA4096

typedef enum _kb_operation kb_operation_t

Details of the operation to be performed by the ROM.

The kRomAuthenticateImage operation requires the entire signed image to be available to the application.

typedef struct _kb_region kb_region_t: Memory region definition.

typedef struct _kb_load_sb kb_load_sb_t

User-provided options passed into kb_init().

The buffer field is a pointer to memory provided by the caller for use by Kboot during execution of the operation. Minimum size is the size of each certificate in the chain plus 432 bytes additional per certificate.

The profile field is a mask that specifies which features are required in the SB file or image being processed. This includes the minimum AES and RSA key sizes. See the _kb_security_profile enum for profile mask constants. The image being loaded or authenticated must match the profile or an error will be returned.

minBuildNumber is an optional field that can be used to prevent version rollback. The API will check the build number of the image, and if it is less than minBuildNumber will fail with an error.

maxImageLength is used to verify the offsetToCertificateBlockHeaderInBytes value at the beginning of a signed image. It should be set to the length of the SB file. If verifying an image in flash, it can be set to the internal flash size or a large number like 0x10000000.

userRHK can optionally be used by the user to override the RHK in IFR. If userRHK is not NULL, it points to a 32-byte array containing the SHA-256 of the root certificate’s RSA public key.

The regions field points to an array of memory regions that the SB file being loaded is allowed to access. If regions is NULL, then all memory is accessible by the SB file. This feature is required to prevent a malicious image from erasing good code or RAM contents while it is being loaded, only for us to find that the image is inauthentic when we hit the end of the section.

overrideSBBootSectionID lets the caller override the default section of the SB file that is processed during a kKbootLoadSB operation. By default, the section specified in the firstBootableSectionID field of the SB header is loaded. If overrideSBBootSectionID is non-zero, then the section with the given ID will be loaded instead.

The userSBKEK field lets a user provide their own AES-256 key for unwrapping keys in an SB file during the kKbootLoadSB operation. userSBKEK should point to a 32-byte AES-256 key. If userSBKEK is NULL then the IFR SBKEK will be used. After kb_init() returns, the caller should zero out the data pointed to by userSBKEK, as the API will have installed the key in the CAU3.

typedef struct _kb_authenticate kb_authenticate_t

typedef struct _kb_options kb_options_t

typedef struct _memory_region_interface memory_region_interface_t: Interface to memory operations for one region of memory.

typedef struct _memory_map_entry memory_map_entry_t: Structure of a memory map entry.

typedef struct _kb_opaque_session_ref kb_session_ref_t

status_t kb_init(kb_session_ref_t **session, const kb_options_t *options)

Initialize ROM API for a given operation.

Inits the ROM API based on the options provided by the application in the second argument. Every call to rom_init() should be paired with a call to rom_deinit().

Return values:

kStatus_Success – API was executed successfully.
kStatus_InvalidArgument – An invalid argument is provided.
kStatus_RomApiBufferSizeNotEnough – The user buffer is not enough for use by Kboot during execution of the operation.
kStatus_RomApiInvalidBuffer – The user buffer is not ok for sbloader or authentication.
kStatus_SKBOOT_Fail – Return the failed status of secure boot.
kStatus_SKBOOT_KeyStoreMarkerInvalid – The key code for the particular PRINCE region is not present in the keystore
kStatus_SKBOOT_Success – Return the successful status of secure boot.

status_t kb_deinit(kb_session_ref_t *session)

Cleans up the ROM API context.

After this call, the context parameter can be reused for another operation by calling rom_init() again.

Return values:: kStatus_Success – API was executed successfully

status_t kb_execute(kb_session_ref_t *session, const uint8_t *data, uint32_t dataLength)

Perform the operation configured during init.

This application must call this API repeatedly, passing in sequential chunks of data from the boot image (SB file) that is to be processed. The ROM will perform the selected operation on this data and return. The application may call this function with as much or as little data as it wishes, which can be used to select the granularity of time given to the application in between executing the operation.

Parameters:

session – Current ROM context pointer.
data – Buffer of boot image data provided to the ROM by the application.
dataLength – Length in bytes of the data in the buffer provided to the ROM.

Return values:

kStatus_Success – ROM successfully process the part of sb file/boot image.
kStatus_RomApiExecuteCompleted – ROM successfully process the whole sb file/boot image.
kStatus_Fail – An error occurred while executing the operation.
kStatus_RomApiNeedMoreData – No error occurred, but the ROM needs more data to continue processing the boot image.
kStatus_RomApiBufferSizeNotEnough – user buffer is not enough for use by Kboot during execution of the operation.

kStatusGroup_RomApi: ROM API status group number.

struct _kb_region: #include <fsl_iap_kbp.h>

Memory region definition.

struct _kb_load_sb

#include <fsl_iap_kbp.h>