FreeCalypso > hg > fc-magnetite
comparison src/condat3/com/include/rtc.h @ 18:c8bd5a927942
src/condat3: import of "condat" tree from TCS3.2, pruned
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Tue, 27 Sep 2016 21:25:36 +0000 |
parents | |
children | f3f58412df01 |
comparison
equal
deleted
inserted
replaced
17:6323e661f2ed | 18:c8bd5a927942 |
---|---|
1 /* | |
2 +----------------------------------------------------------------------------- | |
3 | Project : GSM (6301) | |
4 | Modul : | |
5 +----------------------------------------------------------------------------- | |
6 | Copyright 2002 Texas Instruments Berlin, AG | |
7 | All rights reserved. | |
8 | | |
9 | This file is confidential and a trade secret of Texas | |
10 | Instruments Berlin, AG | |
11 | The receipt of or possession of this file does not convey | |
12 | any rights to reproduce or disclose its contents or to | |
13 | manufacture, use, or sell anything it may describe, in | |
14 | whole, or in part, without the specific written consent of | |
15 | Texas Instruments Berlin, AG. | |
16 +----------------------------------------------------------------------------- | |
17 | Purpose : Type definitions and function prototypes for the real time clock driver | |
18 | SPR 1725, re-wrote file for new RTC driver implementation. | |
19 +----------------------------------------------------------------------------- | |
20 | |
21 Aug 02, 2006 REF:OMAPS00083404 Prabakar R (a0393213) | |
22 Description: Removal of clone code: entity GDI | |
23 Solution: Two similar functions(rtc_get_time_date() and rtc_get_alarm()) are made into one function rtc_get_time_date(). | |
24 As a result, interface for rtc_get_time_date() has been changed. The change is only for locosto. | |
25 */ | |
26 | |
27 #ifndef DEF_RTC__H | |
28 #define DEF_RTC__H | |
29 /*==== INCLUDES ===================================================*/ | |
30 #include <string.h> | |
31 #include "typedefs.h" | |
32 #include "gdi.h" | |
33 #include "kbd.h" | |
34 /*==== EXPORT =====================================================*/ | |
35 /* | |
36 * type definitions | |
37 */ | |
38 | |
39 | |
40 typedef enum | |
41 { | |
42 RTC_TIME_FORMAT_12HOUR, | |
43 RTC_TIME_FORMAT_24HOUR | |
44 } T_RTC_TIME_FORMAT; | |
45 | |
46 typedef struct { | |
47 UBYTE day; | |
48 UBYTE month; | |
49 USHORT year; | |
50 } T_RTC_DATE; | |
51 | |
52 | |
53 typedef struct | |
54 { UBYTE minute; | |
55 UBYTE hour; | |
56 UBYTE second; | |
57 T_RTC_TIME_FORMAT format; | |
58 BOOL PM_flag; | |
59 } T_RTC_TIME; | |
60 | |
61 /* | |
62 Aug 02, 2006 REF:OMAPS00083404 Prabakar R (a0393213) | |
63 Description: Removal of clone code: entity GDI | |
64 Solution: Two similar functions(rtc_get_time_date() and rtc_get_alarm()) are made into one function rtc_get_time_date(). | |
65 This type is added to differenciate the functionality in the function. | |
66 */ | |
67 typedef enum | |
68 { | |
69 RTC_TIME_TYPE_CURRENT, | |
70 RTC_TIME_TYPE_ALARM | |
71 } T_RTC_TIME_TYPE; | |
72 | |
73 typedef void (*RtcCallback) (void*); /* RTC event handler */ | |
74 | |
75 /* | |
76 * Prototypes | |
77 */ | |
78 | |
79 | |
80 BOOL rtc_clock_cleared();// wrapper for RTC_RtcReset(); | |
81 | |
82 UBYTE rtc_set_time_date(T_RTC_DATE* date, T_RTC_TIME* time); // wrapper for RTC_setTimeDate(); | |
83 | |
84 /* | |
85 Aug 02, 2006 REF:OMAPS00083404 Prabakar R (a0393213) | |
86 Description: Removal of clone code: entity GDI | |
87 Solution: Two similar functions(rtc_get_time_date() and rtc_get_alarm()) are made into one function rtc_get_time_date() | |
88 As a result interface of rtc_get_time_date() has been changed. A new parameter 'type' has been added. | |
89 | |
90 */ | |
91 UBYTE rtc_get_time_date(T_RTC_DATE* date, T_RTC_TIME* time , T_RTC_TIME_TYPE type ); // wrapper for RTC_getTimeDate(); | |
92 | |
93 UBYTE rtc_set_alarm(T_RTC_DATE* date , T_RTC_TIME* time, RtcCallback callback_func );//wrapper for RTC_setAlarm(); | |
94 | |
95 /* | |
96 Aug 02, 2006 REF:OMAPS00083404 Prabakar R (a0393213) | |
97 Description: Removal of clone code: entity GDI | |
98 Solution: Two similar functions(rtc_get_time_date() and rtc_get_alarm()) are made into one function rtc_get_time_date() | |
99 So rtc_get_alarm() is removed. To get the time which is set for alarm, use rtc_get_time_date() with RTC_TIME_TYPE_ALARM as third argument | |
100 */ | |
101 | |
102 UBYTE rtc_unset_alarm();//wrapper for RTC_UnsetAlarm(); | |
103 | |
104 UBYTE rtc_set_time_format(T_RTC_TIME_FORMAT format);//wrapper for RTC_Set12HourMode(); | |
105 | |
106 | |
107 | |
108 | |
109 | |
110 #endif /* #ifndef DEF_RTC_H */ |