UefiCpuPkg/PiSmmCpuDxe: code refinement for CpuS3.c

This commit is code logic refinement for s3 boot flow
in CpuS3.c. It doesn't change any code functionality.
This commit implementes InitializeAp and InitializeBsp
as a single function since they are doing almost the
same thing. Then both BSP and AP will execute the same
function InitializeCpuProcedure to do CPU initialization.
This can make the code logic easier to understand.

Signed-off-by: Dun Tan <dun.tan@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>

1 files changed, 138 insertions, 128 deletions

diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c b/UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c
index 0f7ee0372d..b9dbeaef87 100644
--- a/UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c
+++ b/UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c
@@ -539,44 +539,149 @@ SetRegister (
 }

 

 /**

-  AP initialization before then after SMBASE relocation in the S3 boot path.

+  The function is invoked before SMBASE relocation in S3 path to restores CPU status.

+

+  The function is invoked before SMBASE relocation in S3 path. It does first time microcode load

+  and restores MTRRs for both BSP and APs.

+

+  @param   IsBsp   The CPU this function executes on is BSP or not.

+

 **/

 VOID

-InitializeAp (

-  VOID

+InitializeCpuBeforeRebase (

+  IN BOOLEAN  IsBsp

   )

 {

-  UINTN  TopOfStack;

-  UINT8  Stack[128];

-

   LoadMtrrData (mAcpiCpuData.MtrrTable);

 

   SetRegister (TRUE);

 

+  ProgramVirtualWireMode ();

+  if (!IsBsp) {

+    DisableLvtInterrupts ();

+  }

+

   //

   // Count down the number with lock mechanism.

   //

   InterlockedDecrement (&mNumberToFinish);

 

+  if (IsBsp) {

+    //

+    // Bsp wait here till all AP finish the initialization before rebase

+    //

+    while (mNumberToFinish > 0) {

+      CpuPause ();

+    }

+  }

+}

+

+/**

+  The function is invoked after SMBASE relocation in S3 path to restores CPU status.

+

+  The function is invoked after SMBASE relocation in S3 path. It restores configuration according to

+  data saved by normal boot path for both BSP and APs.

+

+  @param   IsBsp   The CPU this function executes on is BSP or not.

+

+**/

+VOID

+InitializeCpuAfterRebase (

+  IN BOOLEAN  IsBsp

+  )

+{

+  UINTN  TopOfStack;

+  UINT8  Stack[128];

+

+  SetRegister (FALSE);

+  if (IsBsp) {

+    while (mNumberToFinish > 0) {

+      CpuPause ();

+    }

+  } else {

+    //

+    // Place AP into the safe code, count down the number with lock mechanism in the safe code.

+    //

+    TopOfStack  = (UINTN)Stack + sizeof (Stack);

+    TopOfStack &= ~(UINTN)(CPU_STACK_ALIGNMENT - 1);

+    CopyMem ((VOID *)(UINTN)mApHltLoopCode, mApHltLoopCodeTemplate, sizeof (mApHltLoopCodeTemplate));

+    TransferApToSafeState ((UINTN)mApHltLoopCode, TopOfStack, (UINTN)&mNumberToFinish);

+  }

+}

+

+/**

+  Cpu initialization procedure.

+

+  @param[in,out] Buffer  The pointer to private data buffer.

+

+**/

+VOID

+EFIAPI

+InitializeCpuProcedure (

+  IN OUT VOID  *Buffer

+  )

+{

+  BOOLEAN  IsBsp;

+

+  IsBsp =  (BOOLEAN)(mBspApicId == GetApicId ());

+

   //

-  // Wait for BSP to signal SMM Base relocation done.

+  // Skip initialization if mAcpiCpuData is not valid

   //

-  while (!mInitApsAfterSmmBaseReloc) {

-    CpuPause ();

+  if (mAcpiCpuData.NumberOfCpus > 0) {

+    //

+    // First time microcode load and restore MTRRs

+    //

+    InitializeCpuBeforeRebase (IsBsp);

   }

 

-  ProgramVirtualWireMode ();

-  DisableLvtInterrupts ();

+  if (IsBsp) {

+    DEBUG ((DEBUG_INFO, "SmmRestoreCpu: mSmmRelocated is %d\n", mSmmRelocated));

 

-  SetRegister (FALSE);

+    //

+    // Check whether Smm Relocation is done or not.

+    // If not, will do the SmmBases Relocation here!!!

+    //

+    if (!mSmmRelocated) {

+      //

+      // Restore SMBASE for BSP and all APs

+      //

+      SmmRelocateBases ();

+    } else {

+      //

+      // Issue SMI IPI (All Excluding  Self SMM IPI + BSP SMM IPI) to execute first SMI init.

+      //

+      ExecuteFirstSmiInit ();

+    }

+  }

 

   //

-  // Place AP into the safe code, count down the number with lock mechanism in the safe code.

+  // Skip initialization if mAcpiCpuData is not valid

   //

-  TopOfStack  = (UINTN)Stack + sizeof (Stack);

-  TopOfStack &= ~(UINTN)(CPU_STACK_ALIGNMENT - 1);

-  CopyMem ((VOID *)(UINTN)mApHltLoopCode, mApHltLoopCodeTemplate, sizeof (mApHltLoopCodeTemplate));

-  TransferApToSafeState ((UINTN)mApHltLoopCode, TopOfStack, (UINTN)&mNumberToFinish);

+  if (mAcpiCpuData.NumberOfCpus > 0) {

+    if (IsBsp) {

+      //

+      // mNumberToFinish should be set before AP executes InitializeCpuAfterRebase()

+      //

+      mNumberToFinish = (UINT32)(mNumberOfCpus - 1);

+      //

+      // Signal that SMM base relocation is complete and to continue initialization for all APs.

+      //

+      mInitApsAfterSmmBaseReloc = TRUE;

+    } else {

+      //

+      // AP Wait for BSP to signal SMM Base relocation done.

+      //

+      while (!mInitApsAfterSmmBaseReloc) {

+        CpuPause ();

+      }

+    }

+

+    //

+    // Restore MSRs for BSP and all APs

+    //

+    InitializeCpuAfterRebase (IsBsp);

+  }

 }

 

 /**

@@ -627,91 +732,7 @@ PrepareApStartupVector (
   mExchangeInfo->BufferStart                         = (UINT32)StartupVector;

   mExchangeInfo->Cr3                                 = (UINT32)(AsmReadCr3 ());

   mExchangeInfo->InitializeFloatingPointUnitsAddress = (UINTN)InitializeFloatingPointUnits;

-}

-

-/**

-  The function is invoked before SMBASE relocation in S3 path to restores CPU status.

-

-  The function is invoked before SMBASE relocation in S3 path. It does first time microcode load

-  and restores MTRRs for both BSP and APs.

-

-**/

-VOID

-InitializeCpuBeforeRebase (

-  VOID

-  )

-{

-  LoadMtrrData (mAcpiCpuData.MtrrTable);

-

-  SetRegister (TRUE);

-

-  ProgramVirtualWireMode ();

-

-  PrepareApStartupVector (mAcpiCpuData.StartupVector);

-

-  if (FeaturePcdGet (PcdCpuHotPlugSupport)) {

-    ASSERT (mNumberOfCpus <= mAcpiCpuData.NumberOfCpus);

-  } else {

-    ASSERT (mNumberOfCpus == mAcpiCpuData.NumberOfCpus);

-  }

-

-  mNumberToFinish           = (UINT32)(mNumberOfCpus - 1);

-  mExchangeInfo->ApFunction = (VOID *)(UINTN)InitializeAp;

-

-  //

-  // Execute code for before SmmBaseReloc. Note: This flag is maintained across S3 boots.

-  //

-  mInitApsAfterSmmBaseReloc = FALSE;

-

-  //

-  // Send INIT IPI - SIPI to all APs

-  //

-  SendInitSipiSipiAllExcludingSelf ((UINT32)mAcpiCpuData.StartupVector);

-

-  while (mNumberToFinish > 0) {

-    CpuPause ();

-  }

-}

-

-/**

-  The function is invoked after SMBASE relocation in S3 path to restores CPU status.

-

-  The function is invoked after SMBASE relocation in S3 path. It restores configuration according to

-  data saved by normal boot path for both BSP and APs.

-

-**/

-VOID

-InitializeCpuAfterRebase (

-  VOID

-  )

-{

-  if (FeaturePcdGet (PcdCpuHotPlugSupport)) {

-    ASSERT (mNumberOfCpus <= mAcpiCpuData.NumberOfCpus);

-  } else {

-    ASSERT (mNumberOfCpus == mAcpiCpuData.NumberOfCpus);

-  }

-

-  mNumberToFinish = (UINT32)(mNumberOfCpus - 1);

-

-  //

-  // Signal that SMM base relocation is complete and to continue initialization for all APs.

-  //

-  mInitApsAfterSmmBaseReloc = TRUE;

-

-  //

-  // Must begin set register after all APs have continue their initialization.

-  // This is a requirement to support semaphore mechanism in register table.

-  // Because if semaphore's dependence type is package type, semaphore will wait

-  // for all Aps in one package finishing their tasks before set next register

-  // for all APs. If the Aps not begin its task during BSP doing its task, the

-  // BSP thread will hang because it is waiting for other Aps in the same

-  // package finishing their task.

-  //

-  SetRegister (FALSE);

-

-  while (mNumberToFinish > 0) {

-    CpuPause ();

-  }

+  mExchangeInfo->ApFunction                          = (VOID *)(UINTN)InitializeCpuProcedure;

 }

 

 /**

@@ -813,44 +834,33 @@ SmmRestoreCpu (
     InitializeDebugAgent (DEBUG_AGENT_INIT_THUNK_PEI_IA32TOX64, (VOID *)&Ia32Idtr, NULL);

   }

 

+  mBspApicId = GetApicId ();

   //

-  // Skip initialization if mAcpiCpuData is not valid

+  // Skip AP initialization if mAcpiCpuData is not valid

   //

   if (mAcpiCpuData.NumberOfCpus > 0) {

-    //

-    // First time microcode load and restore MTRRs

-    //

-    InitializeCpuBeforeRebase ();

-  }

+    if (FeaturePcdGet (PcdCpuHotPlugSupport)) {

+      ASSERT (mNumberOfCpus <= mAcpiCpuData.NumberOfCpus);

+    } else {

+      ASSERT (mNumberOfCpus == mAcpiCpuData.NumberOfCpus);

+    }

 

-  DEBUG ((DEBUG_INFO, "SmmRestoreCpu: mSmmRelocated is %d\n", mSmmRelocated));

+    mNumberToFinish = (UINT32)mNumberOfCpus;

 

-  //

-  // Check whether Smm Relocation is done or not.

-  // If not, will do the SmmBases Relocation here!!!

-  //

-  if (!mSmmRelocated) {

     //

-    // Restore SMBASE for BSP and all APs

+    // Execute code for before SmmBaseReloc. Note: This flag is maintained across S3 boots.

     //

-    SmmRelocateBases ();

-  } else {

-    //

-    // Issue SMI IPI (All Excluding  Self SMM IPI + BSP SMM IPI) to execute first SMI init.

-    //

-    ExecuteFirstSmiInit ();

-  }

+    mInitApsAfterSmmBaseReloc = FALSE;

 

-  //

-  // Skip initialization if mAcpiCpuData is not valid

-  //

-  if (mAcpiCpuData.NumberOfCpus > 0) {

+    PrepareApStartupVector (mAcpiCpuData.StartupVector);

     //

-    // Restore MSRs for BSP and all APs

+    // Send INIT IPI - SIPI to all APs

     //

-    InitializeCpuAfterRebase ();

+    SendInitSipiSipiAllExcludingSelf ((UINT32)mAcpiCpuData.StartupVector);

   }

 

+  InitializeCpuProcedure (NULL);

+

   //

   // Set a flag to restore SMM configuration in S3 path.

   //