Difference between revisions of "Unit Devices"

From Ultibo.org
Jump to: navigation, search
 
(14 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
'''Ultibo Device interface unit'''
+
'''Ultibo Device Interface unit'''
−
 
+
−
''To be documented''
+
  
 
=== Constants ===
 
=== Constants ===
Line 31: Line 29:
 
| <code>DEVICE_SIGNATURE = $AD03FE3C;</code>
 
| <code>DEVICE_SIGNATURE = $AD03FE3C;</code>
 
| style="width: 50%;"|&nbsp;
 
| 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;">'''Device name''' <code> DEVICE_*_LENGTH </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>DEVICE_NAME_LENGTH = SIZE_64;</code>
 +
| Length of device name
 +
|-
 +
| <code>DEVICE_DESC_LENGTH = SIZE_128;</code>
 +
| Length of device description
 
|-
 
|-
 
|}
 
|}
Line 331: Line 343:
 
| <code>DEVICE_CLASS_GENERIC = 56;</code>
 
| <code>DEVICE_CLASS_GENERIC = 56;</code>
 
| A Generic Device
 
| A Generic Device
 +
|-
 +
| <code>DEVICE_CLASS_VIRTIO = 57;</code>
 +
| A VIRTIO Device (eg Block/Network/Memory/Console/Input etc) (Implementing a standard VIRTIO device interface)
 +
|-
 +
| <code>DEVICE_CLASS_BLUETOOTHHOST = 58;</code>
 +
| A Bluetooth Host Controller (Implementing a standard Bluetooth host interface)
 +
|-
 +
| <code>DEVICE_CLASS_JOYSTICK = 59;</code>
 +
| A Joystick or Gamepad Device
 +
|-
 +
| <code>DEVICE_CLASS_HID = 60;</code>
 +
| A Human Interface Device (HID)
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 
|-
 
|-
−
| <code>DEVICE_CLASS_MAX = 56;</code>
+
| <code>DEVICE_CLASS_MAX = 60;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 341: Line 365:
 
| <code>DEVICE_CLASS_ANY = $FFFFFFFF;</code>
 
| <code>DEVICE_CLASS_ANY = $FFFFFFFF;</code>
 
| Any Device (Pass to DeviceFind or DeviceEnumerate to match all devices)
 
| Any Device (Pass to DeviceFind or DeviceEnumerate to match all devices)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|''Device Class Names''
 +
|-
 +
|colspan="2"|<code>DEVICE_CLASS_NAMES:array[DEVICE_CLASS_NONE..DEVICE_CLASS_MAX] of String = (</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_NONE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_USBHOST',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PCIHOST',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_USB',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PCI',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_NETWORK',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_STORAGE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_FILESYSTEM',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PROTOCOL',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_KEYBOARD',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_MOUSE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_BLUETOOTH',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SERIAL',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_AUDIO',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_VIDEO',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SCSI',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_ATA',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_IMAGE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PRINTER',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_COMMUNICATIONS',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SMART_CARD',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_MONITOR',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_DISPLAY',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_AUDIOVIDEO',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_IRDA',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SPI',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_I2C',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_UART',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_MMC',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SD',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SDHCI',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_DFU',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_GPIO',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_MAILBOX',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_OPENGL',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_DVB',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_DAB',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_DMA',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_SCSIHOST',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_ATAHOST',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_TIMER',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_RANDOM',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_FRAMEBUFFER',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_WATCHDOG',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_CLOCK',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_CONSOLE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_RTC',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_USBHUB',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_LOGGING',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PCM',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_PWM',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_1WIRE',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_CLOCK_MANAGER',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_CODEC',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_TOUCH',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_MEMORY',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_GENERIC',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_VIRTIO',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_BLUETOOTHHOST',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_JOYSTICK',</code>
 +
|-
 +
|colspan="2"|<code>'DEVICE_CLASS_HID');</code>
 
|-
 
|-
 
|}
 
|}
Line 422: Line 574:
 
</div></div>
 
</div></div>
 
<br />
 
<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;">'''Firmware name''' <code> FIRMWARE_NAME_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>FIRMWARE_NAME_LENGTH = SIZE_256;</code>
 +
| Length of firmware name
 +
|-
 +
|}
 +
</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;">'''Firmware actions''' <code> FIRMWARE_ACTION_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>FIRMWARE_ACTION_NONE = 0;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FIRMWARE_ACTION_SIZE = 1;</code>
 +
| Return the size in bytes of the firmware item
 +
|-
 +
| <code>FIRMWARE_ACTION_OPEN = 2;</code>
 +
| Open the firmware item and return a handle
 +
|-
 +
| <code>FIRMWARE_ACTION_READ = 3;</code>
 +
| Read from the firmware item specified by a given handle
 +
|-
 +
| <code>FIRMWARE_ACTION_SEEK = 4;</code>
 +
| Seek to a location in the firmware item specified by a given handle
 +
|-
 +
| <code>FIRMWARE_ACTION_CLOSE = 5;</code>
 +
| Close a handle to the firmware item
 +
|-
 +
| <code>FIRMWARE_ACTION_ACQUIRE = 6;</code>
 +
| Acquire a memory block containing the firmware item
 +
|-
 +
| <code>FIRMWARE_ACTION_RELEASE = 7;</code>
 +
| Release a memory block containing the firmware item
 +
|-
 +
|}
 +
</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;">'''Firmware constants''' <code> FIRMWARE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>FIRMWARE_WAIT_DELAY = 100;</code>
 +
| Delay between retries for firmware while waiting for timeout (Milliseconds)
 +
|-
 +
| <code>FIRMWARE_MAX_BUFFER = SIZE_4M;</code>
 +
| Maximum size buffer able to be allocated for firmware by acquire
 +
|-
 +
|}
 +
</div></div>
 +
<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;">'''Notifier signature''' <code> NOTIFIER_SIGNATURE_* </code></div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Notifier signature''' <code> NOTIFIER_SIGNATURE_* </code></div>
Line 505: Line 714:
 
| <code>DRIVER_SIGNATURE = $1EB4980A;</code>
 
| <code>DRIVER_SIGNATURE = $1EB4980A;</code>
 
| style="width: 50%;"|&nbsp;
 
| 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;">'''Driver name''' <code> DRIVER_NAME_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>DRIVER_NAME_LENGTH = SIZE_64;</code>
 +
| Length of driver name
 
|-
 
|-
 
|}
 
|}
Line 558: Line 778:
 
| <code>DRIVER_CLASS_BLUETOOTH = 4;</code>
 
| <code>DRIVER_CLASS_BLUETOOTH = 4;</code>
 
| A Bluetooth Driver (Implementing a standard Bluetooth driver interface)
 
| A Bluetooth Driver (Implementing a standard Bluetooth driver interface)
 +
|-
 +
| <code>DRIVER_CLASS_VIRTIO = 5;</code>
 +
| A VIRTIO Driver (Implementing a standard VIRTIO driver interface)
 +
|-
 +
| <code>DRIVER_CLASS_HID = 6;</code>
 +
| A Human Interface Device (HID) Driver (Implementing a standard HID driver interface)
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 
|-
 
|-
−
| <code>DRIVER_CLASS_MAX = 4;</code>
+
| <code>DRIVER_CLASS_MAX = 6;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 568: Line 794:
 
| <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)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|''Driver Class Names''
 +
|-
 +
|colspan="2"|<code>DRIVER_CLASS_NAMES:array[DRIVER_CLASS_NONE..DRIVER_CLASS_MAX] of String = (</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_NONE',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_USB',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_PCI',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_SDIO',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_BLUETOOTH',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_VIRTIO',</code>
 +
|-
 +
|colspan="2"|<code>'DRIVER_CLASS_HID');</code>
 
|-
 
|-
 
|}
 
|}
Line 590: Line 836:
 
| <code>HOST_SIGNATURE = $F45D30FE;</code>
 
| <code>HOST_SIGNATURE = $F45D30FE;</code>
 
| style="width: 50%;"|&nbsp;
 
| 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 name''' <code> HOST_NAME_* </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_LENGTH = SIZE_64;</code>
 +
| Length of host name
 
|-
 
|-
 
|}
 
|}
Line 1,038: Line 1,295:
 
| Device state (eg Registered/Unregistered)
 
| Device state (eg Registered/Unregistered)
 
|-
 
|-
−
| <code>DeviceName:String;</code>
+
| <code>DeviceName:array[0..DEVICE_NAME_LENGTH - 1] of Char;</code>
 
| The name of the Device (eg Keyboard0, Storage0 or Network0 etc)
 
| The name of the Device (eg Keyboard0, Storage0 or Network0 etc)
 
|-
 
|-
Line 1,056: Line 1,313:
 
| A pointer to a class specific Device interface (eg PUSBDevice, PNetworkDevice or PStorageDevice etc) (Used by Drivers)
 
| A pointer to a class specific Device interface (eg PUSBDevice, PNetworkDevice or PStorageDevice etc) (Used by Drivers)
 
|-
 
|-
−
| <code>DeviceDescription:String;</code>
+
| <code>DeviceDescription:array[0..DEVICE_DESC_LENGTH - 1] of Char;</code>
 
| A description of the Device (eg BCM2835 PL011 UART)
 
| A description of the Device (eg BCM2835 PL011 UART)
 
|-
 
|-
Line 1,069: Line 1,326:
 
|}
 
|}
 
</div></div>  
 
</div></div>  
 +
 +
'''Device firmware'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PDeviceFirmware = ^TDeviceFirmware;</code>
 +
 +
<code>TDeviceFirmware = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>DeviceClass:LongWord;</code>
 +
| The Device class supported by this firmware (or DEVICE_CLASS_ANY for all devices)
 +
|-
 +
| <code>Name:array[0..FIRMWARE_NAME_LENGTH - 1] of Char;</code>
 +
| The device specific name of the firmware which may be a filename, a device model, id or type
 +
|-
 +
| <code>Size:LongWord;</code>
 +
| For block (memory) based firmware, the size passed to Create or 0 for other firmware types
 +
|-
 +
| <code>Buffer:Pointer;</code>
 +
| For block (memory) based firmware, the buffer passed to Create or nil for other firmware types
 +
|-
 +
| <code>Handles:PFirmwareHandle;</code>
 +
| List of currently open handles for this firmware
 +
|-
 +
| <code>Handler:TDeviceFirmwareHandler;</code>
 +
| The device specific callback for the handler which provides this firmware
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PDeviceFirmware;</code>
 +
| Previous entry in Device firmware table}
 +
|-
 +
| <code>Next:PDeviceFirmware;</code>
 +
| Next entry in Device firmware table
 +
|-
 +
|}
 +
</div></div>
 +
 +
'''Device firmware handler'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TDeviceFirmwareHandler = function(Firmware:PDeviceFirmware; Action:LongWord; var Handle:THandle; var Buffer:Pointer; var Value:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 +
'''Firmware handle'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PFirmwareHandle = ^TFirmwareHandle;</code>
 +
 +
<code>TFirmwareHandle = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Handle:THandle;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>Next:PFirmwareHandle;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
  
 
'''Notifier entry'''
 
'''Notifier entry'''
Line 1,138: Line 1,460:
 
|-
 
|-
 
| <code>Next:PNotifierTask;</code>
 
| <code>Next:PNotifierTask;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 +
'''Notifier retry'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PNotifierRetry = ^TNotifierRetry;</code>
 +
 +
<code>TNotifierRetry = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Device:PDevice;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>Notification:LongWord;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 1,172: Line 1,512:
 
| Driver state (eg Registered/Unregistered)
 
| Driver state (eg Registered/Unregistered)
 
|-
 
|-
−
| <code>DriverName:String;</code>
+
| <code>DriverName:array[0..DRIVER_NAME_LENGTH - 1] of Char;</code>
 
| Descriptive name for the Driver (eg USB Mouse Driver)
 
| Descriptive name for the Driver (eg USB Mouse Driver)
 
|-
 
|-
Line 1,218: Line 1,558:
 
| Host state (eg Registered/Unregistered)
 
| Host state (eg Registered/Unregistered)
 
|-
 
|-
−
| <code>HostName:String;</code>
+
| <code>HostName:array[0..HOST_NAME_LENGTH - 1] of Char;</code>
 
| Descriptive name for the Host (eg DWC OTG Host)
 
| Descriptive name for the Host (eg DWC OTG Host)
 
|-
 
|-
Line 1,816: Line 2,156:
 
|}
 
|}
  
−
'''Random device read extended'''
+
'''Random device read double'''
  
 
{| 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>TRandomDeviceReadExtended = function(Random:PRandomDevice):Extended;</code>
+
| <code>TRandomDeviceReadDouble = function(Random:PRandomDevice):Double;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
Line 1,868: Line 2,208:
 
| A device specific DeviceReadQuadWord method implementing a standard random device interface (Or nil if the default method is suitable)
 
| A device specific DeviceReadQuadWord method implementing a standard random device interface (Or nil if the default method is suitable)
 
|-
 
|-
−
| <code>DeviceReadExtended:TRandomDeviceReadExtended;</code>
+
| <code>DeviceReadDouble:TRandomDeviceReadDouble;</code>
−
| A device specific DeviceReadExtended method implementing a standard random device interface (Or nil if the default method is suitable)
+
| A device specific DeviceReadDouble method implementing a standard random device interface (Or nil if the default method is suitable)
 
|-
 
|-
 
|colspan="2"|''Statistics Properties''
 
|colspan="2"|''Statistics Properties''
Line 2,414: Line 2,754:
 
<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 DeviceFindByName(const Name:String):PDevice;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function DeviceFindByName(const Name:String):PDevice; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by name in the device table</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by name in the device table</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 2,429: Line 2,769:
 
<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 DeviceFindByDescription(const Description:String):PDevice;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function DeviceFindByNameEx(DeviceClass:LongWord; const Name:String):PDevice;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by class and name in the device table</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of the device to find (eg DEVICE_CLASS_USB) (DEVICE_CLASS_ANY for all classes)
 +
|-
 +
! Name
 +
| The name of the device to find (eg USB0)
 +
|-
 +
! Return
 +
| Pointer to device entry or nil if not found
 +
|-
 +
|}
 +
</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 DeviceFindByDescription(const Description:String):PDevice; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by description in the device table</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by description in the device table</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;"
 +
|-
 +
! Description
 +
| The description of the device to find (eg BCM2836 ARM Timer)
 +
|-
 +
! Return
 +
| Pointer to device entry or nil if not found
 +
|-
 +
|}
 +
</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 DeviceFindByDescriptionEx(DeviceClass:LongWord; const Description:String):PDevice;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a device by class and description in the device table</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of the device to find (eg DEVICE_CLASS_USB) (DEVICE_CLASS_ANY for all classes)
 
|-
 
|-
 
! Description
 
! Description
Line 2,487: Line 2,863:
 
! Flags
 
! Flags
 
| The flags to control the notification (eg NOTIFIER_FLAG_WORKER)
 
| The flags to control the notification (eg NOTIFIER_FLAG_WORKER)
 +
|-
 +
|}
 +
</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 DeviceFirmwareCreate(DeviceClass:LongWord; const Name:String; Buffer:Pointer; Size:LongWord):Boolean;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create a new block (memory) based firmware entry using the standard block firmware handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of device this firmware applies to (eg DEVICE_CLASS_NETWORK)(or DEVICE_CLASS_ANY for all devices)
 +
|-
 +
! Buffer
 +
| A pointer to a block of memory containing the firmware to be provided to requesting devices
 +
|-
 +
! Size
 +
| The size in bytes of the block pointed to by buffer
 +
|-
 +
! Return
 +
| True if the new firmware entry was added or False on failure
 +
|-
 +
! Note
 +
| Can be used by device drivers to register built in firmware as a device firmware provider. The supplied buffer can be statically or dynamically allocated but must not be freed once the device firmware has been created.
 +
|-
 +
|}
 +
</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 DeviceFirmwareRegister(DeviceClass:LongWord; const Name:String; Handler:TDeviceFirmwareHandler):THandle;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Register a new device firmware handler for acquiring device specific firmware</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of device this firmware applies to (eg DEVICE_CLASS_NETWORK)(or DEVICE_CLASS_ANY for all devices)
 +
|-
 +
! Name
 +
| The name of the device firmware, device specific may be a filename, a device model, id or type
 +
|-
 +
! Handler
 +
| The handler function which is to be called when a device requests this firmware
 +
|-
 +
! Return
 +
| A handle for the new firmware handler on success or INVALID_HANDLE_VALUE on failure
 +
|-
 +
! Note
 +
| Used by device firmware providers to register firmware for device drivers
 +
|-
 +
|}
 +
</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 DeviceFirmwareDeregister(Handle:THandle):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Deregister an existing device firmware handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle returned by Register
 +
|-
 +
! Return
 +
| ERROR_SUCCESS on completion or another error code on failure
 +
|-
 +
! Note
 +
| Used by device firmware providers to deregister firmware for device drivers
 +
|-
 +
|}
 +
</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 DeviceFirmwareFind(DeviceClass:LongWord; const Name:String):PDeviceFirmware;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find an existing device firmware handler for a specified device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of device for the firmware (eg DEVICE_CLASS_NETWORK)(or DEVICE_CLASS_ANY for any class)
 +
|-
 +
! Name
 +
| The name of the device firmware which is a device specific value such as a filename, a device model, id or type
 +
|-
 +
! Return
 +
| A pointer to the device firmware entry which contains the details of the handler
 +
|-
 +
! Note
 +
| Used internally to locate compatible firmware for a device firmware open request
 +
|-
 +
|}
 +
</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 DeviceFirmwareFindByHandle(Handle:THandle):PDeviceFirmware;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find an existing device firmware handler from a returned handle</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| A handle to the firmware returned by Open or Acquire
 +
|-
 +
! Return
 +
| A pointer to the device firmware entry which contains the details of the handler
 +
|-
 +
! Note
 +
| Used internally to locate referenced firmware for a device firmware request
 +
|-
 +
|}
 +
</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 DeviceFirmwareOpen(DeviceClass:LongWord; const Name:String; Timeout:LongWord; var Handle:THandle):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Open the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of device for the firmware (eg DEVICE_CLASS_NETWORK)(or DEVICE_CLASS_ANY for any class)
 +
|-
 +
! Name
 +
| The name of the device firmware which is a device specific value such as a filename, a device model, id or type
 +
|-
 +
! Timeout
 +
| Number of milliseconds to wait for the device firmware to be ready (0 to not wait, INFINITE to wait forever)
 +
|-
 +
! Handle
 +
| A variable to receive a handle to the firmware on return
 +
|-
 +
! Return
 +
| ERROR_SUCCESS on completion, ERROR_NOT_FOUND if no handler can supply firmware or another error code on failure
 +
|-
 +
! Note
 +
| A handler may return ERROR_NOT_READY if the firmware may be accepted but is not available yet
 +
|-
 +
|}
 +
</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 DeviceFirmwareClose(Handle:THandle):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Close a handle to the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle to the firmware as returned by Open
 +
|-
 +
! Return
 +
| ERROR_SUCCESS on completion, ERROR_NOT_FOUND if no handler accepts this firmware 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 DeviceFirmwareSize(Handle:THandle):LongInt;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the size of the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle to the firmware as returned by Open
 +
|-
 +
! Return
 +
| The size of the firmware on success or -1 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 DeviceFirmwareSeek(Handle:THandle; Position:LongInt):LongInt;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Seek to a position within the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle to the firmware as returned by Open
 +
|-
 +
! Position
 +
| The byte position within the firmware to seek to
 +
|-
 +
! Return
 +
| The new position within the firmware on success or -1 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 DeviceFirmwareRead(Handle:THandle; Buffer:Pointer; Count:LongInt):LongInt;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read into a buffer from the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle to the firmware as returned by Open
 +
|-
 +
! Buffer
 +
| A pointer to a buffer to receive the data
 +
|-
 +
! Count
 +
| The maximum number of bytes to be read
 +
|-
 +
! Return
 +
| The number of bytes read on success or -1 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 DeviceFirmwareAcquire(DeviceClass:LongWord; const Name:String; Timeout:LongWord; var Handle:THandle; var Buffer:Pointer; var Size:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Acquire a memory block containing the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! DeviceClass
 +
| The class of device for the firmware (eg DEVICE_CLASS_NETWORK)(or DEVICE_CLASS_ANY for any class)
 +
|-
 +
! Name
 +
| The name of the device firmware which is a device specific value such as a filename, a device model, id or type
 +
|-
 +
! Timeout
 +
| Number of milliseconds to wait for the device firmware to be ready (0 to not wait, INFINITE to wait forever)
 +
|-
 +
! Handle
 +
| A variable to receive a handle to the firmware on return
 +
|-
 +
! Buffer
 +
| A variable to receive a pointer to the block of memory containing the firmware on return
 +
|-
 +
! Size
 +
| A variable to receive the size of the memory block pointed to by buffer on return
 +
|-
 +
! Return
 +
| ERROR_SUCCESS on completion, ERROR_NOT_FOUND if no handler can supply firmware or another error code on failure
 +
|-
 +
! Note
 +
| A handler may return ERROR_NOT_READY if the firmware may be accepted but is not available yet. A handler may return ERROR_MORE_DATA if the size of the firmware is larger than can be returned in a single buffer.
 +
|-
 +
|}
 +
</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 DeviceFirmwareRelease(Handle:THandle; Buffer:Pointer; Size:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Release a memory block containing the firmware for a specified device from a registered handler</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Handle
 +
| The handle to the firmware as returned by Acquire
 +
|-
 +
! Buffer
 +
| The pointer to the block of memory containing the firmware as returned by Acquire
 +
|-
 +
! Size
 +
| The size of the memory block as returned by Acquire
 +
|-
 +
! Return
 +
| ERROR_SUCCESS on completion, ERROR_NOT_FOUND if no handler accepts this firmware or another error code on failure
 
|-
 
|-
 
|}
 
|}
Line 2,529: Line 3,160:
 
<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 NotifierNotify(Device:PDevice; Notification:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function NotifierNotify(Device:PDevice; Notification:LongWord):LongWord;</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 NotifierRetry(Retry:PNotifierRetry);</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;">
Line 3,117: Line 3,760:
 
! Timer
 
! Timer
 
| The Timer device to schedule the callback for
 
| The Timer device to schedule the callback for
 +
|-
 +
! Flags
 +
| The flags to control the event (eg TIMER_EVENT_FLAG_REPEAT)
 
|-
 
|-
 
! Callback
 
! Callback
Line 3,122: Line 3,768:
 
|-
 
|-
 
! Data
 
! Data
−
| A pointer to be pass to the function when the interval expires (Optional)
+
| A pointer to be passed to the function when the interval expires (Optional)
 
|-
 
|-
 
! Return
 
! Return
Line 3,503: Line 4,149:
 
<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 RandomDeviceReadExtended(Random:PRandomDevice):Extended;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function RandomDeviceReadDouble(Random:PRandomDevice):Double;</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;">
Line 3,510: Line 4,156:
 
! Note
 
! Note
 
| None documented
 
| 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;">function RandomDeviceReadExtended(Random:PRandomDevice):Extended; 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
 +
| Replaced by RandomDeviceReadDouble
 
|-
 
|-
 
|}
 
|}
Line 4,277: Line 4,935:
 
<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 SysRandomReadExtended:Extended;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function SysRandomReadDouble:Double;</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;">
Line 4,343: Line 5,001:
  
 
<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 DeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function DeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current device count</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 4,367: Line 5,025:
 
<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 NotifierGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function NotifierGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current notifier count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current notifier count</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 4,502: Line 5,160:
  
 
<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 DriverGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function DriverGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current driver count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current driver count</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 4,553: Line 5,211:
  
 
<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 ClockDeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function ClockDeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current clock device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current clock device count</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 4,565: Line 5,223:
 
<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 ClockDeviceGetDefault:PClockDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function ClockDeviceGetDefault:PClockDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default clock device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default clock 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 4,628: Line 5,286:
  
 
<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 TimerDeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TimerDeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current timer device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current timer device count</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 4,640: Line 5,298:
 
<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 TimerDeviceGetDefault:PTimerDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TimerDeviceGetDefault:PTimerDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default timer device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default timer 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 4,652: Line 5,310:
 
<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 TimerDeviceSetDefault(Timer:PTimerDevice):LongWord; </pre>
+
<pre style="border: 0; padding-bottom:0px;">function TimerDeviceSetDefault(Timer:PTimerDevice):LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the current default timer device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the current default timer 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 4,755: Line 5,413:
  
 
<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 RandomDeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function RandomDeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current random device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current random device count</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 4,767: Line 5,425:
 
<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 RandomDeviceGetDefault:PRandomDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function RandomDeviceGetDefault:PRandomDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default random device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default random 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 4,830: Line 5,488:
  
 
<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 MailboxDeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function MailboxDeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current mailbox device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current mailbox device count</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 4,842: Line 5,500:
 
<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 MailboxDeviceGetDefault:PMailboxDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function MailboxDeviceGetDefault:PMailboxDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default mailbox device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default mailbox 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 4,905: Line 5,563:
  
 
<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 WatchdogDeviceGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function WatchdogDeviceGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current watchdog device count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current watchdog device count</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 4,917: Line 5,575:
 
<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 WatchdogDeviceGetDefault:PWatchdogDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function WatchdogDeviceGetDefault:PWatchdogDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default watchdog device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default watchdog 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;">

Latest revision as of 04:55, 21 June 2023

Return to Unit Reference


Description

Ultibo Device Interface unit

Constants


[Expand]
Device specific constants DEVICE_*


[Expand]
Device signature DEVICE_SIGNATURE_*


[Expand]
Device name DEVICE_*_LENGTH


[Expand]
Device bus DEVICE_BUS_*


[Expand]
Device state DEVICE_STATE_*


[Expand]
Device Id DEVICE_ID_*


[Expand]
Device class DEVICE_CLASS_*


[Expand]
Device notification flag DEVICE_NOTIFICATION_*


[Expand]
Firmware name FIRMWARE_NAME_*


[Expand]
Firmware actions FIRMWARE_ACTION_*


[Expand]
Firmware constants FIRMWARE_*


[Expand]
Notifier signature NOTIFIER_SIGNATURE_*


[Expand]
Notifier state NOTIFIER_STATE_*


[Expand]
Notifier flag NOTIFIER_FLAG_*


[Expand]
Device logging DEVICE_LOG_*


[Expand]
Driver specific constants DRIVER_*


[Expand]
Driver signature DRIVER_SIGNATURE_*


[Expand]
Driver name DRIVER_NAME_*


[Expand]
Driver state DRIVER_STATE_*


[Expand]
Driver Id DRIVER_ID_*


[Expand]
Driver class DRIVER_CLASS_*


[Expand]
Host specific constants HOST_*


[Expand]
Host signature HOST_SIGNATURE_*


[Expand]
Host name HOST_NAME_*


[Expand]
Host state HOST_STATE_*


[Expand]
Host Id HOST_ID_*


[Expand]
Host class HOST_CLASS_*


[Expand]
Clock specific constants CLOCK_*


[Expand]
Clock device type CLOCK_TYPE_*


[Expand]
Clock device state CLOCK_STATE_*


[Expand]
Clock device flag CLOCK_FLAG_*


[Expand]
Timer specific constants TIMER_*


[Expand]
Timer device type TIMER_TYPE_*


[Expand]
Timer device state TIMER_STATE_*


[Expand]
Timer device flag TIMER_FLAG_*


[Expand]
Timer event flag TIMER_EVENT_FLAG_*


[Expand]
Random specific constants RANDOM_*


[Expand]
Random device type RANDOM_TYPE_*


[Expand]
Random device state RANDOM_STATE_*


[Expand]
Random device flag RANDOM_FLAG_*


[Expand]
Mailbox specific constants MAILBOX_*


[Expand]
Mailbox device type MAILBOX_TYPE_*


[Expand]
Mailbox device state MAILBOX_STATE_*


[Expand]
Mailbox device flag MAILBOX_FLAG_*


[Expand]
Watchdog specific constants WATCHDOG_*


[Expand]
Watchdog device type WATCHDOG_TYPE_*


[Expand]
Watchdog device state WATCHDOG_STATE_*


[Expand]
Watchdog device flag WATCHDOG_FLAG_*


Type definitions


Device enumeration callback

TDeviceEnumerate = function(Device:PDevice; Data:Pointer):LongWord;

Device notification callback

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

Device entry

[Expand]

PDevice = ^TDevice;

TDevice = record

Device firmware

[Expand]

PDeviceFirmware = ^TDeviceFirmware;

TDeviceFirmware = record

Device firmware handler

TDeviceFirmwareHandler = function(Firmware:PDeviceFirmware; Action:LongWord; var Handle:THandle; var Buffer:Pointer; var Value:LongWord):LongWord;

Firmware handle

[Expand]

PFirmwareHandle = ^TFirmwareHandle;

TFirmwareHandle = record

Notifier entry

[Expand]

PNotifier = ^TNotifier;

TNotifier = record

Notifier task

[Expand]

PNotifierTask = ^TNotifierTask;

TNotifierTask = record

Notifier retry

[Expand]

PNotifierRetry = ^TNotifierRetry;

TNotifierRetry = record

Driver enumeration callback

TDriverEnumerate = function(Driver:PDriver; Data:Pointer):LongWord;

Driver entry

[Expand]

PDriver = ^TDriver;

TDriver = record

Host enumeration callback

THostEnumerate = function(Host:PHost; Data:Pointer):LongWord;

Host entry

[Expand]

PHost = ^THost;

THost = record

Clock properties

[Expand]

PClockProperties = ^TClockProperties;

TClockProperties = record

Clock enumeration callback

TClockEnumerate = function(Clock:PClockDevice; Data:Pointer):LongWord;

Clock notification callback

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

Clock device start

TClockDeviceStart = function(Clock:PClockDevice):LongWord;

Clock device stop

TClockDeviceStop = function(Clock:PClockDevice):LongWord;

Clock device read

TClockDeviceRead = function(Clock:PClockDevice):LongWord;

Clock device read 64

TClockDeviceRead64 = function(Clock:PClockDevice):Int64;

Clock device write 64

TClockDeviceWrite64 = function(Clock:PClockDevice; const Value:Int64):LongWord;

Clock device get rate

TClockDeviceGetRate = function(Clock:PClockDevice):LongWord;

Clock device set rate

TClockDeviceSetRate = function(Clock:PClockDevice; Rate:LongWord):LongWord;

Clock device get properties

TClockDeviceGetProperties = function(Clock:PClockDevice; Properties:PClockProperties):LongWord;

Clock device

[Expand]

PClockDevice = ^TClockDevice;

TClockDevice = record

Timer callback

TTimerCallback = TCounterCallback; Counter callback from Platform

Timer properties

[Expand]

PTimerProperties = ^TTimerProperties;

TTimerProperties = record

Timer waiter

[Expand]

PTimerWaiter = ^TTimerWaiter;

TTimerWaiter = record

Timer enumeration callback

TTimerEnumerate = function(Timer:PTimerDevice; Data:Pointer):LongWord;

Timer notification callback

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

TImer device start

TTimerDeviceStart = function(Timer:PTimerDevice):LongWord;

Timer device stop

TTimerDeviceStop = function(Timer:PTimerDevice):LongWord;

Timer device read

TTimerDeviceRead = function(Timer:PTimerDevice):LongWord;

Timer device read 64

TTimerDeviceRead64 = function(Timer:PTimerDevice):Int64;

Timer device wait

TTimerDeviceWait = function(Timer:PTimerDevice):LongWord;

Timer device event

TTimerDeviceEvent = function(Timer:PTimerDevice; Flags:LongWord; Callback:TTimerCallback; Data:Pointer):LongWord;

Timer device cancel

TTimerDeviceCancel = function(Timer:PTimerDevice):LongWord;

Timer device get rate

TTimerDeviceGetRate = function(Timer:PTimerDevice):LongWord;

Timer device set rate

TTimerDeviceSetRate = function(Timer:PTimerDevice; Rate:LongWord):LongWord;

Timer device get interval

TTimerDeviceGetInterval = function(Timer:PTimerDevice):LongWord;

Timer device set interval

TTimerDeviceSetInterval = function(Timer:PTimerDevice; Interval:LongWord):LongWord;

Timer device get properties

TTimerDeviceGetProperties = function(Timer:PTimerDevice; Properties:PTimerProperties):LongWord;

Timer device

[Expand]

PTimerDevice = ^TTimerDevice;

TTimerDevice = record

Random enumeration callback

TRandomEnumerate = function(Random:PRandomDevice; Data:Pointer):LongWord;

Random notification callback

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

Random device start

TRandomDeviceStart = function(Random:PRandomDevice):LongWord;

Random device stop

TRandomDeviceStop = function(Random:PRandomDevice):LongWord;

Random device seed

TRandomDeviceSeed = function(Random:PRandomDevice; Seed:LongWord):LongWord;

Random device read byte

TRandomDeviceReadByte = function(Random:PRandomDevice):Byte;

Random device read word

TRandomDeviceReadWord = function(Random:PRandomDevice):Word;

Random device read long word

TRandomDeviceReadLongWord = function(Random:PRandomDevice):LongWord;

Random device read quad word

TRandomDeviceReadQuadWord = function(Random:PRandomDevice):Int64;

Random device read double

TRandomDeviceReadDouble = function(Random:PRandomDevice):Double;

Random device

[Expand]

PRandomDevice = ^TRandomDevice;

TRandomDevice = record

Mailbox enumeration callback

TMailboxEnumerate = function(Mailbox:PMailboxDevice; Data:Pointer):LongWord;

Mailbox notification callback

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

Mailbox device start

TMailboxDeviceStart = function(Mailbox:PMailboxDevice):LongWord;

Mailbox device stop

TMailboxDeviceStop = function(Mailbox:PMailboxDevice):LongWord;

Mailbox device receive

TMailboxDeviceReceive = function(Mailbox:PMailboxDevice; Channel:LongWord):LongWord;

Mailbox device send

TMailboxDeviceSend = function(Mailbox:PMailboxDevice; Channel,Data:LongWord):LongWord;

Mailbox device call

TMailboxDeviceCall = function(Mailbox:PMailboxDevice; Channel,Data:LongWord; var Response:LongWord):LongWord;

Mailbox device get timeout

TMailboxDeviceGetTimeout = function(Mailbox:PMailboxDevice):LongWord;

Mailbox device set timeout

TMailboxDeviceSetTimeout = function(Mailbox:PMailboxDevice; Timeout:LongWord):LongWord;

Mailbox device

[Expand]

PMailboxDevice = ^TMailboxDevice;

TMailboxDevice = record

Watchdog enumeration callback

TWatchdogEnumerate = function(Watchdog:PWatchdogDevice; Data:Pointer):LongWord;

Watchdog notification callback

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

Watchdog device start

TWatchdogDeviceStart = function(Watchdog:PWatchdogDevice):LongWord;

Watchdog device stop

TWatchdogDeviceStop = function(Watchdog:PWatchdogDevice):LongWord;

Watchdog device refresh

TWatchdogDeviceRefresh = function(Watchdog:PWatchdogDevice):LongWord;

Watchdog device get remain

TWatchdogDeviceGetRemain = function(Watchdog:PWatchdogDevice):LongWord;

Watchdog device get timeout

TWatchdogDeviceGetTimeout = function(Watchdog:PWatchdogDevice):LongWord;

Watchdog device set timeout

TWatchdogDeviceSetTimeout = function(Watchdog:PWatchdogDevice; Timeout:LongWord):LongWord;

Watchdog device

[Expand]

PWatchdogDevice = ^TWatchdogDevice;

TWatchdogDevice = record


Public variables


Device logging

DEVICE_DEFAULT_LOG_LEVEL:LongWord = DEVICE_LOG_LEVEL_DEBUG; Minimum level for Device messages. Only messages with level greater than or equal to this will be printed.
DEVICE_LOG_ENABLED:Boolean;


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: Find a device by ID in the device table


[Expand] 
function DeviceFindByDeviceData(DeviceData:Pointer):PDevice;
Description: Find a device with matching DeviceData property in the device table


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


[Expand] 
function DeviceFindByNameEx(DeviceClass:LongWord; const Name:String):PDevice;
Description: Find a device by class and name in the device table


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


[Expand] 
function DeviceFindByDescriptionEx(DeviceClass:LongWord; const Description:String):PDevice;
Description: Find a device by class and description in the device table


[Expand] 
function DeviceEnumerate(DeviceClass:LongWord; Callback:TDeviceEnumerate; Data:Pointer):LongWord;
Description: Enumerate all devices in the device table


[Expand] 
function DeviceNotification(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for device changes


[Expand] 
function DeviceFirmwareCreate(DeviceClass:LongWord; const Name:String; Buffer:Pointer; Size:LongWord):Boolean;
Description: Create a new block (memory) based firmware entry using the standard block firmware handler


[Expand] 
function DeviceFirmwareRegister(DeviceClass:LongWord; const Name:String; Handler:TDeviceFirmwareHandler):THandle;
Description: Register a new device firmware handler for acquiring device specific firmware


[Expand] 
function DeviceFirmwareDeregister(Handle:THandle):LongWord;
Description: Deregister an existing device firmware handler


[Expand] 
function DeviceFirmwareFind(DeviceClass:LongWord; const Name:String):PDeviceFirmware;
Description: Find an existing device firmware handler for a specified device


[Expand] 
function DeviceFirmwareFindByHandle(Handle:THandle):PDeviceFirmware;
Description: Find an existing device firmware handler from a returned handle


[Expand] 
function DeviceFirmwareOpen(DeviceClass:LongWord; const Name:String; Timeout:LongWord; var Handle:THandle):LongWord;
Description: Open the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareClose(Handle:THandle):LongWord;
Description: Close a handle to the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareSize(Handle:THandle):LongInt;
Description: Return the size of the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareSeek(Handle:THandle; Position:LongInt):LongInt;
Description: Seek to a position within the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareRead(Handle:THandle; Buffer:Pointer; Count:LongInt):LongInt;
Description: Read into a buffer from the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareAcquire(DeviceClass:LongWord; const Name:String; Timeout:LongWord; var Handle:THandle; var Buffer:Pointer; var Size:LongWord):LongWord;
Description: Acquire a memory block containing the firmware for a specified device from a registered handler


[Expand] 
function DeviceFirmwareRelease(Handle:THandle; Buffer:Pointer; Size:LongWord):LongWord;
Description: Release a memory block containing the firmware for a specified device from a registered handler


[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


[Expand] 
procedure NotifierRetry(Retry:PNotifierRetry);
Description: To be documented


[Expand] 
procedure NotifierWorker(Task:PNotifierTask);
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: Find a driver by ID in the driver table


[Expand] 
function DriverFindByName(const Name:String):PDriver;
Description: Find a driver by name in the driver table


[Expand] 
function DriverEnumerate(DriverClass:LongWord; Callback:TDriverEnumerate; Data:Pointer):LongWord;
Description: Enumerate all drivers in the driver table


Clock device functions

[Expand] 
function ClockDeviceStart(Clock:PClockDevice):LongWord;
Description: Start the counter of the specified clock device


[Expand] 
function ClockDeviceStop(Clock:PClockDevice):LongWord;
Description: Stop the counter of the specified clock device


[Expand] 
function ClockDeviceRead(Clock:PClockDevice):LongWord;
Description: Read the counter value of the specified clock device


[Expand] 
function ClockDeviceRead64(Clock:PClockDevice):Int64;
Description: Read the counter value of the specified clock device


[Expand] 
function ClockDeviceWrite64(Clock:PClockDevice; const Value:Int64):LongWord;
Description: Write the counter value of the specified clock device


[Expand] 
function ClockDeviceGetRate(Clock:PClockDevice):LongWord;
Description: Get the current clock rate in Hz of the specified clock device


[Expand] 
function ClockDeviceSetRate(Clock:PClockDevice; Rate:LongWord):LongWord;
Description: Set the current clock rate in Hz of the specified clock device


[Expand] 
function ClockDeviceProperties(Clock:PClockDevice; Properties:PClockProperties):LongWord; inline;
Description: Get the properties for the specified clock device


[Expand] 
function ClockDeviceGetProperties(Clock:PClockDevice; Properties:PClockProperties):LongWord;
Description: Get the properties for the specified clock device


[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: Find a clock device by ID in the clock table


[Expand] 
function ClockDeviceFindByName(const Name:String):PClockDevice; inline;
Description: Find a clock device by name in the clock table


[Expand] 
function ClockDeviceFindByDescription(const Description:String):PClockDevice; inline;
Description: Find a clock device by description in the clock table


[Expand] 
function ClockDeviceEnumerate(Callback:TClockEnumerate; Data:Pointer):LongWord;
Description: Enumerate all clock devices in the clock table


[Expand] 
function ClockDeviceNotification(Clock:PClockDevice; Callback:TClockNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for clock device changes


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; inline;
Description: Get the properties for the specified Timer device


[Expand] 
function TimerDeviceGetProperties(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 RandomDeviceReadDouble(Random:PRandomDevice):Double;
Description: To be documented


[Expand] 
function RandomDeviceReadExtended(Random:PRandomDevice):Extended; inline;
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 SysRandomReadDouble:Double;
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;
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;
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); inline;
Description: To be documented


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


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


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


Driver helper functions

[Expand] 
function DriverGetCount:LongWord;
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;
Description: Get the current clock device count


[Expand] 
function ClockDeviceGetDefault:PClockDevice;
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


[Expand] 
function ClockTypeToString(ClockType:LongWord):String;
Description: Convert a Clock type value to a string


[Expand] 
function ClockStateToString(ClockState:LongWord):String;
Description: Convert a Clock state value to a string


Timer device helper functions

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


[Expand] 
function TimerDeviceGetDefault:PTimerDevice;
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 TimerTypeToString(TimerType:LongWord):String;
Description: Convert a Timer type value to a string


[Expand] 
function TimerStateToString(TimerState:LongWord):String;
Description: Convert a Timer state value to a string


[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;
Description: Get the current random device count


[Expand] 
function RandomDeviceGetDefault:PRandomDevice;
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


[Expand] 
function RandomTypeToString(RandomType:LongWord):String;
Description: Convert a Random type value to a string


[Expand] 
function RandomStateToString(RandomState:LongWord):String;
Description: Convert a Random state value to a string


Mailbox device helper functions

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


[Expand] 
function MailboxDeviceGetDefault:PMailboxDevice;
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


[Expand] 
function MailboxTypeToString(MailboxType:LongWord):String;
Description: Convert a Mailbox type value to a string


[Expand] 
function MailboxStateToString(MailboxState:LongWord):String;
Description: Convert a Mailbox state value to a string


Watchdog device helper functions

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


[Expand] 
function WatchdogDeviceGetDefault:PWatchdogDevice;
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


[Expand] 
function WatchdogTypeToString(WatchdogType:LongWord):String;
Description: Convert a Watchdog type value to a string


[Expand] 
function WatchdogStateToString(WatchdogState:LongWord):String;
Description: Convert a Watchdog state value to a string


Return to Unit Reference

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