Collaboration diagram for UARTEx Private Macros:

Macros
#define	UART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the UART clock source.
#define	UART_MASK_COMPUTATION(__HANDLE__)
	Report the UART mask to apply to retrieve the received data according to the word length and to the parity bits activation.
#define	IS_UART_WORD_LENGTH(__LENGTH__)
	Ensure that UART frame length is valid.
#define	IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__)
	Ensure that UART wake-up address length is valid.
#define	IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART TXFIFO threshold level is valid.
#define	IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART RXFIFO threshold level is valid.

Detailed Description

Macro Definition Documentation

◆ IS_UART_ADDRESSLENGTH_DETECT

#define IS_UART_ADDRESSLENGTH_DETECT ( __ADDRESS__ )

Value:

(((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \

((__ADDRESS__) == UART_ADDRESS_DETECT_7B))

UART_ADDRESS_DETECT_7B

#define UART_ADDRESS_DETECT_7B

7-bit long wake-up address

Definition stm32h7xx_hal_uart_ex.h:82

UART_ADDRESS_DETECT_4B

#define UART_ADDRESS_DETECT_4B

4-bit long wake-up address

Definition stm32h7xx_hal_uart_ex.h:81

Ensure that UART wake-up address length is valid.

Parameters

__ADDRESS__ UART wake-up address length.

Return values

SET	(ADDRESS is valid) or RESET (ADDRESS is invalid)

Definition at line 824 of file stm32h7xx_hal_uart_ex.h.

◆ IS_UART_RXFIFO_THRESHOLD

#define IS_UART_RXFIFO_THRESHOLD ( __THRESHOLD__ )

Value:

                                                 (((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_8) || \
                                                 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_4) || \
                                                 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_2) || \
                                                 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_3_4) || \
                                                 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_7_8) || \
                                                 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_8_8))

Ensure that UART RXFIFO threshold level is valid.

Parameters

__THRESHOLD__ UART RXFIFO threshold level.

Return values

SET	(THRESHOLD is valid) or RESET (THRESHOLD is invalid)

Definition at line 844 of file stm32h7xx_hal_uart_ex.h.

◆ IS_UART_TXFIFO_THRESHOLD

#define IS_UART_TXFIFO_THRESHOLD ( __THRESHOLD__ )

Value:

                                                 (((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_8) || \
                                                 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_4) || \
                                                 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_2) || \
                                                 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_3_4) || \
                                                 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_7_8) || \
                                                 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_8_8))

Ensure that UART TXFIFO threshold level is valid.

Parameters

__THRESHOLD__ UART TXFIFO threshold level.

Return values

SET	(THRESHOLD is valid) or RESET (THRESHOLD is invalid)

Definition at line 832 of file stm32h7xx_hal_uart_ex.h.

◆ IS_UART_WORD_LENGTH

#define IS_UART_WORD_LENGTH ( __LENGTH__ )

Value:

                                         (((__LENGTH__) == UART_WORDLENGTH_7B) || \
                                         ((__LENGTH__) == UART_WORDLENGTH_8B) || \
                                         ((__LENGTH__) == UART_WORDLENGTH_9B))

Ensure that UART frame length is valid.

Parameters

__LENGTH__ UART frame length.

Return values

SET	(LENGTH is valid) or RESET (LENGTH is invalid)

Definition at line 815 of file stm32h7xx_hal_uart_ex.h.

◆ UART_GETCLOCKSOURCE

#define UART_GETCLOCKSOURCE	(		__HANDLE__,
			__CLOCKSOURCE__ )

Report the UART clock source.

Parameters

__HANDLE__	specifies the UART Handle.
__CLOCKSOURCE__	output variable.

Return values

UART	clocking source, written in CLOCKSOURCE.

Definition at line 508 of file stm32h7xx_hal_uart_ex.h.

◆ UART_MASK_COMPUTATION

#define UART_MASK_COMPUTATION ( __HANDLE__ )

Report the UART mask to apply to retrieve the received data according to the word length and to the parity bits activation.

Note: If PCE = 1, the parity bit is not included in the data extracted by the reception API(). This masking operation is not carried out in the case of DMA transfers.

Parameters

__HANDLE__ specifies the UART Handle.

Return values

None,the mask to apply to UART RDR register is stored in (HANDLE)->Mask field.

Definition at line 769 of file stm32h7xx_hal_uart_ex.h.