]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
MdeModulePkg: Use new added Perf macros
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCore.c
index a0b295b31af642f64165eb6ce0fb0b4e0cbaeaf8..45f40e0e60c7839ee731114a7b430d16a631094e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   SMM Core Main Entry Point\r
 \r
-  Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\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
@@ -71,6 +71,12 @@ EFI_SMM_SYSTEM_TABLE2  gSmmCoreSmst = {
 //\r
 BOOLEAN  mInLegacyBoot = FALSE;\r
 \r
+//\r
+// Flag to determine if it is during S3 resume.\r
+// It will be set in S3 entry callback and cleared at EndOfS3Resume.\r
+//\r
+BOOLEAN  mDuringS3Resume = FALSE;\r
+\r
 //\r
 // Table of SMI Handlers that are registered by the SMM Core when it is initialized\r
 //\r
@@ -81,7 +87,8 @@ SMM_CORE_SMI_HANDLERS  mSmmCoreSmiHandlers[] = {
   { SmmExitBootServicesHandler, &gEfiEventExitBootServicesGuid,      NULL, FALSE },\r
   { SmmReadyToBootHandler,      &gEfiEventReadyToBootGuid,           NULL, FALSE },\r
   { SmmEndOfDxeHandler,         &gEfiEndOfDxeEventGroupGuid,         NULL, TRUE },\r
-  { SmmEndOfS3ResumeHandler,    &gEdkiiSmmEndOfS3ResumeProtocolGuid, NULL, FALSE },\r
+  { SmmS3SmmInitDoneHandler,    &gEdkiiS3SmmInitDoneGuid,            NULL, FALSE },\r
+  { SmmEndOfS3ResumeHandler,    &gEdkiiEndOfS3ResumeGuid,            NULL, FALSE },\r
   { NULL,                       NULL,                                NULL, FALSE }\r
 };\r
 \r
@@ -151,6 +158,7 @@ SmmLegacyBootHandler (
 {\r
   EFI_STATUS    Status;\r
   EFI_HANDLE    SmmHandle;\r
+  UINTN         Index;\r
 \r
   //\r
   // Install SMM Legacy Boot protocol.\r
@@ -167,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
@@ -195,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
@@ -209,9 +228,50 @@ 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
+/**\r
+  Main entry point for an SMM handler dispatch or communicate-based callback.\r
+\r
+  @param[in]     DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
+  @param[in]     Context         Points to an optional handler context which was specified when the\r
+                                 handler was registered.\r
+  @param[in,out] 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[in,out] CommBufferSize  The size of the CommBuffer.\r
+\r
+  @retval EFI_SUCCESS                         The interrupt was handled and quiesced. No other handlers\r
+                                              should still be called.\r
+  @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED  The interrupt has been quiesced but other handlers should\r
+                                              still be called.\r
+  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING   The interrupt is still pending and other handlers should still\r
+                                              be called.\r
+  @retval EFI_INTERRUPT_PENDING               The interrupt could not be quiesced.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SmmS3EntryCallBack (\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
+  mDuringS3Resume = TRUE;\r
+  return EFI_SUCCESS;\r
+}\r
+\r
 /**\r
   Software SMI handler that is called when an Ready To Boot event is signalled.\r
   Then the SMM Core also install SMM Ready To Boot protocol to notify SMM driver\r
@@ -235,8 +295,8 @@ SmmReadyToBootHandler (
   IN OUT UINTN       *CommBufferSize  OPTIONAL\r
   )\r
 {\r
-  EFI_STATUS    Status;\r
-  EFI_HANDLE    SmmHandle;\r
+  EFI_STATUS                        Status;\r
+  EFI_HANDLE                        SmmHandle;\r
 \r
   //\r
   // Install SMM Ready To Boot protocol.\r
@@ -366,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
@@ -380,11 +444,95 @@ 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
 /**\r
-  Software SMI handler that is called when the EndOfS3Resume event is trigged.\r
+  Software SMI handler that is called when the EndOfS3Resume signal is triggered.\r
   This function installs the SMM EndOfS3Resume Protocol so SMM Drivers are informed that\r
   S3 resume has finished.\r
 \r
@@ -409,7 +557,12 @@ SmmEndOfS3ResumeHandler (
   EFI_STATUS  Status;\r
   EFI_HANDLE  SmmHandle;\r
 \r
-  DEBUG ((EFI_D_INFO, "SmmEndOfS3ResumeHandler\n"));\r
+  DEBUG ((DEBUG_INFO, "SmmEndOfS3ResumeHandler\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 EndOfS3Resume protocol\r
@@ -417,23 +570,24 @@ SmmEndOfS3ResumeHandler (
   SmmHandle = NULL;\r
   Status = SmmInstallProtocolInterface (\r
              &SmmHandle,\r
-             &gEdkiiSmmEndOfS3ResumeProtocolGuid,\r
+             &gEdkiiEndOfS3ResumeGuid,\r
              EFI_NATIVE_INTERFACE,\r
              NULL\r
              );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
   //\r
-  // Uninstall the protocol here because the comsume just hook the\r
+  // Uninstall the protocol here because the comsumer just hook the\r
   // installation event.\r
   //\r
   Status = SmmUninstallProtocolInterface (\r
            SmmHandle,\r
-           &gEdkiiSmmEndOfS3ResumeProtocolGuid,\r
+           &gEdkiiEndOfS3ResumeGuid,\r
            NULL\r
            );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  mDuringS3Resume = FALSE;\r
   return Status;\r
 }\r
 \r
@@ -490,7 +644,7 @@ SmmEntryPoint (
   VOID                        *CommunicationBuffer;\r
   UINTN                       BufferSize;\r
 \r
-  PERF_START (NULL, "SMM", NULL, 0) ;\r
+  PERF_INMODULE_BEGIN ("SMM");\r
 \r
   //\r
   // Update SMST with contents of the SmmEntryContext structure\r
@@ -506,11 +660,11 @@ SmmEntryPoint (
   //\r
   PlatformHookBeforeSmmDispatch ();\r
 \r
-  //
-  // Call memory management hook function
-  //
-  SmmEntryPointMemoryManagementHook ();
-
+  //\r
+  // Call memory management hook function\r
+  //\r
+  SmmEntryPointMemoryManagementHook ();\r
+\r
   //\r
   // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed\r
   //\r
@@ -544,7 +698,7 @@ SmmEntryPoint (
         // return EFI_INVALID_PARAMETER\r
         //\r
         gSmmCorePrivate->CommunicationBuffer = NULL;\r
-        gSmmCorePrivate->ReturnStatus = EFI_INVALID_PARAMETER;\r
+        gSmmCorePrivate->ReturnStatus = EFI_ACCESS_DENIED;\r
       } else {\r
         CommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)CommunicationBuffer;\r
         BufferSize -= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data);\r
@@ -585,7 +739,7 @@ SmmEntryPoint (
     gSmmCorePrivate->InSmm = FALSE;\r
   }\r
 \r
-  PERF_END (NULL, "SMM", NULL, 0) ;\r
+  PERF_INMODULE_END ("SMM");\r
 }\r
 \r
 /**\r
@@ -704,7 +858,7 @@ SmmMain (
   //\r
   gSmmCorePrivate->Smst          = &gSmmCoreSmst;\r
   gSmmCorePrivate->SmmEntryPoint = SmmEntryPoint;\r
-
+\r
   //\r
   // No need to initialize memory service.\r
   // It is done in constructor of PiSmmCoreMemoryAllocationLib(),\r