...
A65 STM32_HAL库函数 之 USART通用驱动 -- A -- 所有函数的介绍及使用
- 1 该驱动函数预览
- 1.1 HAL_USART_Init
- 1.2 HAL_USART_DeInit
- 1.3 HAL_USART_MspInit
- 1.4 HAL_USART_MspDeInit
- 1.5 HAL_USART_Transmit
- 1.6 HAL_USART_Receive
- 1.7 HAL_USART_TransmitReceive
- 1.8 HAL_USART_Transmit_IT
- 1.9 HAL_USART_Receive_IT
- 1.10 HAL_USART_TransmitReceive_IT
- 1.11 HAL_USART_Transmit_DMA
- 1.12 HAL_USART_Receive_DMA
- 1.13 HAL_USART_TransmitReceive_DMA
- 1.14 HAL_USART_DMAPause
- 该文档修改记录:
- 总结
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.1 HAL_USART_Init
函数名 |
HAL_USART_Init |
函数原形 |
HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart) |
功能描述 |
初始化USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_Init(&husart); |
``` |
|
1.2 HAL_USART_DeInit
函数名 |
HAL_USART_DeInit |
函数原形 |
HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart) |
功能描述 |
复位USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_DeInit(&husart); |
``` |
|
1.3 HAL_USART_MspInit
函数名 |
HAL_USART_MspInit |
函数原形 |
void HAL_USART_MspInit(USART_HandleTypeDef *husart) |
功能描述 |
初始化USART外设的GPIO和时钟 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_USART_MspInit(&husart); |
``` |
|
1.4 HAL_USART_MspDeInit
函数名 |
HAL_USART_MspDeInit |
函数原形 |
void HAL_USART_MspDeInit(USART_HandleTypeDef *husart) |
功能描述 |
复位USART外设的GPIO和时钟 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
无 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_USART_MspDeInit(&husart); |
``` |
|
1.5 HAL_USART_Transmit
函数名 |
HAL_USART_Transmit |
函数原形 |
HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size, uint32_t Timeout) |
功能描述 |
发送数据到USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
|
pData:要发送的数据缓冲区指针 |
|
Size:要发送的数据大小 |
|
Timeout:发送超时时间(毫秒) |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t data[] = {0x01, 0x02, 0x03}; |
|
HAL_StatusTypeDef status = HAL_USART_Transmit(&husart, data, sizeof(data), 1000); |
``` |
|
1.6 HAL_USART_Receive
函数名 |
HAL_USART_Receive |
函数原形 |
HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size, uint32_t Timeout) |
功能描述 |
从USART外设接收数据 |
输入参数 |
husart:USART句柄结构体指 |
针 |
| | pData:接收数据的缓冲区指针 |
| | Size:要接收的数据大小 |
| | Timeout:接收超时时间(毫秒) |
| 输出参数 | 无 |
| 返回值 | HAL_StatusTypeDef:函数执行状态 |
| 先决条件 | 无 |
| 被调用函数 | 无 |
| 案例 | c | | | USART_HandleTypeDef husart; | | | uint8_t data[10]; | | | HAL_StatusTypeDef status = HAL_USART_Receive(&husart, data, sizeof(data), 1000); | |
|
1.7 HAL_USART_TransmitReceive
函数名 |
HAL_USART_TransmitReceive |
函数原形 |
HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout) |
功能描述 |
发送和接收数据到USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
|
pTxData:要发送的数据缓冲区指针 |
|
pRxData:接收数据的缓冲区指针 |
|
Size:要发送和接收的数据大小 |
|
Timeout:发送和接收超时时间(毫秒) |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t tx_data[] = {0x01, 0x02, 0x03}; |
|
uint8_t rx_data[3]; |
|
HAL_StatusTypeDef status = HAL_USART_TransmitReceive(&husart, tx_data, rx_data, sizeof(tx_data), 1000); |
``` |
|
1.8 HAL_USART_Transmit_IT
函数名 |
HAL_USART_Transmit_IT |
函数原形 |
HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size) |
功能描述 |
使用中断方式发送数据到USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
|
pData:要发送的数据缓冲区指针 |
|
Size:要发送的数据大小 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t data[] = {0x01, 0x02, 0x03}; |
|
HAL_StatusTypeDef status = HAL_USART_Transmit_IT(&husart, data, sizeof(data)); |
``` |
|
1.9 HAL_USART_Receive_IT
函数名 |
HAL_USART_Receive_IT |
函数原形 |
HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size) |
功能描述 |
使用中断方式从USART外设接收数据 |
输入参数 |
husart:USART句柄结构体指针 |
|
pData:接收数据的缓冲区指针 |
|
Size:要接收的数据大小 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t data[10]; |
|
HAL_StatusTypeDef status = HAL_USART_Receive_IT(&husart, data, sizeof(data)); |
``` |
|
1.10 HAL_USART_TransmitReceive_IT
函数名 |
HAL_USART_TransmitReceive_IT |
函数原形 |
HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTx |
Data, uint8_t *pRxData, uint16_t Size) |
| 功能描述 | 使用中断方式发送和接收数据到USART外设 |
| 输入参数 | husart:USART句柄结构体指针 |
| | pTxData:要发送的数据缓冲区指针 |
| | pRxData:接收数据的缓冲区指针 |
| | Size:要发送和接收的数据大小 |
| 输出参数 | 无 |
| 返回值 | HAL_StatusTypeDef:函数执行状态 |
| 先决条件 | 无 |
| 被调用函数 | 无 |
| 案例 | c | | | USART_HandleTypeDef husart; | | | uint8_t tx_data[] = {0x01, 0x02, 0x03}; | | | uint8_t rx_data[3]; | | | HAL_StatusTypeDef status = HAL_USART_TransmitReceive_IT(&husart, tx_data, rx_data, sizeof(tx_data)); | |
|
1.11 HAL_USART_Transmit_DMA
函数名 |
HAL_USART_Transmit_DMA |
函数原形 |
HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size) |
功能描述 |
使用DMA方式发送数据到USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
|
pData:要发送的数据缓冲区指针 |
|
Size:要发送的数据大小 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t data[] = {0x01, 0x02, 0x03}; |
|
HAL_StatusTypeDef status = HAL_USART_Transmit_DMA(&husart, data, sizeof(data)); |
``` |
|
1.12 HAL_USART_Receive_DMA
函数名 |
HAL_USART_Receive_DMA |
函数原形 |
HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pData, uint16_t Size) |
功能描述 |
使用DMA方式从USART外设接收数据 |
输入参数 |
husart:USART句柄结构体指针 |
|
pData:接收数据的缓冲区指针 |
|
Size:要接收的数据大小 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t data[10]; |
|
HAL_StatusTypeDef status = HAL_USART_Receive_DMA(&husart, data, sizeof(data)); |
``` |
|
1.13 HAL_USART_TransmitReceive_DMA
函数名 |
HAL_USART_TransmitReceive_DMA |
函数原形 |
HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size) |
功能描述 |
使用DMA方式发送和接收数据到USART外设 |
输入参数 |
husart:USART句柄结构体指针 |
|
pTxData:要发送的数据缓冲区指针 |
|
pRxData:接收数据的缓冲区指针 |
|
Size:要发送和接收的数据大小 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
uint8_t tx_data[] = {0x01, 0x02, 0x03}; |
|
uint8_t rx_data[3]; |
|
HAL_StatusTypeDef status |
= HAL_USART_TransmitReceive_DMA(&husart, tx_data, rx_data, sizeof(tx_data)); |
| ``` |
1.14 HAL_USART_DMAPause
函数名 |
HAL_USART_DMAPause |
函数原形 |
HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart) |
功能描述 |
暂停USART外设的DMA传输 |
输入参数 |
husart:USART句柄结构体指针 |
输出参数 |
无 |
返回值 |
HAL_StatusTypeDef:函数执行状态 |
先决条件 |
无 |
被调用函数 |
无 |
案例 |
```c |
|
USART_HandleTypeDef husart; |
|
HAL_StatusTypeDef status = HAL_USART_DMAPause(&husart); |
``` |
|
该文档修改记录:
修改时间 |
修改说明 |
2024年4月30日 |
第一次发布,介绍了该博客驱动所有函数的介绍及使用 |
总结
以上就是该博客驱动所有函数的介绍及使用的内容。
有不明白的地方欢迎留言;有建议欢迎留言,我后面编写文档好改进。
创作不容,如果文档对您有帮助,记得给个赞。