Header file of IRDA HAL module. More...

Go to the source code of this file.
Classes | |
| struct | IRDA_HandleTypeDef | 
| IRDA handle Structure definition.  More... | |
| struct | IRDA_InitTypeDef | 
| IRDA Init Structure definition.  More... | |
Macros | |
| #define | __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF) | 
| Clear the IRDA FE pending flag.  More... | |
| #define | __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) | 
| Clear the specified IRDA pending flag.  More... | |
| #define | __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF) | 
| Clear the IRDA IDLE pending flag.  More... | |
| #define | __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) | 
| Clear the specified IRDA ISR flag, in setting the proper ICR register flag.  More... | |
| #define | __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF) | 
| Clear the IRDA NE pending flag.  More... | |
| #define | __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF) | 
| Clear the IRDA ORE pending flag.  More... | |
| #define | __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF) | 
| Clear the IRDA PE pending flag.  More... | |
| #define | __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) | 
| Disable UART/USART associated to IRDA Handle.  More... | |
| #define | __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) | 
| Disable the specified IRDA interrupt.  More... | |
| #define | __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) | 
| Enable UART/USART associated to IRDA Handle.  More... | |
| #define | __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) | 
| Enable the specified IRDA interrupt.  More... | |
| #define | __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) | 
| Flush the IRDA DR register.  More... | |
| #define | __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) | 
| Check whether the specified IRDA flag is set or not.  More... | |
| #define | __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) | 
| Check whether the specified IRDA interrupt has occurred or not.  More... | |
| #define | __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) | 
| Check whether the specified IRDA interrupt source is enabled or not.  More... | |
| #define | __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) | 
| Disable the IRDA one bit sample method.  More... | |
| #define | __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) | 
| Enable the IRDA one bit sample method.  More... | |
| #define | __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) | 
| Reset IRDA handle state.  More... | |
| #define | __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) | 
| Set a specific IRDA request flag.  More... | |
| #define | HAL_IRDA_ERROR_BUSY ((uint32_t)0x00000020U) | 
| #define | HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010U) | 
| #define | HAL_IRDA_ERROR_FE ((uint32_t)0x00000004U) | 
| #define | HAL_IRDA_ERROR_NE ((uint32_t)0x00000002U) | 
| #define | HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U) | 
| #define | HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008U) | 
| #define | HAL_IRDA_ERROR_PE ((uint32_t)0x00000001U) | 
| #define | HAL_IRDA_STATE_BUSY 0x00000024U | 
| #define | HAL_IRDA_STATE_BUSY_RX 0x00000022U | 
| #define | HAL_IRDA_STATE_BUSY_TX 0x00000021U | 
| #define | HAL_IRDA_STATE_BUSY_TX_RX 0x00000023U | 
| #define | HAL_IRDA_STATE_ERROR 0x000000E0U | 
| #define | HAL_IRDA_STATE_READY 0x00000020U | 
| #define | HAL_IRDA_STATE_RESET 0x00000000U | 
| #define | HAL_IRDA_STATE_TIMEOUT 0x000000A0U | 
| #define | IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ | 
| #define | IRDA_CLEAR_FEF USART_ICR_FECF | 
| #define | IRDA_CLEAR_IDLEF USART_ICR_IDLECF | 
| #define | IRDA_CLEAR_NEF USART_ICR_NCF | 
| #define | IRDA_CLEAR_OREF USART_ICR_ORECF | 
| #define | IRDA_CLEAR_PEF USART_ICR_PECF | 
| #define | IRDA_CLEAR_TCF USART_ICR_TCCF | 
| #define | IRDA_CR_MASK 0x00E0U | 
| #define | IRDA_CR_POS 5U | 
| #define | IRDA_DMA_RX_DISABLE 0x00000000U | 
| #define | IRDA_DMA_RX_ENABLE USART_CR3_DMAR | 
| #define | IRDA_DMA_TX_DISABLE 0x00000000U | 
| #define | IRDA_DMA_TX_ENABLE USART_CR3_DMAT | 
| #define | IRDA_FLAG_ABRE USART_ISR_ABRE | 
| #define | IRDA_FLAG_ABRF USART_ISR_ABRF | 
| #define | IRDA_FLAG_BUSY USART_ISR_BUSY | 
| #define | IRDA_FLAG_FE USART_ISR_FE | 
| #define | IRDA_FLAG_NE USART_ISR_NE | 
| #define | IRDA_FLAG_ORE USART_ISR_ORE | 
| #define | IRDA_FLAG_PE USART_ISR_PE | 
| #define | IRDA_FLAG_RXNE USART_ISR_RXNE | 
| #define | IRDA_FLAG_TC USART_ISR_TC | 
| #define | IRDA_FLAG_TEACK USART_ISR_TEACK | 
| #define | IRDA_FLAG_TXE USART_ISR_TXE | 
| #define | IRDA_ISR_MASK 0x1F00U | 
| #define | IRDA_ISR_POS 8U | 
| #define | IRDA_IT_ERR 0x0060U | 
| #define | IRDA_IT_FE 0x0100U | 
| #define | IRDA_IT_IDLE 0x0424U | 
| #define | IRDA_IT_MASK 0x001FU | 
| #define | IRDA_IT_NE 0x0200U | 
| #define | IRDA_IT_ORE 0x0300U | 
| #define | IRDA_IT_PE 0x0028U | 
| #define | IRDA_IT_RXNE 0x0525U | 
| #define | IRDA_IT_TC 0x0626U | 
| #define | IRDA_IT_TXE 0x0727U | 
| #define | IRDA_MODE_DISABLE 0x00000000U | 
| #define | IRDA_MODE_ENABLE USART_CR3_IREN | 
| #define | IRDA_MODE_RX USART_CR1_RE | 
| #define | IRDA_MODE_TX USART_CR1_TE | 
| #define | IRDA_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) | 
| #define | IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U | 
| #define | IRDA_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT | 
| #define | IRDA_PARITY_EVEN USART_CR1_PCE | 
| #define | IRDA_PARITY_NONE 0x00000000U | 
| #define | IRDA_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) | 
| #define | IRDA_POWERMODE_LOWPOWER USART_CR3_IRLP | 
| #define | IRDA_POWERMODE_NORMAL 0x00000000U | 
| #define | IRDA_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ | 
| #define | IRDA_STATE_DISABLE 0x00000000U | 
| #define | IRDA_STATE_ENABLE USART_CR1_UE | 
| #define | IRDA_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ | 
| #define | IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U) | 
| Ensure that IRDA Baud rate is less or equal to maximum value.  More... | |
| #define | IS_IRDA_DMA_RX(__DMARX__) | 
| Ensure that IRDA DMA RX mode is valid.  More... | |
| #define | IS_IRDA_DMA_TX(__DMATX__) | 
| Ensure that IRDA DMA TX mode is valid.  More... | |
| #define | IS_IRDA_MODE(__MODE__) | 
| Ensure that IRDA associated UART/USART mode is valid.  More... | |
| #define | IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) | 
| Ensure that IRDA sampling rate is valid.  More... | |
| #define | IS_IRDA_PARITY(__PARITY__) | 
| Ensure that IRDA frame parity is valid.  More... | |
| #define | IS_IRDA_POWERMODE(__MODE__) | 
| Ensure that IRDA power mode is valid.  More... | |
| #define | IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U) | 
| Ensure that IRDA prescaler value is strictly larger than 0.  More... | |
| #define | IS_IRDA_REQUEST_PARAMETER(__PARAM__) | 
| Ensure that IRDA request is valid.  More... | |
| #define | IS_IRDA_STATE(__STATE__) | 
| Ensure that IRDA state is valid.  More... | |
| #define | IS_IRDA_TX_RX_MODE(__MODE__) | 
| Ensure that IRDA communication mode is valid.  More... | |
Typedefs | |
| typedef uint32_t | HAL_IRDA_StateTypeDef | 
| HAL IRDA State definition.  More... | |
Enumerations | |
| enum | IRDA_ClockSourceTypeDef {  IRDA_CLOCKSOURCE_PCLK1 = 0x00U, IRDA_CLOCKSOURCE_PCLK2 = 0x01U, IRDA_CLOCKSOURCE_HSI = 0x02U, IRDA_CLOCKSOURCE_SYSCLK = 0x04U, IRDA_CLOCKSOURCE_LSE = 0x10U, IRDA_CLOCKSOURCE_UNDEFINED = 0x20U }  | 
| IRDA clock sources definition.  More... | |
Header file of IRDA HAL module.
This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause
Definition in file stm32f7xx_hal_irda.h.