STM32H735xx HAL User Manual
Defines
UARTEx Private Macros
UARTEx

Defines

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

Define Documentation

#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 822 of file stm32h7xx_hal_uart_ex.h.

Referenced by HAL_MultiProcessorEx_AddressLength_Set(), and UARTEx_Wakeup_AddressConfig().

#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 842 of file stm32h7xx_hal_uart_ex.h.

Referenced by HAL_UARTEx_SetRxFifoThreshold().

#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 830 of file stm32h7xx_hal_uart_ex.h.

Referenced by HAL_UARTEx_SetTxFifoThreshold().

#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 813 of file stm32h7xx_hal_uart_ex.h.

Referenced by UART_SetConfig().

#define UART_GETCLOCKSOURCE (   __HANDLE__,
  __CLOCKSOURCE__ 
)

Report the UART clock source.

Parameters:
__HANDLE__specifies the UART Handle.
__CLOCKSOURCE__output variable.
Return values:
UARTclocking source, written in __CLOCKSOURCE__.

Definition at line 201 of file stm32h7xx_hal_uart_ex.h.

Referenced by UART_SetConfig().

#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,themask to apply to UART RDR register is stored in (__HANDLE__)->Mask field.

Definition at line 767 of file stm32h7xx_hal_uart_ex.h.

Referenced by HAL_UART_Receive(), HAL_UARTEx_ReceiveToIdle(), and UART_Start_Receive_IT().