Difference between revisions of "Unit Serial"

From Ultibo.org
Jump to: navigation, search
Line 19: Line 19:
 
----
 
----
  
−
''To be documented''
+
 
 +
<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;">'''Serial specific constants''' <code> SERIAL_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_NAME_PREFIX = 'Serial';</code>
 +
| Name prefix for Serial Devices
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>SERIAL_RECEIVE_DEPTH_DEFAULT = SIZE_2K;</code>
 +
| Default receive buffer size in bytes
 +
|-
 +
| <code>SERIAL_TRANSMIT_</code>
 +
| Default transmit buffer size in bytes
 +
|-
 +
|}
 +
</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;">'''Serial device type constants''' <code> SERIAL_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SERIAL_TYPE_UART = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_TYPE_USB = 2;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</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;">'''Serial device state constants''' <code> SERIAL_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_STATE_CLOSED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SERIAL_STATE_CLOSING = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_STATE_OPENING = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_STATE_OPEN = 3;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</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;">'''Serial device flag constants''' <code> SERIAL_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_FLAG_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_FLAG_DATA_8BIT = $00000001;</code>
 +
| Device supports 8 data bits
 +
|-
 +
| <code>SERIAL_FLAG_DATA_7BIT = $00000002;</code>
 +
| Device supports 7 data bits
 +
|-
 +
| <code>SERIAL_FLAG_DATA_6BIT = $00000004;</code>
 +
| Device supports 6 data bits
 +
|-
 +
| <code>SERIAL_FLAG_DATA_5BIT = $00000008;</code>
 +
| Device supports 5 data bits
 +
|-
 +
| <code>SERIAL_FLAG_STOP_1BIT = $00000010;</code>
 +
| Device supports 1 stop bit
 +
|-
 +
| <code>SERIAL_FLAG_STOP_2BIT = $00000020;</code>
 +
| Device supports 2 stop bits
 +
|-
 +
| <code>SERIAL_FLAG_STOP_1BIT5 = $00000040;</code>
 +
| Device supports 1.5 stop bits
 +
|-
 +
| <code>SERIAL_FLAG_PARITY_ODD = $00000080;</code>
 +
| Device supports odd parity
 +
|-
 +
| <code>SERIAL_FLAG_PARITY_EVEN = $00000100;</code>
 +
| Device supports even parity
 +
|-
 +
| <code>SERIAL_FLAG_PARITY_MARK = $00000200;</code>
 +
| Device supports mark parity
 +
|-
 +
| <code>SERIAL_FLAG_PARITY_SPACE = $00000400;</code>
 +
| Device supports space parity
 +
|-
 +
| <code>SERIAL_FLAG_FLOW_RTS_CTS = $00000800;</code>
 +
| Device supports RTS/CTS flow control
 +
|-
 +
| <code>SERIAL_FLAG_FLOW_DSR_DTR = $00001000;</code>
 +
| Device supports DSR/DTR flow control
 +
|-
 +
|}
 +
</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;">'''Serial read flag constants''' <code> SERIAL_READ_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_READ_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_READ_NON_BLOCK = $00000001;</code>
 +
| Do not block when reading, if the buffer is empty return immediately
 +
|-
 +
| <code>SERIAL_READ_PEEK_BUFFER = $00000002;</code>
 +
| Return the number of bytes available in the receive buffer without reading them
 +
|-
 +
|}
 +
</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;">'''Serial write flag constants''' <code> SERIAL_WRITE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_WRITE_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_WRITE_NON_BLOCK = $00000001;</code>
 +
| Do not block when writing, if the buffer is full return immediately
 +
|-
 +
| <code>SERIAL_WRITE_PEEK_BUFFER = $00000002;</code>
 +
| Return the number of bytes free in the transmit buffer without writing anything
 +
|-
 +
|}
 +
</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;">'''Serial status flag constants''' <code> SERIAL_STATUS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_STATUS_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SERIAL_STATUS_RTS = $00000001;</code>
 +
| RTS (Request to Send) is set (If applicable)
 +
|-
 +
| <code>SERIAL_STATUS_CTS = $00000002;</code>
 +
| CTS (Clear to Send) is set (If applicable)
 +
|-
 +
| <code>SERIAL_STATUS_DSR = $00000004;</code>
 +
| DSR (Data Set Ready) is set (If applicable)
 +
|-
 +
| <code>SERIAL_STATUS_DTR = $00000008;</code>
 +
| DTR (Data Terminal Ready) is set (If applicable)
 +
|-
 +
| <code>SERIAL_STATUS_RX_FULL = $00000010;</code>
 +
| Receive buffer is full
 +
|-
 +
| <code>SERIAL_STATUS_RX_EMPTY = $00000020;</code>
 +
| Receive buffer is empty
 +
|-
 +
| <code>SERIAL_STATUS_TX_FULL = $00000040;</code>
 +
| Transmit buffer is full
 +
|-
 +
| <code>SERIAL_STATUS_TX_EMPTY = $00000080;</code>
 +
| Transmit buffer is empty
 +
|-
 +
| <code>SERIAL_STATUS_BUSY = $00000100;</code>
 +
| Device is busy
 +
|-
 +
| <code>SERIAL_STATUS_BREAK_ERROR = $00000200;</code>
 +
| Break error reported
 +
|-
 +
| <code>SERIAL_STATUS_PARITY_ERROR = $00000400;</code>
 +
| Parity error reported
 +
|-
 +
| <code>SERIAL_STATUS_FRAMING_ERROR = $00000800;</code>
 +
| Framing error reported
 +
|-
 +
| <code>SERIAL_STATUS_OVERRUN_ERROR = $00001000;</code>
 +
| Overrun error reported
 +
|-
 +
| <code>SERIAL_STATUS_DCD = $00002000;</code>
 +
| DCD (Data Carrier Detect) is set (If applicable)
 +
|-
 +
| <code>SERIAL_STATUS_RI = $00004000;</code>
 +
| RI (Ring Indicator) is set (If applicable)
 +
|-
 +
|}
 +
</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;">'''Serial logging constants''' <code> SERIAL_LOG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>SERIAL_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;</code>
 +
| Serial debugging messages
 +
|-
 +
| <code>SERIAL_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 +
| Serial informational messages, such as a device being attached or detached
 +
|-
 +
| <code>SERIAL_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 +
| Serial error messages
 +
|-
 +
| <code>SERIAL_LOG_LEVEL_NONE = LOG_LEVEL_NONE;</code>
 +
| No Serial messages
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===

Revision as of 03:17, 29 November 2016

Return to Unit Reference


Description

Serial devices represent a communication device that can be both read and written and has a set of common properties and capabilities. The underlying device may be an actual UART or it may be some other form of device such as a USB to Serial converter. As long as the device can implement the common capabilities then it can be accessed as a serial device without regard to the actual implementation.

Each serial 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 from and writes to serial devices are buffered so that varying data transfer rates can be accomodated and 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.

This unit also implements the serial logging device which can be configured via parameters in the GlobalConfig unit or from the command line.

Constants


[Expand]
Serial specific constants SERIAL_*


[Expand]
Serial device type constants SERIAL_TYPE_*


[Expand]
Serial device state constants SERIAL_STATE_*


[Expand]
Serial device flag constants SERIAL_FLAG_*


[Expand]
Serial read flag constants SERIAL_READ_*


[Expand]
Serial write flag constants SERIAL_WRITE_*


[Expand]
Serial status flag constants SERIAL_STATUS_*


[Expand]
Serial logging constants SERIAL_LOG_*


Type definitions

To be documented

Public variables

To be documented

Function declarations


Initialization functions

[Expand] 
procedure SerialInit;
Description: Initialize the Serial unit and Serial device table


Serial functions

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


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


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


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


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


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


[Expand] 
function SerialDeviceCreate:PSerialDevice;
Description: Create a new Serial entry


[Expand] 
function SerialDeviceCreateEx(Size:LongWord):PSerialDevice;
Description: Create a new Serial entry


[Expand] 
function SerialDeviceDestroy(Serial:PSerialDevice):LongWord;
Description: Destroy an existing Serial entry


[Expand] 
function SerialDeviceRegister(Serial:PSerialDevice):LongWord;
Description: Register a new Serial in the Serial table


[Expand] 
function SerialDeviceDeregister(Serial:PSerialDevice):LongWord;
Description: Deregister a Serial ?rom the Serial table


[Expand] 
function SerialDeviceFind(SerialId:LongWord):PSerialDevice;
Description: To be documented


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


[Expand] 
function SerialDeviceFindByDescription(const Description:String):PSerialDevice; inline;
Description: To be documented


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


[Expand] 
function SerialDeviceNotification(Serial:PSerialDevice; Callback:TSerialNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Serial logging functions

[Expand] 
function SerialLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented


RTL serial functions

[Expand] 
function SysSerialAvailable:Boolean;
Description: Check if a Serial device is available


[Expand] 
function SysSerialOpen(BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: Open the default Serial device ready for sending and receiving


[Expand] 
function SysSerialClose:LongWord;
Description: Close the default Serial device and terminate sending and receiving


[Expand] 
function SysSerialRead(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Read data ?rom the default Serial device


[Expand] 
function SysSerialWrite(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to the default Serial device


Serial helper functions

[Expand] 
function SerialGetCount:LongWord; inline;
Description: Get the current Serial count


[Expand] 
function SerialDeviceGetDefault:PSerialDevice; inline;
Description: Get the current default Serial device


[Expand] 
function SerialDeviceSetDefault(Serial:PSerialDevice):LongWord;
Description: Set the current default Serial device


[Expand] 
function SerialDeviceCheck(Serial:PSerialDevice):PSerialDevice;
Description: Check if the supplied Serial is in the Serial table


[Expand] 
function SerialBufferReadStart(Buffer:PSerialBuffer; var Available:LongWord):Pointer;
Description: Return a pointer to the next read ?rom the buffer and the number of bytes that can be read


[Expand] 
function SerialBufferReadComplete(Buffer:PSerialBuffer; Removed:LongWord):Boolean;
Description: Update the buffer to reflect the number of bytes removed when reading


[Expand] 
function SerialBufferWriteStart(Buffer:PSerialBuffer; var Available:LongWord):Pointer;
Description: Return a pointer to the next write to the buffer and the number of bytes that can be written


[Expand] 
function SerialBufferWriteComplete(Buffer:PSerialBuffer; Added:LongWord):Boolean;
Description: Update the buffer to reflect the number of bytes added when writing


[Expand] 
procedure SerialLog(Level:LongWord; Serial:PSerialDevice; const AText:String);
Description: To be documented


[Expand] 
procedure SerialLogInfo(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SerialLogError(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SerialLogDebug(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
function SerialParityToString(Parity:LongWord):String;
Description: To be documented


[Expand] 
function SerialFlowControlToString(Flow:LongWord):String;
Description: To be documented


Serial logging helper functions

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


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


[Expand] 
function SerialLoggingDeviceParameters(Serial:PSerialDevice; const Parameters:String; var BaudRate,Parity,DataBits,StopBits:LongWord):LongWord;
Description: Break down the serial parameters value into component parts of baud rate, parity, data bits and stop bits


[Expand] 
function SerialLoggingFirstWord(var Value:String;const Delimiter:String):String;
Description: To be documented


[Expand] 
function SerialLoggingDeviceEnum(Serial:PSerialDevice; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
Description: To be documented


Return to Unit Reference

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