Unit RTC

From Ultibo.org
Revision as of 04:14, 2 September 2016 by Ultibo (Talk | contribs)

Jump to: navigation, search

Return to Unit Reference


Description


The RTC unit provides the device interface for real time clock modules to be registered with Ultibo core. Each RTC module requires a driver that communicates with the specific hardware to implement the device interface although many devices may use the same chip and will be covered by a single driver.

This unit registers the RTCGetTime and RTCSetTime functions with the Platform unit to enable hardware independent access to a real time clock module.

Constants


To be documented

Type definitions


To be documented

Public variables


To be documented

Function declarations



Initialization functions

procedure RTCInit;
Description: To be documented
Note To be documented


RTC functions

function RTCDeviceStart(RTC:PRTCDevice):LongWord;
Description: To be documented
Note To be documented


function RTCDeviceStop(RTC:PRTCDevice):LongWord;
Description: To be documented
Note To be documented


function RTCDeviceGetTime(RTC:PRTCDevice):Int64;
Description: To be documented
Note To be documented


function RTCDeviceSetTime(RTC:PRTCDevice; const Time:Int64):Int64;
Description: To be documented
Note To be documented


function RTCDeviceProperties(RTC:PRTCDevice; Properties:PRTCProperties):LongWord;
Description: To be documented
Note To be documented


function RTCDeviceCreate:PRTCDevice;
Description: Create a new RTC entry
Return Pointer to new RTC entry or nil if RTC could not be created


function RTCDeviceCreateEx(Size:LongWord):PRTCDevice;
Description: Create a new RTC entry
Size Size in bytes to allocate for new RTC (Including the RTC entry)
Return Pointer to new RTC entry or nil if RTC could not be created


function RTCDeviceDestroy(RTC:PRTCDevice):LongWord;
Description: Destroy an existing RTC entry
Note To be documented


function RTCDeviceRegister(RTC:PRTCDevice):LongWord;
Description: Register a new RTC in the RTC table
Note To be documented


function RTCDeviceDeregister(RTC:PRTCDevice):LongWord;
Description: Deregister a RTC from the RTC table
Note To be documented


function RTCDeviceFind(RTCId:LongWord):PRTCDevice;
Description: To be documented
Note To be documented


function RTCDeviceFindByName(const Name:String):PRTCDevice; inline;
Description: To be documented
Note To be documented


function RTCDeviceFindByDescription(const Description:String):PRTCDevice; inline;
Description: To be documented
Note To be documented


function RTCDeviceEnumerate(Callback:TRTCEnumerate; Data:Pointer):LongWord;
Description: To be documented
Note To be documented


function RTCDeviceNotification(RTC:PRTCDevice; Callback:TRTCNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented
Note To be documented


Return to Unit Reference