]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
MdeModulePkg/S3SmmInitDone.h: Fix copyright coding style error.
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCore.c
index 4aef9b70a1d0111b1fbdf8d3602996ab44ab74c6..d0bc65b5644e35b18c1793ca31e83910f2659ec8 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   SMM Core Main Entry Point\r
 \r
-  Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials are licensed and made available \r
-  under the terms and conditions of the BSD License which accompanies this \r
-  distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available\r
+  under the terms and conditions of the BSD License which accompanies this\r
+  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
+  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
 \r
 **/\r
 \r
@@ -65,7 +65,7 @@ EFI_SMM_SYSTEM_TABLE2  gSmmCoreSmst = {
 \r
 //\r
 // Flag to determine if the platform has performed a legacy boot.\r
-// If this flag is TRUE, then the runtime code and runtime data associated with the \r
+// If this flag is TRUE, then the runtime code and runtime data associated with the\r
 // SMM IPL are converted to free memory, so the SMM Core must guarantee that is\r
 // does not touch of the code/data associated with the SMM IPL if this flag is TRUE.\r
 //\r
@@ -82,11 +82,12 @@ BOOLEAN  mDuringS3Resume = FALSE;
 //\r
 SMM_CORE_SMI_HANDLERS  mSmmCoreSmiHandlers[] = {\r
   { SmmDriverDispatchHandler,   &gEfiEventDxeDispatchGuid,           NULL, TRUE  },\r
-  { SmmReadyToLockHandler,      &gEfiDxeSmmReadyToLockProtocolGuid,  NULL, TRUE }, \r
+  { SmmReadyToLockHandler,      &gEfiDxeSmmReadyToLockProtocolGuid,  NULL, TRUE },\r
   { SmmLegacyBootHandler,       &gEfiEventLegacyBootGuid,            NULL, FALSE },\r
   { SmmExitBootServicesHandler, &gEfiEventExitBootServicesGuid,      NULL, FALSE },\r
   { SmmReadyToBootHandler,      &gEfiEventReadyToBootGuid,           NULL, FALSE },\r
   { SmmEndOfDxeHandler,         &gEfiEndOfDxeEventGroupGuid,         NULL, TRUE },\r
+  { SmmS3SmmInitDoneHandler,    &gEdkiiS3SmmInitDoneGuid,            NULL, FALSE },\r
   { SmmEndOfS3ResumeHandler,    &gEdkiiEndOfS3ResumeGuid,            NULL, FALSE },\r
   { NULL,                       NULL,                                NULL, FALSE }\r
 };\r
@@ -131,7 +132,7 @@ SmmEfiNotAvailableYetArg5 (
 \r
 /**\r
   Software SMI handler that is called when a Legacy Boot event is signalled.  The SMM\r
-  Core uses this signal to know that a Legacy Boot has been performed and that \r
+  Core uses this signal to know that a Legacy Boot has been performed and that\r
   gSmmCorePrivate that is shared between the UEFI and SMM execution environments can\r
   not be accessed from SMM anymore since that structure is considered free memory by\r
   a legacy OS. Then the SMM Core also install SMM Legacy Boot protocol to notify SMM\r
@@ -157,6 +158,7 @@ SmmLegacyBootHandler (
 {\r
   EFI_STATUS    Status;\r
   EFI_HANDLE    SmmHandle;\r
+  UINTN         Index;\r
 \r
   //\r
   // Install SMM Legacy Boot protocol.\r
@@ -173,6 +175,16 @@ SmmLegacyBootHandler (
 \r
   SmiHandlerUnRegister (DispatchHandle);\r
 \r
+  //\r
+  // It is legacy boot, unregister ExitBootService SMI handler.\r
+  //\r
+  for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
+    if (CompareGuid (mSmmCoreSmiHandlers[Index].HandlerType, &gEfiEventExitBootServicesGuid)) {\r
+      SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
+      break;\r
+    }\r
+  }\r
+\r
   return Status;\r
 }\r
 \r
@@ -201,6 +213,7 @@ SmmExitBootServicesHandler (
 {\r
   EFI_STATUS    Status;\r
   EFI_HANDLE    SmmHandle;\r
+  UINTN         Index;\r
 \r
   //\r
   // Install SMM Exit Boot Services protocol.\r
@@ -215,6 +228,16 @@ SmmExitBootServicesHandler (
 \r
   SmiHandlerUnRegister (DispatchHandle);\r
 \r
+  //\r
+  // It is UEFI boot, unregister LegacyBoot SMI handler.\r
+  //\r
+  for (Index = 0; mSmmCoreSmiHandlers[Index].HandlerType != NULL; Index++) {\r
+    if (CompareGuid (mSmmCoreSmiHandlers[Index].HandlerType, &gEfiEventLegacyBootGuid)) {\r
+      SmiHandlerUnRegister (mSmmCoreSmiHandlers[Index].DispatchHandle);\r
+      break;\r
+    }\r
+  }\r
+\r
   return Status;\r
 }\r
 \r
@@ -274,9 +297,6 @@ SmmReadyToBootHandler (
 {\r
   EFI_STATUS                        Status;\r
   EFI_HANDLE                        SmmHandle;\r
-  EFI_SMM_SX_DISPATCH2_PROTOCOL     *SxDispatch;\r
-  EFI_SMM_SX_REGISTER_CONTEXT       EntryRegisterContext;\r
-  EFI_HANDLE                        S3EntryHandle;\r
 \r
   //\r
   // Install SMM Ready To Boot protocol.\r
@@ -291,38 +311,14 @@ SmmReadyToBootHandler (
 \r
   SmiHandlerUnRegister (DispatchHandle);\r
 \r
-  //\r
-  // Locate SmmSxDispatch2 protocol.\r
-  //\r
-  Status = SmmLocateProtocol (\r
-             &gEfiSmmSxDispatch2ProtocolGuid,\r
-             NULL,\r
-             &SxDispatch\r
-             );\r
-  if (!EFI_ERROR (Status)) {\r
-    //\r
-    // Register a S3 entry callback function to\r
-    // determine if it will be during S3 resume.\r
-    //\r
-    EntryRegisterContext.Type  = SxS3;\r
-    EntryRegisterContext.Phase = SxEntry;\r
-    Status = SxDispatch->Register (\r
-                           SxDispatch,\r
-                           SmmS3EntryCallBack,\r
-                           &EntryRegisterContext,\r
-                           &S3EntryHandle\r
-                           );\r
-    ASSERT_EFI_ERROR (Status);\r
-  }\r
-\r
-  return EFI_SUCCESS;\r
+  return Status;\r
 }\r
 \r
 /**\r
   Software SMI handler that is called when the DxeSmmReadyToLock protocol is added\r
-  or if gEfiEventReadyToBootGuid is signalled.  This function unregisters the \r
-  Software SMIs that are nor required after SMRAM is locked and installs the \r
-  SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about \r
+  or if gEfiEventReadyToBootGuid is signalled.  This function unregisters the\r
+  Software SMIs that are nor required after SMRAM is locked and installs the\r
+  SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about\r
   to be locked.  It also verifies the SMM CPU I/O 2 Protocol has been installed\r
   and NULLs gBS and gST because they can not longer be used after SMRAM is locked.\r
 \r
@@ -430,10 +426,14 @@ SmmEndOfDxeHandler (
   IN OUT UINTN       *CommBufferSize  OPTIONAL\r
   )\r
 {\r
-  EFI_STATUS  Status;\r
-  EFI_HANDLE  SmmHandle;\r
+  EFI_STATUS                        Status;\r
+  EFI_HANDLE                        SmmHandle;\r
+  EFI_SMM_SX_DISPATCH2_PROTOCOL     *SxDispatch;\r
+  EFI_SMM_SX_REGISTER_CONTEXT       EntryRegisterContext;\r
+  EFI_HANDLE                        S3EntryHandle;\r
 \r
   DEBUG ((EFI_D_INFO, "SmmEndOfDxeHandler\n"));\r
+\r
   //\r
   // Install SMM EndOfDxe protocol\r
   //\r
@@ -444,6 +444,90 @@ SmmEndOfDxeHandler (
              EFI_NATIVE_INTERFACE,\r
              NULL\r
              );\r
+\r
+  //\r
+  // Locate SmmSxDispatch2 protocol.\r
+  //\r
+  Status = SmmLocateProtocol (\r
+             &gEfiSmmSxDispatch2ProtocolGuid,\r
+             NULL,\r
+             (VOID **)&SxDispatch\r
+             );\r
+  if (!EFI_ERROR (Status) && (SxDispatch != NULL)) {\r
+    //\r
+    // Register a S3 entry callback function to\r
+    // determine if it will be during S3 resume.\r
+    //\r
+    EntryRegisterContext.Type  = SxS3;\r
+    EntryRegisterContext.Phase = SxEntry;\r
+    Status = SxDispatch->Register (\r
+                           SxDispatch,\r
+                           SmmS3EntryCallBack,\r
+                           &EntryRegisterContext,\r
+                           &S3EntryHandle\r
+                           );\r
+    ASSERT_EFI_ERROR (Status);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Software SMI handler that is called when the S3SmmInitDone signal is triggered.\r
+  This function installs the SMM S3SmmInitDone Protocol so SMM Drivers are informed that\r
+  S3 SMM initialization has been done.\r
+\r
+  @param  DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
+  @param  Context         Points to an optional handler context which was specified when the handler was registered.\r
+  @param  CommBuffer      A pointer to a collection of data in memory that will\r
+                          be conveyed from a non-SMM environment into an SMM environment.\r
+  @param  CommBufferSize  The size of the CommBuffer.\r
+\r
+  @return Status Code\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SmmS3SmmInitDoneHandler (\r
+  IN     EFI_HANDLE  DispatchHandle,\r
+  IN     CONST VOID  *Context,        OPTIONAL\r
+  IN OUT VOID        *CommBuffer,     OPTIONAL\r
+  IN OUT UINTN       *CommBufferSize  OPTIONAL\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  EFI_HANDLE  SmmHandle;\r
+\r
+  DEBUG ((DEBUG_INFO, "SmmS3SmmInitDoneHandler\n"));\r
+\r
+  if (!mDuringS3Resume) {\r
+    DEBUG ((DEBUG_ERROR, "It is not during S3 resume\n"));\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  //\r
+  // Install SMM S3SmmInitDone protocol\r
+  //\r
+  SmmHandle = NULL;\r
+  Status = SmmInstallProtocolInterface (\r
+             &SmmHandle,\r
+             &gEdkiiS3SmmInitDoneGuid,\r
+             EFI_NATIVE_INTERFACE,\r
+             NULL\r
+             );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  //\r
+  // Uninstall the protocol here because the comsumer just hook the\r
+  // installation event.\r
+  //\r
+  Status = SmmUninstallProtocolInterface (\r
+           SmmHandle,\r
+           &gEdkiiS3SmmInitDoneGuid,\r
+           NULL\r
+           );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   return Status;\r
 }\r
 \r
@@ -504,7 +588,6 @@ SmmEndOfS3ResumeHandler (
   ASSERT_EFI_ERROR (Status);\r
 \r
   mDuringS3Resume = FALSE;\r
-\r
   return Status;\r
 }\r
 \r
@@ -561,8 +644,6 @@ SmmEntryPoint (
   VOID                        *CommunicationBuffer;\r
   UINTN                       BufferSize;\r
 \r
-  PERF_START (NULL, "SMM", NULL, 0) ;\r
-\r
   //\r
   // Update SMST with contents of the SmmEntryContext structure\r
   //\r
@@ -593,7 +674,7 @@ SmmEntryPoint (
     gSmmCorePrivate->InSmm = TRUE;\r
 \r
     //\r
-    // Check to see if this is a Synchronous SMI sent through the SMM Communication \r
+    // Check to see if this is a Synchronous SMI sent through the SMM Communication\r
     // Protocol or an Asynchronous SMI\r
     //\r
     CommunicationBuffer = gSmmCorePrivate->CommunicationBuffer;\r
@@ -620,9 +701,9 @@ SmmEntryPoint (
         CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)CommunicationBuffer;\r
         BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
         Status = SmiManage (\r
-                   &CommunicateHeader->HeaderGuid, \r
-                   NULL, \r
-                   CommunicateHeader->Data, \r
+                   &CommunicateHeader->HeaderGuid,\r
+                   NULL,\r
+                   CommunicateHeader->Data,\r
                    &BufferSize\r
                    );\r
         //\r
@@ -640,7 +721,7 @@ SmmEntryPoint (
   // Process Asynchronous SMI sources\r
   //\r
   SmiManage (NULL, NULL, NULL, NULL);\r
-  \r
+\r
   //\r
   // Call platform hook after Smm Dispatch\r
   //\r
@@ -655,8 +736,6 @@ SmmEntryPoint (
     //\r
     gSmmCorePrivate->InSmm = FALSE;\r
   }\r
-\r
-  PERF_END (NULL, "SMM", NULL, 0) ;\r
 }\r
 \r
 /**\r
@@ -743,7 +822,7 @@ SmmCoreInstallLoadedImage (
 /**\r
   The Entry Point for SMM Core\r
 \r
-  Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core \r
+  Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core\r
   EntryPoint on the SMI vector.\r
 \r
   Note: This function is called for both DXE invocation and SMRAM invocation.\r