]>
Commit | Line | Data |
---|---|---|
fb0b259e | 1 | /** @file\r |
2 | Header file for real time clock driver.\r | |
8cd4d17c | 3 | \r |
fb0b259e | 4 | Copyright (c) 2006 - 2007, Intel Corporation\r |
3cfb790c | 5 | All rights reserved. This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
8cd4d17c | 12 | \r |
fb0b259e | 13 | **/\r |
8cd4d17c | 14 | \r |
8cd4d17c | 15 | \r |
16 | #ifndef _RTC_H_\r | |
17 | #define _RTC_H_\r | |
18 | \r | |
ed7748fe | 19 | \r |
8cd4d17c | 20 | #include <PiDxe.h>\r |
ed7748fe | 21 | \r |
8cd4d17c | 22 | #include <Protocol/RealTimeClock.h>\r |
ed7748fe | 23 | \r |
8cd4d17c | 24 | #include <Library/BaseLib.h>\r |
25 | #include <Library/DebugLib.h>\r | |
26 | #include <Library/UefiLib.h>\r | |
27 | #include <Library/BaseMemoryLib.h>\r | |
28 | #include <Library/IoLib.h>\r | |
29 | #include <Library/TimerLib.h>\r | |
30 | #include <Library/UefiDriverEntryPoint.h>\r | |
31 | #include <Library/UefiBootServicesTableLib.h>\r | |
32 | #include <Library/UefiRuntimeLib.h>\r | |
33 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
34 | \r | |
35 | \r | |
36 | typedef struct {\r | |
37 | EFI_LOCK RtcLock;\r | |
38 | UINT16 SavedTimeZone;\r | |
39 | UINT8 Daylight;\r | |
40 | } PC_RTC_MODULE_GLOBALS;\r | |
41 | \r | |
42 | #define PCAT_RTC_ADDRESS_REGISTER 0x70\r | |
43 | #define PCAT_RTC_DATA_REGISTER 0x71\r | |
44 | \r | |
45 | //\r | |
46 | // Dallas DS12C887 Real Time Clock\r | |
47 | //\r | |
48 | #define RTC_ADDRESS_SECONDS 0 // R/W Range 0..59\r | |
49 | #define RTC_ADDRESS_SECONDS_ALARM 1 // R/W Range 0..59\r | |
50 | #define RTC_ADDRESS_MINUTES 2 // R/W Range 0..59\r | |
51 | #define RTC_ADDRESS_MINUTES_ALARM 3 // R/W Range 0..59\r | |
52 | #define RTC_ADDRESS_HOURS 4 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM\r | |
53 | #define RTC_ADDRESS_HOURS_ALARM 5 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM\r | |
54 | #define RTC_ADDRESS_DAY_OF_THE_WEEK 6 // R/W Range 1..7\r | |
55 | #define RTC_ADDRESS_DAY_OF_THE_MONTH 7 // R/W Range 1..31\r | |
56 | #define RTC_ADDRESS_MONTH 8 // R/W Range 1..12\r | |
57 | #define RTC_ADDRESS_YEAR 9 // R/W Range 0..99\r | |
58 | #define RTC_ADDRESS_REGISTER_A 10 // R/W[0..6] R0[7]\r | |
59 | #define RTC_ADDRESS_REGISTER_B 11 // R/W\r | |
60 | #define RTC_ADDRESS_REGISTER_C 12 // RO\r | |
61 | #define RTC_ADDRESS_REGISTER_D 13 // RO\r | |
62 | #define RTC_ADDRESS_CENTURY 50 // R/W Range 19..20 Bit 8 is R/W\r | |
63 | //\r | |
64 | // Date and time initial values.\r | |
65 | // They are used if the RTC values are invalid during driver initialization\r | |
66 | //\r | |
67 | #define RTC_INIT_SECOND 0\r | |
68 | #define RTC_INIT_MINUTE 0\r | |
69 | #define RTC_INIT_HOUR 0\r | |
70 | #define RTC_INIT_DAY 1\r | |
71 | #define RTC_INIT_MONTH 1\r | |
72 | #define RTC_INIT_YEAR 2001\r | |
73 | \r | |
74 | //\r | |
75 | // Register initial values\r | |
76 | //\r | |
77 | #define RTC_INIT_REGISTER_A 0x26\r | |
78 | #define RTC_INIT_REGISTER_B 0x02\r | |
79 | #define RTC_INIT_REGISTER_D 0x0\r | |
80 | \r | |
81 | #pragma pack(1)\r | |
82 | //\r | |
83 | // Register A\r | |
84 | //\r | |
85 | typedef struct {\r | |
86 | UINT8 RS : 4; // Rate Selection Bits\r | |
87 | UINT8 DV : 3; // Divisor\r | |
88 | UINT8 UIP : 1; // Update in progress\r | |
89 | } RTC_REGISTER_A_BITS;\r | |
90 | \r | |
91 | typedef union {\r | |
92 | RTC_REGISTER_A_BITS Bits;\r | |
93 | UINT8 Data;\r | |
94 | } RTC_REGISTER_A;\r | |
95 | \r | |
96 | //\r | |
97 | // Register B\r | |
98 | //\r | |
99 | typedef struct {\r | |
100 | UINT8 DSE : 1; // 0 - Daylight saving disabled 1 - Daylight savings enabled\r | |
101 | UINT8 MIL : 1; // 0 - 12 hour mode 1 - 24 hour mode\r | |
102 | UINT8 DM : 1; // 0 - BCD Format 1 - Binary Format\r | |
103 | UINT8 SQWE : 1; // 0 - Disable SQWE output 1 - Enable SQWE output\r | |
104 | UINT8 UIE : 1; // 0 - Update INT disabled 1 - Update INT enabled\r | |
105 | UINT8 AIE : 1; // 0 - Alarm INT disabled 1 - Alarm INT Enabled\r | |
106 | UINT8 PIE : 1; // 0 - Periodic INT disabled 1 - Periodic INT Enabled\r | |
107 | UINT8 SET : 1; // 0 - Normal operation. 1 - Updates inhibited\r | |
108 | } RTC_REGISTER_B_BITS;\r | |
109 | \r | |
110 | typedef union {\r | |
111 | RTC_REGISTER_B_BITS Bits;\r | |
112 | UINT8 Data;\r | |
113 | } RTC_REGISTER_B;\r | |
114 | \r | |
115 | //\r | |
116 | // Register C\r | |
117 | //\r | |
118 | typedef struct {\r | |
119 | UINT8 Reserved : 4; // Read as zero. Can not be written.\r | |
120 | UINT8 UF : 1; // Update End Interrupt Flag\r | |
121 | UINT8 AF : 1; // Alarm Interrupt Flag\r | |
122 | UINT8 PF : 1; // Periodic Interrupt Flag\r | |
123 | UINT8 IRQF : 1; // Iterrupt Request Flag = PF & PIE | AF & AIE | UF & UIE\r | |
124 | } RTC_REGISTER_C_BITS;\r | |
125 | \r | |
126 | typedef union {\r | |
127 | RTC_REGISTER_C_BITS Bits;\r | |
128 | UINT8 Data;\r | |
129 | } RTC_REGISTER_C;\r | |
130 | \r | |
131 | //\r | |
132 | // Register D\r | |
133 | //\r | |
134 | typedef struct {\r | |
135 | UINT8 Reserved : 7; // Read as zero. Can not be written.\r | |
136 | UINT8 VRT : 1; // Valid RAM and Time\r | |
137 | } RTC_REGISTER_D_BITS;\r | |
138 | \r | |
139 | typedef union {\r | |
140 | RTC_REGISTER_D_BITS Bits;\r | |
141 | UINT8 Data;\r | |
142 | } RTC_REGISTER_D;\r | |
143 | \r | |
144 | #pragma pack()\r | |
145 | \r | |
146 | EFI_STATUS\r | |
147 | PcRtcInit (\r | |
148 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
149 | )\r | |
150 | /*++\r | |
151 | \r | |
152 | Routine Description:\r | |
153 | \r | |
154 | GC_TODO: Add function description\r | |
155 | \r | |
156 | Arguments:\r | |
157 | \r | |
158 | Global - GC_TODO: add argument description\r | |
159 | \r | |
160 | Returns:\r | |
161 | \r | |
162 | GC_TODO: add return values\r | |
163 | \r | |
164 | --*/\r | |
165 | ;\r | |
166 | \r | |
167 | EFI_STATUS\r | |
168 | PcRtcSetTime (\r | |
169 | IN EFI_TIME *Time,\r | |
170 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
171 | )\r | |
172 | /*++\r | |
173 | \r | |
174 | Routine Description:\r | |
175 | \r | |
176 | GC_TODO: Add function description\r | |
177 | \r | |
178 | Arguments:\r | |
179 | \r | |
180 | Time - GC_TODO: add argument description\r | |
181 | Global - GC_TODO: add argument description\r | |
182 | \r | |
183 | Returns:\r | |
184 | \r | |
185 | GC_TODO: add return values\r | |
186 | \r | |
187 | --*/\r | |
188 | ;\r | |
189 | \r | |
190 | EFI_STATUS\r | |
191 | PcRtcGetTime (\r | |
192 | OUT EFI_TIME *Time,\r | |
193 | IN EFI_TIME_CAPABILITIES *Capabilities,\r | |
194 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
195 | )\r | |
196 | /*++\r | |
197 | \r | |
198 | Routine Description:\r | |
199 | \r | |
200 | GC_TODO: Add function description\r | |
201 | \r | |
202 | Arguments:\r | |
203 | \r | |
204 | Time - GC_TODO: add argument description\r | |
205 | Capabilities - GC_TODO: add argument description\r | |
206 | Global - GC_TODO: add argument description\r | |
207 | \r | |
208 | Returns:\r | |
209 | \r | |
210 | GC_TODO: add return values\r | |
211 | \r | |
212 | --*/\r | |
213 | ;\r | |
214 | \r | |
215 | EFI_STATUS\r | |
216 | PcRtcSetWakeupTime (\r | |
217 | IN BOOLEAN Enable,\r | |
218 | OUT EFI_TIME *Time,\r | |
219 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
220 | )\r | |
221 | /*++\r | |
222 | \r | |
223 | Routine Description:\r | |
224 | \r | |
225 | GC_TODO: Add function description\r | |
226 | \r | |
227 | Arguments:\r | |
228 | \r | |
229 | Enable - GC_TODO: add argument description\r | |
230 | Time - GC_TODO: add argument description\r | |
231 | Global - GC_TODO: add argument description\r | |
232 | \r | |
233 | Returns:\r | |
234 | \r | |
235 | GC_TODO: add return values\r | |
236 | \r | |
237 | --*/\r | |
238 | ;\r | |
239 | \r | |
240 | EFI_STATUS\r | |
241 | PcRtcGetWakeupTime (\r | |
242 | OUT BOOLEAN *Enabled,\r | |
243 | OUT BOOLEAN *Pending,\r | |
244 | OUT EFI_TIME *Time,\r | |
245 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
246 | )\r | |
247 | /*++\r | |
248 | \r | |
249 | Routine Description:\r | |
250 | \r | |
251 | GC_TODO: Add function description\r | |
252 | \r | |
253 | Arguments:\r | |
254 | \r | |
255 | Enabled - GC_TODO: add argument description\r | |
256 | Pending - GC_TODO: add argument description\r | |
257 | Time - GC_TODO: add argument description\r | |
258 | Global - GC_TODO: add argument description\r | |
259 | \r | |
260 | Returns:\r | |
261 | \r | |
262 | GC_TODO: add return values\r | |
263 | \r | |
264 | --*/\r | |
265 | ;\r | |
266 | \r | |
267 | EFI_STATUS\r | |
268 | EFIAPI\r | |
269 | InitializePcRtc (\r | |
270 | IN EFI_HANDLE ImageHandle,\r | |
271 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
272 | )\r | |
273 | /*++\r | |
274 | \r | |
275 | Routine Description:\r | |
276 | \r | |
277 | GC_TODO: Add function description\r | |
278 | \r | |
279 | Arguments:\r | |
280 | \r | |
281 | ImageHandle - GC_TODO: add argument description\r | |
282 | SystemTable - GC_TODO: add argument description\r | |
283 | \r | |
284 | Returns:\r | |
285 | \r | |
286 | GC_TODO: add return values\r | |
287 | \r | |
288 | --*/\r | |
289 | ;\r | |
290 | \r | |
291 | UINT8\r | |
292 | BcdToDecimal (\r | |
293 | IN UINT8 BcdValue\r | |
294 | )\r | |
295 | /*++\r | |
296 | \r | |
297 | Routine Description:\r | |
298 | \r | |
299 | GC_TODO: Add function description\r | |
300 | \r | |
301 | Arguments:\r | |
302 | \r | |
303 | BcdValue - GC_TODO: add argument description\r | |
304 | \r | |
305 | Returns:\r | |
306 | \r | |
307 | GC_TODO: add return values\r | |
308 | \r | |
309 | --*/\r | |
310 | ;\r | |
311 | \r | |
312 | EFI_STATUS\r | |
313 | RtcTimeFieldsValid (\r | |
314 | IN EFI_TIME *Time\r | |
315 | )\r | |
316 | /*++\r | |
317 | \r | |
318 | Routine Description:\r | |
319 | \r | |
320 | GC_TODO: Add function description\r | |
321 | \r | |
322 | Arguments:\r | |
323 | \r | |
324 | Time - GC_TODO: add argument description\r | |
325 | \r | |
326 | Returns:\r | |
327 | \r | |
328 | GC_TODO: add return values\r | |
329 | \r | |
330 | --*/\r | |
331 | ;\r | |
332 | \r | |
333 | UINT8\r | |
334 | DecimaltoBcd (\r | |
335 | IN UINT8 DecValue\r | |
336 | )\r | |
337 | /*++\r | |
338 | \r | |
339 | Routine Description:\r | |
340 | \r | |
341 | GC_TODO: Add function description\r | |
342 | \r | |
343 | Arguments:\r | |
344 | \r | |
345 | DecValue - GC_TODO: add argument description\r | |
346 | \r | |
347 | Returns:\r | |
348 | \r | |
349 | GC_TODO: add return values\r | |
350 | \r | |
351 | --*/\r | |
352 | ;\r | |
353 | \r | |
354 | VOID\r | |
355 | ConvertEfiTimeToRtcTime (\r | |
356 | IN EFI_TIME *Time,\r | |
357 | IN RTC_REGISTER_B RegisterB,\r | |
358 | IN UINT8 *Century\r | |
359 | )\r | |
360 | /*++\r | |
361 | \r | |
362 | Routine Description:\r | |
363 | \r | |
364 | GC_TODO: Add function description\r | |
365 | \r | |
366 | Arguments:\r | |
367 | \r | |
368 | Time - GC_TODO: add argument description\r | |
369 | RegisterB - GC_TODO: add argument description\r | |
370 | Century - GC_TODO: add argument description\r | |
371 | \r | |
372 | Returns:\r | |
373 | \r | |
374 | GC_TODO: add return values\r | |
375 | \r | |
376 | --*/\r | |
377 | ;\r | |
378 | \r | |
379 | EFI_STATUS\r | |
380 | RtcTestCenturyRegister (\r | |
381 | VOID\r | |
382 | )\r | |
383 | /*++\r | |
384 | \r | |
385 | Routine Description:\r | |
386 | \r | |
387 | GC_TODO: Add function description\r | |
388 | \r | |
389 | Arguments:\r | |
390 | \r | |
391 | None\r | |
392 | \r | |
393 | Returns:\r | |
394 | \r | |
395 | GC_TODO: add return values\r | |
396 | \r | |
397 | --*/\r | |
398 | ;\r | |
399 | \r | |
400 | VOID\r | |
401 | ConvertRtcTimeToEfiTime (\r | |
402 | IN EFI_TIME *Time,\r | |
403 | IN RTC_REGISTER_B RegisterB\r | |
404 | )\r | |
405 | /*++\r | |
406 | \r | |
407 | Routine Description:\r | |
408 | \r | |
409 | GC_TODO: Add function description\r | |
410 | \r | |
411 | Arguments:\r | |
412 | \r | |
413 | Time - GC_TODO: add argument description\r | |
414 | RegisterB - GC_TODO: add argument description\r | |
415 | \r | |
416 | Returns:\r | |
417 | \r | |
418 | GC_TODO: add return values\r | |
419 | \r | |
420 | --*/\r | |
421 | ;\r | |
422 | \r | |
423 | EFI_STATUS\r | |
424 | RtcWaitToUpdate (\r | |
425 | UINTN Timeout\r | |
426 | )\r | |
427 | /*++\r | |
428 | \r | |
429 | Routine Description:\r | |
430 | \r | |
431 | GC_TODO: Add function description\r | |
432 | \r | |
433 | Arguments:\r | |
434 | \r | |
435 | Timeout - GC_TODO: add argument description\r | |
436 | \r | |
437 | Returns:\r | |
438 | \r | |
439 | GC_TODO: add return values\r | |
440 | \r | |
441 | --*/\r | |
442 | ;\r | |
443 | \r | |
444 | UINT8\r | |
445 | RtcSaveContext (\r | |
446 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
447 | )\r | |
448 | /*++\r | |
449 | \r | |
450 | Routine Description:\r | |
451 | \r | |
452 | GC_TODO: Add function description\r | |
453 | \r | |
454 | Arguments:\r | |
455 | \r | |
456 | Global - GC_TODO: add argument description\r | |
457 | \r | |
458 | Returns:\r | |
459 | \r | |
460 | GC_TODO: add return values\r | |
461 | \r | |
462 | --*/\r | |
463 | ;\r | |
464 | \r | |
465 | VOID\r | |
466 | RtcRestoreContext (\r | |
467 | IN UINT8 SavedAddressRegister,\r | |
468 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
469 | )\r | |
470 | /*++\r | |
471 | \r | |
472 | Routine Description:\r | |
473 | \r | |
474 | GC_TODO: Add function description\r | |
475 | \r | |
476 | Arguments:\r | |
477 | \r | |
478 | SavedAddressRegister - GC_TODO: add argument description\r | |
479 | Global - GC_TODO: add argument description\r | |
480 | \r | |
481 | Returns:\r | |
482 | \r | |
483 | GC_TODO: add return values\r | |
484 | \r | |
485 | --*/\r | |
486 | ;\r | |
487 | \r | |
488 | BOOLEAN\r | |
489 | DayValid (\r | |
490 | IN EFI_TIME *Time\r | |
491 | );\r | |
492 | \r | |
493 | BOOLEAN\r | |
494 | IsLeapYear (\r | |
495 | IN EFI_TIME *Time\r | |
496 | );\r | |
497 | \r | |
498 | #endif\r |