Adaptation/GUID-01072199-382F-4691-AC0D-D1226EE5CF2F.dita
changeset 15 307f4279f433
--- /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 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
+<!-- This component and the accompanying materials are made available under the terms of the License 
+"Eclipse Public License v1.0" which accompanies this distribution, 
+and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
+<!-- Initial Contributors:
+    Nokia Corporation - initial contribution.
+Contributors: 
+-->
+<!DOCTYPE concept
+  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="GUID-01072199-382F-4691-AC0D-D1226EE5CF2F" xml:lang="en"><title>Time Client Interface Quick Start</title><shortdesc>Explains how to use the interface between the Time platform
+service and its clients.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
+<section id="GUID-91FBBDBE-A015-4B6A-A1DB-74D87A6DB816"><title>Introduction</title><p>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.</p> </section>
+<section id="GUID-C072C87B-323F-4678-BD81-7D34F2E9E6DF"><title>Time
+client interface limitations</title><p>None</p></section>
+<section id="GUID-E306BFAB-60CC-46D5-8176-A2FEDF55C89B"><title>Adaptation
+dependencies</title><p>None</p></section>
+<section id="GUID-4ADBBA99-D1D6-4E1A-9C5A-81E882011A61"><title>Time
+client interface classes</title><p>The following classes provide the
+RTC interface:</p><table id="GUID-D01391B7-9427-45F3-A873-5FE9BDEDCCA4">
+<tgroup cols="2"><colspec colname="col1" colwidth="0.46*"/><colspec colname="col2" colwidth="1.54*"/>
+<tbody>
+<row>
+<entry><p><b>Name</b></p></entry>
+<entry><p><b>Description</b></p></entry>
+</row>
+<row>
+<entry><p><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita"><apiname>MRtcAdaptation</apiname></xref></p></entry>
+<entry><p>Provides the interface between the Real Time Clock (RTC)
+and the upper layers of the OS.</p></entry>
+</row>
+<row>
+<entry><p><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita"><apiname>ASIC</apiname></xref></p></entry>
+<entry><p>Provides an interface to the Application Specific Integrated
+Circuit (ASIC) that is being used.</p></entry>
+</row>
+</tbody>
+</tgroup>
+</table><p>The functionality provided by this class, can be split
+into the following groups:</p><ul>
+<li><p>Diagnostics</p></li>
+<li><p>Management of the wake-up alarm</p></li>
+<li><p>Request management</p></li>
+<li><p>Set and read the RTC</p></li>
+</ul></section>
+<section id="GUID-7A7E1108-5D58-4500-AB6C-BFC8CA65EE0E"><title>Diagnostics</title><p>These methods are used to test that the RTC is working correctly.
+The methods that are included in this group are:</p><ul>
+<li><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-98F7B0DE-CBA6-430C-972D-02F9AB444E1B">MRtcAdaptation::ValidateRtc()</xref></li>
+<li><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-3D0DD0AB-4F3F-4411-B5E8-9199AB71F1A6">ASIC::SetSystemTimeCalibration()</xref></li>
+</ul></section>
+<section id="GUID-CB062F05-0410-4B8D-930F-2DD55BAFC829"><title>Management
+of the wake-up alarm</title><p>This group of methods, relate to the
+setting and releasing of the wake-up alarm. The methods that are included
+in this group are:<ul>
+<li><p><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-813CB223-3385-4293-9D1C-8C712B031E8F">MRtcAdaptation::SetWakeUpAlarm()</xref></p></li>
+<li><p><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-DE156EC7-759F-4BFC-BCAA-FE0E84CC83D9">MRtcAdaptation::UnsetWakeUpAlarm()</xref></p></li>
+</ul></p></section>
+<section id="GUID-DDED587F-ADBF-4C3D-A263-8A1D333EE85C"><title>Request
+management</title><p>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:</p><ul>
+<li><p><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-1111CFEA-D85C-4107-BB14-618C6A5A0B3F">MRtcAdaptation::Cancel()</xref></p></li>
+<li><p><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-2EE46E01-006D-431E-B6C0-CAEBDDE5D53A">MRtcAdaptation::Release()</xref></p></li>
+</ul></section>
+<section id="GUID-69B30672-ABD6-421A-967A-3669C8477505"><title>Set
+and read the RTC</title><p>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.</p><ul>
+<li><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-C69C0225-1779-4FFC-B071-D18B71C18A74">ASIC::SystemTimeInSecondsFrom2000()</xref></li>
+<li><xref href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita#GUID-8D237BD6-9759-4180-B190-F1624594017F/GUID-1BFBAEE5-AE48-4624-BD34-3D6B936C8C3B">ASIC::SetSystemTimeInSecondsFrom2000()</xref></li>
+</ul></section>
+</conbody></concept>
\ No newline at end of file