Collaboration diagram for USART Exported Macros:

Macros
#define	__HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)
	Clear the USART FE pending flag. More...

#define	__HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
	Clear the specified USART pending flag. More...

#define	__HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)
	Clear the USART IDLE pending flag. More...

#define	__HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
	Clear the specified USART ISR flag, in setting the proper ICR register flag. More...

#define	__HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)
	Clear the USART NE pending flag. More...

#define	__HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)
	Clear the USART ORE pending flag. More...

#define	__HAL_USART_CLEAR_PEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)
	Clear the USART PE pending flag. More...

#define	__HAL_USART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
	Disable USART. More...

#define	__HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified USART interrupt. More...

#define	__HAL_USART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 \|= USART_CR1_UE)
	Enable USART. More...

#define	__HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified USART interrupt. More...

#define	__HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
	Check whether the specified USART flag is set or not. More...

#define	__HAL_USART_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified USART interrupt has occurred or not. More...

#define	__HAL_USART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified USART interrupt source is enabled or not. More...

#define	__HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
	Disable the USART one bit sample method. More...

#define	__HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\|= USART_CR3_ONEBIT)
	Enable the USART one bit sample method. More...

#define	__HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
	Reset USART handle state. More...

#define	__HAL_USART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR \|= (uint16_t)(__REQ__))
	Set a specific USART request flag. More...

Detailed Description

Macro Definition Documentation

◆ __HAL_USART_CLEAR_FEFLAG

#define __HAL_USART_CLEAR_FEFLAG ( __HANDLE__ ) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)

Clear the USART FE pending flag.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 443 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_FLAG

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

Clear the specified USART pending flag.

Parameters

HANDLE specifies the USART Handle.

FLAG

specifies the flag to check. This parameter can be any combination of the following values:

USART_CLEAR_PEF Parity Error Clear Flag
USART_CLEAR_FEF Framing Error Clear Flag
USART_CLEAR_NEF Noise detected Clear Flag
USART_CLEAR_OREF Overrun Error Clear Flag
USART_CLEAR_IDLEF IDLE line detected Clear Flag
USART_CLEAR_TCF Transmission Complete Clear Flag
USART_CLEAR_RTOF Receiver Timeout clear flag

Return values

None

Definition at line 431 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_IDLEFLAG

#define __HAL_USART_CLEAR_IDLEFLAG ( __HANDLE__ ) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)

Clear the USART IDLE pending flag.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 461 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_IT

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

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

Parameters

HANDLE specifies the USART 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:

USART_CLEAR_PEF Parity Error Clear Flag
USART_CLEAR_FEF Framing Error Clear Flag
USART_CLEAR_NEF Noise detected Clear Flag
USART_CLEAR_OREF Overrun Error Clear Flag
USART_CLEAR_IDLEF IDLE line detected Clear Flag
USART_CLEAR_RTOF Receiver timeout clear flag
USART_CLEAR_TCF Transmission Complete Clear Flag

Return values

None

Definition at line 548 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_NEFLAG

#define __HAL_USART_CLEAR_NEFLAG ( __HANDLE__ ) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)

Clear the USART NE pending flag.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 449 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_OREFLAG

#define __HAL_USART_CLEAR_OREFLAG ( __HANDLE__ ) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)

Clear the USART ORE pending flag.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 455 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_CLEAR_PEFLAG

#define __HAL_USART_CLEAR_PEFLAG ( __HANDLE__ ) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)

Clear the USART PE pending flag.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 437 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_DISABLE

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

Disable USART.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 583 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_DISABLE_IT

#define __HAL_USART_DISABLE_IT	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

                                                            (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))))

Disable the specified USART interrupt.

Parameters

HANDLE specifies the USART Handle.

INTERRUPT

specifies the USART interrupt source to disable. 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)

Return values

None

Definition at line 493 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_ENABLE

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

Enable USART.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 577 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_ENABLE_IT

#define __HAL_USART_ENABLE_IT	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

                                                            (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))))

Enable the specified USART interrupt.

Parameters

HANDLE specifies the USART Handle.

INTERRUPT

specifies the USART interrupt source to enable. 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)

Return values

None

Definition at line 477 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_GET_FLAG

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

Check whether the specified USART flag is set or not.

Parameters

HANDLE specifies the USART Handle

FLAG

specifies the flag to check. This parameter can be one of the following values:

USART_FLAG_REACK Receive enable acknowledge flag
USART_FLAG_TEACK Transmit enable acknowledge flag
USART_FLAG_BUSY Busy flag
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_RTOF Receiver Timeout 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

The	new state of FLAG (TRUE or FALSE).

Definition at line 416 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_GET_IT

#define __HAL_USART_GET_IT	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

((((__HANDLE__)->Instance->ISR\

& ((uint32_t)0x01U << (((__INTERRUPT__) & USART_ISR_MASK)>> USART_ISR_POS))) != 0U) ? SET : RESET)

Check whether the specified USART interrupt has occurred or not.

Parameters

HANDLE specifies the USART Handle.

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_ORE OverRun Error interrupt
USART_IT_NE Noise Error interrupt
USART_IT_FE Framing Error interrupt
USART_IT_PE Parity Error interrupt

Return values

The	new state of INTERRUPT (SET or RESET).

Definition at line 512 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_GET_IT_SOURCE

#define __HAL_USART_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)

Value:

                                                                 ((((((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x01U) ? (__HANDLE__)->Instance->CR1 : \
                                                                 (((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x02U) ? (__HANDLE__)->Instance->CR2 : \
                                                                  (__HANDLE__)->Instance->CR3)) & (0x01U << (((uint16_t)(__INTERRUPT__)) & USART_IT_MASK)))  != 0U) ? SET : RESET)

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

Parameters

HANDLE specifies the USART Handle.

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_ORE OverRun Error interrupt
USART_IT_NE Noise Error interrupt
USART_IT_FE Framing Error interrupt
USART_IT_PE Parity Error interrupt

Return values

The	new state of INTERRUPT (SET or RESET).

Definition at line 529 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_ONE_BIT_SAMPLE_DISABLE

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

Disable the USART one bit sample method.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 571 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_ONE_BIT_SAMPLE_ENABLE

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

Enable the USART one bit sample method.

Parameters

HANDLE specifies the USART Handle.

Return values

None

Definition at line 565 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_RESET_HANDLE_STATE

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

Reset USART handle state.

Parameters

HANDLE USART handle.

Return values

None

Definition at line 395 of file stm32f7xx_hal_usart.h.

◆ __HAL_USART_SEND_REQ

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

Set a specific USART request flag.

Parameters

<strong>HANDLE</strong>	specifies the USART Handle.
<strong>REQ</strong>	specifies the request flag to set. This parameter can be one of the following values: USART_RXDATA_FLUSH_REQUEST Receive Data flush Request USART_TXDATA_FLUSH_REQUEST Transmit data flush Request

Return values

None

Definition at line 559 of file stm32f7xx_hal_usart.h.