sol-uart.h File Reference

These routines are used for UART access under Soletta. More...

#include <stdbool.h>
#include <stdint.h>
#include <sol-types.h>
#include <sol-buffer.h>
#include <sol-common-buildopts.h>
#include <sol-macros.h>

Go to the source code of this file.

Data Structures
struct	sol_uart_config
	A configuration struct used to set the UART paramenters. More...

Macros
#define	SOL_UART_CONFIG_API_VERSION   (1)
	compile time API version to be checked during runtime More...

Typedefs
typedef struct sol_uart	sol_uart
	A handle to a UART device. More...
typedef struct sol_uart_config	sol_uart_config
	A configuration struct used to set the UART paramenters. More...

Enumerations
enum	sol_uart_baud_rate {   SOL_UART_BAUD_RATE_9600 = 0, SOL_UART_BAUD_RATE_19200, SOL_UART_BAUD_RATE_38400, SOL_UART_BAUD_RATE_57600,   SOL_UART_BAUD_RATE_115200 }
	Baud rate is the number of times the signal can switch states in one second. More...
enum	sol_uart_data_bits { SOL_UART_DATA_BITS_8 = 0, SOL_UART_DATA_BITS_7, SOL_UART_DATA_BITS_6, SOL_UART_DATA_BITS_5 }
	Amount of data bits. More...
enum	sol_uart_parity { SOL_UART_PARITY_NONE = 0, SOL_UART_PARITY_EVEN, SOL_UART_PARITY_ODD }
	The parity characteristic can be even, odd, or none and it influences last trasmitted bit. More...
enum	sol_uart_stop_bits { SOL_UART_STOP_BITS_ONE = 0, SOL_UART_STOP_BITS_TWO }
	Amount of stop bits. More...

Functions
enum sol_uart_baud_rate	sol_uart_baud_rate_from_str (const char *baud_rate)
	Converts a string UART baudRate to sol_uart_baud_rate. More...
const char *	sol_uart_baud_rate_to_str (enum sol_uart_baud_rate baud_rate)
	Converts sol_uart_baud_rate to a string name. More...
void	sol_uart_close (struct sol_uart *uart)
	Close an UART bus. More...
enum sol_uart_data_bits	sol_uart_data_bits_from_str (const char *data_bits)
	Converts a string UART dataBits to sol_uart_data_bits. More...
const char *	sol_uart_data_bits_to_str (enum sol_uart_data_bits data_bits)
	Converts sol_uart_data_bits to a string name. More...
int	sol_uart_feed (struct sol_uart *uart, struct sol_blob *blob)
	Perform an UART asynchronous transmission. More...
struct sol_uart *	sol_uart_open (const char *port_name, const struct sol_uart_config *config)
	Open an UART bus. More...
enum sol_uart_parity	sol_uart_parity_from_str (const char *parity)
	Converts a string UART parity to sol_uart_parity. More...
const char *	sol_uart_parity_to_str (enum sol_uart_parity parity)
	Converts sol_uart_parity to a string name. More...
enum sol_uart_stop_bits	sol_uart_stop_bits_from_str (const char *stop_bits)
	Converts a string UART stopBits to sol_uart_stop_bits. More...
const char *	sol_uart_stop_bits_to_str (enum sol_uart_stop_bits stop_bits)
	Converts sol_uart_stop_bits to a string name. More...

Detailed Description

These routines are used for UART access under Soletta.

Macro Definition Documentation

#define SOL_UART_CONFIG_API_VERSION   (1)

compile time API version to be checked during runtime

Examples:

/src/samples/common/uart.c.

Referenced by startup().