1 <?xml version="1.0" encoding="utf-8"?>

     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

     3 <!-- This component and the accompanying materials are made available under the terms of the License 

     4 "Eclipse Public License v1.0" which accompanies this distribution, 

     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

     6 <!-- Initial Contributors:

     7     Nokia Corporation - initial contribution.

     8 Contributors: 

     9 -->

    10 <!DOCTYPE concept

    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

    12 <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>

    13 <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>

    14 <section id="GUID-47171771-F8A3-46C4-8EC1-4817BE037634">         

    15    <title>Interface classes</title>             <table id="GUID-111B0F19-7C0C-48FD-90BE-4AF2C1B3D81C">

    16 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>

    17 <thead>

    18 <row>

    19 <entry valign="top">Class </entry>

    20 <entry valign="top">Description</entry>

    21 </row>

    22 </thead>

    23 <tbody>

    24 <row>

    25 <entry><xref href="GUID-CC79A63E-15DF-3437-983B-9A90966B3004.dita"><apiname>MRtcAdaptation</apiname></xref></entry>

    26 <entry>Provides the interface between the Real Time Clock (RTC) and

    27 the upper layers of the operating system.</entry>

    28 </row>

    29 <row>

    30 <entry><xref href="GUID-69C70CA3-1121-3C5B-AEA4-B2E0245539B9.dita"><apiname>ASIC</apiname></xref></entry>

    31 <entry>Provides an interface to the Application Specific Integrated

    32 Circuit (ASIC) that is being used.</entry>

    33 </row>

    34 </tbody>

    35 </tgroup>

    36 </table>      </section>

    37 <section id="GUID-956B0961-1F18-43AD-89EF-EBB5966DC3A2"><title>Time

    38 adaptation functions</title><p>The following functions should be implemented

    39 to provide the Time platform service functionality.</p><table id="GUID-A3E87FE5-5000-477F-8DE1-EE587B58B054">

    40 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>

    41 <thead>

    42 <row>

    43 <entry valign="top">API</entry>

    44 <entry valign="top">Description</entry>

    45 </row>

    46 </thead>

    47 <tbody>

    48 <row>

    49 <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,

    50 TRequestStatus aStatus)</apiname></xref></entry>

    51 <entry>Check the real time clock implementation is valid. </entry>

    52 </row>

    53 <row>

    54 <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,

    55 TRequestStatus&amp; aStat)</apiname></xref></entry>

    56 <entry>Set a device wakeup alarm time in UTC. </entry>

    57 </row>

    58 <row>

    59 <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;

    60 aStatus)</apiname></xref></entry>

    61 <entry>Delete the device wakeup alarm.</entry>

    62 </row>

    63 <row>

    64 <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>

    65 <entry>Cancel any outstanding request to the real time clock.</entry>

    66 </row>

    67 <row>

    68 <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>

    69 <entry>Deletes and release the allocated memory.</entry>

    70 </row>

    71 </tbody>

    72 </tgroup>

    73 </table><p><note>The above function calls will return <codeph>KErrNotSuported

    74 in an emulator.</codeph></note></p></section>

    75 <section id="GUID-514CDC5A-D8CF-436D-B155-B3176BAAC6E6"><title>ASIC

    76 functions</title><p>The functions related to the Time platform service

    77 in the ASIC class.</p><table id="GUID-C31721D2-CB8A-42CE-AB88-19B81E43FF0E">

    78 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>

    79 <thead>

    80 <row>

    81 <entry valign="top">API</entry>

    82 <entry valign="top">Description</entry>

    83 </row>

    84 </thead>

    85 <tbody>

    86 <row>

    87 <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>

    88 <entry>Set the real time clock by specifying the time calibration

    89 in parts per million.</entry>

    90 </row>

    91 <row>

    92 <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>

    93 <entry>Get the system time in seconds from the year 2000.</entry>

    94 </row>

    95 <row>

    96 <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>

    97 <entry>Set the system time to 0 from the start the year 2000.</entry>

    98 </row>

    99 </tbody>

   100 </tgroup>

   101 </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>

   102 </conbody></concept>