Functions
uint32_t	CRYPTOAesLoadKey (uint32_t *pui32AesKey, uint32_t ui32KeyLocation)
	Write the key into the Key Ram. More...

uint32_t	CRYPTOAesCbc (uint32_t pui32MsgIn, uint32_t pui32MsgOut, uint32_t ui32MsgLength, uint32_t *pui32Nonce, uint32_t ui32KeyLocation, bool bEncrypt, bool bIntEnable)
	Start an AES-CBC operation (encryption or decryption). More...

uint32_t	CRYPTOAesCbcStatus (void)
	Check the result of an AES CBC operation. More...

uint32_t	CRYPTOAesEcb (uint32_t pui32MsgIn, uint32_t pui32MsgOut, uint32_t ui32KeyLocation, bool bEncrypt, bool bIntEnable)
	Start an AES-ECB operation (encryption or decryption). More...

uint32_t	CRYPTOAesEcbStatus (void)
	Check the result of an AES ECB operation. More...

static void	CRYPTOAesEcbFinish (void)
	Finish the encryption operation by resetting the operation mode. More...

static void	CRYPTOAesCbcFinish (void)
	Finish the encryption operation by resetting the operation mode. More...

uint32_t	CRYPTOCcmAuthEncrypt (bool bEncrypt, uint32_t ui32AuthLength, uint32_t pui32Nonce, uint32_t pui32PlainText, uint32_t ui32PlainTextLength, uint32_t *pui32Header, uint32_t ui32HeaderLength, uint32_t ui32KeyLocation, uint32_t ui32FieldLength, bool bIntEnable)
	Start CCM operation. More...

uint32_t	CRYPTOCcmAuthEncryptStatus (void)
	Check the result of an AES CCM operation. More...

uint32_t	CRYPTOCcmAuthEncryptResultGet (uint32_t ui32TagLength, uint32_t *pui32CcmTag)
	Get the result of an AES CCM operation. More...

uint32_t	CRYPTOCcmInvAuthDecrypt (bool bDecrypt, uint32_t ui32AuthLength, uint32_t pui32Nonce, uint32_t pui32CipherText, uint32_t ui32CipherTextLength, uint32_t *pui32Header, uint32_t ui32HeaderLength, uint32_t ui32KeyLocation, uint32_t ui32FieldLength, bool bIntEnable)
	Start a CCM Decryption and Inverse Authentication operation. More...

uint32_t	CRYPTOCcmInvAuthDecryptStatus (void)
	Checks CCM decrypt and Inverse Authentication result. More...

uint32_t	CRYPTOCcmInvAuthDecryptResultGet (uint32_t ui32AuthLength, uint32_t pui32CipherText, uint32_t ui32CipherTextLength, uint32_t pui32CcmTag)
	Get the result of the CCM operation. More...

static uint32_t	CRYPTODmaStatus (void)
	Get the current status of the Crypto DMA controller. More...

void	CRYPTODmaEnable (uint32_t ui32Channels)
	Enable Crypto DMA operation. More...

void	CRYPTODmaDisable (uint32_t ui32Channels)
	Disable Crypto DMA operation. More...

static void	CRYPTOIntEnable (uint32_t ui32IntFlags)
	Enables individual Crypto interrupt sources. More...

static void	CRYPTOIntDisable (uint32_t ui32IntFlags)
	Disables individual CRYPTO interrupt sources. More...

static uint32_t	CRYPTOIntStatus (bool bMasked)
	Gets the current interrupt status. More...

static void	CRYPTOIntClear (uint32_t ui32IntFlags)
	Clears Crypto interrupt sources. More...

static void	CRYPTOIntRegister (void(*pfnHandler)(void))
	Registers an interrupt handler for a Crypto interrupt. More...

static void	CRYPTOIntUnregister (void)
	Unregisters an interrupt handler for a Crypto interrupt. More...

Detailed Description

Function Documentation

uint32_t CRYPTOAesCbc	(	uint32_t *	pui32MsgIn,
		uint32_t *	pui32MsgOut,
		uint32_t	ui32MsgLength,
		uint32_t *	pui32Nonce,
		uint32_t	ui32KeyLocation,
		bool	bEncrypt,
		bool	bIntEnable
	)

Start an AES-CBC operation (encryption or decryption).

The function starts an AES CBC mode encypt or decrypt operation. End operation can be deteced by enabling interrupt or by polling CRYPTOAesCbcStatus(). Result of operation is returned by CRYPTOAesCbcStatus().

Parameters

pui32MsgIn	is a pointer to the input data.
pui32MsgOut	is a pointer to the output data.
ui32MsgLength	is the length in bytes of the input data.
pui32Nonce	is a pointer to 16-byte Nonce.
ui32KeyLocation	is the location of the key in Key RAM. This parameter can have any of the following values: CRYPTO_KEY_AREA_0 CRYPTO_KEY_AREA_1 CRYPTO_KEY_AREA_2 CRYPTO_KEY_AREA_3 CRYPTO_KEY_AREA_4 CRYPTO_KEY_AREA_5 CRYPTO_KEY_AREA_6 CRYPTO_KEY_AREA_7
bEncrypt	is set `true` to encrypt or set `false` to decrypt.
bIntEnable	is set `true` to enable Crypto interrupts or `false` to disable Crypto interrupt.

Returns

Returns status of the AES-CBC operation:

See also: CRYPTOAesCbcStatus()

Definition at line 207 of file crypto.c.

Here is the call graph for this function:

static void CRYPTOAesCbcFinish ( void )

inlinestatic

Finish the encryption operation by resetting the operation mode.

This function should be called after CRYPTOAesCbcStatus() has reported that the operation is finished successfully.

Returns: None

See also: CRYPTOAesCbcStatus()

Definition at line 375 of file crypto.h.

uint32_t CRYPTOAesCbcStatus ( void )

Check the result of an AES CBC operation.

This function should be called after CRYPTOAesCbc() function to check if the AES CBC operation was successful.

Returns

Returns the status of the AES CBC operation:

AES_SUCCESS : Successful.
AES_DMA_BUS_ERROR : Failed.
AES_DMA_BSY : Operation is ongoing.

See also: CRYPTOAesCbc()

Definition at line 340 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOAesEcb	(	uint32_t *	pui32MsgIn,
		uint32_t *	pui32MsgOut,
		uint32_t	ui32KeyLocation,
		bool	bEncrypt,
		bool	bIntEnable
	)

Start an AES-ECB operation (encryption or decryption).

The ui32KeyLocation parameter is an enumerated type which specifies the Key Ram location in which the key is stored.

Parameters

pui32MsgIn	is a pointer to the input data.
pui32MsgOut	is a pointer to the output data.
ui32KeyLocation	is the location of the key in Key RAM. This parameter can have any of the following values: CRYPTO_KEY_AREA_0 CRYPTO_KEY_AREA_1 CRYPTO_KEY_AREA_2 CRYPTO_KEY_AREA_3 CRYPTO_KEY_AREA_4 CRYPTO_KEY_AREA_5 CRYPTO_KEY_AREA_6 CRYPTO_KEY_AREA_7
bEncrypt	is set `true` to encrypt or set `false` to decrypt.
bIntEnable	is set `true` to enable Crypto interrupts or `false` to disable Crypto interrupt.

Returns

Returns status of the AES-ECB operation:

See also: CRYPTOAesEcbStatus()

Definition at line 351 of file crypto.c.

Here is the call graph for this function:

static void CRYPTOAesEcbFinish ( void )

inlinestatic

Finish the encryption operation by resetting the operation mode.

This function should be called after CRYPTOAesEcbStatus() has reported that the operation is finished successfully.

Returns: None

See also: CRYPTOAesEcbStatus()

Definition at line 352 of file crypto.h.

uint32_t CRYPTOAesEcbStatus ( void )

Check the result of an AES ECB operation.

This function should be called after CRYPTOAesEcb() function to check if the AES ECB operation was successful.

Returns

Returns the status of the AES ECB operation:

AES_SUCCESS : Successful.
AES_DMA_BUS_ERROR : Failed.
AES_DMA_BSY : Operation is ongoing.

See also: CRYPTOAesEcb()

Definition at line 471 of file crypto.c.

Referenced by CRYPTOAesCbcStatus().

Here is the call graph for this function:

uint32_t CRYPTOAesLoadKey	(	uint32_t *	pui32AesKey,
		uint32_t	ui32KeyLocation
	)

Write the key into the Key Ram.

The ui32KeyLocation parameter is an enumerated type which specifies the Key Ram location in which the key is stored.

The pointer pui8AesKey has the address where the Key is stored.

Parameters

pui32AesKey	is a pointer to an AES Key.
ui32KeyLocation	is the location of the key in Key RAM. This parameter can have any of the following values: CRYPTO_KEY_AREA_0 CRYPTO_KEY_AREA_1 CRYPTO_KEY_AREA_2 CRYPTO_KEY_AREA_3 CRYPTO_KEY_AREA_4 CRYPTO_KEY_AREA_5 CRYPTO_KEY_AREA_6 CRYPTO_KEY_AREA_7

Returns

Returns status of the function:

Definition at line 90 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmAuthEncrypt	(	bool	bEncrypt,
		uint32_t	ui32AuthLength,
		uint32_t *	pui32Nonce,
		uint32_t *	pui32PlainText,
		uint32_t	ui32PlainTextLength,
		uint32_t *	pui32Header,
		uint32_t	ui32HeaderLength,
		uint32_t	ui32KeyLocation,
		uint32_t	ui32FieldLength,
		bool	bIntEnable
	)

Start CCM operation.

The ui32KeyLocation is an enumerated type which specifies the Key Ram location in which the key is stored.

Parameters

bEncrypt	determines whether to run encryption or not.
ui32AuthLength	is the the length of the authentication field - 0, 2, 4, 6, 8, 10, 12, 14 or 16 octets.
pui32Nonce	is a pointer to 13-byte or 12-byte Nonce (Number used once).
pui32PlainText	is a pointer to the octet string input message.
ui32PlainTextLength	is the length of the message.
pui32Header	is the length of the header (Additional Authentication Data or AAD).
ui32HeaderLength	is the length of the header in octets.
ui32KeyLocation	is the location in Key RAM where the key is stored. This parameter can have any of the following values: CRYPTO_KEY_AREA_0 CRYPTO_KEY_AREA_1 CRYPTO_KEY_AREA_2 CRYPTO_KEY_AREA_3 CRYPTO_KEY_AREA_4 CRYPTO_KEY_AREA_5 CRYPTO_KEY_AREA_6 CRYPTO_KEY_AREA_7
ui32FieldLength	is the size of the length field (2 or 3).
bIntEnable	enables interrupts.

Returns

Returns the status of the CCM operation

See also: CRYPTOCcmAuthEncryptStatus()

Definition at line 511 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmAuthEncryptResultGet	(	uint32_t	ui32TagLength,
		uint32_t *	pui32CcmTag
	)

Get the result of an AES CCM operation.

This function should be called after CRYPTOCcmAuthEncryptStatus().

Parameters

ui32TagLength	is length of the Tag.
pui32CcmTag	is the location of the authentication Tag.

Returns: Returns AES_SUCCESS if successful.

See also: CRYPTOCcmAuthEncryptStatus()

Get the result of an AES CCM operation.

Definition at line 793 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmAuthEncryptStatus ( void )

Check the result of an AES CCM operation.

This function should be called after CRYPTOCcmAuthEncrypt() function to check if the AES CCM operation was successful.

Returns

Returns the status of the AES CCM operation:

AES_SUCCESS : Successful.
AES_DMA_BUS_ERROR : Failed.
AES_DMA_BSY : Operation is ongoing.

See also: CRYPTOCcmAuthEncrypt()

Definition at line 754 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmInvAuthDecrypt	(	bool	bDecrypt,
		uint32_t	ui32AuthLength,
		uint32_t *	pui32Nonce,
		uint32_t *	pui32CipherText,
		uint32_t	ui32CipherTextLength,
		uint32_t *	pui32Header,
		uint32_t	ui32HeaderLength,
		uint32_t	ui32KeyLocation,
		uint32_t	ui32FieldLength,
		bool	bIntEnable
	)

Start a CCM Decryption and Inverse Authentication operation.

The ui32KeyLocation is an enumerated type which specifies the Key Ram location in which the key is stored.

Parameters

bDecrypt	determines whether to run decryption or not.
ui32AuthLength	is the the length of the authentication field - 0, 2, 4, 6, 8, 10, 12, 14 or 16 octets.
pui32Nonce	is a pointer to 13-byte or 12-byte Nonce (Number used once).
pui32CipherText	is a pointer to the octet string encrypted message.
ui32CipherTextLength	is the length of the encrypted message.
pui32Header	is the length of the header (Additional Authentication Data or AAD).
ui32HeaderLength	is the length of the header in octets.
ui32KeyLocation	is the location in Key RAM where the key is stored. This parameter can have any of the following values: CRYPTO_KEY_AREA_0 CRYPTO_KEY_AREA_1 CRYPTO_KEY_AREA_2 CRYPTO_KEY_AREA_3 CRYPTO_KEY_AREA_4 CRYPTO_KEY_AREA_5 CRYPTO_KEY_AREA_6 CRYPTO_KEY_AREA_7
ui32FieldLength	is the size of the length field (2 or 3).
bIntEnable	enables interrupts.

Returns

Returns the status of the operation:

Definition at line 842 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmInvAuthDecryptResultGet	(	uint32_t	ui32AuthLength,
		uint32_t *	pui32CipherText,
		uint32_t	ui32CipherTextLength,
		uint32_t *	pui32CcmTag
	)

Get the result of the CCM operation.

Parameters

ui32AuthLength	is the the length of the authentication field - 0, 2, 4, 6, 8, 10, 12, 14 or 16 octets.
pui32CipherText	is a pointer to the octet string encrypted message.
ui32CipherTextLength	is the length of the encrypted message.
pui32CcmTag	is the location of the authentication Tag.

Returns: Returns AES_SUCCESS if successful.

Definition at line 1127 of file crypto.c.

Here is the call graph for this function:

uint32_t CRYPTOCcmInvAuthDecryptStatus ( void )

Checks CCM decrypt and Inverse Authentication result.

Returns

Returns status of operation:

AES_SUCCESS : Operation was successful.
AES_DMA_BSY : Operation is busy.
AES_DMA_BUS_ERROR : An error is encountered.

Definition at line 1088 of file crypto.c.

Here is the call graph for this function:

void CRYPTODmaDisable ( uint32_t ui32Channels )

Disable Crypto DMA operation.

The specified Crypto DMA channels are disabled.

Parameters

ui32Channels

is a bitwise OR of the channels to disable.

Returns: None

Definition at line 1223 of file crypto.c.

void CRYPTODmaEnable ( uint32_t ui32Channels )

Enable Crypto DMA operation.

The specified Crypto DMA channels are enabled.

Parameters

ui32Channels

is a bitwise OR of the channels to enable.

Returns: None

Definition at line 1196 of file crypto.c.

static uint32_t CRYPTODmaStatus ( void )

inlinestatic

Get the current status of the Crypto DMA controller.

This function is used to poll the Crypto DMA controller to check if it is ready for a new operation or if an error has occurred.

The CRYPTO_DMA_BUS_ERROR can also be caught using the crypto event handler.

Returns

Returns the current status of the DMA controller:

CRYPTO_DMA_READY : DMA ready for a new operation
CRYPTO_DMA_BSY : DMA is busy
CRYPTO_DMA_BUS_ERROR : DMA Bus error

Definition at line 558 of file crypto.h.

static void CRYPTOIntClear ( uint32_t ui32IntFlags )

inlinestatic

Clears Crypto interrupt sources.

The specified Crypto interrupt sources are cleared, so that they no longer assert. This function must be called in the interrupt handler to keep the interrupt from being recognized again immediately upon exit.

Note

Due to write buffers and synchronizers in the system it may take several clock cycles from a register write clearing an event in a module and until the event is actually cleared in the NVIC of the system CPU. It is recommended to clear the event source early in the interrupt service routine (ISR) to allow the event clear to propagate to the NVIC before returning from the ISR. At the same time, an early event clear allows new events of the same type to be pended instead of ignored if the event is cleared later in the ISR. It is the responsibility of the programmer to make sure that enough time has passed before returning from the ISR to avoid false re-triggering of the cleared event. A simple, although not necessarily optimal, way of clearing an event before returning from the ISR is:

Write to clear event (interrupt source). (buffered write)
Dummy read from the event source module. (making sure the write has propagated)
Wait two system CPU clock cycles (user code or two NOPs). (allowing cleared event to propagate through any synchronizers)

Parameters

ui32IntFlags

is a bit mask of the interrupt sources to be cleared.

Returns: None

Definition at line 729 of file crypto.h.

static void CRYPTOIntDisable ( uint32_t ui32IntFlags )

inlinestatic

Disables individual CRYPTO interrupt sources.

This function disables the indicated Crypto interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

Parameters

ui32IntFlags

is the bitwise OR of the interrupt sources to be enabled.

Returns: None

Definition at line 647 of file crypto.h.

static void CRYPTOIntEnable ( uint32_t ui32IntFlags )

inlinestatic

Enables individual Crypto interrupt sources.

This function enables the indicated Crypto interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

Parameters

ui32IntFlags

is the bitwise OR of the interrupt sources to be enabled.

Returns: None

Definition at line 612 of file crypto.h.

static void CRYPTOIntRegister ( void(*)(void) pfnHandler )

inlinestatic

Registers an interrupt handler for a Crypto interrupt.

This function does the actual registering of the interrupt handler. This function enables the global interrupt in the interrupt controller; specific UART interrupts must be enabled via CRYPTOIntEnable(). It is the interrupt handler's responsibility to clear the interrupt source.

Parameters

pfnHandler is a pointer to the function to be called when the UART interrupt occurs.

Returns: None

See also: IntRegister() for important information about registering interrupt handlers.

Definition at line 762 of file crypto.h.

Here is the call graph for this function:

static uint32_t CRYPTOIntStatus ( bool bMasked )

inlinestatic

Gets the current interrupt status.

This function returns the interrupt status for the specified Crypto. Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned.

Parameters

bMasked

whether to use raw or masked interrupt status:

false : Raw interrupt status is required.
true : Masked interrupt status is required.

Returns

Returns the current interrupt status:

Definition at line 679 of file crypto.h.

static void CRYPTOIntUnregister ( void )

inlinestatic

Unregisters an interrupt handler for a Crypto interrupt.

This function does the actual unregistering of the interrupt handler. It clears the handler to be called when a Crypto interrupt occurs. This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called.