From nobody Sat Dec 28 10:38:02 2024 Delivered-To: importer@patchew.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; Authentication-Results: mx.zoho.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org; Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1498725156220583.9097515421781; Thu, 29 Jun 2017 01:32:36 -0700 (PDT) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id EC16D21B02B9E; Thu, 29 Jun 2017 01:30:54 -0700 (PDT) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id E55F021B02B91 for ; Thu, 29 Jun 2017 01:30:53 -0700 (PDT) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga105.fm.intel.com with ESMTP; 29 Jun 2017 01:32:26 -0700 Received: from ray-dev.ccr.corp.intel.com ([10.239.9.28]) by FMSMGA003.fm.intel.com with ESMTP; 29 Jun 2017 01:32:25 -0700 X-Original-To: edk2-devel@lists.01.org X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,279,1496127600"; d="scan'208";a="872956490" From: Ruiyu Ni To: edk2-devel@lists.01.org Date: Thu, 29 Jun 2017 16:32:21 +0800 Message-Id: <20170629083221.485184-4-ruiyu.ni@intel.com> X-Mailer: git-send-email 2.12.2.windows.2 In-Reply-To: <20170629083221.485184-1-ruiyu.ni@intel.com> References: <20170629083221.485184-1-ruiyu.ni@intel.com> Subject: [edk2] [PATCH 3/3] MdeModulePkg/ResetSystem: Implement ResetNotification protocol 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: Star Zeng MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ruiyu Ni Cc: Star Zeng --- .../Universal/ResetSystemRuntimeDxe/ResetSystem.c | 137 +++++++++++++++++= +++- .../Universal/ResetSystemRuntimeDxe/ResetSystem.h | 21 +++- .../ResetSystemRuntimeDxe.inf | 5 +- 3 files changed, 155 insertions(+), 8 deletions(-) diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c b/M= deModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c index 64f2da5ce9..36c3238301 100644 --- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c +++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c @@ -16,6 +16,121 @@ #include "ResetSystem.h" =20 /** + Register a notification function to be called when ResetSystem() is call= ed. + + The RegisterResetNotify() function registers a notification function tha= t is called when + ResetSystem()is called and prior to completing the reset of the platform. + The registered functions must not perform a platform reset themselves. T= hese + notifications are intended only for the notification of components which= may need some + special-purpose maintenance prior to the platform resetting. + The list of registered reset notification functions are processed if Res= etSystem()is called + before ExitBootServices(). The list of registered reset notification fun= ctions is ignored if + ResetSystem()is called after ExitBootServices(). + + @param[in] This A pointer to the EFI_RESET_NOTIFICATION_PR= OTOCOL instance. + @param[in] ResetFunction Points to the function to be called when a= ResetSystem() is executed. + + @retval EFI_SUCCESS The reset notification function was succes= sfully registered. + @retval EFI_INVALID_PARAMETER ResetFunction is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available t= o register the reset notification function. + @retval EFI_ALREADY_STARTED The reset notification function specified = by ResetFunction has already been registered. + +**/ +EFI_STATUS +EFIAPI +RegisterResetNotify ( + IN EFI_RESET_NOTIFICATION_PROTOCOL *This, + IN EFI_RESET_SYSTEM ResetFunction + ) +{ + RESET_NOTIFICATION_INSTANCE *Instance; + LIST_ENTRY *Link; + RESET_NOTIFY_ENTRY *Entry; + + if (ResetFunction =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance =3D RESET_NOTIFICATION_INSTANCE_FROM_THIS (This); + + for ( Link =3D GetFirstNode (&Instance->ResetNotifies) + ; !IsNull (&Instance->ResetNotifies, Link) + ; Link =3D GetNextNode (&Instance->ResetNotifies, Link) + ) { + Entry =3D RESET_NOTIFY_ENTRY_FROM_LINK (Link); + if (Entry->ResetNotify =3D=3D ResetFunction) { + return EFI_ALREADY_STARTED; + } + } + + ASSERT (IsNull (&Instance->ResetNotifies, Link)); + Entry =3D AllocatePool (sizeof (*Entry)); + if (Entry =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + Entry->Signature =3D RESET_NOTIFY_ENTRY_SIGNATURE; + Entry->ResetNotify =3D ResetFunction; + InsertTailList (&Instance->ResetNotifies, &Entry->Link); + return EFI_SUCCESS; +} + +/** + Unregister a notification function. + + The UnregisterResetNotify() function removes the previously registered + notification using RegisterResetNotify(). + + @param[in] This A pointer to the EFI_RESET_NOTIFICATION_PR= OTOCOL instance. + @param[in] ResetFunction The pointer to the ResetFunction being unr= egistered. + + @retval EFI_SUCCESS The reset notification function was unregi= stered. + @retval EFI_INVALID_PARAMETER ResetFunction is NULL. + @retval EFI_INVALID_PARAMETER The reset notification function specified = by ResetFunction was not previously + registered using RegisterResetNotify(). + +**/ +EFI_STATUS +EFIAPI +UnregisterResetNotify ( + IN EFI_RESET_NOTIFICATION_PROTOCOL *This, + IN EFI_RESET_SYSTEM ResetFunction + ) +{ + RESET_NOTIFICATION_INSTANCE *Instance; + LIST_ENTRY *Link; + RESET_NOTIFY_ENTRY *Entry; + + if (ResetFunction =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance =3D RESET_NOTIFICATION_INSTANCE_FROM_THIS (This); + + for ( Link =3D GetFirstNode (&Instance->ResetNotifies) + ; !IsNull (&Instance->ResetNotifies, Link) + ; Link =3D GetNextNode (&Instance->ResetNotifies, Link) + ) { + Entry =3D RESET_NOTIFY_ENTRY_FROM_LINK (Link); + if (Entry->ResetNotify =3D=3D ResetFunction) { + RemoveEntryList (&Entry->Link); + FreePool (Entry); + return EFI_SUCCESS; + } + } + + return EFI_INVALID_PARAMETER; +} + +RESET_NOTIFICATION_INSTANCE mResetNotification =3D { + RESET_NOTIFICATION_INSTANCE_SIGNATURE, + { + RegisterResetNotify, + UnregisterResetNotify + }, + INITIALIZE_LIST_HEAD_VARIABLE (mResetNotification.ResetNotifies) +}; + +/** The driver's entry point. =20 It initializes the Reset Architectural Protocol. @@ -53,8 +168,8 @@ InitializeResetSystem ( Handle =3D NULL; Status =3D gBS->InstallMultipleProtocolInterfaces ( &Handle, - &gEfiResetArchProtocolGuid, - NULL, + &gEfiResetArchProtocolGuid, NULL, + &gEfiResetNotificationProtocolGuid, &mResetNotification.= ResetNotification, NULL ); ASSERT_EFI_ERROR (Status); @@ -102,15 +217,27 @@ ResetSystem ( IN VOID *ResetData OPTIONAL ) { - EFI_STATUS Status; - UINTN Size; - UINTN CapsuleDataPtr; + EFI_STATUS Status; + UINTN Size; + UINTN CapsuleDataPtr; + LIST_ENTRY *Link; + RESET_NOTIFY_ENTRY *Entry; =20 // // Indicate reset system runtime service is called. // REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_EFI_RUNTIME_SERVICE= | EFI_SW_RS_PC_RESET_SYSTEM)); =20 + if (!EfiAtRuntime ()) { + for ( Link =3D GetFirstNode (&mResetNotification.ResetNotifies) + ; !IsNull (&mResetNotification.ResetNotifies, Link) + ; Link =3D GetNextNode (&mResetNotification.ResetNotifies, Link) + ) { + Entry =3D RESET_NOTIFY_ENTRY_FROM_LINK (Link); + Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData); + } + } + switch (ResetType) { case EfiResetWarm: =20 diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h b/M= deModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h index c3a2a7f127..73e657d4e0 100644 --- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h +++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h @@ -1,6 +1,6 @@ /** @file =20 - Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
+ Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
=20 This program and the accompanying materials are licensed and made available under the terms and conditions of the BS= D License @@ -19,6 +19,7 @@ #include =20 #include +#include #include =20 #include @@ -31,6 +32,24 @@ #include #include #include +#include + +typedef struct { + UINT32 Signature; + LIST_ENTRY Link; + EFI_RESET_SYSTEM ResetNotify; +} RESET_NOTIFY_ENTRY; +#define RESET_NOTIFY_ENTRY_SIGNATURE SIGNATURE_32('r', 's', 't', 'n') +#define RESET_NOTIFY_ENTRY_FROM_LINK(a) CR (a, RESET_NOTIFY_ENTRY, Link, R= ESET_NOTIFY_ENTRY_SIGNATURE) + +typedef struct { + UINT32 Signature; + EFI_RESET_NOTIFICATION_PROTOCOL ResetNotification; + LIST_ENTRY ResetNotifies; +} RESET_NOTIFICATION_INSTANCE; +#define RESET_NOTIFICATION_INSTANCE_SIGNATURE SIGNATURE_32('r', 's', 't= ', 'i') +#define RESET_NOTIFICATION_INSTANCE_FROM_THIS(a) \ + CR (a, RESET_NOTIFICATION_INSTANCE, ResetNotification, RESET_NOTIFICATIO= N_INSTANCE_SIGNATURE) =20 /** The driver's entry point. diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntim= eDxe.inf b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeD= xe.inf index 7ef52b3283..e63dc4467a 100644 --- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf +++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf @@ -1,7 +1,7 @@ ## @file # This driver implements Reset Architectural Protocol. # -# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
+# Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
# # This program and the accompanying materials are # licensed and made available under the terms and conditions of the BSD Li= cense @@ -48,7 +48,7 @@ [LibraryClasses] DebugLib BaseLib ReportStatusCodeLib - + MemoryAllocationLib =20 [Guids] gEfiCapsuleVendorGuid ## SOMETIMES_CONSUMES ##= Variable:L"CapsuleUpdateData" @@ -56,6 +56,7 @@ [Guids] =20 [Protocols] gEfiResetArchProtocolGuid ## PRODUCES + gEfiResetNotificationProtocolGuid ## PRODUCES =20 =20 [Depex] --=20 2.12.2.windows.2 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel