diff -r 578be2adaf3e -r 307f4279f433 Adaptation/GUID-01072199-382F-4691-AC0D-D1226EE5CF2F.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Adaptation/GUID-01072199-382F-4691-AC0D-D1226EE5CF2F.dita Fri Oct 15 14:32:18 2010 +0100 @@ -0,0 +1,78 @@ + + + + + +Time Client Interface Quick StartExplains how to use the interface between the Time platform +service and its clients. +
Introduction

The Time client interface is used when communicating with the +Real Time Clock (RTC). This client interface can be used to check +that the RTC is working correctly, maintain its request queue and +to set/reset the wake-up alarm.

+
Time +client interface limitations

None

+
Adaptation +dependencies

None

+
Time +client interface classes

The following classes provide the +RTC interface:

+ + + +

Name

+

Description

+
+ +

MRtcAdaptation

+

Provides the interface between the Real Time Clock (RTC) +and the upper layers of the OS.

+
+ +

ASIC

+

Provides an interface to the Application Specific Integrated +Circuit (ASIC) that is being used.

+
+ + +

The functionality provided by this class, can be split +into the following groups:

    +
  • Diagnostics

  • +
  • Management of the wake-up alarm

  • +
  • Request management

  • +
  • Set and read the RTC

  • +
+
Diagnostics

These methods are used to test that the RTC is working correctly. +The methods that are included in this group are:

    +
  • MRtcAdaptation::ValidateRtc()
  • +
  • ASIC::SetSystemTimeCalibration()
  • +
+
Management +of the wake-up alarm

This group of methods, relate to the +setting and releasing of the wake-up alarm. The methods that are included +in this group are:

    +
  • MRtcAdaptation::SetWakeUpAlarm()

  • +
  • MRtcAdaptation::UnsetWakeUpAlarm()

  • +

+
Request +management

Calls to the RTC are placed in a request queue, +waiting for the RTC to process them. Calls to the other two groups +of functionality add requests to the queue for the RTC, the methods +in this group remove them. The methods that are included in this +group are:

    +
  • MRtcAdaptation::Cancel()

  • +
  • MRtcAdaptation::Release()

  • +
+
Set +and read the RTC

These functions are used to set and read +the RTC. Both functions measure time as the number of seconds since +the start of the year 2000.

    +
  • ASIC::SystemTimeInSecondsFrom2000()
  • +
  • ASIC::SetSystemTimeInSecondsFrom2000()
  • +
+
\ No newline at end of file