buffered_uart.h File Reference

SAM UART API Declaration Implementations.

Copyright (c) 2019 Microchip Technology Inc. and its subsidiaries.

#include "compiler.h"
#include "status_codes.h"

Functions
uint8_t	buffered_uart_getchar (void)
	This function performs a blocking character receive functionality. More...
int	buffered_uart_getchar_nowait (void)
	This function performs a non-blocking character receive functionality. More...
void	buffered_uart_init (uint32_t baudrate)
	Initializes the Buffered Serial IO Module. More...
int	buffered_uart_is_empty (void)
	check if the uart buffer is empty or not. More...
void	buffered_uart_putchar (uint8_t)
	This function prints the character to the host. More...
uint8_t	buffered_uart_rx (uint8_t *data, uint8_t max_length)
	Receives data from UART. More...
void	buffered_uart_term (void)
	Terminate the Buffered Serial IO Module. More...
uint8_t	buffered_uart_tx (uint8_t *data, uint32_t length)
	Transmits data via UART. More...

uint8_t buffered_uart_getchar

(

void

)

This function performs a blocking character receive functionality.

Returns

returns the data which is received

References buffered_uart_getchar_nowait().

int buffered_uart_getchar_nowait

(

void

)

This function performs a non-blocking character receive functionality.

Returns

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

References cpu_irq_disable, cpu_irq_enable, serial_rx_buf, serial_rx_buf_head, and serial_rx_buf_tail.

Referenced by buffered_uart_getchar().

void buffered_uart_init

(

uint32_t

baudrate

)

Initializes the Buffered Serial IO Module.

Returns

STATUS_OK for successful initialization and FAILURE in case the IO is not initialized

References uart_rs232_options::baudrate, serial_rx_buf_head, serial_rx_buf_tail, stdio_serial_init(), and sysclk_enable_peripheral_clock().

Referenced by main(), and serial_bridge_process_reconfigure().

int buffered_uart_is_empty

(

void

)

check if the uart buffer is empty or not.

Returns

non zero if empy. not initialized

void buffered_uart_putchar

(

uint8_t

)

This function prints the character to the host.

Returns

void

References uart_is_tx_buf_empty(), usart_is_tx_buf_empty(), and usart_serial_putchar().

Referenced by serial_bridge_process_frame(), serial_bridge_process_read_block(), serial_bridge_process_read_reg_with_ret(), serial_bridge_process_reconfigure(), serial_bridge_process_sync_cmd(), serial_bridge_process_write_block(), and serial_bridge_process_write_reg().

uint8_t buffered_uart_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 cpu_irq_disable, cpu_irq_enable, serial_rx_buf, serial_rx_buf_head, and serial_rx_buf_tail.

Referenced by enter_wifi_firmware_download(), and serial_bridge_frame_receive().

void buffered_uart_term

(

void

)

Terminate the Buffered Serial IO Module.

Returns

STATUS_OK for successful initialization and FAILURE in case the IO is not initialized

Referenced by serial_bridge_process_reconfigure().

uint8_t buffered_uart_tx	(	uint8_t *	data,
		uint32_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 status, STATUS_OK, and usart_serial_write_packet().

Referenced by serial_bridge_process_read_block().