128 #ifndef ti_drivers_UART__include
129 #define ti_drivers_UART__include
155 #define UART_CMD_RESERVED 32
169 #define UART_STATUS_RESERVED -32
184 #define UART_STATUS_SUCCESS 0
192 #define UART_STATUS_ERROR -1
201 #define UART_STATUS_UNDEFINEDCMD -2
220 #define UART_CMD_PEEK 0
231 #define UART_CMD_ISAVAILABLE 1
242 #define UART_CMD_GETRXCOUNT 2
254 #define UART_CMD_RXENABLE 3
267 #define UART_CMD_RXDISABLE 4
272 #define UART_ERROR UART_STATUS_ERROR
277 #define UART_WAIT_FOREVER (~0)
616 extern int UART_control(UART_Handle handle,
unsigned int cmd,
void *arg);
705 extern int UART_write(UART_Handle handle,
const void *buffer,
size_t size);
771 extern int UART_read(UART_Handle handle,
void *buffer,
size_t size);
struct UART_Params UART_Params
UART Parameters.
UART_STOP
UART stop bit settings.
Definition: UART.h:396
struct UART_Config UART_Config
UART Global configuration.
void(* UART_CloseFxn)(UART_Handle handle)
A function pointer to a driver specific implementation of UART_CloseFxn().
Definition: UART.h:445
UART_Callback writeCallback
Definition: UART.h:428
int(* UART_ReadFxn)(UART_Handle handle, void *buffer, size_t size)
A function pointer to a driver specific implementation of UART_ReadFxn().
Definition: UART.h:471
void const * hwAttrs
Definition: UART.h:565
UART_LEN dataLength
Definition: UART.h:434
The definition of a UART function table that contains the required set of functions to control a spec...
Definition: UART.h:514
UART_Callback readCallback
Definition: UART.h:427
int UART_writePolling(UART_Handle handle, const void *buffer, size_t size)
Function that writes data to a UART, polling the peripheral to wait until new data can be written...
UART_PAR
UART parity type settings.
Definition: UART.h:406
unsigned int writeTimeout
Definition: UART.h:426
UART_ControlFxn controlFxn
Definition: UART.h:519
UART_Mode
UART mode settings.
Definition: UART.h:308
UART_Handle UART_open(unsigned int index, UART_Params *params)
Function to initialize a given UART peripheral.
UART_PAR parityType
Definition: UART.h:436
UART_DataMode
UART data mode settings.
Definition: UART.h:356
UART_Echo readEcho
Definition: UART.h:432
UART_ReturnMode
UART return mode settings.
Definition: UART.h:341
UART_WritePollingFxn writePollingFxn
Definition: UART.h:540
struct UART_Config * UART_Handle
A handle that is returned from a UART_open() call.
Definition: UART.h:282
struct UART_FxnTable UART_FxnTable
The definition of a UART function table that contains the required set of functions to control a spec...
void UART_close(UART_Handle handle)
Function to close a UART peripheral specified by the UART handle.
void UART_readCancel(UART_Handle handle)
Function that cancels a UART_read() function call.
UART_Echo
UART echo settings.
Definition: UART.h:374
int(* UART_ReadPollingFxn)(UART_Handle handle, void *buffer, size_t size)
A function pointer to a driver specific implementation of UART_ReadPollingFxn().
Definition: UART.h:478
int UART_read(UART_Handle handle, void *buffer, size_t size)
Function that reads data from a UART with interrupt enabled. This API must be used mutually exclusive...
UART_Mode writeMode
Definition: UART.h:424
int(* UART_ControlFxn)(UART_Handle handle, unsigned int cmd, void *arg)
A function pointer to a driver specific implementation of UART_ControlFxn().
Definition: UART.h:451
UART_STOP stopBits
Definition: UART.h:435
UART_ReturnMode readReturnMode
Definition: UART.h:429
UART_CloseFxn closeFxn
Definition: UART.h:516
void UART_init(void)
Function to initialize the UART module.
int UART_control(UART_Handle handle, unsigned int cmd, void *arg)
Function performs implementation specific features on a given UART_Handle.
uint32_t baudRate
Definition: UART.h:433
UART_Handle(* UART_OpenFxn)(UART_Handle handle, UART_Params *params)
A function pointer to a driver specific implementation of UART_OpenFxn().
Definition: UART.h:465
int(* UART_WriteFxn)(UART_Handle handle, const void *buffer, size_t size)
A function pointer to a driver specific implementation of UART_WriteFxn().
Definition: UART.h:491
void UART_Params_init(UART_Params *params)
Function to initialize the UART_Params struct to its defaults.
void UART_writeCancel(UART_Handle handle)
Function that cancels a UART_write() function call.
uintptr_t custom
Definition: UART.h:437
UART_DataMode readDataMode
Definition: UART.h:430
UART_WriteCancelFxn writeCancelFxn
Definition: UART.h:543
void(* UART_InitFxn)(UART_Handle handle)
A function pointer to a driver specific implementation of UART_InitFxn().
Definition: UART.h:459
UART_ReadPollingFxn readPollingFxn
Definition: UART.h:531
void(* UART_Callback)(UART_Handle, void *buf, size_t count)
The definition of a callback function used by the UART driver when used in UART_MODE_CALLBACK The cal...
Definition: UART.h:301
unsigned int readTimeout
Definition: UART.h:425
UART_ReadCancelFxn readCancelFxn
Definition: UART.h:534
int UART_readPolling(UART_Handle handle, void *buffer, size_t size)
Function that reads data from a UART without interrupts. This API must be used mutually exclusive wit...
UART_LEN
UART data length settings.
Definition: UART.h:384
void(* UART_ReadCancelFxn)(UART_Handle handle)
A function pointer to a driver specific implementation of UART_ReadCancelFxn().
Definition: UART.h:485
UART Parameters.
Definition: UART.h:422
UART_FxnTable const * fxnTablePtr
Definition: UART.h:559
UART_ReadFxn readFxn
Definition: UART.h:528
UART_OpenFxn openFxn
Definition: UART.h:525
void(* UART_WriteCancelFxn)(UART_Handle handle)
A function pointer to a driver specific implementation of UART_WriteCancelFxn().
Definition: UART.h:507
UART_DataMode writeDataMode
Definition: UART.h:431
UART_Mode readMode
Definition: UART.h:423
UART_WriteFxn writeFxn
Definition: UART.h:537
int(* UART_WritePollingFxn)(UART_Handle handle, const void *buffer, size_t size)
A function pointer to a driver specific implementation of UART_WritePollingFxn(). ...
Definition: UART.h:499
void * object
Definition: UART.h:562
UART Global configuration.
Definition: UART.h:557
UART_InitFxn initFxn
Definition: UART.h:522
int UART_write(UART_Handle handle, const void *buffer, size_t size)
Function that writes data to a UART with interrupts enabled. Usage of this API is mutually exclusive ...