From patchwork Mon Nov 6 18:20:36 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 118077 Delivered-To: patch@linaro.org Received: by 10.140.22.164 with SMTP id 33csp3061224qgn; Mon, 6 Nov 2017 10:20:50 -0800 (PST) X-Google-Smtp-Source: ABhQp+SE687zJtA2vNq06dV1aosgDKloIVD/t+LV09TseR9OHa5JioUQLOJ8HsgIy6rx+bWYYBBg X-Received: by 10.84.244.136 with SMTP id h8mr15515569pll.84.1509992450500; Mon, 06 Nov 2017 10:20:50 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1509992450; cv=none; d=google.com; s=arc-20160816; b=Kt3wmIwAzVFh5WLgtnqgYXPAC4tqlPTaRjw8pk0O0zff3zy/Ngi2VvWgu7wN0FFJWR eKSn/NQez2jtvTfzQIR0JArwJ65ZENtF7tG9lzm8QbdJzzda3/ZGkzvO7rsLn7hObUKF aXPMMukknb7Y80U/k3rPVZs6sIdiR5upv+vuM1jh2P53ki8omae3CgFzs6wMrTv38xHH evkQdne5AOWbClzOyWov62jPnQruxVec2msNo8SEEwBUI/qdCvB2CKC02QnImcftiMz9 bJ0g8laPJwyxpQ7FuR8XAIRoEa6E5GMiIs+ptGcpuCO8OwBHv7w475CSHBRK35cTMG/K silA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version:cc :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:references:in-reply-to:message-id:date :to:from:dkim-signature:delivered-to:arc-authentication-results; bh=HIem2PEfdcR1bj3wTXHPQUc7WZG/nkLPd/0TKk0pRHM=; b=QNr5RrbmwOc1UUEcWFERplSX+DdCnQ7/XgCqTlHFTNnb5orsSWWKwrJi8K9O0eND9u hvdOqkNjCgdZ0s4p3gPYkiw0T8uGRLt7DIn9gHfzxi1HJTjWDYBs+Tg4Wlno1Wh3O3mY szNyZdwiWcS6EKKbrVxxaoYw3m/Yz+RBHLimBIopPorxXFtdzLbTZXDKFb3uug8ToUHE MUITIMN8zL2n6YyFFq3sHiwl2MWNb1V4od2s4Xy5PkYVf7EpkndITo0Hn1Nvoq6maip8 bySfUGpplWjdwpuKJO+nCEZ6GZf0XT4AU8BTfRIOzmDBLLkMHyLhmmWzdHS9SP8GeJN8 pqKA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=NepNJu9e; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from ml01.01.org (ml01.01.org. [2001:19d0:306:5::1]) by mx.google.com with ESMTPS id 198si11427637pgd.292.2017.11.06.10.20.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 06 Nov 2017 10:20:50 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) client-ip=2001:19d0:306:5::1; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=NepNJu9e; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 2001:19d0:306:5::1 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 48AD62035D0EF; Mon, 6 Nov 2017 10:16:51 -0800 (PST) X-Original-To: edk2-devel@lists.01.org Delivered-To: edk2-devel@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2a00:1450:400c:c0c::229; helo=mail-wr0-x229.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-wr0-x229.google.com (mail-wr0-x229.google.com [IPv6:2a00:1450:400c:c0c::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 5FCD5202E5CD3 for ; Mon, 6 Nov 2017 10:16:49 -0800 (PST) Received: by mail-wr0-x229.google.com with SMTP id u97so2037579wrc.1 for ; Mon, 06 Nov 2017 10:20:48 -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:in-reply-to:references; bh=39Xt8VJkgW5AUb5977JXcdPQPjvrM3OR0Gj4WVs6aWM=; b=NepNJu9efw9tjzJ1L/Z/fwOEAW07hz8kyZIPpV2aNGICWPWEjz9nhVBFsZlLr2S5yH LRrXSGhWeJzrXXoHLm/0ExQRT9O95rMgjJ42tZsLun/wLIrkyDy4NYCeaok5p66tPDNd QWabHumMJ5pTa+CoWPv/dC7aSIhPkUb6q42ls= 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:in-reply-to :references; bh=39Xt8VJkgW5AUb5977JXcdPQPjvrM3OR0Gj4WVs6aWM=; b=XlRkGBzmPmOB3AESF+eayJlWHMzjoYplhxLFkzd5V0KmqCTPPCZPRVnnlXtC4BnWzZ ybSplXCqP/7xPpilYn+EAsYduQQBsgAsDow3MfoPdpGG3eSSZKi7isLvnY2JizMKT31E 7b0RHidvcR5LdKIbnN05JvETg8I+IV6A+Bc0TwgmzytIviD0gMjGjWZkBQKNGhr06WDc Bh7sUVB2zpen9n8uxrxBDAXo6pEFRn8J0sl1LNPYG9jwYq8EQ5vYm6NJCYLR6jx/8yuj i3liY06eUlXl5c34rf8fpZikYJWK2iji3bdJ5ZJGACpiw3VKL2/xzN0eyAA7r6wVwuLq Qo6A== X-Gm-Message-State: AMCzsaUeDILoH6kO28kuAG59ldBUJyKV02hpPRu+DSSGedbxtoc/QIvh +5j5po+adZQ8pfrFwccu7os85aW/8s4= X-Received: by 10.223.187.143 with SMTP id q15mr12569333wrg.184.1509992446303; Mon, 06 Nov 2017 10:20:46 -0800 (PST) Received: from localhost.localdomain ([105.129.222.2]) by smtp.gmail.com with ESMTPSA id w206sm4516507wmd.36.2017.11.06.10.20.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 06 Nov 2017 10:20:45 -0800 (PST) From: Ard Biesheuvel To: edk2-devel@lists.01.org, leif.lindholm@linaro.org Date: Mon, 6 Nov 2017 18:20:36 +0000 Message-Id: <20171106182038.16750-2-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171106182038.16750-1-ard.biesheuvel@linaro.org> References: <20171106182038.16750-1-ard.biesheuvel@linaro.org> Subject: [edk2] [PATCH v2 1/3] 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: , Cc: Ard Biesheuvel MIME-Version: 1.0 Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" 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 | 171 +++++++++++++++++++- EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf | 11 +- 2 files changed, 171 insertions(+), 11 deletions(-) -- 2.11.0 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel diff --git a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c index f1e067c0b59e..6b7cc876fa33 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 @@ -43,9 +143,20 @@ EFI_STATUS EFIAPI GetTime ( OUT EFI_TIME *Time, - OUT EFI_TIME_CAPABILITIES *Capabilities + OUT EFI_TIME_CAPABILITIES *Capabilities ) { + if (Time == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // 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 +178,41 @@ SetTime ( IN EFI_TIME *Time ) { - return LibSetTime (Time); + EFI_STATUS Status; + BOOLEAN TimeSettingsChanged; + + if (Time == NULL || !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 +283,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