STM32H735xx HAL User Manual
Defines
USARTEx Private Macros
USARTEx

Defines

#define USART_MASK_COMPUTATION(__HANDLE__)
 Compute the USART mask to apply to retrieve the received data according to the word length and to the parity bits activation.
#define IS_USART_WORD_LENGTH(__LENGTH__)
 Ensure that USART frame length is valid.
#define IS_USART_NSS(__NSS__)
 Ensure that USART Negative Slave Select (NSS) pin management is valid.
#define IS_USART_SLAVEMODE(__STATE__)
 Ensure that USART Slave Mode is valid.
#define IS_USART_FIFO_MODE_STATE(__STATE__)
 Ensure that USART FIFO mode is valid.
#define IS_USART_TXFIFO_THRESHOLD(__THRESHOLD__)
 Ensure that USART TXFIFO threshold level is valid.
#define IS_USART_RXFIFO_THRESHOLD(__THRESHOLD__)
 Ensure that USART RXFIFO threshold level is valid.

Define Documentation

#define IS_USART_FIFO_MODE_STATE (   __STATE__)
Value:
(((__STATE__) == USART_FIFOMODE_DISABLE ) || \
                                             ((__STATE__) == USART_FIFOMODE_ENABLE))

Ensure that USART FIFO mode is valid.

Parameters:
__STATE__USART FIFO mode.
Return values:
SET(__STATE__ is valid) or RESET (__STATE__ is invalid)

Definition at line 201 of file stm32h7xx_hal_usart_ex.h.

#define IS_USART_NSS (   __NSS__)
Value:
(((__NSS__) == USART_NSS_HARD) || \
                               ((__NSS__) == USART_NSS_SOFT))

Ensure that USART Negative Slave Select (NSS) pin management is valid.

Parameters:
__NSS__USART Negative Slave Select pin management.
Return values:
SET(__NSS__ is valid) or RESET (__NSS__ is invalid)

Definition at line 185 of file stm32h7xx_hal_usart_ex.h.

Referenced by HAL_USARTEx_ConfigNSS().

#define IS_USART_RXFIFO_THRESHOLD (   __THRESHOLD__)
Value:
(((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_8)  || \
                                                   ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_4)  || \
                                                   ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_2)  || \
                                                   ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_3_4)  || \
                                                   ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_7_8)  || \
                                                   ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_8_8))

Ensure that USART RXFIFO threshold level is valid.

Parameters:
__THRESHOLD__USART RXFIFO threshold level.
Return values:
SET(__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid)

Definition at line 221 of file stm32h7xx_hal_usart_ex.h.

Referenced by HAL_USARTEx_SetRxFifoThreshold().

#define IS_USART_SLAVEMODE (   __STATE__)
Value:
(((__STATE__) == USART_SLAVEMODE_DISABLE ) || \
                                         ((__STATE__) == USART_SLAVEMODE_ENABLE))

Ensure that USART Slave Mode is valid.

Parameters:
__STATE__USART Slave Mode.
Return values:
SET(__STATE__ is valid) or RESET (__STATE__ is invalid)

Definition at line 193 of file stm32h7xx_hal_usart_ex.h.

#define IS_USART_TXFIFO_THRESHOLD (   __THRESHOLD__)
Value:
(((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_8)  || \
                                                   ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_4)  || \
                                                   ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_2)  || \
                                                   ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_3_4)  || \
                                                   ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_7_8)  || \
                                                   ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_8_8))

Ensure that USART TXFIFO threshold level is valid.

Parameters:
__THRESHOLD__USART TXFIFO threshold level.
Return values:
SET(__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid)

Definition at line 209 of file stm32h7xx_hal_usart_ex.h.

Referenced by HAL_USARTEx_SetTxFifoThreshold().

#define IS_USART_WORD_LENGTH (   __LENGTH__)
Value:
(((__LENGTH__) == USART_WORDLENGTH_7B) || \
                                          ((__LENGTH__) == USART_WORDLENGTH_8B) || \
                                          ((__LENGTH__) == USART_WORDLENGTH_9B))

Ensure that USART frame length is valid.

Parameters:
__LENGTH__USART frame length.
Return values:
SET(__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)

Definition at line 176 of file stm32h7xx_hal_usart_ex.h.

Referenced by USART_SetConfig().

#define USART_MASK_COMPUTATION (   __HANDLE__)

Compute the USART 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 USART Handle.
Return values:
None,themask to apply to USART RDR register is stored in (__HANDLE__)->Mask field.

Definition at line 130 of file stm32h7xx_hal_usart_ex.h.

Referenced by HAL_USART_Receive(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive(), and HAL_USART_TransmitReceive_IT().