STM32F769IDiscovery  1.00
uDANTE Audio Networking with STM32F7 DISCO board
Macros
IRDA Exported Macros

Macros

#define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
 Reset IRDA handle state. 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_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified IRDA interrupt. More...
 
#define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the specified IRDA interrupt. More...
 
#define __HAL_IRDA_GET_IT(__HANDLE__, __IT__)   ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))
 Check whether the specified IRDA interrupt has occurred or not. More...
 
#define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__)
 Check whether the specified IRDA interrupt source is enabled. 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_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
 Set a specific IRDA request flag. More...
 
#define __HAL_IRDA_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
 Enable UART/USART associated to IRDA Handle. More...
 
#define __HAL_IRDA_DISABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
 Disable UART/USART associated to IRDA Handle. More...
 

Detailed Description

Macro Definition Documentation

#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.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
<strong>IT_CLEAR</strong>specifies the interrupt clear register flag that needs to be set to clear the corresponding interrupt This parameter can be one of the following values:
  • IRDA_CLEAR_PEF: Parity Error Clear Flag
  • IRDA_CLEAR_FEF: Framing Error Clear Flag
  • IRDA_CLEAR_NEF: Noise detected Clear Flag
  • IRDA_CLEAR_OREF: OverRun Error Clear Flag
  • IRDA_CLEAR_TCF: Transmission Complete Clear Flag
Return values
None

Definition at line 510 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)

Disable UART/USART associated to IRDA Handle.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
Return values
None

Definition at line 537 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
(((((uint8_t)(__INTERRUPT__)) >> 5) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & IRDA_IT_MASK))): \
((((uint8_t)(__INTERRUPT__)) >> 5) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & IRDA_IT_MASK))): \
((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & IRDA_IT_MASK))))
#define IRDA_IT_MASK

Disable the specified IRDA interrupt.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
<strong>INTERRUPT</strong>specifies the IRDA interrupt source to disable. This parameter can be one of the following values:
  • IRDA_IT_TXE: Transmit Data Register empty interrupt
  • IRDA_IT_TC: Transmission complete interrupt
  • IRDA_IT_RXNE: Receive Data register not empty interrupt
  • IRDA_IT_IDLE: Idle line detection interrupt
  • IRDA_IT_PE: Parity Error interrupt
  • IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Return values
None

Definition at line 458 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)

Enable UART/USART associated to IRDA Handle.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
Return values
None

Definition at line 530 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
(((((uint8_t)(__INTERRUPT__)) >> 5) == 1)? ((__HANDLE__)->Instance->CR1 |= (1 << ((__INTERRUPT__) & IRDA_IT_MASK))): \
((((uint8_t)(__INTERRUPT__)) >> 5) == 2)? ((__HANDLE__)->Instance->CR2 |= (1 << ((__INTERRUPT__) & IRDA_IT_MASK))): \
((__HANDLE__)->Instance->CR3 |= (1 << ((__INTERRUPT__) & IRDA_IT_MASK))))
#define IRDA_IT_MASK

Enable the specified IRDA interrupt.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2. UART peripheral
<strong>INTERRUPT</strong>specifies the IRDA interrupt source to enable. This parameter can be one of the following values:
  • IRDA_IT_TXE: Transmit Data Register empty interrupt
  • IRDA_IT_TC: Transmission complete interrupt
  • IRDA_IT_RXNE: Receive Data register not empty interrupt
  • IRDA_IT_IDLE: Idle line detection interrupt
  • IRDA_IT_PE: Parity Error interrupt
  • IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Return values
None

Definition at line 441 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))

Check whether the specified IRDA flag is set or not.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2. UART peripheral
<strong>FLAG</strong>specifies the flag to check. This parameter can be one of the following values:
  • IRDA_FLAG_REACK: Receive enable acknowledge flag
  • IRDA_FLAG_TEACK: Transmit enable acknowledge flag
  • IRDA_FLAG_BUSY: Busy flag
  • IRDA_FLAG_ABRF: Auto Baud rate detection flag
  • IRDA_FLAG_ABRE: Auto Baud rate detection error flag
  • IRDA_FLAG_TXE: Transmit data register empty flag
  • IRDA_FLAG_TC: Transmission Complete flag
  • IRDA_FLAG_RXNE: Receive data register not empty flag
  • IRDA_FLAG_IDLE: Idle Line detection flag
  • IRDA_FLAG_ORE: OverRun Error flag
  • IRDA_FLAG_NE: Noise Error flag
  • IRDA_FLAG_FE: Framing Error flag
  • IRDA_FLAG_PE: Parity Error flag
Return values
Thenew state of FLAG (TRUE or FALSE).

Definition at line 425 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_GET_IT (   __HANDLE__,
  __IT__ 
)    ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))

Check whether the specified IRDA interrupt has occurred or not.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
<strong>IT</strong>specifies the IRDA interrupt source to check. This parameter can be one of the following values:
  • IRDA_IT_TXE: Transmit Data Register empty interrupt
  • IRDA_IT_TC: Transmission complete interrupt
  • IRDA_IT_RXNE: Receive Data register not empty interrupt
  • IRDA_IT_IDLE: Idle line detection interrupt
  • IRDA_IT_ORE: OverRun Error interrupt
  • IRDA_IT_NE: Noise Error interrupt
  • IRDA_IT_FE: Framing Error interrupt
  • IRDA_IT_PE: Parity Error interrupt
Return values
Thenew state of IT (TRUE or FALSE).

Definition at line 477 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_GET_IT_SOURCE (   __HANDLE__,
  __IT__ 
)
Value:
((((((uint8_t)(__IT__)) >> 5) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5) == 2)? \
(__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << (((uint16_t)(__IT__)) & IRDA_IT_MASK)))
#define IRDA_IT_MASK

Check whether the specified IRDA interrupt source is enabled.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
<strong>IT</strong>specifies the IRDA interrupt source to check. This parameter can be one of the following values:
  • IRDA_IT_TXE: Transmit Data Register empty interrupt
  • IRDA_IT_TC: Transmission complete interrupt
  • IRDA_IT_RXNE: Receive Data register not empty interrupt
  • IRDA_IT_IDLE: Idle line detection interrupt
  • IRDA_IT_ORE: OverRun Error interrupt
  • IRDA_IT_NE: Noise Error interrupt
  • IRDA_IT_FE: Framing Error interrupt
  • IRDA_IT_PE: Parity Error interrupt
Return values
Thenew state of IT (TRUE or FALSE).

Definition at line 494 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_RESET_HANDLE_STATE (   __HANDLE__)    ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)

Reset IRDA handle state.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
Return values
None

Definition at line 402 of file stm32f7xx_hal_irda.h.

#define __HAL_IRDA_SEND_REQ (   __HANDLE__,
  __REQ__ 
)    ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))

Set a specific IRDA request flag.

Parameters
<strong>HANDLE</strong>specifies the IRDA Handle. The Handle Instance which can be USART1 or USART2.
<strong>REQ</strong>specifies the request flag to set This parameter can be one of the following values:
  • IRDA_AUTOBAUD_REQUEST: Auto-Baud Rate Request
  • IRDA_RXDATA_FLUSH_REQUEST: Receive Data flush Request
  • IRDA_TXDATA_FLUSH_REQUEST: Transmit data flush Request
Return values
None

Definition at line 523 of file stm32f7xx_hal_irda.h.