Macros
#define	__HAL_USART_RESET_HANDLE_STATE(__HANDLE__)
	Reset USART handle state.
#define	__HAL_USART_GET_FLAG(__HANDLE__, __FLAG__)
	Check whether the specified USART flag is set or not.
#define	__HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the specified USART pending flag.
#define	__HAL_USART_CLEAR_PEFLAG(__HANDLE__)
	Clear the USART PE pending flag.
#define	__HAL_USART_CLEAR_FEFLAG(__HANDLE__)
	Clear the USART FE pending flag.
#define	__HAL_USART_CLEAR_NEFLAG(__HANDLE__)
	Clear the USART NE pending flag.
#define	__HAL_USART_CLEAR_OREFLAG(__HANDLE__)
	Clear the USART ORE pending flag.
#define	__HAL_USART_CLEAR_IDLEFLAG(__HANDLE__)
	Clear the USART IDLE pending flag.
#define	__HAL_USART_CLEAR_TXFECF(__HANDLE__)
	Clear the USART TX FIFO empty clear flag.
#define	__HAL_USART_CLEAR_UDRFLAG(__HANDLE__)
	Clear SPI slave underrun error flag.
#define	__HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified USART interrupt.
#define	__HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified USART interrupt.
#define	__HAL_USART_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified USART interrupt has occurred or not.
#define	__HAL_USART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified USART interrupt source is enabled or not.
#define	__HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__)
	Clear the specified USART ISR flag, in setting the proper ICR register flag.
#define	__HAL_USART_SEND_REQ(__HANDLE__, __REQ__)
	Set a specific USART request flag.
#define	__HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)
	Enable the USART one bit sample method.
#define	__HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)
	Disable the USART one bit sample method.
#define	__HAL_USART_ENABLE(__HANDLE__)
	Enable USART.
#define	__HAL_USART_DISABLE(__HANDLE__)
	Disable USART.

Detailed Description

Macro Definition Documentation

◆ __HAL_USART_CLEAR_FEFLAG

#define __HAL_USART_CLEAR_FEFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)

__HAL_USART_CLEAR_FLAG

#define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__)

Clear the specified USART pending flag.

Definition stm32h7xx_hal_usart.h:504

USART_CLEAR_FEF

#define USART_CLEAR_FEF

Definition stm32h7xx_hal_usart.h:413

Clear the USART FE pending flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_FLAG

#define __HAL_USART_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

Value:

((__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_TXFECF TXFIFO empty clear Flag
USART_CLEAR_TCF Transmission Complete Clear Flag
USART_CLEAR_RTOF Receiver Timeout clear flag
USART_CLEAR_UDRF SPI slave underrun error Clear Flag

Return values

None

◆ __HAL_USART_CLEAR_IDLEFLAG

#define __HAL_USART_CLEAR_IDLEFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)

USART_CLEAR_IDLEF

#define USART_CLEAR_IDLEF

Definition stm32h7xx_hal_usart.h:416

Clear the USART IDLE pending flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_IT

#define __HAL_USART_CLEAR_IT	(		__HANDLE__,
			__IT_CLEAR__ )

Value:

((__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_TXFECF TXFIFO empty clear Flag
USART_CLEAR_TCF Transmission Complete Clear Flag

Return values

None

◆ __HAL_USART_CLEAR_NEFLAG

#define __HAL_USART_CLEAR_NEFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)

USART_CLEAR_NEF

#define USART_CLEAR_NEF

Definition stm32h7xx_hal_usart.h:414

Clear the USART NE pending flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_OREFLAG

#define __HAL_USART_CLEAR_OREFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)

USART_CLEAR_OREF

#define USART_CLEAR_OREF

Definition stm32h7xx_hal_usart.h:415

Clear the USART ORE pending flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_PEFLAG

#define __HAL_USART_CLEAR_PEFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)

USART_CLEAR_PEF

#define USART_CLEAR_PEF

Definition stm32h7xx_hal_usart.h:412

Clear the USART PE pending flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_TXFECF

#define __HAL_USART_CLEAR_TXFECF ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_TXFECF)

USART_CLEAR_TXFECF

#define USART_CLEAR_TXFECF

Definition stm32h7xx_hal_usart.h:419

Clear the USART TX FIFO empty clear flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_CLEAR_UDRFLAG

#define __HAL_USART_CLEAR_UDRFLAG ( __HANDLE__ )

Value:

__HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_UDRF)

USART_CLEAR_UDRF

#define USART_CLEAR_UDRF

Definition stm32h7xx_hal_usart.h:418

Clear SPI slave underrun error flag.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_DISABLE

#define __HAL_USART_DISABLE ( __HANDLE__ )

Value:

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

USART_CR1_UE

#define USART_CR1_UE

Definition stm32h723xx.h:20907

Disable USART.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_DISABLE_IT

#define __HAL_USART_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

Value:

(((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)?\
 ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
 ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)?\
 ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
 ((__HANDLE__)->Instance->CR3 &= ~ (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_RXFF RXFIFO Full interrupt
USART_IT_TXFE TXFIFO Empty interrupt
USART_IT_RXFT RXFIFO threshold interrupt
USART_IT_TXFT TXFIFO threshold interrupt
USART_IT_TXE Transmit Data Register empty interrupt
USART_IT_TXFNF TX FIFO not full interrupt
USART_IT_TC Transmission complete interrupt
USART_IT_RXNE Receive Data register not empty interrupt
USART_IT_RXFNE RXFIFO 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

◆ __HAL_USART_ENABLE

#define __HAL_USART_ENABLE ( __HANDLE__ )

Value:

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

Enable USART.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_ENABLE_IT

#define __HAL_USART_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

Value:

(((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)?\
 ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
 ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)?\
 ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
 ((__HANDLE__)->Instance->CR3 |= (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_RXFF RXFIFO Full interrupt
USART_IT_TXFE TXFIFO Empty interrupt
USART_IT_RXFT RXFIFO threshold interrupt
USART_IT_TXFT TXFIFO threshold interrupt
USART_IT_TXE Transmit Data Register empty interrupt
USART_IT_TXFNF TX FIFO not full interrupt
USART_IT_TC Transmission complete interrupt
USART_IT_RXNE Receive Data register not empty interrupt
USART_IT_RXFNE RXFIFO 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

◆ __HAL_USART_GET_FLAG

#define __HAL_USART_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

Value:

(((__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_TXFT TXFIFO threshold flag
USART_FLAG_RXFT RXFIFO threshold flag
USART_FLAG_RXFF RXFIFO Full flag
USART_FLAG_TXFE TXFIFO Empty flag
USART_FLAG_REACK Receive enable acknowledge flag
USART_FLAG_TEACK Transmit enable acknowledge flag
USART_FLAG_BUSY Busy flag
USART_FLAG_UDR SPI slave underrun error flag
USART_FLAG_TXE Transmit data register empty flag
USART_FLAG_TXFNF TXFIFO not full flag
USART_FLAG_TC Transmission Complete flag
USART_FLAG_RXNE Receive data register not empty flag
USART_FLAG_RXFNE RXFIFO 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).

◆ __HAL_USART_GET_IT

#define __HAL_USART_GET_IT	(		__HANDLE__,
			__INTERRUPT__ )

Value:

((((__HANDLE__)->Instance->ISR\
& (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_RXFF RXFIFO Full interrupt
USART_IT_TXFE TXFIFO Empty interrupt
USART_IT_RXFT RXFIFO threshold interrupt
USART_IT_TXFT TXFIFO threshold interrupt
USART_IT_TXE Transmit Data Register empty interrupt
USART_IT_TXFNF TX FIFO not full interrupt
USART_IT_TC Transmission complete interrupt
USART_IT_RXNE Receive Data register not empty interrupt
USART_IT_RXFNE RXFIFO 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).

◆ __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_RXFF RXFIFO Full interrupt
USART_IT_TXFE TXFIFO Empty interrupt
USART_IT_RXFT RXFIFO threshold interrupt
USART_IT_TXFT TXFIFO threshold interrupt
USART_IT_TXE Transmit Data Register empty interrupt
USART_IT_TXFNF TX FIFO not full interrupt
USART_IT_TC Transmission complete interrupt
USART_IT_RXNE Receive Data register not empty interrupt
USART_IT_RXFNE RXFIFO 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).

◆ __HAL_USART_ONE_BIT_SAMPLE_DISABLE

#define __HAL_USART_ONE_BIT_SAMPLE_DISABLE ( __HANDLE__ )

Value:

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

USART_CR3_ONEBIT

#define USART_CR3_ONEBIT

Definition stm32h723xx.h:21097

Disable the USART one bit sample method.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_ONE_BIT_SAMPLE_ENABLE

#define __HAL_USART_ONE_BIT_SAMPLE_ENABLE ( __HANDLE__ )

Value:

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

Enable the USART one bit sample method.

Parameters

__HANDLE__ specifies the USART Handle.

Return values

None

◆ __HAL_USART_RESET_HANDLE_STATE

#define __HAL_USART_RESET_HANDLE_STATE ( __HANDLE__ )

Value:

((__HANDLE__)->State = HAL_USART_STATE_RESET)

HAL_USART_STATE_RESET

@ HAL_USART_STATE_RESET

Definition stm32h7xx_hal_usart.h:96

Reset USART handle state.

Parameters

__HANDLE__ USART handle.

Return values

None

◆ __HAL_USART_SEND_REQ

#define __HAL_USART_SEND_REQ	(		__HANDLE__,
			__REQ__ )

Value:

((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))

Set a specific USART request flag.

Parameters

__HANDLE__	specifies the USART Handle.
__REQ__	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

Macros

Detailed Description

Macro Definition Documentation

◆ __HAL_USART_CLEAR_FEFLAG

◆ __HAL_USART_CLEAR_FLAG

◆ __HAL_USART_CLEAR_IDLEFLAG

◆ __HAL_USART_CLEAR_IT

◆ __HAL_USART_CLEAR_NEFLAG

◆ __HAL_USART_CLEAR_OREFLAG

◆ __HAL_USART_CLEAR_PEFLAG

◆ __HAL_USART_CLEAR_TXFECF

◆ __HAL_USART_CLEAR_UDRFLAG

◆ __HAL_USART_DISABLE

◆ __HAL_USART_DISABLE_IT

◆ __HAL_USART_ENABLE

◆ __HAL_USART_ENABLE_IT

◆ __HAL_USART_GET_FLAG

◆ __HAL_USART_GET_IT

◆ __HAL_USART_GET_IT_SOURCE

◆ __HAL_USART_ONE_BIT_SAMPLE_DISABLE

◆ __HAL_USART_ONE_BIT_SAMPLE_ENABLE

◆ __HAL_USART_RESET_HANDLE_STATE

◆ __HAL_USART_SEND_REQ