stm32g4xx_hal_usart.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_usart.h
  * @author  MCD Application Team
  * @brief   USART HAL模块的头文件。
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32G4xx_HAL_USART_H
#define STM32G4xx_HAL_USART_H

#ifdef __cplusplus
extern "C" {
#endif

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

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup USART
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup USART_Exported_Types USART 导出类型
  * @{
  */

/**
  * @brief USART 初始化结构体定义
  */
typedef struct
{
  uint32_t BaudRate;                  /*!< 此成员配置Usart通信波特率。
                                           波特率使用以下公式计算：
                                              Baud Rate Register[15:4] = ((2 * fclk_pres) /
                                              ((huart->Init.BaudRate)))[15:4]
                                              Baud Rate Register[3]    = 0
                                              Baud Rate Register[2:0]  =  (((2 * fclk_pres) /
                                              ((huart->Init.BaudRate)))[3:0]) >> 1
                                              其中 fclk_pres 是USART输入时钟频率 (fclk)
                                              除以一个预分频器。
                                           @note  为实现高波特率，系统性地应用了8倍过采样。 */
                                                  */

  uint32_t WordLength;                /*!< 指定在一帧中传输或接收的数据位数。
                                           此参数可以是 @ref USARTEx_Word_Length 的值。 */

  uint32_t StopBits;                  /*!< 指定传输的停止位数。
                                           此参数可以是 @ref USART_Stop_Bits 的值。 */

  uint32_t Parity;                   /*!< 指定奇偶校验模式。
                                           此参数可以是 @ref USART_Parity 的值
                                           @note 当启用奇偶校验时，计算出的奇偶校验位将被插入
                                                 到传输数据的最高有效位位置（当字长设置为9位数据位时为第9位；当
                                                 字长设置为8位数据位时为第8位）。 */


  uint32_t Mode;                      /*!< 指定接收或发送模式是启用还是禁用。
                                           此参数可以是 @ref USART_Mode 的值。 */

  uint32_t CLKPolarity;               /*!< 指定串行时钟的稳态。
                                           此参数可以是 @ref USART_Clock_Polarity 的值。 */

  uint32_t CLKPhase;                  /*!< 指定进行位捕获的时钟沿。
                                           此参数可以是 @ref USART_Clock_Phase 的值。 */

  uint32_t CLKLastBit;                /*!< 指定在同步模式下，对应于最后一个传输数据位（MSB）的时钟脉冲
                                           是否必须在SCLK引脚上输出。
                                           此参数可以是 @ref USART_Last_Bit 的值。 */

  uint32_t ClockPrescaler;            /*!< 指定用于分频USART时钟源的预分频器值。
                                           此参数可以是 @ref USART_ClockPrescaler 的值。 */
} USART_InitTypeDef;

/**
  * @brief HAL USART 状态结构体定义
  */
typedef enum
{
  HAL_USART_STATE_RESET             = 0x00U,    /*!< 外设未初始化                  */
  HAL_USART_STATE_READY             = 0x01U,    /*!< 外设已初始化并准备就绪       */
  HAL_USART_STATE_BUSY              = 0x02U,    /*!< 内部进程正在进行                 */
  HAL_USART_STATE_BUSY_TX           = 0x12U,    /*!< 数据传输进程正在进行           */
  HAL_USART_STATE_BUSY_RX           = 0x22U,    /*!< 数据接收进程正在进行              */
  HAL_USART_STATE_BUSY_TX_RX        = 0x32U,    /*!< 数据传输接收进程正在进行 */
  HAL_USART_STATE_TIMEOUT           = 0x03U,    /*!< 超时状态                                  */
  HAL_USART_STATE_ERROR             = 0x04U     /*!< 错误                                          */
} HAL_USART_StateTypeDef;

/**
  * @brief  USART 时钟源定义
  */
typedef enum
{
  USART_CLOCKSOURCE_PCLK1      = 0x00U,    /*!< PCLK1 时钟源     */
  USART_CLOCKSOURCE_PCLK2      = 0x01U,    /*!< PCLK2 时钟源     */
  USART_CLOCKSOURCE_HSI        = 0x02U,    /*!< HSI 时钟源       */
  USART_CLOCKSOURCE_SYSCLK     = 0x04U,    /*!< SYSCLK 时钟源    */
  USART_CLOCKSOURCE_LSE        = 0x08U,    /*!< LSE 时钟源       */
  USART_CLOCKSOURCE_UNDEFINED  = 0x10U     /*!< 未定义的时钟源 */
}