From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2a00:1450:400c:c09::229; helo=mail-wm0-x229.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-wm0-x229.google.com (mail-wm0-x229.google.com [IPv6:2a00:1450:400c:c09::229]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 577EB2034EE25 for ; Sun, 5 Nov 2017 08:49:03 -0800 (PST) Received: by mail-wm0-x229.google.com with SMTP id y83so9840110wmc.4 for ; Sun, 05 Nov 2017 08:53:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=EvsQiSxNMR8vlk+hr3LuL2QpAVh4KI7BwPpoj/Lo9nc=; b=Kgp5MaDxxh3CHpbpfJJ2Ka8vK/MJH/nsz0uJhNrug5xYAbgkJ68ADytK9dRnzuy3p6 SrbEs9aoLHCB9G1ab/tC9tjOhDF8tcFlyN/af6MTpMvZPUAcTV4oy0SnuZTeyeLmzxNh 3ORTTPfBiGtQzQsuGMeeaKCdBvJeQ14GFBy1U= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=EvsQiSxNMR8vlk+hr3LuL2QpAVh4KI7BwPpoj/Lo9nc=; b=f6wb77NTlLPdxKdvW9W/9xn05nrimhPu223pd2Xp5Vg6jl977rARPwjQQeE9fW2rRl tj8nLnyN2g9vp/Q+7WN3fA7TXzfr74cHGrSDLT7M71cnzlJhpKvHs7RLiYI6SE4P5Vmr W8c0EljlbJLlIFY6sd0RxJtCrusA5PD9E5KF2V7Hq3Xy2g64eejhOz0a+c8gq0fnjm+/ qi/VnvmNaY+0ONg5ECd0fvKk9Fwkp60OpAAC2WzLtIxdhliN+n9A3habcVpX2Pjnf5PS n7RmAxeXBejBP5BvinVvH2awe8GIGXYFpq6ZdmdhasbmXIvakFzpWOIgmeur7d3GghiJ uXWQ== X-Gm-Message-State: AJaThX7drmYjot554B/bnzlU5wLloXv/fPC4EcNzwlMMvfaya5BLYVU8 K3qSNHB85BvEdX2M1AIR35VwB3GvpUM= X-Google-Smtp-Source: ABhQp+Rv34ORm7bhHnLxqIR6Q0+PrqPsYgYKoy+LL6X7OI2umqZLIBX2/nrR8dZmwjRMdLljPMsD4Q== X-Received: by 10.28.139.72 with SMTP id n69mr3863676wmd.29.1509900779540; Sun, 05 Nov 2017 08:52:59 -0800 (PST) Received: from localhost.localdomain ([105.129.222.2]) by smtp.gmail.com with ESMTPSA id 141sm8835247wmr.45.2017.11.05.08.52.58 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 05 Nov 2017 08:52:58 -0800 (PST) From: Ard Biesheuvel To: edk2-devel@lists.01.org, leif.lindholm@linaro.org Cc: Ard Biesheuvel Date: Sun, 5 Nov 2017 16:52:52 +0000 Message-Id: <20171105165253.32571-1-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 2.11.0 Subject: [PATCH 1/2] EmbeddedPkg/RealTimeClockRuntimeDxe: move common functionality into core X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 05 Nov 2017 16:49:04 -0000 RealTimeClockRuntimeDxe defers the hardware/platform specific handling of reading/setting the hardware clock to RealTimeClockLib, but for unknown reasons, it also defers common functionality such as input validation and recording the timezone and DST settings (which are informational only and not managed by hardware) This has led to a lot of duplication in implementations of RealTimeClockLib as well as TimeBaseLib, to the point where each library implementation has its own set of UEFI variables to record the timezone and DST settings. This makes little sense, and so let's update RealTimeClockRuntimeDxe now to allow future implementations to rely on the core driver to take care of these things. Note that reading the timezone and DST settings occurs before calling into the library, so we can phase out this behavior gradually from library implementations in EDK2, edk2-platforms or out of tree. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ard Biesheuvel --- EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c | 165 +++++++++++++++++++- EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf | 11 +- 2 files changed, 166 insertions(+), 10 deletions(-) diff --git a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c index f1e067c0b59e..944bdac1a3f9 100644 --- a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c +++ b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c @@ -1,10 +1,8 @@ /** @file Implement EFI RealTimeClock runtime services via RTC Lib. - Currently this driver does not support runtime virtual calling. - - Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+ Copyright (c) 2017, Linaro, Ltd. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License @@ -17,14 +15,116 @@ **/ #include +#include +#include #include #include -#include +#include #include EFI_HANDLE mHandle = NULL; +// +// These values can be set by SetTime () and need to be returned by GetTime () +// but cannot usually be kept by the RTC hardware, so we store them in a UEFI +// variable instead. +// +typedef struct { + INT16 TimeZone; + UINT8 Daylight; +} NON_VOLATILE_TIME_SETTINGS; + +STATIC CONST CHAR16 mTimeSettingsVariableName[] = L"RtcTimeSettings"; +STATIC NON_VOLATILE_TIME_SETTINGS mTimeSettings; + +STATIC +BOOLEAN +IsValidTimeZone ( + IN INT16 TimeZone + ) +{ + return TimeZone == EFI_UNSPECIFIED_TIMEZONE || + (TimeZone >= -1440 && TimeZone <= 1440); +} + +STATIC +BOOLEAN +IsValidDaylight ( + IN INT8 Daylight + ) +{ + return Daylight == 0 || + Daylight == EFI_TIME_ADJUST_DAYLIGHT || + Daylight == (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT); +} + +STATIC +BOOLEAN +EFIAPI +IsLeapYear ( + IN EFI_TIME *Time + ) +{ + if (Time->Year % 4 == 0) { + if (Time->Year % 100 == 0) { + if (Time->Year % 400 == 0) { + return TRUE; + } else { + return FALSE; + } + } else { + return TRUE; + } + } else { + return FALSE; + } +} +STATIC CONST INTN mDayOfMonth[12] = { + 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 +}; + +STATIC +BOOLEAN +EFIAPI +IsDayValid ( + IN EFI_TIME *Time + ) +{ + ASSERT (Time->Day >= 1); + ASSERT (Time->Day <= mDayOfMonth[Time->Month - 1]); + ASSERT (Time->Month != 2 || (IsLeapYear (Time) && Time->Day <= 29)); + + if (Time->Day < 1 || + Time->Day > mDayOfMonth[Time->Month - 1] || + (Time->Month == 2 && (!IsLeapYear (Time) && Time->Day > 28))) { + return FALSE; + } + return TRUE; +} + +STATIC +BOOLEAN +EFIAPI +IsTimeValid( + IN EFI_TIME *Time + ) +{ + // Check the input parameters are within the range specified by UEFI + if (Time->Year < 1900 || + Time->Year > 9999 || + Time->Month < 1 || + Time->Month > 12 || + !IsDayValid (Time) || + Time->Hour > 23 || + Time->Minute > 59 || + Time->Second > 59 || + !IsValidTimeZone (Time->TimeZone) || + !IsValidDaylight (Time->Daylight)) { + return FALSE; + } + return TRUE; +} /** Returns the current time and date information, and the time-keeping capabilities @@ -46,6 +146,13 @@ GetTime ( OUT EFI_TIME_CAPABILITIES *Capabilities ) { + // + // Set these first so the RealTimeClockLib implementation + // can override them based on its own settings. + // + Time->TimeZone = mTimeSettings.TimeZone; + Time->Daylight = mTimeSettings.Daylight; + return LibGetTime (Time, Capabilities); } @@ -67,7 +174,41 @@ SetTime ( IN EFI_TIME *Time ) { - return LibSetTime (Time); + EFI_STATUS Status; + BOOLEAN TimeSettingsChanged; + + if (!IsTimeValid (Time)) { + return EFI_INVALID_PARAMETER; + } + + TimeSettingsChanged = FALSE; + if (mTimeSettings.TimeZone != Time->TimeZone || + mTimeSettings.Daylight != Time->Daylight) { + + mTimeSettings.TimeZone = Time->TimeZone; + mTimeSettings.Daylight = Time->Daylight; + TimeSettingsChanged = TRUE; + } + + Status = LibSetTime (Time); + if (EFI_ERROR (Status)) { + return Status; + } + + if (TimeSettingsChanged) { + Status = EfiSetVariable ( + (CHAR16 *)mTimeSettingsVariableName, + &gEfiCallerIdGuid, + EFI_VARIABLE_NON_VOLATILE | + EFI_VARIABLE_BOOTSERVICE_ACCESS | + EFI_VARIABLE_RUNTIME_ACCESS, + sizeof (mTimeSettings), + (VOID *)&mTimeSettings); + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + } + return EFI_SUCCESS; } @@ -138,12 +279,26 @@ InitializeRealTimeClock ( ) { EFI_STATUS Status; + UINTN Size; Status = LibRtcInitialize (ImageHandle, SystemTable); if (EFI_ERROR (Status)) { return Status; } + Size = sizeof (mTimeSettings); + Status = EfiGetVariable ((CHAR16 *)mTimeSettingsVariableName, + &gEfiCallerIdGuid, NULL, &Size, (VOID *)&mTimeSettings); + if (EFI_ERROR (Status) || + !IsValidTimeZone (mTimeSettings.TimeZone) || + !IsValidDaylight (mTimeSettings.Daylight)) { + DEBUG ((DEBUG_WARN, "%a: using default timezone/daylight settings\n", + __FUNCTION__)); + + mTimeSettings.TimeZone = EFI_UNSPECIFIED_TIMEZONE; + mTimeSettings.Daylight = 0; + } + SystemTable->RuntimeServices->GetTime = GetTime; SystemTable->RuntimeServices->SetTime = SetTime; SystemTable->RuntimeServices->GetWakeupTime = GetWakeupTime; diff --git a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf index 186d4610bd42..d0520392f145 100644 --- a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf +++ b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf @@ -1,8 +1,8 @@ #/** @file -# Reset Architectural Protocol Driver as defined in PI +# Real Time Clock Architectural Protocol Driver as defined in PI # -# This Reset module simulates system reset by process exit on NT. -# Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.
+# Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.
+# Copyright (c) 2017, Linaro, Ltd. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -31,10 +31,11 @@ [Packages] EmbeddedPkg/EmbeddedPkg.dec [LibraryClasses] - UefiBootServicesTableLib - UefiDriverEntryPoint DebugLib RealTimeClockLib + UefiBootServicesTableLib + UefiDriverEntryPoint + UefiRuntimeLib [Protocols] gEfiRealTimeClockArchProtocolGuid -- 2.11.0