USARTEx Private Macros

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

Detailed Description

Macro Definition Documentation

IS_USART_FIFO_MODE_STATE

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

IS_USART_NSS

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

IS_USART_RXFIFO_THRESHOLD

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

IS_USART_SLAVEMODE

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

IS_USART_TXFIFO_THRESHOLD

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

IS_USART_WORD_LENGTH

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

USART_MASK_COMPUTATION

#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,the

mask to apply to USART RDR register is stored in (HANDLE)->Mask field.