title: 我的程序库01_HAL库文件的头文件结构
tags: 编程,STM32,函数库,程序库
grammar_cjkRuby: true
防重复编译和C++冲突申明
其中#ifndef 是为了防止重复编译，cplusplus 是为了防止编译冲突
#ifndef __STM32F4xx_HAL_USART_H //如果没有包含过头文件，则包含进去
#define __STM32F4xx_HAL_USART_H
#ifdef __cplusplus //如果编译器是C++，则下面的语句以C语言进行编译，这里是为了兼容C++调用
extern "C" {
#endif
包含头文件
其中HAL_DEF文件包含了一些HAL要用到的标志数据结构枚举等
#include "stm32f4xx_hal_def.h"
HAL_OK = 0x00U,
HAL_ERROR = 0x01U,
HAL_BUSY = 0x02U,
HAL_TIMEOUT = 0x03U
结构体的定义，包括如下几个结构体
1. USART_InitTypeDef
// 通信的初始化一般有，模式设置，数据速度，数据格式和时钟
2. HAL_USART_StateTypeDef
状态包括了：是否初始化过，发送和接收忙，以及错误和超时
模块的虚拟化结构体USART_HandleTypeDef
typedef struct
{
USART_TypeDef *Instance; //所有模块寄存器的地址都在这里定义
USART_InitTypeDef Init; //初始化结构体
uint8_t *pTxBuffPtr; //发送的数据从哪里取
uint16_t TxXferSize; //发送数据的长度
__IO uint16_t TxXferCount; //发送数据计数
uint8_t *pRxBuffPtr; /./接收的数据从哪里取
uint16_t RxXferSize; /接收数据的长度
__IO uint16_t RxXferCount; //接收数据计数
DMA_HandleTypeDef *hdmatx; //发送数据的DMA模块
DMA_HandleTypeDef *hdmarx; //接收数据的DMA模块
HAL_LockTypeDef Lock; //模块锁存，在进行初始化的时候不再使用
__IO HAL_USART_StateTypeDef State; //通信状态，在上面的枚举体中
__IO uint32_t ErrorCode; //错误码
}USART_HandleTypeDef;
定义数据结构体要用的模块常量
其中错误码，标志，中断和标志，时钟使能这五个常量大部分的模块都会有，其他为特殊功能性的。
// 1. 错误码：
//2. 数据长度：
// 3. 停止位
//4. 校验
//5. 模式：
//6. 时钟使能：
//7. 极性
//8. 相位
//9. 停止位
//10. 响应
//11. 标志位
//12. 中断
定义一些简单的宏定义函数
__HAL_USART_RESET_HANDLE_STATE //复位USART模块
__HAL_USART_GET_FLAG //获取标志
__HAL_USART_CLEAR_FLAG //清标志位
__HAL_USART_CLEAR_PEFLAG //清模块挂起
__HAL_USART_CLEAR_FEFLAG//FE //清快速使能标志
__HAL_USART_CLEAR_NEFLAG //清互补输出
__HAL_USART_CLEAR_OREFLAG//清OVER溢出
//中断相关函数
__HAL_USART_ENABLE_IT // 中断使能
__HAL_USART_DISABLE_IT //中断去使能
__HAL_USART_GET_IT_SOURCE
__HAL_USART_ONE_BIT_SAMPLE_ENABLE //一位采样模式使能和失能
__HAL_USART_ENABLE //UART模块使能和失能
初始化和去初始化的函数
HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
void HAL_USART_MspInit(USART_HandleTypeDef *husart);
void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
其中MspInit是用于HAL_USART_Init的调用，其中此函数为weak函数，如果需要进行修改，我们也可以自己定义。
模块的IO功能函数组
//发送和接收
HAL_USART_Transmit //发送
HAL_USART_Receive //接收
HAL_USART_TransmitReceive // 全双工下的数据通信
//中断
HAL_USART_Transmit_IT //发送中断
HAL_USART_Receive_IT // 接收中断
HAL_USART_TransmitReceive_IT //收发中断
//DMA相关
HAL_USART_Transmit_DMA
HAL_USART_Receive_DMA
HAL_USART_TransmitReceive_DMA //
HAL_USART_DMAPause //暂停
HAL_USART_DMAResume //重启
HAL_USART_DMAStop //停止
//终止函数
HAL_USART_Abort
HAL_USART_Abort_IT //终止和终止中断
//中断和回调函数，回调函数全是弱定义“ __weak”
HAL_USART_IRQHandler //中断入口
HAL_USART_TxCpltCallback //发送完成回调
HAL_USART_TxHalfCpltCallback //发送一半
HAL_USART_RxCpltCallback //
HAL_USART_RxHalfCpltCallback
HAL_USART_TxRxCpltCallback //双工发送接收完成
HAL_USART_ErrorCallback //错误
HAL_USART_AbortCpltCallback //终止
//获取状态和错误状态标识
HAL_USART_GetState
HAL_USART_GetError
私有类型，私有变量和私有常量
这个是上面的IO函数要用到的私有参数，可以不关注
// Private types
//Private variables
// Private constants