UART

Provides APIs for UART (Universal Asynchronous Receiver/Transmitter) More...

Collaboration diagram for UART:

Files
file	iotbus_uart.h
	Iotbus APIs for UART.

Typedefs
typedef struct _iotbus_uart_s *	iotbus_uart_context_h
	Pointer definition to the internal struct _iotbus_uart_s. More...

Enumerations

Functions
iotbus_uart_context_h	iotbus_uart_init (const char *path)
	initializes uart_context. More...
int	iotbus_uart_stop (iotbus_uart_context_h hnd)
	closes uart_context. More...
int	iotbus_uart_flush (iotbus_uart_context_h hnd)
	flushes uart buffer. More...
int	iotbus_uart_set_baudrate (iotbus_uart_context_h hnd, unsigned int baud)
	sets uart baud rate. More...
int	iotbus_uart_set_mode (iotbus_uart_context_h hnd, int bytesize, iotbus_uart_parity_e parity, int stopbits)
	sets byte size, parity bit and stop bits. More...
int	iotbus_uart_set_flowcontrol (iotbus_uart_context_h hnd, int xonxoff, int rtscts)
	set flow control settings. More...
int	iotbus_uart_read (iotbus_uart_context_h hnd, char *buf, unsigned int length)
	reads data over uart bus. More...
int	iotbus_uart_write (iotbus_uart_context_h hnd, const char *buf, unsigned int length)
	writes data over uart bus. More...

Detailed Description

Provides APIs for UART (Universal Asynchronous Receiver/Transmitter)

Typedef Documentation

typedef struct _iotbus_uart_s* iotbus_uart_context_h

Pointer definition to the internal struct _iotbus_uart_s.

Definition at line 53 of file iotbus_uart.h.

Enumeration Type Documentation

enum iotbus_uart_parity_e

Enumeration of UART parity type.

Enumeration Details:
IOTBUS_UART_PARITY_NONE
IOTBUS_UART_PARITY_EVEN
IOTBUS_UART_PARITY_ODD

Definition at line 44 of file iotbus_uart.h.

Function Documentation

int iotbus_uart_flush

(

iotbus_uart_context_h

hnd

)

flushes uart buffer.

Parameters

[in]

hnd

handle of uart_context

Returns

On success, 0 is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

iotbus_uart_context_h iotbus_uart_init

(

const char *

path

)

initializes uart_context.

Parameters

[in]

path

uart device node path

Returns

On success, handle of uart_context is returned. On failure, NULL is returned.

Since

Tizen RT v1.0

int iotbus_uart_read	(	iotbus_uart_context_h	hnd,
		char *	buf,
		unsigned int	length
	)

reads data over uart bus.

Parameters

[in]	hnd	handle of uart_context
[in]	buf	the pointer of data buffer
[in]	length	size to read

Returns

On success, size is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

int iotbus_uart_set_baudrate	(	iotbus_uart_context_h	hnd,
		unsigned int	baud
	)

sets uart baud rate.

Parameters

[in]	hnd	handle of uart_context
[in]	baud	uart baud rate

Returns

On success, 0 is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

int iotbus_uart_set_flowcontrol	(	iotbus_uart_context_h	hnd,
		int	xonxoff,
		int	rtscts
	)

set flow control settings.

Parameters

[in]	hnd	handle of uart_context
[in]	xonxoff	ixon/ixoff
[in]	rtscts	rts/cts

Returns

On success, 0 is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

int iotbus_uart_set_mode	(	iotbus_uart_context_h	hnd,
		int	bytesize,
		iotbus_uart_parity_e	parity,
		int	stopbits
	)

sets byte size, parity bit and stop bits.

Parameters

[in]	hnd	handle of uart_context
[in]	bytesize	uart byte size
[in]	parity	uart parity type
[in]	stopbits	uart stop bits

Returns

On success, 0 is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

int iotbus_uart_stop

(

iotbus_uart_context_h

hnd

)

closes uart_context.

Parameters

[in]

hnd

handle of uart_context

Returns

On success, 0 is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0

int iotbus_uart_write	(	iotbus_uart_context_h	hnd,
		const char *	buf,
		unsigned int	length
	)

writes data over uart bus.

Parameters

[in]	hnd	handle of uart_context
[in]	buf	the pointer of data buffer
[in]	length	size to write

Returns

On success, size is returned. On failure, a negative value is returned.

Since

Tizen RT v1.0