STM32H735xx HAL User Manual
stm32h7xx_hal_irda.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32h7xx_hal_irda.h
00004   * @author  MCD Application Team
00005   * @brief   Header file of IRDA HAL module.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * Copyright (c) 2017 STMicroelectronics.
00010   * All rights reserved.
00011   *
00012   * This software is licensed under terms that can be found in the LICENSE file
00013   * in the root directory of this software component.
00014   * If no LICENSE file comes with this software, it is provided AS-IS.
00015   *
00016   ******************************************************************************
00017   */
00018 
00019 /* Define to prevent recursive inclusion -------------------------------------*/
00020 #ifndef STM32H7xx_HAL_IRDA_H
00021 #define STM32H7xx_HAL_IRDA_H
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /* Includes ------------------------------------------------------------------*/
00028 #include "stm32h7xx_hal_def.h"
00029 
00030 /** @addtogroup STM32H7xx_HAL_Driver
00031   * @{
00032   */
00033 
00034 /** @addtogroup IRDA
00035   * @{
00036   */
00037 
00038 /* Exported types ------------------------------------------------------------*/
00039 /** @defgroup IRDA_Exported_Types IRDA Exported Types
00040   * @{
00041   */
00042 
00043 /**
00044   * @brief IRDA Init Structure definition
00045   */
00046 typedef struct
00047 {
00048   uint32_t BaudRate;                  /*!< This member configures the IRDA communication baud rate.
00049                                            The baud rate register is computed using the following formula:
00050                                               Baud Rate Register = ((usart_ker_ckpres) / ((hirda->Init.BaudRate)))
00051                                            where usart_ker_ckpres is the IRDA input clock divided by a prescaler */
00052 
00053   uint32_t WordLength;                /*!< Specifies the number of data bits transmitted or received in a frame.
00054                                            This parameter can be a value of @ref IRDAEx_Word_Length */
00055 
00056   uint32_t Parity;                    /*!< Specifies the parity mode.
00057                                            This parameter can be a value of @ref IRDA_Parity
00058                                            @note When parity is enabled, the computed parity is inserted
00059                                                  at the MSB position of the transmitted data (9th bit when
00060                                                  the word length is set to 9 data bits; 8th bit when the
00061                                                  word length is set to 8 data bits). */
00062 
00063   uint32_t Mode;                      /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
00064                                            This parameter can be a value of @ref IRDA_Transfer_Mode */
00065 
00066   uint8_t  Prescaler;                 /*!< Specifies the Prescaler value for dividing the UART/USART source clock
00067                                            to achieve low-power frequency.
00068                                            @note Prescaler value 0 is forbidden */
00069 
00070   uint16_t PowerMode;                 /*!< Specifies the IRDA power mode.
00071                                            This parameter can be a value of @ref IRDA_Low_Power */
00072 
00073   uint32_t ClockPrescaler;            /*!< Specifies the prescaler value used to divide the IRDA clock source.
00074                                            This parameter can be a value of @ref IRDA_ClockPrescaler. */
00075 
00076 } IRDA_InitTypeDef;
00077 
00078 /**
00079   * @brief HAL IRDA State definition
00080   * @note  HAL IRDA State value is a combination of 2 different substates:
00081   *        gState and RxState (see @ref IRDA_State_Definition).
00082   *        - gState contains IRDA state information related to global Handle management
00083   *          and also information related to Tx operations.
00084   *          gState value coding follow below described bitmap :
00085   *          b7-b6  Error information
00086   *             00 : No Error
00087   *             01 : (Not Used)
00088   *             10 : Timeout
00089   *             11 : Error
00090   *          b5     Peripheral initialization status
00091   *             0  : Reset (Peripheral not initialized)
00092   *             1  : Init done (Peripheral initialized. HAL IRDA Init function already called)
00093   *          b4-b3  (not used)
00094   *             xx : Should be set to 00
00095   *          b2     Intrinsic process state
00096   *             0  : Ready
00097   *             1  : Busy (Peripheral busy with some configuration or internal operations)
00098   *          b1     (not used)
00099   *             x  : Should be set to 0
00100   *          b0     Tx state
00101   *             0  : Ready (no Tx operation ongoing)
00102   *             1  : Busy (Tx operation ongoing)
00103   *        - RxState contains information related to Rx operations.
00104   *          RxState value coding follow below described bitmap :
00105   *          b7-b6  (not used)
00106   *             xx : Should be set to 00
00107   *          b5     Peripheral initialization status
00108   *             0  : Reset (Peripheral not initialized)
00109   *             1  : Init done (Peripheral initialized)
00110   *          b4-b2  (not used)
00111   *            xxx : Should be set to 000
00112   *          b1     Rx state
00113   *             0  : Ready (no Rx operation ongoing)
00114   *             1  : Busy (Rx operation ongoing)
00115   *          b0     (not used)
00116   *             x  : Should be set to 0.
00117   */
00118 typedef uint32_t HAL_IRDA_StateTypeDef;
00119 
00120 /**
00121   * @brief IRDA clock sources definition
00122   */
00123 typedef enum
00124 {
00125   IRDA_CLOCKSOURCE_D2PCLK1    = 0x11U,    /*!< Domain2 PCLK1 clock source */
00126   IRDA_CLOCKSOURCE_D2PCLK2    = 0x12U,    /*!< Domain2 PCLK2 clock source */
00127   IRDA_CLOCKSOURCE_PLL2Q      = 0x14U,    /*!< PLL2Q clock source         */
00128   IRDA_CLOCKSOURCE_PLL3Q      = 0x18U,    /*!< PLL3Q clock source         */
00129   IRDA_CLOCKSOURCE_HSI        = 0x02U,    /*!< HSI clock source           */
00130   IRDA_CLOCKSOURCE_CSI        = 0x08U,    /*!< CSI clock source           */
00131   IRDA_CLOCKSOURCE_LSE        = 0x10U,    /*!< LSE clock source           */
00132   IRDA_CLOCKSOURCE_UNDEFINED  = 0x20U     /*!< Undefined clock source     */
00133 } IRDA_ClockSourceTypeDef;
00134 
00135 /**
00136   * @brief  IRDA handle Structure definition
00137   */
00138 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00139 typedef struct __IRDA_HandleTypeDef
00140 #else
00141 typedef struct
00142 #endif  /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00143 {
00144   USART_TypeDef            *Instance;        /*!< USART registers base address       */
00145 
00146   IRDA_InitTypeDef         Init;             /*!< IRDA communication parameters      */
00147 
00148   const uint8_t            *pTxBuffPtr;      /*!< Pointer to IRDA Tx transfer Buffer */
00149 
00150   uint16_t                 TxXferSize;       /*!< IRDA Tx Transfer size              */
00151 
00152   __IO uint16_t            TxXferCount;      /*!< IRDA Tx Transfer Counter           */
00153 
00154   uint8_t                  *pRxBuffPtr;      /*!< Pointer to IRDA Rx transfer Buffer */
00155 
00156   uint16_t                 RxXferSize;       /*!< IRDA Rx Transfer size              */
00157 
00158   __IO uint16_t            RxXferCount;      /*!< IRDA Rx Transfer Counter           */
00159 
00160   uint16_t                 Mask;             /*!< USART RX RDR register mask         */
00161 
00162   DMA_HandleTypeDef        *hdmatx;          /*!< IRDA Tx DMA Handle parameters      */
00163 
00164   DMA_HandleTypeDef        *hdmarx;          /*!< IRDA Rx DMA Handle parameters      */
00165 
00166   HAL_LockTypeDef          Lock;             /*!< Locking object                     */
00167 
00168   __IO HAL_IRDA_StateTypeDef    gState;      /*!< IRDA state information related to global Handle management
00169                                                   and also related to Tx operations.
00170                                                   This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
00171 
00172   __IO HAL_IRDA_StateTypeDef    RxState;     /*!< IRDA state information related to Rx operations.
00173                                                   This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
00174 
00175   __IO uint32_t            ErrorCode;        /*!< IRDA Error code                    */
00176 
00177 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00178   void (* TxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda);        /*!< IRDA Tx Half Complete Callback        */
00179 
00180   void (* TxCpltCallback)(struct __IRDA_HandleTypeDef *hirda);            /*!< IRDA Tx Complete Callback             */
00181 
00182   void (* RxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda);        /*!< IRDA Rx Half Complete Callback        */
00183 
00184   void (* RxCpltCallback)(struct __IRDA_HandleTypeDef *hirda);            /*!< IRDA Rx Complete Callback             */
00185 
00186   void (* ErrorCallback)(struct __IRDA_HandleTypeDef *hirda);             /*!< IRDA Error Callback                   */
00187 
00188   void (* AbortCpltCallback)(struct __IRDA_HandleTypeDef *hirda);         /*!< IRDA Abort Complete Callback          */
00189 
00190   void (* AbortTransmitCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Transmit Complete Callback */
00191 
00192   void (* AbortReceiveCpltCallback)(struct __IRDA_HandleTypeDef *hirda);  /*!< IRDA Abort Receive Complete Callback  */
00193 
00194 
00195   void (* MspInitCallback)(struct __IRDA_HandleTypeDef *hirda);           /*!< IRDA Msp Init callback                */
00196 
00197   void (* MspDeInitCallback)(struct __IRDA_HandleTypeDef *hirda);         /*!< IRDA Msp DeInit callback              */
00198 #endif  /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00199 
00200 } IRDA_HandleTypeDef;
00201 
00202 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00203 /**
00204   * @brief  HAL IRDA Callback ID enumeration definition
00205   */
00206 typedef enum
00207 {
00208   HAL_IRDA_TX_HALFCOMPLETE_CB_ID         = 0x00U,    /*!< IRDA Tx Half Complete Callback ID        */
00209   HAL_IRDA_TX_COMPLETE_CB_ID             = 0x01U,    /*!< IRDA Tx Complete Callback ID             */
00210   HAL_IRDA_RX_HALFCOMPLETE_CB_ID         = 0x02U,    /*!< IRDA Rx Half Complete Callback ID        */
00211   HAL_IRDA_RX_COMPLETE_CB_ID             = 0x03U,    /*!< IRDA Rx Complete Callback ID             */
00212   HAL_IRDA_ERROR_CB_ID                   = 0x04U,    /*!< IRDA Error Callback ID                   */
00213   HAL_IRDA_ABORT_COMPLETE_CB_ID          = 0x05U,    /*!< IRDA Abort Complete Callback ID          */
00214   HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U,    /*!< IRDA Abort Transmit Complete Callback ID */
00215   HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID  = 0x07U,    /*!< IRDA Abort Receive Complete Callback ID  */
00216 
00217   HAL_IRDA_MSPINIT_CB_ID                 = 0x08U,    /*!< IRDA MspInit callback ID                 */
00218   HAL_IRDA_MSPDEINIT_CB_ID               = 0x09U     /*!< IRDA MspDeInit callback ID               */
00219 
00220 } HAL_IRDA_CallbackIDTypeDef;
00221 
00222 /**
00223   * @brief  HAL IRDA Callback pointer definition
00224   */
00225 typedef  void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda);  /*!< pointer to an IRDA callback function */
00226 
00227 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00228 
00229 /**
00230   * @}
00231   */
00232 
00233 /* Exported constants --------------------------------------------------------*/
00234 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
00235   * @{
00236   */
00237 
00238 /** @defgroup IRDA_State_Definition IRDA State Code Definition
00239   * @{
00240   */
00241 #define HAL_IRDA_STATE_RESET                0x00000000U   /*!< Peripheral is not initialized
00242                                                                Value is allowed for gState and RxState */
00243 #define HAL_IRDA_STATE_READY                0x00000020U   /*!< Peripheral Initialized and ready for use
00244                                                                Value is allowed for gState and RxState */
00245 #define HAL_IRDA_STATE_BUSY                 0x00000024U   /*!< An internal process is ongoing
00246                                                                Value is allowed for gState only */
00247 #define HAL_IRDA_STATE_BUSY_TX              0x00000021U   /*!< Data Transmission process is ongoing
00248                                                                Value is allowed for gState only */
00249 #define HAL_IRDA_STATE_BUSY_RX              0x00000022U   /*!< Data Reception process is ongoing
00250                                                                Value is allowed for RxState only */
00251 #define HAL_IRDA_STATE_BUSY_TX_RX           0x00000023U   /*!< Data Transmission and Reception process is ongoing
00252                                                                Not to be used for neither gState nor RxState.
00253                                                                Value is result of combination (Or) between
00254                                                                gState and RxState values */
00255 #define HAL_IRDA_STATE_TIMEOUT              0x000000A0U   /*!< Timeout state
00256                                                                Value is allowed for gState only */
00257 #define HAL_IRDA_STATE_ERROR                0x000000E0U   /*!< Error
00258                                                                Value is allowed for gState only */
00259 /**
00260   * @}
00261   */
00262 
00263 /** @defgroup IRDA_Error_Definition IRDA Error Code Definition
00264   * @{
00265   */
00266 #define HAL_IRDA_ERROR_NONE                 (0x00000000U)          /*!< No error                */
00267 #define HAL_IRDA_ERROR_PE                   (0x00000001U)          /*!< Parity error            */
00268 #define HAL_IRDA_ERROR_NE                   (0x00000002U)          /*!< Noise error             */
00269 #define HAL_IRDA_ERROR_FE                   (0x00000004U)          /*!< frame error             */
00270 #define HAL_IRDA_ERROR_ORE                  (0x00000008U)          /*!< Overrun error           */
00271 #define HAL_IRDA_ERROR_DMA                  (0x00000010U)          /*!< DMA transfer error      */
00272 #define HAL_IRDA_ERROR_BUSY                 (0x00000020U)          /*!< Busy Error              */
00273 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00274 #define HAL_IRDA_ERROR_INVALID_CALLBACK     (0x00000040U)          /*!< Invalid Callback error  */
00275 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00276 /**
00277   * @}
00278   */
00279 
00280 /** @defgroup IRDA_Parity IRDA Parity
00281   * @{
00282   */
00283 #define IRDA_PARITY_NONE                    0x00000000U                      /*!< No parity   */
00284 #define IRDA_PARITY_EVEN                    USART_CR1_PCE                    /*!< Even parity */
00285 #define IRDA_PARITY_ODD                     (USART_CR1_PCE | USART_CR1_PS)   /*!< Odd parity  */
00286 /**
00287   * @}
00288   */
00289 
00290 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
00291   * @{
00292   */
00293 #define IRDA_MODE_RX                        USART_CR1_RE                   /*!< RX mode        */
00294 #define IRDA_MODE_TX                        USART_CR1_TE                   /*!< TX mode        */
00295 #define IRDA_MODE_TX_RX                     (USART_CR1_TE |USART_CR1_RE)   /*!< RX and TX mode */
00296 /**
00297   * @}
00298   */
00299 
00300 /** @defgroup IRDA_Low_Power IRDA Low Power
00301   * @{
00302   */
00303 #define IRDA_POWERMODE_NORMAL               0x00000000U       /*!< IRDA normal power mode */
00304 #define IRDA_POWERMODE_LOWPOWER             USART_CR3_IRLP    /*!< IRDA low power mode    */
00305 /**
00306   * @}
00307   */
00308 
00309 /** @defgroup IRDA_ClockPrescaler IRDA Clock Prescaler
00310   * @{
00311   */
00312 #define IRDA_PRESCALER_DIV1    0x00000000U  /*!< fclk_pres = fclk     */
00313 #define IRDA_PRESCALER_DIV2    0x00000001U  /*!< fclk_pres = fclk/2   */
00314 #define IRDA_PRESCALER_DIV4    0x00000002U  /*!< fclk_pres = fclk/4   */
00315 #define IRDA_PRESCALER_DIV6    0x00000003U  /*!< fclk_pres = fclk/6   */
00316 #define IRDA_PRESCALER_DIV8    0x00000004U  /*!< fclk_pres = fclk/8   */
00317 #define IRDA_PRESCALER_DIV10   0x00000005U  /*!< fclk_pres = fclk/10  */
00318 #define IRDA_PRESCALER_DIV12   0x00000006U  /*!< fclk_pres = fclk/12  */
00319 #define IRDA_PRESCALER_DIV16   0x00000007U  /*!< fclk_pres = fclk/16  */
00320 #define IRDA_PRESCALER_DIV32   0x00000008U  /*!< fclk_pres = fclk/32  */
00321 #define IRDA_PRESCALER_DIV64   0x00000009U  /*!< fclk_pres = fclk/64  */
00322 #define IRDA_PRESCALER_DIV128  0x0000000AU  /*!< fclk_pres = fclk/128 */
00323 #define IRDA_PRESCALER_DIV256  0x0000000BU  /*!< fclk_pres = fclk/256 */
00324 /**
00325   * @}
00326   */
00327 
00328 /** @defgroup IRDA_State IRDA State
00329   * @{
00330   */
00331 #define IRDA_STATE_DISABLE                  0x00000000U     /*!< IRDA disabled  */
00332 #define IRDA_STATE_ENABLE                   USART_CR1_UE    /*!< IRDA enabled   */
00333 /**
00334   * @}
00335   */
00336 
00337 /** @defgroup IRDA_Mode IRDA Mode
00338   * @{
00339   */
00340 #define IRDA_MODE_DISABLE                   0x00000000U      /*!< Associated UART disabled in IRDA mode */
00341 #define IRDA_MODE_ENABLE                    USART_CR3_IREN   /*!< Associated UART enabled in IRDA mode  */
00342 /**
00343   * @}
00344   */
00345 
00346 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
00347   * @{
00348   */
00349 #define IRDA_ONE_BIT_SAMPLE_DISABLE         0x00000000U       /*!< One-bit sampling disabled */
00350 #define IRDA_ONE_BIT_SAMPLE_ENABLE          USART_CR3_ONEBIT  /*!< One-bit sampling enabled  */
00351 /**
00352   * @}
00353   */
00354 
00355 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
00356   * @{
00357   */
00358 #define IRDA_DMA_TX_DISABLE                 0x00000000U       /*!< IRDA DMA TX disabled */
00359 #define IRDA_DMA_TX_ENABLE                  USART_CR3_DMAT    /*!< IRDA DMA TX enabled  */
00360 /**
00361   * @}
00362   */
00363 
00364 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
00365   * @{
00366   */
00367 #define IRDA_DMA_RX_DISABLE                 0x00000000U       /*!< IRDA DMA RX disabled */
00368 #define IRDA_DMA_RX_ENABLE                  USART_CR3_DMAR    /*!< IRDA DMA RX enabled  */
00369 /**
00370   * @}
00371   */
00372 
00373 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
00374   * @{
00375   */
00376 #define IRDA_AUTOBAUD_REQUEST            USART_RQR_ABRRQ        /*!< Auto-Baud Rate Request      */
00377 #define IRDA_RXDATA_FLUSH_REQUEST        USART_RQR_RXFRQ        /*!< Receive Data flush Request  */
00378 #define IRDA_TXDATA_FLUSH_REQUEST        USART_RQR_TXFRQ        /*!< Transmit data flush Request */
00379 /**
00380   * @}
00381   */
00382 
00383 /** @defgroup IRDA_Flags IRDA Flags
00384   *        Elements values convention: 0xXXXX
00385   *           - 0xXXXX  : Flag mask in the ISR register
00386   * @{
00387   */
00388 #define IRDA_FLAG_REACK                     USART_ISR_REACK         /*!< IRDA receive enable acknowledge flag      */
00389 #define IRDA_FLAG_TEACK                     USART_ISR_TEACK         /*!< IRDA transmit enable acknowledge flag     */
00390 #define IRDA_FLAG_BUSY                      USART_ISR_BUSY          /*!< IRDA busy flag                            */
00391 #define IRDA_FLAG_ABRF                      USART_ISR_ABRF          /*!< IRDA auto Baud rate flag                  */
00392 #define IRDA_FLAG_ABRE                      USART_ISR_ABRE          /*!< IRDA auto Baud rate error                 */
00393 #define IRDA_FLAG_TXE                       USART_ISR_TXE_TXFNF     /*!< IRDA transmit data register empty         */
00394 #define IRDA_FLAG_TC                        USART_ISR_TC            /*!< IRDA transmission complete                */
00395 #define IRDA_FLAG_RXNE                      USART_ISR_RXNE_RXFNE    /*!< IRDA read data register not empty         */
00396 #define IRDA_FLAG_ORE                       USART_ISR_ORE           /*!< IRDA overrun error                        */
00397 #define IRDA_FLAG_NE                        USART_ISR_NE            /*!< IRDA noise error                          */
00398 #define IRDA_FLAG_FE                        USART_ISR_FE            /*!< IRDA frame error                          */
00399 #define IRDA_FLAG_PE                        USART_ISR_PE            /*!< IRDA parity error                         */
00400 /**
00401   * @}
00402   */
00403 
00404 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
00405   *        Elements values convention: 0000ZZZZ0XXYYYYYb
00406   *           - YYYYY  : Interrupt source position in the XX register (5bits)
00407   *           - XX  : Interrupt source register (2bits)
00408   *                 - 01: CR1 register
00409   *                 - 10: CR2 register
00410   *                 - 11: CR3 register
00411   *           - ZZZZ  : Flag position in the ISR register(4bits)
00412   * @{
00413   */
00414 #define IRDA_IT_PE                          0x0028U     /*!< IRDA Parity error interruption                 */
00415 #define IRDA_IT_TXE                         0x0727U     /*!< IRDA Transmit data register empty interruption */
00416 #define IRDA_IT_TC                          0x0626U     /*!< IRDA Transmission complete interruption        */
00417 #define IRDA_IT_RXNE                        0x0525U     /*!< IRDA Read data register not empty interruption */
00418 #define IRDA_IT_IDLE                        0x0424U     /*!< IRDA Idle interruption                         */
00419 
00420 /*       Elements values convention: 000000000XXYYYYYb
00421              - YYYYY  : Interrupt source position in the XX register (5bits)
00422              - XX  : Interrupt source register (2bits)
00423                    - 01: CR1 register
00424                    - 10: CR2 register
00425                    - 11: CR3 register */
00426 #define IRDA_IT_ERR                         0x0060U       /*!< IRDA Error interruption        */
00427 
00428 /*       Elements values convention: 0000ZZZZ00000000b
00429              - ZZZZ  : Flag position in the ISR register(4bits) */
00430 #define IRDA_IT_ORE                         0x0300U      /*!< IRDA Overrun error interruption */
00431 #define IRDA_IT_NE                          0x0200U      /*!< IRDA Noise error interruption   */
00432 #define IRDA_IT_FE                          0x0100U      /*!< IRDA Frame error interruption   */
00433 /**
00434   * @}
00435   */
00436 
00437 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
00438   * @{
00439   */
00440 #define IRDA_CLEAR_PEF                       USART_ICR_PECF            /*!< Parity Error Clear Flag          */
00441 #define IRDA_CLEAR_FEF                       USART_ICR_FECF            /*!< Framing Error Clear Flag         */
00442 #define IRDA_CLEAR_NEF                       USART_ICR_NECF            /*!< Noise Error detected Clear Flag  */
00443 #define IRDA_CLEAR_OREF                      USART_ICR_ORECF           /*!< OverRun Error Clear Flag         */
00444 #define IRDA_CLEAR_IDLEF                     USART_ICR_IDLECF          /*!< IDLE line detected Clear Flag    */
00445 #define IRDA_CLEAR_TCF                       USART_ICR_TCCF            /*!< Transmission Complete Clear Flag */
00446 /**
00447   * @}
00448   */
00449 
00450 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
00451   * @{
00452   */
00453 #define IRDA_IT_MASK  0x001FU  /*!< IRDA Interruptions flags mask  */
00454 #define IRDA_CR_MASK  0x00E0U  /*!< IRDA control register mask     */
00455 #define IRDA_CR_POS   5U       /*!< IRDA control register position */
00456 #define IRDA_ISR_MASK 0x1F00U  /*!< IRDA ISR register mask         */
00457 #define IRDA_ISR_POS  8U       /*!< IRDA ISR register position     */
00458 /**
00459   * @}
00460   */
00461 
00462 /**
00463   * @}
00464   */
00465 
00466 /* Exported macros -----------------------------------------------------------*/
00467 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
00468   * @{
00469   */
00470 
00471 /** @brief  Reset IRDA handle state.
00472   * @param  __HANDLE__ IRDA handle.
00473   * @retval None
00474   */
00475 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1
00476 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00477                                                        (__HANDLE__)->gState = HAL_IRDA_STATE_RESET;      \
00478                                                        (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET;     \
00479                                                        (__HANDLE__)->MspInitCallback = NULL;             \
00480                                                        (__HANDLE__)->MspDeInitCallback = NULL;           \
00481                                                      } while(0U)
00482 #else
00483 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00484                                                        (__HANDLE__)->gState = HAL_IRDA_STATE_RESET;      \
00485                                                        (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET;     \
00486                                                      } while(0U)
00487 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS  */
00488 
00489 /** @brief  Flush the IRDA DR register.
00490   * @param  __HANDLE__ specifies the IRDA Handle.
00491   * @retval None
00492   */
00493 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__)                            \
00494   do{                                                                    \
00495     SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
00496     SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
00497   } while(0U)
00498 
00499 /** @brief  Clear the specified IRDA pending flag.
00500   * @param  __HANDLE__ specifies the IRDA Handle.
00501   * @param  __FLAG__ specifies the flag to check.
00502   *          This parameter can be any combination of the following values:
00503   *            @arg @ref IRDA_CLEAR_PEF
00504   *            @arg @ref IRDA_CLEAR_FEF
00505   *            @arg @ref IRDA_CLEAR_NEF
00506   *            @arg @ref IRDA_CLEAR_OREF
00507   *            @arg @ref IRDA_CLEAR_TCF
00508   *            @arg @ref IRDA_CLEAR_IDLEF
00509   * @retval None
00510   */
00511 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
00512 
00513 /** @brief  Clear the IRDA PE pending flag.
00514   * @param  __HANDLE__ specifies the IRDA Handle.
00515   * @retval None
00516   */
00517 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
00518 
00519 
00520 /** @brief  Clear the IRDA FE pending flag.
00521   * @param  __HANDLE__ specifies the IRDA Handle.
00522   * @retval None
00523   */
00524 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
00525 
00526 /** @brief  Clear the IRDA NE pending flag.
00527   * @param  __HANDLE__ specifies the IRDA Handle.
00528   * @retval None
00529   */
00530 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
00531 
00532 /** @brief  Clear the IRDA ORE pending flag.
00533   * @param  __HANDLE__ specifies the IRDA Handle.
00534   * @retval None
00535   */
00536 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
00537 
00538 /** @brief  Clear the IRDA IDLE pending flag.
00539   * @param  __HANDLE__ specifies the IRDA Handle.
00540   * @retval None
00541   */
00542 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
00543 
00544 /** @brief  Check whether the specified IRDA flag is set or not.
00545   * @param  __HANDLE__ specifies the IRDA Handle.
00546   * @param  __FLAG__ specifies the flag to check.
00547   *        This parameter can be one of the following values:
00548   *            @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag
00549   *            @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
00550   *            @arg @ref IRDA_FLAG_BUSY  Busy flag
00551   *            @arg @ref IRDA_FLAG_ABRF  Auto Baud rate detection flag
00552   *            @arg @ref IRDA_FLAG_ABRE  Auto Baud rate detection error flag
00553   *            @arg @ref IRDA_FLAG_TXE   Transmit data register empty flag
00554   *            @arg @ref IRDA_FLAG_TC    Transmission Complete flag
00555   *            @arg @ref IRDA_FLAG_RXNE  Receive data register not empty flag
00556   *            @arg @ref IRDA_FLAG_ORE   OverRun Error flag
00557   *            @arg @ref IRDA_FLAG_NE    Noise Error flag
00558   *            @arg @ref IRDA_FLAG_FE    Framing Error flag
00559   *            @arg @ref IRDA_FLAG_PE    Parity Error flag
00560   * @retval The new state of __FLAG__ (TRUE or FALSE).
00561   */
00562 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
00563 
00564 
00565 /** @brief  Enable the specified IRDA interrupt.
00566   * @param  __HANDLE__ specifies the IRDA Handle.
00567   * @param  __INTERRUPT__ specifies the IRDA interrupt source to enable.
00568   *          This parameter can be one of the following values:
00569   *            @arg @ref IRDA_IT_TXE  Transmit Data Register empty interrupt
00570   *            @arg @ref IRDA_IT_TC   Transmission complete interrupt
00571   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00572   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00573   *            @arg @ref IRDA_IT_PE   Parity Error interrupt
00574   *            @arg @ref IRDA_IT_ERR  Error interrupt(Frame error, noise error, overrun error)
00575   * @retval None
00576   */
00577 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \
00578                                                            ((__HANDLE__)->Instance->CR1 |= (1U << \
00579                                                                ((__INTERRUPT__) & IRDA_IT_MASK))):\
00580                                                            ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \
00581                                                            ((__HANDLE__)->Instance->CR2 |= (1U << \
00582                                                                ((__INTERRUPT__) & IRDA_IT_MASK))):\
00583                                                            ((__HANDLE__)->Instance->CR3 |= (1U << \
00584                                                                ((__INTERRUPT__) & IRDA_IT_MASK))))
00585 
00586 /** @brief  Disable the specified IRDA interrupt.
00587   * @param  __HANDLE__ specifies the IRDA Handle.
00588   * @param  __INTERRUPT__ specifies the IRDA interrupt source to disable.
00589   *          This parameter can be one of the following values:
00590   *            @arg @ref IRDA_IT_TXE  Transmit Data Register empty interrupt
00591   *            @arg @ref IRDA_IT_TC   Transmission complete interrupt
00592   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00593   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00594   *            @arg @ref IRDA_IT_PE   Parity Error interrupt
00595   *            @arg @ref IRDA_IT_ERR  Error interrupt(Frame error, noise error, overrun error)
00596   * @retval None
00597   */
00598 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__)  (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \
00599                                                            ((__HANDLE__)->Instance->CR1 &= ~ (1U << \
00600                                                                ((__INTERRUPT__) & IRDA_IT_MASK))): \
00601                                                            ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \
00602                                                            ((__HANDLE__)->Instance->CR2 &= ~ (1U << \
00603                                                                ((__INTERRUPT__) & IRDA_IT_MASK))): \
00604                                                            ((__HANDLE__)->Instance->CR3 &= ~ (1U << \
00605                                                                ((__INTERRUPT__) & IRDA_IT_MASK))))
00606 
00607 /** @brief  Check whether the specified IRDA interrupt has occurred or not.
00608   * @param  __HANDLE__ specifies the IRDA Handle.
00609   * @param  __INTERRUPT__ specifies the IRDA interrupt source to check.
00610   *          This parameter can be one of the following values:
00611   *            @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
00612   *            @arg @ref IRDA_IT_TC  Transmission complete interrupt
00613   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00614   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00615   *            @arg @ref IRDA_IT_ORE OverRun Error interrupt
00616   *            @arg @ref IRDA_IT_NE Noise Error interrupt
00617   *            @arg @ref IRDA_IT_FE Framing Error interrupt
00618   *            @arg @ref IRDA_IT_PE Parity Error interrupt
00619   * @retval The new state of __IT__ (SET or RESET).
00620   */
00621 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) \
00622   ((((__HANDLE__)->Instance->ISR& (0x01U << (((__INTERRUPT__) & IRDA_ISR_MASK)>>IRDA_ISR_POS))) != 0U) ? SET : RESET)
00623 
00624 /** @brief  Check whether the specified IRDA interrupt source is enabled or not.
00625   * @param  __HANDLE__ specifies the IRDA Handle.
00626   * @param  __INTERRUPT__ specifies the IRDA interrupt source to check.
00627   *          This parameter can be one of the following values:
00628   *            @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
00629   *            @arg @ref IRDA_IT_TC  Transmission complete interrupt
00630   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00631   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00632   *            @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
00633   *            @arg @ref IRDA_IT_PE Parity Error interrupt
00634   * @retval The new state of __IT__ (SET or RESET).
00635   */
00636 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)                                                          \
00637   ((((((((__INTERRUPT__) & IRDA_CR_MASK) >>IRDA_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 :(((((__INTERRUPT__)  \
00638       & IRDA_CR_MASK) >> IRDA_CR_POS)== 0x02U)? (__HANDLE__)->Instance->CR2 :(__HANDLE__)->Instance->CR3))           \
00639      & (0x01U <<(((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != 0U) ? SET : RESET)
00640 
00641 /** @brief  Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
00642   * @param  __HANDLE__ specifies the IRDA Handle.
00643   * @param  __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
00644   *                       to clear the corresponding interrupt
00645   *          This parameter can be one of the following values:
00646   *            @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
00647   *            @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
00648   *            @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
00649   *            @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
00650   *            @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
00651   * @retval None
00652   */
00653 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
00654 
00655 
00656 /** @brief  Set a specific IRDA request flag.
00657   * @param  __HANDLE__ specifies the IRDA Handle.
00658   * @param  __REQ__ specifies the request flag to set
00659   *          This parameter can be one of the following values:
00660   *            @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
00661   *            @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
00662   *            @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
00663   * @retval None
00664   */
00665 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
00666 
00667 /** @brief  Enable the IRDA one bit sample method.
00668   * @param  __HANDLE__ specifies the IRDA Handle.
00669   * @retval None
00670   */
00671 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
00672 
00673 /** @brief  Disable the IRDA one bit sample method.
00674   * @param  __HANDLE__ specifies the IRDA Handle.
00675   * @retval None
00676   */
00677 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
00678                                                        &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
00679 
00680 /** @brief  Enable UART/USART associated to IRDA Handle.
00681   * @param  __HANDLE__ specifies the IRDA Handle.
00682   * @retval None
00683   */
00684 #define __HAL_IRDA_ENABLE(__HANDLE__)                   ((__HANDLE__)->Instance->CR1 |=  USART_CR1_UE)
00685 
00686 /** @brief  Disable UART/USART associated to IRDA Handle.
00687   * @param  __HANDLE__ specifies the IRDA Handle.
00688   * @retval None
00689   */
00690 #define __HAL_IRDA_DISABLE(__HANDLE__)                  ((__HANDLE__)->Instance->CR1 &=  ~USART_CR1_UE)
00691 
00692 /**
00693   * @}
00694   */
00695 
00696 /* Private macros --------------------------------------------------------*/
00697 /** @addtogroup IRDA_Private_Macros
00698   * @{
00699   */
00700 
00701 /** @brief  Ensure that IRDA Baud rate is less or equal to maximum value.
00702   * @param  __BAUDRATE__ specifies the IRDA Baudrate set by the user.
00703   * @retval True or False
00704   */
00705 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U)
00706 
00707 /** @brief  Ensure that IRDA prescaler value is strictly larger than 0.
00708   * @param  __PRESCALER__ specifies the IRDA prescaler value set by the user.
00709   * @retval True or False
00710   */
00711 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U)
00712 
00713 /** @brief Ensure that IRDA frame parity is valid.
00714   * @param __PARITY__ IRDA frame parity.
00715   * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
00716   */
00717 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
00718                                     ((__PARITY__) == IRDA_PARITY_EVEN) || \
00719                                     ((__PARITY__) == IRDA_PARITY_ODD))
00720 
00721 /** @brief Ensure that IRDA communication mode is valid.
00722   * @param __MODE__ IRDA communication mode.
00723   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00724   */
00725 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__)\
00726                                         & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
00727 
00728 /** @brief Ensure that IRDA power mode is valid.
00729   * @param __MODE__ IRDA power mode.
00730   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00731   */
00732 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
00733                                      ((__MODE__) == IRDA_POWERMODE_NORMAL))
00734 
00735 /** @brief Ensure that IRDA clock Prescaler is valid.
00736   * @param __CLOCKPRESCALER__ IRDA clock Prescaler value.
00737   * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
00738   */
00739 #define IS_IRDA_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV1) || \
00740                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV2)   || \
00741                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV4)   || \
00742                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV6)   || \
00743                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV8)   || \
00744                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV10)  || \
00745                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV12)  || \
00746                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV16)  || \
00747                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV32)  || \
00748                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV64)  || \
00749                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV128) || \
00750                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV256))
00751 
00752 /** @brief Ensure that IRDA state is valid.
00753   * @param __STATE__ IRDA state mode.
00754   * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
00755   */
00756 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
00757                                   ((__STATE__) == IRDA_STATE_ENABLE))
00758 
00759 /** @brief Ensure that IRDA associated UART/USART mode is valid.
00760   * @param __MODE__ IRDA associated UART/USART mode.
00761   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00762   */
00763 #define IS_IRDA_MODE(__MODE__)  (((__MODE__) == IRDA_MODE_DISABLE) || \
00764                                  ((__MODE__) == IRDA_MODE_ENABLE))
00765 
00766 /** @brief Ensure that IRDA sampling rate is valid.
00767   * @param __ONEBIT__ IRDA sampling rate.
00768   * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
00769   */
00770 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__)      (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
00771                                                  ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
00772 
00773 /** @brief Ensure that IRDA DMA TX mode is valid.
00774   * @param __DMATX__ IRDA DMA TX mode.
00775   * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
00776   */
00777 #define IS_IRDA_DMA_TX(__DMATX__)     (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
00778                                        ((__DMATX__) == IRDA_DMA_TX_ENABLE))
00779 
00780 /** @brief Ensure that IRDA DMA RX mode is valid.
00781   * @param __DMARX__ IRDA DMA RX mode.
00782   * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
00783   */
00784 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
00785                                    ((__DMARX__) == IRDA_DMA_RX_ENABLE))
00786 
00787 /** @brief Ensure that IRDA request is valid.
00788   * @param __PARAM__ IRDA request.
00789   * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
00790   */
00791 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
00792                                               ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
00793                                               ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
00794 /**
00795   * @}
00796   */
00797 
00798 /* Include IRDA HAL Extended module */
00799 #include "stm32h7xx_hal_irda_ex.h"
00800 
00801 /* Exported functions --------------------------------------------------------*/
00802 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
00803   * @{
00804   */
00805 
00806 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
00807   * @{
00808   */
00809 
00810 /* Initialization and de-initialization functions  ****************************/
00811 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
00812 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
00813 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
00814 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
00815 
00816 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00817 /* Callbacks Register/UnRegister functions  ***********************************/
00818 HAL_StatusTypeDef HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID,
00819                                             pIRDA_CallbackTypeDef pCallback);
00820 HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID);
00821 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00822 
00823 /**
00824   * @}
00825   */
00826 
00827 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
00828   * @{
00829   */
00830 
00831 /* IO operation functions *****************************************************/
00832 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size, uint32_t Timeout);
00833 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
00834 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size);
00835 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
00836 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size);
00837 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
00838 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
00839 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
00840 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
00841 /* Transfer Abort functions */
00842 HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda);
00843 HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda);
00844 HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda);
00845 HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda);
00846 HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda);
00847 HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda);
00848 
00849 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
00850 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
00851 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
00852 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
00853 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
00854 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
00855 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef *hirda);
00856 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef *hirda);
00857 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda);
00858 
00859 /**
00860   * @}
00861   */
00862 
00863 /* Peripheral Control functions  ************************************************/
00864 
00865 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
00866   * @{
00867   */
00868 
00869 /* Peripheral State and Error functions ***************************************/
00870 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
00871 uint32_t              HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
00872 
00873 /**
00874   * @}
00875   */
00876 
00877 /**
00878   * @}
00879   */
00880 
00881 /**
00882   * @}
00883   */
00884 
00885 /**
00886   * @}
00887   */
00888 
00889 #ifdef __cplusplus
00890 }
00891 #endif
00892 
00893 #endif /* STM32H7xx_HAL_IRDA_H */
00894