Unit Devices
Return to Unit Reference
Description
To be documented
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure DevicesInit;
Note | Called only during system startup |
---|
Device functions
function DeviceCreate:PDevice;
Return | Pointer to new Device entry or nil if device could not be created |
---|
function DeviceCreateEx(Size:LongWord):PDevice;
Size | Size in bytes to allocate for new device (Including the device entry) |
---|---|
Return | Pointer to new Device entry or nil if device could not be created |
function DeviceDestroy(Device:PDevice):LongWord;
Note | None documented |
---|
function DeviceGetName(Device:PDevice):String;
Note | None documented |
---|
function DeviceSetName(Device:PDevice; const Name:String):LongWord;
Note | None documented |
---|
function DeviceGetDescription(Device:PDevice):String;
Note | None documented |
---|
function DeviceSetDescription(Device:PDevice; const Description:String):LongWord;
Note | None documented |
---|
function DeviceRegister(Device:PDevice):LongWord;
Note | None documented |
---|
function DeviceDeregister(Device:PDevice):LongWord;
Note | None documented |
---|
function DeviceFind(DeviceClass,DeviceId:LongWord):PDevice;
Note | None documented |
---|
function DeviceFindByName(const Name:String):PDevice;
Note | None documented |
---|
function DeviceFindByDescription(const Description:String):PDevice;
Note | None documented |
---|
function DeviceEnumerate(DeviceClass:LongWord; Callback:TDeviceEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function DeviceNotification(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
function NotifierAllocate(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):PNotifier;
Note | None documented |
---|
function NotifierRelease(Notifier:PNotifier):LongWord;
Note | None documented |
---|
function NotifierFind(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer):PNotifier;
Note | None documented |
---|
function NotifierNotify(Device:PDevice; Notification:LongWord):LongWord;
Note | None documented |
---|
Driver functions
function DriverCreate:PDriver;
Return | Pointer to new Driver entry or nil if driver could not be created |
---|
function DriverCreateEx(Size:LongWord):PDriver;
Size | Size in bytes to allocate for new driver (Including the driver entry) |
---|---|
Return | Pointer to new Driver entry or nil if driver could not be created |
function DriverDestroy(Driver:PDriver):LongWord;
Note | None documented |
---|
function DriverGetName(Driver:PDriver):String;
Note | None documented |
---|
function DriverSetName(Driver:PDriver; const Name:String):LongWord;
Note | None documented |
---|
function DriverRegister(Driver:PDriver):LongWord;
Note | None documented |
---|
function DriverDeregister(Driver:PDriver):LongWord;
Note | None documented |
---|
function DriverFind(DriverClass,DriverId:LongWord):PDriver;
Note | None documented |
---|
function DriverFindByName(const Name:String):PDriver;
Note | None documented |
---|
function DriverEnumerate(DriverClass:LongWord; Callback:TDriverEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
Clock device functions
function ClockDeviceStart(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceStop(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceRead(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceRead64(Clock:PClockDevice):Int64;
Note | None documented |
---|
function ClockDeviceWrite64(Clock:PClockDevice; const Value:Int64):LongWord;
Note | None documented |
---|
function ClockDeviceGetRate(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceCreate:PClockDevice;
Return | Pointer to new Clock entry or nil if Clock could not be created |
---|
function ClockDeviceCreateEx(Size:LongWord):PClockDevice;
Size | Size in bytes to allocate for new Clock (Including the Clock entry) |
---|---|
Return | Pointer to new Clock entry or nil if Clock could not be created |
function ClockDeviceDestroy(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceRegister(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceDeregister(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceFind(ClockId:LongWord):PClockDevice;
Note | None documented |
---|
function ClockDeviceFindByName(const Name:String):PClockDevice; inline;
Note | None documented |
---|
function ClockDeviceFindByDescription(const Description:String):PClockDevice; inline;
Note | None documented |
---|
function ClockDeviceEnumerate(Callback:TClockEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function ClockDeviceNotification(Clock:PClockDevice; Callback:TClockNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
Timer device functions
function TimerDeviceStart(Timer:PTimerDevice):LongWord;
Timer | The Timer device to start |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function TimerDeviceStop(Timer:PTimerDevice):LongWord;
Timer | The Timer device to stop |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function TimerDeviceRead(Timer:PTimerDevice):LongWord;
Timer | The Timer device to read from |
---|---|
Return | The 32 bit current value of the timer or 0 on failure |
function TimerDeviceRead64(Timer:PTimerDevice):Int64;
Timer | The Timer device to read from |
---|---|
Return | The 64 bit current value of the timer or 0 on failure |
function TimerDeviceWait(Timer:PTimerDevice):LongWord;
Timer | The Timer device to wait for |
---|---|
Return | ERROR_SUCCESS if the interval expired or another error code on failure |
function TimerDeviceEvent(Timer:PTimerDevice; Flags:LongWord; Callback:TTimerCallback; Data:Pointer):LongWord;
Timer | The Timer device to schedule the callback for |
---|---|
Callback | The function to be called when the interval expires |
Data | A pointer to be pass to the function when the interval expires (Optional) |
Return | ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure |
function TimerDeviceCancel(Timer:PTimerDevice):LongWord;
Timer | The Timer device to cancel the callback for |
---|---|
Return | ERROR_SUCCESS if the callback was cancelled successfully or another error code on failure |
function TimerDeviceGetRate(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceSetRate(Timer:PTimerDevice; Rate:LongWord):LongWord;
Note | None documented |
---|
function TimerDeviceGetInterval(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceSetInterval(Timer:PTimerDevice; Interval:LongWord):LongWord;
Note | None documented |
---|
function TimerDeviceProperties(Timer:PTimerDevice; Properties:PTimerProperties):LongWord;
Note | None documented |
---|
function TimerDeviceCreate:PTimerDevice;
Return | Pointer to new Timer entry or nil if Timer could not be created |
---|
function TimerDeviceCreateEx(Size:LongWord):PTimerDevice;
Size | Size in bytes to allocate for new Timer (Including the Timer entry) |
---|---|
Return | Pointer to new Timer entry or nil if Timer could not be created |
function TimerDeviceDestroy(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceRegister(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceDeregister(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceFind(TimerId:LongWord):PTimerDevice;
Note | None documented |
---|
function TimerDeviceFindByName(const Name:String):PTimerDevice; inline;
Note | None documented |
---|
function TimerDeviceFindByDescription(const Description:String):PTimerDevice; inline;
Note | None documented |
---|
function TimerDeviceEnumerate(Callback:TTimerEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function TimerDeviceNotification(Timer:PTimerDevice; Callback:TTimerNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
Random device functions
function RandomDeviceStart(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceStop(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceSeed(Random:PRandomDevice; Seed:LongWord):LongWord;
Note | None documented |
---|
function RandomDeviceReadByte(Random:PRandomDevice):Byte;
Note | None documented |
---|
function RandomDeviceReadWord(Random:PRandomDevice):Word;
Note | None documented |
---|
function RandomDeviceReadLongWord(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceReadQuadWord(Random:PRandomDevice):Int64;
Note | None documented |
---|
function RandomDeviceReadExtended(Random:PRandomDevice):Extended;
Note | None documented |
---|
function RandomDeviceCreate:PRandomDevice;
Return | Pointer to new Random entry or nil if Random could not be created |
---|
function RandomDeviceCreateEx(Size:LongWord):PRandomDevice;
Size | Size in bytes to allocate for new Random (Including the Random entry) |
---|---|
Return | Pointer to new Random entry or nil if Random could not be created |
function RandomDeviceDestroy(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceRegister(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceDeregister(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceFind(RandomId:LongWord):PRandomDevice;
Note | None documented |
---|
function RandomDeviceFindByName(const Name:String):PRandomDevice; inline;
Note | None documented |
---|
function RandomDeviceFindByDescription(const Description:String):PRandomDevice; inline;
Note | None documented |
---|
function RandomDeviceEnumerate(Callback:TRandomEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function RandomDeviceNotification(Random:PRandomDevice; Callback:TRandomNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
Mailbox device functions
function MailboxDeviceStart(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceStop(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceReceive(Mailbox:PMailboxDevice; Channel:LongWord):LongWord;
Note | None documented |
---|
function MailboxDeviceSend(Mailbox:PMailboxDevice; Channel,Data:LongWord):LongWord;
Note | None documented |
---|
function MailboxDeviceCall(Mailbox:PMailboxDevice; Channel,Data:LongWord; var Response:LongWord):LongWord;
Note | None documented |
---|
function MailboxDeviceGetTimeout(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceSetTimeout(Mailbox:PMailboxDevice; Timeout:LongWord):LongWord;
Note | None documented |
---|
function MailboxDeviceCreate:PMailboxDevice;
Return | Pointer to new Mailbox entry or nil if Mailbox could not be created |
---|
function MailboxDeviceCreateEx(Size:LongWord):PMailboxDevice;
Size | Size in bytes to allocate for new Mailbox (Including the Mailbox entry) |
---|---|
Return | Pointer to new Mailbox entry or nil if Mailbox could not be created |
function MailboxDeviceDestroy(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceRegister(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceDeregister(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceFind(MailboxId:LongWord):PMailboxDevice;
Note | None documented |
---|
function MailboxDeviceFindByName(const Name:String):PMailboxDevice; inline;
Note | None documented |
---|
function MailboxDeviceFindByDescription(const Description:String):PMailboxDevice; inline;
Note | None documented |
---|
function MailboxDeviceEnumerate(Callback:TMailboxEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function MailboxDeviceNotification(Mailbox:PMailboxDevice; Callback:TMailboxNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
Watchdog device functions
function WatchdogDeviceStart(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceStop(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceRefresh(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceGetRemain(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceGetTimeout(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceSetTimeout(Watchdog:PWatchdogDevice; Timeout:LongWord):LongWord;
Note | None documented |
---|
function WatchdogDeviceCreate:PWatchdogDevice;
Return | Pointer to new Watchdog entry or nil if Watchdog could not be created |
---|
function WatchdogDeviceCreateEx(Size:LongWord):PWatchdogDevice;
Size | Size in bytes to allocate for new Watchdog (Including the Watchdog entry) |
---|---|
Return | Pointer to new Watchdog entry or nil if Watchdog could not be created |
function WatchdogDeviceDestroy(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceRegister(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceDeregister(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceFind(WatchdogId:LongWord):PWatchdogDevice;
Note | None documented |
---|
function WatchdogDeviceFindByName(const Name:String):PWatchdogDevice; inline;
Note | None documented |
---|
function WatchdogDeviceFindByDescription(const Description:String):PWatchdogDevice; inline;
Note | None documented |
---|
function WatchdogDeviceEnumerate(Callback:TWatchdogEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function WatchdogDeviceNotification(Watchdog:PWatchdogDevice; Callback:TWatchdogNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
RTL clock functions
function SysClockRead:LongWord;
Note | None documented |
---|
function SysClockRead64:Int64;
Note | None documented |
---|
RTL timer (counter) functions
function SysTimerAvailable:Boolean;
Note | None documented |
---|
function SysTimerRead:LongWord;
Return | The 32 bit current value of the current or 0 on failure |
---|
function SysTimerRead64:Int64;
Return | The 64 bit current value of the current or 0 on failure |
---|
function SysTimerWait:LongWord;
Return | ERROR_SUCCESS if the interval expired or another error code on failure |
---|
function SysTimerEvent(Callback:TTimerCallback; Data:Pointer):LongWord;
Callback | The function to be called when the interval expires |
---|---|
Data | A pointer to be pass to the function when the interval expires (Optional) |
Return | ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure |
function SysTimerGetRate:LongWord;
Return | The current clock rate in Hz or 0 on failure |
---|
function SysTimerSetRate(Rate:LongWord):LongWord;
Rate | The clock rate in Hz to set |
---|---|
Return | ERROR_SUCCESS if the clock rate was set or another error code on failure |
function SysTimerGetInterval:LongWord;
Return | The current interval in milliseconds or 0 on failure (or not set) |
---|
function SysTimerSetInterval(Interval:LongWord):LongWord;
Interval | The interval in milliseconds to set |
---|---|
Return | ERROR_SUCCESS if the interval was set or another error code on failure |
RTL random functions
function SysRandomAvailable:Boolean;
Note | None documented |
---|
procedure SysRandomize;
Note | None documented |
---|
procedure SysRandomSeed(Seed:LongWord);
Note | None documented |
---|
function SysRandomReadLongInt(Limit:LongInt):LongInt;
Note | None documented |
---|
function SysRandomReadInt64(Limit:Int64):Int64;
Note | None documented |
---|
function SysRandomReadExtended:Extended;
Note | None documented |
---|
RTL watchdog functions
function SysWatchdogAvailable:Boolean;
Note | None documented |
---|
function SysWatchdogStart(Milliseconds:LongWord):LongWord;
Note | None documented |
---|
function SysWatchdogStop:LongWord;
Note | None documented |
---|
function SysWatchdogRefresh(Milliseconds:LongWord):LongWord;
Note | None documented |
---|
Device helper functions
function DeviceGetCount:LongWord; inline;
Note | None documented |
---|
function DeviceCheck(Device:PDevice):PDevice;
Note | None documented |
---|
function NotifierGetCount:LongWord; inline;
Note | None documented |
---|
function NotifierCheck(Notifier:PNotifier):PNotifier;
Note | None documented |
---|
function DeviceBusToString(DeviceBus:LongWord):String;
Note | None documented |
---|
function DeviceStateToString(DeviceState:LongWord):String;
Note | None documented |
---|
function DeviceClassToString(DeviceClass:LongWord):String;
Note | None documented |
---|
function NotificationToString(Notification:LongWord):String;
Note | None documented |
---|
procedure DeviceLog(Level:LongWord; Device:PDevice; const AText:String);
Note | None documented |
---|
procedure DeviceLogInfo(Device:PDevice; const AText:String);
Note | None documented |
---|
procedure DeviceLogError(Device:PDevice; const AText:String);
Note | None documented |
---|
procedure DeviceLogDebug(Device:PDevice; const AText:String);
Note | None documented |
---|
Driver helper functions
function DriverGetCount:LongWord; inline;
Note | None documented |
---|
function DriverCheck(Driver:PDriver):PDriver;
Note | None documented |
---|
function DriverStateToString(DriverState:LongWord):String;
Note | None documented |
---|
function DriverClassToString(DriverClass:LongWord):String;
Note | None documented |
---|
Clock device helper functions
function ClockDeviceGetCount:LongWord; inline;
Note | None documented |
---|
function ClockDeviceGetDefault:PClockDevice; inline;
Note | None documented |
---|
function ClockDeviceSetDefault(Clock:PClockDevice):LongWord;
Note | None documented |
---|
function ClockDeviceCheck(Clock:PClockDevice):PClockDevice;
Note | None documented |
---|
Timer device helper functions
function TimerDeviceGetCount:LongWord; inline;
Note | None documented |
---|
function TimerDeviceGetDefault:PTimerDevice; inline;
Note | None documented |
---|
function TimerDeviceSetDefault(Timer:PTimerDevice):LongWord;
Note | None documented |
---|
function TimerDeviceCheck(Timer:PTimerDevice):PTimerDevice;
Note | None documented |
---|
Random device helper functions
function RandomDeviceGetCount:LongWord; inline;
Note | None documented |
---|
function RandomDeviceGetDefault:PRandomDevice; inline;
Note | None documented |
---|
function RandomDeviceSetDefault(Random:PRandomDevice):LongWord;
Note | None documented |
---|
function RandomDeviceCheck(Random:PRandomDevice):PRandomDevice;
Note | None documented |
---|
Mailbox device helper functions
function MailboxDeviceGetCount:LongWord; inline;
Note | None documented |
---|
function MailboxDeviceGetDefault:PMailboxDevice; inline;
Note | None documented |
---|
function MailboxDeviceSetDefault(Mailbox:PMailboxDevice):LongWord;
Note | None documented |
---|
function MailboxDeviceCheck(Mailbox:PMailboxDevice):PMailboxDevice;
Note | None documented |
---|
Watchdog device helper functions
function WatchdogDeviceGetCount:LongWord; inline;
Note | None documented |
---|
function WatchdogDeviceGetDefault:PWatchdogDevice; inline;
Note | None documented |
---|
function WatchdogDeviceSetDefault(Watchdog:PWatchdogDevice):LongWord;
Note | None documented |
---|
function WatchdogDeviceCheck(Watchdog:PWatchdogDevice):PWatchdogDevice;
Note | None documented |
---|
Return to Unit Reference