UefiPayloadPkg: Update PayloadLoader to suport FDT.

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

Create FDT nodes (reserved-memory, serial, pci-rb, options) in
FdtPpiNotifyCallback function right after gEfiEndOfPeiSignalPpiGuid.

Signed-off-by: Linus Liu <linus.liu@intel.com>

4 files changed, 315 insertions, 29 deletions

diff --git a/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.c b/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.c
index 8566618511..d659b75474 100644
--- a/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.c
+++ b/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.c
@@ -6,18 +6,34 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 

 #include <PiPei.h>

 #include <UniversalPayload/UniversalPayload.h>

+#include <UniversalPayload/DeviceTree.h>

 #include <Guid/UniversalPayloadBase.h>

 #include <UniversalPayload/ExtraData.h>

-

+#include <UniversalPayload/DeviceTree.h>

 #include <Ppi/LoadFile.h>

-

+#include <Library/PciHostBridgeLib.h>

+#include <Protocol/DevicePath.h>

 #include <Library/DebugLib.h>

 #include <Library/HobLib.h>

-#include <Library/PeiServicesLib.h>

 #include <Library/MemoryAllocationLib.h>

 #include <Library/BaseMemoryLib.h>

-

+#include <Library/FdtLib.h>

+#include <Library/PrintLib.h>

+#include <Library/PeiServicesLib.h>

 #include "FitLib.h"

+#define STACK_SIZE  0x20000

+

+CONST EFI_PEI_PPI_DESCRIPTOR  gReadyToPayloadSignalPpi = {

+  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),

+  &gUplReadyToPayloadPpiGuid,

+  NULL

+};

+

+EFI_PEI_PPI_DESCRIPTOR  mEndOfPeiSignalPpi = {

+  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),

+  &gEfiEndOfPeiSignalPpiGuid,

+  NULL

+};

 

 /**

   The wrapper function of PeiLoadImageLoadImage().

@@ -50,6 +66,15 @@ PeiLoadFileLoadPayload (
   UINTN                   Delta;

   UINTN                   Index;

 

+ #if (FixedPcdGetBool (PcdHandOffFdtEnable))

+  VOID                           *BaseOfStack;

+  VOID                           *TopOfStack;

+  UNIVERSAL_PAYLOAD_DEVICE_TREE  *Fdt;

+  VOID                           *Hob;

+

+  Fdt = NULL;

+ #endif

+

   Instance = 0;

   do {

     Status = PeiServicesFfsFindSectionData3 (EFI_SECTION_RAW, Instance++, FileHandle, &Binary, AuthenticationState);

@@ -66,13 +91,15 @@ PeiLoadFileLoadPayload (
     return Status;

   }

 

-  DEBUG ((

-    DEBUG_INFO,

-    "Before Rebase Payload File Base: 0x%08x, File Size: 0x%08X, EntryPoint: 0x%08x\n",

-    Context.PayloadBaseAddress,

-    Context.PayloadSize,

-    Context.PayloadEntryPoint

-    ));

+  DEBUG (

+    (

+     DEBUG_INFO,

+     "Before Rebase Payload File Base: 0x%08x, File Size: 0x%08X, EntryPoint: 0x%08x\n",

+     Context.PayloadBaseAddress,

+     Context.PayloadSize,

+     Context.PayloadEntryPoint

+    )

+    );

   Context.PayloadBaseAddress = (EFI_PHYSICAL_ADDRESS)AllocatePages (EFI_SIZE_TO_PAGES (Context.PayloadSize));

 

   RelocateTable = (FIT_RELOCATE_ITEM *)(UINTN)(Context.PayloadBaseAddress + Context.RelocateTableOffset);

@@ -96,13 +123,15 @@ PeiLoadFileLoadPayload (
     }

   }

 

-  DEBUG ((

-    DEBUG_INFO,

-    "After Rebase Payload File Base: 0x%08x, File Size: 0x%08X, EntryPoint: 0x%08x\n",

-    Context.PayloadBaseAddress,

-    Context.PayloadSize,

-    Context.PayloadEntryPoint

-    ));

+  DEBUG (

+    (

+     DEBUG_INFO,

+     "After Rebase Payload File Base: 0x%08x, File Size: 0x%08X, EntryPoint: 0x%08x\n",

+     Context.PayloadBaseAddress,

+     Context.PayloadSize,

+     Context.PayloadEntryPoint

+    )

+    );

 

   Length      = sizeof (UNIVERSAL_PAYLOAD_BASE);

   PayloadBase = BuildGuidHob (

@@ -115,6 +144,42 @@ PeiLoadFileLoadPayload (
   *ImageSizeArg    = Context.PayloadSize;

   *EntryPoint      = Context.PayloadEntryPoint;

 

+  Status = PeiServicesInstallPpi (&mEndOfPeiSignalPpi);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = PeiServicesInstallPpi (&gReadyToPayloadSignalPpi);

+  ASSERT_EFI_ERROR (Status);

+

+ #if (FixedPcdGetBool (PcdHandOffFdtEnable))

+  Hob = GetFirstGuidHob (&gUniversalPayloadDeviceTreeGuid);

+  if (Hob != NULL) {

+    Fdt =  (UNIVERSAL_PAYLOAD_DEVICE_TREE *)GET_GUID_HOB_DATA (Hob);

+  }

+

+  //

+  // Allocate 128KB for the Stack

+  //

+  BaseOfStack = AllocatePages (EFI_SIZE_TO_PAGES (STACK_SIZE));

+  ASSERT (BaseOfStack != NULL);

+

+  //

+  // Compute the top of the stack we were allocated. Pre-allocate a UINTN

+  // for safety.

+  //

+  TopOfStack = (VOID *)((UINTN)BaseOfStack + EFI_SIZE_TO_PAGES (STACK_SIZE) * EFI_PAGE_SIZE - CPU_STACK_ALIGNMENT);

+  TopOfStack = ALIGN_POINTER (TopOfStack, CPU_STACK_ALIGNMENT);

+

+  //

+  // Transfer the control to the entry point of UniveralPayloadEntry.

+  //

+  SwitchStack (

+    (SWITCH_STACK_ENTRY_POINT)(UINTN)Context.PayloadEntryPoint,

+    (VOID *)(Fdt->DeviceTreeAddress),

+    NULL,

+    TopOfStack

+    );

+ #endif

+

   return EFI_SUCCESS;

 }

 

@@ -128,11 +193,148 @@ EFI_PEI_PPI_DESCRIPTOR  gPpiLoadFilePpiList = {
   &mPeiLoadFilePpi

 };

 

+#if (FixedPcdGetBool (PcdHandOffFdtEnable))

+

+/**

+  Discover Hobs data and report data into a FDT.

+  @param[in] PeiServices       An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.

+  @param[in] NotifyDescriptor  Address of the notification descriptor data structure.

+  @param[in] Ppi               Address of the PPI that was installed.

+  @retval EFI_SUCCESS          Hobs data is discovered.

+  @return Others               No Hobs data is discovered.

+**/

+EFI_STATUS

+EFIAPI

+FdtPpiNotifyCallback (

+  IN EFI_PEI_SERVICES           **PeiServices,

+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,

+  IN VOID                       *Ppi

+  );

+

+EFI_PEI_NOTIFY_DESCRIPTOR  mReadyToPayloadNotifyList[] = {

+  {

+    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),

+    &gUplReadyToPayloadPpiGuid,

+    FdtPpiNotifyCallback

+  }

+};

+#endif

+

+/**

+  Print FDT data.

+  @param[in] FdtBase         Address of the Fdt data.

+**/

+VOID

+PrintFdt (

+  IN     VOID  *FdtBase

+  )

+{

+  UINT8   *Fdt;

+  UINT32  i;

+

+  Fdt = NULL;

+  i   = 0;

+

+  DEBUG ((DEBUG_ERROR, "FDT DTB data:"));

+  for (Fdt = FdtBase, i = 0; i < Fdt32ToCpu (((FDT_HEADER *)FdtBase)->TotalSize); i++, Fdt++) {

+    if (i % 16 == 0) {

+      DEBUG ((DEBUG_ERROR, "\n"));

+    }

+

+    DEBUG ((DEBUG_ERROR, "%02x ", *Fdt));

+  }

+

+  DEBUG ((DEBUG_ERROR, "\n"));

+}

+

+/**

+  It will build FDT for UPL consumed.

+  @param[in] FdtBase         Address of the Fdt data.

+  @retval EFI_SUCCESS        If it completed successfully.

+  @retval Others             If it failed to build required FDT.

+**/

+EFI_STATUS

+BuildFdtForUPL (

+  IN     VOID  *FdtBase

+  );

+

+#if (FixedPcdGetBool (PcdHandOffFdtEnable))

+

+/**

+  Discover Hobs data and report data into a FDT.

+  @param[in] PeiServices       An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.

+  @param[in] NotifyDescriptor  Address of the notification descriptor data structure.

+  @param[in] Ppi               Address of the PPI that was installed.

+  @retval EFI_SUCCESS          Hobs data is discovered.

+  @return Others               No Hobs data is discovered.

+**/

+EFI_STATUS

+EFIAPI

+FdtPpiNotifyCallback (

+  IN EFI_PEI_SERVICES           **PeiServices,

+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,

+  IN VOID                       *Ppi

+  )

+{

+  EFI_STATUS                     Status;

+  UNIVERSAL_PAYLOAD_DEVICE_TREE  *Fdt;

+  UINT32                         FdtSize;

+  UINTN                          FdtPages;

+  VOID                           *FdtBase;

+  UINT32                         Data32;

+

+  Fdt      = NULL;

+  FdtSize  = PcdGet8 (PcdFDTPageSize) * EFI_PAGE_SIZE;

+  FdtPages = EFI_SIZE_TO_PAGES (FdtSize);

+  FdtBase  = AllocatePages (FdtPages);

+  if (FdtBase == NULL) {

+    DEBUG ((DEBUG_ERROR, "%a: AllocatePages failed\n", __func__));

+    return EFI_NOT_FOUND;

+  }

+

+  Status = FdtCreateEmptyTree (FdtBase, (UINT32)FdtSize);

+  if (EFI_ERROR (Status)) {

+    DEBUG ((DEBUG_ERROR, "%a: cannot create FDT\n", __func__));

+  }

+

+  // Set cell property of root node

+  Data32 = CpuToFdt32 (2);

+  Status = FdtSetProp (FdtBase, 0, "#address-cells", &Data32, sizeof (UINT32));

+  Status = FdtSetProp (FdtBase, 0, "#size-cells", &Data32, sizeof (UINT32));

+

+  Status = BuildFdtForUPL (FdtBase);

+  ASSERT_EFI_ERROR (Status);

+

+  PrintFdt (FdtBase);

+

+  Fdt = BuildGuidHob (&gUniversalPayloadDeviceTreeGuid, sizeof (UNIVERSAL_PAYLOAD_DEVICE_TREE));

+  if (Fdt == NULL) {

+    DEBUG ((DEBUG_ERROR, "%a: Build FDT Hob failed\n", __func__));

+    return EFI_NOT_FOUND;

+  }

+

+  DEBUG ((

+    DEBUG_ERROR,

+    "%a: fdt at 0x%x (size %d)\n",

+    __func__,

+    FdtBase,

+    Fdt32ToCpu (((FDT_HEADER *)FdtBase)->TotalSize)

+    ));

+

+  Fdt->Header.Revision   = UNIVERSAL_PAYLOAD_DEVICE_TREE_REVISION;

+  Fdt->Header.Length     = sizeof (UNIVERSAL_PAYLOAD_DEVICE_TREE);

+  Fdt->DeviceTreeAddress = (UINT64)FdtBase;

+

+  return Status;

+}

+

+#endif

+

 /**

   Install Pei Load File PPI.

   @param  FileHandle  Handle of the file being invoked.

   @param  PeiServices Describes the list of possible PEI Services.

-  @retval EFI_SUCCESS The entry point executes successfully.

+  @retval EFI_SUCESS  The entry point executes successfully.

   @retval Others      Some error occurs during the execution of this function.

 **/

 EFI_STATUS

@@ -146,5 +348,13 @@ InitializeFitPayloadLoaderPeim (
 

   Status = PeiServicesInstallPpi (&gPpiLoadFilePpiList);

 

+ #if (FixedPcdGetBool (PcdHandOffFdtEnable))

+

+  //

+  // Build FDT in end of PEI notify callback.

+  //

+  Status = PeiServicesNotifyPpi (&mReadyToPayloadNotifyList[0]);

+  ASSERT_EFI_ERROR (Status);

+ #endif

   return Status;

 }

diff --git a/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.inf b/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.inf
index cd0cb186e1..b891706b77 100644
--- a/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.inf
+++ b/UefiPayloadPkg/PayloadLoaderPeim/FitPayloadLoaderPeim.inf
@@ -35,7 +35,6 @@
 

 [LibraryClasses]

   PcdLib

-  MemoryAllocationLib

   BaseMemoryLib

   PeiServicesLib

   HobLib

@@ -43,17 +42,27 @@
   PeimEntryPoint

   DebugLib

   FdtLib

+##for testing, remove this for HandOffFdtEnable == FALSE scenario: BuildFdtLib

+##Hook this lib to FitPayloadLoaderPeim.inf in platform DSC when HandOffFdtEnable == TRUE.

 

 [Ppis]

   gEfiPeiLoadFilePpiGuid                 ## PRODUCES

+  gUplReadyToPayloadPpiGuid              ## PRODUCES

+  gEfiEndOfPeiSignalPpiGuid              ## CONSUMES

 

 [Pcd]

   gPcAtChipsetPkgTokenSpaceGuid.PcdRtcIndexRegister

   gPcAtChipsetPkgTokenSpaceGuid.PcdRtcTargetRegister

+  gUefiPayloadPkgTokenSpaceGuid.PcdHandOffFdtEnable

+  gUefiPayloadPkgTokenSpaceGuid.PcdFDTPageSize

 

 [Guids]

-  gUniversalPayloadExtraDataGuid         ## PRODUCES

   gUniversalPayloadBaseGuid              ## PRODUCES

+  gUniversalPayloadDeviceTreeGuid        ## CONSUMES

+  gEfiGraphicsInfoHobGuid                ## CONSUMES

+  gUniversalPayloadPciRootBridgeInfoGuid ## CONSUMES

+  gUniversalPayloadAcpiTableGuid         ## CONSUMES

+  gUniversalPayloadSerialPortParentDeviceInfoGuid

 

 [Depex]

   TRUE

diff --git a/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.c b/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.c
index 219a86cfbc..cdb7c1abf2 100644
--- a/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.c
+++ b/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.c
@@ -17,9 +17,49 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Library/PeiServicesLib.h>

 #include <Library/MemoryAllocationLib.h>

 #include <Library/BaseMemoryLib.h>

-

+#include <Guid/UniversalPayloadBase.h>

 #include "ElfLib.h"

 

+CONST EFI_PEI_PPI_DESCRIPTOR  gReadyToPayloadSignalPpi = {

+  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),

+  &gUplReadyToPayloadPpiGuid,

+  NULL

+};

+

+/**

+  Notify ReadyToPayLoad signal.

+  @param[in] PeiServices       An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.

+  @param[in] NotifyDescriptor  Address of the notification descriptor data structure.

+  @param[in] Ppi               Address of the PPI that was installed.

+  @retval EFI_SUCCESS          Hobs data is discovered.

+  @return Others               No Hobs data is discovered.

+**/

+EFI_STATUS

+EFIAPI

+EndOfPeiPpiNotifyCallback (

+  IN EFI_PEI_SERVICES           **PeiServices,

+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,

+  IN VOID                       *Ppi

+  )

+{

+  EFI_STATUS  Status;

+

+  //

+  // Ready to Payload phase signal

+  //

+  Status = PeiServicesInstallPpi (&gReadyToPayloadSignalPpi);

+

+  return Status;

+}

+

+EFI_PEI_NOTIFY_DESCRIPTOR  mEndOfPeiNotifyList[] = {

+  {

+    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),

+    &gEfiEndOfPeiSignalPpiGuid,

+    EndOfPeiPpiNotifyCallback

+  }

+};

+

 /**

   The wrapper function of PeiLoadImageLoadImage().

 

@@ -47,6 +87,7 @@ PeiLoadFileLoadPayload (
   EFI_STATUS                    Status;

   VOID                          *Elf;

   UNIVERSAL_PAYLOAD_EXTRA_DATA  *ExtraData;

+  UNIVERSAL_PAYLOAD_BASE        *PayloadBase;

   ELF_IMAGE_CONTEXT             Context;

   UINT32                        Index;

   UINT16                        ExtraDataIndex;

@@ -73,13 +114,22 @@ PeiLoadFileLoadPayload (
     Status = ParseElfImage (Elf, &Context);

   } while (EFI_ERROR (Status));

 

-  DEBUG ((

-    DEBUG_INFO,

-    "Payload File Size: 0x%08X, Mem Size: 0x%08x, Reload: %d\n",

-    Context.FileSize,

-    Context.ImageSize,

-    Context.ReloadRequired

-    ));

+  Length      = sizeof (UNIVERSAL_PAYLOAD_BASE);

+  PayloadBase = BuildGuidHob (

+                  &gUniversalPayloadBaseGuid,

+                  Length

+                  );

+  PayloadBase->Entry = (EFI_PHYSICAL_ADDRESS)Context.FileBase;

+

+  DEBUG (

+    (

+     DEBUG_INFO,

+     "Payload File Size: 0x%08X, Mem Size: 0x%08x, Reload: %d\n",

+     Context.FileSize,

+     Context.ImageSize,

+     Context.ReloadRequired

+    )

+    );

 

   //

   // Get UNIVERSAL_PAYLOAD_INFO_HEADER and number of additional PLD sections.

@@ -153,6 +203,11 @@ PeiLoadFileLoadPayload (
     *ImageSizeArg    = Context.ImageSize;

   }

 

+  DEBUG ((DEBUG_INFO, "LoadElfImage :%r, EntryPoint :%x\n", Status, (UINTN)Context.EntryPoint));

+

+  Status = PeiServicesNotifyPpi (&mEndOfPeiNotifyList[0]);

+  ASSERT_EFI_ERROR (Status);

+

   return Status;

 }

 

diff --git a/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.inf b/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.inf
index 06e83dbadc..8db026eaa1 100644
--- a/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.inf
+++ b/UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.inf
@@ -52,6 +52,8 @@
 

 [Ppis]

   gEfiPeiLoadFilePpiGuid                 ## PRODUCES

+  gEfiEndOfPeiSignalPpiGuid              ## CONSUMES

+  gUplReadyToPayloadPpiGuid              ## PRODUCES

 

 [Pcd]

   gPcAtChipsetPkgTokenSpaceGuid.PcdRtcIndexRegister

@@ -59,6 +61,16 @@
 

 [Guids]

   gUniversalPayloadExtraDataGuid         ## PRODUCES

+  gUniversalPayloadBaseGuid              ## PRODUCES

 

 [Depex]

   TRUE

+

+[BuildOptions]

+  MSFT:*_*_*_CC_FLAGS = /wd4244

+  GCC:*_*_IA32_CC_FLAGS    = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast

+  GCC:*_*_X64_CC_FLAGS     = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast

+  GCC:*_*_ARM_CC_FLAGS     = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast

+  GCC:*_*_AARCH64_CC_FLAGS = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast

+  GCC:*_*_RISCV64_CC_FLAGS = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast

+  GCC:*_*_LOONGARCH64_CC_FLAGS = -Wno-error=pointer-to-int-cast -Wno-error=int-to-pointer-cast