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