Atmel Software Framework

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIO2HOST - UART

This module performs serial input/output functionalities via UART.

Functions

uint8_t sio2host_getchar (void)
 This function performs a blocking character receive functionality. More...
 
int sio2host_getchar_nowait (void)
 This function performs a non-blocking character receive functionality. More...
 
void sio2host_init (void)
 Initializes the Serial IO Module. More...
 
void sio2host_putchar (uint8_t)
 This function prints the character to the host. More...
 
uint8_t sio2host_rx (uint8_t *data, uint8_t max_length)
 Receives data from UART. More...
 
uint8_t sio2host_tx (uint8_t *data, uint8_t length)
 Transmits data via UART. More...
 

uint8_t sio2host_getchar ( void  )

This function performs a blocking character receive functionality.

Returns
returns the data which is received

References c, and sio2host_rx().

int sio2host_getchar_nowait ( void  )

This function performs a non-blocking character receive functionality.

Returns
'-1' if no data is recieved or returns the data if a character is received

References c, and sio2host_rx().

void sio2host_init ( void  )

Initializes the Serial IO Module.

Returns
STATUS_OK for successful initialization and FAILURE incase the IO is not initialized

Initializes the Serial IO Module.

Returns
STATUS_OK for successful initialization and FAILURE incase the IO is not initialized

References stdio_serial_init(), and stdio_usb_init().

void sio2host_putchar ( uint8_t  )

This function prints the character to the host.

Returns
void

References sio2host_tx().

uint8_t sio2host_rx ( uint8_t *  data,
uint8_t  max_length 
)

Receives data from UART.

Parameters
datapointer to the buffer where the received data is to be stored
max_lengthmaximum length of data to be received
Returns
actual number of bytes received

Receives data from UART.

Parameters
datapointer to the buffer where the received data is to be stored
max_lengthmaximum length of data to be received
Returns
actual number of bytes received

References serial_rx_buf, serial_rx_buf_head, serial_rx_buf_tail, and serial_rx_count.

Referenced by sio2host_getchar(), and sio2host_getchar_nowait().

uint8_t sio2host_tx ( uint8_t *  data,
uint8_t  length 
)

Transmits data via UART.

Parameters
dataPointer to the buffer where the data to be transmitted is present
lengthNumber of bytes to be transmitted
Returns
Number of bytes actually transmitted

Transmits data via UART.

Parameters
dataPointer to the buffer where the data to be transmitted is present
lengthNumber of bytes to be transmitted
Returns
Number of bytes actually transmitted

References length, status, STATUS_OK, udi_cdc_write_buf(), and usart_serial_write_packet().

Referenced by sio2host_putchar().