Collaboration diagram for UARTEx Private Macros:

Macros
#define	IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__)
	Ensure that UART wake-up address length is valid. More...

#define	IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__)
	Ensure that UART wake-up address length is valid. More...

#define	IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__)
	Ensure that UART wake-up address length is valid. More...

#define	IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART RXFIFO threshold level is valid. More...

#define	IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART RXFIFO threshold level is valid. More...

#define	IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART TXFIFO threshold level is valid. More...

#define	IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__)
	Ensure that UART TXFIFO threshold level is valid. More...

#define	IS_UART_WORD_LENGTH(__LENGTH__)
	Ensure that UART frame length is valid. More...

#define	IS_UART_WORD_LENGTH(__LENGTH__)
	Ensure that UART frame length is valid. More...

#define	IS_UART_WORD_LENGTH(__LENGTH__)
	Ensure that UART frame length is valid. More...

#define	UART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the UART clock source. More...

#define	UART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the UART clock source. More...

#define	UART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the UART clock source. More...

#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. More...

#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. More...

#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. More...

Detailed Description

Macro Definition Documentation

◆ IS_UART_ADDRESSLENGTH_DETECT [1/3]

#define IS_UART_ADDRESSLENGTH_DETECT ( __ADDRESS__ )

Value:

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

((__ADDRESS__) == UART_ADDRESS_DETECT_7B))

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 402 of file stm32f7xx_hal_uart_ex.h.

◆ IS_UART_ADDRESSLENGTH_DETECT [2/3]

#define IS_UART_ADDRESSLENGTH_DETECT ( __ADDRESS__ )

Value:

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

((__ADDRESS__) == UART_ADDRESS_DETECT_7B))

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 817 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_ADDRESSLENGTH_DETECT [3/3]

#define IS_UART_ADDRESSLENGTH_DETECT ( __ADDRESS__ )

Value:

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

((__ADDRESS__) == UART_ADDRESS_DETECT_7B))

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 823 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_RXFIFO_THRESHOLD [1/2]

#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 837 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_RXFIFO_THRESHOLD [2/2]

#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 843 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_TXFIFO_THRESHOLD [1/2]

#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 825 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_TXFIFO_THRESHOLD [2/2]

#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 831 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_WORD_LENGTH [1/3]

#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 393 of file stm32f7xx_hal_uart_ex.h.

◆ IS_UART_WORD_LENGTH [2/3]

#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 808 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ IS_UART_WORD_LENGTH [3/3]

#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 814 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ UART_GETCLOCKSOURCE [1/3]

#define UART_GETCLOCKSOURCE	(	__HANDLE__,
		__CLOCKSOURCE__
	)

Report the UART clock source.

Parameters

<strong>HANDLE</strong>	specifies the UART Handle.
<strong>CLOCKSOURCE</strong>	output variable.

Return values

UART	clocking source, written in CLOCKSOURCE.

Definition at line 162 of file stm32f7xx_hal_uart_ex.h.

◆ UART_GETCLOCKSOURCE [2/3]

#define UART_GETCLOCKSOURCE	(	__HANDLE__,
		__CLOCKSOURCE__
	)

Report the UART clock source.

Parameters

<strong>HANDLE</strong>	specifies the UART Handle.
<strong>CLOCKSOURCE</strong>	output variable.

Return values

UART	clocking source, written in CLOCKSOURCE.

Definition at line 501 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ UART_GETCLOCKSOURCE [3/3]

#define UART_GETCLOCKSOURCE	(	__HANDLE__,
		__CLOCKSOURCE__
	)

Report the UART clock source.

Parameters

<strong>HANDLE</strong>	specifies the UART Handle.
<strong>CLOCKSOURCE</strong>	output variable.

Return values

UART	clocking source, written in CLOCKSOURCE.

Definition at line 507 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ UART_MASK_COMPUTATION [1/3]

#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 347 of file stm32f7xx_hal_uart_ex.h.

◆ UART_MASK_COMPUTATION [2/3]

#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 762 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.

◆ UART_MASK_COMPUTATION [3/3]

#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 768 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart_ex.h.