|
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 task |
|
11 PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd"> |
|
12 <task id="GUID-10D79C75-6AB9-4717-87EF-057F19CB8283" xml:lang="en"><title>Time Implementation Guide</title><shortdesc>How to implement the Time platform service.</shortdesc><prolog><metadata><keywords/></metadata></prolog><taskbody> |
|
13 <prereq id="GUID-9237420C-294D-4A65-AB19-46BD17038B5D"><p>The Time |
|
14 platform service specifies functions to get and set the current time.</p></prereq> |
|
15 <context id="GUID-547ED715-ED71-486D-B9F2-CFD9E39C4E83"><p>To implement |
|
16 the Time platform service, you implement the functions <xref href="GUID-DED2C0D0-EA27-3C02-8FF2-8CB5ADCC1170.dita"><apiname>RtcData()</apiname></xref> and <xref href="GUID-9926EDCB-DA2C-3D1C-9637-CB3147E7E97A.dita"><apiname>SetRtcData()</apiname></xref> in hardware.</p></context> |
|
17 <steps id="GUID-4DD07DEC-6017-4237-BE46-1D69E5FBD744-GENID-1-2-1-10-1-5-1-10-1-1-8-1-3-1-3-3"> |
|
18 <step id="GUID-9A69E5AD-E938-4092-A8C2-CB65C37C8962-GENID-1-2-1-10-1-5-1-10-1-1-8-1-3-1-3-3-1"><cmd/> |
|
19 <info><p>The function <xref href="GUID-9926EDCB-DA2C-3D1C-9637-CB3147E7E97A.dita"><apiname>SetRtcData()</apiname></xref> sets the state |
|
20 of the real time clock to a passed in value. To implement it you write |
|
21 that value to the RTC current time register. On Symbian platform, |
|
22 the value should be the number of seconds that have elapsed since |
|
23 the beginning of 2000.</p></info> |
|
24 <stepresult><p>The platform now has a function to set the current |
|
25 time in seconds.</p></stepresult> |
|
26 </step> |
|
27 <step id="GUID-9A69E5AD-E938-4092-A8C2-CB65C37C8962-GENID-1-2-1-10-1-5-1-10-1-1-8-1-3-1-3-3-2"><cmd/> |
|
28 <info><p>The function <xref href="GUID-DED2C0D0-EA27-3C02-8FF2-8CB5ADCC1170.dita"><apiname>RtcData()</apiname></xref> returns the current |
|
29 state of the real time clock. To implement it, you read the RTC current |
|
30 time register and return that time as a <xref href="GUID-F9432D7B-41C9-3048-AC50-B5BCF8BE11D0.dita"><apiname>TUint</apiname></xref>.</p></info> |
|
31 <stepresult><p>The current state of the real time clock is a <xref href="GUID-F9432D7B-41C9-3048-AC50-B5BCF8BE11D0.dita"><apiname>TUint</apiname></xref> containing the number of seconds since the beginning |
|
32 of 2000.</p></stepresult> |
|
33 </step> |
|
34 </steps> |
|
35 <result id="GUID-A265C295-5403-4C52-9CC1-8D004F06DC4A"><p>You have |
|
36 now implemented the Time platform service in hardware.</p></result> |
|
37 </taskbody><related-links> |
|
38 <link href="GUID-8D237BD6-9759-4180-B190-F1624594017F.dita"><linktext>Time |
|
39 Client Interface Tutorial — Using the Interface</linktext></link> |
|
40 </related-links></task> |