]> git.proxmox.com Git - mirror_edk2.git/blobdiff - EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c
Maintainers.txt: Update email address
[mirror_edk2.git] / EmbeddedPkg / RealTimeClockRuntimeDxe / RealTimeClock.c
index 08fb9b0100b6690b4270fba13b154dc94a3e4089..308e8cfca4bb5d68e7a85d6bfec758ca14446b57 100644 (file)
@@ -3,6 +3,7 @@
 \r
   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
   Copyright (c) 2017, Linaro, Ltd. All rights reserved.<BR>\r
+  Copyright (c) 2021, Ampere Computing LLC. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
@@ -11,6 +12,7 @@
 #include <PiDxe.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/RealTimeClockLib.h>\r
+#include <Library/TimeBaseLib.h>\r
 #include <Library/UefiLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiRuntimeLib.h>\r
@@ -24,101 +26,12 @@ EFI_HANDLE  mHandle = NULL;
 // variable instead.\r
 //\r
 typedef struct {\r
-  INT16           TimeZone;\r
-  UINT8           Daylight;\r
+  INT16    TimeZone;\r
+  UINT8    Daylight;\r
 } NON_VOLATILE_TIME_SETTINGS;\r
 \r
-STATIC CONST CHAR16 mTimeSettingsVariableName[] = L"RtcTimeSettings";\r
-STATIC NON_VOLATILE_TIME_SETTINGS mTimeSettings;\r
-\r
-STATIC\r
-BOOLEAN\r
-IsValidTimeZone (\r
-  IN  INT16  TimeZone\r
-  )\r
-{\r
-  return TimeZone == EFI_UNSPECIFIED_TIMEZONE ||\r
-         (TimeZone >= -1440 && TimeZone <= 1440);\r
-}\r
-\r
-STATIC\r
-BOOLEAN\r
-IsValidDaylight (\r
-  IN  INT8  Daylight\r
-  )\r
-{\r
-  return Daylight == 0 ||\r
-         Daylight == EFI_TIME_ADJUST_DAYLIGHT ||\r
-         Daylight == (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT);\r
-}\r
-\r
-STATIC\r
-BOOLEAN\r
-EFIAPI\r
-IsLeapYear (\r
-  IN EFI_TIME   *Time\r
-  )\r
-{\r
-  if (Time->Year % 4 == 0) {\r
-    if (Time->Year % 100 == 0) {\r
-      if (Time->Year % 400 == 0) {\r
-        return TRUE;\r
-      } else {\r
-        return FALSE;\r
-      }\r
-    } else {\r
-      return TRUE;\r
-    }\r
-  } else {\r
-    return FALSE;\r
-  }\r
-}\r
-\r
-STATIC CONST INTN mDayOfMonth[12] = {\r
-  31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31\r
-};\r
-\r
-STATIC\r
-BOOLEAN\r
-EFIAPI\r
-IsDayValid (\r
-  IN  EFI_TIME  *Time\r
-  )\r
-{\r
-  ASSERT (Time->Day >= 1);\r
-  ASSERT (Time->Day <= mDayOfMonth[Time->Month - 1]);\r
-  ASSERT (Time->Month != 2 || IsLeapYear (Time) || Time->Day <= 28);\r
-\r
-  if (Time->Day < 1 ||\r
-      Time->Day > mDayOfMonth[Time->Month - 1] ||\r
-      (Time->Month == 2 && !IsLeapYear (Time) && Time->Day > 28)) {\r
-    return FALSE;\r
-  }\r
-  return TRUE;\r
-}\r
-\r
-STATIC\r
-BOOLEAN\r
-EFIAPI\r
-IsTimeValid(\r
-  IN EFI_TIME *Time\r
-  )\r
-{\r
-  // Check the input parameters are within the range specified by UEFI\r
-  if (Time->Year   < 1900               ||\r
-      Time->Year   > 9999               ||\r
-      Time->Month  < 1                  ||\r
-      Time->Month  > 12                 ||\r
-      !IsDayValid (Time)                ||\r
-      Time->Hour   > 23                 ||\r
-      Time->Minute > 59                 ||\r
-      Time->Second > 59                 ||\r
-      !IsValidTimeZone (Time->TimeZone) ||\r
-      !IsValidDaylight (Time->Daylight)) {\r
-    return FALSE;\r
-  }\r
-  return TRUE;\r
-}\r
+STATIC CONST CHAR16                mTimeSettingsVariableName[] = L"RtcTimeSettings";\r
+STATIC NON_VOLATILE_TIME_SETTINGS  mTimeSettings;\r
 \r
 /**\r
   Returns the current time and date information, and the time-keeping capabilities\r
@@ -136,8 +49,8 @@ IsTimeValid(
 EFI_STATUS\r
 EFIAPI\r
 GetTime (\r
-  OUT EFI_TIME                *Time,\r
-  OUT EFI_TIME_CAPABILITIES   *Capabilities\r
+  OUT EFI_TIME               *Time,\r
+  OUT EFI_TIME_CAPABILITIES  *Capabilities\r
   )\r
 {\r
   if (Time == NULL) {\r
@@ -154,8 +67,6 @@ GetTime (
   return LibGetTime (Time, Capabilities);\r
 }\r
 \r
-\r
-\r
 /**\r
   Sets the current local time and date information.\r
 \r
@@ -169,23 +80,23 @@ GetTime (
 EFI_STATUS\r
 EFIAPI\r
 SetTime (\r
-  IN EFI_TIME                *Time\r
+  IN EFI_TIME  *Time\r
   )\r
 {\r
-  EFI_STATUS        Status;\r
-  BOOLEAN           TimeSettingsChanged;\r
+  EFI_STATUS  Status;\r
+  BOOLEAN     TimeSettingsChanged;\r
 \r
-  if (Time == NULL || !IsTimeValid (Time)) {\r
+  if ((Time == NULL) || !IsTimeValid (Time)) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
   TimeSettingsChanged = FALSE;\r
-  if (mTimeSettings.TimeZone != Time->TimeZone ||\r
-      mTimeSettings.Daylight != Time->Daylight) {\r
-\r
+  if ((mTimeSettings.TimeZone != Time->TimeZone) ||\r
+      (mTimeSettings.Daylight != Time->Daylight))\r
+  {\r
     mTimeSettings.TimeZone = Time->TimeZone;\r
     mTimeSettings.Daylight = Time->Daylight;\r
-    TimeSettingsChanged = TRUE;\r
+    TimeSettingsChanged    = TRUE;\r
   }\r
 \r
   Status = LibSetTime (Time);\r
@@ -201,15 +112,16 @@ SetTime (
                EFI_VARIABLE_BOOTSERVICE_ACCESS |\r
                EFI_VARIABLE_RUNTIME_ACCESS,\r
                sizeof (mTimeSettings),\r
-               (VOID *)&mTimeSettings);\r
+               (VOID *)&mTimeSettings\r
+               );\r
     if (EFI_ERROR (Status)) {\r
       return EFI_DEVICE_ERROR;\r
     }\r
   }\r
+\r
   return EFI_SUCCESS;\r
 }\r
 \r
-\r
 /**\r
   Returns the current wakeup alarm clock setting.\r
 \r
@@ -225,15 +137,25 @@ SetTime (
 EFI_STATUS\r
 EFIAPI\r
 GetWakeupTime (\r
-  OUT BOOLEAN     *Enabled,\r
-  OUT BOOLEAN     *Pending,\r
-  OUT EFI_TIME    *Time\r
+  OUT BOOLEAN   *Enabled,\r
+  OUT BOOLEAN   *Pending,\r
+  OUT EFI_TIME  *Time\r
   )\r
 {\r
+  if ((Time == NULL) || (Enabled == NULL) || (Pending == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Set these first so the RealTimeClockLib implementation\r
+  // can override them based on its own settings.\r
+  //\r
+  Time->TimeZone = mTimeSettings.TimeZone;\r
+  Time->Daylight = mTimeSettings.Daylight;\r
+\r
   return LibGetWakeupTime (Enabled, Pending, Time);\r
 }\r
 \r
-\r
 /**\r
   Sets the system wakeup alarm clock time.\r
 \r
@@ -250,15 +172,13 @@ GetWakeupTime (
 EFI_STATUS\r
 EFIAPI\r
 SetWakeupTime (\r
-  IN BOOLEAN      Enabled,\r
-  OUT EFI_TIME    *Time\r
+  IN BOOLEAN    Enabled,\r
+  OUT EFI_TIME  *Time\r
   )\r
 {\r
   return LibSetWakeupTime (Enabled, Time);\r
 }\r
 \r
-\r
-\r
 /**\r
   This is the declaration of an EFI image entry point. This can be the entry point to an application\r
   written to this specification, an EFI boot service driver, or an EFI runtime driver.\r
@@ -272,8 +192,8 @@ SetWakeupTime (
 EFI_STATUS\r
 EFIAPI\r
 InitializeRealTimeClock (\r
-  IN EFI_HANDLE                            ImageHandle,\r
-  IN EFI_SYSTEM_TABLE                      *SystemTable\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
 {\r
   EFI_STATUS  Status;\r
@@ -284,14 +204,23 @@ InitializeRealTimeClock (
     return Status;\r
   }\r
 \r
-  Size = sizeof (mTimeSettings);\r
-  Status = EfiGetVariable ((CHAR16 *)mTimeSettingsVariableName,\r
-             &gEfiCallerIdGuid, NULL, &Size, (VOID *)&mTimeSettings);\r
+  Size   = sizeof (mTimeSettings);\r
+  Status = EfiGetVariable (\r
+             (CHAR16 *)mTimeSettingsVariableName,\r
+             &gEfiCallerIdGuid,\r
+             NULL,\r
+             &Size,\r
+             (VOID *)&mTimeSettings\r
+             );\r
   if (EFI_ERROR (Status) ||\r
       !IsValidTimeZone (mTimeSettings.TimeZone) ||\r
-      !IsValidDaylight (mTimeSettings.Daylight)) {\r
-    DEBUG ((DEBUG_WARN, "%a: using default timezone/daylight settings\n",\r
-      __FUNCTION__));\r
+      !IsValidDaylight (mTimeSettings.Daylight))\r
+  {\r
+    DEBUG ((\r
+      DEBUG_WARN,\r
+      "%a: using default timezone/daylight settings\n",\r
+      __FUNCTION__\r
+      ));\r
 \r
     mTimeSettings.TimeZone = EFI_UNSPECIFIED_TIMEZONE;\r
     mTimeSettings.Daylight = 0;\r
@@ -311,4 +240,3 @@ InitializeRealTimeClock (
 \r
   return Status;\r
 }\r
-\r