2 RTC Architectural Protocol GUID as defined in DxeCis 0.96.
4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Compare the Hour, Minute and Second of the From time and the To time.
20 Only compare H/M/S in EFI_TIME and ignore other fields here.
22 @param From the first time
23 @param To the second time
25 @return >0 The H/M/S of the From time is later than those of To time
26 @return ==0 The H/M/S of the From time is same as those of To time
27 @return <0 The H/M/S of the From time is earlier than those of To time
36 To check if second date is later than first date within 24 hours.
38 @param From the first date
39 @param To the second date
41 @retval TRUE From is previous to To within 24 hours.
42 @retval FALSE From is later, or it is previous to To more than 24 hours.
51 Read RTC content through its registers.
53 @param Address Address offset of RTC. It is recommended to use macros such as
56 @return The data of UINT8 type read from RTC.
63 IoWrite8 (PCAT_RTC_ADDRESS_REGISTER
, (UINT8
) (Address
| (UINT8
) (IoRead8 (PCAT_RTC_ADDRESS_REGISTER
) & 0x80)));
64 return IoRead8 (PCAT_RTC_DATA_REGISTER
);
68 Write RTC through its registers.
70 @param Address Address offset of RTC. It is recommended to use macros such as
72 @param Data The content you want to write into RTC.
81 IoWrite8 (PCAT_RTC_ADDRESS_REGISTER
, (UINT8
) (Address
| (UINT8
) (IoRead8 (PCAT_RTC_ADDRESS_REGISTER
) & 0x80)));
82 IoWrite8 (PCAT_RTC_DATA_REGISTER
, Data
);
88 @param Global For global use inside this module.
90 @retval EFI_DEVICE_ERROR Initialization failed due to device error.
91 @retval EFI_SUCCESS Initialization successful.
96 IN PC_RTC_MODULE_GLOBALS
*Global
100 RTC_REGISTER_A RegisterA
;
101 RTC_REGISTER_B RegisterB
;
102 RTC_REGISTER_D RegisterD
;
109 // Acquire RTC Lock to make access to RTC atomic
111 if (!EfiAtRuntime ()) {
112 EfiAcquireLock (&Global
->RtcLock
);
115 // Initialize RTC Register
117 // Make sure Division Chain is properly configured,
118 // or RTC clock won't "tick" -- time won't increment
120 RegisterA
.Data
= RTC_INIT_REGISTER_A
;
121 RtcWrite (RTC_ADDRESS_REGISTER_A
, RegisterA
.Data
);
126 RegisterB
.Data
= RtcRead (RTC_ADDRESS_REGISTER_B
);
129 // Clear RTC flag register
131 RtcRead (RTC_ADDRESS_REGISTER_C
);
134 // Clear RTC register D
136 RegisterD
.Data
= RTC_INIT_REGISTER_D
;
137 RtcWrite (RTC_ADDRESS_REGISTER_D
, RegisterD
.Data
);
140 // Wait for up to 0.1 seconds for the RTC to be updated
142 Status
= RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout
));
143 if (EFI_ERROR (Status
)) {
144 if (!EfiAtRuntime ()) {
145 EfiReleaseLock (&Global
->RtcLock
);
147 return EFI_DEVICE_ERROR
;
150 // Get the Time/Date/Daylight Savings values.
152 Time
.Second
= RtcRead (RTC_ADDRESS_SECONDS
);
153 Time
.Minute
= RtcRead (RTC_ADDRESS_MINUTES
);
154 Time
.Hour
= RtcRead (RTC_ADDRESS_HOURS
);
155 Time
.Day
= RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH
);
156 Time
.Month
= RtcRead (RTC_ADDRESS_MONTH
);
157 Time
.Year
= RtcRead (RTC_ADDRESS_YEAR
);
159 Century
= RtcRead (RTC_ADDRESS_CENTURY
);
162 // Set RTC configuration after get original time
163 // The value of bit AIE should be reserved.
165 RtcWrite (RTC_ADDRESS_REGISTER_B
, (UINT8
)(RTC_INIT_REGISTER_B
| (RegisterB
.Data
& BIT5
)));
170 if (!EfiAtRuntime ()) {
171 EfiReleaseLock (&Global
->RtcLock
);
175 // Get the data of Daylight saving and time zone, if they have been
176 // stored in NV variable during previous boot.
178 DataSize
= sizeof (UINT32
);
179 Status
= EfiGetVariable (
186 if (!EFI_ERROR (Status
)) {
187 Time
.TimeZone
= (INT16
) TimerVar
;
188 Time
.Daylight
= (UINT8
) (TimerVar
>> 16);
190 Time
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
195 // Validate time fields
197 Status
= ConvertRtcTimeToEfiTime (&Time
, Century
, RegisterB
);
198 if (!EFI_ERROR (Status
)) {
199 Status
= RtcTimeFieldsValid (&Time
);
201 if (EFI_ERROR (Status
)) {
202 Time
.Second
= RTC_INIT_SECOND
;
203 Time
.Minute
= RTC_INIT_MINUTE
;
204 Time
.Hour
= RTC_INIT_HOUR
;
205 Time
.Day
= RTC_INIT_DAY
;
206 Time
.Month
= RTC_INIT_MONTH
;
207 Time
.Year
= RTC_INIT_YEAR
;
212 // Reset time value according to new RTC configuration
214 Status
= PcRtcSetTime (&Time
, Global
);
215 if(!EFI_ERROR (Status
)) {
218 return EFI_DEVICE_ERROR
;
223 Returns the current time and date information, and the time-keeping capabilities
224 of the hardware platform.
226 @param Time A pointer to storage to receive a snapshot of the current time.
227 @param Capabilities An optional pointer to a buffer to receive the real time clock
228 device's capabilities.
229 @param Global For global use inside this module.
231 @retval EFI_SUCCESS The operation completed successfully.
232 @retval EFI_INVALID_PARAMETER Time is NULL.
233 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
239 OUT EFI_TIME_CAPABILITIES
*Capabilities
, OPTIONAL
240 IN PC_RTC_MODULE_GLOBALS
*Global
244 RTC_REGISTER_B RegisterB
;
248 // Check parameters for null pointer
251 return EFI_INVALID_PARAMETER
;
255 // Acquire RTC Lock to make access to RTC atomic
257 if (!EfiAtRuntime ()) {
258 EfiAcquireLock (&Global
->RtcLock
);
261 // Wait for up to 0.1 seconds for the RTC to be updated
263 Status
= RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout
));
264 if (EFI_ERROR (Status
)) {
265 if (!EfiAtRuntime ()) {
266 EfiReleaseLock (&Global
->RtcLock
);
273 RegisterB
.Data
= RtcRead (RTC_ADDRESS_REGISTER_B
);
276 // Get the Time/Date/Daylight Savings values.
278 Time
->Second
= RtcRead (RTC_ADDRESS_SECONDS
);
279 Time
->Minute
= RtcRead (RTC_ADDRESS_MINUTES
);
280 Time
->Hour
= RtcRead (RTC_ADDRESS_HOURS
);
281 Time
->Day
= RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH
);
282 Time
->Month
= RtcRead (RTC_ADDRESS_MONTH
);
283 Time
->Year
= RtcRead (RTC_ADDRESS_YEAR
);
285 Century
= RtcRead (RTC_ADDRESS_CENTURY
);
290 if (!EfiAtRuntime ()) {
291 EfiReleaseLock (&Global
->RtcLock
);
295 // Get the variable that contains the TimeZone and Daylight fields
297 Time
->TimeZone
= Global
->SavedTimeZone
;
298 Time
->Daylight
= Global
->Daylight
;
301 // Make sure all field values are in correct range
303 Status
= ConvertRtcTimeToEfiTime (Time
, Century
, RegisterB
);
304 if (!EFI_ERROR (Status
)) {
305 Status
= RtcTimeFieldsValid (Time
);
307 if (EFI_ERROR (Status
)) {
308 return EFI_DEVICE_ERROR
;
312 // Fill in Capabilities if it was passed in
314 if (Capabilities
!= NULL
) {
315 Capabilities
->Resolution
= 1;
319 Capabilities
->Accuracy
= 50000000;
323 Capabilities
->SetsToZero
= FALSE
;
330 Sets the current local time and date information.
332 @param Time A pointer to the current time.
333 @param Global For global use inside this module.
335 @retval EFI_SUCCESS The operation completed successfully.
336 @retval EFI_INVALID_PARAMETER A time field is out of range.
337 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
343 IN PC_RTC_MODULE_GLOBALS
*Global
348 RTC_REGISTER_B RegisterB
;
353 return EFI_INVALID_PARAMETER
;
356 // Make sure that the time fields are valid
358 Status
= RtcTimeFieldsValid (Time
);
359 if (EFI_ERROR (Status
)) {
363 CopyMem (&RtcTime
, Time
, sizeof (EFI_TIME
));
366 // Acquire RTC Lock to make access to RTC atomic
368 if (!EfiAtRuntime ()) {
369 EfiAcquireLock (&Global
->RtcLock
);
372 // Wait for up to 0.1 seconds for the RTC to be updated
374 Status
= RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout
));
375 if (EFI_ERROR (Status
)) {
376 if (!EfiAtRuntime ()) {
377 EfiReleaseLock (&Global
->RtcLock
);
382 // Read Register B, and inhibit updates of the RTC
384 RegisterB
.Data
= RtcRead (RTC_ADDRESS_REGISTER_B
);
385 RegisterB
.Bits
.Set
= 1;
386 RtcWrite (RTC_ADDRESS_REGISTER_B
, RegisterB
.Data
);
388 ConvertEfiTimeToRtcTime (&RtcTime
, RegisterB
, &Century
);
390 RtcWrite (RTC_ADDRESS_SECONDS
, RtcTime
.Second
);
391 RtcWrite (RTC_ADDRESS_MINUTES
, RtcTime
.Minute
);
392 RtcWrite (RTC_ADDRESS_HOURS
, RtcTime
.Hour
);
393 RtcWrite (RTC_ADDRESS_DAY_OF_THE_MONTH
, RtcTime
.Day
);
394 RtcWrite (RTC_ADDRESS_MONTH
, RtcTime
.Month
);
395 RtcWrite (RTC_ADDRESS_YEAR
, (UINT8
) RtcTime
.Year
);
396 RtcWrite (RTC_ADDRESS_CENTURY
, Century
);
399 // Allow updates of the RTC registers
401 RegisterB
.Bits
.Set
= 0;
402 RtcWrite (RTC_ADDRESS_REGISTER_B
, RegisterB
.Data
);
407 if (!EfiAtRuntime ()) {
408 EfiReleaseLock (&Global
->RtcLock
);
411 // Set the variable that contains the TimeZone and Daylight fields
413 Global
->SavedTimeZone
= Time
->TimeZone
;
414 Global
->Daylight
= Time
->Daylight
;
416 TimerVar
= Time
->Daylight
;
417 TimerVar
= (UINT32
) ((TimerVar
<< 16) | Time
->TimeZone
);
418 Status
= EfiSetVariable (
421 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
425 ASSERT_EFI_ERROR (Status
);
431 Returns the current wakeup alarm clock setting.
433 @param Enabled Indicates if the alarm is currently enabled or disabled.
434 @param Pending Indicates if the alarm signal is pending and requires acknowledgment.
435 @param Time The current alarm setting.
436 @param Global For global use inside this module.
438 @retval EFI_SUCCESS The alarm settings were returned.
439 @retval EFI_INVALID_PARAMETER Enabled is NULL.
440 @retval EFI_INVALID_PARAMETER Pending is NULL.
441 @retval EFI_INVALID_PARAMETER Time is NULL.
442 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
443 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
448 OUT BOOLEAN
*Enabled
,
449 OUT BOOLEAN
*Pending
,
451 IN PC_RTC_MODULE_GLOBALS
*Global
455 RTC_REGISTER_B RegisterB
;
456 RTC_REGISTER_C RegisterC
;
462 // Check parameters for null pointers
464 if ((Enabled
== NULL
) || (Pending
== NULL
) || (Time
== NULL
)) {
465 return EFI_INVALID_PARAMETER
;
469 // Acquire RTC Lock to make access to RTC atomic
471 if (!EfiAtRuntime ()) {
472 EfiAcquireLock (&Global
->RtcLock
);
475 // Wait for up to 0.1 seconds for the RTC to be updated
477 Status
= RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout
));
478 if (EFI_ERROR (Status
)) {
479 if (!EfiAtRuntime ()) {
480 EfiReleaseLock (&Global
->RtcLock
);
482 return EFI_DEVICE_ERROR
;
485 // Read Register B and Register C
487 RegisterB
.Data
= RtcRead (RTC_ADDRESS_REGISTER_B
);
488 RegisterC
.Data
= RtcRead (RTC_ADDRESS_REGISTER_C
);
491 // Get the Time/Date/Daylight Savings values.
493 *Enabled
= RegisterB
.Bits
.Aie
;
494 *Pending
= RegisterC
.Bits
.Af
;
496 Time
->Second
= RtcRead (RTC_ADDRESS_SECONDS_ALARM
);
497 Time
->Minute
= RtcRead (RTC_ADDRESS_MINUTES_ALARM
);
498 Time
->Hour
= RtcRead (RTC_ADDRESS_HOURS_ALARM
);
499 Time
->Day
= RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH
);
500 Time
->Month
= RtcRead (RTC_ADDRESS_MONTH
);
501 Time
->Year
= RtcRead (RTC_ADDRESS_YEAR
);
502 Time
->TimeZone
= Global
->SavedTimeZone
;
503 Time
->Daylight
= Global
->Daylight
;
505 Century
= RtcRead (RTC_ADDRESS_CENTURY
);
508 // Get the alarm info from variable
510 Status
= EfiGetVariable (
517 if (!EFI_ERROR (Status
)) {
519 // The alarm variable exists. In this case, we read variable to get info.
521 Time
->Day
= RtcTime
.Day
;
522 Time
->Month
= RtcTime
.Month
;
523 Time
->Year
= RtcTime
.Year
;
529 if (!EfiAtRuntime ()) {
530 EfiReleaseLock (&Global
->RtcLock
);
534 // Make sure all field values are in correct range
536 Status
= ConvertRtcTimeToEfiTime (Time
, Century
, RegisterB
);
537 if (!EFI_ERROR (Status
)) {
538 Status
= RtcTimeFieldsValid (Time
);
540 if (EFI_ERROR (Status
)) {
541 return EFI_DEVICE_ERROR
;
548 Sets the system wakeup alarm clock time.
550 @param Enabled Enable or disable the wakeup alarm.
551 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
552 If Enable is FALSE, then this parameter is optional, and may be NULL.
553 @param Global For global use inside this module.
555 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
556 If Enable is FALSE, then the wakeup alarm was disabled.
557 @retval EFI_INVALID_PARAMETER A time field is out of range.
558 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
559 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
565 IN EFI_TIME
*Time
, OPTIONAL
566 IN PC_RTC_MODULE_GLOBALS
*Global
571 RTC_REGISTER_B RegisterB
;
573 EFI_TIME_CAPABILITIES Capabilities
;
575 ZeroMem (&RtcTime
, sizeof (RtcTime
));
580 return EFI_INVALID_PARAMETER
;
583 // Make sure that the time fields are valid
585 Status
= RtcTimeFieldsValid (Time
);
586 if (EFI_ERROR (Status
)) {
587 return EFI_INVALID_PARAMETER
;
590 // Just support set alarm time within 24 hours
592 PcRtcGetTime (&RtcTime
, &Capabilities
, Global
);
593 Status
= RtcTimeFieldsValid (&RtcTime
);
594 if (EFI_ERROR (Status
)) {
595 return EFI_DEVICE_ERROR
;
597 if (!IsWithinOneDay (&RtcTime
, Time
)) {
598 return EFI_UNSUPPORTED
;
601 // Make a local copy of the time and date
603 CopyMem (&RtcTime
, Time
, sizeof (EFI_TIME
));
607 // Acquire RTC Lock to make access to RTC atomic
609 if (!EfiAtRuntime ()) {
610 EfiAcquireLock (&Global
->RtcLock
);
613 // Wait for up to 0.1 seconds for the RTC to be updated
615 Status
= RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout
));
616 if (EFI_ERROR (Status
)) {
617 if (!EfiAtRuntime ()) {
618 EfiReleaseLock (&Global
->RtcLock
);
620 return EFI_DEVICE_ERROR
;
623 // Read Register B, and inhibit updates of the RTC
625 RegisterB
.Data
= RtcRead (RTC_ADDRESS_REGISTER_B
);
627 RegisterB
.Bits
.Set
= 1;
628 RtcWrite (RTC_ADDRESS_REGISTER_B
, RegisterB
.Data
);
631 ConvertEfiTimeToRtcTime (&RtcTime
, RegisterB
, &Century
);
634 // Set RTC alarm time
636 RtcWrite (RTC_ADDRESS_SECONDS_ALARM
, RtcTime
.Second
);
637 RtcWrite (RTC_ADDRESS_MINUTES_ALARM
, RtcTime
.Minute
);
638 RtcWrite (RTC_ADDRESS_HOURS_ALARM
, RtcTime
.Hour
);
640 RegisterB
.Bits
.Aie
= 1;
643 RegisterB
.Bits
.Aie
= 0;
645 // if the alarm is disable, record the current setting.
647 RtcTime
.Second
= RtcRead (RTC_ADDRESS_SECONDS_ALARM
);
648 RtcTime
.Minute
= RtcRead (RTC_ADDRESS_MINUTES_ALARM
);
649 RtcTime
.Hour
= RtcRead (RTC_ADDRESS_HOURS_ALARM
);
650 RtcTime
.Day
= RtcRead (RTC_ADDRESS_DAY_OF_THE_MONTH
);
651 RtcTime
.Month
= RtcRead (RTC_ADDRESS_MONTH
);
652 RtcTime
.Year
= RtcRead (RTC_ADDRESS_YEAR
);
653 RtcTime
.TimeZone
= Global
->SavedTimeZone
;
654 RtcTime
.Daylight
= Global
->Daylight
;
657 // Allow updates of the RTC registers
659 RegisterB
.Bits
.Set
= 0;
660 RtcWrite (RTC_ADDRESS_REGISTER_B
, RegisterB
.Data
);
663 // Set the Y/M/D info to variable as it has no corresponding hw registers.
665 Status
= EfiSetVariable (
668 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
672 if (EFI_ERROR (Status
)) {
673 return EFI_DEVICE_ERROR
;
679 if (!EfiAtRuntime ()) {
680 EfiReleaseLock (&Global
->RtcLock
);
687 Checks an 8-bit BCD value, and converts to an 8-bit value if valid.
689 This function checks the 8-bit BCD value specified by Value.
690 If valid, the function converts it to an 8-bit value and returns it.
691 Otherwise, return 0xff.
693 @param Value The 8-bit BCD value to check and convert
695 @return The 8-bit value converted. Or 0xff if Value is invalid.
699 CheckAndConvertBcd8ToDecimal8 (
703 if ((Value
< 0xa0) && ((Value
& 0xf) < 0xa)) {
704 return BcdToDecimal8 (Value
);
711 Converts time read from RTC to EFI_TIME format defined by UEFI spec.
713 This function converts raw time data read from RTC to the EFI_TIME format
714 defined by UEFI spec.
715 If data mode of RTC is BCD, then converts it to decimal,
716 If RTC is in 12-hour format, then converts it to 24-hour format.
718 @param Time On input, the time data read from RTC to convert
719 On output, the time converted to UEFI format
720 @param Century Value of century read from RTC.
721 @param RegisterB Value of Register B of RTC, indicating data mode
724 @retval EFI_INVALID_PARAMETER Parameters passed in are invalid.
725 @retval EFI_SUCCESS Convert RTC time to EFI time successfully.
729 ConvertRtcTimeToEfiTime (
730 IN OUT EFI_TIME
*Time
,
732 IN RTC_REGISTER_B RegisterB
737 if ((Time
->Hour
& 0x80) != 0) {
743 Time
->Hour
= (UINT8
) (Time
->Hour
& 0x7f);
745 if (RegisterB
.Bits
.Dm
== 0) {
746 Time
->Year
= CheckAndConvertBcd8ToDecimal8 ((UINT8
) Time
->Year
);
747 Time
->Month
= CheckAndConvertBcd8ToDecimal8 (Time
->Month
);
748 Time
->Day
= CheckAndConvertBcd8ToDecimal8 (Time
->Day
);
749 Time
->Hour
= CheckAndConvertBcd8ToDecimal8 (Time
->Hour
);
750 Time
->Minute
= CheckAndConvertBcd8ToDecimal8 (Time
->Minute
);
751 Time
->Second
= CheckAndConvertBcd8ToDecimal8 (Time
->Second
);
753 Century
= CheckAndConvertBcd8ToDecimal8 (Century
);
755 if (Time
->Year
== 0xff || Time
->Month
== 0xff || Time
->Day
== 0xff ||
756 Time
->Hour
== 0xff || Time
->Minute
== 0xff || Time
->Second
== 0xff ||
758 return EFI_INVALID_PARAMETER
;
761 Time
->Year
= (UINT16
) (Century
* 100 + Time
->Year
);
764 // If time is in 12 hour format, convert it to 24 hour format
766 if (RegisterB
.Bits
.Mil
== 0) {
767 if (IsPM
&& Time
->Hour
< 12) {
768 Time
->Hour
= (UINT8
) (Time
->Hour
+ 12);
771 if (!IsPM
&& Time
->Hour
== 12) {
776 Time
->Nanosecond
= 0;
782 Wait for a period for the RTC to be ready.
784 @param Timeout Tell how long it should take to wait.
786 @retval EFI_DEVICE_ERROR RTC device error.
787 @retval EFI_SUCCESS RTC is updated and ready.
794 RTC_REGISTER_A RegisterA
;
795 RTC_REGISTER_D RegisterD
;
798 // See if the RTC is functioning correctly
800 RegisterD
.Data
= RtcRead (RTC_ADDRESS_REGISTER_D
);
802 if (RegisterD
.Bits
.Vrt
== 0) {
803 return EFI_DEVICE_ERROR
;
806 // Wait for up to 0.1 seconds for the RTC to be ready.
808 Timeout
= (Timeout
/ 10) + 1;
809 RegisterA
.Data
= RtcRead (RTC_ADDRESS_REGISTER_A
);
810 while (RegisterA
.Bits
.Uip
== 1 && Timeout
> 0) {
811 MicroSecondDelay (10);
812 RegisterA
.Data
= RtcRead (RTC_ADDRESS_REGISTER_A
);
816 RegisterD
.Data
= RtcRead (RTC_ADDRESS_REGISTER_D
);
817 if (Timeout
== 0 || RegisterD
.Bits
.Vrt
== 0) {
818 return EFI_DEVICE_ERROR
;
825 See if all fields of a variable of EFI_TIME type is correct.
827 @param Time The time to be checked.
829 @retval EFI_INVALID_PARAMETER Some fields of Time are not correct.
830 @retval EFI_SUCCESS Time is a valid EFI_TIME variable.
838 if (Time
->Year
< 1998 ||
842 (!DayValid (Time
)) ||
846 Time
->Nanosecond
> 999999999 ||
847 (!(Time
->TimeZone
== EFI_UNSPECIFIED_TIMEZONE
|| (Time
->TimeZone
>= -1440 && Time
->TimeZone
<= 1440))) ||
848 ((Time
->Daylight
& (~(EFI_TIME_ADJUST_DAYLIGHT
| EFI_TIME_IN_DAYLIGHT
))) != 0)) {
849 return EFI_INVALID_PARAMETER
;
856 See if field Day of an EFI_TIME is correct.
858 @param Time Its Day field is to be checked.
860 @retval TRUE Day field of Time is correct.
861 @retval FALSE Day field of Time is NOT correct.
884 // The validity of Time->Month field should be checked before
886 ASSERT (Time
->Month
>=1);
887 ASSERT (Time
->Month
<=12);
889 Time
->Day
> DayOfMonth
[Time
->Month
- 1] ||
890 (Time
->Month
== 2 && (!IsLeapYear (Time
) && Time
->Day
> 28))
899 Check if it is a leap year.
901 @param Time The time to be checked.
903 @retval TRUE It is a leap year.
904 @retval FALSE It is NOT a leap year.
911 if (Time
->Year
% 4 == 0) {
912 if (Time
->Year
% 100 == 0) {
913 if (Time
->Year
% 400 == 0) {
927 Converts time from EFI_TIME format defined by UEFI spec to RTC's.
929 This function converts time from EFI_TIME format defined by UEFI spec to RTC's.
930 If data mode of RTC is BCD, then converts EFI_TIME to it.
931 If RTC is in 12-hour format, then converts EFI_TIME to it.
933 @param Time On input, the time data read from UEFI to convert
934 On output, the time converted to RTC format
935 @param RegisterB Value of Register B of RTC, indicating data mode
936 @param Century It is set according to EFI_TIME Time.
940 ConvertEfiTimeToRtcTime (
941 IN OUT EFI_TIME
*Time
,
942 IN RTC_REGISTER_B RegisterB
,
950 // Adjust hour field if RTC is in 12 hour mode
952 if (RegisterB
.Bits
.Mil
== 0) {
953 if (Time
->Hour
< 12) {
957 if (Time
->Hour
>= 13) {
958 Time
->Hour
= (UINT8
) (Time
->Hour
- 12);
959 } else if (Time
->Hour
== 0) {
964 // Set the Time/Date/Daylight Savings values.
966 *Century
= DecimalToBcd8 ((UINT8
) (Time
->Year
/ 100));
968 Time
->Year
= (UINT16
) (Time
->Year
% 100);
970 if (RegisterB
.Bits
.Dm
== 0) {
971 Time
->Year
= DecimalToBcd8 ((UINT8
) Time
->Year
);
972 Time
->Month
= DecimalToBcd8 (Time
->Month
);
973 Time
->Day
= DecimalToBcd8 (Time
->Day
);
974 Time
->Hour
= DecimalToBcd8 (Time
->Hour
);
975 Time
->Minute
= DecimalToBcd8 (Time
->Minute
);
976 Time
->Second
= DecimalToBcd8 (Time
->Second
);
979 // If we are in 12 hour mode and PM is set, then set bit 7 of the Hour field.
981 if (RegisterB
.Bits
.Mil
== 0 && IsPM
) {
982 Time
->Hour
= (UINT8
) (Time
->Hour
| 0x80);
987 Compare the Hour, Minute and Second of the From time and the To time.
989 Only compare H/M/S in EFI_TIME and ignore other fields here.
991 @param From the first time
992 @param To the second time
994 @return >0 The H/M/S of the From time is later than those of To time
995 @return ==0 The H/M/S of the From time is same as those of To time
996 @return <0 The H/M/S of the From time is earlier than those of To time
1004 if ((From
->Hour
> To
->Hour
) ||
1005 ((From
->Hour
== To
->Hour
) && (From
->Minute
> To
->Minute
)) ||
1006 ((From
->Hour
== To
->Hour
) && (From
->Minute
== To
->Minute
) && (From
->Second
> To
->Second
))) {
1008 } else if ((From
->Hour
== To
->Hour
) && (From
->Minute
== To
->Minute
) && (From
->Second
== To
->Second
)) {
1016 To check if second date is later than first date within 24 hours.
1018 @param From the first date
1019 @param To the second date
1021 @retval TRUE From is previous to To within 24 hours.
1022 @retval FALSE From is later, or it is previous to To more than 24 hours.
1030 UINT8 DayOfMonth
[12];
1043 DayOfMonth
[10] = 30;
1044 DayOfMonth
[11] = 31;
1049 // The validity of From->Month field should be checked before
1051 ASSERT (From
->Month
>=1);
1052 ASSERT (From
->Month
<=12);
1054 if (From
->Year
== To
->Year
) {
1055 if (From
->Month
== To
->Month
) {
1056 if ((From
->Day
+ 1) == To
->Day
) {
1057 if ((CompareHMS(From
, To
) >= 0)) {
1060 } else if (From
->Day
== To
->Day
) {
1061 if ((CompareHMS(From
, To
) <= 0)) {
1065 } else if (((From
->Month
+ 1) == To
->Month
) && (To
->Day
== 1)) {
1066 if ((From
->Month
== 2) && !IsLeapYear(From
)) {
1067 if (From
->Day
== 28) {
1068 if ((CompareHMS(From
, To
) >= 0)) {
1072 } else if (From
->Day
== DayOfMonth
[From
->Month
- 1]) {
1073 if ((CompareHMS(From
, To
) >= 0)) {
1078 } else if (((From
->Year
+ 1) == To
->Year
) &&
1079 (From
->Month
== 12) &&
1080 (From
->Day
== 31) &&
1083 if ((CompareHMS(From
, To
) >= 0)) {