]> git.proxmox.com Git - mirror_edk2.git/blobdiff - UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c
UefiCpuPkg/PiSmmCpuDxeSmm: patch "gSmbase" with PatchInstructionX86()
[mirror_edk2.git] / UefiCpuPkg / PiSmmCpuDxeSmm / CpuS3.c
index f26149d27a2784dac2ff8e2d0f512287affd7bff..554629536a5db5da465f24397289b30dd1a346b6 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
 Code for Processor S3 restoration\r
 \r
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\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
@@ -14,6 +14,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "PiSmmCpuDxeSmm.h"\r
 \r
+#pragma pack(1)\r
 typedef struct {\r
   UINTN             Lock;\r
   VOID              *StackStart;\r
@@ -23,7 +24,9 @@ typedef struct {
   IA32_DESCRIPTOR   IdtrProfile;\r
   UINT32            BufferStart;\r
   UINT32            Cr3;\r
+  UINTN             InitializeFloatingPointUnitsAddress;\r
 } MP_CPU_EXCHANGE_INFO;\r
+#pragma pack()\r
 \r
 typedef struct {\r
   UINT8 *RendezvousFunnelAddress;\r
@@ -39,6 +42,11 @@ typedef struct {
 //\r
 SPIN_LOCK                *mMemoryMappedLock = NULL;\r
 \r
+//\r
+// Signal that SMM BASE relocation is complete.\r
+//\r
+volatile BOOLEAN         mInitApsAfterSmmBaseReloc;\r
+\r
 /**\r
   Get starting address and size of the rendezvous entry for APs.\r
   Information for fixing a jump instruction in the code is also returned.\r
@@ -55,7 +63,7 @@ AsmGetAddressMap (
 #define LEGACY_REGION_BASE    (0xA0000 - LEGACY_REGION_SIZE)\r
 \r
 ACPI_CPU_DATA                mAcpiCpuData;\r
-UINT32                       mNumberToFinish;\r
+volatile UINT32              mNumberToFinish;\r
 MP_CPU_EXCHANGE_INFO         *mExchangeInfo;\r
 BOOLEAN                      mRestoreSmmConfigurationInS3 = FALSE;\r
 VOID                         *mGdtForAp = NULL;\r
@@ -75,6 +83,17 @@ BOOLEAN                      mSmmS3Flag = FALSE;
 //\r
 SMM_S3_RESUME_STATE          *mSmmS3ResumeState = NULL;\r
 \r
+BOOLEAN                      mAcpiS3Enable = TRUE;\r
+\r
+UINT8                        *mApHltLoopCode = NULL;\r
+UINT8                        mApHltLoopCodeTemplate[] = {\r
+                               0x8B, 0x44, 0x24, 0x04,  // mov  eax, dword ptr [esp+4]\r
+                               0xF0, 0xFF, 0x08,        // lock dec  dword ptr [eax]\r
+                               0xFA,                    // cli\r
+                               0xF4,                    // hlt\r
+                               0xEB, 0xFC               // jmp $-2\r
+                               };\r
+\r
 /**\r
   Get MSR spin lock by MSR index.\r
 \r
@@ -192,18 +211,32 @@ Returns:
 \r
   This function programs registers for the calling processor.\r
 \r
-  @param  RegisterTable Pointer to register table of the running processor.\r
+  @param  RegisterTables        Pointer to register table of the running processor.\r
+  @param  RegisterTableCount    Register table count.\r
 \r
 **/\r
 VOID\r
 SetProcessorRegister (\r
-  IN CPU_REGISTER_TABLE        *RegisterTable\r
+  IN CPU_REGISTER_TABLE        *RegisterTables,\r
+  IN UINTN                     RegisterTableCount\r
   )\r
 {\r
   CPU_REGISTER_TABLE_ENTRY  *RegisterTableEntry;\r
   UINTN                     Index;\r
   UINTN                     Value;\r
   SPIN_LOCK                 *MsrSpinLock;\r
+  UINT32                    InitApicId;\r
+  CPU_REGISTER_TABLE        *RegisterTable;\r
+\r
+  InitApicId = GetInitialApicId ();\r
+  RegisterTable = NULL;\r
+  for (Index = 0; Index < RegisterTableCount; Index++) {\r
+    if (RegisterTables[Index].InitialApicId == InitApicId) {\r
+      RegisterTable =  &RegisterTables[Index];\r
+      break;\r
+    }\r
+  }\r
+  ASSERT (RegisterTable != NULL);\r
 \r
   //\r
   // Traverse Register Table of this logical processor\r
@@ -304,7 +337,7 @@ SetProcessorRegister (
     case MemoryMapped:\r
       AcquireSpinLock (mMemoryMappedLock);\r
       MmioBitFieldWrite32 (\r
-        RegisterTableEntry->Index,\r
+        (UINTN)(RegisterTableEntry->Index | LShiftU64 (RegisterTableEntry->HighIndex, 32)),\r
         RegisterTableEntry->ValidBitStart,\r
         RegisterTableEntry->ValidBitStart + RegisterTableEntry->ValidBitLength - 1,\r
         (UINT32)RegisterTableEntry->Value\r
@@ -332,65 +365,44 @@ SetProcessorRegister (
 }\r
 \r
 /**\r
-  AP initialization before SMBASE relocation in the S3 boot path.\r
+  AP initialization before then after SMBASE relocation in the S3 boot path.\r
 **/\r
 VOID\r
-EarlyMPRendezvousProcedure (\r
+InitializeAp (\r
   VOID\r
   )\r
 {\r
-  CPU_REGISTER_TABLE         *RegisterTableList;\r
-  UINT32                     InitApicId;\r
-  UINTN                      Index;\r
+  UINTN                      TopOfStack;\r
+  UINT8                      Stack[128];\r
 \r
   LoadMtrrData (mAcpiCpuData.MtrrTable);\r
 \r
-  //\r
-  // Find processor number for this CPU.\r
-  //\r
-  RegisterTableList = (CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.PreSmmInitRegisterTable;\r
-  InitApicId = GetInitialApicId ();\r
-  for (Index = 0; Index < mAcpiCpuData.NumberOfCpus; Index++) {\r
-    if (RegisterTableList[Index].InitialApicId == InitApicId) {\r
-      SetProcessorRegister (&RegisterTableList[Index]);\r
-      break;\r
-    }\r
-  }\r
+  SetProcessorRegister ((CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.PreSmmInitRegisterTable, mAcpiCpuData.NumberOfCpus);\r
 \r
   //\r
   // Count down the number with lock mechanism.\r
   //\r
   InterlockedDecrement (&mNumberToFinish);\r
-}\r
 \r
-/**\r
-  AP initialization after SMBASE relocation in the S3 boot path.\r
-**/\r
-VOID\r
-MPRendezvousProcedure (\r
-  VOID\r
-  )\r
-{\r
-  CPU_REGISTER_TABLE         *RegisterTableList;\r
-  UINT32                     InitApicId;\r
-  UINTN                      Index;\r
+  //\r
+  // Wait for BSP to signal SMM Base relocation done.\r
+  //\r
+  while (!mInitApsAfterSmmBaseReloc) {\r
+    CpuPause ();\r
+  }\r
 \r
   ProgramVirtualWireMode ();\r
   DisableLvtInterrupts ();\r
 \r
-  RegisterTableList = (CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.RegisterTable;\r
-  InitApicId = GetInitialApicId ();\r
-  for (Index = 0; Index < mAcpiCpuData.NumberOfCpus; Index++) {\r
-    if (RegisterTableList[Index].InitialApicId == InitApicId) {\r
-      SetProcessorRegister (&RegisterTableList[Index]);\r
-      break;\r
-    }\r
-  }\r
+  SetProcessorRegister ((CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.RegisterTable, mAcpiCpuData.NumberOfCpus);\r
 \r
   //\r
-  // Count down the number with lock mechanism.\r
+  // Place AP into the safe code, count down the number with lock mechanism in the safe code.\r
   //\r
-  InterlockedDecrement (&mNumberToFinish);\r
+  TopOfStack  = (UINTN) Stack + sizeof (Stack);\r
+  TopOfStack &= ~(UINTN) (CPU_STACK_ALIGNMENT - 1);\r
+  CopyMem ((VOID *) (UINTN) mApHltLoopCode, mApHltLoopCodeTemplate, sizeof (mApHltLoopCodeTemplate));\r
+  TransferApToSafeState ((UINTN)mApHltLoopCode, TopOfStack, (UINTN)&mNumberToFinish);\r
 }\r
 \r
 /**\r
@@ -447,6 +459,7 @@ PrepareApStartupVector (
   mExchangeInfo->StackSize   = mAcpiCpuData.StackSize;\r
   mExchangeInfo->BufferStart = (UINT32) StartupVector;\r
   mExchangeInfo->Cr3         = (UINT32) (AsmReadCr3 ());\r
+  mExchangeInfo->InitializeFloatingPointUnitsAddress = (UINTN)InitializeFloatingPointUnits;\r
 }\r
 \r
 /**\r
@@ -457,34 +470,25 @@ PrepareApStartupVector (
 \r
 **/\r
 VOID\r
-EarlyInitializeCpu (\r
+InitializeCpuBeforeRebase (\r
   VOID\r
   )\r
 {\r
-  CPU_REGISTER_TABLE         *RegisterTableList;\r
-  UINT32                     InitApicId;\r
-  UINTN                      Index;\r
-\r
   LoadMtrrData (mAcpiCpuData.MtrrTable);\r
 \r
-  //\r
-  // Find processor number for this CPU.\r
-  //\r
-  RegisterTableList = (CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.PreSmmInitRegisterTable;\r
-  InitApicId = GetInitialApicId ();\r
-  for (Index = 0; Index < mAcpiCpuData.NumberOfCpus; Index++) {\r
-    if (RegisterTableList[Index].InitialApicId == InitApicId) {\r
-      SetProcessorRegister (&RegisterTableList[Index]);\r
-      break;\r
-    }\r
-  }\r
+  SetProcessorRegister ((CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.PreSmmInitRegisterTable, mAcpiCpuData.NumberOfCpus);\r
 \r
   ProgramVirtualWireMode ();\r
 \r
   PrepareApStartupVector (mAcpiCpuData.StartupVector);\r
 \r
   mNumberToFinish = mAcpiCpuData.NumberOfCpus - 1;\r
-  mExchangeInfo->ApFunction  = (VOID *) (UINTN) EarlyMPRendezvousProcedure;\r
+  mExchangeInfo->ApFunction  = (VOID *) (UINTN) InitializeAp;\r
+\r
+  //\r
+  // Execute code for before SmmBaseReloc. Note: This flag is maintained across S3 boots.\r
+  //\r
+  mInitApsAfterSmmBaseReloc = FALSE;\r
 \r
   //\r
   // Send INIT IPI - SIPI to all APs\r
@@ -504,35 +508,18 @@ EarlyInitializeCpu (
 \r
 **/\r
 VOID\r
-InitializeCpu (\r
+InitializeCpuAfterRebase (\r
   VOID\r
   )\r
 {\r
-  CPU_REGISTER_TABLE         *RegisterTableList;\r
-  UINT32                     InitApicId;\r
-  UINTN                      Index;\r
-\r
-  RegisterTableList = (CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.RegisterTable;\r
-  InitApicId = GetInitialApicId ();\r
-  for (Index = 0; Index < mAcpiCpuData.NumberOfCpus; Index++) {\r
-    if (RegisterTableList[Index].InitialApicId == InitApicId) {\r
-      SetProcessorRegister (&RegisterTableList[Index]);\r
-      break;\r
-    }\r
-  }\r
+  SetProcessorRegister ((CPU_REGISTER_TABLE *) (UINTN) mAcpiCpuData.RegisterTable, mAcpiCpuData.NumberOfCpus);\r
 \r
   mNumberToFinish = mAcpiCpuData.NumberOfCpus - 1;\r
-  //\r
-  // StackStart was updated when APs were waken up in EarlyInitializeCpu.\r
-  // Re-initialize StackAddress to original beginning address.\r
-  //\r
-  mExchangeInfo->StackStart  = (VOID *) (UINTN) mAcpiCpuData.StackAddress;\r
-  mExchangeInfo->ApFunction  = (VOID *) (UINTN) MPRendezvousProcedure;\r
 \r
   //\r
-  // Send INIT IPI - SIPI to all APs\r
+  // Signal that SMM base relocation is complete and to continue initialization.\r
   //\r
-  SendInitSipiSipiAllExcludingSelf ((UINT32)mAcpiCpuData.StartupVector);\r
+  mInitApsAfterSmmBaseReloc = TRUE;\r
 \r
   while (mNumberToFinish > 0) {\r
     CpuPause ();\r
@@ -548,6 +535,10 @@ RestoreSmmConfigurationInS3 (
   VOID\r
   )\r
 {\r
+  if (!mAcpiS3Enable) {\r
+    return;\r
+  }\r
+\r
   //\r
   // Restore SMM Configuration in S3 boot path.\r
   //\r
@@ -639,7 +630,7 @@ SmmRestoreCpu (
     //\r
     // First time microcode load and restore MTRRs\r
     //\r
-    EarlyInitializeCpu ();\r
+    InitializeCpuBeforeRebase ();\r
   }\r
 \r
   //\r
@@ -654,7 +645,7 @@ SmmRestoreCpu (
     //\r
     // Restore MSRs for BSP and all APs\r
     //\r
-    InitializeCpu ();\r
+    InitializeCpuAfterRebase ();\r
   }\r
 \r
   //\r
@@ -725,6 +716,12 @@ InitSmmS3ResumeState (
   VOID                       *GuidHob;\r
   EFI_SMRAM_DESCRIPTOR       *SmramDescriptor;\r
   SMM_S3_RESUME_STATE        *SmmS3ResumeState;\r
+  EFI_PHYSICAL_ADDRESS       Address;\r
+  EFI_STATUS                 Status;\r
+\r
+  if (!mAcpiS3Enable) {\r
+    return;\r
+  }\r
 \r
   GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);\r
   if (GuidHob != NULL) {\r
@@ -763,6 +760,20 @@ InitSmmS3ResumeState (
   // Patch SmmS3ResumeState->SmmS3Cr3\r
   //\r
   InitSmmS3Cr3 ();\r
+\r
+  //\r
+  // Allocate safe memory in ACPI NVS for AP to execute hlt loop in\r
+  // protected mode on S3 path\r
+  //\r
+  Address = BASE_4GB - 1;\r
+  Status  = gBS->AllocatePages (\r
+                   AllocateMaxAddress,\r
+                   EfiACPIMemoryNVS,\r
+                   EFI_SIZE_TO_PAGES (sizeof (mApHltLoopCodeTemplate)),\r
+                   &Address\r
+                   );\r
+  ASSERT_EFI_ERROR (Status);\r
+  mApHltLoopCode = (UINT8 *) (UINTN) Address;\r
 }\r
 \r
 /**\r
@@ -786,19 +797,23 @@ CopyRegisterTable (
 \r
   CopyMem (DestinationRegisterTableList, SourceRegisterTableList, NumberOfCpus * sizeof (CPU_REGISTER_TABLE));\r
   for (Index = 0; Index < NumberOfCpus; Index++) {\r
-    DestinationRegisterTableList[Index].RegisterTableEntry = AllocatePool (DestinationRegisterTableList[Index].AllocatedSize);\r
-    ASSERT (DestinationRegisterTableList[Index].RegisterTableEntry != NULL);\r
-    CopyMem (DestinationRegisterTableList[Index].RegisterTableEntry, SourceRegisterTableList[Index].RegisterTableEntry, DestinationRegisterTableList[Index].AllocatedSize);\r
-    //\r
-    // Go though all MSRs in register table to initialize MSR spin lock\r
-    //\r
-    RegisterTableEntry = DestinationRegisterTableList[Index].RegisterTableEntry;\r
-    for (Index1 = 0; Index1 < DestinationRegisterTableList[Index].TableLength; Index1++, RegisterTableEntry++) {\r
-      if ((RegisterTableEntry->RegisterType == Msr) && (RegisterTableEntry->ValidBitLength < 64)) {\r
-        //\r
-        // Initialize MSR spin lock only for those MSRs need bit field writing\r
-        //\r
-        InitMsrSpinLockByIndex (RegisterTableEntry->Index);\r
+    if (DestinationRegisterTableList[Index].AllocatedSize != 0) {\r
+      RegisterTableEntry = AllocateCopyPool (\r
+        DestinationRegisterTableList[Index].AllocatedSize,\r
+        (VOID *)(UINTN)SourceRegisterTableList[Index].RegisterTableEntry\r
+        );\r
+      ASSERT (RegisterTableEntry != NULL);\r
+      DestinationRegisterTableList[Index].RegisterTableEntry = (EFI_PHYSICAL_ADDRESS)(UINTN)RegisterTableEntry;\r
+      //\r
+      // Go though all MSRs in register table to initialize MSR spin lock\r
+      //\r
+      for (Index1 = 0; Index1 < DestinationRegisterTableList[Index].TableLength; Index1++, RegisterTableEntry++) {\r
+        if ((RegisterTableEntry->RegisterType == Msr) && (RegisterTableEntry->ValidBitLength < 64)) {\r
+          //\r
+          // Initialize MSR spin lock only for those MSRs need bit field writing\r
+          //\r
+          InitMsrSpinLockByIndex (RegisterTableEntry->Index);\r
+        }\r
       }\r
     }\r
   }\r
@@ -817,6 +832,10 @@ GetAcpiCpuData (
   IA32_DESCRIPTOR            *Gdtr;\r
   IA32_DESCRIPTOR            *Idtr;\r
 \r
+  if (!mAcpiS3Enable) {\r
+    return;\r
+  }\r
+\r
   //\r
   // Prevent use of mAcpiCpuData by initialize NumberOfCpus to 0\r
   //\r
@@ -883,3 +902,15 @@ GetAcpiCpuData (
   CopyMem (mIdtForAp, (VOID *)Idtr->Base, Idtr->Limit + 1);\r
   CopyMem (mMachineCheckHandlerForAp, (VOID *)(UINTN)mAcpiCpuData.ApMachineCheckHandlerBase, mAcpiCpuData.ApMachineCheckHandlerSize);\r
 }\r
+\r
+/**\r
+  Get ACPI S3 enable flag.\r
+\r
+**/\r
+VOID\r
+GetAcpiS3EnableFlag (\r
+  VOID\r
+  )\r
+{\r
+  mAcpiS3Enable = PcdGetBool (PcdAcpiS3Enable);\r
+}\r