AES_Advanced_Encryption_Standard_api

Functions
void	AESConfigSet (uint32_t ui32Base, uint32_t ui32Config)
void	AESKey1Set (uint32_t ui32Base, uint8_t *pui8Key, uint32_t ui32Keysize)
void	AESKey2Set (uint32_t ui32Base, uint8_t *pui8Key, uint32_t ui32Keysize)
void	AESKey3Set (uint32_t ui32Base, uint8_t *pui8Key)
void	AESIVSet (uint32_t ui32Base, uint8_t *pui8IVdata)
void	AESIVGet (uint32_t ui32Base, uint8_t *pui8IVdata)
void	AESTagRead (uint32_t ui32Base, uint8_t *pui8TagData)
void	AESDataLengthSet (uint32_t ui32Base, uint64_t ui64Length)
void	AESAuthDataLengthSet (uint32_t ui32Base, uint32_t ui32Length)
bool	AESDataReadNonBlocking (uint32_t ui32Base, uint8_t *pui8Dest, uint8_t ui8Length)
void	AESDataRead (uint32_t ui32Base, uint8_t *pui8Dest, uint8_t ui8Length)
bool	AESDataWriteNonBlocking (uint32_t ui32Base, uint8_t *pui8Src, uint8_t ui8Length)
void	AESDataWrite (uint32_t ui32Base, uint8_t *pui8Src, uint8_t ui8Length)
bool	AESDataProcess (uint32_t ui32Base, uint8_t *pui8Src, uint8_t *pui8Dest, uint32_t ui32Length)
bool	AESDataMAC (uint32_t ui32Base, uint8_t *pui8Src, uint32_t ui32Length, uint8_t *pui8Tag)
bool	AESDataProcessAE (uint32_t ui32Base, uint8_t *pui8Src, uint8_t *pui8Dest, uint32_t ui32Length, uint8_t *pui8AuthSrc, uint32_t ui32AuthLength, uint8_t *pui8Tag)
uint32_t	AESIntStatus (uint32_t ui32Base, bool bMasked)
void	AESIntEnable (uint32_t ui32Base, uint32_t ui32IntFlags)
void	AESIntDisable (uint32_t ui32Base, uint32_t ui32IntFlags)
void	AESIntClear (uint32_t ui32Base, uint32_t ui32IntFlags)
void	AESIntRegister (uint32_t ui32Base, void(*pfnHandler)(void))
void	AESIntUnregister (uint32_t ui32Base)
void	AESDMAEnable (uint32_t ui32Base, uint32_t ui32Flags)
void	AESDMADisable (uint32_t ui32Base, uint32_t ui32Flags)

Detailed Description

Function Documentation

void AESAuthDataLengthSet	(	uint32_t	ui32Base,
		uint32_t	ui32Length
	)

Sets the optional additional authentication data (AAD) length.

Parameters

ui32Base	is the base address of the AES module.
ui32Length	is the length in bytes.

This function is only used to write the authentication data length in the combined modes (GCM or CCM) and XTS mode. Supported AAD lengths for CCM are from 0 to (2^16 - 28) bytes. For GCM, any value up to (2^32 - 1) can be used. For XTS mode, this register is used to load j. Loading of j is only required if j != 0. j represents the sequential number of the 128-bit blocks inside the data unit. Consequently, j must be multiplied by 16 when passed to this function, thereby placing the block number in bits [31:4] of the register.

When this function is called, the engine is triggered to start using this context for GCM and CCM.

Returns

None

void AESConfigSet	(	uint32_t	ui32Base,
		uint32_t	ui32Config
	)

Configures the AES module.

Parameters

ui32Base	is the base address of the AES module.
ui32Config	is the configuration of the AES module.

This function configures the AES module based on the specified parameters. It does not change any DMA- or interrupt-related parameters.

The ui32Config parameter is a bit-wise OR of a number of configuration flags. The valid flags are grouped based on their function.

The direction of the operation is specified with only of following flags:

• AES_CFG_DIR_ENCRYPT - Encryption mode
• AES_CFG_DIR_DECRYPT - Decryption mode

The key size is specified with only one of the following flags:

• AES_CFG_KEY_SIZE_128BIT - Key size of 128 bits
• AES_CFG_KEY_SIZE_192BIT - Key size of 192 bits
• AES_CFG_KEY_SIZE_256BIT - Key size of 256 bits

The mode of operation is specified with only one of the following flags.

• AES_CFG_MODE_ECB - Electronic codebook mode
• AES_CFG_MODE_CBC - Cipher-block chaining mode
• AES_CFG_MODE_CFB - Cipher feedback mode
• AES_CFG_MODE_CTR - Counter mode
• AES_CFG_MODE_ICM - Integer counter mode
• AES_CFG_MODE_XTS - Ciphertext stealing mode
• AES_CFG_MODE_XTS_TWEAKJL - XEX-based tweaked-codebook mode with ciphertext stealing with previous/intermediate tweak value and j loaded
• AES_CFG_MODE_XTS_K2IJL - XEX-based tweaked-codebook mode with ciphertext stealing with key2, i and j loaded
• AES_CFG_MODE_XTS_K2ILJ0 - XEX-based tweaked-codebook mode with ciphertext stealing with key2 and i loaded, j = 0
• AES_CFG_MODE_F8 - F8 mode
• AES_CFG_MODE_F9 - F9 mode
• AES_CFG_MODE_CBCMAC - Cipher block chaining message authentication code mode
• AES_CFG_MODE_GCM - Galois/counter mode
• AES_CFG_MODE_GCM_HLY0ZERO - Galois/counter mode with GHASH with H loaded and Y0-encrypted forced to zero
• AES_CFG_MODE_GCM_HLY0CALC - Galois/counter mode with GHASH with H loaded and Y0-encrypted calculated internally
• AES_CFG_MODE_GCM_HY0CALC - Galois/Counter mode with autonomous GHASH (both H and Y0-encrypted calculated internally)
• AES_CFG_MODE_CCM - Counter with CBC-MAC mode

The following defines are used to specify the counter width. It is only required to be defined when using CTR, CCM, or GCM modes, only one of the following defines must be used to specify the counter width length:

• AES_CFG_CTR_WIDTH_32 - Counter is 32 bits
• AES_CFG_CTR_WIDTH_64 - Counter is 64 bits
• AES_CFG_CTR_WIDTH_96 - Counter is 96 bits
• AES_CFG_CTR_WIDTH_128 - Counter is 128 bits

Only one of the following defines must be used to specify the length field for CCM operations (L):

• AES_CFG_CCM_L_2 - 2 bytes
• AES_CFG_CCM_L_4 - 4 bytes
• AES_CFG_CCM_L_8 - 8 bytes

Only one of the following defines must be used to specify the length of the authentication field for CCM operations (M) through the ui32Config argument in the AESConfigSet() function:

• AES_CFG_CCM_M_4 - 4 bytes
• AES_CFG_CCM_M_6 - 6 bytes
• AES_CFG_CCM_M_8 - 8 bytes
• AES_CFG_CCM_M_10 - 10 bytes
• AES_CFG_CCM_M_12 - 12 bytes
• AES_CFG_CCM_M_14 - 14 bytes
• AES_CFG_CCM_M_16 - 16 bytes

Returns

None.

void AESDataLengthSet	(	uint32_t	ui32Base,
		uint64_t	ui64Length
	)

Used to set the write crypto data length in the AES module.

Parameters

ui32Base	is the base address of the AES module.
ui64Length	is the crypto data length in bytes.

This function stores the cryptographic data length in blocks for all modes. Data lengths up to (2^61 - 1) bytes are allowed. For GCM, any value up to (2^36 - 2) bytes are allowed because a 32-bit block counter is used. For basic modes (ECB/CBC/CTR/ICM/CFB128), zero can be programmed into the length field, indicating that the length is infinite.

When this function is called, the engine is triggered to start using this context.

Note

This length does not include the authentication-only data used in some modes. Use the AESAuthLengthSet() function to specify the authentication data length.

Returns

None

bool AESDataMAC	(	uint32_t	ui32Base,
		uint8_t *	pui8Src,
		uint32_t	ui32Length,
		uint8_t *	pui8Tag
	)

Used to generate message authentication code (MAC) using CBC-MAC and F9 mode.

Parameters

ui32Base	is the base address of the AES module.
pui8Src	is a pointer to the memory location where the input data is stored.
ui32Length	is the length of the cryptographic data in bytes.
pui8Tag	is a pointer to a 4-word array where the hash tag is written.

This function processes data to produce a hash tag that can be used tor authentication. Before calling this function, ensure that the AES module is properly configured the key, data size, mode, etc. Only CBC-MAC and F9 modes should be used.

Returns

Returns true if data was processed successfully. Returns false if data processing failed.

bool AESDataProcess	(	uint32_t	ui32Base,
		uint8_t *	pui8Src,
		uint8_t *	pui8Dest,
		uint32_t	ui32Length
	)

Used to process(transform) blocks of data, either encrypt or decrypt it.

Parameters

ui32Base	is the base address of the AES module.
pui8Src	is a pointer to the memory location where the input data is stored.
pui8Dest	is a pointer to the memory location output is written.
ui32Length	is the length of the cryptographic data in bytes.

This function iterates the encryption or decryption mechanism number over the data length. Before calling this function, ensure that the AES module is properly configured the key, data size, mode, etc. Only ECB, CBC, CTR, ICM, CFB, XTS and F8 operating modes should be used. The data is processed in 4-word (16-byte) blocks.

Note

This function only supports values of ui32Length less than 2^32, because the memory size is restricted to between 0 to 2^32 bytes.

Returns

Returns true if data was processed successfully. Returns false if data processing failed.

bool AESDataProcessAE	(	uint32_t	ui32Base,
		uint8_t *	pui8Src,
		uint8_t *	pui8Dest,
		uint32_t	ui32Length,
		uint8_t *	pui8AuthSrc,
		uint32_t	ui32AuthLength,
		uint8_t *	pui8Tag
	)

Used for Authenticated encryption (AE) of the data. Processes and authenticates blocks of data, either encrypt the data or decrypt the data.

Parameters

ui32Base	is the base address of the AES module.
pui8Src	is a pointer to the memory location where the input data is stored. The data must be padded to the 16-byte boundary.
pui8Dest	is a pointer to the memory location output is written. The space for written data must be rounded up to the 16-byte boundary.
ui32Length	is the length of the cryptographic data in bytes.
pui8AuthSrc	is a pointer to the memory location where the additional authentication data is stored. The data must be padded to the 16-byte boundary.
ui32AuthLength	is the length of the additional authentication data in bytes.
pui8Tag	is a pointer to a 4-word array where the hash tag is written.

This function encrypts or decrypts blocks of data in addition to authentication data. A hash tag is also produced. Before calling this function, ensure that the AES module is properly configured the key, data size, mode, etc. Only CCM and GCM modes should be used.

Returns

Returns true if data was processed successfully. Returns false if data processing failed.

void AESDataRead	(	uint32_t	ui32Base,
		uint8_t *	pui8Dest,
		uint8_t	ui8Length
	)

Reads plaintext/ciphertext from data registers with blocking. This api writes data in blocks

Parameters

ui32Base	is the base address of the AES module.
pui8Dest	is a pointer to an array of words.
ui8Length	is the length of data in bytes to be read. ui8Length can be from 1 to 16

This function reads a block of either plaintext or ciphertext out of the AES module. If the output is not ready, the function waits until it is ready. A block is 16 bytes or 4 words.

Returns

None.

bool AESDataReadNonBlocking	(	uint32_t	ui32Base,
		uint8_t *	pui8Dest,
		uint8_t	ui8Length
	)

Reads plaintext/ciphertext from data registers without blocking. This api writes data in blocks

Parameters

ui32Base	is the base address of the AES module.
pui8Dest	is a pointer to an array of words of data.
ui8Length	the length can be from 1 to 16

This function reads a block of either plaintext or ciphertext out of the AES module. If the output data is not ready, the function returns false. If the read completed successfully, the function returns true. A block is 16 bytes or 4 words.

Returns

true or false.

void AESDataWrite	(	uint32_t	ui32Base,
		uint8_t *	pui8Src,
		uint8_t	ui8Length
	)

Writes plaintext/ciphertext to data registers with blocking.

Parameters

ui32Base	is the base address of the AES module.
pui8Src	is a pointer to an array of bytes.
ui8Length	the length can be from 1 to 16

This function writes a block of either plaintext or ciphertext into the AES module. If the input is not ready, the function waits until it is ready before performing the write.

Returns

None.

bool AESDataWriteNonBlocking	(	uint32_t	ui32Base,
		uint8_t *	pui8Src,
		uint8_t	ui8Length
	)

Writes plaintext/ciphertext to data registers without blocking.

Parameters

ui32Base	is the base address of the AES module.
pui8Src	is a pointer to an array of words of data.
ui8Length	the length can be from 1 to 16

This function writes a block of either plaintext or ciphertext into the AES module. If the input is not ready, the function returns false If the write completed successfully, the function returns true.

Returns

True or false.

void AESDMADisable	(	uint32_t	ui32Base,
		uint32_t	ui32Flags
	)

Disables uDMA requests for the AES module.

Parameters

ui32Base	is the base address of the AES module.
ui32Flags	is a bit mask of the uDMA requests to be disabled.

This function disables the uDMA request sources in the AES module. The ui32Flags parameter is the logical OR of any of the following:

• AES_DMA_DATA_IN
• AES_DMA_DATA_OUT
• AES_DMA_CONTEXT_IN
• AES_DMA_CONTEXT_OUT

Returns

None.

void AESDMAEnable	(	uint32_t	ui32Base,
		uint32_t	ui32Flags
	)

Enables uDMA requests for the AES module.

Parameters

ui32Base	is the base address of the AES module.
ui32Flags	is a bit mask of the uDMA requests to be enabled.

This function enables the uDMA request sources in the AES module. The ui32Flags parameter is the logical OR of any of the following:

• AES_DMA_DATA_IN
• AES_DMA_DATA_OUT
• AES_DMA_CONTEXT_IN
• AES_DMA_CONTEXT_OUT

Returns

None.

void AESIntClear	(	uint32_t	ui32Base,
		uint32_t	ui32IntFlags
	)

Clears AES module interrupts.

Parameters

ui32Base	is the base address of the AES module.
ui32IntFlags	is a bit mask of the interrupt sources to disable.

This function clears the interrupt sources in the AES module. The ui32IntFlags parameter is the logical OR of any of the following:

• AES_INT_DMA_CONTEXT_IN - Context DMA done interrupt
• AES_INT_DMA_CONTEXT_OUT - Authentication tag (and IV) DMA done interrupt
• AES_INT_DMA_DATA_IN - Data input DMA done interrupt
• AES_INT_DMA_DATA_OUT - Data output DMA done interrupt

Note

Only the DMA done interrupts can be cleared. The remaining interrupts should be disabled with AESIntDisable().

Returns

None.

void AESIntDisable	(	uint32_t	ui32Base,
		uint32_t	ui32IntFlags
	)

Disables AES module interrupts.

Parameters

ui32Base	is the base address of the AES module.
ui32IntFlags	is a bit mask of the interrupt sources to disable.

This function disables the interrupt sources in the AES module. The ui32IntFlags parameter is the logical OR of any of the following:

• AES_INT_CONTEXT_IN - Context interrupt
• AES_INT_CONTEXT_OUT - Authentication tag (and IV) interrupt
• AES_INT_DATA_IN - Data input interrupt
• AES_INT_DATA_OUT - Data output interrupt
• AES_INT_DMA_CONTEXT_IN - Context DMA done interrupt
• AES_INT_DMA_CONTEXT_OUT - Authentication tag (and IV) DMA done interrupt
• AES_INT_DMA_DATA_IN - Data input DMA done interrupt
• AES_INT_DMA_DATA_OUT - Data output DMA done interrupt

Note

The DMA done interrupts are the only interrupts that can be cleared. The remaining interrupts can be disabled instead using AESIntDisable().

Returns

None.

void AESIntEnable	(	uint32_t	ui32Base,
		uint32_t	ui32IntFlags
	)

Enables AES module interrupts.

Parameters

ui32Base	is the base address of the AES module.
ui32IntFlags	is a bit mask of the interrupt sources to enable.

This function enables the interrupts in the AES module. The ui32IntFlags parameter is the logical OR of any of the following:

• AES_INT_CONTEXT_IN - Context interrupt
• AES_INT_CONTEXT_OUT - Authentication tag (and IV) interrupt
• AES_INT_DATA_IN - Data input interrupt
• AES_INT_DATA_OUT - Data output interrupt
• AES_INT_DMA_CONTEXT_IN - Context DMA done interrupt
• AES_INT_DMA_CONTEXT_OUT - Authentication tag (and IV) DMA done interrupt
• AES_INT_DMA_DATA_IN - Data input DMA done interrupt
• AES_INT_DMA_DATA_OUT - Data output DMA done interrupt

Note

Interrupts that have been previously been enabled are not disabled when this function is called.

Returns

None.

void AESIntRegister	(	uint32_t	ui32Base,
		void(*)(void)	pfnHandler
	)

Registers an interrupt handler for the AES module.

Parameters

ui32Base	is the base address of the AES module.
pfnHandler	is a pointer to the function to be called when the enabled AES interrupts occur.

This function registers the interrupt handler in the interrupt vector table, and enables AES interrupts on the interrupt controller; specific AES interrupt sources must be enabled using AESIntEnable(). The interrupt handler being registered must clear the source of the interrupt using AESIntClear().

If the application is using a static interrupt vector table stored in flash, then it is not necessary to register the interrupt handler this way. Instead, IntEnable() is used to enable AES interrupts on the interrupt controller.

See also

IntRegister() for important information about registering interrupt handlers.

Returns

None.

uint32_t AESIntStatus	(	uint32_t	ui32Base,
		bool	bMasked
	)

Returns the current AES module interrupt status.

Parameters

ui32Base	is the base address of the AES module.
bMasked	is false if the raw interrupt status is required and true if the masked interrupt status is required.

Returns

Returns a bit mask of the interrupt sources, which is a logical OR of any of the following:

• AES_INT_CONTEXT_IN - Context interrupt
• AES_INT_CONTEXT_OUT - Authentication tag (and IV) interrupt.
• AES_INT_DATA_IN - Data input interrupt
• AES_INT_DATA_OUT - Data output interrupt
• AES_INT_DMA_CONTEXT_IN - Context DMA done interrupt
• AES_INT_DMA_CONTEXT_OUT - Authentication tag (and IV) DMA done interrupt
• AES_INT_DMA_DATA_IN - Data input DMA done interrupt
• AES_INT_DMA_DATA_OUT - Data output DMA done interrupt

void AESIntUnregister

(

uint32_t

ui32Base

)

Unregisters an interrupt handler for the AES module.

Parameters

ui32Base

is the base address of the AES module.

This function unregisters the previously registered interrupt handler and disables the interrupt in the interrupt controller.

See also

IntRegister() for important information about registering interrupt handlers.

Returns

None.

void AESIVGet	(	uint32_t	ui32Base,
		uint8_t *	pui8IVdata
	)

Reads the Initial Vector (IV) register, needed in some of the AES Modes.

Parameters

ui32Base	is the base address of the AES module.
pui8IVdata	is pointer to an array of 16 bytes.

This functions reads the initial vector registers in the AES module.

Returns

None.

void AESIVSet	(	uint32_t	ui32Base,
		uint8_t *	pui8IVdata
	)

Writes the Initial Vector (IV) register, needed in some of the AES Modes.

Parameters

ui32Base	is the base address of the AES module.
pui8IVdata	is an array of 16 bytes (128 bits), containing the IV value to be configured. The least significant word is in the 0th index.

This functions writes the initial vector registers in the AES module.

Returns

None.

void AESKey1Set	(	uint32_t	ui32Base,
		uint8_t *	pui8Key,
		uint32_t	ui32Keysize
	)

Writes the key 1 configuration registers, which are used for encryption or decryption.

Parameters

ui32Base	is the base address for the AES module.
pui8Key	is an array of bytes, containing the key to be configured. The least significant word in the 0th index.
ui32Keysize	is the size of the key, which must be one of the following values: AES_CFG_KEY_SIZE_128, AES_CFG_KEY_SIZE_192, or AES_CFG_KEY_SIZE_256.

This function writes key 1 configuration registers based on the key size. This function is used in all modes.

Returns

None.

void AESKey2Set	(	uint32_t	ui32Base,
		uint8_t *	pui8Key,
		uint32_t	ui32Keysize
	)

Writes the key 2 configuration registers, which are used for encryption or decryption.

Parameters

ui32Base	is the base address for the AES module.
pui8Key	is an array of bytes, containing the key to be configured. The least significant word in the 0th index.
ui32Keysize	is the size of the key, which must be one of the following values: AES_CFG_KEY_SIZE_128, AES_CFG_KEY_SIZE_192, or AES_CFG_KEY_SIZE_256.

This function writes the key 2 configuration registers based on the key size. This function is used in the F8, F9, XTS, CCM, and CBC-MAC modes.

Returns

None.

void AESKey3Set	(	uint32_t	ui32Base,
		uint8_t *	pui8Key
	)

Writes key 3 configuration registers, which are used for encryption or decryption.

Parameters

ui32Base	is the base address for the AES module.
pui8Key	is a pointer to an array bytes, containing the key to be configured. The least significant word is in the 0th index.

This function writes the key 2 configuration registers with key 3 data used in CBC-MAC and F8 modes. This key is always 128 bits.

Returns

None.

void AESTagRead	(	uint32_t	ui32Base,
		uint8_t *	pui8TagData
	)

Saves the tag registers to a user-defined location.

Parameters

ui32Base	is the base address of the AES module.
pui8TagData	is pointer to the location that stores the tag data.

This function stores the tag data for use authenticated encryption and decryption operations.

Returns

None.