|
|
|
TI-RTOS Drivers
tidrivers_full_2_20_00_08
|
|
Macros | |
| #define | UARTCC26XX_CMD_RETURN_PARTIAL_ENABLE UART_CMD_RESERVED + 0 |
| Command used by UART_control to enable partial return. More... | |
| #define | UARTCC26XX_CMD_RETURN_PARTIAL_DISABLE UART_CMD_RESERVED + 1 |
| Command used by UART_control to disable partial return. More... | |
| #define | UARTCC26XX_CMD_RX_FIFO_FLUSH UART_CMD_RESERVED + 2 |
| Command used by UART_control to flush the RX FIFO. More... | |
| #define | UART_CMD_PEEK 0 |
| Command code used by UART_control() to read the next unsigned char. More... | |
| #define | UART_CMD_ISAVAILABLE 1 |
| Command code used by UART_control() to determine if the read buffer is empty. More... | |
| #define | UART_CMD_GETRXCOUNT 2 |
| Command code used by UART_control() to determine how many unsigned chars are in the read buffer. More... | |
| #define | UART_CMD_RXENABLE 3 |
| Command code used by UART_control() to enable data receive by the UART. More... | |
| #define | UART_CMD_RXDISABLE 4 |
| Command code used by UART_control() to disable data received by the UART. More... | |
UART_CMD_* macros are general command codes for UART_control(). Not all UART driver implementations support these command codes.
UARTCC26XX_CMD_* macros are command codes only defined in the UARTCC26XX.h driver implementation and need to:
UARTCC3200_CMD_* macros are command codes only defined in the UARTCC3200.h driver implementation and need to:
UARTCC3200DMA_CMD_* macros are command codes only defined in the UARTCC3200DMA.h driver implementation and need to:
UARTEUSCIA_CMD_* macros are command codes only defined in the UARTEUSCIA.h driver implementation and need to:
UARTMSP432_CMD_* macros are command codes only defined in the UARTMSP432.h driver implementation and need to:
UARTTivaDMA_CMD_* macros are command codes only defined in the UARTTivaDMA.h driver implementation and need to:
UARTUSCIA_CMD_* macros are command codes only defined in the UARTUSCIA.h driver implementation and need to:
| #define UARTCC26XX_CMD_RETURN_PARTIAL_ENABLE UART_CMD_RESERVED + 0 |
Command used by UART_control to enable partial return.
Enabling this command allows UART_read to return partial data if data reception is inactive for a given 32-bit period. With this command arg is don't care and it returns UART_STATUS_SUCCESS.
| #define UARTCC26XX_CMD_RETURN_PARTIAL_DISABLE UART_CMD_RESERVED + 1 |
Command used by UART_control to disable partial return.
Disabling this command returns the UARTCC26XX to the default blocking behavior where UART_read blocks until all data bytes were received. With this comand arg is don't care and it returns UART_STATUS_SUCCESS.
| #define UARTCC26XX_CMD_RX_FIFO_FLUSH UART_CMD_RESERVED + 2 |
Command used by UART_control to flush the RX FIFO.
This control command flushes any contents in the RX FIFO. With this command arg is don't care and it returns UART_STATUS_SUCCESS.
| #define UART_CMD_PEEK 0 |
Command code used by UART_control() to read the next unsigned char.
This command is used to read the next unsigned char from the UART's circular buffer without removing it. With this command code, arg is a pointer to an integer. *arg contains the next unsigned char read if data is present, else *arg is set to UART_ERROR.
| #define UART_CMD_ISAVAILABLE 1 |
Command code used by UART_control() to determine if the read buffer is empty.
This command is used to determine if there are any unsigned chars available to read from the UART's circular buffer using UART_read(). With this command code, arg is a pointer to a bool. *arg contains true if data is available, else false.
| #define UART_CMD_GETRXCOUNT 2 |
Command code used by UART_control() to determine how many unsigned chars are in the read buffer.
This command is used to determine how many unsigned chars are available to read from the UART's circular buffer using UART_read(). With this command code, arg is a pointer to an integer. *arg contains the number of unsigned chars available to read.
| #define UART_CMD_RXENABLE 3 |
Command code used by UART_control() to enable data receive by the UART.
This command is used to enable the UART in such a way that it stores received unsigned chars into the circular buffer. For drivers that support power management, this typically means that the UART will set a power constraint while receive is enabled. UART_open() will always have this option enabled. With this command code, arg is don't care.
| #define UART_CMD_RXDISABLE 4 |
Command code used by UART_control() to disable data received by the UART.
This command is used to disable the UART in such a way that ignores the data it receives. For drivers that support power management, this typically means that the driver will release any power constraints, to permit the system to enter low power modes. With this command code, arg is don't care.
