Difference between revisions of "Unit UART"

From Ultibo.org
Jump to: navigation, search
Line 166: Line 166:
 
| <code>UART_WRITE_NON_BLOCK = SERIAL_WRITE_NON_BLOCK;</code>
 
| <code>UART_WRITE_NON_BLOCK = SERIAL_WRITE_NON_BLOCK;</code>
 
| Do not block when transmitting, if the FIFO is full return immediately
 
| Do not block when transmitting, if the FIFO is full return immediately
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''UART wait direction''' <code> UART_WAIT_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>UART_WAIT_NONE = SERIAL_WAIT_NONE;</code>
 +
| &nbsp;
 +
|-
 +
| <code>UART_WAIT_RECEIVE = SERIAL_WAIT_RECEIVE;</code>
 +
| Wait for data to be available in the receive FIFO
 +
|-
 +
| <code>UART_WAIT_TRANSMIT = SERIAL_WAIT_TRANSMIT;</code>
 +
| Wait for space to be available in the transmit FIFO
 
|-
 
|-
 
|}
 
|}
Line 236: Line 253:
 
| <code>UART_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| <code>UART_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| UART informational messages, such as a device being attached or detached
 
| UART informational messages, such as a device being attached or detached
 +
|-
 +
| <code>UART_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| UART warning messages
 
|-
 
|-
 
| <code>UART_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 
| <code>UART_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
Line 341: Line 361:
 
|}
 
|}
  
−
'''UART device status'''
+
'''UART device wait'''
  
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>TUARTDeviceStatus = function(UART:PUARTDevice):LongWord;</code>
+
| <code>TUARTDeviceWait = function(UART:PUARTDevice; Direction,Timeout:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''UART device get status'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TUARTDeviceGetStatus = function(UART:PUARTDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''UART device set status'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TUARTDeviceSetStatus = function(UART:PUARTDevice; Status:LongWord):LongWord;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
Line 358: Line 396:
 
|-
 
|-
 
|}  
 
|}  
 +
 +
'''UART device set properties'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TUARTDeviceSetProperties = function(UART:PUARTDevice; Properties:PUARTProperties):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
  
 
'''UART device'''
 
'''UART device'''
Line 399: Line 446:
 
| A Device specific DeviceWrite method implementing the standard UART device interface (Mandatory)
 
| A Device specific DeviceWrite method implementing the standard UART device interface (Mandatory)
 
|-
 
|-
−
| <code>DeviceStatus:TUARTDeviceStatus;</code>
+
| <code>DeviceWait:TUARTDeviceWait;</code>
−
| A Device specific DeviceStatus method implementing the standard UART device interface (Or nil if the default method is suitable)
+
| A Device specific DeviceWait method implementing the standard UART device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceGetStatus:TUARTDeviceGetStatus;</code>
 +
| A Device specific DeviceGetStatus method implementing the standard UART device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceSetStatus:TUARTDeviceSetStatus;</code>
 +
| A Device specific DeviceSetStatus method implementing the standard UART device interface (Optional)
 
|-
 
|-
 
| <code>DeviceGetProperties:TUARTDeviceGetProperties;</code>
 
| <code>DeviceGetProperties:TUARTDeviceGetProperties;</code>
 
| A Device specific DeviceGetProperties method implementing the standard UART device interface (Or nil if the default method is suitable)
 
| A Device specific DeviceGetProperties method implementing the standard UART device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceSetProperties:TUARTDeviceSetProperties;</code>
 +
| A Device specific DeviceSetProperties method implementing the standard UART device interface (Or nil if the default method is suitable)
 
|-
 
|-
 
|colspan="2"|''Driver Properties''
 
|colspan="2"|''Driver Properties''
Line 591: Line 647:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceStatus(UART:PUARTDevice):LongWord;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceWait(UART:PUARTDevice; Direction,Timeout:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Wait for data to be available in the receive or transmit FIFO of a UART device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''UART'''
 +
| The UART device to wait for
 +
|-
 +
! '''Direction'''
 +
| The direction of data to wait for (eg UART_WAIT_RECEIVE)
 +
|-
 +
! '''Timeout'''
 +
| The number of milliseconds to wait for data (INFINITE to wait forever)
 +
|-
 +
! '''Return'''
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceStatus(UART:PUARTDevice):LongWord; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current line status of a UART device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current line status of a UART device</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 601: Line 678:
 
! '''Return'''
 
! '''Return'''
 
| A set of flags containing the device status (eg UART_STATUS_RTS)
 
| A set of flags containing the device status (eg UART_STATUS_RTS)
 +
|-
 +
! '''Note'''
 +
| Replaced by UARTDeviceGetStatus for consistency
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceGetStatus(UART:PUARTDevice):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current line status of a UART device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''UART'''
 +
| The UART device to get the status from
 +
|-
 +
! '''Return'''
 +
| A set of flags containing the device status (eg UART_STATUS_RTS)
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceSetStatus(UART:PUARTDevice;Status:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the current line status of a UART device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''UART'''
 +
| The UART device to set the status for
 +
|-
 +
! '''Status'''
 +
| The device status flags to be set (eg UART_STATUS_RTS)
 +
|-
 +
! '''Return'''
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
! '''Note'''
 +
| Not all UART_STATUS_* flags can be set, the device may ignore invalid values
 +
Not all UART devices support set status, returns ERROR_CALL_NOT_IMPLEMENTED if not supported
 
|-
 
|-
 
|}
 
|}
Line 637: Line 754:
 
! '''Properties'''
 
! '''Properties'''
 
| Pointer to a PUARTProperties structure to fill in
 
| Pointer to a PUARTProperties structure to fill in
 +
|-
 +
! '''Return'''
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTDeviceSetProperties(UART:PUARTDevice; Properties:PUARTProperties):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the properties for the specified UART device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''UART'''
 +
| The UART device to set properties for
 +
|-
 +
! '''Properties'''
 +
| Pointer to a PUARTProperties structure to use
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 855: Line 990:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function UARTSerialDeviceStatus(Serial:PSerialDevice):LongWord;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function UARTSerialDeviceWait(Serial:PSerialDevice; Direction,Timeout:LongWord; var Count:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of SerialDeviceWait API for UART Serial</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Note'''
 +
| Not intended to be called directly by applications, use SerialDeviceWait instead
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTSerialDeviceStatus(Serial:PSerialDevice):LongWord; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of SerialDeviceStatus API for UART Serial</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of SerialDeviceStatus API for UART Serial</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 862: Line 1,009:
 
! '''Note'''
 
! '''Note'''
 
| Not intended to be called directly by applications, use SerialDeviceStatus instead
 
| Not intended to be called directly by applications, use SerialDeviceStatus instead
 +
Replaced by UARTSerialDeviceGetStatus for consistency
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTSerialDeviceGetStatus(Serial:PSerialDevice):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of SerialDeviceGetStatus API for UART Serial</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Note'''
 +
| Not intended to be called directly by applications, use SerialDeviceGetStatus instead
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function UARTSerialDeviceSetStatus(Serial:PSerialDevice; Status:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of SerialDeviceSetStatus API for UART Serial</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Note'''
 +
| Not intended to be called directly by applications, use SerialDeviceSetStatus instead
 
|-
 
|-
 
|}
 
|}
Line 943: Line 1,115:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">procedure UARTLogInfo(UART:PUARTDevice; const AText:String); inline;</pre>
 
<pre style="border: 0; padding-bottom:0px;">procedure UARTLogInfo(UART:PUARTDevice; const AText:String); inline;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Note'''
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure UARTLogWarn(UART:PUARTDevice; const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">

Revision as of 04:05, 27 March 2018

Return to Unit Reference


Description

Ultibo UART interface unit

UART (Universal Asynchronous Receiver Transmitter) devices represent the industry standard serial communications devices that are available on almost every system.

This unit implements the framework for UART devices and provides a standardized API to allow driver specific implementation to be abstracted. All UART devices are also represented as a serial device and this unit handles the relationship between the two devices.

Each UART device returns a set of properties that describe the capabilities of the device and includes a set of flags that indicate what features are supported.

Reads and writes to UART devices are unbuffered and simply pass raw data to and from the caller unless the serial interface is used instead which includes buffering of transmitted and received data. Both reads and writes allow for non blocking so that a caller can avoid waiting for received data to be available or the device to be ready to transmit.

Constants


[Expand]
UART specific constants UART_*


[Expand]
UART device type UART_TYPE_*


[Expand]
UART device mode UART_MODE_*


[Expand]
UART device state UART_STATE_*


[Expand]
UART device flag UART_FLAG_*


[Expand]
UART read flag UART_READ_*


[Expand]
UART write flag UART_WRITE_*


[Expand]
UART wait direction UART_WAIT_*


[Expand]
UART status flag UART_STATUS_*


[Expand]
UART logging UART_LOG_*


Type definitions


UART properties

[Expand]

PUARTProperties = ^TUARTProperties;

TUARTProperties = record

UART enumeration callback

TUARTEnumerate = function(UART:PUARTDevice; Data:Pointer):LongWord;

UART notification callback

TUARTNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

UART device open

TUARTDeviceOpen = function(UART:PUARTDevice; BaudRate,DataBits,StopBits,Parity,FlowControl:LongWord):LongWord;

UART device close

TUARTDeviceClose = function(UART:PUARTDevice):LongWord;

UART device read

TUARTDeviceRead = function(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

UART device write

TUARTDeviceWrite = function(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

UART device wait

TUARTDeviceWait = function(UART:PUARTDevice; Direction,Timeout:LongWord):LongWord;

UART device get status

TUARTDeviceGetStatus = function(UART:PUARTDevice):LongWord;

UART device set status

TUARTDeviceSetStatus = function(UART:PUARTDevice; Status:LongWord):LongWord;

UART device get properties

TUARTDeviceGetProperties = function(UART:PUARTDevice; Properties:PUARTProperties):LongWord;

UART device set properties

TUARTDeviceSetProperties = function(UART:PUARTDevice; Properties:PUARTProperties):LongWord;

UART device

[Expand]

PUARTDevice = ^TUARTDevice;

TUARTDevice = record


Public variables


UART logging

UART_DEFAULT_LOG_LEVEL:LongWord = UART_LOG_LEVEL_DEBUG; Minimum level for UART messages. Only messages with level greater than or equal to this will be printed.
UART_LOG_ENABLED:Boolean;


Function declarations


Initialization functions

[Expand] 
procedure UARTInit;
Description: Initialize the UART unit and UART device table


UART functions

[Expand] 
function UARTDeviceOpen(UART:PUARTDevice; BaudRate,DataBits,StopBits,Parity,FlowControl:LongWord):LongWord;
Description: Open a UART device ready for sending and receiving


[Expand] 
function UARTDeviceClose(UART:PUARTDevice):LongWord;
Description: Close a UART device and terminate sending and receiving


[Expand] 
function UARTDeviceRead(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord;var Count:LongWord):LongWord;
Description: Read data from a UART device


[Expand] 
function UARTDeviceWrite(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord;var Count:LongWord):LongWord;
Description: Write data to a UART device


[Expand] 
function UARTDeviceWait(UART:PUARTDevice; Direction,Timeout:LongWord):LongWord;
Description: Wait for data to be available in the receive or transmit FIFO of a UART device


[Expand] 
function UARTDeviceStatus(UART:PUARTDevice):LongWord; inline;
Description: Get the current line status of a UART device


[Expand] 
function UARTDeviceGetStatus(UART:PUARTDevice):LongWord;
Description: Get the current line status of a UART device


[Expand] 
function UARTDeviceSetStatus(UART:PUARTDevice;Status:LongWord):LongWord;
Description: Set the current line status of a UART device


[Expand] 
function UARTDeviceProperties(UART:PUARTDevice; Properties:PUARTProperties):LongWord; inline;
Description: Get the properties for the specified UART device


[Expand] 
function UARTDeviceGetProperties(UART:PUARTDevice;Properties:PUARTProperties):LongWord;
Description: Get the properties for the specified UART device


[Expand] 
function UARTDeviceSetProperties(UART:PUARTDevice; Properties:PUARTProperties):LongWord;
Description: Set the properties for the specified UART device


[Expand] 
function UARTDeviceCreate:PUARTDevice;
Description: Create a new UART entry


[Expand] 
function UARTDeviceCreateEx(Size:LongWord):PUARTDevice;
Description: Create a new UART entry


[Expand] 
function UARTDeviceDestroy(UART:PUARTDevice):LongWord;
Description: Destroy an existing UART entry


[Expand] 
function UARTDeviceRegister(UART:PUARTDevice):LongWord;
Description: Register a new UART in the UART table


[Expand] 
function UARTDeviceDeregister(UART:PUARTDevice):LongWord;
Description: Deregister a UART from the UART table


[Expand] 
function UARTDeviceFind(UARTId:LongWord):PUARTDevice;
Description: Find a UART device by Id in the UART table


[Expand] 
function UARTDeviceFindByName(const Name:String):PUARTDevice; inline;
Description: Find a UART device by name in the UART table


[Expand] 
function UARTDeviceFindByDescription(const Description:String):PUARTDevice; inline;
Description: Find a UART device by description in the UART table


[Expand] 
function UARTDeviceEnumerate(Callback:TUARTEnumerate; Data:Pointer):LongWord;
Description: Enumerate all UART devices in the UART table


[Expand] 
function UARTDeviceNotification(UART:PUARTDevice; Callback:TUARTNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for UART device changes


UART serial functions

[Expand] 
function UARTSerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: Implementation of SerialDeviceOpen API for UART Serial


[Expand] 
function UARTSerialDeviceClose(Serial:PSerialDevice):LongWord;
Description: Implementation of SerialDeviceClose API for UART Serial


[Expand] 
function UARTSerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Implementation of SerialDeviceRead API for UART Serial


[Expand] 
function UARTSerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Implementation of SerialDeviceWrite API for UART Serial


[Expand] 
function UARTSerialDeviceWait(Serial:PSerialDevice; Direction,Timeout:LongWord; var Count:LongWord):LongWord;
Description: Implementation of SerialDeviceWait API for UART Serial


[Expand] 
function UARTSerialDeviceStatus(Serial:PSerialDevice):LongWord; inline;
Description: Implementation of SerialDeviceStatus API for UART Serial


[Expand] 
function UARTSerialDeviceGetStatus(Serial:PSerialDevice):LongWord;
Description: Implementation of SerialDeviceGetStatus API for UART Serial


[Expand] 
function UARTSerialDeviceSetStatus(Serial:PSerialDevice; Status:LongWord):LongWord;
Description: Implementation of SerialDeviceSetStatus API for UART Serial


[Expand] 
function UARTSerialDeviceGetProperties(Serial:PSerialDevice;Properties:PSerialProperties):LongWord;
Description: Implementation of SerialDeviceGetProperties API for UART Serial


UART helper functions

[Expand] 
function UARTGetCount:LongWord; inline;
Description: Get the current UART count


[Expand] 
function UARTDeviceGetDefault:PUARTDevice; inline;
Description: Get the current default UART device


[Expand] 
function UARTDeviceSetDefault(UART:PUARTDevice):LongWord;
Description: Set the current default UART device


[Expand] 
function UARTDeviceCheck(UART:PUARTDevice):PUARTDevice;
Description: Check if the supplied UART is in the UART table


[Expand] 
procedure UARTLog(Level:LongWord;UART:PUARTDevice; const AText:String);
Description: To be documented


[Expand] 
procedure UARTLogInfo(UART:PUARTDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure UARTLogWarn(UART:PUARTDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure UARTLogError(UART:PUARTDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure UARTLogDebug(UART:PUARTDevice; const AText:String); inline;
Description: To be documented


UART serial helper functions

[Expand] 
function UARTSerialDeviceReceive(UART:PUARTDevice):LongWord;
Description: Read data from a UART device into the receive buffer of the associated Serial device


[Expand] 
function UARTSerialDeviceTransmit(UART:PUARTDevice):LongWord;
Description: Write data to a UART device from the transmit buffer of the associated Serial device


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_UART&oldid=3597"