]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
MdeModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / PiSmmCore.c
index 45f40e0e60c7839ee731114a7b430d16a631094e..b5676f21bf26502bc3f7402265dbde39f2e63a14 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
   SMM Core Main Entry Point\r
 \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
+  Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -65,7 +59,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
@@ -77,16 +71,29 @@ BOOLEAN  mInLegacyBoot = FALSE;
 //\r
 BOOLEAN  mDuringS3Resume = FALSE;\r
 \r
+//\r
+// Flag to determine if platform enabled S3.\r
+// Get the value from PcdAcpiS3Enable.\r
+//\r
+BOOLEAN  mAcpiS3Enable = FALSE;\r
+\r
 //\r
 // Table of SMI Handlers that are registered by the SMM Core when it is initialized\r
 //\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
+  { NULL,                       NULL,                                NULL, FALSE }\r
+};\r
+\r
+//\r
+// Table of SMI Handlers that are registered by the SMM Core when it is initialized\r
+//\r
+SMM_CORE_SMI_HANDLERS  mSmmCoreS3SmiHandlers[] = {\r
   { SmmS3SmmInitDoneHandler,    &gEdkiiS3SmmInitDoneGuid,            NULL, FALSE },\r
   { SmmEndOfS3ResumeHandler,    &gEdkiiEndOfS3ResumeGuid,            NULL, FALSE },\r
   { NULL,                       NULL,                                NULL, FALSE }\r
@@ -132,7 +139,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
@@ -316,9 +323,9 @@ SmmReadyToBootHandler (
 \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
@@ -445,28 +452,30 @@ SmmEndOfDxeHandler (
              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
+  if (mAcpiS3Enable) {\r
     //\r
-    // Register a S3 entry callback function to\r
-    // determine if it will be during S3 resume.\r
+    // Locate SmmSxDispatch2 protocol.\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
+    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
 \r
   return EFI_SUCCESS;\r
@@ -644,8 +653,6 @@ SmmEntryPoint (
   VOID                        *CommunicationBuffer;\r
   UINTN                       BufferSize;\r
 \r
-  PERF_INMODULE_BEGIN ("SMM");\r
-\r
   //\r
   // Update SMST with contents of the SmmEntryContext structure\r
   //\r
@@ -676,7 +683,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
@@ -703,9 +710,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
@@ -723,7 +730,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
@@ -738,8 +745,6 @@ SmmEntryPoint (
     //\r
     gSmmCorePrivate->InSmm = FALSE;\r
   }\r
-\r
-  PERF_INMODULE_END ("SMM");\r
 }\r
 \r
 /**\r
@@ -826,7 +831,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
@@ -887,6 +892,21 @@ SmmMain (
     ASSERT_EFI_ERROR (Status);\r
   }\r
 \r
+  mAcpiS3Enable = PcdGetBool (PcdAcpiS3Enable);\r
+  if (mAcpiS3Enable) {\r
+    //\r
+    // Register all S3 related SMI Handlers required by the SMM Core\r
+    //\r
+    for (Index = 0; mSmmCoreS3SmiHandlers[Index].HandlerType != NULL; Index++) {\r
+      Status = SmiHandlerRegister (\r
+                 mSmmCoreS3SmiHandlers[Index].Handler,\r
+                 mSmmCoreS3SmiHandlers[Index].HandlerType,\r
+                 &mSmmCoreS3SmiHandlers[Index].DispatchHandle\r
+                 );\r
+      ASSERT_EFI_ERROR (Status);\r
+    }\r
+  }\r
+\r
   RegisterSmramProfileHandler ();\r
   SmramProfileInstallProtocol ();\r
 \r