|
int_fast16_t | UART_readBuffered (UART_Handle handle, void *buf, size_t size, size_t *bytesRead) |
| UART read that only supports buffered mode. More...
|
|
int_fast16_t | UART_writeBuffered (UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten) |
| UART write that only supports buffered mode. More...
|
|
int_fast16_t | UART_readCallback (UART_Handle handle, void *buf, size_t size, size_t *bytesRead) |
| UART read that only supports callback mode. More...
|
|
int_fast16_t | UART_writeCallback (UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten) |
| UART write that only supports callback mode. More...
|
|
int_fast16_t | UART_readFullFeatured (UART_Handle handle, void *buf, size_t size, size_t *bytesRead) |
| UART read that only supports buffered and callback mode. More...
|
|
int_fast16_t | UART_writeFullFeatured (UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten) |
| UART write that only supports buffered and callback mode. More...
|
|
Overview
Refer to ti_drivers_UART_Overview for a complete description of APIs and examples of use.
§ UART_Config
UART Global configuration.
The UART_Config structure contains a set of pointers used to characterize the UART driver implementation.
§ UART_readBuffered()
int_fast16_t UART_readBuffered |
( |
UART_Handle |
handle, |
|
|
void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesRead |
|
) |
| |
UART read that only supports buffered mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[out] | buf | location to read data into. |
[in] | size | amount of data to read in bytes. |
[out] | bytesRead | If non-NULL, the location to store the number of bytes actually read into the buffer. If NULL, this parameter will be ignored. |
- Returns
- Returns a status indicating success or failure of the read.
- Return values
-
§ UART_writeBuffered()
int_fast16_t UART_writeBuffered |
( |
UART_Handle |
handle, |
|
|
const void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesWritten |
|
) |
| |
UART write that only supports buffered mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[in] | buf | location to write data from. |
[in] | size | amount of data to write in bytes. |
[out] | bytesWritten | If non-NULL, the location to store the number of bytes actually written into the buffer. If NULL, this parameter will be ignored. |
- Returns
- Returns a status indicating success or failure of the write.
- Return values
-
§ UART_readCallback()
int_fast16_t UART_readCallback |
( |
UART_Handle |
handle, |
|
|
void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesRead |
|
) |
| |
UART read that only supports callback mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[out] | buf | location to read data into. |
[in] | size | amount of data to read in bytes. |
[out] | bytesRead | If non-NULL, the location to store the number of bytes actually read into the buffer. If NULL, this parameter will be ignored. In callback mode, NULL could be passed in for this parameter, since the callback function will be passed the number of bytes read. |
- Returns
- Returns a status indicating success or failure of the read.
- Return values
-
§ UART_writeCallback()
int_fast16_t UART_writeCallback |
( |
UART_Handle |
handle, |
|
|
const void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesWritten |
|
) |
| |
UART write that only supports callback mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[in] | buf | location to write data from. |
[in] | size | amount of data to write in bytes. |
[out] | bytesWritten | If non-NULL, the location to store the number of bytes actually written into the buffer. If NULL, this parameter will be ignored. In callback mode, NULL could be passed in for this parameter, since the callback function will be passed the number of bytes written. |
- Returns
- Returns a status indicating success or failure of the write.
- Return values
-
§ UART_readFullFeatured()
int_fast16_t UART_readFullFeatured |
( |
UART_Handle |
handle, |
|
|
void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesRead |
|
) |
| |
UART read that only supports buffered and callback mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[out] | buf | location to read data into. |
[in] | size | amount of data to read in bytes. |
[out] | bytesRead | If non-NULL, the location to store the number of bytes actually read into the buffer. If NULL, this parameter will be ignored. In callback mode, NULL could be passed in for this parameter, since the callback function will be passed the number of bytes read. |
- Returns
- Returns a status indicating success or failure of the read.
- Return values
-
§ UART_writeFullFeatured()
int_fast16_t UART_writeFullFeatured |
( |
UART_Handle |
handle, |
|
|
const void * |
buf, |
|
|
size_t |
size, |
|
|
size_t * |
bytesWritten |
|
) |
| |
UART write that only supports buffered and callback mode.
- Parameters
-
[in] | handle | UART_Handle instance from UART_open(). |
[in] | buf | location to write data from. |
[in] | size | amount of data to write in bytes. |
[out] | bytesWritten | If non-NULL, the location to store the number of bytes actually written into the buffer. If NULL, this parameter will be ignored. In callback mode, NULL could be passed in for this parameter, since the callback function will be passed the number of bytes written. |
- Returns
- Returns a status indicating success or failure of the write.
- Return values
-