2 ******************************************************************************
3 * @file stm32f7xx_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 STM32F7xx_HAL_IRDA_H
22 #define STM32F7xx_HAL_IRDA_H
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f7xx_hal_def.h"
31 /** @addtogroup STM32F7xx_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_clk) / ((hirda->Init.BaudRate)))
52 where usart_ker_clk is the IRDA input clock */
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 */
77 * @brief HAL IRDA State definition
78 * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState (see @ref IRDA_State_Definition).
79 * - gState contains IRDA state information related to global Handle management
80 * and also information related to Tx operations.
81 * gState value coding follow below described bitmap :
82 * b7-b6 Error information
87 * b5 Peripheral initialization status
88 * 0 : Reset (Peripheral not initialized)
89 * 1 : Init done (Peripheral not initialized. HAL IRDA Init function already called)
91 * xx : Should be set to 00
92 * b2 Intrinsic process state
94 * 1 : Busy (Peripheral busy with some configuration or internal operations)
96 * x : Should be set to 0
98 * 0 : Ready (no Tx operation ongoing)
99 * 1 : Busy (Tx operation ongoing)
100 * - RxState contains information related to Rx operations.
101 * RxState value coding follow below described bitmap :
103 * xx : Should be set to 00
104 * b5 Peripheral initialization status
105 * 0 : Reset (Peripheral not initialized)
106 * 1 : Init done (Peripheral not initialized)
108 * xxx : Should be set to 000
110 * 0 : Ready (no Rx operation ongoing)
111 * 1 : Busy (Rx operation ongoing)
113 * x : Should be set to 0.
115 typedef uint32_t HAL_IRDA_StateTypeDef
;
118 * @brief IRDA clock sources definition
122 IRDA_CLOCKSOURCE_PCLK1
= 0x00U
, /*!< PCLK1 clock source */
123 IRDA_CLOCKSOURCE_PCLK2
= 0x01U
, /*!< PCLK2 clock source */
124 IRDA_CLOCKSOURCE_HSI
= 0x02U
, /*!< HSI clock source */
125 IRDA_CLOCKSOURCE_SYSCLK
= 0x04U
, /*!< SYSCLK clock source */
126 IRDA_CLOCKSOURCE_LSE
= 0x10U
, /*!< LSE clock source */
127 IRDA_CLOCKSOURCE_UNDEFINED
= 0x20U
/*!< Undefined clock source */
128 } IRDA_ClockSourceTypeDef
;
131 * @brief IRDA handle Structure definition
133 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
134 typedef struct __IRDA_HandleTypeDef
137 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
139 USART_TypeDef
*Instance
; /*!< USART registers base address */
141 IRDA_InitTypeDef Init
; /*!< IRDA communication parameters */
143 uint8_t *pTxBuffPtr
; /*!< Pointer to IRDA Tx transfer Buffer */
145 uint16_t TxXferSize
; /*!< IRDA Tx Transfer size */
147 __IO
uint16_t TxXferCount
; /*!< IRDA Tx Transfer Counter */
149 uint8_t *pRxBuffPtr
; /*!< Pointer to IRDA Rx transfer Buffer */
151 uint16_t RxXferSize
; /*!< IRDA Rx Transfer size */
153 __IO
uint16_t RxXferCount
; /*!< IRDA Rx Transfer Counter */
155 uint16_t Mask
; /*!< USART RX RDR register mask */
157 DMA_HandleTypeDef
*hdmatx
; /*!< IRDA Tx DMA Handle parameters */
159 DMA_HandleTypeDef
*hdmarx
; /*!< IRDA Rx DMA Handle parameters */
161 HAL_LockTypeDef Lock
; /*!< Locking object */
163 __IO HAL_IRDA_StateTypeDef gState
; /*!< IRDA state information related to global Handle management
164 and also related to Tx operations.
165 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
167 __IO HAL_IRDA_StateTypeDef RxState
; /*!< IRDA state information related to Rx operations.
168 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
170 __IO
uint32_t ErrorCode
; /*!< IRDA Error code */
172 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
173 void (* TxHalfCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Tx Half Complete Callback */
175 void (* TxCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Tx Complete Callback */
177 void (* RxHalfCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Rx Half Complete Callback */
179 void (* RxCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Rx Complete Callback */
181 void (* ErrorCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Error Callback */
183 void (* AbortCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Complete Callback */
185 void (* AbortTransmitCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Transmit Complete Callback */
187 void (* AbortReceiveCpltCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Abort Receive Complete Callback */
190 void (* MspInitCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Msp Init callback */
192 void (* MspDeInitCallback
)(struct __IRDA_HandleTypeDef
*hirda
); /*!< IRDA Msp DeInit callback */
193 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
195 } IRDA_HandleTypeDef
;
197 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
199 * @brief HAL IRDA Callback ID enumeration definition
203 HAL_IRDA_TX_HALFCOMPLETE_CB_ID
= 0x00U
, /*!< IRDA Tx Half Complete Callback ID */
204 HAL_IRDA_TX_COMPLETE_CB_ID
= 0x01U
, /*!< IRDA Tx Complete Callback ID */
205 HAL_IRDA_RX_HALFCOMPLETE_CB_ID
= 0x02U
, /*!< IRDA Rx Half Complete Callback ID */
206 HAL_IRDA_RX_COMPLETE_CB_ID
= 0x03U
, /*!< IRDA Rx Complete Callback ID */
207 HAL_IRDA_ERROR_CB_ID
= 0x04U
, /*!< IRDA Error Callback ID */
208 HAL_IRDA_ABORT_COMPLETE_CB_ID
= 0x05U
, /*!< IRDA Abort Complete Callback ID */
209 HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID
= 0x06U
, /*!< IRDA Abort Transmit Complete Callback ID */
210 HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID
= 0x07U
, /*!< IRDA Abort Receive Complete Callback ID */
212 HAL_IRDA_MSPINIT_CB_ID
= 0x08U
, /*!< IRDA MspInit callback ID */
213 HAL_IRDA_MSPDEINIT_CB_ID
= 0x09U
/*!< IRDA MspDeInit callback ID */
215 } HAL_IRDA_CallbackIDTypeDef
;
218 * @brief HAL IRDA Callback pointer definition
220 typedef void (*pIRDA_CallbackTypeDef
)(IRDA_HandleTypeDef
*hirda
); /*!< pointer to an IRDA callback function */
222 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
228 /* Exported constants --------------------------------------------------------*/
229 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
233 /** @defgroup IRDA_State_Definition IRDA State Code Definition
236 #define HAL_IRDA_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
237 Value is allowed for gState and RxState */
238 #define HAL_IRDA_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
239 Value is allowed for gState and RxState */
240 #define HAL_IRDA_STATE_BUSY 0x00000024U /*!< An internal process is ongoing
241 Value is allowed for gState only */
242 #define HAL_IRDA_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
243 Value is allowed for gState only */
244 #define HAL_IRDA_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
245 Value is allowed for RxState only */
246 #define HAL_IRDA_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
247 Not to be used for neither gState nor RxState.
248 Value is result of combination (Or) between gState and RxState values */
249 #define HAL_IRDA_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
250 Value is allowed for gState only */
251 #define HAL_IRDA_STATE_ERROR 0x000000E0U /*!< Error
252 Value is allowed for gState only */
257 /** @defgroup IRDA_Error_Definition IRDA Error Code Definition
260 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
261 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
262 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
263 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */
264 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
265 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
266 #define HAL_IRDA_ERROR_BUSY ((uint32_t)0x00000020U) /*!< Busy Error */
267 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
268 #define HAL_IRDA_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
269 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
274 /** @defgroup IRDA_Parity IRDA Parity
277 #define IRDA_PARITY_NONE 0x00000000U /*!< No parity */
278 #define IRDA_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
279 #define IRDA_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
284 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
287 #define IRDA_MODE_RX USART_CR1_RE /*!< RX mode */
288 #define IRDA_MODE_TX USART_CR1_TE /*!< TX mode */
289 #define IRDA_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
294 /** @defgroup IRDA_Low_Power IRDA Low Power
297 #define IRDA_POWERMODE_NORMAL 0x00000000U /*!< IRDA normal power mode */
298 #define IRDA_POWERMODE_LOWPOWER USART_CR3_IRLP /*!< IRDA low power mode */
303 /** @defgroup IRDA_State IRDA State
306 #define IRDA_STATE_DISABLE 0x00000000U /*!< IRDA disabled */
307 #define IRDA_STATE_ENABLE USART_CR1_UE /*!< IRDA enabled */
312 /** @defgroup IRDA_Mode IRDA Mode
315 #define IRDA_MODE_DISABLE 0x00000000U /*!< Associated UART disabled in IRDA mode */
316 #define IRDA_MODE_ENABLE USART_CR3_IREN /*!< Associated UART enabled in IRDA mode */
321 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
324 #define IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disabled */
325 #define IRDA_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enabled */
330 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
333 #define IRDA_DMA_TX_DISABLE 0x00000000U /*!< IRDA DMA TX disabled */
334 #define IRDA_DMA_TX_ENABLE USART_CR3_DMAT /*!< IRDA DMA TX enabled */
339 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
342 #define IRDA_DMA_RX_DISABLE 0x00000000U /*!< IRDA DMA RX disabled */
343 #define IRDA_DMA_RX_ENABLE USART_CR3_DMAR /*!< IRDA DMA RX enabled */
348 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
351 #define IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
352 #define IRDA_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
353 #define IRDA_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
358 /** @defgroup IRDA_Flags IRDA Flags
359 * Elements values convention: 0xXXXX
360 * - 0xXXXX : Flag mask in the ISR register
363 #define IRDA_FLAG_TEACK USART_ISR_TEACK /*!< IRDA transmit enable acknowledge flag */
364 #define IRDA_FLAG_BUSY USART_ISR_BUSY /*!< IRDA busy flag */
365 #define IRDA_FLAG_ABRF USART_ISR_ABRF /*!< IRDA auto Baud rate flag */
366 #define IRDA_FLAG_ABRE USART_ISR_ABRE /*!< IRDA auto Baud rate error */
367 #define IRDA_FLAG_TXE USART_ISR_TXE /*!< IRDA transmit data register empty */
368 #define IRDA_FLAG_TC USART_ISR_TC /*!< IRDA transmission complete */
369 #define IRDA_FLAG_RXNE USART_ISR_RXNE /*!< IRDA read data register not empty */
370 #define IRDA_FLAG_ORE USART_ISR_ORE /*!< IRDA overrun error */
371 #define IRDA_FLAG_NE USART_ISR_NE /*!< IRDA noise error */
372 #define IRDA_FLAG_FE USART_ISR_FE /*!< IRDA frame error */
373 #define IRDA_FLAG_PE USART_ISR_PE /*!< IRDA parity error */
378 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
379 * Elements values convention: 0000ZZZZ0XXYYYYYb
380 * - YYYYY : Interrupt source position in the XX register (5bits)
381 * - XX : Interrupt source register (2bits)
385 * - ZZZZ : Flag position in the ISR register(4bits)
388 #define IRDA_IT_PE 0x0028U /*!< IRDA Parity error interruption */
389 #define IRDA_IT_TXE 0x0727U /*!< IRDA Transmit data register empty interruption */
390 #define IRDA_IT_TC 0x0626U /*!< IRDA Transmission complete interruption */
391 #define IRDA_IT_RXNE 0x0525U /*!< IRDA Read data register not empty interruption */
392 #define IRDA_IT_IDLE 0x0424U /*!< IRDA Idle interruption */
394 /* Elements values convention: 000000000XXYYYYYb
395 - YYYYY : Interrupt source position in the XX register (5bits)
396 - XX : Interrupt source register (2bits)
399 - 11: CR3 register */
400 #define IRDA_IT_ERR 0x0060U /*!< IRDA Error interruption */
402 /* Elements values convention: 0000ZZZZ00000000b
403 - ZZZZ : Flag position in the ISR register(4bits) */
404 #define IRDA_IT_ORE 0x0300U /*!< IRDA Overrun error interruption */
405 #define IRDA_IT_NE 0x0200U /*!< IRDA Noise error interruption */
406 #define IRDA_IT_FE 0x0100U /*!< IRDA Frame error interruption */
411 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
414 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
415 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
416 #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise Error detected Clear Flag */
417 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
418 #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
419 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
424 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
427 #define IRDA_IT_MASK 0x001FU /*!< IRDA Interruptions flags mask */
428 #define IRDA_CR_MASK 0x00E0U /*!< IRDA control register mask */
429 #define IRDA_CR_POS 5U /*!< IRDA control register position */
430 #define IRDA_ISR_MASK 0x1F00U /*!< IRDA ISR register mask */
431 #define IRDA_ISR_POS 8U /*!< IRDA ISR register position */
440 /* Exported macros -----------------------------------------------------------*/
441 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
445 /** @brief Reset IRDA handle state.
446 * @param __HANDLE__ IRDA handle.
449 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1
450 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
451 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
452 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
453 (__HANDLE__)->MspInitCallback = NULL; \
454 (__HANDLE__)->MspDeInitCallback = NULL; \
457 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
458 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
459 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
461 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS */
463 /** @brief Flush the IRDA DR register.
464 * @param __HANDLE__ specifies the IRDA Handle.
467 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \
469 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
470 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
473 /** @brief Clear the specified IRDA pending flag.
474 * @param __HANDLE__ specifies the IRDA Handle.
475 * @param __FLAG__ specifies the flag to check.
476 * This parameter can be any combination of the following values:
477 * @arg @ref IRDA_CLEAR_PEF
478 * @arg @ref IRDA_CLEAR_FEF
479 * @arg @ref IRDA_CLEAR_NEF
480 * @arg @ref IRDA_CLEAR_OREF
481 * @arg @ref IRDA_CLEAR_TCF
482 * @arg @ref IRDA_CLEAR_IDLEF
485 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
487 /** @brief Clear the IRDA PE pending flag.
488 * @param __HANDLE__ specifies the IRDA Handle.
491 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
494 /** @brief Clear the IRDA FE pending flag.
495 * @param __HANDLE__ specifies the IRDA Handle.
498 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
500 /** @brief Clear the IRDA NE pending flag.
501 * @param __HANDLE__ specifies the IRDA Handle.
504 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
506 /** @brief Clear the IRDA ORE pending flag.
507 * @param __HANDLE__ specifies the IRDA Handle.
510 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
512 /** @brief Clear the IRDA IDLE pending flag.
513 * @param __HANDLE__ specifies the IRDA Handle.
516 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
518 /** @brief Check whether the specified IRDA flag is set or not.
519 * @param __HANDLE__ specifies the IRDA Handle.
520 * @param __FLAG__ specifies the flag to check.
521 * This parameter can be one of the following values:
522 * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
523 * @arg @ref IRDA_FLAG_BUSY Busy flag
524 * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag
525 * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag
526 * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag
527 * @arg @ref IRDA_FLAG_TC Transmission Complete flag
528 * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag
529 * @arg @ref IRDA_FLAG_ORE OverRun Error flag
530 * @arg @ref IRDA_FLAG_NE Noise Error flag
531 * @arg @ref IRDA_FLAG_FE Framing Error flag
532 * @arg @ref IRDA_FLAG_PE Parity Error flag
533 * @retval The new state of __FLAG__ (TRUE or FALSE).
535 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
538 /** @brief Enable the specified IRDA interrupt.
539 * @param __HANDLE__ specifies the IRDA Handle.
540 * @param __INTERRUPT__ specifies the IRDA interrupt source to enable.
541 * This parameter can be one of the following values:
542 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
543 * @arg @ref IRDA_IT_TC Transmission complete interrupt
544 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
545 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
546 * @arg @ref IRDA_IT_PE Parity Error interrupt
547 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
550 #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))): \
551 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
552 ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
554 /** @brief Disable the specified IRDA interrupt.
555 * @param __HANDLE__ specifies the IRDA Handle.
556 * @param __INTERRUPT__ specifies the IRDA interrupt source to disable.
557 * This parameter can be one of the following values:
558 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
559 * @arg @ref IRDA_IT_TC Transmission complete interrupt
560 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
561 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
562 * @arg @ref IRDA_IT_PE Parity Error interrupt
563 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
566 #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))): \
567 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
568 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
571 /** @brief Check whether the specified IRDA interrupt has occurred or not.
572 * @param __HANDLE__ specifies the IRDA Handle.
573 * @param __INTERRUPT__ specifies the IRDA interrupt source to check.
574 * This parameter can be one of the following values:
575 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
576 * @arg @ref IRDA_IT_TC Transmission complete interrupt
577 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
578 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
579 * @arg @ref IRDA_IT_ORE OverRun Error interrupt
580 * @arg @ref IRDA_IT_NE Noise Error interrupt
581 * @arg @ref IRDA_IT_FE Framing Error interrupt
582 * @arg @ref IRDA_IT_PE Parity Error interrupt
583 * @retval The new state of __IT__ (SET or RESET).
585 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & (0x01U << (((__INTERRUPT__) & IRDA_ISR_MASK)>> IRDA_ISR_POS))) != 0U) ? SET : RESET)
587 /** @brief Check whether the specified IRDA interrupt source is enabled or not.
588 * @param __HANDLE__ specifies the IRDA Handle.
589 * @param __INTERRUPT__ specifies the IRDA interrupt source to check.
590 * This parameter can be one of the following values:
591 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
592 * @arg @ref IRDA_IT_TC Transmission complete interrupt
593 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
594 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
595 * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
596 * @arg @ref IRDA_IT_PE Parity Error interrupt
597 * @retval The new state of __IT__ (SET or RESET).
599 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 : \
600 (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 0x02U)? (__HANDLE__)->Instance->CR2 : \
601 (__HANDLE__)->Instance->CR3)) & ((uint32_t)0x01U << (((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != 0U) ? SET : RESET)
603 /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
604 * @param __HANDLE__ specifies the IRDA Handle.
605 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
606 * to clear the corresponding interrupt
607 * This parameter can be one of the following values:
608 * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
609 * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
610 * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
611 * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
612 * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
615 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
618 /** @brief Set a specific IRDA request flag.
619 * @param __HANDLE__ specifies the IRDA Handle.
620 * @param __REQ__ specifies the request flag to set
621 * This parameter can be one of the following values:
622 * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
623 * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
624 * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
627 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
629 /** @brief Enable the IRDA one bit sample method.
630 * @param __HANDLE__ specifies the IRDA Handle.
633 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
635 /** @brief Disable the IRDA one bit sample method.
636 * @param __HANDLE__ specifies the IRDA Handle.
639 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
641 /** @brief Enable UART/USART associated to IRDA Handle.
642 * @param __HANDLE__ specifies the IRDA Handle.
645 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
647 /** @brief Disable UART/USART associated to IRDA Handle.
648 * @param __HANDLE__ specifies the IRDA Handle.
651 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
657 /* Private macros --------------------------------------------------------*/
658 /** @addtogroup IRDA_Private_Macros
662 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value.
663 * @param __BAUDRATE__ specifies the IRDA Baudrate set by the user.
664 * @retval True or False
666 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U)
668 /** @brief Ensure that IRDA prescaler value is strictly larger than 0.
669 * @param __PRESCALER__ specifies the IRDA prescaler value set by the user.
670 * @retval True or False
672 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U)
674 /** @brief Ensure that IRDA frame parity is valid.
675 * @param __PARITY__ IRDA frame parity.
676 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
678 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
679 ((__PARITY__) == IRDA_PARITY_EVEN) || \
680 ((__PARITY__) == IRDA_PARITY_ODD))
682 /** @brief Ensure that IRDA communication mode is valid.
683 * @param __MODE__ IRDA communication mode.
684 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
686 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
688 /** @brief Ensure that IRDA power mode is valid.
689 * @param __MODE__ IRDA power mode.
690 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
692 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
693 ((__MODE__) == IRDA_POWERMODE_NORMAL))
695 /** @brief Ensure that IRDA state is valid.
696 * @param __STATE__ IRDA state mode.
697 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
699 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
700 ((__STATE__) == IRDA_STATE_ENABLE))
702 /** @brief Ensure that IRDA associated UART/USART mode is valid.
703 * @param __MODE__ IRDA associated UART/USART mode.
704 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
706 #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \
707 ((__MODE__) == IRDA_MODE_ENABLE))
709 /** @brief Ensure that IRDA sampling rate is valid.
710 * @param __ONEBIT__ IRDA sampling rate.
711 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
713 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
714 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
716 /** @brief Ensure that IRDA DMA TX mode is valid.
717 * @param __DMATX__ IRDA DMA TX mode.
718 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
720 #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
721 ((__DMATX__) == IRDA_DMA_TX_ENABLE))
723 /** @brief Ensure that IRDA DMA RX mode is valid.
724 * @param __DMARX__ IRDA DMA RX mode.
725 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
727 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
728 ((__DMARX__) == IRDA_DMA_RX_ENABLE))
730 /** @brief Ensure that IRDA request is valid.
731 * @param __PARAM__ IRDA request.
732 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
734 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
735 ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
736 ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
741 /* Include IRDA HAL Extended module */
742 #include "stm32f7xx_hal_irda_ex.h"
744 /* Exported functions --------------------------------------------------------*/
745 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
749 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
753 /* Initialization and de-initialization functions ****************************/
754 HAL_StatusTypeDef
HAL_IRDA_Init(IRDA_HandleTypeDef
*hirda
);
755 HAL_StatusTypeDef
HAL_IRDA_DeInit(IRDA_HandleTypeDef
*hirda
);
756 void HAL_IRDA_MspInit(IRDA_HandleTypeDef
*hirda
);
757 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef
*hirda
);
759 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
760 /* Callbacks Register/UnRegister functions ***********************************/
761 HAL_StatusTypeDef
HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef
*hirda
, HAL_IRDA_CallbackIDTypeDef CallbackID
, pIRDA_CallbackTypeDef pCallback
);
762 HAL_StatusTypeDef
HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef
*hirda
, HAL_IRDA_CallbackIDTypeDef CallbackID
);
763 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
769 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
773 /* IO operation functions *****************************************************/
774 HAL_StatusTypeDef
HAL_IRDA_Transmit(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
, uint32_t Timeout
);
775 HAL_StatusTypeDef
HAL_IRDA_Receive(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
, uint32_t Timeout
);
776 HAL_StatusTypeDef
HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
777 HAL_StatusTypeDef
HAL_IRDA_Receive_IT(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
778 HAL_StatusTypeDef
HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
779 HAL_StatusTypeDef
HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef
*hirda
, uint8_t *pData
, uint16_t Size
);
780 HAL_StatusTypeDef
HAL_IRDA_DMAPause(IRDA_HandleTypeDef
*hirda
);
781 HAL_StatusTypeDef
HAL_IRDA_DMAResume(IRDA_HandleTypeDef
*hirda
);
782 HAL_StatusTypeDef
HAL_IRDA_DMAStop(IRDA_HandleTypeDef
*hirda
);
783 /* Transfer Abort functions */
784 HAL_StatusTypeDef
HAL_IRDA_Abort(IRDA_HandleTypeDef
*hirda
);
785 HAL_StatusTypeDef
HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef
*hirda
);
786 HAL_StatusTypeDef
HAL_IRDA_AbortReceive(IRDA_HandleTypeDef
*hirda
);
787 HAL_StatusTypeDef
HAL_IRDA_Abort_IT(IRDA_HandleTypeDef
*hirda
);
788 HAL_StatusTypeDef
HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef
*hirda
);
789 HAL_StatusTypeDef
HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef
*hirda
);
791 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef
*hirda
);
792 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef
*hirda
);
793 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef
*hirda
);
794 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef
*hirda
);
795 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef
*hirda
);
796 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef
*hirda
);
797 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef
*hirda
);
798 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef
*hirda
);
799 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef
*hirda
);
805 /* Peripheral Control functions ************************************************/
807 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
811 /* Peripheral State and Error functions ***************************************/
812 HAL_IRDA_StateTypeDef
HAL_IRDA_GetState(IRDA_HandleTypeDef
*hirda
);
813 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef
*hirda
);
835 #endif /* STM32F7xx_HAL_IRDA_H */
837 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/