Difference between revisions of "Unit RTC"

From Ultibo.org
Jump to: navigation, search
Line 92: Line 92:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''RTC properties'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PRTCProperties = ^TRTCProperties;</code>
 +
 
 +
<code>TRTCProperties = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Flags:LongWord;</code>
 +
| Device flags (eg RTC_FLAG_ALARM)
 +
|-
 +
| <code>MinTime:Int64;</code>
 +
| Minimum time value represented by the device (Normally the power on reset value)
 +
|-
 +
| <code>MaxTime:Int64;</code>
 +
| Maximum time value represented by the device (Time when a rollover will occur)
 +
|-
 +
| <code>AlarmCount:LongWord;</code>
 +
| Number of alarms supported by the device (0 if not supported)
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''RTC enumeration callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCEnumerate = function(RTC:PRTCDevice; Data:Pointer):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC notification callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC device start'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCDeviceStart = function(RTC:PRTCDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC device stop'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCDeviceStop = function(RTC:PRTCDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC device get time'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCDeviceGetTime = function(RTC:PRTCDevice):Int64;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC device set time'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCDeviceSetTime = function(RTC:PRTCDevice; const Time:Int64):Int64;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''RTC device properties'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TRTCDeviceProperties = function(RTC:PRTCDevice; Properties:PRTCProperties):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 +
'''RTC device'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PRTCDevice = ^TRTCDevice;</code>
 +
 
 +
<code>TRTCDevice = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Device Properties''
 +
|-
 +
| <code>Device:TDevice;</code>
 +
| The Device entry for this RTC
 +
|-
 +
|colspan="2"|''RTC Properties''
 +
|-
 +
| <code>RTCId:LongWord;</code>
 +
| Unique Id of this RTC in the RTC table
 +
|-
 +
| <code>RTCState:LongWord;</code>
 +
| RTC state (eg RTC_STATE_ENABLED)
 +
|-
 +
| <code>DeviceStart:TRTCDeviceStart;</code>
 +
| A Device specific DeviceStart method implementing the standard RTC device interface
 +
|-
 +
| <code>DeviceStop:TRTCDeviceStop;</code>
 +
| A Device specific DeviceStop method implementing the standard RTC device interface
 +
|-
 +
| <code>DeviceGetTime:TRTCDeviceGetTime;</code>
 +
| A Device specific DeviceGetTime method implementing the standard RTC device interface
 +
|-
 +
| <code>DeviceSetTime:TRTCDeviceSetTime;</code>
 +
| A Device specific DeviceSetTime method implementing the standard RTC device interface
 +
|-
 +
| <code>DeviceProperties:TRTCDeviceProperties;</code>
 +
| A Device specific DeviceProperties method implementing the standard RTC device interface
 +
|-
 +
|colspan="2"|''Statistics Properties''
 +
|-
 +
| <code>GetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Driver Properties''
 +
|-
 +
| <code>Lock:TMutexHandle;</code>
 +
| Device lock
 +
|-
 +
| <code>Properties:TRTCProperties;</code>
 +
| Device properties
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PRTCDevice;</code>
 +
| Previous entry in RTC table
 +
|-
 +
| <code>Next:PRTCDevice;</code>
 +
| Next entry in RTC table
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 03:16, 25 January 2017

Return to Unit Reference


Description

Ultibo Real Time Clock device interface unit

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


RTC specific constants RTC_*
RTC_NAME_PREFIX = 'RTC'; Name prefix for RTC Devices


RTC device type constants RTC_TYPE_*
RTC_TYPE_NONE = 0;  


RTC device state constants RTC_STATE_*
RTC_STATE_DISABLED = 0;  
RTC_STATE_ENABLED = 1;  


RTC device flag constants RTC_FLAG_*
RTC_FLAG_NONE = $00000000;  
RTC_FLAG_ALARM = $00000001; Device supports one or more alarms
RTC_FLAG_WATCHDOG = $00000002; Device has a watchdog timer function


RTC logging constants RTC_LOG_*
RTC_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG; RTC debugging messages
RTC_LOG_LEVEL_INFO = LOG_LEVEL_INFO; RTC informational messages, such as a device being attached or detached
RTC_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR; RTC error messages
RTC_LOG_LEVEL_NONE = LOG_LEVEL_NONE; No RTC messages


Type definitions


RTC properties

PRTCProperties = ^TRTCProperties;

TRTCProperties = record

Flags:LongWord; Device flags (eg RTC_FLAG_ALARM)
MinTime:Int64; Minimum time value represented by the device (Normally the power on reset value)
MaxTime:Int64; Maximum time value represented by the device (Time when a rollover will occur)
AlarmCount:LongWord; Number of alarms supported by the device (0 if not supported)

RTC enumeration callback

TRTCEnumerate = function(RTC:PRTCDevice; Data:Pointer):LongWord;

RTC notification callback

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

RTC device start

TRTCDeviceStart = function(RTC:PRTCDevice):LongWord;

RTC device stop

TRTCDeviceStop = function(RTC:PRTCDevice):LongWord;

RTC device get time

TRTCDeviceGetTime = function(RTC:PRTCDevice):Int64;

RTC device set time

TRTCDeviceSetTime = function(RTC:PRTCDevice; const Time:Int64):Int64;

RTC device properties

TRTCDeviceProperties = function(RTC:PRTCDevice; Properties:PRTCProperties):LongWord;

RTC device

PRTCDevice = ^TRTCDevice;

TRTCDevice = record

Device Properties
Device:TDevice; The Device entry for this RTC
RTC Properties
RTCId:LongWord; Unique Id of this RTC in the RTC table
RTCState:LongWord; RTC state (eg RTC_STATE_ENABLED)
DeviceStart:TRTCDeviceStart; A Device specific DeviceStart method implementing the standard RTC device interface
DeviceStop:TRTCDeviceStop; A Device specific DeviceStop method implementing the standard RTC device interface
DeviceGetTime:TRTCDeviceGetTime; A Device specific DeviceGetTime method implementing the standard RTC device interface
DeviceSetTime:TRTCDeviceSetTime; A Device specific DeviceSetTime method implementing the standard RTC device interface
DeviceProperties:TRTCDeviceProperties; A Device specific DeviceProperties method implementing the standard RTC device interface
Statistics Properties
GetCount:LongWord;  
SetCount:LongWord;  
Driver Properties
Lock:TMutexHandle; Device lock
Properties:TRTCProperties; Device properties
Internal Properties
Prev:PRTCDevice; Previous entry in RTC table
Next:PRTCDevice; Next entry in RTC table


Public variables


RTC logging

RTC_DEFAULT_LOG_LEVEL:LongWord = RTC_LOG_LEVEL_DEBUG; Minimum level for RTC messages. Only messages with level greater than or equal to this will be printed.
RTC_LOG_ENABLED:Boolean;


Function declarations


Initialization functions 

procedure RTCInit;
Description: To be documented
Note None documented


RTC functions 

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


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


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


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


function RTCDeviceProperties(RTC:PRTCDevice; Properties:PRTCProperties):LongWord;
Description: To be documented
Note None 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 None documented 


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


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


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


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


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


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


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


RTL RTC functions 

function SysRTCAvailable:Boolean;
Description: Check if an RTC device is available
Note None documented 


function SysRTCGetTime:Int64;
Description: Get the current time from a RTC device
Note Returned time is 100 nanosecond ticks since 1 January 1601 


function SysRTCSetTime(const Time:Int64):Int64;
Description: Set the current time for a RTC device
Time The time to be set
Return The device time after setting (or 0 on failure)
Note Time and returned time is 100 nanosecond ticks since 1 January 1601


RTC helper functions 

function RTCGetCount:LongWord; inline;
Description: Get the current RTC count
Note None documented 


function RTCDeviceGetDefault:PRTCDevice; inline;
Description: Get the current default RTC device
Note None documented 


function RTCDeviceSetDefault(RTC:PRTCDevice):LongWord;
Description: Set the current default RTC device
Note None documented 


function RTCDeviceCheck(RTC:PRTCDevice):PRTCDevice;
Description: Check if the supplied RTC is in the RTC table
Note None documented 


function RTCTimeIsValid(const Time:TSystemTime):Boolean;
Description: To be documented
Note None documented 


function RTCSystemTimeToFileTime(const SystemTime:TSystemTime; var FileTime:Int64):Boolean;
Description: System time is assumed to be UTC and returned file time is UTC
Note None documented 


function RTCFileTimeToSystemTime(const FileTime:Int64; var SystemTime:TSystemTime):Boolean;
Description: File time is assumed to be UTC and returned system time is UTC
Note None documented 


procedure RTCLog(Level:LongWord; RTC:PRTCDevice; const AText:String);
Description: To be documented
Note None documented 


procedure RTCLogInfo(RTC:PRTCDevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure RTCLogError(RTC:PRTCDevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure RTCLogDebug(RTC:PRTCDevice; const AText:String); inline;
Description: To be documented
Note None documented


Return to Unit Reference

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