stm32g4xx_hal_usart_ex.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_usart_ex.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_EX_H
#define STM32G4xx_HAL_USART_EX_H

#ifdef __cplusplus
extern "C" {
#endif

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

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup USARTEx
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup USARTEx_Exported_Constants USARTEx 导出常量
  * @{
  */

/** @defgroup USARTEx_Word_Length USARTEx 字长
  * @{
  */
#define USART_WORDLENGTH_7B                  (USART_CR1_M1)   /*!< 7位长的USART帧 */
#define USART_WORDLENGTH_8B                  (0x00000000U)    /*!< 8位长的USART帧 */
#define USART_WORDLENGTH_9B                  (USART_CR1_M0)   /*!< 9位长的USART帧 */
/**
  * @}
  */

/** @defgroup USARTEx_Slave_Select_management USARTEx 从机选择管理
  * @{
  */
#define USART_NSS_HARD                        0x00000000U          /*!< SPI从机选择取决于NSS输入引脚              */
#define USART_NSS_SOFT                        USART_CR2_DIS_NSS    /*!< SPI从机始终被选中，忽略NSS输入引脚 */
/**
  * @}
  */


/** @defgroup USARTEx_Slave_Mode USARTEx 同步从机模式使能
  * @brief    USART 从机模式
  * @{
  */
#define USART_SLAVEMODE_DISABLE   0x00000000U     /*!< USART SPI从机模式使能  */
#define USART_SLAVEMODE_ENABLE    USART_CR2_SLVEN /*!< USART SPI从机模式禁用 */
/**
  * @}
  */

/** @defgroup USARTEx_FIFO_mode USARTEx FIFO 模式
  * @brief    USART FIFO 模式
  * @{
  */
#define USART_FIFOMODE_DISABLE        0x00000000U                   /*!< FIFO模式禁用 */
#define USART_FIFOMODE_ENABLE         USART_CR1_FIFOEN              /*!< FIFO模式使能  */
/**
  * @}
  */

/** @defgroup USARTEx_TXFIFO_threshold_level USARTEx TXFIFO 阈值级别
  * @brief    USART TXFIFO 级别
  * @{
  */
#define USART_TXFIFO_THRESHOLD_1_8   0x00000000U                               /*!< TXFIFO达到其深度的1/8 */
#define USART_TXFIFO_THRESHOLD_1_4   USART_CR3_TXFTCFG_0                       /*!< TXFIFO达到其深度的1/4 */
#define USART_TXFIFO_THRESHOLD_1_2   USART_CR3_TXFTCFG_1                       /*!< TXFIFO达到其深度的1/2 */
#define USART_TXFIFO_THRESHOLD_3_4   (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TXFIFO达到其深度的3/4 */
#define USART_TXFIFO_THRESHOLD_7_8   USART_CR3_TXFTCFG_2                       /*!< TXFIFO达到其深度的7/8 */
#define USART_TXFIFO_THRESHOLD_8_8   (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TXFIFO变为空            */
/**
  * @}
  */

/** @defgroup USARTEx_RXFIFO_threshold_level USARTEx RXFIFO 阈值级别
  * @brief    USART RXFIFO 级别
  * @{
  */
#define USART_RXFIFO_THRESHOLD_1_8   0x00000000U                               /*!< RXFIFO达到其深度的1/8 */
#define USART_RXFIFO_THRESHOLD_1_4   USART_CR3_RXFTCFG_0                       /*!< RXFIFO达到其深度的1/4 */
#define USART_RXFIFO_THRESHOLD_1_2   USART_CR3_RXFTCFG_1                       /*!< RXFIFO达到其深度的1/2 */
#define USART_RXFIFO_THRESHOLD_3_4   (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RXFIFO达到其深度的3/4 */
#define USART_RXFIFO_THRESHOLD_7_8   USART_CR3_RXFTCFG_2                       /*!< RXFIFO达到其深度的7/8 */
#define USART_RXFIFO_THRESHOLD_8_8   (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RXFIFO变满             */
/**
  * @}
  */

/**
  * @}
  */

/* Private macros ------------------------------------------------------------*/
/** @defgroup USARTEx_Private_Macros USARTEx 私有宏
  * @{
  */

/** @brief  计算用于检索接收数据的USART掩码
  *         根据字长和奇偶校验位激活情况。
  * @note   如果 PCE = 1，奇偶校验位不包含在接收API()提取的数据中。
  *         在DMA传输的情况下不执行此掩码操作。
  * @param  __HANDLE__ 指定USART句柄。
  * @retval 无，应用于USART RDR寄存器的掩码存储在(__HANDLE__)->Mask字段中。
  */
#define USART_MASK_COMPUTATION(__HANDLE__)                            \
  do {                                                                \
    if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B)         \
    {                                                                 \
      if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
      {                                                               \
        (__HANDLE__)->Mask = 0x01FFU;                                 \
      }                                                               \
      else                                                            \
      {                                                               \
        (__HANDLE__)->Mask = 0x00FFU;                                 \
      }                                                               \
    }                                                                 \
    else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B)    \
    {                                                                 \
      if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
      {                                                               \
        (__HANDLE__)->Mask = 0x00FFU;                                 \
      }                                                               \
      else                                                            \
      {                                                               \
        (__HANDLE__)->Mask = 0x007FU;                                 \
      }                                                               \
    }                                                                 \
    else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B)    \
    {                                                                 \
      if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
      {                                                               \
        (__HANDLE__)->Mask = 0x007FU;                                 \
      }                                                               \
      else                                                            \