UART Exported Macros

Macros
#define	__HAL_UART_RESET_HANDLE_STATE(__HANDLE__)
	Reset UART handle states.
#define	__HAL_UART_FLUSH_DRREGISTER(__HANDLE__)
	Flush the UART Data registers.
#define	__HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
	Clear the specified UART pending flag.
#define	__HAL_UART_CLEAR_PEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
	Clear the UART PE pending flag.
#define	__HAL_UART_CLEAR_FEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
	Clear the UART FE pending flag.
#define	__HAL_UART_CLEAR_NEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
	Clear the UART NE pending flag.
#define	__HAL_UART_CLEAR_OREFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
	Clear the UART ORE pending flag.
#define	__HAL_UART_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
	Clear the UART IDLE pending flag.
#define	__HAL_UART_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
	Check whether the specified UART flag is set or not.
#define	__HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified UART interrupt.
#define	__HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified UART interrupt.
#define	__HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified UART interrupt has occurred or not.
#define	__HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified UART interrupt source is enabled or not.
#define	__HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
	Clear the specified UART ISR flag, in setting the proper ICR register flag.
#define	__HAL_UART_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
	Set a specific UART request flag.
#define	__HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
	Enable the UART one bit sample method.
#define	__HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
	Disable the UART one bit sample method.
#define	__HAL_UART_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
	Enable UART.
#define	__HAL_UART_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
	Disable UART.
#define	__HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__)
	Enable CTS flow control.
#define	__HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__)
	Disable CTS flow control.
#define	__HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__)
	Enable RTS flow control.
#define	__HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__)
	Disable RTS flow control.

Detailed Description

Macro Definition Documentation

__HAL_UART_CLEAR_FEFLAG

#define __HAL_UART_CLEAR_FEFLAG

(

__HANDLE__

)

__HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)

Clear the UART FE pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_CLEAR_FLAG

#define __HAL_UART_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__
	)		((__HANDLE__)->Instance->ICR = (__FLAG__))

Clear the specified UART pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

__FLAG__

specifies the flag to check. This parameter can be any combination of the following values: UART_CLEAR_PEF Parity Error Clear Flag UART_CLEAR_FEF Framing Error Clear Flag UART_CLEAR_NEF Noise detected Clear Flag UART_CLEAR_OREF Overrun Error Clear Flag UART_CLEAR_IDLEF IDLE line detected Clear Flag UART_CLEAR_TCF Transmission Complete Clear Flag UART_CLEAR_RTOF Receiver Timeout clear flag UART_CLEAR_LBDF LIN Break Detection Clear Flag UART_CLEAR_CTSF CTS Interrupt Clear Flag UART_CLEAR_CMF Character Match Clear Flag UART_CLEAR_WUF Wake Up from stop mode Clear Flag

Return values

None

__HAL_UART_CLEAR_IDLEFLAG

#define __HAL_UART_CLEAR_IDLEFLAG

(

__HANDLE__

)

__HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)

Clear the UART IDLE pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_CLEAR_IT

#define __HAL_UART_CLEAR_IT	(		__HANDLE__,
			__IT_CLEAR__
	)		((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))

Clear the specified UART ISR flag, in setting the proper ICR register flag.

Parameters

__HANDLE__

specifies the UART Handle.

__IT_CLEAR__

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: UART_CLEAR_PEF Parity Error Clear Flag UART_CLEAR_FEF Framing Error Clear Flag UART_CLEAR_NEF Noise detected Clear Flag UART_CLEAR_OREF Overrun Error Clear Flag UART_CLEAR_IDLEF IDLE line detected Clear Flag UART_CLEAR_RTOF Receiver timeout clear flag UART_CLEAR_TCF Transmission Complete Clear Flag UART_CLEAR_LBDF LIN Break Detection Clear Flag UART_CLEAR_CTSF CTS Interrupt Clear Flag UART_CLEAR_CMF Character Match Clear Flag UART_CLEAR_WUF Wake Up from stop mode Clear Flag

Return values

None

__HAL_UART_CLEAR_NEFLAG

#define __HAL_UART_CLEAR_NEFLAG

(

__HANDLE__

)

__HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)

Clear the UART NE pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_CLEAR_OREFLAG

#define __HAL_UART_CLEAR_OREFLAG

(

__HANDLE__

)

__HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)

Clear the UART ORE pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_CLEAR_PEFLAG

#define __HAL_UART_CLEAR_PEFLAG

(

__HANDLE__

)

__HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)

Clear the UART PE pending flag.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_DISABLE

#define __HAL_UART_DISABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)

Disable UART.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_DISABLE_IT

#define __HAL_UART_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                           (\
                                                           ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
                                                           ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))): \
                                                           ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
                                                           ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))): \
                                                           ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))))

Disable the specified UART interrupt.

Parameters

__HANDLE__

specifies the UART Handle.

__INTERRUPT__

specifies the UART interrupt source to disable. This parameter can be one of the following values: UART_IT_WUF Wakeup from stop mode interrupt UART_IT_CM Character match interrupt UART_IT_CTS CTS change interrupt UART_IT_LBD LIN Break detection interrupt UART_IT_TXE Transmit Data Register empty interrupt UART_IT_TC Transmission complete interrupt UART_IT_RXNE Receive Data register not empty interrupt UART_IT_RTO Receive Timeout interrupt UART_IT_IDLE Idle line detection interrupt UART_IT_PE Parity Error interrupt UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)

Return values

None

__HAL_UART_ENABLE

#define __HAL_UART_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)

Enable UART.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_ENABLE_IT

#define __HAL_UART_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                           (\
                                                           ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
                                                           ((__HANDLE__)->Instance->CR1 |= (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))): \
                                                           ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
                                                           ((__HANDLE__)->Instance->CR2 |= (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))): \
                                                           ((__HANDLE__)->Instance->CR3 |= (1U <<\
                                                               ((__INTERRUPT__) & UART_IT_MASK))))

Enable the specified UART interrupt.

Parameters

__HANDLE__

specifies the UART Handle.

__INTERRUPT__

specifies the UART interrupt source to enable. This parameter can be one of the following values: UART_IT_WUF Wakeup from stop mode interrupt UART_IT_CM Character match interrupt UART_IT_CTS CTS change interrupt UART_IT_LBD LIN Break detection interrupt UART_IT_TXE Transmit Data Register empty interrupt UART_IT_TC Transmission complete interrupt UART_IT_RXNE Receive Data register not empty interrupt UART_IT_RTO Receive Timeout interrupt UART_IT_IDLE Idle line detection interrupt UART_IT_PE Parity Error interrupt UART_IT_ERR Error interrupt (frame error, noise error, overrun error)

Return values

None

__HAL_UART_FLUSH_DRREGISTER

#define __HAL_UART_FLUSH_DRREGISTER

(

__HANDLE__

)

Value:

  do{                \
    SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \
    SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \
  }  while(0U)

Flush the UART Data registers.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_GET_FLAG

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

Check whether the specified UART flag is set or not.

Parameters

__HANDLE__

specifies the UART Handle.

__FLAG__

specifies the flag to check. This parameter can be one of the following values: UART_FLAG_REACK Receive enable acknowledge flag UART_FLAG_TEACK Transmit enable acknowledge flag UART_FLAG_WUF Wake up from stop mode flag UART_FLAG_RWU Receiver wake up flag (if the UART in mute mode) UART_FLAG_SBKF Send Break flag UART_FLAG_CMF Character match flag UART_FLAG_BUSY Busy flag UART_FLAG_ABRF Auto Baud rate detection flag UART_FLAG_ABRE Auto Baud rate detection error flag UART_FLAG_CTS CTS Change flag UART_FLAG_LBDF LIN Break detection flag UART_FLAG_TXE Transmit data register empty flag UART_FLAG_TC Transmission Complete flag UART_FLAG_RXNE Receive data register not empty flag UART_FLAG_RTOF Receiver Timeout flag UART_FLAG_IDLE Idle Line detection flag UART_FLAG_ORE Overrun Error flag UART_FLAG_NE Noise Error flag UART_FLAG_FE Framing Error flag UART_FLAG_PE Parity Error flag

Return values

The	new state of FLAG (TRUE or FALSE).

__HAL_UART_GET_IT

#define __HAL_UART_GET_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                        ((((__HANDLE__)->Instance->ISR\
                                                        & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)

Check whether the specified UART interrupt has occurred or not.

Parameters

__HANDLE__

specifies the UART Handle.

__INTERRUPT__

specifies the UART interrupt to check. This parameter can be one of the following values: UART_IT_WUF Wakeup from stop mode interrupt UART_IT_CM Character match interrupt UART_IT_CTS CTS change interrupt UART_IT_LBD LIN Break detection interrupt UART_IT_TXE Transmit Data Register empty interrupt UART_IT_TC Transmission complete interrupt UART_IT_RXNE Receive Data register not empty interrupt UART_IT_RTO Receive Timeout interrupt UART_IT_IDLE Idle line detection interrupt UART_IT_PE Parity Error interrupt UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)

Return values

The	new state of INTERRUPT (SET or RESET).

__HAL_UART_GET_IT_SOURCE

#define __HAL_UART_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                                ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ?\
                                                                (__HANDLE__)->Instance->CR1 : \
                                                                (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ?\
                                                                 (__HANDLE__)->Instance->CR2 : \
                                                                 (__HANDLE__)->Instance->CR3)) & (1U <<\
                                                                     (((uint16_t)(__INTERRUPT__)) &\
                                                                      UART_IT_MASK)))  != RESET) ? SET : RESET)

Check whether the specified UART interrupt source is enabled or not.

Parameters

__HANDLE__

specifies the UART Handle.

__INTERRUPT__

specifies the UART interrupt source to check. This parameter can be one of the following values: UART_IT_WUF Wakeup from stop mode interrupt UART_IT_CM Character match interrupt UART_IT_CTS CTS change interrupt UART_IT_LBD LIN Break detection interrupt UART_IT_TXE Transmit Data Register empty interrupt UART_IT_TC Transmission complete interrupt UART_IT_RXNE Receive Data register not empty interrupt UART_IT_RTO Receive Timeout interrupt UART_IT_IDLE Idle line detection interrupt UART_IT_PE Parity Error interrupt UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)

Return values

The	new state of INTERRUPT (SET or RESET).

__HAL_UART_HWCONTROL_CTS_DISABLE

#define __HAL_UART_HWCONTROL_CTS_DISABLE

(

__HANDLE__

)

Value:

  do{                                                              \
    ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
    (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE);             \
  } while(0U)

Disable CTS flow control.

Note

This macro allows to disable CTS hardware flow control for a given UART instance, without need to call HAL_UART_Init() function. As involving direct access to UART registers, usage of this macro should be fully endorsed by user.

As macro is expected to be used for modifying CTS Hw flow control feature activation, without need for USART instance Deinit/Init, following conditions for macro call should be fulfilled :

• UART instance should have already been initialised (through call of HAL_UART_Init() )
• macro could only be called when corresponding UART instance is disabled (i.e. HAL_UART_DISABLE(__HANDLE)) and should be followed by an Enable macro (i.e. HAL_UART_ENABLE(__HANDLE)).

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_HWCONTROL_CTS_ENABLE

#define __HAL_UART_HWCONTROL_CTS_ENABLE

(

__HANDLE__

)

Value:

  do{                                                             \
    ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE);  \
    (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE;               \
  } while(0U)

Enable CTS flow control.

Note

This macro allows to enable CTS hardware flow control for a given UART instance, without need to call HAL_UART_Init() function. As involving direct access to UART registers, usage of this macro should be fully endorsed by user.

As macro is expected to be used for modifying CTS Hw flow control feature activation, without need for USART instance Deinit/Init, following conditions for macro call should be fulfilled :

• UART instance should have already been initialised (through call of HAL_UART_Init() )
• macro could only be called when corresponding UART instance is disabled (i.e. HAL_UART_DISABLE(__HANDLE)) and should be followed by an Enable macro (i.e. HAL_UART_ENABLE(__HANDLE)).

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_HWCONTROL_RTS_DISABLE

#define __HAL_UART_HWCONTROL_RTS_DISABLE

(

__HANDLE__

)

Value:

  do{                                                             \
    ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
    (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE);            \
  } while(0U)

Disable RTS flow control.

Note

This macro allows to disable RTS hardware flow control for a given UART instance, without need to call HAL_UART_Init() function. As involving direct access to UART registers, usage of this macro should be fully endorsed by user.

As macro is expected to be used for modifying RTS Hw flow control feature activation, without need for USART instance Deinit/Init, following conditions for macro call should be fulfilled :

• UART instance should have already been initialised (through call of HAL_UART_Init() )
• macro could only be called when corresponding UART instance is disabled (i.e. HAL_UART_DISABLE(__HANDLE)) and should be followed by an Enable macro (i.e. HAL_UART_ENABLE(__HANDLE)).

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_HWCONTROL_RTS_ENABLE

#define __HAL_UART_HWCONTROL_RTS_ENABLE

(

__HANDLE__

)

Value:

  do{                                                            \
    ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
    (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE;              \
  } while(0U)

Enable RTS flow control.

Note

This macro allows to enable RTS hardware flow control for a given UART instance, without need to call HAL_UART_Init() function. As involving direct access to UART registers, usage of this macro should be fully endorsed by user.

As macro is expected to be used for modifying RTS Hw flow control feature activation, without need for USART instance Deinit/Init, following conditions for macro call should be fulfilled :

• UART instance should have already been initialised (through call of HAL_UART_Init() )
• macro could only be called when corresponding UART instance is disabled (i.e. HAL_UART_DISABLE(__HANDLE)) and should be followed by an Enable macro (i.e. HAL_UART_ENABLE(__HANDLE)).

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_ONE_BIT_SAMPLE_DISABLE

#define __HAL_UART_ONE_BIT_SAMPLE_DISABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)

Disable the UART one bit sample method.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_ONE_BIT_SAMPLE_ENABLE

#define __HAL_UART_ONE_BIT_SAMPLE_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)

Enable the UART one bit sample method.

Parameters

__HANDLE__

specifies the UART Handle.

Return values

None

__HAL_UART_RESET_HANDLE_STATE

#define __HAL_UART_RESET_HANDLE_STATE

(

__HANDLE__

)

Value:

                                                       do{                                                   \
                                                       (__HANDLE__)->gState = HAL_UART_STATE_RESET;      \
                                                       (__HANDLE__)->RxState = HAL_UART_STATE_RESET;     \
                                                     } while(0U)

Reset UART handle states.

Parameters

__HANDLE__

UART handle.

Return values

None

__HAL_UART_SEND_REQ

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

Set a specific UART request flag.

Parameters

__HANDLE__	specifies the UART Handle.
__REQ__	specifies the request flag to set This parameter can be one of the following values: UART_AUTOBAUD_REQUEST Auto-Baud Rate Request UART_SENDBREAK_REQUEST Send Break Request UART_MUTE_MODE_REQUEST Mute Mode Request UART_RXDATA_FLUSH_REQUEST Receive Data flush Request UART_TXDATA_FLUSH_REQUEST Transmit data flush Request

Return values

None