_UART_DEVICE Struct Reference

#include <uart.h>

Data Fields
DEVICE	device
	The Device entry for this UART.
uint32_t	uartid
	Unique Id of this UART in the UART table.
uint32_t	uartmode
	UART mode (eg UART_MODE_SERIAL).
uint32_t	uartstate
	UART state (eg UART_STATE_ENABLED).
uint32_t	uartstatus
	UART status (eg UART_STATUS_RX_FULL)(May not be real time status depending on the driver).
uart_device_open_proc	deviceopen
	A Device specific DeviceOpen method implementing the standard UART device interface (Mandatory).
uart_device_close_proc	deviceclose
	A Device specific DeviceClose method implementing the standard UART device interface (Mandatory).
uart_device_read_proc	deviceread
	A Device specific DeviceRead method implementing the standard UART device interface (Mandatory).
uart_device_write_proc	devicewrite
	A Device specific DeviceWrite method implementing the standard UART device interface (Mandatory).
uart_device_wait_proc	devicewait
	A Device specific DeviceWait method implementing the standard UART device interface (Or nil if the default method is suitable).
uart_device_get_status_proc	devicegetstatus
	A Device specific DeviceGetStatus method implementing the standard UART device interface (Or nil if the default method is suitable).
uart_device_set_status_proc	devicesetstatus
	A Device specific DeviceSetStatus method implementing the standard UART device interface (Optional).
uart_device_get_properties_proc	devicegetproperties
	A Device specific DeviceGetProperties method implementing the standard UART device interface (Or nil if the default method is suitable).
uart_device_set_properties_proc	devicesetproperties
	A Device specific DeviceSetProperties method implementing the standard UART device interface (Or nil if the default method is suitable).
MUTEX_HANDLE	lock
	Device lock.
EVENT_HANDLE	receivewait
	Read wait event.
EVENT_HANDLE	transmitwait
	Write wait event.
UART_PROPERTIES	properties
	Device properties.
SERIAL_DEVICE *	serial
	The Serial device represented by this UART.
uint32_t	receivecount
uint32_t	receiveerrors
uint32_t	transmitcount
uint32_t	transmiterrors
UART_DEVICE *	prev
	Previous entry in UART table.
UART_DEVICE *	next
	Next entry in UART table.

Field Documentation

device

DEVICE device

The Device entry for this UART.

uartid

uint32_t uartid

Unique Id of this UART in the UART table.

uartmode

uint32_t uartmode

UART mode (eg UART_MODE_SERIAL).

uartstate

uint32_t uartstate

UART state (eg UART_STATE_ENABLED).

uartstatus

uint32_t uartstatus

UART status (eg UART_STATUS_RX_FULL)(May not be real time status depending on the driver).

deviceopen

uart_device_open_proc deviceopen

A Device specific DeviceOpen method implementing the standard UART device interface (Mandatory).

deviceclose

uart_device_close_proc deviceclose

A Device specific DeviceClose method implementing the standard UART device interface (Mandatory).

deviceread

uart_device_read_proc deviceread

A Device specific DeviceRead method implementing the standard UART device interface (Mandatory).

devicewrite

uart_device_write_proc devicewrite

A Device specific DeviceWrite method implementing the standard UART device interface (Mandatory).

devicewait

uart_device_wait_proc devicewait

A Device specific DeviceWait method implementing the standard UART device interface (Or nil if the default method is suitable).

devicegetstatus

uart_device_get_status_proc devicegetstatus

A Device specific DeviceGetStatus method implementing the standard UART device interface (Or nil if the default method is suitable).

devicesetstatus

uart_device_set_status_proc devicesetstatus

A Device specific DeviceSetStatus method implementing the standard UART device interface (Optional).

devicegetproperties

uart_device_get_properties_proc devicegetproperties

A Device specific DeviceGetProperties method implementing the standard UART device interface (Or nil if the default method is suitable).

devicesetproperties

uart_device_set_properties_proc devicesetproperties

A Device specific DeviceSetProperties method implementing the standard UART device interface (Or nil if the default method is suitable).

lock

MUTEX_HANDLE lock

Device lock.

receivewait

EVENT_HANDLE receivewait

Read wait event.

transmitwait

EVENT_HANDLE transmitwait

Write wait event.

properties

UART_PROPERTIES properties

Device properties.

serial

SERIAL_DEVICE* serial

The Serial device represented by this UART.

receivecount

uint32_t receivecount

receiveerrors

uint32_t receiveerrors

transmitcount

uint32_t transmitcount

transmiterrors

uint32_t transmiterrors

prev

UART_DEVICE* prev

Previous entry in UART table.

next

UART_DEVICE* next

Next entry in UART table.

---

The documentation for this struct was generated from the following file:

• ultibo/uart.h