MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClEls_Crc_Functions

Defines all functions of mcuxClEls_Crc. More...

Functions

MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_ConfigureCommandCRC (mcuxClEls_CommandCrcConfig_t options)
 Set command CRC flags. More...
 
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_GetCommandCRC (uint32_t *commandCrc)
 Get the current command CRC value. More...
 
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_VerifyVsRefCRC (uint32_t refCrc)
 Verifies a reference CRC against the computed ELS command CRC. More...
 
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_UpdateRefCRC (uint8_t command, uint32_t options, uint32_t *refCrc)
 Updates a reference CRC with the parameters of an ELS command. More...
 

Detailed Description

Defines all functions of mcuxClEls_Crc.

Function Documentation

◆ mcuxClEls_ConfigureCommandCRC()

MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_ConfigureCommandCRC ( mcuxClEls_CommandCrcConfig_t  options)

Set command CRC flags.

Parameters
[in]optionsThe command CRC options. For more information, see mcuxClEls_CommandCrcConfig_t.
Returns
An error code that is always MCUXCLELS_STATUS_OK

◆ mcuxClEls_GetCommandCRC()

MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_GetCommandCRC ( uint32_t *  commandCrc)

Get the current command CRC value.

Parameters
[out]commandCrcThe command CRC value.
Returns
An error code
Return values
MCUXCLELS_STATUS_OKOperation successful
MCUXCLELS_STATUS_SW_INVALID_PARAMParameter commandCRC points to NULL

◆ mcuxClEls_VerifyVsRefCRC()

MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_VerifyVsRefCRC ( uint32_t  refCrc)

Verifies a reference CRC against the computed ELS command CRC.

Parameters
[in]refCrcThe reference CRC value.
Returns
An error code that can be any error code in MCUXCLELS_STATUS_, see individual documentation for more information

◆ mcuxClEls_UpdateRefCRC()

MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_UpdateRefCRC ( uint8_t  command,
uint32_t  options,
uint32_t *  refCrc 
)

Updates a reference CRC with the parameters of an ELS command.

This can be used to verify against the ELS command CRC.

Parameters
[in]commandThe ELS command ID.
[in]optionsThe command options for the given ELS command.
[in,out]refCrcThe current reference CRC value to update.
Returns
An error code
Return values
MCUXCLELS_STATUS_OKOperation successful
MCUXCLELS_STATUS_SW_INVALID_PARAMParameter crc points to NULL