|
UART
|
| enum | UART_STATUS { UART_STATUS_SUCCESS, UART_STATUS_FAILURE, UART_STATUS_BUSY, UART_STATUS_BUFFER_INVALID, UART_STATUS_MODE_MISMATCH } |
| Enum to describe the possible status values, returned by UART APIs. More... | |
| enum | UART_MODE { UART_MODE_FULLDUPLEX, UART_MODE_HALFDUPLEX, UART_MODE_LOOPBACK } |
| Enum used to describe the UART Mode of operation. More... | |
| enum | UART_EVENT { UART_EVENT_SYNC_BRK, UART_EVENT_RX_NOISE, UART_EVENT_FORMAT_ERR0, UART_EVENT_FORMAT_ERR1, UART_EVENT_COLLISION, UART_EVENT_MAX } |
| Enum used to identify UART protocol event callback function. More... | |
| enum | UART_TRANSFER_MODE { UART_TRANSFER_MODE_INTERRUPT, UART_TRANSFER_MODE_DMA, UART_TRANSFER_MODE_DIRECT } |
| Enum used to identify the transfer type used for either transmit or receive function. More... | |
| typedef enum UART_STATUS | UART_STATUS_t |
| Enum to describe the possible status values, returned by UART APIs. | |
| typedef enum UART_MODE | UART_MODE_t |
| Enum used to describe the UART Mode of operation. | |
| typedef enum UART_EVENT | UART_EVENT_t |
| Enum used to identify UART protocol event callback function. | |
| typedef enum UART_TRANSFER_MODE | UART_TRANSFER_MODE_t |
| Enum used to identify the transfer type used for either transmit or receive function. | |
Detailed Description
Enumeration Type Documentation
| enum UART_EVENT |
Enum used to identify UART protocol event callback function.
| Enumerator | |
|---|---|
| UART_EVENT_SYNC_BRK |
Synchronization break detected event |
| UART_EVENT_RX_NOISE |
Receiver noise detected event |
| UART_EVENT_FORMAT_ERR0 |
Frame format error at stop bit 0 event |
| UART_EVENT_FORMAT_ERR1 |
Frame format error at stop bit 1 event |
| UART_EVENT_COLLISION |
Data collision detected in half duplex mode event |
| UART_EVENT_MAX |
Indicates number of UART events supported |
| enum UART_MODE |
| enum UART_STATUS |
Enum to describe the possible status values, returned by UART APIs.
| Enumerator | |
|---|---|
| UART_STATUS_SUCCESS |
Indicates App initialization state successful |
| UART_STATUS_FAILURE |
Unknown error |
| UART_STATUS_BUSY |
UART Busy |
| UART_STATUS_BUFFER_INVALID |
Buffer provided or the buffer size is invalid |
| UART_STATUS_MODE_MISMATCH |
API invoked by a handle configured with different mode. e.g, If UART_StartTransmitDMA is invoked for an instance which has transmit mode configured as "Interrupt", will return this status. |
| enum UART_TRANSFER_MODE |
Enum used to identify the transfer type used for either transmit or receive function.