UART Private Macros

Macros

#define IS_UART_BAUDRATE(__BAUDRATE__)   ((__BAUDRATE__) < 921600U)
 Check if UART Baudrate is valid. More...
 
#define IS_UART_STOPBITS(__STOPBITS__)
 Check if UART frame number of stop bits is valid. More...
 
#define IS_UART_DATABITS(__DATABITS__)
 Check if UART frame number of data bits is valid. More...
 
#define IS_UART_PARITY(__PARITY__)
 Check if UART frame parity is valid. More...
 
#define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)
 Check if UART hardware flow control is valid. More...
 

Detailed Description

Macro Definition Documentation

◆ IS_UART_BAUDRATE

#define IS_UART_BAUDRATE (   __BAUDRATE__)    ((__BAUDRATE__) < 921600U)

Check if UART Baudrate is valid.

Parameters
__BAUDRATE__UART Baudrate.
Return values
SET(__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid)

Definition at line 399 of file gr55xx_hal_uart.h.

◆ IS_UART_DATABITS

#define IS_UART_DATABITS (   __DATABITS__)
Value:
(((__DATABITS__) == UART_DATABITS_5) || \
((__DATABITS__) == UART_DATABITS_6) || \
((__DATABITS__) == UART_DATABITS_7) || \
((__DATABITS__) == UART_DATABITS_8))

Check if UART frame number of data bits is valid.

Parameters
__DATABITS__UART frame number of data bits.
Return values
SET(__DATABITS__ is valid) or RESET (__DATABITS__ is invalid)

Definition at line 415 of file gr55xx_hal_uart.h.

◆ IS_UART_HARDWARE_FLOW_CONTROL

#define IS_UART_HARDWARE_FLOW_CONTROL (   __CONTROL__)
Value:
(((__CONTROL__) == UART_HWCONTROL_NONE) || \
((__CONTROL__) == UART_HWCONTROL_RTS_CTS)

Check if UART hardware flow control is valid.

Parameters
__CONTROL__UART hardware flow control.
Return values
SET(__CONTROL__ is valid) or RESET (__CONTROL__ is invalid)

Definition at line 436 of file gr55xx_hal_uart.h.

◆ IS_UART_PARITY

#define IS_UART_PARITY (   __PARITY__)
Value:
(((__PARITY__) == UART_PARITY_NONE) || \
((__PARITY__) == UART_PARITY_EVEN) || \
((__PARITY__) == UART_PARITY_ODD) || \
((__PARITY__) == UART_PARITY_SP0) || \
((__PARITY__) == UART_PARITY_SP1))

Check if UART frame parity is valid.

Parameters
__PARITY__UART frame parity.
Return values
SET(__PARITY__ is valid) or RESET (__PARITY__ is invalid)

Definition at line 425 of file gr55xx_hal_uart.h.

◆ IS_UART_STOPBITS

#define IS_UART_STOPBITS (   __STOPBITS__)
Value:
(((__STOPBITS__) == UART_STOPBITS_1) || \
((__STOPBITS__) == UART_STOPBITS_1_5) || \
((__STOPBITS__) == UART_STOPBITS_2))

Check if UART frame number of stop bits is valid.

Parameters
__STOPBITS__UART frame number of stop bits.
Return values
SET(__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)

Definition at line 406 of file gr55xx_hal_uart.h.

UART_DATABITS_8
#define UART_DATABITS_8
Definition: gr55xx_hal_uart.h:250
UART_HWCONTROL_NONE
#define UART_HWCONTROL_NONE
Definition: gr55xx_hal_uart.h:274
UART_DATABITS_6
#define UART_DATABITS_6
Definition: gr55xx_hal_uart.h:248
UART_STOPBITS_1_5
#define UART_STOPBITS_1_5
Definition: gr55xx_hal_uart.h:257
UART_PARITY_NONE
#define UART_PARITY_NONE
Definition: gr55xx_hal_uart.h:264
UART_PARITY_SP1
#define UART_PARITY_SP1
Definition: gr55xx_hal_uart.h:268
UART_DATABITS_5
#define UART_DATABITS_5
Definition: gr55xx_hal_uart.h:247
UART_PARITY_SP0
#define UART_PARITY_SP0
Definition: gr55xx_hal_uart.h:267
UART_HWCONTROL_RTS_CTS
#define UART_HWCONTROL_RTS_CTS
Definition: gr55xx_hal_uart.h:275
UART_DATABITS_7
#define UART_DATABITS_7
Definition: gr55xx_hal_uart.h:249
UART_PARITY_EVEN
#define UART_PARITY_EVEN
Definition: gr55xx_hal_uart.h:266
UART_STOPBITS_1
#define UART_STOPBITS_1
Definition: gr55xx_hal_uart.h:256
UART_STOPBITS_2
#define UART_STOPBITS_2
Definition: gr55xx_hal_uart.h:258
UART_PARITY_ODD
#define UART_PARITY_ODD
Definition: gr55xx_hal_uart.h:265