SIO2HOST - UART

This module performs serial input/output functionalities via UART.

Functions
void	sio2host_deinit (void)
	DeInitializes the Serial IO Module. More...
void	sio2host_disable (void)
	Disables the Serial IO Module. More...
void	sio2host_enable (void)
	Enables the Serial IO Module. More...
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...
void	USART_HOST_ISR_VECT (uint8_t instance)

void sio2host_deinit

(

void

)

DeInitializes the Serial IO Module.

References host_uart_module.

void sio2host_disable

(

void

)

Disables the Serial IO Module.

Returns

void

References host_uart_module.

void sio2host_enable

(

void

)

Enables the Serial IO Module.

Returns

void

References host_uart_module.

uint8_t sio2host_getchar

(

void

)

This function performs a blocking character receive functionality.

Returns

returns the data which is received

References 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 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

References host_uart_module, stdio_serial_init(), USART_HOST, USART_HOST_BAUDRATE, and USART_HOST_RX_ISR_ENABLE.

Referenced by serial_interface_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

data	pointer to the buffer where the received data is to be stored
max_length	maximum length of data to be received

Returns

actual number of bytes received

References serial_rx_buf, serial_rx_buf_head, SERIAL_RX_BUF_SIZE_HOST, serial_rx_buf_tail, and serial_rx_count.

Referenced by serial_data_handler(), sio2host_getchar(), and sio2host_getchar_nowait().

uint8_t sio2host_tx	(	uint8_t *	data,
		uint8_t	length
	)

Transmits data via UART.

Parameters

data	Pointer to the buffer where the data to be transmitted is present
length	Number of bytes to be transmitted

Returns

Number of bytes actually transmitted

References host_uart_module, status_code_genare_t, STATUS_OK, USART_HOST, and usart_serial_write_packet().

Referenced by serial_data_handler(), and sio2host_putchar().

void USART_HOST_ISR_VECT

(

uint8_t

instance

)

References cpu_irq_disable, cpu_irq_enable, host_uart_module, serial_rx_buf, SERIAL_RX_BUF_SIZE_HOST, serial_rx_buf_tail, USART_HOST, and usart_serial_read_packet().