AES驱动API描述

hal_status_t hal_aes_init(aes_handle_t *p_aes)

根据aes_init_t结构体里的参数初始化AES外设。

p_aes：指向aes_handle_t结构体变量的指针，该结构体变量包含指定的AES配置信息。

HAL状态。

hal_status_t hal_aes_deinit(aes_handle_t *p_aes)

反初始化AES外设，将AES模块的寄存器恢复为默认值。

p_aes：指向aes_handle_t结构体变量的指针，包含指定的寄存器基址。

HAL状态。

void hal_aes_msp_init(aes_handle_t *p_aes)

初始化AES外设所使用的NVIC中断、DMA通道等配置。

p_aes：指向aes_handle_t结构体变量的指针。

无

该函数为weak类型的空函数，开发者需重写该API完成NVIC中断、DMA通道的初始化。

void hal_aes_msp_deinit(aes_handle_t *p_aes)

反初始化AES外设所使用的NVIC中断、DMA通道等配置。

p_aes：指向aes_handle_t结构体变量的指针。

无

该函数为weak类型的空函数，开发者需重写该API完成NVIC中断、DMA通道的反初始化。

hal_status_t hal_aes_ecb_encrypt(aes_handle_t *p_aes, uint32_t *p_plain_data, uint32_t number, uint32_t *p_cypher_data, uint32_t timeout)

ECB模式加密，轮询方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_plain_data：指向待加密数据的指针。

number：待加密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_cypher_data：指向存储加密结果的内存空间的指针。

timeout：超时时间，单位ms。

HAL状态。

待加密数据流超过最大长度时，可分多次加密。

hal_status_t hal_aes_ecb_decrypt(aes_handle_t *p_aes, uint32_t *p_cypher_data, uint32_t number, uint32_t *p_plain_data, uint32_t timeout)

ECB模式解密，轮询方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_cypher_data：指向待解密数据的指针。

number：待解密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_plain_data：指向存储解密结果的内存空间的指针。

timeout：超时时间，单位ms。

HAL状态

待解密数据流超过最大长度时，可分多次解密

hal_status_t hal_aes_cbc_encrypt(aes_handle_t *p_aes, uint32_t *p_plain_data, uint32_t number, uint32_t *p_cypher_data, uint32_t timeout)

CBC模式加密，轮询方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_plain_data：指向待加密数据的指针。

number：待加密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_cypher_data：指向存储加密结果的内存空间的指针。

timeout：超时时间，单位ms。

HAL状态。

待加密数据流超过最大长度时，可分多次加密，并且从第二次开始需重载初始化向量（p_aes->init.p_init_vector）为上一次加密结果的最后16 bytes数据。

hal_status_t hal_aes_cbc_decrypt(aes_handle_t *p_aes, uint32_t *p_cypher_data, uint32_t number, uint32_t *p_plain_data, uint32_t timeout)

CBC模式解密，轮询方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_cypher_data：指向待解密数据的指针。

number：待解密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_plain_data：指向存储解密结果的内存空间的指针。

timeout：超时时间，单位ms。

HAL状态。

待解密数据流超过最大长度时，可分多次解密，从第二次开始需重载初始化向量（p_aes->init.p_init_vector）为上一次待解密数据的最后16 bytes数据。

hal_status_t hal_aes_ecb_encrypt_it(aes_handle_t *p_aes, uint32_t *p_plain_data, uint32_t number, uint32_t *p_cypher_data)

ECB模式加密，中断方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_plain_data：指向待加密数据的指针。

number：待加密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_cypher_data：指向存储加密结果的内存空间的指针。

HAL状态。

待加密数据流超过最大长度时，可分多次加密。

hal_status_t hal_aes_ecb_decrypt_it(aes_handle_t *p_aes, uint32_t *p_cypher_data, uint32_t number, uint32_t *p_plain_data)

ECB模式解密，中断方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_cypher_data：指向待解密数据的指针。

number：待解密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_plain_data：指向存储解密结果的内存空间的指针。

HAL状态。

待解密数据流超过最大长度时，可分多次解密。

hal_status_t hal_aes_cbc_encrypt_it(aes_handle_t *p_aes, uint32_t *p_plain_data, uint32_t number, uint32_t *p_cypher_data)

CBC模式加密，中断方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_plain_data：指向待加密数据的指针。

number：待加密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_cypher_data：指向存储加密结果的内存空间的指针。

HAL状态。

待加密数据流超过最大长度时，可分多次加密，从第二次开始需重载初始化向量（p_aes->init.p_init_vector）为上一次加密结果的最后16 bytes数据。

hal_status_t hal_aes_cbc_decrypt_it(aes_handle_t *p_aes, uint32_t *p_cypher_data, uint32_t number, uint32_t *p_plain_data)

CBC模式解密，中断方式。

p_aes：指向aes_handle_t结构体变量的指针。

p_cypher_data：指向待解密数据的指针。

number：待解密数据的长度，单位byte，最大取值为32768，且必须为16的整数倍。

p_plain_data：指向存储解密结果的内存空间的指针。

HAL状态。

待解密数据流超过最大长度时，可分多次解密，从第二次开始需重载初始化向量（p_aes->init.p_init_vector）为上一次待解密数据的最后16 bytes数据。

hal_status_t hal_aes_abort(aes_handle_t *p_aes)

中止加解密，轮询方式。

p_aes：指向aes_handle_t结构体变量的指针。

HAL状态。

该接口用于中止非轮询方式的加解密过程。轮询式接口，中止操作完成后返回状态。

hal_status_t hal_aes_abort_it(aes_handle_t *p_aes)

中止加解密，中断方式。

p_aes：指向aes_handle_t结构体变量的指针。

HAL状态。

该接口用于中止非轮询方式的加解密过程。非轮询式接口，立即返回状态，中止操作完成后调用hal_aes_abort_cplt_callback()。

void hal_aes_irq_handler(aes_handle_t *p_aes)

处理AES中断请求。

p_aes：指向aes_handle_t结构体变量的指针。

无

void hal_aes_done_callback(aes_handle_t *p_aes)

AES加解密完成回调函数。

p_aes：指向aes_handle_t结构体变量的指针。

无

中断或DMA方式下加解密操作完成时该接口会被调用。该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_aes_error_callback(aes_handle_t *p_aes)

AES加解密错误回调函数。

p_aes：指向aes_handle_t结构体变量的指针。

无

中断或DMA方式下加解密操作出现错误时该接口会被调用。该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_aes_abort_cplt_callback(aes_handle_t *p_aes)

AES加解密中止回调函数。

p_aes：指向aes_handle_t结构体变量的指针。

无

中断或DMA方式下加解密操作被中止时该接口会被调用。该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

hal_aes_state_t hal_aes_get_state(aes_handle_t *p_aes)

获取AES运行状态。

p_aes：指向aes_handle_t结构体变量的指针。

AES运行状态，该参数的取值可能是下列值中的任意一个：

• HAL_AES_STATE_RESET（未初始化）
• HAL_AES_STATE_READY（已初始化且空闲）
• HAL_AES_STATE_BUSY（忙）
• HAL_AES_STATE_ERROR（运行错误）
• HAL_AES_STATE_TIMEOUT（超时）
• HAL_AES_STATE_SUSPENDED（已挂起）

uint32 hal_aes_get_error(aes_handle_t *p_aes)

获取AES错误码。

p_aes：指向aes_handle_t结构体变量的指针。

AES错误码，该参数的取值可能是下列值中的任意一个：

• HAL_AES_ERROR_NONE（无错误）
• HAL_AES_ERROR_TIMEOUT（超时）
• HAL_AES_ERROR_TRANSFER（传输错误）
• HAL_AES_ERROR_INVALID_PARAM（非法参数）

void hal_aes_set_timeout(aes_handle_t *p_aes)

设置AES操作超时时间。

p_aes：指向aes_handle_t结构体变量的指针。

无

hal_status_t hal_aes_suspend_reg(aes_handle_t *p_aes)

睡眠时挂起AES配置相关的寄存器

p_aes：指向aes_handle_t结构体变量的指针。

HAL状态

hal_status_t hal_aes_resume_reg(aes_handle_t *p_aes)

唤醒时恢复AES配置相关的寄存器

p_aes：指向aes_handle_t结构体变量的指针。

HAL状态。