dm: crypto: Create AES uclass

Create a basic framework for a group of devices that perform AES
cryptographic operations.

Signed-off-by: Ion Agorria <ion@agorria.com>
Signed-off-by: Svyatoslav Ryhel <clamor95@gmail.com>
This commit is contained in:
Ion Agorria
2025-06-29 13:57:08 +03:00
committed by Tom Rini
parent a14da5ed61
commit 0d84494064
7 changed files with 455 additions and 0 deletions

View File

@@ -38,6 +38,7 @@ enum uclass_id {
/* U-Boot uclasses start here - in alphabetical order */
UCLASS_ACPI_PMC, /* (x86) Power-management controller (PMC) */
UCLASS_ADC, /* Analog-to-digital converter */
UCLASS_AES, /* AES cryptographic engine */
UCLASS_AHCI, /* SATA disk controller */
UCLASS_AUDIO_CODEC, /* Audio codec with control and data path */
UCLASS_AXI, /* AXI bus */

View File

@@ -7,6 +7,8 @@
#ifndef _AES_REF_H_
#define _AES_REF_H_
#include <errno.h>
#ifdef USE_HOSTCC
/* Define compat stuff for use in fw_* tools. */
typedef unsigned char u8;
@@ -107,4 +109,253 @@ void aes_cbc_encrypt_blocks(u32 key_size, u8 *key_exp, u8 *iv, u8 *src, u8 *dst,
void aes_cbc_decrypt_blocks(u32 key_size, u8 *key_exp, u8 *iv, u8 *src, u8 *dst,
u32 num_aes_blocks);
/* An AES block filled with zeros */
static const u8 AES_ZERO_BLOCK[AES_BLOCK_LENGTH] = { 0 };
struct udevice;
/**
* struct struct aes_ops - Driver model for AES related operations
*
* The uclass interface is implemented by AES crypto devices which use driver model.
*
* Some AES crypto devices use key slots to store the key for the encrypt/decrypt
* operations, while others may simply pass the key on each operation.
*
* In case the device does not implement hardware slots, driver can emulate or simply
* store one active key slot at 0 in the driver state and pass it on each underlying
* hw calls for AES operations.
*
* Note that some devices like Tegra AES engine may contain preloaded keys by bootrom,
* thus in those cases the set_key_for_key_slot() may be skipped.
*
* Sequence for a series of AES CBC encryption, one decryption and a CMAC hash example
* with 128bits key at slot 0 would be as follow:
*
* set_key_for_key_slot(DEV, 128, KEY, 0);
* select_key_slot(DEV, 128, 0);
* aes_cbc_encrypt(DEV, IV1, SRC1, DST1, LEN1);
* aes_cbc_encrypt(DEV, IV2, SRC2, DST2, LEN2);
* aes_cbc_decrypt(DEV, IV3, SRC3, DST3, LEN3);
*/
struct aes_ops {
/**
* available_key_slots() - How many key slots this AES device has
*
* @dev The AES udevice
* @return Available slots to use, 0 for none
*/
int (*available_key_slots)(struct udevice *dev);
/**
* select_key_slot() - Selects the AES key slot to use for following operations
*
* @dev The AES udevice
* @key_size Size of the aes key (in bits)
* @slot The key slot to set as selected
* @return 0 on success, negative value on failure
*/
int (*select_key_slot)(struct udevice *dev, u32 key_size, u8 slot);
/**
* set_key_for_key_slot() - Sets the AES key to use for specified key slot
*
* @dev The AES udevice
* @key_size Size of the aes key (in bits)
* @key An AES key to set
* @slot The slot to load the key at
* @return 0 on success, negative value on failure
*/
int (*set_key_for_key_slot)(struct udevice *dev, u32 key_size, u8 *key,
u8 slot);
/**
* aes_ecb_encrypt() - Encrypt multiple blocks of data with AES ECB.
*
* @dev The AES udevice
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* @return 0 on success, negative value on failure
*/
int (*aes_ecb_encrypt)(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* aes_ecb_decrypt() - Decrypt multiple blocks of data with AES ECB.
*
* @dev The AES udevice
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* @return 0 on success, negative value on failure
*/
int (*aes_ecb_decrypt)(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* aes_cbc_encrypt() - Encrypt multiple blocks of data with AES CBC.
*
* @dev The AES udevice
* @iv Initialization vector
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* @return 0 on success, negative value on failure
*/
int (*aes_cbc_encrypt)(struct udevice *dev, u8 *iv,
u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* aes_cbc_decrypt() - Decrypt multiple blocks of data with AES CBC.
*
* @dev The AES udevice
* @iv Initialization vector
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* @return 0 on success, negative value on failure
*/
int (*aes_cbc_decrypt)(struct udevice *dev, u8 *iv,
u8 *src, u8 *dst, u32 num_aes_blocks);
};
#define aes_get_ops(dev) ((struct aes_ops *)(dev)->driver->ops)
#if CONFIG_IS_ENABLED(DM_AES)
/**
* dm_aes_get_available_key_slots - How many key slots this AES device has
*
* @dev The AES udevice
* Return: Available slots to use, 0 for none, -ve on failure
*/
int dm_aes_get_available_key_slots(struct udevice *dev);
/**
* dm_aes_select_key_slot - Selects the AES key slot to use for following operations
*
* @dev The AES udevice
* @key_size Size of the aes key (in bits)
* @slot The key slot to set as selected
* Return: 0 on success, -ve on failure
*/
int dm_aes_select_key_slot(struct udevice *dev, u32 key_size, u8 slot);
/**
* dm_aes_set_key_for_key_slot - Sets the AES key to use for specified key slot
*
* @dev The AES udevice
* @key_size Size of the aes key (in bits)
* @key An AES key to set
* @slot The slot to load the key at
* Return: 0 on success, negative value on failure
*/
int dm_aes_set_key_for_key_slot(struct udevice *dev, u32 key_size, u8 *key, u8 slot);
/**
* dm_aes_ecb_encrypt - Encrypt multiple blocks of data with AES ECB.
*
* @dev The AES udevice
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* Return: 0 on success, negative value on failure
*/
int dm_aes_ecb_encrypt(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* dm_aes_ecb_decrypt - Decrypt multiple blocks of data with AES ECB.
*
* @dev The AES udevice
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* Return: 0 on success, negative value on failure
*/
int dm_aes_ecb_decrypt(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* dm_aes_cbc_encrypt - Encrypt multiple blocks of data with AES CBC.
*
* @dev The AES udevice
* @iv Initialization vector
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* Return: 0 on success, negative value on failure
*/
int dm_aes_cbc_encrypt(struct udevice *dev, u8 *iv, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* dm_aes_cbc_decrypt - Decrypt multiple blocks of data with AES CBC.
*
* @dev The AES udevice
* @iv Initialization vector
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination data of length 'num_aes_blocks' blocks
* @num_aes_blocks Number of AES blocks to encrypt/decrypt
* Return: 0 on success, negative value on failure
*/
int dm_aes_cbc_decrypt(struct udevice *dev, u8 *iv, u8 *src, u8 *dst, u32 num_aes_blocks);
/**
* dm_aes_cmac - Hashes the input data with AES-CMAC, putting the result into dst.
* The key slot must be selected already.
*
* @dev The AES udevice
* @key_size Size of the aes key (in bits)
* @src Source data of length 'num_aes_blocks' blocks
* @dst Destination for hash result
* @num_aes_blocks Number of AES blocks to encrypt
* Return: 0 on success, negative value on failure.
*/
int dm_aes_cmac(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks);
#else
static inline int dm_aes_get_available_key_slots(struct udevice *dev)
{
return -ENOSYS;
}
static inline int dm_aes_select_key_slot(struct udevice *dev, u32 key_size, u8 slot)
{
return -ENOSYS;
}
static inline int dm_aes_set_key_for_key_slot(struct udevice *dev, u32 key_size, u8 *key,
u8 slot)
{
return -ENOSYS;
}
static inline int dm_aes_ecb_encrypt(struct udevice *dev, u8 *src, u8 *dst,
u32 num_aes_blocks)
{
return -ENOSYS;
}
static inline int dm_aes_ecb_decrypt(struct udevice *dev, u8 *src, u8 *dst,
u32 num_aes_blocks)
{
return -ENOSYS;
}
static inline int dm_aes_cbc_encrypt(struct udevice *dev, u8 *iv, u8 *src,
u8 *dst, u32 num_aes_blocks)
{
return -ENOSYS;
}
static inline int dm_aes_cbc_decrypt(struct udevice *dev, u8 *iv, u8 *src,
u8 *dst, u32 num_aes_blocks)
{
return -ENOSYS;
}
static inline int dm_aes_cmac(struct udevice *dev, u8 *src, u8 *dst, u32 num_aes_blocks)
{
return -ENOSYS;
}
#endif /* CONFIG_DM_AES */
#endif /* _AES_REF_H_ */