stm32g4xx_hal_irda.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_irda.h
  * @author  MCD Application Team
  * @brief   IRDA 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_IRDA_H
#define STM32G4xx_HAL_IRDA_H

#ifdef __cplusplus
extern "C" {
#endif

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

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup IRDA
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup IRDA_Exported_Types IRDA导出的类型
  * @{
  */

/**
  * @brief IRDA初始化结构体定义
  */
typedef struct
{
  uint32_t BaudRate;                  /*!< 此成员配置IRDA通信波特率。
                                           波特率寄存器使用以下公式计算：
                                              波特率寄存器 = ((usart_ker_ckpres) / ((hirda->Init.BaudRate)))
                                           其中usart_ker_ckpres是IRDA输入时钟除以预分频器后的值 */

  uint32_t WordLength;                /*!< 指定帧中发送或接收的数据位数。
                                           此参数可以是@ref IRDAEx_Word_Length的值 */

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

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

  uint8_t  Prescaler;                 /*!< 指定分频器值，用于分频UART/USART源时钟
                                           以实现低功耗频率。
                                           @note 禁止使用预分频器值0 */

  uint16_t PowerMode;                 /*!< 指定IRDA电源模式。
                                           此参数可以是@ref IRDA_Low_Power的值 */

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

} IRDA_InitTypeDef;

/**
  * @brief HAL IRDA状态定义
  * @note  HAL IRDA状态值是2个不同子状态的组合：
  *        gState和RxState（参见@ref IRDA_State_Definition）。
  *        - gState包含与全局句柄管理相关的IRDA状态信息
  *          以及与Tx操作相关的信息。
  *          gState值编码遵循以下描述的位图：
  *          b7-b6  错误信息
  *             00 : 无错误
  *             01 : (未使用)
  *             10 : 超时
  *             11 : 错误
  *          b5     外设初始化状态
  *             0  : 复位（外设未初始化）
  *             1  : 初始化完成（外设已初始化。HAL IRDA初始化函数已调用）
  *          b4-b3  (未使用)
  *             xx : 应设置为00
  *          b2     固有进程状态
  *             0  : 就绪
  *             1  : 忙（外设正忙于某些配置或内部操作）
  *          b1     (未使用)
  *             x  : 应设置为0
  *          b0     Tx状态
  *             0  : 就绪（无Tx操作正在进行）
  *             1  : 忙（Tx操作正在进行）
  *        - RxState包含与Rx操作相关的信息。
  *          RxState值编码遵循以下描述的位图：
  *          b7-b6  (未使用)
  *             xx : 应设置为00
  *          b5     外设初始化状态
  *             0  : 复位（外设未初始化）
  *             1  : 初始化完成（外设已初始化）
  *          b4-b2  (未使用)
  *            xxx : 应设置为000
  *          b1     Rx状态
  *             0  : 就绪（无Rx操作正在进行）
  *             1  : 忙（Rx操作正在进行）
  *          b0     (未使用)
  *             x  : 应设置为0。
  */
typedef uint32_t HAL_IRDA_StateTypeDef;

/**
  * @brief IRDA时钟源定义
  */
typedef enum
{
  IRDA_CLOCKSOURCE_PCLK1      = 0x00U,    /*!< PCLK1时钟源         */
  IRDA_CLOCKSOURCE_PCLK2      = 0x01U,    /*!< PCLK2时钟源         */
  IRDA_CLOCKSOURCE_HSI        = 0x02U,    /*!< HSI时钟源           */
  IRDA_CLOCKSOURCE_SYSCLK     = 0x04U,    /*!< SYSCLK时钟源        */
  IRDA_CLOCKSOURCE_LSE        = 0x10U,    /*!< LSE时钟源           */
  IRDA_CLOCKSOURCE_UNDEFINED  = 0x20U     /*!< 未定义的时钟源     */
} IRDA_ClockSourceTypeDef;

/**
  * @brief  IRDA句柄结构体定义
  */
#if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
typedef struct __IRDA_HandleTypeDef
#else
typedef struct
#endif  /* USE_HAL_IRDA_REGISTER_CALLBACKS */
{
  USART_TypeDef            *Instance;        /*!< USART寄存器基地址       */

  IRDA_InitTypeDef         Init;             /*!< IRDA通信参数      */

  const uint8_t            *pTxBuffPtr;      /*!< IRDA Tx传输缓冲区指针 */

  uint16_t                 TxXferSize;       /*!< IRDA Tx传输大小              */

  __IO uint16_t            TxXferCount;      /*!< IRDA Tx传输计数器           */

  uint8_t                  *pRxBuffPtr;      /*!< IRDA Rx传输缓冲区指针 */

  uint16_t                 RxXferSize;       /*!< IRDA Rx传输大小              */

  __IO uint16_t            RxXferCount;      /*!< IRDA Rx传输计数器           */

  uint16_t                 Mask;             /*!< USART RX RDR寄存器掩码         */

  DMA_HandleTypeDef        *