2 ******************************************************************************
3 * @file stm32g4xx_hal_irda.h
4 * @author MCD Application Team
5 * @brief Header file of IRDA HAL module.
6 ******************************************************************************
9 * <h2><center>© Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.</center></h2>
12 * This software component is licensed by ST under BSD 3-Clause license,
13 * the "License"; You may not use this file except in compliance with the
14 * License. You may obtain a copy of the License at:
15 * opensource.org/licenses/BSD-3-Clause
17 ******************************************************************************
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32G4xx_HAL_IRDA_H
22 #define STM32G4xx_HAL_IRDA_H
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32g4xx_hal_def.h"
31 /** @addtogroup STM32G4xx_HAL_Driver
39 /* Exported types ------------------------------------------------------------*/
40 /** @defgroup IRDA_Exported_Types IRDA Exported Types
45 * @brief IRDA Init Structure definition
49 uint32_t BaudRate
; /*!< This member configures the IRDA communication baud rate.
50 The baud rate register is computed using the following formula:
51 Baud Rate Register = ((usart_ker_ckpres) / ((hirda->Init.BaudRate)))
52 where usart_ker_ckpres is the IRDA input clock divided by a prescaler */
54 uint32_t WordLength
; /*!< Specifies the number of data bits transmitted or received in a frame.
55 This parameter can be a value of @ref IRDAEx_Word_Length */
57 uint32_t Parity
; /*!< Specifies the parity mode.
58 This parameter can be a value of @ref IRDA_Parity
59 @note When parity is enabled, the computed parity is inserted
60 at the MSB position of the transmitted data (9th bit when
61 the word length is set to 9 data bits; 8th bit when the
62 word length is set to 8 data bits). */
64 uint32_t Mode
; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
65 This parameter can be a value of @ref IRDA_Transfer_Mode */
67 uint8_t Prescaler
; /*!< Specifies the Prescaler value for dividing the UART/USART source clock
68 to achieve low-power frequency.
69 @note Prescaler value 0 is forbidden */
71 uint16_t PowerMode
; /*!< Specifies the IRDA power mode.
72 This parameter can be a value of @ref IRDA_Low_Power */
74 uint32_t ClockPrescaler
; /*!< Specifies the prescaler value used to divide the IRDA clock source.
75 This parameter can be a value of @ref IRDA_ClockPrescaler. */
80 * @brief HAL IRDA State definition
81 * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState (see @ref IRDA_State_Definition).
82 * - gState contains IRDA state information related to global Handle management
83 * and also information related to Tx operations.
84 * gState value coding follow below described bitmap :
85 * b7-b6 Error information
90 * b5 Peripheral initialization status
91 * 0 : Reset (Peripheral not initialized)
92 * 1 : Init done (Peripheral not initialized. HAL IRDA Init function already called)
94 * xx : Should be set to 00
95 * b2 Intrinsic process state
97 * 1 : Busy (Peripheral busy with some configuration or internal operations)
99 * x : Should be set to 0
101 * 0 : Ready (no Tx operation ongoing)
102 * 1 : Busy (Tx operation ongoing)
103 * - RxState contains information related to Rx operations.
104 * RxState value coding follow below described bitmap :
106 * xx : Should be set to 00
107 * b5 Peripheral initialization status
108 * 0 : Reset (Peripheral not initialized)
109 * 1 : Init done (Peripheral not initialized)
111 * xxx : Should be set to 000
113 * 0 : Ready (no Rx operation ongoing)
114 * 1 : Busy (Rx operation ongoing)
116 * x : Should be set to 0.
118 typedef uint32_t HAL_IRDA_StateTypeDef
;
121 * @brief IRDA clock sources definition
125 IRDA_CLOCKSOURCE_PCLK1
= 0x00U
, /*!< PCLK1 clock source */
126 IRDA_CLOCKSOURCE_PCLK2
= 0x01U
, /*!< PCLK2 clock source */
127 IRDA_CLOCKSOURCE_HSI
= 0x02U
, /*!< HSI clock source */
128 IRDA_CLOCKSOURCE_SYSCLK
= 0x04U
, /*!< SYSCLK clock source */
129 IRDA_CLOCKSOURCE_LSE
= 0x10U
, /*!< LSE clock source */
130 IRDA_CLOCKSOURCE_UNDEFINED
= 0x20U
/*!< Undefined clock source */
131 } IRDA_ClockSourceTypeDef
;
134 * @brief IRDA handle Structure definition
136 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
137 typedef struct __IRDA_HandleTypeDef
140 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
142 USART_TypeDef
*Instance
; /*!< USART registers base address */
144 IRDA_InitTypeDef Init
; /*!< IRDA communication parameters */
146 uint8_t *pTxBuffPtr
; /*!< Pointer to IRDA Tx transfer Buffer */
148 uint16_t TxXferSize
; /*!< IRDA Tx Transfer size */
150 __IO
uint16_t TxXferCount
; /*!< IRDA Tx Transfer Counter */
152 uint8_t *pRxBuffPtr
; /*!< Pointer to IRDA Rx transfer Buffer */
154 uint16_t RxXferSize
; /*!< IRDA Rx Transfer size */
156 __IO
uint16_t RxXferCount
; /*!< IRDA Rx Transfer Counter */
158 uint16_t Mask
; /*!< USART RX RDR register mask */
160 DMA_HandleTypeDef
*hdmatx
; /*!< IRDA Tx DMA Handle parameters */
162 DMA_HandleTypeDef
*hdmarx
; /*!< IRDA Rx DMA Handle parameters */
164 HAL_LockTypeDef Lock
; /*!< Locking object */
166 __IO HAL_IRDA_StateTypeDef gState
; /*!< IRDA state information related to global Handle management
167 and also related to Tx operations.
168 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
170 __IO HAL_IRDA_StateTypeDef RxState
; /*!< IRDA state information related to Rx operations.
171 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
173 __IO
uint32_t ErrorCode
; /*!< IRDA Error code */
175 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
176 void (* TxHalfCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Tx Half Complete Callback */
178 void (* TxCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Tx Complete Callback */
180 void (* RxHalfCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Rx Half Complete Callback */
182 void (* RxCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Rx Complete Callback */
184 void (* ErrorCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Error Callback */
186 void (* AbortCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Complete Callback */
188 void (* AbortTransmitCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Transmit Complete Callback */
190 void (* AbortReceiveCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Receive Complete Callback */
193 void (* MspInitCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Msp Init callback */
195 void (* MspDeInitCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Msp DeInit callback */
196 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
198 } IRDA_HandleTypeDef
;
200 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
202 * @brief HAL IRDA Callback ID enumeration definition
206 HAL_IRDA_TX_HALFCOMPLETE_CB_ID
= 0x00U
, /*!< IRDA Tx Half Complete Callback ID */
207 HAL_IRDA_TX_COMPLETE_CB_ID
= 0x01U
, /*!< IRDA Tx Complete Callback ID */
208 HAL_IRDA_RX_HALFCOMPLETE_CB_ID
= 0x02U
, /*!< IRDA Rx Half Complete Callback ID */
209 HAL_IRDA_RX_COMPLETE_CB_ID
= 0x03U
, /*!< IRDA Rx Complete Callback ID */
210 HAL_IRDA_ERROR_CB_ID
= 0x04U
, /*!< IRDA Error Callback ID */
211 HAL_IRDA_ABORT_COMPLETE_CB_ID
= 0x05U
, /*!< IRDA Abort Complete Callback ID */
212 HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID
= 0x06U
, /*!< IRDA Abort Transmit Complete Callback ID */
213 HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID
= 0x07U
, /*!< IRDA Abort Receive Complete Callback ID */
215 HAL_IRDA_MSPINIT_CB_ID
= 0x08U
, /*!< IRDA MspInit callback ID */
216 HAL_IRDA_MSPDEINIT_CB_ID
= 0x09U
/*!< IRDA MspDeInit callback ID */
218 } HAL_IRDA_CallbackIDTypeDef
;
221 * @brief HAL IRDA Callback pointer definition
223 typedef void (*pIRDA_CallbackTypeDef
)(IRDA_HandleTypeDef
*hirda
); /*!< pointer to an IRDA callback function */
225 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
231 /* Exported constants --------------------------------------------------------*/
232 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
236 /** @defgroup IRDA_State_Definition IRDA State Code Definition
239 #define HAL_IRDA_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
240 Value is allowed for gState and RxState */
241 #define HAL_IRDA_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
242 Value is allowed for gState and RxState */
243 #define HAL_IRDA_STATE_BUSY 0x00000024U /*!< An internal process is ongoing
244 Value is allowed for gState only */
245 #define HAL_IRDA_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
246 Value is allowed for gState only */
247 #define HAL_IRDA_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
248 Value is allowed for RxState only */
249 #define HAL_IRDA_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
250 Not to be used for neither gState nor RxState.
251 Value is result of combination (Or) between gState and RxState values */
252 #define HAL_IRDA_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
253 Value is allowed for gState only */
254 #define HAL_IRDA_STATE_ERROR 0x000000E0U /*!< Error
255 Value is allowed for gState only */
260 /** @defgroup IRDA_Error_Definition IRDA Error Code Definition
263 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
264 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
265 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
266 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */
267 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
268 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
269 #define HAL_IRDA_ERROR_BUSY ((uint32_t)0x00000020U) /*!< Busy Error */
270 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
271 #define HAL_IRDA_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
272 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
277 /** @defgroup IRDA_Parity IRDA Parity
280 #define IRDA_PARITY_NONE 0x00000000U /*!< No parity */
281 #define IRDA_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
282 #define IRDA_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
287 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
290 #define IRDA_MODE_RX USART_CR1_RE /*!< RX mode */
291 #define IRDA_MODE_TX USART_CR1_TE /*!< TX mode */
292 #define IRDA_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
297 /** @defgroup IRDA_Low_Power IRDA Low Power
300 #define IRDA_POWERMODE_NORMAL 0x00000000U /*!< IRDA normal power mode */
301 #define IRDA_POWERMODE_LOWPOWER USART_CR3_IRLP /*!< IRDA low power mode */
306 /** @defgroup IRDA_ClockPrescaler Clock Prescaler
309 #define IRDA_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
310 #define IRDA_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
311 #define IRDA_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
312 #define IRDA_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
313 #define IRDA_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
314 #define IRDA_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
315 #define IRDA_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
316 #define IRDA_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
317 #define IRDA_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
318 #define IRDA_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
319 #define IRDA_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
320 #define IRDA_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
325 /** @defgroup IRDA_State IRDA State
328 #define IRDA_STATE_DISABLE 0x00000000U /*!< IRDA disabled */
329 #define IRDA_STATE_ENABLE USART_CR1_UE /*!< IRDA enabled */
334 /** @defgroup IRDA_Mode IRDA Mode
337 #define IRDA_MODE_DISABLE 0x00000000U /*!< Associated UART disabled in IRDA mode */
338 #define IRDA_MODE_ENABLE USART_CR3_IREN /*!< Associated UART enabled in IRDA mode */
343 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
346 #define IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disabled */
347 #define IRDA_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enabled */
352 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
355 #define IRDA_DMA_TX_DISABLE 0x00000000U /*!< IRDA DMA TX disabled */
356 #define IRDA_DMA_TX_ENABLE USART_CR3_DMAT /*!< IRDA DMA TX enabled */
361 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
364 #define IRDA_DMA_RX_DISABLE 0x00000000U /*!< IRDA DMA RX disabled */
365 #define IRDA_DMA_RX_ENABLE USART_CR3_DMAR /*!< IRDA DMA RX enabled */
370 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
373 #define IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
374 #define IRDA_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
375 #define IRDA_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
380 /** @defgroup IRDA_Flags IRDA Flags
381 * Elements values convention: 0xXXXX
382 * - 0xXXXX : Flag mask in the ISR register
385 #define IRDA_FLAG_REACK USART_ISR_REACK /*!< IRDA receive enable acknowledge flag */
386 #define IRDA_FLAG_TEACK USART_ISR_TEACK /*!< IRDA transmit enable acknowledge flag */
387 #define IRDA_FLAG_BUSY USART_ISR_BUSY /*!< IRDA busy flag */
388 #define IRDA_FLAG_ABRF USART_ISR_ABRF /*!< IRDA auto Baud rate flag */
389 #define IRDA_FLAG_ABRE USART_ISR_ABRE /*!< IRDA auto Baud rate error */
390 #define IRDA_FLAG_TXE USART_ISR_TXE_TXFNF /*!< IRDA transmit data register empty */
391 #define IRDA_FLAG_TC USART_ISR_TC /*!< IRDA transmission complete */
392 #define IRDA_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< IRDA read data register not empty */
393 #define IRDA_FLAG_ORE USART_ISR_ORE /*!< IRDA overrun error */
394 #define IRDA_FLAG_NE USART_ISR_NE /*!< IRDA noise error */
395 #define IRDA_FLAG_FE USART_ISR_FE /*!< IRDA frame error */
396 #define IRDA_FLAG_PE USART_ISR_PE /*!< IRDA parity error */
401 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
402 * Elements values convention: 0000ZZZZ0XXYYYYYb
403 * - YYYYY : Interrupt source position in the XX register (5bits)
404 * - XX : Interrupt source register (2bits)
408 * - ZZZZ : Flag position in the ISR register(4bits)
411 #define IRDA_IT_PE 0x0028U /*!< IRDA Parity error interruption */
412 #define IRDA_IT_TXE 0x0727U /*!< IRDA Transmit data register empty interruption */
413 #define IRDA_IT_TC 0x0626U /*!< IRDA Transmission complete interruption */
414 #define IRDA_IT_RXNE 0x0525U /*!< IRDA Read data register not empty interruption */
415 #define IRDA_IT_IDLE 0x0424U /*!< IRDA Idle interruption */
417 /* Elements values convention: 000000000XXYYYYYb
418 - YYYYY : Interrupt source position in the XX register (5bits)
419 - XX : Interrupt source register (2bits)
422 - 11: CR3 register */
423 #define IRDA_IT_ERR 0x0060U /*!< IRDA Error interruption */
425 /* Elements values convention: 0000ZZZZ00000000b
426 - ZZZZ : Flag position in the ISR register(4bits) */
427 #define IRDA_IT_ORE 0x0300U /*!< IRDA Overrun error interruption */
428 #define IRDA_IT_NE 0x0200U /*!< IRDA Noise error interruption */
429 #define IRDA_IT_FE 0x0100U /*!< IRDA Frame error interruption */
434 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
437 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
438 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
439 #define IRDA_CLEAR_NEF USART_ICR_NECF /*!< Noise Error detected Clear Flag */
440 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
441 #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
442 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
447 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
450 #define IRDA_IT_MASK 0x001FU /*!< IRDA Interruptions flags mask */
451 #define IRDA_CR_MASK 0x00E0U /*!< IRDA control register mask */
452 #define IRDA_CR_POS 5U /*!< IRDA control register position */
453 #define IRDA_ISR_MASK 0x1F00U /*!< IRDA ISR register mask */
454 #define IRDA_ISR_POS 8U /*!< IRDA ISR register position */
463 /* Exported macros -----------------------------------------------------------*/
464 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
468 /** @brief Reset IRDA handle state.
469 * @param __HANDLE__ IRDA handle.
472 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1
473 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
474 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
475 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
476 (__HANDLE__)->MspInitCallback = NULL; \
477 (__HANDLE__)->MspDeInitCallback = NULL; \
480 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
481 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
482 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
484 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS */
486 /** @brief Flush the IRDA DR register.
487 * @param __HANDLE__ specifies the IRDA Handle.
490 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \
492 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
493 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
496 /** @brief Clear the specified IRDA pending flag.
497 * @param __HANDLE__ specifies the IRDA Handle.
498 * @param __FLAG__ specifies the flag to check.
499 * This parameter can be any combination of the following values:
500 * @arg @ref IRDA_CLEAR_PEF
501 * @arg @ref IRDA_CLEAR_FEF
502 * @arg @ref IRDA_CLEAR_NEF
503 * @arg @ref IRDA_CLEAR_OREF
504 * @arg @ref IRDA_CLEAR_TCF
505 * @arg @ref IRDA_CLEAR_IDLEF
508 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
510 /** @brief Clear the IRDA PE pending flag.
511 * @param __HANDLE__ specifies the IRDA Handle.
514 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
517 /** @brief Clear the IRDA FE pending flag.
518 * @param __HANDLE__ specifies the IRDA Handle.
521 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
523 /** @brief Clear the IRDA NE pending flag.
524 * @param __HANDLE__ specifies the IRDA Handle.
527 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
529 /** @brief Clear the IRDA ORE pending flag.
530 * @param __HANDLE__ specifies the IRDA Handle.
533 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
535 /** @brief Clear the IRDA IDLE pending flag.
536 * @param __HANDLE__ specifies the IRDA Handle.
539 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
541 /** @brief Check whether the specified IRDA flag is set or not.
542 * @param __HANDLE__ specifies the IRDA Handle.
543 * @param __FLAG__ specifies the flag to check.
544 * This parameter can be one of the following values:
545 * @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag
546 * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
547 * @arg @ref IRDA_FLAG_BUSY Busy flag
548 * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag
549 * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag
550 * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag
551 * @arg @ref IRDA_FLAG_TC Transmission Complete flag
552 * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag
553 * @arg @ref IRDA_FLAG_ORE OverRun Error flag
554 * @arg @ref IRDA_FLAG_NE Noise Error flag
555 * @arg @ref IRDA_FLAG_FE Framing Error flag
556 * @arg @ref IRDA_FLAG_PE Parity Error flag
557 * @retval The new state of __FLAG__ (TRUE or FALSE).
559 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
562 /** @brief Enable the specified IRDA interrupt.
563 * @param __HANDLE__ specifies the IRDA Handle.
564 * @param __INTERRUPT__ specifies the IRDA interrupt source to enable.
565 * This parameter can be one of the following values:
566 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
567 * @arg @ref IRDA_IT_TC Transmission complete interrupt
568 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
569 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
570 * @arg @ref IRDA_IT_PE Parity Error interrupt
571 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
574 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
575 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
576 ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
578 /** @brief Disable the specified IRDA interrupt.
579 * @param __HANDLE__ specifies the IRDA Handle.
580 * @param __INTERRUPT__ specifies the IRDA interrupt source to disable.
581 * This parameter can be one of the following values:
582 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
583 * @arg @ref IRDA_IT_TC Transmission complete interrupt
584 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
585 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
586 * @arg @ref IRDA_IT_PE Parity Error interrupt
587 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
590 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
591 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
592 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
595 /** @brief Check whether the specified IRDA interrupt has occurred or not.
596 * @param __HANDLE__ specifies the IRDA Handle.
597 * @param __INTERRUPT__ specifies the IRDA interrupt source to check.
598 * This parameter can be one of the following values:
599 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
600 * @arg @ref IRDA_IT_TC Transmission complete interrupt
601 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
602 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
603 * @arg @ref IRDA_IT_ORE OverRun Error interrupt
604 * @arg @ref IRDA_IT_NE Noise Error interrupt
605 * @arg @ref IRDA_IT_FE Framing Error interrupt
606 * @arg @ref IRDA_IT_PE Parity Error interrupt
607 * @retval The new state of __IT__ (SET or RESET).
609 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\
610 & (0x01U << (((__INTERRUPT__) & IRDA_ISR_MASK)>> IRDA_ISR_POS))) != 0U) ? SET : RESET)
612 /** @brief Check whether the specified IRDA interrupt source is enabled or not.
613 * @param __HANDLE__ specifies the IRDA Handle.
614 * @param __INTERRUPT__ specifies the IRDA interrupt source to check.
615 * This parameter can be one of the following values:
616 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
617 * @arg @ref IRDA_IT_TC Transmission complete interrupt
618 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
619 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
620 * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
621 * @arg @ref IRDA_IT_PE Parity Error interrupt
622 * @retval The new state of __IT__ (SET or RESET).
624 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 : \
625 (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 0x02U)? (__HANDLE__)->Instance->CR2 : \
626 (__HANDLE__)->Instance->CR3)) & ((uint32_t)0x01U << (((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != 0U) ? SET : RESET)
628 /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
629 * @param __HANDLE__ specifies the IRDA Handle.
630 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
631 * to clear the corresponding interrupt
632 * This parameter can be one of the following values:
633 * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
634 * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
635 * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
636 * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
637 * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
640 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
643 /** @brief Set a specific IRDA request flag.
644 * @param __HANDLE__ specifies the IRDA Handle.
645 * @param __REQ__ specifies the request flag to set
646 * This parameter can be one of the following values:
647 * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
648 * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
649 * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
652 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
654 /** @brief Enable the IRDA one bit sample method.
655 * @param __HANDLE__ specifies the IRDA Handle.
658 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
660 /** @brief Disable the IRDA one bit sample method.
661 * @param __HANDLE__ specifies the IRDA Handle.
664 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
665 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
667 /** @brief Enable UART/USART associated to IRDA Handle.
668 * @param __HANDLE__ specifies the IRDA Handle.
671 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
673 /** @brief Disable UART/USART associated to IRDA Handle.
674 * @param __HANDLE__ specifies the IRDA Handle.
677 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
683 /* Private macros --------------------------------------------------------*/
684 /** @addtogroup IRDA_Private_Macros
688 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value.
689 * @param __BAUDRATE__ specifies the IRDA Baudrate set by the user.
690 * @retval True or False
692 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U)
694 /** @brief Ensure that IRDA prescaler value is strictly larger than 0.
695 * @param __PRESCALER__ specifies the IRDA prescaler value set by the user.
696 * @retval True or False
698 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U)
700 /** @brief Ensure that IRDA frame parity is valid.
701 * @param __PARITY__ IRDA frame parity.
702 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
704 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
705 ((__PARITY__) == IRDA_PARITY_EVEN) || \
706 ((__PARITY__) == IRDA_PARITY_ODD))
708 /** @brief Ensure that IRDA communication mode is valid.
709 * @param __MODE__ IRDA communication mode.
710 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
712 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__)\
713 & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
715 /** @brief Ensure that IRDA power mode is valid.
716 * @param __MODE__ IRDA power mode.
717 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
719 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
720 ((__MODE__) == IRDA_POWERMODE_NORMAL))
722 /** @brief Ensure that IRDA clock Prescaler is valid.
723 * @param __CLOCKPRESCALER__ IRDA clock Prescaler value.
724 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
726 #define IS_IRDA_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV1) || \
727 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV2) || \
728 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV4) || \
729 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV6) || \
730 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV8) || \
731 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV10) || \
732 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV12) || \
733 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV16) || \
734 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV32) || \
735 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV64) || \
736 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV128) || \
737 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV256))
739 /** @brief Ensure that IRDA state is valid.
740 * @param __STATE__ IRDA state mode.
741 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
743 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
744 ((__STATE__) == IRDA_STATE_ENABLE))
746 /** @brief Ensure that IRDA associated UART/USART mode is valid.
747 * @param __MODE__ IRDA associated UART/USART mode.
748 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
750 #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \
751 ((__MODE__) == IRDA_MODE_ENABLE))
753 /** @brief Ensure that IRDA sampling rate is valid.
754 * @param __ONEBIT__ IRDA sampling rate.
755 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
757 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
758 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
760 /** @brief Ensure that IRDA DMA TX mode is valid.
761 * @param __DMATX__ IRDA DMA TX mode.
762 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
764 #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
765 ((__DMATX__) == IRDA_DMA_TX_ENABLE))
767 /** @brief Ensure that IRDA DMA RX mode is valid.
768 * @param __DMARX__ IRDA DMA RX mode.
769 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
771 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
772 ((__DMARX__) == IRDA_DMA_RX_ENABLE))
774 /** @brief Ensure that IRDA request is valid.
775 * @param __PARAM__ IRDA request.
776 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
778 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
779 ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
780 ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
785 /* Include IRDA HAL Extended module */
786 #include "stm32g4xx_hal_irda_ex.h"
788 /* Exported functions --------------------------------------------------------*/
789 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
793 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
797 /* Initialization and de-initialization functions ****************************/
798 HAL_StatusTypeDef
HAL_IRDA_Init(IRDA_HandleTypeDef
*hirda
);
799 HAL_StatusTypeDef
HAL_IRDA_DeInit(IRDA_HandleTypeDef
*hirda
);
800 void HAL_IRDA_MspInit(IRDA_HandleTypeDef
*hirda
);
801 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef
*hirda
);
803 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
804 /* Callbacks Register/UnRegister functions ***********************************/
805 HAL_StatusTypeDef
HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef
*hirda
, HAL_IRDA_CallbackIDTypeDef CallbackID
,
806 pIRDA_CallbackTypeDef pCallback
);
807 HAL_StatusTypeDef
HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef
*hirda
, HAL_IRDA_CallbackIDTypeDef CallbackID
);
808 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
814 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
818 /* IO operation functions *****************************************************/
819 HAL_StatusTypeDef
HAL_IRDA_Transmit(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
, uint32_t Timeout
);
820 HAL_StatusTypeDef
HAL_IRDA_Receive(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
, uint32_t Timeout
);
821 HAL_StatusTypeDef
HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
822 HAL_StatusTypeDef
HAL_IRDA_Receive_IT(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
823 HAL_StatusTypeDef
HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
824 HAL_StatusTypeDef
HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
825 HAL_StatusTypeDef
HAL_IRDA_DMAPause(IRDA_HandleTypeDef
*hirda
);
826 HAL_StatusTypeDef
HAL_IRDA_DMAResume(IRDA_HandleTypeDef
*hirda
);
827 HAL_StatusTypeDef
HAL_IRDA_DMAStop(IRDA_HandleTypeDef
*hirda
);
828 /* Transfer Abort functions */
829 HAL_StatusTypeDef
HAL_IRDA_Abort(IRDA_HandleTypeDef
*hirda
);
830 HAL_StatusTypeDef
HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef
*hirda
);
831 HAL_StatusTypeDef
HAL_IRDA_AbortReceive(IRDA_HandleTypeDef
*hirda
);
832 HAL_StatusTypeDef
HAL_IRDA_Abort_IT(IRDA_HandleTypeDef
*hirda
);
833 HAL_StatusTypeDef
HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef
*hirda
);
834 HAL_StatusTypeDef
HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef
*hirda
);
836 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef
*hirda
);
837 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef
*hirda
);
838 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef
*hirda
);
839 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef
*hirda
);
840 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef
*hirda
);
841 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef
*hirda
);
842 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef
*hirda
);
843 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef
*hirda
);
844 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef
*hirda
);
850 /* Peripheral Control functions ************************************************/
852 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
856 /* Peripheral State and Error functions ***************************************/
857 HAL_IRDA_StateTypeDef
HAL_IRDA_GetState(IRDA_HandleTypeDef
*hirda
);
858 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef
*hirda
);
880 #endif /* STM32G4xx_HAL_IRDA_H */
882 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/