]>
Commit | Line | Data |
---|---|---|
fb0b259e | 1 | /** @file\r |
2 | RTC Architectural Protocol GUID as defined in DxeCis 0.96.\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 |
15 | #include "PcRtc.h"\r | |
16 | \r | |
8d85dc31 | 17 | /**\r |
18 | Compare the Hour, Minute and Second of the From time and the To time.\r | |
19 | \r | |
20 | Only compare H/M/S in EFI_TIME and ignore other fields here.\r | |
21 | \r | |
22 | @param From the first time\r | |
23 | @param To the second time\r | |
24 | \r | |
25 | @return >0 The H/M/S of the From time is later than those of To time\r | |
26 | @return ==0 The H/M/S of the From time is same as those of To time\r | |
27 | @return <0 The H/M/S of the From time is earlier than those of To time\r | |
28 | **/\r | |
8cd4d17c | 29 | INTN\r |
30 | CompareHMS (\r | |
31 | IN EFI_TIME *From,\r | |
32 | IN EFI_TIME *To\r | |
33 | );\r | |
34 | \r | |
8d85dc31 | 35 | /**\r |
36 | To check if second date is later than first date within 24 hours.\r | |
37 | \r | |
38 | @param From the first date\r | |
39 | @param To the second date\r | |
40 | \r | |
41 | @retval TRUE From is previous to To within 24 hours.\r | |
42 | @retval FALSE From is later, or it is previous to To more than 24 hours.\r | |
43 | **/\r | |
8cd4d17c | 44 | BOOLEAN\r |
45 | IsWithinOneDay (\r | |
46 | IN EFI_TIME *From,\r | |
47 | IN EFI_TIME *To\r | |
48 | );\r | |
49 | \r | |
8d85dc31 | 50 | /**\r |
51 | Read RTC content through its registers.\r | |
52 | \r | |
53 | @param Address Address offset of RTC. It is recommended to use macros such as\r | |
54 | RTC_ADDRESS_SECONDS.\r | |
55 | \r | |
56 | @return The data of UINT8 type read from RTC.\r | |
57 | **/\r | |
8cd4d17c | 58 | UINT8\r |
59 | RtcRead (\r | |
60 | IN UINT8 Address\r | |
61 | )\r | |
8cd4d17c | 62 | {\r |
63 | IoWrite8 (PCAT_RTC_ADDRESS_REGISTER, (UINT8) (Address | (UINT8) (IoRead8 (PCAT_RTC_ADDRESS_REGISTER) & 0x80)));\r | |
64 | return IoRead8 (PCAT_RTC_DATA_REGISTER);\r | |
65 | }\r | |
66 | \r | |
8d85dc31 | 67 | /**\r |
68 | Write RTC through its registers.\r | |
69 | \r | |
70 | @param Address Address offset of RTC. It is recommended to use macros such as\r | |
71 | RTC_ADDRESS_SECONDS.\r | |
72 | @param Data The content you want to write into RTC.\r | |
73 | \r | |
74 | **/\r | |
8cd4d17c | 75 | VOID\r |
76 | RtcWrite (\r | |
77 | IN UINT8 Address,\r | |
78 | IN UINT8 Data\r | |
79 | )\r | |
8cd4d17c | 80 | {\r |
81 | IoWrite8 (PCAT_RTC_ADDRESS_REGISTER, (UINT8) (Address | (UINT8) (IoRead8 (PCAT_RTC_ADDRESS_REGISTER) & 0x80)));\r | |
82 | IoWrite8 (PCAT_RTC_DATA_REGISTER, Data);\r | |
83 | }\r | |
84 | \r | |
8d85dc31 | 85 | /**\r |
86 | Initialize RTC.\r | |
87 | \r | |
88 | @param Global For global use inside this module.\r | |
89 | \r | |
90 | @retval EFI_DEVICE_ERROR Initialization failed due to device error.\r | |
91 | @retval EFI_SUCCESS Initialization successful.\r | |
92 | \r | |
93 | **/\r | |
8cd4d17c | 94 | EFI_STATUS\r |
95 | PcRtcInit (\r | |
96 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
97 | )\r | |
8cd4d17c | 98 | {\r |
99 | EFI_STATUS Status;\r | |
100 | RTC_REGISTER_A RegisterA;\r | |
101 | RTC_REGISTER_B RegisterB;\r | |
102 | RTC_REGISTER_D RegisterD;\r | |
103 | UINT8 Century;\r | |
104 | EFI_TIME Time;\r | |
ec35e997 LG |
105 | UINTN DataSize;\r |
106 | UINT32 TimerVar;\r | |
8cd4d17c | 107 | \r |
108 | //\r | |
109 | // Acquire RTC Lock to make access to RTC atomic\r | |
110 | //\r | |
111 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
112 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
113 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 114 | EfiAcquireLock (&Global->RtcLock);\r |
8cd4d17c | 115 | }\r |
116 | //\r | |
117 | // Initialize RTC Register\r | |
118 | //\r | |
119 | // Make sure Division Chain is properly configured,\r | |
120 | // or RTC clock won't "tick" -- time won't increment\r | |
121 | //\r | |
122 | RegisterA.Data = RTC_INIT_REGISTER_A;\r | |
123 | RtcWrite (RTC_ADDRESS_REGISTER_A, RegisterA.Data);\r | |
124 | \r | |
125 | //\r | |
126 | // Read Register B\r | |
127 | //\r | |
128 | RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r | |
129 | \r | |
130 | //\r | |
131 | // Clear RTC flag register\r | |
132 | //\r | |
133 | RtcRead (RTC_ADDRESS_REGISTER_C);\r | |
134 | \r | |
135 | //\r | |
136 | // Clear RTC register D\r | |
137 | //\r | |
138 | RegisterD.Data = RTC_INIT_REGISTER_D;\r | |
139 | RtcWrite (RTC_ADDRESS_REGISTER_D, RegisterD.Data);\r | |
140 | \r | |
141 | //\r | |
142 | // Wait for up to 0.1 seconds for the RTC to be updated\r | |
143 | //\r | |
f8ea3026 | 144 | Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r |
8cd4d17c | 145 | if (EFI_ERROR (Status)) {\r |
146 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
147 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
148 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 149 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 150 | }\r |
151 | return EFI_DEVICE_ERROR;\r | |
152 | }\r | |
153 | //\r | |
154 | // Get the Time/Date/Daylight Savings values.\r | |
155 | //\r | |
156 | Time.Second = RtcRead (RTC_ADDRESS_SECONDS);\r | |
157 | Time.Minute = RtcRead (RTC_ADDRESS_MINUTES);\r | |
158 | Time.Hour = RtcRead (RTC_ADDRESS_HOURS);\r | |
159 | Time.Day = RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH);\r | |
160 | Time.Month = RtcRead (RTC_ADDRESS_MONTH);\r | |
161 | Time.Year = RtcRead (RTC_ADDRESS_YEAR);\r | |
162 | \r | |
8cd4d17c | 163 | if (RtcTestCenturyRegister () == EFI_SUCCESS) {\r |
254ba247 | 164 | Century = (UINT8) (RtcRead (RTC_ADDRESS_CENTURY) & 0x7f);\r |
8cd4d17c | 165 | } else {\r |
254ba247 | 166 | Century = RtcRead (RTC_ADDRESS_CENTURY);\r |
8cd4d17c | 167 | }\r |
168 | \r | |
8cd4d17c | 169 | //\r |
170 | // Set RTC configuration after get original time\r | |
ec35e997 | 171 | // The value of bit AIE should be reserved.\r |
8cd4d17c | 172 | //\r |
f7033880 | 173 | RtcWrite (RTC_ADDRESS_REGISTER_B, (UINT8)(RTC_INIT_REGISTER_B | (RegisterB.Data & BIT5)));\r |
8cd4d17c | 174 | \r |
175 | //\r | |
176 | // Release RTC Lock.\r | |
177 | //\r | |
178 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
179 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
254ba247 | 180 | //\r |
8cd4d17c | 181 | if (!EfiAtRuntime ()) {\r |
8d85dc31 | 182 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 183 | }\r |
254ba247 | 184 | \r |
8cd4d17c | 185 | //\r |
186 | // Validate time fields\r | |
187 | //\r | |
254ba247 | 188 | Status = ConvertRtcTimeToEfiTime (&Time, Century, RegisterB);\r |
189 | if (!EFI_ERROR (Status)) {\r | |
190 | Status = RtcTimeFieldsValid (&Time);\r | |
191 | }\r | |
8cd4d17c | 192 | if (EFI_ERROR (Status)) {\r |
193 | Time.Second = RTC_INIT_SECOND;\r | |
194 | Time.Minute = RTC_INIT_MINUTE;\r | |
195 | Time.Hour = RTC_INIT_HOUR;\r | |
196 | Time.Day = RTC_INIT_DAY;\r | |
197 | Time.Month = RTC_INIT_MONTH;\r | |
198 | Time.Year = RTC_INIT_YEAR;\r | |
199 | }\r | |
200 | //\r | |
ec35e997 LG |
201 | // Get the data of Daylight saving and time zone, if they have been\r |
202 | // stored in NV variable during previous boot.\r | |
203 | //\r | |
204 | DataSize = sizeof (UINT32);\r | |
205 | Status = EfiGetVariable (\r | |
206 | L"TimerVar",\r | |
207 | &gEfiGenericPlatformVariableGuid,\r | |
208 | NULL,\r | |
209 | &DataSize,\r | |
210 | (VOID *) &TimerVar\r | |
211 | );\r | |
212 | if (!EFI_ERROR (Status)) {\r | |
213 | Global->SavedTimeZone = (INT16) TimerVar;\r | |
214 | Global->Daylight = (UINT8) (TimerVar >> 16);\r | |
215 | \r | |
216 | Time.TimeZone = Global->SavedTimeZone;\r | |
217 | Time.Daylight = Global->Daylight;\r | |
218 | }\r | |
219 | //\r | |
8cd4d17c | 220 | // Reset time value according to new RTC configuration\r |
221 | //\r | |
222 | PcRtcSetTime (&Time, Global);\r | |
223 | \r | |
224 | return EFI_SUCCESS;\r | |
225 | }\r | |
226 | \r | |
8d85dc31 | 227 | /**\r |
228 | Returns the current time and date information, and the time-keeping capabilities\r | |
229 | of the hardware platform.\r | |
8cd4d17c | 230 | \r |
8d85dc31 | 231 | @param Time A pointer to storage to receive a snapshot of the current time.\r |
232 | @param Capabilities An optional pointer to a buffer to receive the real time clock\r | |
233 | device's capabilities.\r | |
234 | @param Global For global use inside this module.\r | |
8cd4d17c | 235 | \r |
8d85dc31 | 236 | @retval EFI_SUCCESS The operation completed successfully.\r |
237 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
238 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r | |
8cd4d17c | 239 | \r |
8d85dc31 | 240 | **/\r |
241 | EFI_STATUS\r | |
242 | PcRtcGetTime (\r | |
243 | OUT EFI_TIME *Time,\r | |
244 | OUT EFI_TIME_CAPABILITIES *Capabilities, OPTIONAL\r | |
245 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
246 | )\r | |
8cd4d17c | 247 | {\r |
248 | EFI_STATUS Status;\r | |
249 | RTC_REGISTER_B RegisterB;\r | |
250 | UINT8 Century;\r | |
251 | \r | |
252 | //\r | |
253 | // Check parameters for null pointer\r | |
254 | //\r | |
255 | if (Time == NULL) {\r | |
256 | return EFI_INVALID_PARAMETER;\r | |
257 | \r | |
258 | }\r | |
259 | //\r | |
260 | // Acquire RTC Lock to make access to RTC atomic\r | |
261 | //\r | |
262 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
263 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
264 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 265 | EfiAcquireLock (&Global->RtcLock);\r |
8cd4d17c | 266 | }\r |
267 | //\r | |
268 | // Wait for up to 0.1 seconds for the RTC to be updated\r | |
269 | //\r | |
f8ea3026 | 270 | Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r |
8cd4d17c | 271 | if (EFI_ERROR (Status)) {\r |
272 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
273 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
274 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 275 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 276 | }\r |
277 | return Status;\r | |
278 | }\r | |
279 | //\r | |
280 | // Read Register B\r | |
281 | //\r | |
282 | RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r | |
283 | \r | |
284 | //\r | |
285 | // Get the Time/Date/Daylight Savings values.\r | |
286 | //\r | |
287 | Time->Second = RtcRead (RTC_ADDRESS_SECONDS);\r | |
288 | Time->Minute = RtcRead (RTC_ADDRESS_MINUTES);\r | |
289 | Time->Hour = RtcRead (RTC_ADDRESS_HOURS);\r | |
290 | Time->Day = RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH);\r | |
291 | Time->Month = RtcRead (RTC_ADDRESS_MONTH);\r | |
292 | Time->Year = RtcRead (RTC_ADDRESS_YEAR);\r | |
293 | \r | |
8cd4d17c | 294 | if (RtcTestCenturyRegister () == EFI_SUCCESS) {\r |
254ba247 | 295 | Century = (UINT8) (RtcRead (RTC_ADDRESS_CENTURY) & 0x7f);\r |
8cd4d17c | 296 | } else {\r |
254ba247 | 297 | Century = RtcRead (RTC_ADDRESS_CENTURY);\r |
8cd4d17c | 298 | }\r |
299 | \r | |
8cd4d17c | 300 | //\r |
301 | // Release RTC Lock.\r | |
302 | //\r | |
303 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
304 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
305 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 306 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 307 | }\r |
308 | //\r | |
309 | // Get the variable that containts the TimeZone and Daylight fields\r | |
310 | //\r | |
311 | Time->TimeZone = Global->SavedTimeZone;\r | |
312 | Time->Daylight = Global->Daylight;\r | |
313 | \r | |
314 | //\r | |
315 | // Make sure all field values are in correct range\r | |
316 | //\r | |
254ba247 | 317 | Status = ConvertRtcTimeToEfiTime (Time, Century, RegisterB);\r |
318 | if (!EFI_ERROR (Status)) {\r | |
319 | Status = RtcTimeFieldsValid (Time);\r | |
320 | }\r | |
8cd4d17c | 321 | if (EFI_ERROR (Status)) {\r |
322 | return EFI_DEVICE_ERROR;\r | |
323 | }\r | |
324 | //\r | |
325 | // Fill in Capabilities if it was passed in\r | |
326 | //\r | |
8d85dc31 | 327 | if (Capabilities != NULL) {\r |
8cd4d17c | 328 | Capabilities->Resolution = 1;\r |
329 | //\r | |
330 | // 1 hertz\r | |
331 | //\r | |
332 | Capabilities->Accuracy = 50000000;\r | |
333 | //\r | |
334 | // 50 ppm\r | |
335 | //\r | |
336 | Capabilities->SetsToZero = FALSE;\r | |
337 | }\r | |
338 | \r | |
339 | return EFI_SUCCESS;\r | |
340 | }\r | |
341 | \r | |
8d85dc31 | 342 | /**\r |
343 | Sets the current local time and date information.\r | |
344 | \r | |
345 | @param Time A pointer to the current time.\r | |
346 | @param Global For global use inside this module.\r | |
347 | \r | |
348 | @retval EFI_SUCCESS The operation completed successfully.\r | |
349 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
350 | @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r | |
351 | \r | |
352 | **/\r | |
8cd4d17c | 353 | EFI_STATUS\r |
354 | PcRtcSetTime (\r | |
355 | IN EFI_TIME *Time,\r | |
356 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
357 | )\r | |
8cd4d17c | 358 | {\r |
359 | EFI_STATUS Status;\r | |
360 | EFI_TIME RtcTime;\r | |
361 | RTC_REGISTER_B RegisterB;\r | |
362 | UINT8 Century;\r | |
ec35e997 | 363 | UINT32 TimerVar;\r |
8cd4d17c | 364 | \r |
365 | if (Time == NULL) {\r | |
366 | return EFI_INVALID_PARAMETER;\r | |
367 | }\r | |
368 | //\r | |
369 | // Make sure that the time fields are valid\r | |
370 | //\r | |
371 | Status = RtcTimeFieldsValid (Time);\r | |
372 | if (EFI_ERROR (Status)) {\r | |
373 | return Status;\r | |
374 | }\r | |
375 | \r | |
376 | CopyMem (&RtcTime, Time, sizeof (EFI_TIME));\r | |
377 | \r | |
378 | //\r | |
379 | // Acquire RTC Lock to make access to RTC atomic\r | |
380 | //\r | |
381 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
382 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
383 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 384 | EfiAcquireLock (&Global->RtcLock);\r |
8cd4d17c | 385 | }\r |
386 | //\r | |
387 | // Wait for up to 0.1 seconds for the RTC to be updated\r | |
388 | //\r | |
f8ea3026 | 389 | Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r |
8cd4d17c | 390 | if (EFI_ERROR (Status)) {\r |
391 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
392 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
393 | if (!EfiAtRuntime ()) {\r | |
394 | EfiReleaseLock (&Global->RtcLock);\r | |
395 | }\r | |
396 | return Status;\r | |
397 | }\r | |
398 | //\r | |
399 | // Read Register B, and inhibit updates of the RTC\r | |
400 | //\r | |
401 | RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r | |
402 | RegisterB.Bits.SET = 1;\r | |
403 | RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r | |
404 | \r | |
405 | ConvertEfiTimeToRtcTime (&RtcTime, RegisterB, &Century);\r | |
406 | \r | |
407 | RtcWrite (RTC_ADDRESS_SECONDS, RtcTime.Second);\r | |
408 | RtcWrite (RTC_ADDRESS_MINUTES, RtcTime.Minute);\r | |
409 | RtcWrite (RTC_ADDRESS_HOURS, RtcTime.Hour);\r | |
410 | RtcWrite (RTC_ADDRESS_DAY_OF_THE_MONTH, RtcTime.Day);\r | |
411 | RtcWrite (RTC_ADDRESS_MONTH, RtcTime.Month);\r | |
412 | RtcWrite (RTC_ADDRESS_YEAR, (UINT8) RtcTime.Year);\r | |
413 | if (RtcTestCenturyRegister () == EFI_SUCCESS) {\r | |
414 | Century = (UINT8) ((Century & 0x7f) | (RtcRead (RTC_ADDRESS_CENTURY) & 0x80));\r | |
415 | }\r | |
416 | \r | |
417 | RtcWrite (RTC_ADDRESS_CENTURY, Century);\r | |
418 | \r | |
419 | //\r | |
420 | // Allow updates of the RTC registers\r | |
421 | //\r | |
422 | RegisterB.Bits.SET = 0;\r | |
423 | RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r | |
424 | \r | |
425 | //\r | |
426 | // Release RTC Lock.\r | |
427 | //\r | |
428 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
429 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
430 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 431 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 432 | }\r |
433 | //\r | |
434 | // Set the variable that containts the TimeZone and Daylight fields\r | |
435 | //\r | |
436 | Global->SavedTimeZone = Time->TimeZone;\r | |
437 | Global->Daylight = Time->Daylight;\r | |
ec35e997 LG |
438 | \r |
439 | TimerVar = Time->Daylight;\r | |
440 | TimerVar = (UINT32) ((TimerVar << 16) | Time->TimeZone);\r | |
441 | Status = EfiSetVariable (\r | |
442 | L"TimerVar",\r | |
443 | &gEfiGenericPlatformVariableGuid,\r | |
444 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
445 | sizeof (TimerVar),\r | |
446 | &TimerVar\r | |
447 | );\r | |
448 | ASSERT_EFI_ERROR (Status);\r | |
449 | \r | |
450 | return EFI_SUCCESS;\r | |
8cd4d17c | 451 | }\r |
452 | \r | |
8d85dc31 | 453 | /**\r |
454 | Returns the current wakeup alarm clock setting.\r | |
455 | \r | |
456 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r | |
457 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
458 | @param Time The current alarm setting.\r | |
459 | @param Global For global use inside this module.\r | |
460 | \r | |
461 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
462 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r | |
463 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
464 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
465 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r | |
466 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
467 | \r | |
468 | **/\r | |
8cd4d17c | 469 | EFI_STATUS\r |
470 | PcRtcGetWakeupTime (\r | |
471 | OUT BOOLEAN *Enabled,\r | |
472 | OUT BOOLEAN *Pending,\r | |
473 | OUT EFI_TIME *Time,\r | |
8d85dc31 | 474 | IN PC_RTC_MODULE_GLOBALS *Global\r |
8cd4d17c | 475 | )\r |
8cd4d17c | 476 | {\r |
477 | EFI_STATUS Status;\r | |
478 | RTC_REGISTER_B RegisterB;\r | |
479 | RTC_REGISTER_C RegisterC;\r | |
480 | UINT8 Century;\r | |
481 | \r | |
482 | //\r | |
483 | // Check paramters for null pointers\r | |
484 | //\r | |
485 | if ((Enabled == NULL) || (Pending == NULL) || (Time == NULL)) {\r | |
486 | return EFI_INVALID_PARAMETER;\r | |
487 | \r | |
488 | }\r | |
489 | //\r | |
490 | // Acquire RTC Lock to make access to RTC atomic\r | |
491 | //\r | |
492 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
493 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
494 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 495 | EfiAcquireLock (&Global->RtcLock);\r |
8cd4d17c | 496 | }\r |
497 | //\r | |
498 | // Wait for up to 0.1 seconds for the RTC to be updated\r | |
499 | //\r | |
f8ea3026 | 500 | Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r |
8cd4d17c | 501 | if (EFI_ERROR (Status)) {\r |
502 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
503 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
504 | if (!EfiAtRuntime ()) {\r | |
505 | EfiReleaseLock (&Global->RtcLock);\r | |
506 | }\r | |
507 | return EFI_DEVICE_ERROR;\r | |
508 | }\r | |
509 | //\r | |
510 | // Read Register B and Register C\r | |
511 | //\r | |
512 | RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r | |
513 | RegisterC.Data = RtcRead (RTC_ADDRESS_REGISTER_C);\r | |
514 | \r | |
515 | //\r | |
516 | // Get the Time/Date/Daylight Savings values.\r | |
517 | //\r | |
518 | *Enabled = RegisterB.Bits.AIE;\r | |
519 | if (*Enabled) {\r | |
520 | Time->Second = RtcRead (RTC_ADDRESS_SECONDS_ALARM);\r | |
521 | Time->Minute = RtcRead (RTC_ADDRESS_MINUTES_ALARM);\r | |
522 | Time->Hour = RtcRead (RTC_ADDRESS_HOURS_ALARM);\r | |
523 | Time->Day = RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH);\r | |
524 | Time->Month = RtcRead (RTC_ADDRESS_MONTH);\r | |
525 | Time->Year = RtcRead (RTC_ADDRESS_YEAR);\r | |
526 | } else {\r | |
527 | Time->Second = 0;\r | |
528 | Time->Minute = 0;\r | |
529 | Time->Hour = 0;\r | |
530 | Time->Day = RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH);\r | |
531 | Time->Month = RtcRead (RTC_ADDRESS_MONTH);\r | |
532 | Time->Year = RtcRead (RTC_ADDRESS_YEAR);\r | |
533 | }\r | |
534 | \r | |
8cd4d17c | 535 | if (RtcTestCenturyRegister () == EFI_SUCCESS) {\r |
254ba247 | 536 | Century = (UINT8) (RtcRead (RTC_ADDRESS_CENTURY) & 0x7f);\r |
8cd4d17c | 537 | } else {\r |
254ba247 | 538 | Century = RtcRead (RTC_ADDRESS_CENTURY);\r |
8cd4d17c | 539 | }\r |
540 | \r | |
8cd4d17c | 541 | //\r |
542 | // Release RTC Lock.\r | |
543 | //\r | |
544 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
545 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
546 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 547 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 548 | }\r |
549 | //\r | |
550 | // Make sure all field values are in correct range\r | |
551 | //\r | |
254ba247 | 552 | Status = ConvertRtcTimeToEfiTime (Time, Century, RegisterB);\r |
553 | if (!EFI_ERROR (Status)) {\r | |
554 | Status = RtcTimeFieldsValid (Time);\r | |
555 | }\r | |
8cd4d17c | 556 | if (EFI_ERROR (Status)) {\r |
557 | return EFI_DEVICE_ERROR;\r | |
558 | }\r | |
559 | \r | |
560 | *Pending = RegisterC.Bits.AF;\r | |
561 | \r | |
562 | return EFI_SUCCESS;\r | |
563 | }\r | |
564 | \r | |
8d85dc31 | 565 | /**\r |
566 | Sets the system wakeup alarm clock time.\r | |
567 | \r | |
568 | @param Enabled Enable or disable the wakeup alarm.\r | |
569 | @param Time If Enable is TRUE, the time to set the wakeup alarm for.\r | |
570 | If Enable is FALSE, then this parameter is optional, and may be NULL.\r | |
571 | @param Global For global use inside this module.\r | |
572 | \r | |
573 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r | |
574 | If Enable is FALSE, then the wakeup alarm was disabled.\r | |
575 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
576 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
577 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
578 | \r | |
579 | **/\r | |
8cd4d17c | 580 | EFI_STATUS\r |
581 | PcRtcSetWakeupTime (\r | |
582 | IN BOOLEAN Enable,\r | |
8d85dc31 | 583 | IN EFI_TIME *Time, OPTIONAL\r |
8cd4d17c | 584 | IN PC_RTC_MODULE_GLOBALS *Global\r |
585 | )\r | |
8cd4d17c | 586 | {\r |
587 | EFI_STATUS Status;\r | |
588 | EFI_TIME RtcTime;\r | |
589 | RTC_REGISTER_B RegisterB;\r | |
590 | UINT8 Century;\r | |
591 | EFI_TIME_CAPABILITIES Capabilities;\r | |
592 | \r | |
593 | if (Enable) {\r | |
594 | \r | |
595 | if (Time == NULL) {\r | |
596 | return EFI_INVALID_PARAMETER;\r | |
597 | }\r | |
598 | //\r | |
599 | // Make sure that the time fields are valid\r | |
600 | //\r | |
601 | Status = RtcTimeFieldsValid (Time);\r | |
602 | if (EFI_ERROR (Status)) {\r | |
603 | return EFI_INVALID_PARAMETER;\r | |
604 | }\r | |
605 | //\r | |
606 | // Just support set alarm time within 24 hours\r | |
607 | //\r | |
608 | PcRtcGetTime (&RtcTime, &Capabilities, Global);\r | |
609 | if (!IsWithinOneDay (&RtcTime, Time)) {\r | |
610 | return EFI_UNSUPPORTED;\r | |
611 | }\r | |
612 | //\r | |
613 | // Make a local copy of the time and date\r | |
614 | //\r | |
615 | CopyMem (&RtcTime, Time, sizeof (EFI_TIME));\r | |
616 | \r | |
617 | }\r | |
618 | //\r | |
619 | // Acquire RTC Lock to make access to RTC atomic\r | |
620 | //\r | |
621 | //BugBug: the EfiAtRuntime should be encapsulated in EfiAcquireLock or\r | |
622 | // provide a new instance for EfiAcquireLock, say, RtEfiAcquireLock\r | |
623 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 624 | EfiAcquireLock (&Global->RtcLock);\r |
8cd4d17c | 625 | }\r |
626 | //\r | |
627 | // Wait for up to 0.1 seconds for the RTC to be updated\r | |
628 | //\r | |
f8ea3026 | 629 | Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r |
8cd4d17c | 630 | if (EFI_ERROR (Status)) {\r |
631 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
632 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
633 | if (!EfiAtRuntime ()) {\r | |
634 | EfiReleaseLock (&Global->RtcLock);\r | |
635 | }\r | |
636 | return EFI_DEVICE_ERROR;\r | |
637 | }\r | |
638 | //\r | |
639 | // Read Register B, and inhibit updates of the RTC\r | |
640 | //\r | |
641 | RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r | |
642 | \r | |
643 | RegisterB.Bits.SET = 1;\r | |
644 | RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r | |
645 | \r | |
646 | if (Enable) {\r | |
647 | ConvertEfiTimeToRtcTime (&RtcTime, RegisterB, &Century);\r | |
648 | \r | |
649 | //\r | |
650 | // Set RTC alarm time\r | |
651 | //\r | |
652 | RtcWrite (RTC_ADDRESS_SECONDS_ALARM, RtcTime.Second);\r | |
653 | RtcWrite (RTC_ADDRESS_MINUTES_ALARM, RtcTime.Minute);\r | |
654 | RtcWrite (RTC_ADDRESS_HOURS_ALARM, RtcTime.Hour);\r | |
655 | \r | |
656 | RegisterB.Bits.AIE = 1;\r | |
657 | \r | |
658 | } else {\r | |
659 | RegisterB.Bits.AIE = 0;\r | |
660 | }\r | |
661 | //\r | |
662 | // Allow updates of the RTC registers\r | |
663 | //\r | |
664 | RegisterB.Bits.SET = 0;\r | |
665 | RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r | |
666 | \r | |
667 | //\r | |
668 | // Release RTC Lock.\r | |
669 | //\r | |
670 | //BugBug: the EfiAtRuntime should be encapsulated in EfiReleaseLock or\r | |
671 | // provide a new instance for EfiReleaseLock, say, RtEfiReleaseLock\r | |
672 | if (!EfiAtRuntime ()) {\r | |
8d85dc31 | 673 | EfiReleaseLock (&Global->RtcLock);\r |
8cd4d17c | 674 | }\r |
675 | return EFI_SUCCESS;\r | |
676 | }\r | |
677 | \r | |
8d85dc31 | 678 | /**\r |
679 | See if centry register of RTC is valid.\r | |
680 | \r | |
681 | @retval EFI_SUCCESS Century register is valid.\r | |
682 | @retval EFI_DEVICE_ERROR Century register is NOT valid.\r | |
683 | **/\r | |
8cd4d17c | 684 | EFI_STATUS\r |
685 | RtcTestCenturyRegister (\r | |
686 | VOID\r | |
687 | )\r | |
8cd4d17c | 688 | {\r |
689 | UINT8 Century;\r | |
690 | UINT8 Temp;\r | |
691 | \r | |
692 | Century = RtcRead (RTC_ADDRESS_CENTURY);\r | |
8cd4d17c | 693 | Temp = (UINT8) (RtcRead (RTC_ADDRESS_CENTURY) & 0x7f);\r |
694 | RtcWrite (RTC_ADDRESS_CENTURY, Century);\r | |
695 | if (Temp == 0x19 || Temp == 0x20) {\r | |
696 | return EFI_SUCCESS;\r | |
697 | }\r | |
698 | \r | |
699 | return EFI_DEVICE_ERROR;\r | |
700 | }\r | |
701 | \r | |
254ba247 | 702 | /**\r |
703 | Checks an 8-bit BCD value, and converts to an 8-bit value if valid.\r | |
704 | \r | |
705 | This function checks the 8-bit BCD value specified by Value.\r | |
706 | If valid, the function converts it to an 8-bit value and returns it.\r | |
707 | Otherwise, return 0xff.\r | |
708 | \r | |
8d85dc31 | 709 | @param Value The 8-bit BCD value to check and convert\r |
254ba247 | 710 | \r |
8d85dc31 | 711 | @return The 8-bit value converted. Or 0xff if Value is invalid.\r |
254ba247 | 712 | \r |
713 | **/\r | |
714 | UINT8\r | |
715 | CheckAndConvertBcd8ToDecimal8 (\r | |
716 | IN UINT8 Value\r | |
8cd4d17c | 717 | )\r |
254ba247 | 718 | {\r |
719 | if ((Value < 0xa0) && ((Value & 0xf) < 0xa)) {\r | |
720 | return BcdToDecimal8 (Value);\r | |
721 | }\r | |
8cd4d17c | 722 | \r |
254ba247 | 723 | return 0xff;\r |
724 | }\r | |
8cd4d17c | 725 | \r |
254ba247 | 726 | /**\r |
727 | Converts time read from RTC to EFI_TIME format defined by UEFI spec.\r | |
8cd4d17c | 728 | \r |
254ba247 | 729 | This function converts raw time data read from RTC to the EFI_TIME format\r |
730 | defined by UEFI spec.\r | |
731 | If data mode of RTC is BCD, then converts it to decimal,\r | |
732 | If RTC is in 12-hour format, then converts it to 24-hour format.\r | |
8cd4d17c | 733 | \r |
254ba247 | 734 | @param Time On input, the time data read from RTC to convert\r |
735 | On output, the time converted to UEFI format\r | |
736 | @param Century Value of century read from RTC.\r | |
737 | @param RegisterB Value of Register B of RTC, indicating data mode\r | |
738 | and hour format.\r | |
8cd4d17c | 739 | \r |
8d85dc31 | 740 | @retval EFI_INVALID_PARAMETER Parameters passed in are invalid.\r |
741 | @retval EFI_SUCCESS Convert RTC time to EFI time successfully.\r | |
742 | \r | |
254ba247 | 743 | **/\r |
744 | EFI_STATUS\r | |
745 | ConvertRtcTimeToEfiTime (\r | |
746 | IN OUT EFI_TIME *Time,\r | |
747 | IN UINT8 Century,\r | |
748 | IN RTC_REGISTER_B RegisterB\r | |
749 | )\r | |
8cd4d17c | 750 | {\r |
8d85dc31 | 751 | BOOLEAN IsPM;\r |
8cd4d17c | 752 | \r |
21176834 | 753 | if ((Time->Hour & 0x80) != 0) {\r |
8d85dc31 | 754 | IsPM = TRUE;\r |
8cd4d17c | 755 | } else {\r |
8d85dc31 | 756 | IsPM = FALSE;\r |
8cd4d17c | 757 | }\r |
758 | \r | |
759 | Time->Hour = (UINT8) (Time->Hour & 0x7f);\r | |
760 | \r | |
761 | if (RegisterB.Bits.DM == 0) {\r | |
254ba247 | 762 | Time->Year = CheckAndConvertBcd8ToDecimal8 ((UINT8) Time->Year);\r |
763 | Time->Month = CheckAndConvertBcd8ToDecimal8 (Time->Month);\r | |
764 | Time->Day = CheckAndConvertBcd8ToDecimal8 (Time->Day);\r | |
765 | Time->Hour = CheckAndConvertBcd8ToDecimal8 (Time->Hour);\r | |
766 | Time->Minute = CheckAndConvertBcd8ToDecimal8 (Time->Minute);\r | |
767 | Time->Second = CheckAndConvertBcd8ToDecimal8 (Time->Second);\r | |
768 | Century = CheckAndConvertBcd8ToDecimal8 (Century);\r | |
769 | }\r | |
770 | \r | |
771 | if (Time->Year == 0xff || Time->Month == 0xff || Time->Day == 0xff ||\r | |
772 | Time->Hour == 0xff || Time->Minute == 0xff || Time->Second == 0xff ||\r | |
773 | Century == 0xff) {\r | |
774 | return EFI_INVALID_PARAMETER;\r | |
8cd4d17c | 775 | }\r |
254ba247 | 776 | \r |
777 | Time->Year = (UINT16) (Century * 100 + Time->Year);\r | |
778 | \r | |
8cd4d17c | 779 | //\r |
780 | // If time is in 12 hour format, convert it to 24 hour format\r | |
781 | //\r | |
782 | if (RegisterB.Bits.MIL == 0) {\r | |
8d85dc31 | 783 | if (IsPM && Time->Hour < 12) {\r |
8cd4d17c | 784 | Time->Hour = (UINT8) (Time->Hour + 12);\r |
785 | }\r | |
786 | \r | |
8d85dc31 | 787 | if (!IsPM && Time->Hour == 12) {\r |
8cd4d17c | 788 | Time->Hour = 0;\r |
789 | }\r | |
790 | }\r | |
791 | \r | |
792 | Time->Nanosecond = 0;\r | |
793 | Time->TimeZone = EFI_UNSPECIFIED_TIMEZONE;\r | |
794 | Time->Daylight = 0;\r | |
254ba247 | 795 | \r |
796 | return EFI_SUCCESS;\r | |
8cd4d17c | 797 | }\r |
798 | \r | |
8d85dc31 | 799 | /**\r |
800 | Wait for a period for the RTC to be ready.\r | |
801 | \r | |
802 | @param Timeout Tell how long it should take to wait.\r | |
803 | \r | |
804 | @retval EFI_DEVICE_ERROR RTC device error.\r | |
805 | @retval EFI_SUCCESS RTC is updated and ready. \r | |
806 | **/\r | |
8cd4d17c | 807 | EFI_STATUS\r |
808 | RtcWaitToUpdate (\r | |
809 | UINTN Timeout\r | |
810 | )\r | |
8cd4d17c | 811 | {\r |
812 | RTC_REGISTER_A RegisterA;\r | |
813 | RTC_REGISTER_D RegisterD;\r | |
814 | \r | |
815 | //\r | |
816 | // See if the RTC is functioning correctly\r | |
817 | //\r | |
818 | RegisterD.Data = RtcRead (RTC_ADDRESS_REGISTER_D);\r | |
819 | \r | |
820 | if (RegisterD.Bits.VRT == 0) {\r | |
821 | return EFI_DEVICE_ERROR;\r | |
822 | }\r | |
823 | //\r | |
824 | // Wait for up to 0.1 seconds for the RTC to be ready.\r | |
825 | //\r | |
826 | Timeout = (Timeout / 10) + 1;\r | |
827 | RegisterA.Data = RtcRead (RTC_ADDRESS_REGISTER_A);\r | |
828 | while (RegisterA.Bits.UIP == 1 && Timeout > 0) {\r | |
829 | MicroSecondDelay (10);\r | |
830 | RegisterA.Data = RtcRead (RTC_ADDRESS_REGISTER_A);\r | |
831 | Timeout--;\r | |
832 | }\r | |
833 | \r | |
834 | RegisterD.Data = RtcRead (RTC_ADDRESS_REGISTER_D);\r | |
835 | if (Timeout == 0 || RegisterD.Bits.VRT == 0) {\r | |
836 | return EFI_DEVICE_ERROR;\r | |
837 | }\r | |
838 | \r | |
839 | return EFI_SUCCESS;\r | |
840 | }\r | |
841 | \r | |
8d85dc31 | 842 | /**\r |
843 | See if all fields of a variable of EFI_TIME type is correct.\r | |
844 | \r | |
845 | @param Time The time to be checked.\r | |
846 | \r | |
847 | @retval EFI_INVALID_PARAMETER Some fields of Time are not correct.\r | |
848 | @retval EFI_SUCCESS Time is a valid EFI_TIME variable.\r | |
849 | \r | |
850 | **/\r | |
8cd4d17c | 851 | EFI_STATUS\r |
852 | RtcTimeFieldsValid (\r | |
853 | IN EFI_TIME *Time\r | |
854 | )\r | |
8cd4d17c | 855 | {\r |
856 | if (Time->Year < 1998 ||\r | |
857 | Time->Year > 2099 ||\r | |
858 | Time->Month < 1 ||\r | |
859 | Time->Month > 12 ||\r | |
860 | (!DayValid (Time)) ||\r | |
861 | Time->Hour > 23 ||\r | |
862 | Time->Minute > 59 ||\r | |
863 | Time->Second > 59 ||\r | |
864 | Time->Nanosecond > 999999999 ||\r | |
865 | (!(Time->TimeZone == EFI_UNSPECIFIED_TIMEZONE || (Time->TimeZone >= -1440 && Time->TimeZone <= 1440))) ||\r | |
21176834 | 866 | ((Time->Daylight & (~(EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT))) != 0)\r |
8cd4d17c | 867 | ) {\r |
868 | return EFI_INVALID_PARAMETER;\r | |
869 | }\r | |
870 | \r | |
871 | return EFI_SUCCESS;\r | |
872 | }\r | |
873 | \r | |
8d85dc31 | 874 | /**\r |
875 | See if field Day of an EFI_TIME is correct.\r | |
876 | \r | |
877 | @param Time Its Day field is to be checked.\r | |
878 | \r | |
879 | @retval TRUE Day field of Time is correct.\r | |
880 | @retval FALSE Day field of Time is NOT correct.\r | |
881 | **/\r | |
8cd4d17c | 882 | BOOLEAN\r |
883 | DayValid (\r | |
884 | IN EFI_TIME *Time\r | |
885 | )\r | |
8cd4d17c | 886 | {\r |
887 | INTN DayOfMonth[12];\r | |
888 | \r | |
889 | DayOfMonth[0] = 31;\r | |
890 | DayOfMonth[1] = 29;\r | |
891 | DayOfMonth[2] = 31;\r | |
892 | DayOfMonth[3] = 30;\r | |
893 | DayOfMonth[4] = 31;\r | |
894 | DayOfMonth[5] = 30;\r | |
895 | DayOfMonth[6] = 31;\r | |
896 | DayOfMonth[7] = 31;\r | |
897 | DayOfMonth[8] = 30;\r | |
898 | DayOfMonth[9] = 31;\r | |
899 | DayOfMonth[10] = 30;\r | |
900 | DayOfMonth[11] = 31;\r | |
901 | \r | |
902 | if (Time->Day < 1 ||\r | |
903 | Time->Day > DayOfMonth[Time->Month - 1] ||\r | |
904 | (Time->Month == 2 && (!IsLeapYear (Time) && Time->Day > 28))\r | |
905 | ) {\r | |
906 | return FALSE;\r | |
907 | }\r | |
908 | \r | |
909 | return TRUE;\r | |
910 | }\r | |
911 | \r | |
8d85dc31 | 912 | /**\r |
913 | Check if it is a leapyear.\r | |
914 | \r | |
915 | @param Time The time to be checked.\r | |
916 | \r | |
917 | @retval TRUE It is a leapyear.\r | |
918 | @retval FALSE It is NOT a leapyear.\r | |
919 | **/\r | |
8cd4d17c | 920 | BOOLEAN\r |
921 | IsLeapYear (\r | |
922 | IN EFI_TIME *Time\r | |
923 | )\r | |
8cd4d17c | 924 | {\r |
925 | if (Time->Year % 4 == 0) {\r | |
926 | if (Time->Year % 100 == 0) {\r | |
927 | if (Time->Year % 400 == 0) {\r | |
928 | return TRUE;\r | |
929 | } else {\r | |
930 | return FALSE;\r | |
931 | }\r | |
932 | } else {\r | |
933 | return TRUE;\r | |
934 | }\r | |
935 | } else {\r | |
936 | return FALSE;\r | |
937 | }\r | |
938 | }\r | |
939 | \r | |
8d85dc31 | 940 | /**\r |
941 | Converts time from EFI_TIME format defined by UEFI spec to RTC's.\r | |
8cd4d17c | 942 | \r |
8d85dc31 | 943 | This function converts time from EFI_TIME format defined by UEFI spec to RTC's.\r |
944 | If data mode of RTC is BCD, then converts EFI_TIME to it.\r | |
945 | If RTC is in 12-hour format, then converts EFI_TIME to it.\r | |
8cd4d17c | 946 | \r |
8d85dc31 | 947 | @param Time On input, the time data read from UEFI to convert\r |
948 | On output, the time converted to RTC format\r | |
949 | @param RegisterB Value of Register B of RTC, indicating data mode\r | |
950 | @param Century It is set according to EFI_TIME Time.\r | |
8cd4d17c | 951 | \r |
8d85dc31 | 952 | **/\r |
953 | VOID\r | |
954 | ConvertEfiTimeToRtcTime (\r | |
955 | IN OUT EFI_TIME *Time,\r | |
956 | IN RTC_REGISTER_B RegisterB,\r | |
957 | OUT UINT8 *Century\r | |
958 | )\r | |
8cd4d17c | 959 | {\r |
8d85dc31 | 960 | BOOLEAN IsPM;\r |
8cd4d17c | 961 | \r |
8d85dc31 | 962 | IsPM = TRUE;\r |
8cd4d17c | 963 | //\r |
8d85dc31 | 964 | // Adjust hour field if RTC is in 12 hour mode\r |
8cd4d17c | 965 | //\r |
966 | if (RegisterB.Bits.MIL == 0) {\r | |
967 | if (Time->Hour < 12) {\r | |
8d85dc31 | 968 | IsPM = FALSE;\r |
8cd4d17c | 969 | }\r |
970 | \r | |
971 | if (Time->Hour >= 13) {\r | |
972 | Time->Hour = (UINT8) (Time->Hour - 12);\r | |
973 | } else if (Time->Hour == 0) {\r | |
974 | Time->Hour = 12;\r | |
975 | }\r | |
976 | }\r | |
977 | //\r | |
978 | // Set the Time/Date/Daylight Savings values.\r | |
979 | //\r | |
980 | *Century = DecimalToBcd8 ((UINT8) (Time->Year / 100));\r | |
981 | \r | |
982 | Time->Year = (UINT16) (Time->Year % 100);\r | |
983 | \r | |
984 | if (RegisterB.Bits.DM == 0) {\r | |
985 | Time->Year = DecimalToBcd8 ((UINT8) Time->Year);\r | |
986 | Time->Month = DecimalToBcd8 (Time->Month);\r | |
987 | Time->Day = DecimalToBcd8 (Time->Day);\r | |
988 | Time->Hour = DecimalToBcd8 (Time->Hour);\r | |
989 | Time->Minute = DecimalToBcd8 (Time->Minute);\r | |
990 | Time->Second = DecimalToBcd8 (Time->Second);\r | |
991 | }\r | |
992 | //\r | |
993 | // If we are in 12 hour mode and PM is set, then set bit 7 of the Hour field.\r | |
994 | //\r | |
8d85dc31 | 995 | if (RegisterB.Bits.MIL == 0 && IsPM) {\r |
8cd4d17c | 996 | Time->Hour = (UINT8) (Time->Hour | 0x80);\r |
997 | }\r | |
998 | }\r | |
999 | \r | |
8d85dc31 | 1000 | /**\r |
1001 | Compare the Hour, Minute and Second of the From time and the To time.\r | |
1002 | \r | |
1003 | Only compare H/M/S in EFI_TIME and ignore other fields here.\r | |
1004 | \r | |
1005 | @param From the first time\r | |
1006 | @param To the second time\r | |
1007 | \r | |
1008 | @return >0 The H/M/S of the From time is later than those of To time\r | |
1009 | @return ==0 The H/M/S of the From time is same as those of To time\r | |
1010 | @return <0 The H/M/S of the From time is earlier than those of To time\r | |
1011 | **/\r | |
8cd4d17c | 1012 | INTN\r |
1013 | CompareHMS (\r | |
1014 | IN EFI_TIME *From,\r | |
1015 | IN EFI_TIME *To\r | |
1016 | )\r | |
8cd4d17c | 1017 | {\r |
1018 | if ((From->Hour > To->Hour) ||\r | |
1019 | ((From->Hour == To->Hour) && (From->Minute > To->Minute)) ||\r | |
1020 | ((From->Hour == To->Hour) && (From->Minute == To->Minute) && (From->Second > To->Second))) {\r | |
1021 | return 1;\r | |
1022 | } else if ((From->Hour == To->Hour) && (From->Minute == To->Minute) && (From->Second == To->Second)) {\r | |
1023 | return 0;\r | |
1024 | } else {\r | |
1025 | return -1;\r | |
1026 | }\r | |
1027 | }\r | |
1028 | \r | |
8d85dc31 | 1029 | /**\r |
1030 | To check if second date is later than first date within 24 hours.\r | |
1031 | \r | |
1032 | @param From the first date\r | |
1033 | @param To the second date\r | |
1034 | \r | |
1035 | @retval TRUE From is previous to To within 24 hours.\r | |
1036 | @retval FALSE From is later, or it is previous to To more than 24 hours.\r | |
1037 | **/\r | |
8cd4d17c | 1038 | BOOLEAN\r |
1039 | IsWithinOneDay (\r | |
1040 | IN EFI_TIME *From,\r | |
1041 | IN EFI_TIME *To\r | |
1042 | )\r | |
8cd4d17c | 1043 | {\r |
1f4cf7b1 | 1044 | UINT8 DayOfMonth[12];\r |
1045 | BOOLEAN Adjacent;\r | |
1046 | \r | |
1047 | DayOfMonth[0] = 31;\r | |
1048 | DayOfMonth[1] = 29;\r | |
1049 | DayOfMonth[2] = 31;\r | |
1050 | DayOfMonth[3] = 30;\r | |
1051 | DayOfMonth[4] = 31;\r | |
1052 | DayOfMonth[5] = 30;\r | |
1053 | DayOfMonth[6] = 31;\r | |
1054 | DayOfMonth[7] = 31;\r | |
1055 | DayOfMonth[8] = 30;\r | |
1056 | DayOfMonth[9] = 31;\r | |
1057 | DayOfMonth[10] = 30;\r | |
1058 | DayOfMonth[11] = 31;\r | |
1059 | \r | |
1060 | Adjacent = FALSE;\r | |
8cd4d17c | 1061 | \r |
1062 | if (From->Year == To->Year) {\r | |
1063 | if (From->Month == To->Month) {\r | |
1064 | if ((From->Day + 1) == To->Day) {\r | |
1065 | if ((CompareHMS(From, To) >= 0)) {\r | |
1066 | Adjacent = TRUE;\r | |
1067 | }\r | |
1068 | } else if (From->Day == To->Day) {\r | |
1069 | if ((CompareHMS(From, To) <= 0)) {\r | |
1070 | Adjacent = TRUE;\r | |
1071 | }\r | |
1072 | }\r | |
1073 | } else if (((From->Month + 1) == To->Month) && (To->Day == 1)) {\r | |
1074 | if ((From->Month == 2) && !IsLeapYear(From)) {\r | |
1075 | if (From->Day == 28) {\r | |
1076 | if ((CompareHMS(From, To) >= 0)) {\r | |
1077 | Adjacent = TRUE;\r | |
1078 | }\r | |
1079 | }\r | |
1080 | } else if (From->Day == DayOfMonth[From->Month - 1]) {\r | |
1081 | if ((CompareHMS(From, To) >= 0)) {\r | |
1082 | Adjacent = TRUE;\r | |
1083 | }\r | |
1084 | }\r | |
1085 | }\r | |
1086 | } else if (((From->Year + 1) == To->Year) &&\r | |
1087 | (From->Month == 12) &&\r | |
1088 | (From->Day == 31) &&\r | |
1089 | (To->Month == 1) &&\r | |
1090 | (To->Day == 1)) {\r | |
1091 | if ((CompareHMS(From, To) >= 0)) {\r | |
1092 | Adjacent = TRUE;\r | |
1093 | }\r | |
1094 | }\r | |
1095 | \r | |
1096 | return Adjacent;\r | |
1097 | }\r | |
1098 | \r |