STM32F439xx HAL User Manual
Defines
USART Exported Macros
USART

Defines

#define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_USART_STATE_RESET)
 Reset USART handle state.
#define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 Checks whether the specified Smartcard flag is set or not.
#define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 Clears the specified Smartcard pending flags.
#define __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 Clear the USART PE pending flag.
#define __HAL_USART_CLEAR_FEFLAG(__HANDLE__)   __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 Clear the USART FE pending flag.
#define __HAL_USART_CLEAR_NEFLAG(__HANDLE__)   __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 Clear the USART NE pending flag.
#define __HAL_USART_CLEAR_OREFLAG(__HANDLE__)   __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 Clear the UART ORE pending flag.
#define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 Clear the USART IDLE pending flag.
#define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enables or disables the specified USART interrupts.
#define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
#define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__)
 Checks whether the specified USART interrupt has occurred or not.
#define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
 Macro to enable the USART's one bit sample method.
#define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
 Macro to disable the USART's one bit sample method.
#define __HAL_USART_ENABLE(__HANDLE__)   ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
 Enable USART.
#define __HAL_USART_DISABLE(__HANDLE__)   ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
 Disable USART.

Define Documentation

#define __HAL_USART_CLEAR_FEFLAG (   __HANDLE__)    __HAL_USART_CLEAR_PEFLAG(__HANDLE__)

Clear the USART FE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 365 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__HANDLE__)->Instance->SR = ~(__FLAG__))

Clears the specified Smartcard pending flags.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
__FLAG__specifies the flag to check. This parameter can be any combination of the following values:
  • USART_FLAG_TC: Transmission Complete flag.
  • USART_FLAG_RXNE: Receive data register not empty flag.
Note:
PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun error) and IDLE (Idle line detected) flags are cleared by software sequence: a read operation to USART_SR register followed by a read operation to USART_DR register.
RXNE flag can be also cleared by a read to the USART_DR register.
TC flag can be also cleared by software sequence: a read operation to USART_SR register followed by a write operation to USART_DR register.
TXE flag is cleared only by a write to the USART_DR register.
Return values:
None

Definition at line 345 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Transmit_DMA(), and HAL_USART_TransmitReceive_DMA().

#define __HAL_USART_CLEAR_IDLEFLAG (   __HANDLE__)    __HAL_USART_CLEAR_PEFLAG(__HANDLE__)

Clear the USART IDLE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 386 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_CLEAR_NEFLAG (   __HANDLE__)    __HAL_USART_CLEAR_PEFLAG(__HANDLE__)

Clear the USART NE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 372 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_CLEAR_OREFLAG (   __HANDLE__)    __HAL_USART_CLEAR_PEFLAG(__HANDLE__)

Clear the UART ORE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 379 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive_DMA(), and HAL_USART_TransmitReceive_DMA().

#define __HAL_USART_CLEAR_PEFLAG (   __HANDLE__)
Value:
do{                                           \
    __IO uint32_t tmpreg = 0x00U;                \
    tmpreg = (__HANDLE__)->Instance->SR;        \
    tmpreg = (__HANDLE__)->Instance->DR;        \
    UNUSED(tmpreg);                             \
  } while(0U)

Clear the USART PE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 352 of file stm32f4xx_hal_usart.h.

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

Disable USART.

Parameters:
__HANDLE__specifies the USART Handle. USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 449 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_DeInit().

#define __HAL_USART_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
                                                            (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
                                                             ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))

Definition at line 405 of file stm32f4xx_hal_usart.h.

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

Enable USART.

Parameters:
__HANDLE__specifies the USART Handle. USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 442 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Init().

#define __HAL_USART_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
                                                            (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 |=  ((__INTERRUPT__) & USART_IT_MASK)): \
                                                             ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))

Enables or disables the specified USART interrupts.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
__INTERRUPT__specifies the USART interrupt source to check. This parameter can be one of the following values:
  • USART_IT_TXE: Transmit Data Register empty interrupt
  • USART_IT_TC: Transmission complete interrupt
  • USART_IT_RXNE: Receive Data register not empty interrupt
  • USART_IT_IDLE: Idle line detection interrupt
  • USART_IT_PE: Parity Error interrupt
  • USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error) This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 402 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))

Checks whether the specified Smartcard flag is set or not.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
__FLAG__specifies the flag to check. This parameter can be one of the following values:
  • USART_FLAG_TXE: Transmit data register empty flag
  • USART_FLAG_TC: Transmission Complete flag
  • USART_FLAG_RXNE: Receive data register not empty flag
  • USART_FLAG_IDLE: Idle Line detection flag
  • USART_FLAG_ORE: Overrun Error flag
  • USART_FLAG_NE: Noise Error flag
  • USART_FLAG_FE: Framing Error flag
  • USART_FLAG_PE: Parity Error flag
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 324 of file stm32f4xx_hal_usart.h.

Referenced by USART_TransmitReceive_IT(), and USART_WaitOnFlagUntilTimeout().

#define __HAL_USART_GET_IT_SOURCE (   __HANDLE__,
  __IT__ 
)
Value:
(((((__IT__) >> 28U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == 2U)? \
                                                      (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))

Checks whether the specified USART interrupt has occurred or not.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
__IT__specifies the USART interrupt source to check. This parameter can be one of the following values:
  • USART_IT_TXE: Transmit Data Register empty interrupt
  • USART_IT_TC: Transmission complete interrupt
  • USART_IT_RXNE: Receive Data register not empty interrupt
  • USART_IT_IDLE: Idle line detection interrupt
  • USART_IT_ERR: Error interrupt
  • USART_IT_PE: Parity Error interrupt
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 422 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_ONE_BIT_SAMPLE_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))

Macro to disable the USART's one bit sample method.

Parameters:
__HANDLE__specifies the USART Handle.
Return values:
None

Definition at line 435 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_ONE_BIT_SAMPLE_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)

Macro to enable the USART's one bit sample method.

Parameters:
__HANDLE__specifies the USART Handle.
Return values:
None

Definition at line 429 of file stm32f4xx_hal_usart.h.

#define __HAL_USART_RESET_HANDLE_STATE (   __HANDLE__)    ((__HANDLE__)->State = HAL_USART_STATE_RESET)

Reset USART handle state.

Parameters:
__HANDLE__specifies the USART Handle. This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Return values:
None

Definition at line 307 of file stm32f4xx_hal_usart.h.