_SERIAL_DEVICE Struct Reference

#include <serial.h>

Data Fields
DEVICE	device
	The Device entry for this Serial.
uint32_t	serialid
	Unique Id of this Serial device in the Serial device table.
uint32_t	serialstate
	Serial state (eg SERIAL_STATE_OPEN).
uint32_t	serialstatus
	Serial status (eg SERIAL_STATUS_RX_FULL)(May not be real time status depending on the driver).
serial_device_open_proc	deviceopen
	A Device specific DeviceOpen method implementing the standard Serial device interface (Mandatory).
serial_device_close_proc	deviceclose
	A Device specific DeviceClose method implementing the standard Serial device interface (Mandatory).
serial_device_read_proc	deviceread
	A Device specific DeviceRead method implementing the standard Serial device interface (Mandatory).
serial_device_write_proc	devicewrite
	A Device specific DeviceWrite method implementing the standard Serial device interface (Mandatory).
serial_device_wait_proc	devicewait
	A Device specific DeviceWait method implementing the standard Serial device interface (Or nil if the default method is suitable).
serial_device_flush_proc	deviceflush
	A Device specific DeviceFlush method implementing the standard Serial device interface (Or nil if the default method is suitable).
serial_device_get_status_proc	devicegetstatus
	A Device specific DeviceGetStatus method implementing the standard Serial device interface (Or nil if the default method is suitable).
serial_device_set_status_proc	devicesetstatus
	A Device specific DeviceSetStatus method implementing the standard Serial device interface (Optional).
serial_device_get_properties_proc	devicegetproperties
	A Device specific DeviceGetProperties method implementing the standard Serial device interface (Or nil if the default method is suitable).
serial_device_set_properties_proc	devicesetproperties
	A Device specific DeviceSetProperties method implementing the standard Serial device interface (Or nil if the default method is suitable).
MUTEX_HANDLE	lock
	Device lock.
SERIAL_BUFFER	receive
	Serial receive buffer.
SERIAL_BUFFER	transmit
	Serial transmit buffer.
SERIAL_PROPERTIES	properties
	Device properties.
uint32_t	receivecount
uint32_t	receiveerrors
uint32_t	receiveoverruns
uint32_t	transmitcount
uint32_t	transmiterrors
uint32_t	transmitoverruns
SERIAL_DEVICE *	prev
	Previous entry in Serial table.
SERIAL_DEVICE *	next
	Next entry in Serial table.

Field Documentation

device

DEVICE device

The Device entry for this Serial.

serialid

uint32_t serialid

Unique Id of this Serial device in the Serial device table.

serialstate

uint32_t serialstate

Serial state (eg SERIAL_STATE_OPEN).

serialstatus

uint32_t serialstatus

Serial status (eg SERIAL_STATUS_RX_FULL)(May not be real time status depending on the driver).

deviceopen

serial_device_open_proc deviceopen

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

deviceclose

serial_device_close_proc deviceclose

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

deviceread

serial_device_read_proc deviceread

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

devicewrite

serial_device_write_proc devicewrite

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

devicewait

serial_device_wait_proc devicewait

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

deviceflush

serial_device_flush_proc deviceflush

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

devicegetstatus

serial_device_get_status_proc devicegetstatus

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

devicesetstatus

serial_device_set_status_proc devicesetstatus

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

devicegetproperties

serial_device_get_properties_proc devicegetproperties

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

devicesetproperties

serial_device_set_properties_proc devicesetproperties

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

lock

MUTEX_HANDLE lock

Device lock.

receive

SERIAL_BUFFER receive

Serial receive buffer.

transmit

SERIAL_BUFFER transmit

Serial transmit buffer.

properties

SERIAL_PROPERTIES properties

Device properties.

receivecount

uint32_t receivecount

receiveerrors

uint32_t receiveerrors

receiveoverruns

uint32_t receiveoverruns

transmitcount

uint32_t transmitcount

transmiterrors

uint32_t transmiterrors

transmitoverruns

uint32_t transmitoverruns

prev

SERIAL_DEVICE* prev

Previous entry in Serial table.

next

SERIAL_DEVICE* next

Next entry in Serial table.

---

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

• ultibo/serial.h