<?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-FE77CDFC-B66B-485B-A94D-F646894FD330" xml:lang="en"><title>Time Interface Guide</title><shortdesc>Provides a summary of Time platform service interface.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
<p>The Time platform service interface is provided by the <xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita"><apiname>MRtcAdaptation</apiname></xref> class. The class is defined in the <filepath>os/devicesrv/sysstatemgmt/systemstatemgr/inc/ssmadaptation.h</filepath> header file.</p>
<section id="GUID-47171771-F8A3-46C4-8EC1-4817BE037634">         
   <title>Interface classes</title>             <table id="GUID-111B0F19-7C0C-48FD-90BE-4AF2C1B3D81C">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<thead>
<row>
<entry valign="top">Class </entry>
<entry valign="top">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita"><apiname>MRtcAdaptation</apiname></xref></entry>
<entry>Provides the interface between the Real Time Clock (RTC) and
the upper layers of the operating system.</entry>
</row>
<row>
<entry><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita"><apiname>ASIC</apiname></xref></entry>
<entry>Provides an interface to the Application Specific Integrated
Circuit (ASIC) that is being used.</entry>
</row>
</tbody>
</tgroup>
</table>      </section>
<section id="GUID-956B0961-1F18-43AD-89EF-EBB5966DC3A2"><title>Time
adaptation functions</title><p>The following functions should be implemented
to provide the Time platform service functionality.</p><table id="GUID-A3E87FE5-5000-477F-8DE1-EE587B58B054">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<thead>
<row>
<entry valign="top">API</entry>
<entry valign="top">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita#GUID-CC79A63E-15DF-3437-983B-9A90966B3004/GUID-949F292B-90FE-3412-9529-E63503669758"><apiname>MRtcAdaptation::ValidateRtc(TDesc8&amp; aValidityPckg,
TRequestStatus aStatus)</apiname></xref></entry>
<entry>Check the real time clock implementation is valid. </entry>
</row>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita#GUID-CC79A63E-15DF-3437-983B-9A90966B3004/GUID-C9CA1DF9-786F-39D3-B661-2F082C164BC6"><apiname>MRtcAdaptation::SetWakeupAlarm(TDesC8&amp; aAlarmTimePckg,
TRequestStatus&amp; aStat)</apiname></xref></entry>
<entry>Set a device wakeup alarm time in UTC. </entry>
</row>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita#GUID-CC79A63E-15DF-3437-983B-9A90966B3004/GUID-77E1ECE3-06C1-3C61-9756-C1C83A14DDA5"><apiname>MRtcAdaptation::UnsetWakeupAlarm(TRequestStatus&amp;
aStatus)</apiname></xref></entry>
<entry>Delete the device wakeup alarm.</entry>
</row>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita#GUID-CC79A63E-15DF-3437-983B-9A90966B3004/GUID-ADC7041A-23F0-319F-A163-29E8BB261D0B"><apiname>MRtcAdaptation::Cancel()</apiname></xref></entry>
<entry>Cancel any outstanding request to the real time clock.</entry>
</row>
<row>
<entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita#GUID-CC79A63E-15DF-3437-983B-9A90966B3004/GUID-C44E98E9-6568-3628-9A7E-85379C4298FD"><apiname>MRtcAdaptation::Release()</apiname></xref></entry>
<entry>Deletes and release the allocated memory.</entry>
</row>
</tbody>
</tgroup>
</table><p><note>The above function calls will return <codeph>KErrNotSuported
in an emulator.</codeph></note></p></section>
<section id="GUID-514CDC5A-D8CF-436D-B155-B3176BAAC6E6"><title>ASIC
functions</title><p>The functions related to the Time platform service
in the ASIC class.</p><table id="GUID-C31721D2-CB8A-42CE-AB88-19B81E43FF0E">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<thead>
<row>
<entry valign="top">API</entry>
<entry valign="top">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita#GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9/GUID-2D7976BE-F6D5-3FC4-8253-C34A592A63D3"><apiname>ASIC::SetSystemTimeCalibration()</apiname></xref></entry>
<entry>Set the real time clock by specifying the time calibration
in parts per million.</entry>
</row>
<row>
<entry><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita#GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9/GUID-DE2DBFE9-9B9E-3C30-9435-5EA8A12C54E6"><apiname>ASIC::SystemTimeInSecondsFrom2000(TInt)</apiname></xref></entry>
<entry>Get the system time in seconds from the year 2000.</entry>
</row>
<row>
<entry><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita#GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9/GUID-B210267E-2378-331C-8B4E-AF7E0FA0258B"><apiname>ASIC::SetSystemTimeInSecondsFrom2000(TInt)</apiname></xref></entry>
<entry>Set the system time to 0 from the start the year 2000.</entry>
</row>
</tbody>
</tgroup>
</table><p>The header file for the Time platform service can be found <xref href="http://developer.symbian.org/xref/oss/xref/MCL/sf/os/devicesrv/sysstatemgmt/systemstatemgr/inc/ssmadaptation.h.dita#http://developer.symbian.org/xref/oss/xref/MCL/sf/os/devicesrv/sysstatemgmt/systemstatemgr/inc/ssmadaptation.h/MRtcAdaptation">here</xref>.</p></section>
</conbody></concept>