A66 STM32_HAL库函数 之 USART通用驱动 -- B -- 所有函数的介绍及使用
1 该驱动函数预览
序号 |
函数名 |
描述 |
1 |
HAL_USART_Init() |
初始化USART。 |
2 |
HAL_USART_DeInit() |
反初始化USART。 |
3 |
HAL_USART_MspInit() |
初始化USART的底层硬件资源。 |
4 |
HAL_USART_MspDeInit() |
反初始化USART的底层硬件资源。 |
5 |
HAL_USART_Transmit() |
发送USART数据。 |
6 |
HAL_USART_Receive() |
接收USART数据。 |
7 |
HAL_USART_TransmitReceive() |
发送并接收USART数据。 |
8 |
HAL_USART_Transmit_IT() |
使用中断发送USART数据。 |
9 |
HAL_USART_Receive_IT() |
使用中断接收USART数据。 |
10 |
HAL_USART_TransmitReceive_IT() |
使用中断发送并接收USART数据。 |
11 |
HAL_USART_Transmit_DMA() |
使用DMA发送USART数据。 |
12 |
HAL_USART_Receive_DMA() |
使用DMA接收USART数据。 |
13 |
HAL_USART_TransmitReceive_DMA() |
使用DMA发送并接收USART数据。 |
14 |
HAL_USART_DMAPause() |
暂停USART的DMA传输。 |
15 |
HAL_USART_DMAResume() |
恢复USART的DMA传输。 |
16 |
HAL_USART_DMAStop() |
停止USART的DMA传输。 |
17 |
HAL_USART_Abort() |
中止USART的传输。 |
18 |
HAL_USART_Abort_IT() |
使用中断中止USART的传输。 |
19 |
HAL_USART_IRQHandler() |
USART中断处理函数。 |
20 |
HAL_USART_TxCpltCallback() |
USART发送完成回调函数。 |
21 |
HAL_USART_TxHalfCpltCallback() |
USART半发送完成回调函数。 |
22 |
HAL_USART_RxCpltCallback() |
USART接收完成回调函数。 |
23 |
HAL_USART_RxHalfCpltCallback() |
USART半接收完成回调函数。 |
24 |
HAL_USART_TxRxCpltCallback() |
USART发送接收完成回调函数。 |
25 |
HAL_USART_ErrorCallback() |
USART错误回调函数。 |
26 |
HAL_USART_AbortCpltCallback() |
USART中止完成回调函数。 |
27 |
HAL_USART_GetState() |
获取USART状态。 |
28 |
HAL_USART_GetError() |
获取USART错误状态。 |
1.15 HAL_USART_DMAResume
函数名 |
HAL_USART_DMAResume |
函数原形 |
HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart) |
功能描述 |
恢复USART外设的DMA传输 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_DMAResume(&husart); |
``` |
|
1.16 HAL_USART_DMAStop
函数名 |
HAL_USART_DMAStop |
函数原形 |
HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart) |
功能描述 |
停止USART外设的DMA传输 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_DMAStop(&husart); |
``` |
|
1.17 HAL_USART_Abort
函数名 |
HAL_USART_Abort |
函数原形 |
HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart) |
功能描述 |
终止USART外设的传输 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_Abort(&husart); |
``` |
|
1.18 HAL_USART_Abort_IT
函数名 |
HAL_USART_Abort_IT |
函数原形 |
HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart) |
功能描述 |
使用中断方式终止USART外设的传输 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_Abort_IT(&husart); |
``` |
|
1.19 HAL_USART_IRQHandler
函数名 |
HAL_USART_IRQHandler |
函数原形 |
void HAL_USART_IRQHandler(USART_HandleTypeDef *husart) |
功能描述 |
USART外设的中断处理函数 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
无 |
1.20 HAL_USART_TxCpltCallback
函数名 |
HAL_USART_TxCpltCallback |
|
| 函数原形 | void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart) |
| 功能描述 | 发送完成的回调函数,用户自定义处理发送完成时的操作 |
| 输入参数 | husart:USART句柄结构体指针 |
| 输出参数 | 无 |
| 返回值 | 无 |
| 先决条件 | 无 |
| 被调用函数 | HAL_USART_IRQHandler |
| 案例 | 无 |
1.21 HAL_USART_TxHalfCpltCallback
函数名 |
HAL_USART_TxHalfCpltCallback |
函数原形 |
void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart) |
功能描述 |
发送完成一半时的回调函数,用户自定义处理发送完成一半时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
无 |
1.22 HAL_USART_RxCpltCallback
函数名 |
HAL_USART_RxCpltCallback |
函数原形 |
void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart) |
功能描述 |
接收完成的回调函数,用户自定义处理接收完成时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
无 |
1.23 HAL_USART_RxHalfCpltCallback
函数名 |
HAL_USART_RxHalfCpltCallback |
函数原形 |
void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart) |
功能描述 |
接收完成一半时的回调函数,用户自定义处理接收完成一半时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
无 |
1.24 HAL_USART_TxRxCpltCallback
函数名 |
HAL_USART_TxRxCpltCallback |
函数原形 |
void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart) |
功能描述 |
发送和接收完成的回调函数,用户自定义处理发送和接收完成时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
无 |
1.25 HAL_USART_ErrorCallback
函数名 |
HAL_USART_ErrorCallback |
函数原形 |
void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart) |
功能描述 |
错误处理回调函数,用户自定义处理USART错误时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
无 |
1.26 HAL_USART_AbortCpltCallback
函数名 |
HAL_USART_AbortCpltCallback |
函数原形 |
void HAL_USART_AbortCpltCallback(USART_HandleTypeDef *husart) |
功能描述 |
终止传输完成的回调函数,用户自定义处理终止传输完成时的操作 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
无 |
1.27 HAL_USART_GetState
函数名 |
HAL_USART_GetState |
函数原形 |
uint32_t |
HAL_USART_GetState(USART_HandleTypeDef *husart) |
| 功能描述 | 获取USART外设的状态 |
| 输入参数 | husart:USART句柄结构体指针 |
| 输出参数 | 无 |
| 返回值 | uint32_t:USART外设的状态 |
| 先决条件 | 无 |
| 被调用函数 | 无 |
| 案例 | c | | | USART_HandleTypeDef husart; | | | uint32_t state = HAL_USART_GetState(&husart); | |
|
1.28 HAL_USART_GetError
函数名 |
HAL_USART_GetError |
函数原形 |
uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart) |
功能描述 |
获取USART外设的错误 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
uint32_t:USART外设的错误 |
先决条件 |
无 |
被调用函数 |
HAL_USART_IRQHandler |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint32_t error = HAL_USART_GetError(&husart); |
``` |
|
该文档修改记录:
修改时间 |
修改说明 |
2024年4月30日 |
第一次发布,介绍了该博客驱动所有函数的介绍及使用 |
总结
以上就是该博客驱动所有函数的介绍及使用的内容。
有不明白的地方欢迎留言;有建议欢迎留言,我后面编写文档好改进。
创作不容,如果文档对您有帮助,记得给个赞。