CC3200 Peripheral Driver Library User's Guide
1.2.0
|
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) |
void AESAuthDataLengthSet | ( | uint32_t | ui32Base, |
uint32_t | ui32Length | ||
) |
Sets the optional additional authentication data (AAD) length.
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.
void AESConfigSet | ( | uint32_t | ui32Base, |
uint32_t | ui32Config | ||
) |
Configures the AES module.
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:
The key size is specified with only one of the following flags:
The mode of operation is specified with only one of the following flags.
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:
Only one of the following defines must be used to specify the length field for CCM operations (L):
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:
void AESDataLengthSet | ( | uint32_t | ui32Base, |
uint64_t | ui64Length | ||
) |
Used to set the write crypto data length in the AES module.
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.
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.
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.
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.
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.
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.
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.
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
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.
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
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.
void AESDataWrite | ( | uint32_t | ui32Base, |
uint8_t * | pui8Src, | ||
uint8_t | ui8Length | ||
) |
Writes plaintext/ciphertext to data registers with blocking.
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.
bool AESDataWriteNonBlocking | ( | uint32_t | ui32Base, |
uint8_t * | pui8Src, | ||
uint8_t | ui8Length | ||
) |
Writes plaintext/ciphertext to data registers without blocking.
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.
void AESDMADisable | ( | uint32_t | ui32Base, |
uint32_t | ui32Flags | ||
) |
Disables uDMA requests for the AES module.
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:
void AESDMAEnable | ( | uint32_t | ui32Base, |
uint32_t | ui32Flags | ||
) |
Enables uDMA requests for the AES module.
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:
void AESIntClear | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Clears AES module interrupts.
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:
void AESIntDisable | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Disables AES module interrupts.
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:
void AESIntEnable | ( | uint32_t | ui32Base, |
uint32_t | ui32IntFlags | ||
) |
Enables AES module interrupts.
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:
void AESIntRegister | ( | uint32_t | ui32Base, |
void(*)(void) | pfnHandler | ||
) |
Registers an interrupt handler for the AES module.
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.
uint32_t AESIntStatus | ( | uint32_t | ui32Base, |
bool | bMasked | ||
) |
Returns the current AES module interrupt status.
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. |
void AESIntUnregister | ( | uint32_t | ui32Base | ) |
Unregisters an interrupt handler for the AES module.
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.
void AESIVGet | ( | uint32_t | ui32Base, |
uint8_t * | pui8IVdata | ||
) |
Reads the Initial Vector (IV) register, needed in some of the AES Modes.
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.
void AESIVSet | ( | uint32_t | ui32Base, |
uint8_t * | pui8IVdata | ||
) |
Writes the Initial Vector (IV) register, needed in some of the AES Modes.
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.
void AESKey1Set | ( | uint32_t | ui32Base, |
uint8_t * | pui8Key, | ||
uint32_t | ui32Keysize | ||
) |
Writes the key 1 configuration registers, which are used for encryption or decryption.
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.
void AESKey2Set | ( | uint32_t | ui32Base, |
uint8_t * | pui8Key, | ||
uint32_t | ui32Keysize | ||
) |
Writes the key 2 configuration registers, which are used for encryption or decryption.
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.
void AESKey3Set | ( | uint32_t | ui32Base, |
uint8_t * | pui8Key | ||
) |
Writes key 3 configuration registers, which are used for encryption or decryption.
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.
void AESTagRead | ( | uint32_t | ui32Base, |
uint8_t * | pui8TagData | ||
) |
Saves the tag registers to a user-defined location.
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.