Difference between revisions of "Unit Devices"

From Ultibo.org
Jump to: navigation, search
Line 347: Line 347:
 
| <code>DRIVER_CLASS_ANY = $FFFFFFFF;</code>
 
| <code>DRIVER_CLASS_ANY = $FFFFFFFF;</code>
 
| Any Driver (Pass to DriverFind or DriverEnumerate to match all drivers)
 
| Any Driver (Pass to DriverFind or DriverEnumerate to match all drivers)
 +
|-
 +
|}
 +
</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;">'''Host specific constants''' <code> HOST_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>HOST_NAME_PREFIX = 'Host';</code>
 +
| Name prefix for Hosts
 +
|-
 +
|}
 +
</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;">'''Host signature constants''' <code> HOST_SIGNATURE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>HOST_SIGNATURE = $F45D30FE;</code>
 +
| style="width: 50%;"|&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;">'''Host state constants''' <code> HOST_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>HOST_STATE_UNREGISTERED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>HOST_STATE_REGISTERED = 1;</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;">'''Host Id constants''' <code> HOST_ID_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>HOST_ID_ANY = $FFFFFFFF;</code>
 +
| Any Host (Pass to HostFind to match all hosts)
 +
|-
 +
|}
 +
</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;">'''Host class constants''' <code> HOST_CLASS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>HOST_CLASS_NONE = 0;</code>
 +
| No Host}
 +
|-
 +
| <code>HOST_CLASS_USB = 1;</code>
 +
| A USB Host (eg XHCI/EHCI/UHCI/OHCI or DWCOTG etc) (Implementing a standard USB host interface)
 +
|-
 +
| <code>HOST_CLASS_PCI = 2;</code>
 +
| A PCI Host (eg AHCI etc) (Implementing a standard PCI host interface)
 +
|-
 +
| <code>HOST_CLASS_SD = 3;</code>
 +
| An SD Host (eg MMC/SDIO etc) (Implementing a standard SD host interface)
 +
|-
 +
| <code>HOST_CLASS_BLUETOOTH = 4;</code>
 +
| A Bluetooth Host (Implementing a standard Bluetooth host interface)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>HOST_CLASS_MAX = 4;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>HOST_CLASS_ANY = $FFFFFFFF;</code>
 +
| Any Host (Pass to HostFind or HostEnumerate to match all hosts)
 +
|-
 +
|}
 +
</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;">'''Clock specific constants''' <code> CLOCK_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>CLOCK_NAME_PREFIX = 'Clock';</code>
 +
| Name prefix for Clock Devices
 +
|-
 +
|}
 +
</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;">'''Clock device type constants''' <code> CLOCK_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>CLOCK_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>CLOCK_TYPE_HARDWARE = 1;</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;">'''Clock device state constants''' <code> CLOCK_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>CLOCK_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>CLOCK_STATE_ENABLED = 1;</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;">'''Clock device flag constants''' <code> CLOCK_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>CLOCK_FLAG_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>CLOCK_FLAG_WRITABLE = $00000001;</code>
 +
| Device supports writing the clock value
 +
|-
 +
|}
 +
</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;">'''Timer specific constants''' <code> TIMER_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>TIMER_NAME_PREFIX = 'Timer';</code>
 +
| Name prefix for Timer Devices
 +
|-
 +
|}
 +
</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;">'''Timer device type constants''' <code> TIMER_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>TIMER_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>TIMER_TYPE_HARDWARE = 1;</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;">'''Timer device state constants''' <code> TIMER_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>TIMER_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>TIMER_STATE_ENABLED = 1;</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;">'''Timer device flag constants''' <code> TIMER_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>TIMER_FLAG_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TIMER_FLAG_WRAPPING = $00000001;</code>
 +
| Device provides a wrapping or self reloading counter
 +
|-
 +
| <code>TIMER_FLAG_COUNTER = $00000002;</code>
 +
| Device will appear as a continuously incrementing counter when read
 +
|-
 +
| <code>TIMER_FLAG_DOWN = $00000004;</code>
 +
| Device counts down from the starting value to zero (And optionally triggers an event)
 +
|-
 +
|}
 +
</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;">'''Timer event flag constants''' <code> TIMER_EVENT_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>TIMER_EVENT_FLAG_NONE = $00000000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TIMER_EVENT_FLAG_REPEAT = $00000001;</code>
 +
| Event will be repeated until cancelled
 +
|-
 +
| <code>TIMER_EVENT_FLAG_INTERRUPT = $00000002;</code>
 +
| Event will be dispatched by interrupt handler (If applicable). Caution: Events called by the interrupt handler must obey interrupt rules with regard to locks, memory allocation and latency.
 +
|-
 +
|}
 +
</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;">'''Random specific constants''' <code> RANDOM_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>RANDOM_NAME_PREFIX = 'Random';</code>
 +
| Name prefix for Random Devices
 +
|-
 +
|}
 +
</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;">'''Random device type constants''' <code> RANDOM_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>RANDOM_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>RANDOM_TYPE_HARDWARE = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>RANDOM_TYPE_SOFTWARE = 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;">'''Random device state constants''' <code> RANDOM_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>RANDOM_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>RANDOM_STATE_ENABLED = 1;</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;">'''Random device flag constants''' <code> RANDOM_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>RANDOM_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&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;">'''Mailbox specific constants''' <code> MAILBOX_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MAILBOX_NAME_PREFIX = 'Mailbox';</code>
 +
| Name prefix for Mailbox Devices
 +
|-
 +
|}
 +
</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;">'''Mailbox device type constants''' <code> MAILBOX_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MAILBOX_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MAILBOX_TYPE_GPU = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAILBOX_TYPE_LOCAL = 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;">'''Mailbox device state constants''' <code> MAILBOX_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MAILBOX_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MAILBOX_STATE_ENABLED = 1;</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;">'''Mailbox device flag constants''' <code> MAILBOX_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MAILBOX_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&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;">'''Watchdog specific constants''' <code> WATCHDOG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>WATCHDOG_NAME_PREFIX = 'Watchdog';</code>
 +
| Name prefix for Watchdog Devices
 +
|-
 +
|}
 +
</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;">'''Watchdog device type constants''' <code> WATCHDOG_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>WATCHDOG_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>WATCHDOG_TYPE_HARDWARE = 1;</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;">'''Watchdog device state constants''' <code> WATCHDOG_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>WATCHDOG_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>WATCHDOG_STATE_ENABLED = 1;</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;">'''Watchdog device flag constants''' <code> WATCHDOG_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>WATCHDOG_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&nbsp;
 
|-
 
|-
 
|}
 
|}

Revision as of 01:00, 25 November 2016

Return to Unit Reference


Description

To be documented

Constants


[Expand]
Device specific constants DEVICE_*


[Expand]
Device signature constants DEVICE_SIGNATURE_*


[Expand]
Device bus constants DEVICE_BUS_*


[Expand]
Device state constants DEVICE_STATE_*


[Expand]
Device Id constants DEVICE_ID_*


[Expand]
Device notification flag constants DEVICE_NOTIFICATION_*


[Expand]
Notifier signature constants NOTIFIER_SIGNATURE_*


[Expand]
Notifier state constants NOTIFIER_STATE_*


[Expand]
Notifier flag constants NOTIFIER_FLAG_*


[Expand]
Device logging constants DEVICE_LOG_*


[Expand]
Driver specific constants DRIVER_*


[Expand]
Driver signature constants DRIVER_SIGNATURE_*


[Expand]
Driver state constants DRIVER_STATE_*


[Expand]
Driver Id constants DRIVER_ID_*


[Expand]
Driver class constants DRIVER_CLASS_*


[Expand]
Host specific constants HOST_*


[Expand]
Host signature constants HOST_SIGNATURE_*


[Expand]
Host state constants HOST_STATE_*


[Expand]
Host Id constants HOST_ID_*


[Expand]
Host class constants HOST_CLASS_*


[Expand]
Clock specific constants CLOCK_*


[Expand]
Clock device type constants CLOCK_TYPE_*


[Expand]
Clock device state constants CLOCK_STATE_*


[Expand]
Clock device flag constants CLOCK_FLAG_*


[Expand]
Timer specific constants TIMER_*


[Expand]
Timer device type constants TIMER_TYPE_*


[Expand]
Timer device state constants TIMER_STATE_*


[Expand]
Timer device flag constants TIMER_FLAG_*


[Expand]
Timer event flag constants TIMER_EVENT_FLAG_*


[Expand]
Random specific constants RANDOM_*


[Expand]
Random device type constants RANDOM_TYPE_*


[Expand]
Random device state constants RANDOM_STATE_*


[Expand]
Random device flag constants RANDOM_FLAG_*


[Expand]
Mailbox specific constants MAILBOX_*


[Expand]
Mailbox device type constants MAILBOX_TYPE_*


[Expand]
Mailbox device state constants MAILBOX_STATE_*


[Expand]
Mailbox device flag constants MAILBOX_FLAG_*


[Expand]
Watchdog specific constants WATCHDOG_*


[Expand]
Watchdog device type constants WATCHDOG_TYPE_*


[Expand]
Watchdog device state constants WATCHDOG_STATE_*


[Expand]
Watchdog device flag constants WATCHDOG_FLAG_*


Type definitions

To be documented

Public variables

To be documented

Function declarations


Initialization functions

[Expand] 
procedure DevicesInit;
Description: Initialize the Devices unit and device, notifier and driver tables


Device functions

[Expand] 
function DeviceCreate:PDevice;
Description: Create a new Device entry


[Expand] 
function DeviceCreateEx(Size:LongWord):PDevice;
Description: Create a new Device entry


[Expand] 
function DeviceDestroy(Device:PDevice):LongWord;
Description: Destroy an existing Device entry


[Expand] 
function DeviceGetName(Device:PDevice):String;
Description: Get the name of the supplied Device


[Expand] 
function DeviceSetName(Device:PDevice; const Name:String):LongWord;
Description: Set the name of the supplied Device


[Expand] 
function DeviceGetDescription(Device:PDevice):String;
Description: Get the description of the supplied Device


[Expand] 
function DeviceSetDescription(Device:PDevice; const Description:String):LongWord;
Description: Set the description of the supplied Device


[Expand] 
function DeviceRegister(Device:PDevice):LongWord;
Description: Register a new Device in the Device table


[Expand] 
function DeviceDeregister(Device:PDevice):LongWord;
Description: Deregister a Device from the Device table


[Expand] 
function DeviceFind(DeviceClass,DeviceId:LongWord):PDevice;
Description: To be documented


[Expand] 
function DeviceFindByName(const Name:String):PDevice;
Description: To be documented


[Expand] 
function DeviceFindByDescription(const Description:String):PDevice;
Description: To be documented


[Expand] 
function DeviceEnumerate(DeviceClass:LongWord; Callback:TDeviceEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function DeviceNotification(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


[Expand] 
function NotifierAllocate(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):PNotifier;
Description: Create and Register a new Notifier entry in the Notifier table


[Expand] 
function NotifierRelease(Notifier:PNotifier):LongWord;
Description: Deregister and Destroy a Notifier from the Notifier table


[Expand] 
function NotifierFind(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer):PNotifier;
Description: To be documented


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


Driver functions

[Expand] 
function DriverCreate:PDriver;
Description: Create a new Driver entry


[Expand] 
function DriverCreateEx(Size:LongWord):PDriver;
Description: Create a new Driver entry


[Expand] 
function DriverDestroy(Driver:PDriver):LongWord;
Description: Destroy an existing Driver entry


[Expand] 
function DriverGetName(Driver:PDriver):String;
Description: Get the name of the supplied Driver


[Expand] 
function DriverSetName(Driver:PDriver; const Name:String):LongWord;
Description: Set the name of the supplied Driver


[Expand] 
function DriverRegister(Driver:PDriver):LongWord;
Description: Register a new Driver in the Driver table


[Expand] 
function DriverDeregister(Driver:PDriver):LongWord;
Description: Deregister a Driver from the Driver table


[Expand] 
function DriverFind(DriverClass,DriverId:LongWord):PDriver;
Description: To be documented


[Expand] 
function DriverFindByName(const Name:String):PDriver;
Description: To be documented


[Expand] 
function DriverEnumerate(DriverClass:LongWord; Callback:TDriverEnumerate; Data:Pointer):LongWord;
Description: To be documented


Clock device functions

[Expand] 
function ClockDeviceStart(Clock:PClockDevice):LongWord;
Description: To be documented


[Expand] 
function ClockDeviceStop(Clock:PClockDevice):LongWord;
Description: To be documented


[Expand] 
function ClockDeviceRead(Clock:PClockDevice):LongWord;
Description: To be documented


[Expand] 
function ClockDeviceRead64(Clock:PClockDevice):Int64;
Description: To be documented


[Expand] 
function ClockDeviceWrite64(Clock:PClockDevice; const Value:Int64):LongWord;
Description: To be documented


[Expand] 
function ClockDeviceGetRate(Clock:PClockDevice):LongWord;
Description: To be documented


[Expand] 
function ClockDeviceCreate:PClockDevice;
Description: Create a new Clock entry


[Expand] 
function ClockDeviceCreateEx(Size:LongWord):PClockDevice;
Description: Create a new Clock entry


[Expand] 
function ClockDeviceDestroy(Clock:PClockDevice):LongWord;
Description: Destroy an existing Clock entry


[Expand] 
function ClockDeviceRegister(Clock:PClockDevice):LongWord;
Description: Register a new Clock in the Clock table


[Expand] 
function ClockDeviceDeregister(Clock:PClockDevice):LongWord;
Description: Deregister a Clock from the Clock table


[Expand] 
function ClockDeviceFind(ClockId:LongWord):PClockDevice;
Description: To be documented


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


[Expand] 
function ClockDeviceFindByDescription(const Description:String):PClockDevice; inline;
Description: To be documented


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


[Expand] 
function ClockDeviceNotification(Clock:PClockDevice; Callback:TClockNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Timer device functions

[Expand] 
function TimerDeviceStart(Timer:PTimerDevice):LongWord;
Description: Start the clock and counter of the specified Timer device


[Expand] 
function TimerDeviceStop(Timer:PTimerDevice):LongWord;
Description: Stop the clock and counter of the specified Timer device


[Expand] 
function TimerDeviceRead(Timer:PTimerDevice):LongWord;
Description: Read the current value of the specified Timer device


[Expand] 
function TimerDeviceRead64(Timer:PTimerDevice):Int64;
Description: Read the current value of the specified Timer device


[Expand] 
function TimerDeviceWait(Timer:PTimerDevice):LongWord;
Description: Wait for the current interval to expire on the specified Timer device


[Expand] 
function TimerDeviceEvent(Timer:PTimerDevice; Flags:LongWord; Callback:TTimerCallback; Data:Pointer):LongWord;
Description: Schedule a function to be called when the current interval expires on the specified Timer device


[Expand] 
function TimerDeviceCancel(Timer:PTimerDevice):LongWord;
Description: Cancel a previously scheduled event callback function on the specified Timer device


[Expand] 
function TimerDeviceGetRate(Timer:PTimerDevice):LongWord;
Description: Get the current clock rate in Hz of the specified Timer device


[Expand] 
function TimerDeviceSetRate(Timer:PTimerDevice; Rate:LongWord):LongWord;
Description: Set the current clock rate in Hz of the specified Timer device


[Expand] 
function TimerDeviceGetInterval(Timer:PTimerDevice):LongWord;
Description: Get the current interval in ticks of the specified Timer device


[Expand] 
function TimerDeviceSetInterval(Timer:PTimerDevice; Interval:LongWord):LongWord;
Description: Set the current interval in ticks of the specified Timer device


[Expand] 
function TimerDeviceProperties(Timer:PTimerDevice; Properties:PTimerProperties):LongWord;
Description: Get the properties for the specified Timer device


[Expand] 
function TimerDeviceCreate:PTimerDevice;
Description: Create a new Timer entry


[Expand] 
function TimerDeviceCreateEx(Size:LongWord):PTimerDevice;
Description: Create a new Timer entry


[Expand] 
function TimerDeviceDestroy(Timer:PTimerDevice):LongWord;
Description: Destroy an existing Timer entry


[Expand] 
function TimerDeviceRegister(Timer:PTimerDevice):LongWord;
Description: Register a new Timer in the Timer table


[Expand] 
function TimerDeviceDeregister(Timer:PTimerDevice):LongWord;
Description: Deregister a Timer from the Timer table


[Expand] 
function TimerDeviceFind(TimerId:LongWord):PTimerDevice;
Description: Find a timer device by ID in the timer table


[Expand] 
function TimerDeviceFindByName(const Name:String):PTimerDevice; inline;
Description: Find a timer device by name in the timer table


[Expand] 
function TimerDeviceFindByDescription(const Description:String):PTimerDevice; inline;
Description: Find a timer device by description in the timer table


[Expand] 
function TimerDeviceEnumerate(Callback:TTimerEnumerate; Data:Pointer):LongWord;
Description: Enumerate all timer devices in the timer table


[Expand] 
function TimerDeviceNotification(Timer:PTimerDevice; Callback:TTimerNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for timer device changes


Random device functions

[Expand] 
function RandomDeviceStart(Random:PRandomDevice):LongWord;
Description: To be documented


[Expand] 
function RandomDeviceStop(Random:PRandomDevice):LongWord;
Description: To be documented


[Expand] 
function RandomDeviceSeed(Random:PRandomDevice; Seed:LongWord):LongWord;
Description: To be documented


[Expand] 
function RandomDeviceReadByte(Random:PRandomDevice):Byte;
Description: To be documented


[Expand] 
function RandomDeviceReadWord(Random:PRandomDevice):Word;
Description: To be documented


[Expand] 
function RandomDeviceReadLongWord(Random:PRandomDevice):LongWord;
Description: To be documented


[Expand] 
function RandomDeviceReadQuadWord(Random:PRandomDevice):Int64;
Description: To be documented


[Expand] 
function RandomDeviceReadExtended(Random:PRandomDevice):Extended;
Description: To be documented


[Expand] 
function RandomDeviceCreate:PRandomDevice;
Description: Create a new Random entry


[Expand] 
function RandomDeviceCreateEx(Size:LongWord):PRandomDevice;
Description: Create a new Random entry


[Expand] 
function RandomDeviceDestroy(Random:PRandomDevice):LongWord;
Description: Destroy an existing Random entry


[Expand] 
function RandomDeviceRegister(Random:PRandomDevice):LongWord;
Description: Register a new Random in the Random table


[Expand] 
function RandomDeviceDeregister(Random:PRandomDevice):LongWord;
Description: Deregister a Random from the Random table


[Expand] 
function RandomDeviceFind(RandomId:LongWord):PRandomDevice;
Description: To be documented


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


[Expand] 
function RandomDeviceFindByDescription(const Description:String):PRandomDevice; inline;
Description: To be documented


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


[Expand] 
function RandomDeviceNotification(Random:PRandomDevice; Callback:TRandomNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Mailbox device functions

[Expand] 
function MailboxDeviceStart(Mailbox:PMailboxDevice):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceStop(Mailbox:PMailboxDevice):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceReceive(Mailbox:PMailboxDevice; Channel:LongWord):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceSend(Mailbox:PMailboxDevice; Channel,Data:LongWord):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceCall(Mailbox:PMailboxDevice; Channel,Data:LongWord; var Response:LongWord):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceGetTimeout(Mailbox:PMailboxDevice):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceSetTimeout(Mailbox:PMailboxDevice; Timeout:LongWord):LongWord;
Description: To be documented


[Expand] 
function MailboxDeviceCreate:PMailboxDevice;
Description: Create a new Mailbox entry


[Expand] 
function MailboxDeviceCreateEx(Size:LongWord):PMailboxDevice;
Description: Create a new Mailbox entry


[Expand] 
function MailboxDeviceDestroy(Mailbox:PMailboxDevice):LongWord;
Description: Destroy an existing Mailbox entry


[Expand] 
function MailboxDeviceRegister(Mailbox:PMailboxDevice):LongWord;
Description: Register a new Mailbox in the Mailbox table


[Expand] 
function MailboxDeviceDeregister(Mailbox:PMailboxDevice):LongWord;
Description: Deregister a Mailbox from the Mailbox table


[Expand] 
function MailboxDeviceFind(MailboxId:LongWord):PMailboxDevice;
Description: To be documented


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


[Expand] 
function MailboxDeviceFindByDescription(const Description:String):PMailboxDevice; inline;
Description: To be documented


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


[Expand] 
function MailboxDeviceNotification(Mailbox:PMailboxDevice; Callback:TMailboxNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Watchdog device functions

[Expand] 
function WatchdogDeviceStart(Watchdog:PWatchdogDevice):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceStop(Watchdog:PWatchdogDevice):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceRefresh(Watchdog:PWatchdogDevice):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceGetRemain(Watchdog:PWatchdogDevice):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceGetTimeout(Watchdog:PWatchdogDevice):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceSetTimeout(Watchdog:PWatchdogDevice; Timeout:LongWord):LongWord;
Description: To be documented


[Expand] 
function WatchdogDeviceCreate:PWatchdogDevice;
Description: Create a new Watchdog entry


[Expand] 
function WatchdogDeviceCreateEx(Size:LongWord):PWatchdogDevice;
Description: Create a new Watchdog entry


[Expand] 
function WatchdogDeviceDestroy(Watchdog:PWatchdogDevice):LongWord;
Description: Destroy an existing Watchdog entry


[Expand] 
function WatchdogDeviceRegister(Watchdog:PWatchdogDevice):LongWord;
Description: Register a new Watchdog in the Watchdog table


[Expand] 
function WatchdogDeviceDeregister(Watchdog:PWatchdogDevice):LongWord;
Description: Deregister a Watchdog from the Watchdog table


[Expand] 
function WatchdogDeviceFind(WatchdogId:LongWord):PWatchdogDevice;
Description: To be documented


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


[Expand] 
function WatchdogDeviceFindByDescription(const Description:String):PWatchdogDevice; inline;
Description: To be documented


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


[Expand] 
function WatchdogDeviceNotification(Watchdog:PWatchdogDevice; Callback:TWatchdogNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


RTL clock functions

[Expand] 
function SysClockRead:LongWord;
Description: To be documented


[Expand] 
function SysClockRead64:Int64;
Description: To be documented


RTL timer (counter) functions

[Expand] 
function SysTimerAvailable:Boolean;
Description: Check if a timer device is available


[Expand] 
function SysTimerRead:LongWord;
Description: Read the current value of the default counter


[Expand] 
function SysTimerRead64:Int64;
Description: Read the current value of the default counter


[Expand] 
function SysTimerWait:LongWord;
Description: Wait for the current interval to expire on the default counter


[Expand] 
function SysTimerEvent(Callback:TTimerCallback; Data:Pointer):LongWord;
Description: Schedule a function to be called when the current interval expires on the default counter


[Expand] 
function SysTimerCancel:LongWord;
Description: Cancel a previously scheduled event callback function on the default counter


[Expand] 
function SysTimerGetRate:LongWord;
Description: Get the current clock rate in Hz of the default counter


[Expand] 
function SysTimerSetRate(Rate:LongWord):LongWord;
Description: Set the current clock rate in Hz of the default counter


[Expand] 
function SysTimerGetInterval:LongWord;
Description: Get the current interval in ticks of the default counter


[Expand] 
function SysTimerSetInterval(Interval:LongWord):LongWord;
Description: Set the current interval in ticks of the default counter


RTL random functions

[Expand] 
function SysRandomAvailable:Boolean;
Description: Check if a random (RNG) device is available


[Expand] 
procedure SysRandomize;
Description: To be documented


[Expand] 
procedure SysRandomSeed(Seed:LongWord);
Description: To be documented


[Expand] 
function SysRandomReadLongInt(Limit:LongInt):LongInt;
Description: To be documented


[Expand] 
function SysRandomReadInt64(Limit:Int64):Int64;
Description: To be documented


[Expand] 
function SysRandomReadExtended:Extended;
Description: To be documented


RTL watchdog functions

[Expand] 
function SysWatchdogAvailable:Boolean;
Description: Check if a watchdog timer device is available


[Expand] 
function SysWatchdogStart(Milliseconds:LongWord):LongWord;
Description: To be documented


[Expand] 
function SysWatchdogStop:LongWord;
Description: To be documented


[Expand] 
function SysWatchdogRefresh(Milliseconds:LongWord):LongWord;
Description: To be documented


Device helper functions

[Expand] 
function DeviceGetCount:LongWord; inline;
Description: Get the current device count


[Expand] 
function DeviceCheck(Device:PDevice):PDevice;
Description: Check if the supplied Device is in the device table


[Expand] 
function NotifierGetCount:LongWord; inline;
Description: Get the current notifier count


[Expand] 
function NotifierCheck(Notifier:PNotifier):PNotifier;
Description: Check if the supplied Notifier is in the notifier table


[Expand] 
function DeviceBusToString(DeviceBus:LongWord):String;
Description: To be documented


[Expand] 
function DeviceStateToString(DeviceState:LongWord):String;
Description: To be documented


[Expand] 
function DeviceClassToString(DeviceClass:LongWord):String;
Description: To be documented


[Expand] 
function NotificationToString(Notification:LongWord):String;
Description: To be documented


[Expand] 
procedure DeviceLog(Level:LongWord; Device:PDevice; const AText:String);
Description: To be documented


[Expand] 
procedure DeviceLogInfo(Device:PDevice; const AText:String);
Description: To be documented


[Expand] 
procedure DeviceLogError(Device:PDevice; const AText:String);
Description: To be documented


[Expand] 
procedure DeviceLogDebug(Device:PDevice; const AText:String);
Description: To be documented


Driver helper functions

[Expand] 
function DriverGetCount:LongWord; inline;
Description: Get the current driver count


[Expand] 
function DriverCheck(Driver:PDriver):PDriver;
Description: Check if the supplied Driver is in the driver table


[Expand] 
function DriverStateToString(DriverState:LongWord):String;
Description: To be documented


[Expand] 
function DriverClassToString(DriverClass:LongWord):String;
Description: To be documented


Clock device helper functions

[Expand] 
function ClockDeviceGetCount:LongWord; inline;
Description: Get the current clock device count


[Expand] 
function ClockDeviceGetDefault:PClockDevice; inline;
Description: Get the current default clock device


[Expand] 
function ClockDeviceSetDefault(Clock:PClockDevice):LongWord;
Description: Set the current default clock device


[Expand] 
function ClockDeviceCheck(Clock:PClockDevice):PClockDevice;
Description: Check if the supplied Clock is in the Clock table


Timer device helper functions

[Expand] 
function TimerDeviceGetCount:LongWord; inline;
Description: Get the current timer device count


[Expand] 
function TimerDeviceGetDefault:PTimerDevice; inline;
Description: Get the current default timer device


[Expand] 
function TimerDeviceSetDefault(Timer:PTimerDevice):LongWord;
Description: Set the current default timer device


[Expand] 
function TimerDeviceCheck(Timer:PTimerDevice):PTimerDevice;
Description: Check if the supplied Timer is in the Timer table


[Expand] 
function TimerDeviceCreateWaiter(Timer:PTimerDevice; Callback:TTimerCallback; Data:Pointer):PTimerWaiter;
Description: Create a new waiter using the supplied parameters


[Expand] 
function TimerDeviceDestroyWaiter(Timer:PTimerDevice; Waiter:PTimerWaiter):LongWord;
Description: Destroy an existing waiter


[Expand] 
function TimerDeviceRegisterWaiter(Timer:PTimerDevice; Waiter:PTimerWaiter):LongWord;
Description: Register a waiter in the waiter list of the supplied Timer


[Expand] 
function TimerDeviceDeregisterWaiter(Timer:PTimerDevice; Waiter:PTimerWaiter):LongWord;
Description: Deregister a waiter from the waiter list of the supplied Timer


Random device helper functions

[Expand] 
function RandomDeviceGetCount:LongWord; inline;
Description: Get the current random device count


[Expand] 
function RandomDeviceGetDefault:PRandomDevice; inline;
Description: Get the current default random device


[Expand] 
function RandomDeviceSetDefault(Random:PRandomDevice):LongWord;
Description: Set the current default random device


[Expand] 
function RandomDeviceCheck(Random:PRandomDevice):PRandomDevice;
Description: Check if the supplied Random is in the Random table


Mailbox device helper functions

[Expand] 
function MailboxDeviceGetCount:LongWord; inline;
Description: Get the current mailbox device count


[Expand] 
function MailboxDeviceGetDefault:PMailboxDevice; inline;
Description: Get the current default mailbox device


[Expand] 
function MailboxDeviceSetDefault(Mailbox:PMailboxDevice):LongWord;
Description: Set the current default mailbox device


[Expand] 
function MailboxDeviceCheck(Mailbox:PMailboxDevice):PMailboxDevice;
Description: Check if the supplied Mailbox is in the Mailbox table


Watchdog device helper functions

[Expand] 
function WatchdogDeviceGetCount:LongWord; inline;
Description: Get the current watchdog device count


[Expand] 
function WatchdogDeviceGetDefault:PWatchdogDevice; inline;
Description: Get the current default watchdog device


[Expand] 
function WatchdogDeviceSetDefault(Watchdog:PWatchdogDevice):LongWord;
Description: Set the current default watchdog device


[Expand] 
function WatchdogDeviceCheck(Watchdog:PWatchdogDevice):PWatchdogDevice;
Description: Check if the supplied Watchdog is in the Watchdog table


Return to Unit Reference

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