stm32g4xx_hal_uart.c

跳转到本文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_uart.c
  * @author  MCD 应用团队
  * @brief   UART HAL 模块驱动程序。
  *          本文件提供固件函数，用于管理通用异步收发器（UART）外设的以下功能：
  *           + 初始化和反初始化函数
  *           + IO 操作函数
  *           + 外设控制函数
  *
  *
  ******************************************************************************
  * @attention
  *
  * 版权所有 (c) 2019 STMicroelectronics。
  * 保留所有权利。
  *
  * 本软件根据可在本软件组件根目录的 LICENSE 文件中找到的条款进行许可。
  * 如果没有随附的 LICENSE 文件，则按“原样”提供。
  *
  ******************************************************************************
  @verbatim
 ===============================================================================
                        ##### 如何使用本驱动程序 #####
 ===============================================================================
  [..]
     UART HAL 驱动程序使用方法如下：

     (#) 声明一个 UART_HandleTypeDef 句柄结构（例如 UART_HandleTypeDef huart）。
     (#) 通过实现 HAL_UART_MspInit() API 初始化 UART 低层资源：
         (++) 启用 USARTx 接口时钟。
         (++) UART 引脚配置：
             (+++) 启用 UART GPIO 的时钟。
             (+++) 将这些 UART 引脚配置为复用功能上拉。
         (++) 如果需要使用中断过程（HAL_UART_Transmit_IT() 和 HAL_UART_Receive_IT() API），则配置 NVIC：
             (+++) 配置 USARTx 中断优先级。
             (+++) 启用 NVIC USART IRQ 句柄。
         (++) UART 中断处理：
               -@@-  特定的 UART 中断（发送完成中断、RXNE 中断、RX/TX FIFO 相关中断和错误中断）
                 通过宏 __HAL_UART_ENABLE_IT() 和 __HAL_UART_DISABLE_IT() 在发送和接收过程中进行管理。
         (++) 如果需要使用 DMA 过程（HAL_UART_Transmit_DMA() 和 HAL_UART_Receive_DMA() API），则配置 DMA：
             (+++) 为 Tx/Rx 通道声明一个 DMA 句柄结构。
             (+++) 启用 DMAx 接口时钟。
             (+++) 使用所需的 Tx/Rx 参数配置声明的 DMA 句柄结构。
             (+++) 配置 DMA Tx/Rx 通道。
             (+++) 将初始化后的 DMA 句柄与 UART DMA Tx/Rx 句柄关联。
             (+++) 配置优先级并启用 NVIC，用于 DMA Tx/Rx 通道的传输完成中断。

     (#) 在 huart 句柄的 Init 结构中编程波特率、字长、停止位、奇偶校验、预分频器值、硬件流控制和模式（接收器/发送器）。

     (#) 如果需要，在 huart 句柄的 AdvancedInit 结构中编程 UART 高级功能（TX/RX 引脚交换、自动波特率检测等）。

     (#) 对于 UART 异步模式，通过调用 HAL_UART_Init() API 初始化 UART 寄存器。

     (#) 对于 UART 半双工模式，通过调用 HAL_HalfDuplex_Init() API 初始化 UART 寄存器。

     (#) 对于 UART LIN（本地互连网络）模式，通过调用 HAL_LIN_Init() API 初始化 UART 寄存器。

     (#) 对于 UART 多处理器模式，通过调用 HAL_MultiProcessor_Init() API 初始化 UART 寄存器。

     (#) 对于 UART RS485 驱动器使能模式，通过调用 HAL_RS485Ex_Init() API 初始化 UART 寄存器。

     [..]
     (@) 这些 API（HAL_UART_Init()、HAL_HalfDuplex_Init()、HAL_LIN_Init()、HAL_MultiProcessor_Init()、
         也通过调用定制的 HAL_UART_MspInit() API 来配置低层硬件 GPIO、时钟、CORTEX 等。

     ##### 回调注册 #####
     ==================================

     [..]
     编译定义 USE_HAL_UART_REGISTER_CALLBACKS 设置为 1 时，允许用户动态配置驱动程序回调。

     [..]
     使用函数 HAL_UART_RegisterCallback() 注册用户回调。
     函数 HAL_UART_RegisterCallback() 允许注册以下回调：
     (+) TxHalfCpltCallback        : 发送半完成回调。
     (+) TxCpltCallback            : 发送完成回调。
     (+) RxHalfCpltCallback        : 接收半完成回调。
     (+) RxCpltCallback            : 接收完成回调。
     (+) ErrorCallback             : 错误回调。
     (+) AbortCpltCallback         : 中止完成回调。
     (+) AbortTransmitCpltCallback : 中止发送完成回调。
     (+) AbortReceiveCpltCallback  : 中止接收完成回调。
     (+) WakeupCallback            : 唤醒回调。
     (+) RxFifoFullCallback        : 接收 FIFO 满回调。
     (+) TxFifoEmptyCallback       : 发送 FIFO 空回调。
     (+) MspInitCallback           : UART MspInit。
     (+) MspDeInitCallback         : UART MspDeInit。
     此函数接受 HAL 外设句柄、回调 ID 和指向用户回调函数的指针作为参数。

     [..]
     使用函数 HAL_UART_UnRegisterCallback() 将回调重置为默认弱函数。
     HAL_UART_UnRegisterCallback() 接受 HAL 外设句柄和回调 ID 作为参数。
     此函数允许重置以下回调：
     (+) TxHalfCpltCallback        : 发送半完成回调。
     (+) TxCpltCallback            : 发送完成回调。
     (+) RxHalfCpltCallback        : 接收半完成回调。
     (+) RxCpltCallback            : 接收完成回调。
     (+) ErrorCallback             : 错误回调。
     (+) AbortCpltCallback         : 中止完成回调。
     (+) AbortTransmitCpltCallback : 中止发送完成回调。
     (+) AbortReceiveCpltCallback  : 中止接收完成回调。
     (+) WakeupCallback            : 唤醒回调。
     (+) RxFifoFullCallback        : 接收 FIFO 满回调。
     (+) TxFifoEmptyCallback       : 发送 FIFO 空回调。
     (+) MspInitCallback           : UART MspInit。
     (+) MspDeInitCallback         : UART MspDeInit。

     [..]
     对于特定的回调 RxEventCallback，使用专用的注册/重置函数：
     分别为 HAL_UART_RegisterRxEventCallback()、HAL_UART_UnRegisterRxEventCallback()。

     [..]
     默认情况下，在 HAL_UART_Init() 之后且状态为 HAL_UART_STATE_RESET 时，
     所有回调都设置为相应的弱函数：
     例如 HAL_UART_TxCpltCallback()、HAL_UART_RxHalfCpltCallback()。
     对于 MspInit 和 MspDeInit 函数，当这些回调为空（未提前注册）时，
     它们分别在 HAL_UART_Init() 和 HAL_UART_DeInit() 中重置为旧的弱函数。
     否则，如果 MspInit 或 MspDeInit 不为空，则 HAL_UART_Init() 和 HAL_UART_DeInit()
     保留并使用用户 MspInit/MspDeInit 回调（提前注册的）。

     [..]
     回调只能在 HAL_UART_STATE_READY 状态下注册/注销。
     MspInit/MspDeInit 例外，可以在 HAL_UART_STATE_READY 或 HAL_UART_STATE_RESET 状态下注册/注销，
     因此注册的（用户）MspInit/DeInit 回调可以在 Init/DeInit 期间使用。
     在这种情况下，首先使用 HAL_UART_RegisterCallback() 注册 MspInit/MspDeInit 用户回调，
     然后再调用 HAL_UART_DeInit() 或 HAL_UART_Init() 函数。

     [..]
     当编译定义 USE_HAL_UART_REGISTER_CALLBACKS 设置为 0 或未定义时，
     回调注册功能不可用，并使用弱回调。


  @endverbatim
  ******************************************************************************
  */

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup UART UART
  * @brief HAL UART 模块驱动程序
  * @{
  */

#ifdef HAL_UART_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup UART_Private_Constants UART 私有常量
  * @{
  */
#define USART_CR1_FIELDS  ((uint32_t)(USART_CR1_M | USART_CR1_PCE | USART_CR1_PS | USART_CR1_TE | USART_CR1_RE | \
                                      USART_CR1_OVER8 | USART_CR1_FIFOEN)) /*!< 由 UART_SetConfig API 设置的 UART 或 USART CR1 参数字段 */

#define USART_CR3_FIELDS  ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE | USART_CR3_ONEBIT | USART_CR3_TXFTCFG | \
                                      USART_CR3_RXFTCFG)) /*!< 由 UART_SetConfig API 设置的 UART 或 USART CR3 参数字段 */

#define LPUART_BRR_MIN  0x00000300U  /* LPUART BRR 最小允许值 */
#define LPUART_BRR_MAX  0x000FFFFFU  /* LPUART BRR 最大允许值 */

#define UART_BRR_MIN    0x10U        /* UART BRR 最小允许值 */
#define UART_BRR_MAX    0x0000FFFFU  /* UART BRR 最大允许值 */
/**
  * @}
  */

/* Private macros ------------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @addtogroup UART_Private_Functions
  * @{
  */
static void UART_EndRxTransfer(UART_HandleTypeDef *huart);
static void UART_EndTxTransfer(UART_HandleTypeDef *huart);
static void UART_DMATransmitCplt(DMA_HandleTypeDef *hdma);
static void UART_DMAReceiveCplt(DMA_HandleTypeDef *hdma);
static void UART_DMARxHalfCplt(DMA_HandleTypeDef *hdma);
static void UART_DMATxHalfCplt(DMA_HandleTypeDef *hdma);
static void UART_DMAError(DMA_HandleTypeDef *hdma);
static void