/** @file\r
Reset Architectural and Reset Notification protocols implementation.\r
\r
- Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
\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
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "ResetSystem.h"\r
\r
+GLOBAL_REMOVE_IF_UNREFERENCED CHAR16 *mResetTypeStr[] = {\r
+ L"Cold", L"Warm", L"Shutdown", L"PlatformSpecific"\r
+};\r
+\r
+//\r
+// The current ResetSystem() notification recursion depth\r
+//\r
+UINTN mResetNotifyDepth = 0;\r
+\r
/**\r
Register a notification function to be called when ResetSystem() is called.\r
\r
EFI_STATUS\r
EFIAPI\r
RegisterResetNotify (\r
- IN EFI_RESET_NOTIFICATION_PROTOCOL *This,\r
- IN EFI_RESET_SYSTEM ResetFunction\r
+ IN EFI_RESET_NOTIFICATION_PROTOCOL *This,\r
+ IN EFI_RESET_SYSTEM ResetFunction\r
)\r
{\r
- RESET_NOTIFICATION_INSTANCE *Instance;\r
- LIST_ENTRY *Link;\r
- RESET_NOTIFY_ENTRY *Entry;\r
+ RESET_NOTIFICATION_INSTANCE *Instance;\r
+ LIST_ENTRY *Link;\r
+ RESET_NOTIFY_ENTRY *Entry;\r
\r
if (ResetFunction == NULL) {\r
return EFI_INVALID_PARAMETER;\r
Instance = RESET_NOTIFICATION_INSTANCE_FROM_THIS (This);\r
\r
for ( Link = GetFirstNode (&Instance->ResetNotifies)\r
- ; !IsNull (&Instance->ResetNotifies, Link)\r
- ; Link = GetNextNode (&Instance->ResetNotifies, Link)\r
- ) {\r
+ ; !IsNull (&Instance->ResetNotifies, Link)\r
+ ; Link = GetNextNode (&Instance->ResetNotifies, Link)\r
+ )\r
+ {\r
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
if (Entry->ResetNotify == ResetFunction) {\r
return EFI_ALREADY_STARTED;\r
if (Entry == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
+\r
Entry->Signature = RESET_NOTIFY_ENTRY_SIGNATURE;\r
Entry->ResetNotify = ResetFunction;\r
InsertTailList (&Instance->ResetNotifies, &Entry->Link);\r
EFI_STATUS\r
EFIAPI\r
UnregisterResetNotify (\r
- IN EFI_RESET_NOTIFICATION_PROTOCOL *This,\r
- IN EFI_RESET_SYSTEM ResetFunction\r
+ IN EFI_RESET_NOTIFICATION_PROTOCOL *This,\r
+ IN EFI_RESET_SYSTEM ResetFunction\r
)\r
{\r
- RESET_NOTIFICATION_INSTANCE *Instance;\r
- LIST_ENTRY *Link;\r
- RESET_NOTIFY_ENTRY *Entry;\r
+ RESET_NOTIFICATION_INSTANCE *Instance;\r
+ LIST_ENTRY *Link;\r
+ RESET_NOTIFY_ENTRY *Entry;\r
\r
if (ResetFunction == NULL) {\r
return EFI_INVALID_PARAMETER;\r
Instance = RESET_NOTIFICATION_INSTANCE_FROM_THIS (This);\r
\r
for ( Link = GetFirstNode (&Instance->ResetNotifies)\r
- ; !IsNull (&Instance->ResetNotifies, Link)\r
- ; Link = GetNextNode (&Instance->ResetNotifies, Link)\r
- ) {\r
+ ; !IsNull (&Instance->ResetNotifies, Link)\r
+ ; Link = GetNextNode (&Instance->ResetNotifies, Link)\r
+ )\r
+ {\r
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
if (Entry->ResetNotify == ResetFunction) {\r
RemoveEntryList (&Entry->Link);\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
-RESET_NOTIFICATION_INSTANCE mResetNotification = {\r
+RESET_NOTIFICATION_INSTANCE mResetNotification = {\r
RESET_NOTIFICATION_INSTANCE_SIGNATURE,\r
{\r
RegisterResetNotify,\r
INITIALIZE_LIST_HEAD_VARIABLE (mResetNotification.ResetNotifies)\r
};\r
\r
+RESET_NOTIFICATION_INSTANCE mPlatformSpecificResetFilter = {\r
+ RESET_NOTIFICATION_INSTANCE_SIGNATURE,\r
+ {\r
+ RegisterResetNotify,\r
+ UnregisterResetNotify\r
+ },\r
+ INITIALIZE_LIST_HEAD_VARIABLE (mPlatformSpecificResetFilter.ResetNotifies)\r
+};\r
+\r
+RESET_NOTIFICATION_INSTANCE mPlatformSpecificResetHandler = {\r
+ RESET_NOTIFICATION_INSTANCE_SIGNATURE,\r
+ {\r
+ RegisterResetNotify,\r
+ UnregisterResetNotify\r
+ },\r
+ INITIALIZE_LIST_HEAD_VARIABLE (mPlatformSpecificResetHandler.ResetNotifies)\r
+};\r
+\r
/**\r
The driver's entry point.\r
\r
It initializes the Reset Architectural Protocol.\r
\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
+ @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
@param[in] SystemTable A pointer to the EFI System Table.\r
- \r
+\r
@retval EFI_SUCCESS The entry point is executed successfully.\r
@retval other Cannot install ResetArch protocol.\r
\r
//\r
// Hook the runtime service table\r
//\r
- gRT->ResetSystem = ResetSystem;\r
+ gRT->ResetSystem = RuntimeServiceResetSystem;\r
\r
//\r
// Now install the Reset RT AP on a new handle\r
Handle = NULL;\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
&Handle,\r
- &gEfiResetArchProtocolGuid, NULL,\r
- &gEfiResetNotificationProtocolGuid, &mResetNotification.ResetNotification,\r
+ &gEfiResetArchProtocolGuid,\r
+ NULL,\r
+ &gEfiResetNotificationProtocolGuid,\r
+ &mResetNotification.ResetNotification,\r
+ &gEdkiiPlatformSpecificResetFilterProtocolGuid,\r
+ &mPlatformSpecificResetFilter.ResetNotification,\r
+ &gEdkiiPlatformSpecificResetHandlerProtocolGuid,\r
+ &mPlatformSpecificResetHandler.ResetNotification,\r
NULL\r
);\r
ASSERT_EFI_ERROR (Status);\r
return Status;\r
}\r
\r
-/**\r
- Put the system into S3 power state. \r
-**/\r
-VOID\r
-DoS3 (\r
- VOID\r
- )\r
-{\r
- EnterS3WithImmediateWake ();\r
-\r
- //\r
- // Should not return\r
- //\r
- CpuDeadLoop ();\r
-}\r
-\r
/**\r
Resets the entire platform.\r
\r
EfiResetShutdown the data buffer starts with a Null-terminated\r
string, optionally followed by additional binary data.\r
The string is a description that the caller may use to further\r
- indicate the reason for the system reset. ResetData is only\r
- valid if ResetStatus is something other than EFI_SUCCESS\r
- unless the ResetType is EfiResetPlatformSpecific\r
- where a minimum amount of ResetData is always required.\r
+ indicate the reason for the system reset.\r
For a ResetType of EfiResetPlatformSpecific the data buffer\r
also starts with a Null-terminated string that is followed\r
by an EFI_GUID that describes the specific type of reset to perform.\r
**/\r
VOID\r
EFIAPI\r
-ResetSystem (\r
- IN EFI_RESET_TYPE ResetType,\r
- IN EFI_STATUS ResetStatus,\r
- IN UINTN DataSize,\r
- IN VOID *ResetData OPTIONAL\r
+RuntimeServiceResetSystem (\r
+ IN EFI_RESET_TYPE ResetType,\r
+ IN EFI_STATUS ResetStatus,\r
+ IN UINTN DataSize,\r
+ IN VOID *ResetData OPTIONAL\r
)\r
{\r
- EFI_STATUS Status;\r
- UINTN Size;\r
- UINTN CapsuleDataPtr;\r
LIST_ENTRY *Link;\r
RESET_NOTIFY_ENTRY *Entry;\r
- \r
+\r
//\r
- // Indicate reset system runtime service is called.\r
+ // Only do REPORT_STATUS_CODE() on first call to RuntimeServiceResetSystem()\r
//\r
- REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_EFI_RUNTIME_SERVICE | EFI_SW_RS_PC_RESET_SYSTEM));\r
-\r
- if (!EfiAtRuntime ()) {\r
- for ( Link = GetFirstNode (&mResetNotification.ResetNotifies)\r
- ; !IsNull (&mResetNotification.ResetNotifies, Link)\r
- ; Link = GetNextNode (&mResetNotification.ResetNotifies, Link)\r
- ) {\r
- Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
- Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);\r
- }\r
+ if (mResetNotifyDepth == 0) {\r
+ //\r
+ // Indicate reset system runtime service is called.\r
+ //\r
+ REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_EFI_RUNTIME_SERVICE | EFI_SW_RS_PC_RESET_SYSTEM));\r
}\r
\r
- switch (ResetType) {\r
- case EfiResetWarm:\r
+ mResetNotifyDepth++;\r
+ DEBUG ((\r
+ DEBUG_INFO,\r
+ "DXE ResetSystem2: ResetType %s, Call Depth = %d.\n",\r
+ mResetTypeStr[ResetType],\r
+ mResetNotifyDepth\r
+ ));\r
+\r
+ if (mResetNotifyDepth <= MAX_RESET_NOTIFY_DEPTH) {\r
+ if (!EfiAtRuntime ()) {\r
+ //\r
+ // Call reset notification functions registered through the\r
+ // EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PROTOCOL.\r
+ //\r
+ for ( Link = GetFirstNode (&mPlatformSpecificResetFilter.ResetNotifies)\r
+ ; !IsNull (&mPlatformSpecificResetFilter.ResetNotifies, Link)\r
+ ; Link = GetNextNode (&mPlatformSpecificResetFilter.ResetNotifies, Link)\r
+ )\r
+ {\r
+ Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
+ Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);\r
+ }\r
\r
- //\r
- //Check if there are pending capsules to process\r
- //\r
- Size = sizeof (CapsuleDataPtr);\r
- Status = EfiGetVariable (\r
- EFI_CAPSULE_VARIABLE_NAME,\r
- &gEfiCapsuleVendorGuid,\r
- NULL,\r
- &Size,\r
- (VOID *) &CapsuleDataPtr\r
- );\r
-\r
- if (Status == EFI_SUCCESS) {\r
//\r
- //Process capsules across a system reset.\r
+ // Call reset notification functions registered through the\r
+ // EFI_RESET_NOTIFICATION_PROTOCOL.\r
//\r
- DoS3();\r
+ for ( Link = GetFirstNode (&mResetNotification.ResetNotifies)\r
+ ; !IsNull (&mResetNotification.ResetNotifies, Link)\r
+ ; Link = GetNextNode (&mResetNotification.ResetNotifies, Link)\r
+ )\r
+ {\r
+ Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
+ Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);\r
+ }\r
+\r
+ //\r
+ // call reset notification functions registered through the\r
+ // EDKII_PLATFORM_SPECIFIC_RESET_HANDLER_PROTOCOL.\r
+ //\r
+ for ( Link = GetFirstNode (&mPlatformSpecificResetHandler.ResetNotifies)\r
+ ; !IsNull (&mPlatformSpecificResetHandler.ResetNotifies, Link)\r
+ ; Link = GetNextNode (&mPlatformSpecificResetHandler.ResetNotifies, Link)\r
+ )\r
+ {\r
+ Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);\r
+ Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);\r
+ }\r
}\r
+ } else {\r
+ ASSERT (ResetType < ARRAY_SIZE (mResetTypeStr));\r
+ DEBUG ((DEBUG_ERROR, "DXE ResetSystem2: Maximum reset call depth is met. Use the current reset type: %s!\n", mResetTypeStr[ResetType]));\r
+ }\r
\r
- ResetWarm ();\r
+ switch (ResetType) {\r
+ case EfiResetWarm:\r
\r
- break;\r
+ ResetWarm ();\r
+ break;\r
\r
- case EfiResetCold:\r
- ResetCold ();\r
- break;\r
+ case EfiResetCold:\r
+ ResetCold ();\r
+ break;\r
\r
- case EfiResetShutdown:\r
- ResetShutdown ();\r
- return ;\r
+ case EfiResetShutdown:\r
+ ResetShutdown ();\r
+ return;\r
\r
- case EfiResetPlatformSpecific:\r
- ResetPlatformSpecific (DataSize, ResetData);\r
- return;\r
+ case EfiResetPlatformSpecific:\r
+ ResetPlatformSpecific (DataSize, ResetData);\r
+ return;\r
\r
- default:\r
- return ;\r
+ default:\r
+ return;\r
}\r
\r
//\r