IntelFsp2Pkg: Support FSP Dispatch mode

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1241

Add support for both API (original mode) and DISPATCH mode:
1. Add FspMode field from reserved byte of Global
   Data Structure to tell which mode is selected by boot
   loader. If boot loader invoking FSP-M API this field
   will remain as default 0 (API mode), otherwise platform
   FSP should set this field to 1 (Dispatch mode) when
   initializing Global Data Structure.
2. gFspInApiModePpiGuid will be instaled when FSP running in API
   mode and modules only for API mode should have this in depex.
3. If it is DISPATCH mode, FSP will return to PEI dispatcher,
   not directly return to boot loader.
4. DISPATCH mode supports DXE NotifyPhase drivers so FSP
   will not wait for PEI NotifyPhase callbacks, instead it
   will install gFspReadyForNotifyPhasePpiGuid PPI for
   platform to complete late initialization before transferring
   to DXE.

Test: Verified FSP API and DISPATCH modes on 2 internal
      platforms and both boot successfully.

Cc: Jiewen Yao <Jiewen.yao@intel.com>
Cc: Desimone Nathaniel L <nathaniel.l.desimone@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
Reviewed-by: Jiewen Yao <Jiewen.yao@intel.com>

2 files changed, 60 insertions, 40 deletions

diff --git a/IntelFsp2Pkg/Library/BaseFspCommonLib/FspCommonLib.c b/IntelFsp2Pkg/Library/BaseFspCommonLib/FspCommonLib.c
index d0128304e6..64ffba1d16 100644
--- a/IntelFsp2Pkg/Library/BaseFspCommonLib/FspCommonLib.c
+++ b/IntelFsp2Pkg/Library/BaseFspCommonLib/FspCommonLib.c
@@ -519,14 +519,16 @@ FspApiReturnStatusReset (
 

   LoopUntilReset = TRUE;

   DEBUG ((DEBUG_INFO, "FSP returning control to Bootloader with reset required return status %x\n",FspResetType));

-  ///

-  /// Below code is not an infinite loop.The control will go back to API calling function in BootLoader each time BootLoader

-  /// calls the FSP API without honoring the reset request by FSP

-  ///

-  do {

-    SetFspApiReturnStatus ((EFI_STATUS)FspResetType);

-    Pei2LoaderSwitchStack ();

-    DEBUG ((DEBUG_ERROR, "!!!ERROR: FSP has requested BootLoader for reset. But BootLoader has not honored the reset\n"));

-    DEBUG ((DEBUG_ERROR, "!!!ERROR: Please add support in BootLoader to honor the reset request from FSP\n"));

-  } while (LoopUntilReset);

+  if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {

+    ///

+    /// Below code is not an infinite loop.The control will go back to API calling function in BootLoader each time BootLoader

+    /// calls the FSP API without honoring the reset request by FSP

+    ///

+    do {

+      SetFspApiReturnStatus ((EFI_STATUS)FspResetType);

+      Pei2LoaderSwitchStack ();

+      DEBUG ((DEBUG_ERROR, "!!!ERROR: FSP has requested BootLoader for reset. But BootLoader has not honored the reset\n"));

+      DEBUG ((DEBUG_ERROR, "!!!ERROR: Please add support in BootLoader to honor the reset request from FSP\n"));

+    } while (LoopUntilReset);

+  }

 }

diff --git a/IntelFsp2Pkg/Library/BaseFspPlatformLib/FspPlatformNotify.c b/IntelFsp2Pkg/Library/BaseFspPlatformLib/FspPlatformNotify.c
index ac1fc1ac0b..cbc3b472c6 100644
--- a/IntelFsp2Pkg/Library/BaseFspPlatformLib/FspPlatformNotify.c
+++ b/IntelFsp2Pkg/Library/BaseFspPlatformLib/FspPlatformNotify.c
@@ -1,6 +1,6 @@
 /** @file

 

-  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -117,6 +117,9 @@ FspSiliconInitDone2 (
   IN EFI_STATUS Status

   )

 {

+  volatile EFI_STATUS FspStatus;

+

+  FspStatus = Status;

   //

   // Convert to FSP EAS defined API return codes

   //

@@ -139,13 +142,15 @@ FspSiliconInitDone2 (
   DEBUG ((DEBUG_INFO | DEBUG_INIT, "FspSiliconInitApi() - [Status: 0x%08X] - End\n", Status));

   PERF_END_EX (&gFspPerformanceDataGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

   REPORT_STATUS_CODE (EFI_PROGRESS_CODE, FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

-  do {

-    SetFspApiReturnStatus (Status);

-    Pei2LoaderSwitchStack ();

-    if (Status != EFI_SUCCESS) {

-      DEBUG ((DEBUG_ERROR, "!!!ERROR: FspSiliconInitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

-    }

-  } while (Status != EFI_SUCCESS);

+  if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {

+    do {

+      SetFspApiReturnStatus (Status);

+      Pei2LoaderSwitchStack ();

+      if (Status != EFI_SUCCESS) {

+        DEBUG ((DEBUG_ERROR, "!!!ERROR: FspSiliconInitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

+      }

+    } while (FspStatus != EFI_SUCCESS);

+  }

 }

 

 /**

@@ -162,6 +167,9 @@ FspMemoryInitDone2 (
   )

 {

   FSP_GLOBAL_DATA   *FspData;

+  volatile EFI_STATUS FspStatus;

+

+  FspStatus = Status;

   //

   // Calling use FspMemoryInit API

   // Update HOB and return the control directly

@@ -199,13 +207,15 @@ FspMemoryInitDone2 (
   PERF_START_EX(&gFspPerformanceDataGuid, "EventRec", NULL, (FspData->PerfData[2] & FSP_PERFORMANCE_DATA_TIMER_MASK), FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);

   PERF_END_EX(&gFspPerformanceDataGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

   REPORT_STATUS_CODE (EFI_PROGRESS_CODE, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

-  do {

-    SetFspApiReturnStatus (Status);

-    Pei2LoaderSwitchStack ();

-    if (Status != EFI_SUCCESS) {

-      DEBUG ((DEBUG_ERROR, "!!!ERROR: FspMemoryInitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

-    }

-  } while (Status != EFI_SUCCESS);

+  if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {

+    do {

+      SetFspApiReturnStatus (Status);

+      Pei2LoaderSwitchStack ();

+      if (Status != EFI_SUCCESS) {

+        DEBUG ((DEBUG_ERROR, "!!!ERROR: FspMemoryInitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

+      }

+    } while (FspStatus != EFI_SUCCESS);

+  }

 

   //

   // The TempRamExitApi is called

@@ -238,6 +248,9 @@ FspTempRamExitDone2 (
   )

 {

   //

+  volatile EFI_STATUS FspStatus;

+

+  FspStatus = Status;

   // Convert to FSP EAS defined API return codes

   //

   switch (Status) {

@@ -259,13 +272,15 @@ FspTempRamExitDone2 (
   SetFspMeasurePoint (FSP_PERF_ID_API_TEMP_RAM_EXIT_EXIT);

   PERF_END_EX(&gFspPerformanceDataGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_TEMP_RAM_EXIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

   REPORT_STATUS_CODE (EFI_PROGRESS_CODE, FSP_STATUS_CODE_TEMP_RAM_EXIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

-  do {

-    SetFspApiReturnStatus (Status);

-    Pei2LoaderSwitchStack ();

-    if (Status != EFI_SUCCESS) {

-      DEBUG ((DEBUG_ERROR, "!!!ERROR: TempRamExitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

-    }

-  } while (Status != EFI_SUCCESS);

+  if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {

+    do {

+      SetFspApiReturnStatus (Status);

+      Pei2LoaderSwitchStack ();

+      if (Status != EFI_SUCCESS) {

+        DEBUG ((DEBUG_ERROR, "!!!ERROR: TempRamExitApi() - [Status: 0x%08X] - Error encountered during previous API and cannot proceed further\n", Status));

+      }

+    } while (FspStatus != EFI_SUCCESS);

+  }

   SetPhaseStatusCode (FSP_STATUS_CODE_SILICON_INIT);

   SetFspMeasurePoint (FSP_PERF_ID_API_FSP_SILICON_INIT_ENTRY);

   PERF_START_EX(&gFspPerformanceDataGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);

@@ -289,6 +304,7 @@ FspWaitForNotify (
   UINT32                     NotificationValue;

   UINT32                     NotificationCount;

   UINT8                      Count;

+  volatile EFI_STATUS        FspStatus;

 

   NotificationCount = 0;

   while (NotificationCount < sizeof(mFspNotifySequence) / sizeof(UINT32)) {

@@ -341,15 +357,17 @@ FspWaitForNotify (
       PERF_END_EX(&gFspPerformanceDataGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_END_OF_FIRMWARE_NOTIFICATION | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

       REPORT_STATUS_CODE (EFI_PROGRESS_CODE, FSP_STATUS_CODE_END_OF_FIRMWARE_NOTIFICATION | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);

     }

-    do {

-      SetFspApiReturnStatus(Status);

-      Pei2LoaderSwitchStack();

-      if (Status != EFI_SUCCESS) {

-        DEBUG ((DEBUG_ERROR, "!!!ERROR: NotifyPhaseApi() [Phase: %08X] - Failed - [Status: 0x%08X]\n", NotificationValue, Status));

-      }

-    } while (Status != EFI_SUCCESS);

+    if (GetFspGlobalDataPointer ()->FspMode == FSP_IN_API_MODE) {

+      FspStatus = Status;

+      do {

+        SetFspApiReturnStatus(Status);

+        Pei2LoaderSwitchStack();

+        if (Status != EFI_SUCCESS) {

+          DEBUG ((DEBUG_ERROR, "!!!ERROR: NotifyPhaseApi() [Phase: %08X] - Failed - [Status: 0x%08X]\n", NotificationValue, Status));

+        }

+      } while (FspStatus != EFI_SUCCESS);

+    }

   }

-

   //

   // Control goes back to the PEI Core and it dispatches further PEIMs.

   // DXEIPL is the final one to transfer control back to the boot loader.