STM32L443xx HAL User Manual
stm32l4xx_hal_irda.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4xx_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 STM32L4xx_HAL_IRDA_H
00021 #define STM32L4xx_HAL_IRDA_H
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /* Includes ------------------------------------------------------------------*/
00028 #include "stm32l4xx_hal_def.h"
00029 
00030 /** @addtogroup STM32L4xx_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 #if defined(USART_PRESC_PRESCALER)
00074   uint32_t ClockPrescaler;            /*!< Specifies the prescaler value used to divide the IRDA clock source.
00075                                            This parameter can be a value of @ref IRDA_ClockPrescaler. */
00076 
00077 #endif /* USART_PRESC_PRESCALER */
00078 } IRDA_InitTypeDef;
00079 
00080 /**
00081   * @brief HAL IRDA State definition
00082   * @note  HAL IRDA State value is a combination of 2 different substates:
00083   *        gState and RxState (see @ref IRDA_State_Definition).
00084   *        - gState contains IRDA state information related to global Handle management
00085   *          and also information related to Tx operations.
00086   *          gState value coding follow below described bitmap :
00087   *          b7-b6  Error information
00088   *             00 : No Error
00089   *             01 : (Not Used)
00090   *             10 : Timeout
00091   *             11 : Error
00092   *          b5     Peripheral initialization status
00093   *             0  : Reset (Peripheral not initialized)
00094   *             1  : Init done (Peripheral initialized. HAL IRDA Init function already called)
00095   *          b4-b3  (not used)
00096   *             xx : Should be set to 00
00097   *          b2     Intrinsic process state
00098   *             0  : Ready
00099   *             1  : Busy (Peripheral busy with some configuration or internal operations)
00100   *          b1     (not used)
00101   *             x  : Should be set to 0
00102   *          b0     Tx state
00103   *             0  : Ready (no Tx operation ongoing)
00104   *             1  : Busy (Tx operation ongoing)
00105   *        - RxState contains information related to Rx operations.
00106   *          RxState value coding follow below described bitmap :
00107   *          b7-b6  (not used)
00108   *             xx : Should be set to 00
00109   *          b5     Peripheral initialization status
00110   *             0  : Reset (Peripheral not initialized)
00111   *             1  : Init done (Peripheral initialized)
00112   *          b4-b2  (not used)
00113   *            xxx : Should be set to 000
00114   *          b1     Rx state
00115   *             0  : Ready (no Rx operation ongoing)
00116   *             1  : Busy (Rx operation ongoing)
00117   *          b0     (not used)
00118   *             x  : Should be set to 0.
00119   */
00120 typedef uint32_t HAL_IRDA_StateTypeDef;
00121 
00122 /**
00123   * @brief IRDA clock sources definition
00124   */
00125 typedef enum
00126 {
00127   IRDA_CLOCKSOURCE_PCLK1      = 0x00U,    /*!< PCLK1 clock source         */
00128   IRDA_CLOCKSOURCE_PCLK2      = 0x01U,    /*!< PCLK2 clock source         */
00129   IRDA_CLOCKSOURCE_HSI        = 0x02U,    /*!< HSI clock source           */
00130   IRDA_CLOCKSOURCE_SYSCLK     = 0x04U,    /*!< SYSCLK 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 #if defined(USART_PRESC_PRESCALER)
00310 /** @defgroup IRDA_ClockPrescaler IRDA Clock Prescaler
00311   * @{
00312   */
00313 #define IRDA_PRESCALER_DIV1    0x00000000U  /*!< fclk_pres = fclk     */
00314 #define IRDA_PRESCALER_DIV2    0x00000001U  /*!< fclk_pres = fclk/2   */
00315 #define IRDA_PRESCALER_DIV4    0x00000002U  /*!< fclk_pres = fclk/4   */
00316 #define IRDA_PRESCALER_DIV6    0x00000003U  /*!< fclk_pres = fclk/6   */
00317 #define IRDA_PRESCALER_DIV8    0x00000004U  /*!< fclk_pres = fclk/8   */
00318 #define IRDA_PRESCALER_DIV10   0x00000005U  /*!< fclk_pres = fclk/10  */
00319 #define IRDA_PRESCALER_DIV12   0x00000006U  /*!< fclk_pres = fclk/12  */
00320 #define IRDA_PRESCALER_DIV16   0x00000007U  /*!< fclk_pres = fclk/16  */
00321 #define IRDA_PRESCALER_DIV32   0x00000008U  /*!< fclk_pres = fclk/32  */
00322 #define IRDA_PRESCALER_DIV64   0x00000009U  /*!< fclk_pres = fclk/64  */
00323 #define IRDA_PRESCALER_DIV128  0x0000000AU  /*!< fclk_pres = fclk/128 */
00324 #define IRDA_PRESCALER_DIV256  0x0000000BU  /*!< fclk_pres = fclk/256 */
00325 /**
00326   * @}
00327   */
00328 
00329 #endif /* USART_PRESC_PRESCALER */
00330 /** @defgroup IRDA_State IRDA State
00331   * @{
00332   */
00333 #define IRDA_STATE_DISABLE                  0x00000000U     /*!< IRDA disabled  */
00334 #define IRDA_STATE_ENABLE                   USART_CR1_UE    /*!< IRDA enabled   */
00335 /**
00336   * @}
00337   */
00338 
00339 /** @defgroup IRDA_Mode IRDA Mode
00340   * @{
00341   */
00342 #define IRDA_MODE_DISABLE                   0x00000000U      /*!< Associated UART disabled in IRDA mode */
00343 #define IRDA_MODE_ENABLE                    USART_CR3_IREN   /*!< Associated UART enabled in IRDA mode  */
00344 /**
00345   * @}
00346   */
00347 
00348 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
00349   * @{
00350   */
00351 #define IRDA_ONE_BIT_SAMPLE_DISABLE         0x00000000U       /*!< One-bit sampling disabled */
00352 #define IRDA_ONE_BIT_SAMPLE_ENABLE          USART_CR3_ONEBIT  /*!< One-bit sampling enabled  */
00353 /**
00354   * @}
00355   */
00356 
00357 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
00358   * @{
00359   */
00360 #define IRDA_DMA_TX_DISABLE                 0x00000000U       /*!< IRDA DMA TX disabled */
00361 #define IRDA_DMA_TX_ENABLE                  USART_CR3_DMAT    /*!< IRDA DMA TX enabled  */
00362 /**
00363   * @}
00364   */
00365 
00366 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
00367   * @{
00368   */
00369 #define IRDA_DMA_RX_DISABLE                 0x00000000U       /*!< IRDA DMA RX disabled */
00370 #define IRDA_DMA_RX_ENABLE                  USART_CR3_DMAR    /*!< IRDA DMA RX enabled  */
00371 /**
00372   * @}
00373   */
00374 
00375 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
00376   * @{
00377   */
00378 #define IRDA_AUTOBAUD_REQUEST            USART_RQR_ABRRQ        /*!< Auto-Baud Rate Request      */
00379 #define IRDA_RXDATA_FLUSH_REQUEST        USART_RQR_RXFRQ        /*!< Receive Data flush Request  */
00380 #define IRDA_TXDATA_FLUSH_REQUEST        USART_RQR_TXFRQ        /*!< Transmit data flush Request */
00381 /**
00382   * @}
00383   */
00384 
00385 /** @defgroup IRDA_Flags IRDA Flags
00386   *        Elements values convention: 0xXXXX
00387   *           - 0xXXXX  : Flag mask in the ISR register
00388   * @{
00389   */
00390 #define IRDA_FLAG_REACK                     USART_ISR_REACK         /*!< IRDA receive enable acknowledge flag      */
00391 #define IRDA_FLAG_TEACK                     USART_ISR_TEACK         /*!< IRDA transmit enable acknowledge flag     */
00392 #define IRDA_FLAG_BUSY                      USART_ISR_BUSY          /*!< IRDA busy flag                            */
00393 #define IRDA_FLAG_ABRF                      USART_ISR_ABRF          /*!< IRDA auto Baud rate flag                  */
00394 #define IRDA_FLAG_ABRE                      USART_ISR_ABRE          /*!< IRDA auto Baud rate error                 */
00395 #if defined(USART_CR1_FIFOEN)
00396 #define IRDA_FLAG_TXE                       USART_ISR_TXE_TXFNF     /*!< IRDA transmit data register empty         */
00397 #else
00398 #define IRDA_FLAG_TXE                       USART_ISR_TXE           /*!< IRDA transmit data register empty         */
00399 #endif /* USART_CR1_FIFOEN */
00400 #define IRDA_FLAG_TC                        USART_ISR_TC            /*!< IRDA transmission complete                */
00401 #if defined(USART_CR1_FIFOEN)
00402 #define IRDA_FLAG_RXNE                      USART_ISR_RXNE_RXFNE    /*!< IRDA read data register not empty         */
00403 #else
00404 #define IRDA_FLAG_RXNE                      USART_ISR_RXNE          /*!< IRDA read data register not empty         */
00405 #endif /* USART_CR1_FIFOEN */
00406 #define IRDA_FLAG_ORE                       USART_ISR_ORE           /*!< IRDA overrun error                        */
00407 #define IRDA_FLAG_NE                        USART_ISR_NE            /*!< IRDA noise error                          */
00408 #define IRDA_FLAG_FE                        USART_ISR_FE            /*!< IRDA frame error                          */
00409 #define IRDA_FLAG_PE                        USART_ISR_PE            /*!< IRDA parity error                         */
00410 /**
00411   * @}
00412   */
00413 
00414 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
00415   *        Elements values convention: 0000ZZZZ0XXYYYYYb
00416   *           - YYYYY  : Interrupt source position in the XX register (5bits)
00417   *           - XX  : Interrupt source register (2bits)
00418   *                 - 01: CR1 register
00419   *                 - 10: CR2 register
00420   *                 - 11: CR3 register
00421   *           - ZZZZ  : Flag position in the ISR register(4bits)
00422   * @{
00423   */
00424 #define IRDA_IT_PE                          0x0028U     /*!< IRDA Parity error interruption                 */
00425 #define IRDA_IT_TXE                         0x0727U     /*!< IRDA Transmit data register empty interruption */
00426 #define IRDA_IT_TC                          0x0626U     /*!< IRDA Transmission complete interruption        */
00427 #define IRDA_IT_RXNE                        0x0525U     /*!< IRDA Read data register not empty interruption */
00428 #define IRDA_IT_IDLE                        0x0424U     /*!< IRDA Idle interruption                         */
00429 
00430 /*       Elements values convention: 000000000XXYYYYYb
00431              - YYYYY  : Interrupt source position in the XX register (5bits)
00432              - XX  : Interrupt source register (2bits)
00433                    - 01: CR1 register
00434                    - 10: CR2 register
00435                    - 11: CR3 register */
00436 #define IRDA_IT_ERR                         0x0060U       /*!< IRDA Error interruption        */
00437 
00438 /*       Elements values convention: 0000ZZZZ00000000b
00439              - ZZZZ  : Flag position in the ISR register(4bits) */
00440 #define IRDA_IT_ORE                         0x0300U      /*!< IRDA Overrun error interruption */
00441 #define IRDA_IT_NE                          0x0200U      /*!< IRDA Noise error interruption   */
00442 #define IRDA_IT_FE                          0x0100U      /*!< IRDA Frame error interruption   */
00443 /**
00444   * @}
00445   */
00446 
00447 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
00448   * @{
00449   */
00450 #define IRDA_CLEAR_PEF                       USART_ICR_PECF            /*!< Parity Error Clear Flag          */
00451 #define IRDA_CLEAR_FEF                       USART_ICR_FECF            /*!< Framing Error Clear Flag         */
00452 #define IRDA_CLEAR_NEF                       USART_ICR_NECF            /*!< Noise Error detected Clear Flag  */
00453 #define IRDA_CLEAR_OREF                      USART_ICR_ORECF           /*!< OverRun Error Clear Flag         */
00454 #define IRDA_CLEAR_IDLEF                     USART_ICR_IDLECF          /*!< IDLE line detected Clear Flag    */
00455 #define IRDA_CLEAR_TCF                       USART_ICR_TCCF            /*!< Transmission Complete Clear Flag */
00456 /**
00457   * @}
00458   */
00459 
00460 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
00461   * @{
00462   */
00463 #define IRDA_IT_MASK  0x001FU  /*!< IRDA Interruptions flags mask  */
00464 #define IRDA_CR_MASK  0x00E0U  /*!< IRDA control register mask     */
00465 #define IRDA_CR_POS   5U       /*!< IRDA control register position */
00466 #define IRDA_ISR_MASK 0x1F00U  /*!< IRDA ISR register mask         */
00467 #define IRDA_ISR_POS  8U       /*!< IRDA ISR register position     */
00468 /**
00469   * @}
00470   */
00471 
00472 /**
00473   * @}
00474   */
00475 
00476 /* Exported macros -----------------------------------------------------------*/
00477 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
00478   * @{
00479   */
00480 
00481 /** @brief  Reset IRDA handle state.
00482   * @param  __HANDLE__ IRDA handle.
00483   * @retval None
00484   */
00485 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1
00486 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00487                                                        (__HANDLE__)->gState = HAL_IRDA_STATE_RESET;      \
00488                                                        (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET;     \
00489                                                        (__HANDLE__)->MspInitCallback = NULL;             \
00490                                                        (__HANDLE__)->MspDeInitCallback = NULL;           \
00491                                                      } while(0U)
00492 #else
00493 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00494                                                        (__HANDLE__)->gState = HAL_IRDA_STATE_RESET;      \
00495                                                        (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET;     \
00496                                                      } while(0U)
00497 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS  */
00498 
00499 /** @brief  Flush the IRDA DR register.
00500   * @param  __HANDLE__ specifies the IRDA Handle.
00501   * @retval None
00502   */
00503 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__)                            \
00504   do{                                                                    \
00505     SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
00506     SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
00507   } while(0U)
00508 
00509 /** @brief  Clear the specified IRDA pending flag.
00510   * @param  __HANDLE__ specifies the IRDA Handle.
00511   * @param  __FLAG__ specifies the flag to check.
00512   *          This parameter can be any combination of the following values:
00513   *            @arg @ref IRDA_CLEAR_PEF
00514   *            @arg @ref IRDA_CLEAR_FEF
00515   *            @arg @ref IRDA_CLEAR_NEF
00516   *            @arg @ref IRDA_CLEAR_OREF
00517   *            @arg @ref IRDA_CLEAR_TCF
00518   *            @arg @ref IRDA_CLEAR_IDLEF
00519   * @retval None
00520   */
00521 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
00522 
00523 /** @brief  Clear the IRDA PE pending flag.
00524   * @param  __HANDLE__ specifies the IRDA Handle.
00525   * @retval None
00526   */
00527 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
00528 
00529 
00530 /** @brief  Clear the IRDA FE pending flag.
00531   * @param  __HANDLE__ specifies the IRDA Handle.
00532   * @retval None
00533   */
00534 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
00535 
00536 /** @brief  Clear the IRDA NE pending flag.
00537   * @param  __HANDLE__ specifies the IRDA Handle.
00538   * @retval None
00539   */
00540 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
00541 
00542 /** @brief  Clear the IRDA ORE pending flag.
00543   * @param  __HANDLE__ specifies the IRDA Handle.
00544   * @retval None
00545   */
00546 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__)    __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
00547 
00548 /** @brief  Clear the IRDA IDLE pending flag.
00549   * @param  __HANDLE__ specifies the IRDA Handle.
00550   * @retval None
00551   */
00552 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
00553 
00554 /** @brief  Check whether the specified IRDA flag is set or not.
00555   * @param  __HANDLE__ specifies the IRDA Handle.
00556   * @param  __FLAG__ specifies the flag to check.
00557   *        This parameter can be one of the following values:
00558   *            @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag
00559   *            @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
00560   *            @arg @ref IRDA_FLAG_BUSY  Busy flag
00561   *            @arg @ref IRDA_FLAG_ABRF  Auto Baud rate detection flag
00562   *            @arg @ref IRDA_FLAG_ABRE  Auto Baud rate detection error flag
00563   *            @arg @ref IRDA_FLAG_TXE   Transmit data register empty flag
00564   *            @arg @ref IRDA_FLAG_TC    Transmission Complete flag
00565   *            @arg @ref IRDA_FLAG_RXNE  Receive data register not empty flag
00566   *            @arg @ref IRDA_FLAG_ORE   OverRun Error flag
00567   *            @arg @ref IRDA_FLAG_NE    Noise Error flag
00568   *            @arg @ref IRDA_FLAG_FE    Framing Error flag
00569   *            @arg @ref IRDA_FLAG_PE    Parity Error flag
00570   * @retval The new state of __FLAG__ (TRUE or FALSE).
00571   */
00572 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
00573 
00574 
00575 /** @brief  Enable the specified IRDA interrupt.
00576   * @param  __HANDLE__ specifies the IRDA Handle.
00577   * @param  __INTERRUPT__ specifies the IRDA interrupt source to enable.
00578   *          This parameter can be one of the following values:
00579   *            @arg @ref IRDA_IT_TXE  Transmit Data Register empty interrupt
00580   *            @arg @ref IRDA_IT_TC   Transmission complete interrupt
00581   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00582   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00583   *            @arg @ref IRDA_IT_PE   Parity Error interrupt
00584   *            @arg @ref IRDA_IT_ERR  Error interrupt(Frame error, noise error, overrun error)
00585   * @retval None
00586   */
00587 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \
00588                                                            ((__HANDLE__)->Instance->CR1 |= (1U << \
00589                                                                ((__INTERRUPT__) & IRDA_IT_MASK))):\
00590                                                            ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \
00591                                                            ((__HANDLE__)->Instance->CR2 |= (1U << \
00592                                                                ((__INTERRUPT__) & IRDA_IT_MASK))):\
00593                                                            ((__HANDLE__)->Instance->CR3 |= (1U << \
00594                                                                ((__INTERRUPT__) & IRDA_IT_MASK))))
00595 
00596 /** @brief  Disable the specified IRDA interrupt.
00597   * @param  __HANDLE__ specifies the IRDA Handle.
00598   * @param  __INTERRUPT__ specifies the IRDA interrupt source to disable.
00599   *          This parameter can be one of the following values:
00600   *            @arg @ref IRDA_IT_TXE  Transmit Data Register empty interrupt
00601   *            @arg @ref IRDA_IT_TC   Transmission complete interrupt
00602   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00603   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00604   *            @arg @ref IRDA_IT_PE   Parity Error interrupt
00605   *            @arg @ref IRDA_IT_ERR  Error interrupt(Frame error, noise error, overrun error)
00606   * @retval None
00607   */
00608 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__)  (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \
00609                                                            ((__HANDLE__)->Instance->CR1 &= ~ (1U << \
00610                                                                ((__INTERRUPT__) & IRDA_IT_MASK))): \
00611                                                            ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \
00612                                                            ((__HANDLE__)->Instance->CR2 &= ~ (1U << \
00613                                                                ((__INTERRUPT__) & IRDA_IT_MASK))): \
00614                                                            ((__HANDLE__)->Instance->CR3 &= ~ (1U << \
00615                                                                ((__INTERRUPT__) & IRDA_IT_MASK))))
00616 
00617 /** @brief  Check whether the specified IRDA interrupt has occurred or not.
00618   * @param  __HANDLE__ specifies the IRDA Handle.
00619   * @param  __INTERRUPT__ specifies the IRDA interrupt source to check.
00620   *          This parameter can be one of the following values:
00621   *            @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
00622   *            @arg @ref IRDA_IT_TC  Transmission complete interrupt
00623   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00624   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00625   *            @arg @ref IRDA_IT_ORE OverRun Error interrupt
00626   *            @arg @ref IRDA_IT_NE Noise Error interrupt
00627   *            @arg @ref IRDA_IT_FE Framing Error interrupt
00628   *            @arg @ref IRDA_IT_PE Parity Error interrupt
00629   * @retval The new state of __IT__ (SET or RESET).
00630   */
00631 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) \
00632   ((((__HANDLE__)->Instance->ISR& (0x01U << (((__INTERRUPT__) & IRDA_ISR_MASK)>>IRDA_ISR_POS))) != 0U) ? SET : RESET)
00633 
00634 /** @brief  Check whether the specified IRDA interrupt source is enabled or not.
00635   * @param  __HANDLE__ specifies the IRDA Handle.
00636   * @param  __INTERRUPT__ specifies the IRDA interrupt source to check.
00637   *          This parameter can be one of the following values:
00638   *            @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
00639   *            @arg @ref IRDA_IT_TC  Transmission complete interrupt
00640   *            @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
00641   *            @arg @ref IRDA_IT_IDLE Idle line detection interrupt
00642   *            @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
00643   *            @arg @ref IRDA_IT_PE Parity Error interrupt
00644   * @retval The new state of __IT__ (SET or RESET).
00645   */
00646 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)                                                          \
00647   ((((((((__INTERRUPT__) & IRDA_CR_MASK) >>IRDA_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 :(((((__INTERRUPT__)  \
00648       & IRDA_CR_MASK) >> IRDA_CR_POS)== 0x02U)? (__HANDLE__)->Instance->CR2 :(__HANDLE__)->Instance->CR3))           \
00649      & (0x01U <<(((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != 0U) ? SET : RESET)
00650 
00651 /** @brief  Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
00652   * @param  __HANDLE__ specifies the IRDA Handle.
00653   * @param  __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
00654   *                       to clear the corresponding interrupt
00655   *          This parameter can be one of the following values:
00656   *            @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
00657   *            @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
00658   *            @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
00659   *            @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
00660   *            @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
00661   * @retval None
00662   */
00663 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
00664 
00665 
00666 /** @brief  Set a specific IRDA request flag.
00667   * @param  __HANDLE__ specifies the IRDA Handle.
00668   * @param  __REQ__ specifies the request flag to set
00669   *          This parameter can be one of the following values:
00670   *            @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
00671   *            @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
00672   *            @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
00673   * @retval None
00674   */
00675 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
00676 
00677 /** @brief  Enable the IRDA one bit sample method.
00678   * @param  __HANDLE__ specifies the IRDA Handle.
00679   * @retval None
00680   */
00681 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
00682 
00683 /** @brief  Disable the IRDA one bit sample method.
00684   * @param  __HANDLE__ specifies the IRDA Handle.
00685   * @retval None
00686   */
00687 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
00688                                                        &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
00689 
00690 /** @brief  Enable UART/USART associated to IRDA Handle.
00691   * @param  __HANDLE__ specifies the IRDA Handle.
00692   * @retval None
00693   */
00694 #define __HAL_IRDA_ENABLE(__HANDLE__)                   ((__HANDLE__)->Instance->CR1 |=  USART_CR1_UE)
00695 
00696 /** @brief  Disable UART/USART associated to IRDA Handle.
00697   * @param  __HANDLE__ specifies the IRDA Handle.
00698   * @retval None
00699   */
00700 #define __HAL_IRDA_DISABLE(__HANDLE__)                  ((__HANDLE__)->Instance->CR1 &=  ~USART_CR1_UE)
00701 
00702 /**
00703   * @}
00704   */
00705 
00706 /* Private macros --------------------------------------------------------*/
00707 /** @addtogroup IRDA_Private_Macros
00708   * @{
00709   */
00710 
00711 /** @brief  Ensure that IRDA Baud rate is less or equal to maximum value.
00712   * @param  __BAUDRATE__ specifies the IRDA Baudrate set by the user.
00713   * @retval True or False
00714   */
00715 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U)
00716 
00717 /** @brief  Ensure that IRDA prescaler value is strictly larger than 0.
00718   * @param  __PRESCALER__ specifies the IRDA prescaler value set by the user.
00719   * @retval True or False
00720   */
00721 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U)
00722 
00723 /** @brief Ensure that IRDA frame parity is valid.
00724   * @param __PARITY__ IRDA frame parity.
00725   * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
00726   */
00727 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
00728                                     ((__PARITY__) == IRDA_PARITY_EVEN) || \
00729                                     ((__PARITY__) == IRDA_PARITY_ODD))
00730 
00731 /** @brief Ensure that IRDA communication mode is valid.
00732   * @param __MODE__ IRDA communication mode.
00733   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00734   */
00735 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__)\
00736                                         & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
00737 
00738 /** @brief Ensure that IRDA power mode is valid.
00739   * @param __MODE__ IRDA power mode.
00740   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00741   */
00742 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
00743                                      ((__MODE__) == IRDA_POWERMODE_NORMAL))
00744 
00745 #if defined(USART_PRESC_PRESCALER)
00746 /** @brief Ensure that IRDA clock Prescaler is valid.
00747   * @param __CLOCKPRESCALER__ IRDA clock Prescaler value.
00748   * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
00749   */
00750 #define IS_IRDA_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV1) || \
00751                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV2)   || \
00752                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV4)   || \
00753                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV6)   || \
00754                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV8)   || \
00755                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV10)  || \
00756                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV12)  || \
00757                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV16)  || \
00758                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV32)  || \
00759                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV64)  || \
00760                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV128) || \
00761                                                     ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV256))
00762 
00763 #endif /* USART_PRESC_PRESCALER */
00764 /** @brief Ensure that IRDA state is valid.
00765   * @param __STATE__ IRDA state mode.
00766   * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
00767   */
00768 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
00769                                   ((__STATE__) == IRDA_STATE_ENABLE))
00770 
00771 /** @brief Ensure that IRDA associated UART/USART mode is valid.
00772   * @param __MODE__ IRDA associated UART/USART mode.
00773   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
00774   */
00775 #define IS_IRDA_MODE(__MODE__)  (((__MODE__) == IRDA_MODE_DISABLE) || \
00776                                  ((__MODE__) == IRDA_MODE_ENABLE))
00777 
00778 /** @brief Ensure that IRDA sampling rate is valid.
00779   * @param __ONEBIT__ IRDA sampling rate.
00780   * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
00781   */
00782 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__)      (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
00783                                                  ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
00784 
00785 /** @brief Ensure that IRDA DMA TX mode is valid.
00786   * @param __DMATX__ IRDA DMA TX mode.
00787   * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
00788   */
00789 #define IS_IRDA_DMA_TX(__DMATX__)     (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
00790                                        ((__DMATX__) == IRDA_DMA_TX_ENABLE))
00791 
00792 /** @brief Ensure that IRDA DMA RX mode is valid.
00793   * @param __DMARX__ IRDA DMA RX mode.
00794   * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
00795   */
00796 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
00797                                    ((__DMARX__) == IRDA_DMA_RX_ENABLE))
00798 
00799 /** @brief Ensure that IRDA request is valid.
00800   * @param __PARAM__ IRDA request.
00801   * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
00802   */
00803 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
00804                                               ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
00805                                               ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
00806 /**
00807   * @}
00808   */
00809 
00810 /* Include IRDA HAL Extended module */
00811 #include "stm32l4xx_hal_irda_ex.h"
00812 
00813 /* Exported functions --------------------------------------------------------*/
00814 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
00815   * @{
00816   */
00817 
00818 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
00819   * @{
00820   */
00821 
00822 /* Initialization and de-initialization functions  ****************************/
00823 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
00824 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
00825 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
00826 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
00827 
00828 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
00829 /* Callbacks Register/UnRegister functions  ***********************************/
00830 HAL_StatusTypeDef HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID,
00831                                             pIRDA_CallbackTypeDef pCallback);
00832 HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID);
00833 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
00834 
00835 /**
00836   * @}
00837   */
00838 
00839 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
00840   * @{
00841   */
00842 
00843 /* IO operation functions *****************************************************/
00844 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size, uint32_t Timeout);
00845 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
00846 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size);
00847 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
00848 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size);
00849 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
00850 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
00851 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
00852 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
00853 /* Transfer Abort functions */
00854 HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda);
00855 HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda);
00856 HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda);
00857 HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda);
00858 HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda);
00859 HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda);
00860 
00861 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
00862 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
00863 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
00864 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
00865 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
00866 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
00867 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef *hirda);
00868 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef *hirda);
00869 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda);
00870 
00871 /**
00872   * @}
00873   */
00874 
00875 /* Peripheral Control functions  ************************************************/
00876 
00877 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
00878   * @{
00879   */
00880 
00881 /* Peripheral State and Error functions ***************************************/
00882 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
00883 uint32_t              HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
00884 
00885 /**
00886   * @}
00887   */
00888 
00889 /**
00890   * @}
00891   */
00892 
00893 /**
00894   * @}
00895   */
00896 
00897 /**
00898   * @}
00899   */
00900 
00901 #ifdef __cplusplus
00902 }
00903 #endif
00904 
00905 #endif /* STM32L4xx_HAL_IRDA_H */
00906