]> git.proxmox.com Git - mirror_edk2.git/blobdiff - PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.c
PcAtChipsetPkg/PcRtc: Fix a Y2K bug
[mirror_edk2.git] / PcAtChipsetPkg / PcatRealTimeClockRuntimeDxe / PcRtc.c
index 35eb60ade486e265387c303d296a00d7513205a5..9ec309c6b997d90983a179fc07292ad8a9294481 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   RTC Architectural Protocol GUID as defined in DxeCis 0.96.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -100,10 +100,11 @@ PcRtcInit (
   RTC_REGISTER_A  RegisterA;\r
   RTC_REGISTER_B  RegisterB;\r
   RTC_REGISTER_D  RegisterD;\r
-  UINT8           Century;\r
   EFI_TIME        Time;\r
   UINTN           DataSize;\r
   UINT32          TimerVar;\r
+  BOOLEAN         Enabled;\r
+  BOOLEAN         Pending;\r
 \r
   //\r
   // Acquire RTC Lock to make access to RTC atomic\r
@@ -141,6 +142,11 @@ PcRtcInit (
   //\r
   Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r
   if (EFI_ERROR (Status)) {\r
+    //\r
+    // Set the variable with default value if the RTC is functioning incorrectly.\r
+    //\r
+    Global->SavedTimeZone = EFI_UNSPECIFIED_TIMEZONE;\r
+    Global->Daylight      = 0;\r
     if (!EfiAtRuntime ()) {\r
       EfiReleaseLock (&Global->RtcLock);\r
     }\r
@@ -156,8 +162,6 @@ PcRtcInit (
   Time.Month  = RtcRead (RTC_ADDRESS_MONTH);\r
   Time.Year   = RtcRead (RTC_ADDRESS_YEAR);\r
 \r
-  Century = RtcRead (RTC_ADDRESS_CENTURY);\r
-  \r
   //\r
   // Set RTC configuration after get original time\r
   // The value of bit AIE should be reserved.\r
@@ -194,29 +198,123 @@ PcRtcInit (
   //\r
   // Validate time fields\r
   //\r
-  Status = ConvertRtcTimeToEfiTime (&Time, Century, RegisterB);\r
+  Status = ConvertRtcTimeToEfiTime (&Time, RegisterB);\r
   if (!EFI_ERROR (Status)) {\r
     Status = RtcTimeFieldsValid (&Time);\r
   }\r
   if (EFI_ERROR (Status)) {\r
+    //\r
+    // Report Status Code to indicate that the RTC has bad date and time\r
+    //\r
+    REPORT_STATUS_CODE (\r
+      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+      (EFI_SOFTWARE_DXE_RT_DRIVER | EFI_SW_EC_BAD_DATE_TIME)\r
+      );\r
     Time.Second = RTC_INIT_SECOND;\r
     Time.Minute = RTC_INIT_MINUTE;\r
     Time.Hour   = RTC_INIT_HOUR;\r
     Time.Day    = RTC_INIT_DAY;\r
     Time.Month  = RTC_INIT_MONTH;\r
-    Time.Year   = RTC_INIT_YEAR;\r
+    Time.Year   = PcdGet16 (PcdMinimalValidYear);\r
     Time.Nanosecond  = 0;\r
+    Time.TimeZone = EFI_UNSPECIFIED_TIMEZONE;\r
+    Time.Daylight = 0;\r
   }\r
 \r
   //\r
   // Reset time value according to new RTC configuration\r
   //\r
   Status = PcRtcSetTime (&Time, Global);\r
-  if(!EFI_ERROR (Status)) {\r
+  if (EFI_ERROR (Status)) {\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+  \r
+  //\r
+  // Reset wakeup time value to valid state when wakeup alarm is disabled and wakeup time is invalid.\r
+  // Global variable has already had valid SavedTimeZone and Daylight,\r
+  // so we can use them to get and set wakeup time.\r
+  //\r
+  Status = PcRtcGetWakeupTime (&Enabled, &Pending, &Time, Global);\r
+  if ((Enabled) || (!EFI_ERROR (Status))) {\r
     return EFI_SUCCESS;\r
-  } else {\r
+  }\r
+  \r
+  //\r
+  // When wakeup time is disabled and invalid, reset wakeup time register to valid state \r
+  // but keep wakeup alarm disabled.\r
+  //\r
+  Time.Second = RTC_INIT_SECOND;\r
+  Time.Minute = RTC_INIT_MINUTE;\r
+  Time.Hour   = RTC_INIT_HOUR;\r
+  Time.Day    = RTC_INIT_DAY;\r
+  Time.Month  = RTC_INIT_MONTH;\r
+  Time.Year   = PcdGet16 (PcdMinimalValidYear);\r
+  Time.Nanosecond  = 0;\r
+  Time.TimeZone = Global->SavedTimeZone;\r
+  Time.Daylight = Global->Daylight;;\r
+\r
+  //\r
+  // Acquire RTC Lock to make access to RTC atomic\r
+  //\r
+  if (!EfiAtRuntime ()) {\r
+    EfiAcquireLock (&Global->RtcLock);\r
+  }\r
+  //\r
+  // Wait for up to 0.1 seconds for the RTC to be updated\r
+  //\r
+  Status = RtcWaitToUpdate (PcdGet32 (PcdRealTimeClockUpdateTimeout));\r
+  if (EFI_ERROR (Status)) {\r
+    if (!EfiAtRuntime ()) {\r
+    EfiReleaseLock (&Global->RtcLock);\r
+    }\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+\r
+  ConvertEfiTimeToRtcTime (&Time, RegisterB);\r
+\r
+  //\r
+  // Set the Y/M/D info to variable as it has no corresponding hw registers.\r
+  //\r
+  Status =  EfiSetVariable (\r
+              L"RTCALARM",\r
+              &gEfiCallerIdGuid,\r
+              EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+              sizeof (Time),\r
+              &Time\r
+              );\r
+  if (EFI_ERROR (Status)) {\r
+    if (!EfiAtRuntime ()) {\r
+      EfiReleaseLock (&Global->RtcLock);\r
+    }\r
     return EFI_DEVICE_ERROR;\r
   }\r
+  \r
+  //\r
+  // Inhibit updates of the RTC\r
+  //\r
+  RegisterB.Bits.Set  = 1;\r
+  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
\r
+  //\r
+  // Set RTC alarm time registers\r
+  //\r
+  RtcWrite (RTC_ADDRESS_SECONDS_ALARM, Time.Second);\r
+  RtcWrite (RTC_ADDRESS_MINUTES_ALARM, Time.Minute);\r
+  RtcWrite (RTC_ADDRESS_HOURS_ALARM, Time.Hour);\r
+\r
+  //\r
+  // Allow updates of the RTC registers\r
+  //\r
+  RegisterB.Bits.Set = 0;\r
+  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
\r
+  //\r
+  // Release RTC Lock.\r
+  //\r
+  if (!EfiAtRuntime ()) {\r
+    EfiReleaseLock (&Global->RtcLock);\r
+  }\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r
@@ -234,7 +332,6 @@ PcRtcInit (
 \r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 PcRtcGetTime (\r
   OUT  EFI_TIME               *Time,\r
   OUT  EFI_TIME_CAPABILITIES  *Capabilities,  OPTIONAL\r
@@ -243,7 +340,6 @@ PcRtcGetTime (
 {\r
   EFI_STATUS      Status;\r
   RTC_REGISTER_B  RegisterB;\r
-  UINT8           Century;\r
 \r
   //\r
   // Check parameters for null pointer\r
@@ -283,8 +379,6 @@ PcRtcGetTime (
   Time->Month   = RtcRead (RTC_ADDRESS_MONTH);\r
   Time->Year    = RtcRead (RTC_ADDRESS_YEAR);\r
 \r
-  Century = RtcRead (RTC_ADDRESS_CENTURY);\r
-  \r
   //\r
   // Release RTC Lock.\r
   //\r
@@ -301,7 +395,7 @@ PcRtcGetTime (
   //\r
   // Make sure all field values are in correct range\r
   //\r
-  Status = ConvertRtcTimeToEfiTime (Time, Century, RegisterB);\r
+  Status = ConvertRtcTimeToEfiTime (Time, RegisterB);\r
   if (!EFI_ERROR (Status)) {\r
     Status = RtcTimeFieldsValid (Time);\r
   }\r
@@ -339,7 +433,6 @@ PcRtcGetTime (
 \r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 PcRtcSetTime (\r
   IN EFI_TIME                *Time,\r
   IN PC_RTC_MODULE_GLOBALS   *Global\r
@@ -348,7 +441,6 @@ PcRtcSetTime (
   EFI_STATUS      Status;\r
   EFI_TIME        RtcTime;\r
   RTC_REGISTER_B  RegisterB;\r
-  UINT8           Century;\r
   UINT32          TimerVar;\r
 \r
   if (Time == NULL) {\r
@@ -380,6 +472,26 @@ PcRtcSetTime (
      }\r
     return Status;\r
   }\r
+  \r
+  //\r
+  // Write timezone and daylight to RTC variable\r
+  //\r
+  TimerVar = Time->Daylight;\r
+  TimerVar = (UINT32) ((TimerVar << 16) | (UINT16)(Time->TimeZone));\r
+  Status =  EfiSetVariable (\r
+              L"RTC",\r
+              &gEfiCallerIdGuid,\r
+              EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+              sizeof (TimerVar),\r
+              &TimerVar\r
+              );\r
+  if (EFI_ERROR (Status)) {\r
+    if (!EfiAtRuntime ()) {\r
+      EfiReleaseLock (&Global->RtcLock);\r
+    }\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+\r
   //\r
   // Read Register B, and inhibit updates of the RTC\r
   //\r
@@ -387,7 +499,7 @@ PcRtcSetTime (
   RegisterB.Bits.Set  = 1;\r
   RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
 \r
-  ConvertEfiTimeToRtcTime (&RtcTime, RegisterB, &Century);\r
+  ConvertEfiTimeToRtcTime (&RtcTime, RegisterB);\r
 \r
   RtcWrite (RTC_ADDRESS_SECONDS, RtcTime.Second);\r
   RtcWrite (RTC_ADDRESS_MINUTES, RtcTime.Minute);\r
@@ -395,7 +507,6 @@ PcRtcSetTime (
   RtcWrite (RTC_ADDRESS_DAY_OF_THE_MONTH, RtcTime.Day);\r
   RtcWrite (RTC_ADDRESS_MONTH, RtcTime.Month);\r
   RtcWrite (RTC_ADDRESS_YEAR, (UINT8) RtcTime.Year);\r
-  RtcWrite (RTC_ADDRESS_CENTURY, Century);\r
 \r
   //\r
   // Allow updates of the RTC registers\r
@@ -415,17 +526,6 @@ PcRtcSetTime (
   Global->SavedTimeZone = Time->TimeZone;\r
   Global->Daylight      = Time->Daylight;\r
 \r
-  TimerVar = Time->Daylight;\r
-  TimerVar = (UINT32) ((TimerVar << 16) | Time->TimeZone);\r
-  Status =  EfiSetVariable (\r
-              L"RTC",\r
-              &gEfiCallerIdGuid,\r
-              EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
-              sizeof (TimerVar),\r
-              &TimerVar\r
-              );\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -456,7 +556,6 @@ PcRtcGetWakeupTime (
   EFI_STATUS      Status;\r
   RTC_REGISTER_B  RegisterB;\r
   RTC_REGISTER_C  RegisterC;\r
-  UINT8           Century;\r
   EFI_TIME        RtcTime;\r
   UINTN           DataSize;\r
 \r
@@ -504,11 +603,10 @@ PcRtcGetWakeupTime (
   Time->TimeZone = Global->SavedTimeZone;\r
   Time->Daylight = Global->Daylight;\r
 \r
-  Century = RtcRead (RTC_ADDRESS_CENTURY);\r
-\r
   //\r
   // Get the alarm info from variable\r
   //\r
+  DataSize = sizeof (EFI_TIME);\r
   Status = EfiGetVariable (\r
               L"RTCALARM",\r
               &gEfiCallerIdGuid,\r
@@ -535,7 +633,7 @@ PcRtcGetWakeupTime (
   //\r
   // Make sure all field values are in correct range\r
   //\r
-  Status = ConvertRtcTimeToEfiTime (Time, Century, RegisterB);\r
+  Status = ConvertRtcTimeToEfiTime (Time, RegisterB);\r
   if (!EFI_ERROR (Status)) {\r
     Status = RtcTimeFieldsValid (Time);\r
   }\r
@@ -562,7 +660,6 @@ PcRtcGetWakeupTime (
 \r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 PcRtcSetWakeupTime (\r
   IN BOOLEAN                Enable,\r
   IN EFI_TIME               *Time,   OPTIONAL\r
@@ -572,10 +669,9 @@ PcRtcSetWakeupTime (
   EFI_STATUS            Status;\r
   EFI_TIME              RtcTime;\r
   RTC_REGISTER_B        RegisterB;\r
-  UINT8                 Century;\r
   EFI_TIME_CAPABILITIES Capabilities;\r
 \r
-  ZeroMem (RtcTime);\r
+  ZeroMem (&RtcTime, sizeof (RtcTime));\r
 \r
   if (Enable) {\r
 \r
@@ -623,27 +719,13 @@ PcRtcSetWakeupTime (
     return EFI_DEVICE_ERROR;\r
   }\r
   //\r
-  // Read Register B, and inhibit updates of the RTC\r
+  // Read Register B\r
   //\r
-  RegisterB.Data      = RtcRead (RTC_ADDRESS_REGISTER_B);\r
-\r
-  RegisterB.Bits.Set  = 1;\r
-  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
+  RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B);\r
 \r
   if (Enable) {\r
-    ConvertEfiTimeToRtcTime (&RtcTime, RegisterB, &Century);\r
-\r
-    //\r
-    // Set RTC alarm time\r
-    //\r
-    RtcWrite (RTC_ADDRESS_SECONDS_ALARM, RtcTime.Second);\r
-    RtcWrite (RTC_ADDRESS_MINUTES_ALARM, RtcTime.Minute);\r
-    RtcWrite (RTC_ADDRESS_HOURS_ALARM, RtcTime.Hour);\r
-\r
-    RegisterB.Bits.Aie = 1;\r
-\r
+    ConvertEfiTimeToRtcTime (&RtcTime, RegisterB);\r
   } else {\r
-    RegisterB.Bits.Aie = 0;\r
     //\r
     // if the alarm is disable, record the current setting.\r
     //\r
@@ -656,11 +738,6 @@ PcRtcSetWakeupTime (
     RtcTime.TimeZone = Global->SavedTimeZone;\r
     RtcTime.Daylight = Global->Daylight;\r
   }\r
-  //\r
-  // Allow updates of the RTC registers\r
-  //\r
-  RegisterB.Bits.Set = 0;\r
-  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
 \r
   //\r
   // Set the Y/M/D info to variable as it has no corresponding hw registers.\r
@@ -673,8 +750,36 @@ PcRtcSetWakeupTime (
               &RtcTime\r
               );\r
   if (EFI_ERROR (Status)) {\r
+    if (!EfiAtRuntime ()) {\r
+      EfiReleaseLock (&Global->RtcLock);\r
+    }\r
     return EFI_DEVICE_ERROR;\r
   }\r
+  \r
+  //\r
+  // Inhibit updates of the RTC\r
+  //\r
+  RegisterB.Bits.Set  = 1;\r
+  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
+\r
+  if (Enable) {\r
+    //\r
+    // Set RTC alarm time\r
+    //\r
+    RtcWrite (RTC_ADDRESS_SECONDS_ALARM, RtcTime.Second);\r
+    RtcWrite (RTC_ADDRESS_MINUTES_ALARM, RtcTime.Minute);\r
+    RtcWrite (RTC_ADDRESS_HOURS_ALARM, RtcTime.Hour);\r
+\r
+    RegisterB.Bits.Aie = 1;\r
+\r
+  } else {\r
+    RegisterB.Bits.Aie = 0;\r
+  }\r
+  //\r
+  // Allow updates of the RTC registers\r
+  //\r
+  RegisterB.Bits.Set = 0;\r
+  RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data);\r
 \r
   //\r
   // Release RTC Lock.\r
@@ -720,7 +825,6 @@ CheckAndConvertBcd8ToDecimal8 (
 \r
   @param   Time       On input, the time data read from RTC to convert\r
                       On output, the time converted to UEFI format\r
-  @param   Century    Value of century read from RTC.\r
   @param   RegisterB  Value of Register B of RTC, indicating data mode\r
                       and hour format.\r
 \r
@@ -731,11 +835,11 @@ CheckAndConvertBcd8ToDecimal8 (
 EFI_STATUS\r
 ConvertRtcTimeToEfiTime (\r
   IN OUT EFI_TIME        *Time,\r
-  IN     UINT8           Century,\r
   IN     RTC_REGISTER_B  RegisterB\r
   )\r
 {\r
   BOOLEAN IsPM;\r
+  UINT8   Century;\r
 \r
   if ((Time->Hour & 0x80) != 0) {\r
     IsPM = TRUE;\r
@@ -753,14 +857,21 @@ ConvertRtcTimeToEfiTime (
     Time->Minute  = CheckAndConvertBcd8ToDecimal8 (Time->Minute);\r
     Time->Second  = CheckAndConvertBcd8ToDecimal8 (Time->Second);\r
   }\r
-  Century       = CheckAndConvertBcd8ToDecimal8 (Century);\r
 \r
   if (Time->Year == 0xff || Time->Month == 0xff || Time->Day == 0xff ||\r
-      Time->Hour == 0xff || Time->Minute == 0xff || Time->Second == 0xff ||\r
-      Century == 0xff) {\r
+      Time->Hour == 0xff || Time->Minute == 0xff || Time->Second == 0xff) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
+  //\r
+  // For minimal/maximum year range [1970, 2069],\r
+  //   Century is 19 if RTC year >= 70,\r
+  //   Century is 20 otherwise.\r
+  //\r
+  Century = (UINT8) (PcdGet16 (PcdMinimalValidYear) / 100);\r
+  if (Time->Year < PcdGet16 (PcdMinimalValidYear) % 100) {\r
+    Century++;\r
+  }\r
   Time->Year = (UINT16) (Century * 100 + Time->Year);\r
 \r
   //\r
@@ -838,8 +949,8 @@ RtcTimeFieldsValid (
   IN EFI_TIME *Time\r
   )\r
 {\r
-  if (Time->Year < 1998 ||\r
-      Time->Year > 2099 ||\r
+  if (Time->Year < PcdGet16 (PcdMinimalValidYear) ||\r
+      Time->Year > PcdGet16 (PcdMaximalValidYear) ||\r
       Time->Month < 1 ||\r
       Time->Month > 12 ||\r
       (!DayValid (Time)) ||\r
@@ -936,14 +1047,11 @@ IsLeapYear (
   @param   Time       On input, the time data read from UEFI to convert\r
                       On output, the time converted to RTC format\r
   @param   RegisterB  Value of Register B of RTC, indicating data mode\r
-  @param   Century    It is set according to EFI_TIME Time.\r
-\r
 **/\r
 VOID\r
 ConvertEfiTimeToRtcTime (\r
   IN OUT EFI_TIME        *Time,\r
-  IN     RTC_REGISTER_B  RegisterB,\r
-     OUT UINT8           *Century\r
+  IN     RTC_REGISTER_B  RegisterB\r
   )\r
 {\r
   BOOLEAN IsPM;\r
@@ -964,10 +1072,8 @@ ConvertEfiTimeToRtcTime (
     }\r
   }\r
   //\r
-  // Set the Time/Date/Daylight Savings values.\r
+  // Set the Time/Date values.\r
   //\r
-  *Century    = DecimalToBcd8 ((UINT8) (Time->Year / 100));\r
-\r
   Time->Year  = (UINT16) (Time->Year % 100);\r
 \r
   if (RegisterB.Bits.Dm == 0) {\r