Difference between revisions of "Unit UART"

From Ultibo.org
Jump to: navigation, search
Line 31: Line 31:
 
<br />  
 
<br />  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 device type constants''' <code> UART_TYPE_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART device type''' <code> UART_TYPE_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 51: Line 51:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 device mode constants''' <code> UART_MODE_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART device mode''' <code> UART_MODE_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 68: Line 68:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 device state constants''' <code> UART_STATE_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART device state''' <code> UART_STATE_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 82: Line 82:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 device flag constants''' <code> UART_FLAG_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART device flag''' <code> UART_FLAG_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 132: Line 132:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 read flag constants''' <code> UART_READ_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART read flag''' <code> UART_READ_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 146: Line 146:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 write flag constants''' <code> UART_WRITE_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART write flag''' <code> UART_WRITE_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 160: Line 160:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 status flag constants''' <code> UART_STATUS_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART status flag''' <code> UART_STATUS_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 216: Line 216:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<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 logging constants''' <code> UART_LOG_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''UART logging''' <code> UART_LOG_* </code></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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 448: Line 448:
 
|-
 
|-
 
| <code>UART_DEFAULT_LOG_LEVEL:LongWord = UART_LOG_LEVEL_DEBUG;</code>
 
| <code>UART_DEFAULT_LOG_LEVEL:LongWord = UART_LOG_LEVEL_DEBUG;</code>
−
| style="width: 65%;"|Minimum level for UART messages. Only messages with level greater than or equal to this will be printed.
+
| style="width: 40%;"|Minimum level for UART messages. Only messages with level greater than or equal to this will be printed.
 
|-
 
|-
 
|}
 
|}
Line 454: Line 454:
 
|-
 
|-
 
| <code>UART_LOG_ENABLED:Boolean;</code>
 
| <code>UART_LOG_ENABLED:Boolean;</code>
−
| style="width: 65%;"|
+
| style="width: 40%;"|
 
|-
 
|-
 
|}
 
|}

Revision as of 04:42, 27 March 2017

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 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 status

TUARTDeviceStatus = function(UART:PUARTDevice):LongWord;

UART device properties

TUARTDeviceProperties = 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: To be documented


[Expand] 
function UARTDeviceClose(UART:PUARTDevice):LongWord;
Description: To be documented


[Expand] 
function UARTDeviceRead(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord;var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function UARTDeviceWrite(UART:PUARTDevice; Buffer:Pointer; Size,Flags:LongWord;var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function UARTDeviceStatus(UART:PUARTDevice):LongWord;
Description: To be documented


[Expand] 
function UARTDeviceProperties(UART:PUARTDevice; Properties:PUARTProperties):LongWord;
Description: To be documented


[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: To be documented


[Expand] 
function UARTDeviceFindByName(const Name:String):PUARTDevice; inline;
Description: To be documented


[Expand] 
function UARTDeviceFindByDescription(const Description:String):PUARTDevice; inline;
Description: To be documented


[Expand] 
function UARTDeviceEnumerate(Callback:TUARTEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function UARTDeviceNotification(UART:PUARTDevice; Callback:TUARTNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


UART serial functions

[Expand] 
function UARTSerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: To be documented


[Expand] 
function UARTSerialDeviceClose(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function UARTSerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function UARTSerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function UARTSerialDeviceStatus(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function UARTSerialDeviceProperties(Serial:PSerialDevice; Properties:PSerialProperties):LongWord;
Description: To be documented


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 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: To be documented


[Expand] 
function UARTSerialDeviceTransmit(UART:PUARTDevice):LongWord;
Description: To be documented


Return to Unit Reference

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