CTB

Modules
	CTB_Registers

Data Structures
struct	mxc_ctb_dma_req_t
struct	mxc_ctb_ecc_req_t
struct	mxc_ctb_crc_req_t
struct	mxc_ctb_hash_req_t
struct	mxc_ctb_cipher_req_t

Typedefs
typedef void(*	mxc_ctb_complete_cb_t) (void *req, int result)

Enumerations
enum	mxc_ctb_features_t
enum	mxc_ctb_dma_read_source_t
enum	mxc_ctb_dma_write_source_t
enum	mxc_ctb_crc_bitorder_t
enum	mxc_ctb_hash_func_t
enum	mxc_ctb_hash_source_t
enum	mxc_ctb_cipher_mode_t
enum	mxc_ctb_cipher_t
enum	mxc_ctb_cipher_key_t
enum	mxc_ctb_cipher_operation_t

Functions
int	MXC_CTB_Init (uint32_t features)
uint32_t	MXC_CTB_CheckFeatures (void)
void	MXC_CTB_EnableInt (void)
void	MXC_CTB_DisableInt (void)
int	MXC_CTB_Ready (void)
void	MXC_CTB_DoneClear (uint32_t features)
uint32_t	MXC_CTB_Done (void)
void	MXC_CTB_Reset (uint32_t features)
void	MXC_CTB_CacheInvalidate (void)
int	MXC_CTB_Shutdown (uint32_t features)
uint32_t	MXC_CTB_GetEnabledFeatures (void)
void	MXC_CTB_Handler (void)
void	MXC_CTB_DMA_SetReadSource (mxc_ctb_dma_read_source_t source)
mxc_ctb_dma_read_source_t	MXC_CTB_DMA_GetReadSource (void)
void	MXC_CTB_DMA_SetWriteSource (mxc_ctb_dma_write_source_t source)
mxc_ctb_dma_write_source_t	MXC_CTB_DMA_GetWriteSource (void)
void	MXC_CTB_DMA_SetSource (uint8_t *source)
void	MXC_CTB_DMA_SetDestination (uint8_t *dest)
int	MXC_CTB_DMA_SetupOperation (mxc_ctb_dma_req_t *req)
int	MXC_CTB_DMA_DoOperation (mxc_ctb_dma_req_t *req)
void	MXC_CTB_DMA_StartTransfer (uint32_t length)
int	MXC_CTB_TRNG_RandomInt (void)
int	MXC_CTB_TRNG_Random (uint8_t *data, uint32_t len)
void	MXC_CTB_TRNG_RandomAsync (uint8_t *data, uint32_t len, mxc_ctb_complete_cb_t callback)
void	MXC_CTB_ECC_Enable (void)
void	MXC_CTB_ECC_Disable (void)
uint32_t	MXC_CTB_ECC_GetResult (void)
int	MXC_CTB_ECC_Compute (mxc_ctb_ecc_req_t *req)
int	MXC_CTB_ECC_ErrorCheck (mxc_ctb_ecc_req_t *req)
void	MXC_CTB_ECC_ComputeAsync (mxc_ctb_ecc_req_t *req)
void	MXC_CTB_ECC_ErrorCheckAsync (mxc_ctb_ecc_req_t *req)
void	MXC_CTB_CRC_SetDirection (mxc_ctb_crc_bitorder_t bitOrder)
mxc_ctb_crc_bitorder_t	MXC_CTB_CRC_GetDirection (void)
void	MXC_CTB_CRC_SetPoly (uint32_t poly)
uint32_t	MXC_CTB_CRC_GetPoly (void)
uint32_t	MXC_CTB_CRC_GetResult (void)
void	MXC_CTB_CRC_SetInitialValue (uint32_t seed)
void	MXC_CTB_CRC_SetFinalXORValue (uint32_t xor)
int	MXC_CTB_CRC_Compute (mxc_ctb_crc_req_t *req)
void	MXC_CTB_CRC_ComputeAsync (mxc_ctb_crc_req_t *req)
unsigned int	MXC_CTB_Hash_GetBlockSize (mxc_ctb_hash_func_t function)
unsigned int	MXC_CTB_Hash_GetDigestSize (mxc_ctb_hash_func_t function)
void	MXC_CTB_Hash_SetFunction (mxc_ctb_hash_func_t function)
mxc_ctb_hash_func_t	MXC_CTB_Hash_GetFunction (void)
void	MXC_CTB_Hash_SetAutoPad (int pad)
int	MXC_CTB_Hash_GetAutoPad (void)
void	MXC_CTB_Hash_GetResult (uint8_t *digest, int *len)
void	MXC_CTB_Hash_SetMessageSize (uint32_t size)
void	MXC_CTB_Hash_SetSource (mxc_ctb_hash_source_t source)
mxc_ctb_hash_source_t	MXC_CTB_Hash_GetSource (void)
void	MXC_CTB_Hash_InitializeHash (void)
int	MXC_CTB_Hash_Compute (mxc_ctb_hash_req_t *req)
void	MXC_CTB_Hash_ComputeAsync (mxc_ctb_hash_req_t *req)
unsigned int	MXC_CTB_Cipher_GetKeySize (mxc_ctb_cipher_t cipher)
unsigned int	MXC_CTB_Cipher_GetBlockSize (mxc_ctb_cipher_t cipher)
void	MXC_CTB_Cipher_SetMode (mxc_ctb_cipher_mode_t mode)
mxc_ctb_cipher_mode_t	MXC_CTB_Cipher_GetMode (void)
void	MXC_CTB_Cipher_SetCipher (mxc_ctb_cipher_t cipher)
mxc_ctb_cipher_t	MXC_CTB_Cipher_GetCipher (void)
void	MXC_CTB_Cipher_SetKeySource (mxc_ctb_cipher_key_t source)
mxc_ctb_cipher_key_t	MXC_CTB_Cipher_GetKeySource (void)
void	MXC_CTB_Cipher_LoadKey (void)
void	MXC_CTB_Cipher_SetOperation (mxc_ctb_cipher_operation_t operation)
void	MXC_CTB_Cipher_SetKey (uint8_t *key, uint32_t len)
void	MXC_CTB_Cipher_SetIV (uint8_t *iv, uint32_t len)
void	MXC_CTB_Cipher_GetIV (uint8_t *ivOut, uint32_t len)
int	MXC_CTB_Cipher_Encrypt (mxc_ctb_cipher_req_t *req)
int	MXC_CTB_Cipher_Decrypt (mxc_ctb_cipher_req_t *req)
void	MXC_CTB_Cipher_EncryptAsync (mxc_ctb_cipher_req_t *req)
void	MXC_CTB_Cipher_DecryptAsync (mxc_ctb_cipher_req_t *req)

Detailed Description

---

Data Structure Documentation

mxc_ctb_dma_req_t

struct mxc_ctb_dma_req_t

Structure for using DMA with CTB.

Data Fields
uint8_t *	sourceBuffer
uint8_t *	destBuffer
uint32_t	length
mxc_ctb_complete_cb_t	callback

mxc_ctb_ecc_req_t

struct mxc_ctb_ecc_req_t

Structure used to set up ECC request.

mxc_ctb_crc_req_t

struct mxc_ctb_crc_req_t

Structure used to set up CRC request.

mxc_ctb_hash_req_t

struct mxc_ctb_hash_req_t

Structure used to set up Hash request.

mxc_ctb_cipher_req_t

struct mxc_ctb_cipher_req_t

Structure used to set up Cipher request.

Enumeration Type Documentation

mxc_ctb_cipher_mode_t

enum mxc_ctb_cipher_mode_t

Enumeration type to select Cipher mode.

Enumerator
MXC_CTB_MODE_ECB	Electronic Code Book.
MXC_CTB_MODE_CBC	Cipher Block Chaining.
MXC_CTB_MODE_CFB	Cipher Feedback.
MXC_CTB_MODE_CTR	Counter.
MXC_CTB_MODE_OFB	Output Feedback.

mxc_ctb_cipher_t

enum mxc_ctb_cipher_t

Enumeration type to select Cipher function.

Enumerator
MXC_CTB_CIPHER_DIS	Disable.
MXC_CTB_CIPHER_AES128	Select AES-128.
MXC_CTB_CIPHER_AES192	Select AES-192.
MXC_CTB_CIPHER_AES256	Select AES-256.
MXC_CTB_CIPHER_DES	Select DES.
MXC_CTB_CIPHER_TDES	Select TDES.

Function Documentation

MXC_CTB_CacheInvalidate()

void MXC_CTB_CacheInvalidate

(

void

)

Invalidates the CTB's internal cache.

Note

For best security, should be done after every operation

MXC_CTB_CheckFeatures()

uint32_t MXC_CTB_CheckFeatures

(

void

)

Detects what CTB features exist, see mxc_ctb_features_t.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_Cipher_Decrypt()

int MXC_CTB_Cipher_Decrypt

(

mxc_ctb_cipher_req_t *

req

)

Perform a decryption using the cipher feature.

Note

The result will be stored in the req structure

Parameters

req	Structure containing data for the decryption

Returns

See Error Codes for a list of return codes.

MXC_CTB_Cipher_DecryptAsync()

void MXC_CTB_Cipher_DecryptAsync

(

mxc_ctb_cipher_req_t *

req

)

Perform a decryption using the cipher feature.

Note

The result will be stored in the req structure. The user needs to call MXC_CTB_Handler() in the ISR

Parameters

req	Structure containing data for the decryption

MXC_CTB_Cipher_Encrypt()

int MXC_CTB_Cipher_Encrypt

(

mxc_ctb_cipher_req_t *

req

)

Perform an encryption using the cipher feature.

Note

The result will be stored in the req structure

Parameters

req	Structure containing data for the encryption

Returns

See Error Codes for a list of return codes.

MXC_CTB_Cipher_EncryptAsync()

void MXC_CTB_Cipher_EncryptAsync

(

mxc_ctb_cipher_req_t *

req

)

Perform an encryption using the cipher feature.

Note

The result will be stored in the req structure. The user needs to call MXC_CTB_Handler() in the ISR

Parameters

req	Structure containing data for the encryption

MXC_CTB_Cipher_GetBlockSize()

unsigned int MXC_CTB_Cipher_GetBlockSize

(

mxc_ctb_cipher_t

cipher

)

Get the block size for a given cipher type.

Parameters

cipher

See mxc_ctb_cipher_t for options

Returns

Size of the block in bytes

MXC_CTB_Cipher_GetCipher()

mxc_ctb_cipher_t MXC_CTB_Cipher_GetCipher

(

void

)

Get the cipher type used for cipher operations.

Returns

See mxc_ctb_cipher_t for options

MXC_CTB_Cipher_GetIV()

void MXC_CTB_Cipher_GetIV	(	uint8_t *	ivOut,
		uint32_t	len
	)

Get the initial value used for cipher operations.

Parameters

ivOut	buffer containing iv
len	length of buffer

MXC_CTB_Cipher_GetKeySize()

unsigned int MXC_CTB_Cipher_GetKeySize

(

mxc_ctb_cipher_t

cipher

)

Get the key size for a given cipher type.

Parameters

cipher

See mxc_ctb_cipher_t for options

Returns

Size of the key in bytes

MXC_CTB_Cipher_GetKeySource()

mxc_ctb_cipher_key_t MXC_CTB_Cipher_GetKeySource

(

void

)

Get the cipher type used for cipher operations.

Returns

See mxc_ctb_cipher_key_t for options

MXC_CTB_Cipher_GetMode()

mxc_ctb_cipher_mode_t MXC_CTB_Cipher_GetMode

(

void

)

Get the block mode used for cipher operations.

Returns

See mxc_ctb_cipher_mode_t for options

MXC_CTB_Cipher_SetCipher()

void MXC_CTB_Cipher_SetCipher

(

mxc_ctb_cipher_t

cipher

)

Set the cipher type used for cipher operations.

Parameters

cipher

See mxc_ctb_cipher_t for options

MXC_CTB_Cipher_SetIV()

void MXC_CTB_Cipher_SetIV	(	uint8_t *	iv,
		uint32_t	len
	)

Set the initial value used for cipher operations.

Parameters

iv	buffer containing iv
len	length of initial value

MXC_CTB_Cipher_SetKey()

void MXC_CTB_Cipher_SetKey	(	uint8_t *	key,
		uint32_t	len
	)

Set the cipher key.

Note

This only takes effect if software is the selected key source

Parameters

key	buffer containing key
len	length of key (dependent on cipher used)

MXC_CTB_Cipher_SetKeySource()

void MXC_CTB_Cipher_SetKeySource

(

mxc_ctb_cipher_key_t

source

)

Set the source of the key used in cipher operations.

Parameters

source

See mxc_ctb_cipher_key_t for options

MXC_CTB_Cipher_SetMode()

void MXC_CTB_Cipher_SetMode

(

mxc_ctb_cipher_mode_t

mode

)

Set the block mode used for cipher operations.

Parameters

mode	See mxc_ctb_cipher_mode_t for options

MXC_CTB_Cipher_SetOperation()

void MXC_CTB_Cipher_SetOperation

(

mxc_ctb_cipher_operation_t

operation

)

Configure for encryption or decryption.

Parameters

operation

Set to perform encryption/decryption mxc_ctb_cipher_operation_t

MXC_CTB_CRC_Compute()

int MXC_CTB_CRC_Compute

(

mxc_ctb_crc_req_t *

req

)

Perform a CRC computation.

Note

The result of the CRC calculation will be placed in the mxc_ctb_crc_req_t structure

Parameters

req	Structure containing the data for calculation

Returns

see Error Codes for a list of return codes.

MXC_CTB_CRC_ComputeAsync()

void MXC_CTB_CRC_ComputeAsync

(

mxc_ctb_crc_req_t *

req

)

Perform a CRC computation asynchronously.

Note

The result of the CRC calculation will be placed in the mxc_ctb_crc_req_t structure. The user must call MXC_CTB_Handler() in the ISR

Parameters

req	Structure containing the data for calculation

MXC_CTB_CRC_GetDirection()

mxc_ctb_crc_bitorder_t MXC_CTB_CRC_GetDirection

(

void

)

Set the bit-order of CRC calculation.

Returns

The direction of calculation, 1 for MSB first, 0 for LSB first , mxc_ctb_crc_bitorder_t

MXC_CTB_CRC_GetPoly()

uint32_t MXC_CTB_CRC_GetPoly

(

void

)

Get the polynomial for CRC calculation.

Returns

The polynomial used in calculation

MXC_CTB_CRC_GetResult()

uint32_t MXC_CTB_CRC_GetResult

(

void

)

Get the result of a CRC calculation.

Returns

The calculated CRC value

MXC_CTB_CRC_SetDirection()

void MXC_CTB_CRC_SetDirection

(

mxc_ctb_crc_bitorder_t

bitOrder

)

Set the bit-order of CRC calculation.

Parameters

bitOrder

The direction to perform CRC calculation in, mxc_ctb_crc_bitorder_t

MXC_CTB_CRC_SetFinalXORValue()

void MXC_CTB_CRC_SetFinalXORValue

(

uint32_t

xor

)

Set the value that will be bitwise XORed with the final output from the CRC computation. Use 0 to skip the XOR step.

Parameters

xor	The value that will be XORed with the CRC

MXC_CTB_CRC_SetInitialValue()

void MXC_CTB_CRC_SetInitialValue

(

uint32_t

seed

)

Set the intial value used (the seed) when starting a CRC computation.

Parameters

seed	The value to seed the CRC generator with

MXC_CTB_CRC_SetPoly()

void MXC_CTB_CRC_SetPoly

(

uint32_t

poly

)

Set the Polynomial for CRC calculation.

Parameters

poly	The polynomial to use for CRC calculation

MXC_CTB_DMA_DoOperation()

int MXC_CTB_DMA_DoOperation

(

mxc_ctb_dma_req_t *

req

)

Start a DMA transfer defined by the request object Blocks until completion.

Parameters

req	request structure that contains the source and destination information. A destination address of NULL will indicate that the Read Source has been set as something other than memory.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_DMA_GetReadSource()

mxc_ctb_dma_read_source_t MXC_CTB_DMA_GetReadSource

(

void

)

Get the source the DMA reads from.

Returns

The source of the data for DMA read operations see mxc_ctb_dma_read_source_t for a list of sources

MXC_CTB_DMA_GetWriteSource()

mxc_ctb_dma_write_source_t MXC_CTB_DMA_GetWriteSource

(

void

)

Set the source the DMA write fifo reads from.

Returns

The source of the data for DMA write operations see mxc_ctb_dma_write_source_t for a list of sources

MXC_CTB_DMA_SetDestination()

void MXC_CTB_DMA_SetDestination

(

uint8_t *

dest

)

Set the destination address of the DMA.

Parameters

dest	pointer to destination

MXC_CTB_DMA_SetReadSource()

void MXC_CTB_DMA_SetReadSource

(

mxc_ctb_dma_read_source_t

source

)

Set the source the DMA reads from.

Note

The DMA is unable to read directly from Flash

Parameters

source

The source of the data for DMA read operations see mxc_ctb_dma_read_source_t for a list of sources

MXC_CTB_DMA_SetSource()

void MXC_CTB_DMA_SetSource

(

uint8_t *

source

)

Set the source address of the DMA.

Note

This is only applicable when the read source is memory The DMA is unable to read directly from Flash

Parameters

source

pointer to the source location

MXC_CTB_DMA_SetupOperation()

int MXC_CTB_DMA_SetupOperation

(

mxc_ctb_dma_req_t *

req

)

Set the source and destination addresses of the DMA.

Parameters

req	request structure that contains the source and destination information. A destination address of NULL will indicate that the Read Source has been set as something other than memory.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_DMA_SetWriteSource()

void MXC_CTB_DMA_SetWriteSource

(

mxc_ctb_dma_write_source_t

source

)

Set the source the DMA write fifo reads from.

Parameters

source

The source of the data for DMA write operations see mxc_ctb_dma_write_source_t for a list of sources

MXC_CTB_DMA_StartTransfer()

void MXC_CTB_DMA_StartTransfer

(

uint32_t

length

)

Start a DMA transfer of fixed size.

Parameters

length

Number of bytes to transfer

MXC_CTB_Done()

uint32_t MXC_CTB_Done

(

void

)

Returns CTB features showing operations complete, see mxc_ctb_features_t.

Returns

CTB features showing operations complete, see mxc_ctb_features_t.

MXC_CTB_DoneClear()

void MXC_CTB_DoneClear

(

uint32_t

features

)

Clears the selected feature's done bits, see mxc_ctb_features_t.

Parameters

features

bit banded value indicating features to clear

MXC_CTB_ECC_Compute()

int MXC_CTB_ECC_Compute

(

mxc_ctb_ecc_req_t *

req

)

Compute the ECC value for a block of data up to 8kB in size.

Note

This function places the computed ECC value in the appropriate place in the mxc_ctb_ecc_req_t structure

Parameters

req	Structure containing data for the ECC request

Returns

see Error Codes for a list of return codes.

MXC_CTB_ECC_ComputeAsync()

void MXC_CTB_ECC_ComputeAsync

(

mxc_ctb_ecc_req_t *

req

)

Compute the ECC value for a block of data up to 8kB in size.

Note

This function places the computed ECC value in the appropriate place in the mxc_ctb_ecc_req_t structure. The user needs to call MXC_CTB_Handler() in the ISR

Parameters

req	Structure containing data for the ECC request

MXC_CTB_ECC_Disable()

void MXC_CTB_ECC_Disable

(

void

)

Disable ECC Calculation.

Note

ECC calculation is shared with CRC, when ECC is enabled, CRC computation is not possible

MXC_CTB_ECC_Enable()

void MXC_CTB_ECC_Enable

(

void

)

Enable ECC Calculation.

Note

ECC calculation is shared with CRC, when ECC is enabled, CRC computation is not possible

MXC_CTB_ECC_ErrorCheck()

int MXC_CTB_ECC_ErrorCheck

(

mxc_ctb_ecc_req_t *

req

)

Check for single or dual bit errors in a block of data.

Note

This function will also correct single bit errors as needed

Parameters

req	Structure containing data for the ECC request

Returns

Positive values for 1 or 2 bit errors, respectively otherwise, see Error Codes for a list of return codes.

MXC_CTB_ECC_ErrorCheckAsync()

void MXC_CTB_ECC_ErrorCheckAsync

(

mxc_ctb_ecc_req_t *

req

)

Check for single or dual bit errors in a block of data.

Note

This function will also correct single bit errors as needed The user must call MXC_CTB_Handler() in the ISR.

Parameters

req	Structure containing data for the ECC request

MXC_CTB_ECC_GetResult()

uint32_t MXC_CTB_ECC_GetResult

(

void

)

Get the Result of an ECC Calculation.

Returns

The result of the ECC calculation

MXC_CTB_GetEnabledFeatures()

uint32_t MXC_CTB_GetEnabledFeatures

(

void

)

Check which CTB features are enabled.

Returns

CTB features showing features enabled, see mxc_ctb_features_t.

MXC_CTB_Hash_Compute()

int MXC_CTB_Hash_Compute

(

mxc_ctb_hash_req_t *

req

)

Compute a Hash Digest.

Note

The computed digest will be stored in the req structure

Parameters

req	Structure containing all data needed for a hash computation

Returns

See Error Codes for a list of return codes

MXC_CTB_Hash_ComputeAsync()

void MXC_CTB_Hash_ComputeAsync

(

mxc_ctb_hash_req_t *

req

)

Compute a Hash Digest.

Note

The computed digest will be stored in the req structure. The user must call MXC_CTB_Handler() in the ISR.

Parameters

req	Structure containing all data needed for a hash computation

MXC_CTB_Hash_GetAutoPad()

int MXC_CTB_Hash_GetAutoPad

(

void

)

Get whether to use automatic padding of the input data.

Returns

Using hardware padding of the data

MXC_CTB_Hash_GetBlockSize()

unsigned int MXC_CTB_Hash_GetBlockSize

(

mxc_ctb_hash_func_t

function

)

Get the block size for a given hash function.

Parameters

function

See mxc_ctb_hash_func_t for options

Returns

Block size in bytes

MXC_CTB_Hash_GetDigestSize()

unsigned int MXC_CTB_Hash_GetDigestSize

(

mxc_ctb_hash_func_t

function

)

Get the digest size for a given hash function.

Parameters

function

See mxc_ctb_hash_func_t for options

Returns

Digest size in bytes

MXC_CTB_Hash_GetFunction()

mxc_ctb_hash_func_t MXC_CTB_Hash_GetFunction

(

void

)

Get the algorithm to use for hash computation.

Returns

See mxc_ctb_hash_func_t for options

MXC_CTB_Hash_GetResult()

void MXC_CTB_Hash_GetResult	(	uint8_t *	digest,
		int *	len
	)

Get the result of a hash computation.

Parameters

digest	buffer to store the ouctbt of the hash algorithm
len	location to store the length of the digest

MXC_CTB_Hash_GetSource()

mxc_ctb_hash_source_t MXC_CTB_Hash_GetSource

(

void

)

Get the source of data for the hash computation.

Returns

See mxc_ctb_hash_source_t for options

MXC_CTB_Hash_InitializeHash()

void MXC_CTB_Hash_InitializeHash

(

void

)

Initialize the hash computation unit.

Note

Call this after setting the hash function and message size This function blocks until load is complete

MXC_CTB_Hash_SetAutoPad()

void MXC_CTB_Hash_SetAutoPad

(

int

pad

)

Set whether to use automatic padding of the input data.

Note

The padding procedure used by hardware is described in the users guide

Parameters

pad	Use hardware padding of the data

MXC_CTB_Hash_SetFunction()

void MXC_CTB_Hash_SetFunction

(

mxc_ctb_hash_func_t

function

)

Set the algorithm to use for hash computation.

Parameters

function

See mxc_ctb_hash_func_t for options

MXC_CTB_Hash_SetMessageSize()

void MXC_CTB_Hash_SetMessageSize

(

uint32_t

size

)

Set the size of the data input into the hash computation.

Note

Hash data size is software limited to ~3GB

Parameters

size	Size of the data in bytes

MXC_CTB_Hash_SetSource()

void MXC_CTB_Hash_SetSource

(

mxc_ctb_hash_source_t

source

)

Set the source of data for the hash computation.

Parameters

source

see mxc_ctb_hash_source_t for options

MXC_CTB_Init()

int MXC_CTB_Init

(

uint32_t

features

)

Enable portions of the CTB.

Parameters

features

bit banded value indicating features to enable see mxc_ctb_features_t for a list of features

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_Ready()

int MXC_CTB_Ready

(

void

)

Checks the global CTB Ready Status.

Returns

Nonzero if ready, zero if not ready or Error Codes.

MXC_CTB_Reset()

void MXC_CTB_Reset

(

uint32_t

features

)

Resets the selected features, see mxc_ctb_features_t.

Parameters

features

bit banded value indicating features to reset

MXC_CTB_Shutdown()

int MXC_CTB_Shutdown

(

uint32_t

features

)

Disable and reset portions of the CTB.

Parameters

features

bit banded value indicating features to shutdown see mxc_ctb_features_t for a list of features

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_TRNG_Random()

int MXC_CTB_TRNG_Random	(	uint8_t *	data,
		uint32_t	len
	)

Get a random number of length len.

Parameters

data	Pointer to a location to store the number
len	Length of random number in bytes

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CTB_TRNG_RandomAsync()

void MXC_CTB_TRNG_RandomAsync	(	uint8_t *	data,
		uint32_t	len,
		mxc_ctb_complete_cb_t	callback
	)

Get a random number of length len, do not block while generating data.

Note

The user must call MXC_CTB_Handler() in the ISR

Parameters

data	Pointer to a location to store the number
len	Length of random number in bytes
callback	Function that will be called when all data has been generated

MXC_CTB_TRNG_RandomInt()

int MXC_CTB_TRNG_RandomInt

(

void

)

Get a random number.

Returns

A random 32-bit number