[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeLoad.c

/** @file\r
  Last PEIM.\r
  Responsibility of this module is to load the DXE Core from a Firmware Volume.\r
\r
Copyright (c) 2016 HP Development Company, L.P.\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "DxeIpl.h"\r
\r
\r
//\r
// Module Globals used in the DXE to PEI hand off\r
// These must be module globals, so the stack can be switched\r
//\r
CONST EFI_DXE_IPL_PPI mDxeIplPpi = {\r
  DxeLoadCore\r
};\r
\r
CONST EFI_PEI_PPI_DESCRIPTOR mDxeIplPpiList = {\r
  EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
  &gEfiDxeIplPpiGuid,\r
  (VOID *) &mDxeIplPpi\r
};\r
\r
CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomGuidedSectionExtractionPpi = {\r
  CustomGuidedSectionExtract\r
};\r
\r
CONST EFI_PEI_DECOMPRESS_PPI mDecompressPpi = {\r
  Decompress\r
};\r
\r
CONST EFI_PEI_PPI_DESCRIPTOR mDecompressPpiList = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiDecompressPpiGuid,\r
  (VOID *) &mDecompressPpi\r
};\r
\r
CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiEndOfPeiSignalPpiGuid,\r
  NULL\r
};\r
\r
CONST EFI_PEI_NOTIFY_DESCRIPTOR mMemoryDiscoveredNotifyList = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMemoryDiscoveredPpiGuid,\r
  InstallIplPermanentMemoryPpis\r
};\r
\r
/**\r
  Entry point of DXE IPL PEIM.\r
\r
  This function installs DXE IPL PPI.  It also reloads\r
  itself to memory on non-S3 resume boot path.\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCESS  The entry point of DXE IPL PEIM executes successfully.\r
  @retval Others      Some error occurs during the execution of this function.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  EFI_STATUS                                Status;\r
  EFI_BOOT_MODE                             BootMode;\r
  VOID                                      *Dummy;\r
\r
  BootMode = GetBootModeHob ();\r
\r
  if (BootMode != BOOT_ON_S3_RESUME) {\r
    Status = PeiServicesRegisterForShadow (FileHandle);\r
    if (Status == EFI_SUCCESS) {\r
      //\r
      // EFI_SUCESS means it is the first time to call register for shadow.\r
      //\r
      return Status;\r
    }\r
\r
    //\r
    // Ensure that DXE IPL is shadowed to permanent memory.\r
    //\r
    ASSERT (Status == EFI_ALREADY_STARTED);\r
\r
    //\r
    // DXE core load requires permanent memory.\r
    //\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiMemoryDiscoveredPpiGuid,\r
               0,\r
               NULL,\r
               (VOID **) &Dummy\r
               );\r
    ASSERT_EFI_ERROR (Status);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Now the permanent memory exists, install the PPIs for decompression\r
    // and section extraction.\r
    //\r
    Status = InstallIplPermanentMemoryPpis (NULL, NULL, NULL);\r
    ASSERT_EFI_ERROR (Status);\r
  } else {\r
    //\r
    // Install memory discovered PPI notification to install PPIs for\r
    // decompression and section extraction.\r
    //\r
    Status = PeiServicesNotifyPpi (&mMemoryDiscoveredNotifyList);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // Install DxeIpl PPI.\r
  //\r
  Status = PeiServicesInstallPpi (&mDxeIplPpiList);\r
  ASSERT_EFI_ERROR(Status);\r
\r
  return Status;\r
}\r
\r
/**\r
   This function installs the PPIs that require permanent memory.\r
\r
   @param  PeiServices      Indirect reference to the PEI Services Table.\r
   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
   @param  Ppi              Address of the PPI that was installed.\r
\r
   @return EFI_SUCCESS      The PPIs were installed successfully.\r
   @return Others           Some error occurs during the execution of this function.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InstallIplPermanentMemoryPpis (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
  IN VOID                       *Ppi\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_GUID                      *ExtractHandlerGuidTable;\r
  UINTN                         ExtractHandlerNumber;\r
  EFI_PEI_PPI_DESCRIPTOR        *GuidPpi;\r
\r
  //\r
  // Get custom extract guided section method guid list\r
  //\r
  ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
\r
  //\r
  // Install custom guided section extraction PPI\r
  //\r
  if (ExtractHandlerNumber > 0) {\r
    GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePool (ExtractHandlerNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
    ASSERT (GuidPpi != NULL);\r
    while (ExtractHandlerNumber-- > 0) {\r
      GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
      GuidPpi->Ppi   = (VOID *) &mCustomGuidedSectionExtractionPpi;\r
      GuidPpi->Guid  = &ExtractHandlerGuidTable[ExtractHandlerNumber];\r
      Status = PeiServicesInstallPpi (GuidPpi++);\r
      ASSERT_EFI_ERROR(Status);\r
    }\r
  }\r
\r
  //\r
  // Install Decompress PPI.\r
  //\r
  Status = PeiServicesInstallPpi (&mDecompressPpiList);\r
  ASSERT_EFI_ERROR(Status);\r
\r
  return Status;\r
}\r
\r
/**\r
   Validate variable data for the MemoryTypeInformation.\r
\r
   @param MemoryData       Variable data.\r
   @param MemoryDataSize   Variable data length.\r
\r
   @return TRUE            The variable data is valid.\r
   @return FALSE           The variable data is invalid.\r
\r
**/\r
BOOLEAN\r
ValidateMemoryTypeInfoVariable (\r
  IN EFI_MEMORY_TYPE_INFORMATION      *MemoryData,\r
  IN UINTN                            MemoryDataSize\r
  )\r
{\r
  UINTN                       Count;\r
  UINTN                       Index;\r
\r
  // Check the input parameter.\r
  if (MemoryData == NULL) {\r
    return FALSE;\r
  }\r
\r
  // Get Count\r
  Count = MemoryDataSize / sizeof (*MemoryData);\r
\r
  // Check Size\r
  if (Count * sizeof(*MemoryData) != MemoryDataSize) {\r
    return FALSE;\r
  }\r
\r
  // Check last entry type filed.\r
  if (MemoryData[Count - 1].Type != EfiMaxMemoryType) {\r
    return FALSE;\r
  }\r
\r
  // Check the type filed.\r
  for (Index = 0; Index < Count - 1; Index++) {\r
    if (MemoryData[Index].Type >= EfiMaxMemoryType) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
   Main entry point to last PEIM.\r
\r
   This function finds DXE Core in the firmware volume and transfer the control to\r
   DXE core.\r
\r
   @param This          Entry point for DXE IPL PPI.\r
   @param PeiServices   General purpose services available to every PEIM.\r
   @param HobList       Address to the Pei HOB list.\r
\r
   @return EFI_SUCCESS              DXE core was successfully loaded.\r
   @return EFI_OUT_OF_RESOURCES     There are not enough resources to load DXE core.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeLoadCore (\r
  IN CONST EFI_DXE_IPL_PPI *This,\r
  IN EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_PEI_HOB_POINTERS  HobList\r
  )\r
{\r
  EFI_STATUS                                Status;\r
  EFI_FV_FILE_INFO                          DxeCoreFileInfo;\r
  EFI_PHYSICAL_ADDRESS                      DxeCoreAddress;\r
  UINT64                                    DxeCoreSize;\r
  EFI_PHYSICAL_ADDRESS                      DxeCoreEntryPoint;\r
  EFI_BOOT_MODE                             BootMode;\r
  EFI_PEI_FILE_HANDLE                       FileHandle;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI           *Variable;\r
  EFI_PEI_LOAD_FILE_PPI                     *LoadFile;\r
  UINTN                                     Instance;\r
  UINT32                                    AuthenticationState;\r
  UINTN                                     DataSize;\r
  EFI_PEI_S3_RESUME2_PPI                    *S3Resume;\r
  EFI_PEI_RECOVERY_MODULE_PPI               *PeiRecovery;\r
  EFI_MEMORY_TYPE_INFORMATION               MemoryData[EfiMaxMemoryType + 1];\r
\r
  //\r
  // if in S3 Resume, restore configure\r
  //\r
  BootMode = GetBootModeHob ();\r
\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiS3Resume2PpiGuid,\r
               0,\r
               NULL,\r
               (VOID **) &S3Resume\r
               );\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Report Status code that S3Resume PPI can not be found\r
      //\r
      REPORT_STATUS_CODE (\r
        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_RESUME_PPI_NOT_FOUND)\r
        );\r
    }\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = S3Resume->S3RestoreConfig2 (S3Resume);\r
    ASSERT_EFI_ERROR (Status);\r
  } else if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_RECOVERY_BEGIN));\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiRecoveryModulePpiGuid,\r
               0,\r
               NULL,\r
               (VOID **) &PeiRecovery\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "Locate Recovery PPI Failed.(Status = %r)\n", Status));\r
      //\r
      // Report Status code the failure of locating Recovery PPI\r
      //\r
      REPORT_STATUS_CODE (\r
        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_RECOVERY_PPI_NOT_FOUND)\r
        );\r
      CpuDeadLoop ();\r
    }\r
\r
    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_LOAD));\r
    Status = PeiRecovery->LoadRecoveryCapsule (PeiServices, PeiRecovery);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "Load Recovery Capsule Failed.(Status = %r)\n", Status));\r
      //\r
      // Report Status code that recovery image can not be found\r
      //\r
      REPORT_STATUS_CODE (\r
        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_NO_RECOVERY_CAPSULE)\r
        );\r
      CpuDeadLoop ();\r
    }\r
    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_START));\r
    //\r
    // Now should have a HOB with the DXE core\r
    //\r
  }\r
\r
  if (GetFirstGuidHob ((CONST EFI_GUID *)&gEfiMemoryTypeInformationGuid) == NULL) {\r
    //\r
    // Don't build GuidHob if GuidHob has been installed.\r
    //\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiReadOnlyVariable2PpiGuid,\r
               0,\r
               NULL,\r
               (VOID **)&Variable\r
               );\r
    if (!EFI_ERROR (Status)) {\r
      DataSize = sizeof (MemoryData);\r
      Status = Variable->GetVariable (\r
                           Variable,\r
                           EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
                           &gEfiMemoryTypeInformationGuid,\r
                           NULL,\r
                           &DataSize,\r
                           &MemoryData\r
                           );\r
      if (!EFI_ERROR (Status) && ValidateMemoryTypeInfoVariable(MemoryData, DataSize)) {\r
        //\r
        // Build the GUID'd HOB for DXE\r
        //\r
        BuildGuidDataHob (\r
          &gEfiMemoryTypeInformationGuid,\r
          MemoryData,\r
          DataSize\r
          );\r
      }\r
    }\r
  }\r
\r
  //\r
  // Look in all the FVs present in PEI and find the DXE Core FileHandle\r
  //\r
  FileHandle = DxeIplFindDxeCore ();\r
\r
  //\r
  // Load the DXE Core from a Firmware Volume.\r
  //\r
  Instance = 0;\r
  do {\r
    Status = PeiServicesLocatePpi (&gEfiPeiLoadFilePpiGuid, Instance++, NULL, (VOID **) &LoadFile);\r
    //\r
    // These must exist an instance of EFI_PEI_LOAD_FILE_PPI to support to load DxeCore file handle successfully.\r
    //\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = LoadFile->LoadFile (\r
                         LoadFile,\r
                         FileHandle,\r
                         &DxeCoreAddress,\r
                         &DxeCoreSize,\r
                         &DxeCoreEntryPoint,\r
                         &AuthenticationState\r
                         );\r
  } while (EFI_ERROR (Status));\r
\r
  //\r
  // Get the DxeCore File Info from the FileHandle for the DxeCore GUID file name.\r
  //\r
  Status = PeiServicesFfsGetFileInfo (FileHandle, &DxeCoreFileInfo);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Add HOB for the DXE Core\r
  //\r
  BuildModuleHob (\r
    &DxeCoreFileInfo.FileName,\r
    DxeCoreAddress,\r
    ALIGN_VALUE (DxeCoreSize, EFI_PAGE_SIZE),\r
    DxeCoreEntryPoint\r
    );\r
\r
  //\r
  // Report Status Code EFI_SW_PEI_PC_HANDOFF_TO_NEXT\r
  //\r
  REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_CORE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT));\r
\r
  DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Loading DXE CORE at 0x%11p EntryPoint=0x%11p\n", (VOID *)(UINTN)DxeCoreAddress, FUNCTION_ENTRY_POINT (DxeCoreEntryPoint)));\r
\r
  //\r
  // Transfer control to the DXE Core\r
  // The hand off state is simply a pointer to the HOB list\r
  //\r
  HandOffToDxeCore (DxeCoreEntryPoint, HobList);\r
  //\r
  // If we get here, then the DXE Core returned.  This is an error\r
  // DxeCore should not return.\r
  //\r
  ASSERT (FALSE);\r
  CpuDeadLoop ();\r
\r
  return EFI_OUT_OF_RESOURCES;\r
}\r
\r
\r
/**\r
   Searches DxeCore in all firmware Volumes and loads the first\r
   instance that contains DxeCore.\r
\r
   @return FileHandle of DxeCore to load DxeCore.\r
\r
**/\r
EFI_PEI_FILE_HANDLE\r
DxeIplFindDxeCore (\r
  VOID\r
  )\r
{\r
  EFI_STATUS            Status;\r
  UINTN                 Instance;\r
  EFI_PEI_FV_HANDLE     VolumeHandle;\r
  EFI_PEI_FILE_HANDLE   FileHandle;\r
\r
  Instance    = 0;\r
  while (TRUE) {\r
    //\r
    // Traverse all firmware volume instances\r
    //\r
    Status = PeiServicesFfsFindNextVolume (Instance, &VolumeHandle);\r
    //\r
    // If some error occurs here, then we cannot find any firmware\r
    // volume that may contain DxeCore.\r
    //\r
    if (EFI_ERROR (Status)) {\r
      REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_EC_DXE_CORRUPT));\r
    }\r
    ASSERT_EFI_ERROR (Status);\r
\r
    //\r
    // Find the DxeCore file type from the beginning in this firmware volume.\r
    //\r
    FileHandle = NULL;\r
    Status = PeiServicesFfsFindNextFile (EFI_FV_FILETYPE_DXE_CORE, VolumeHandle, &FileHandle);\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // Find DxeCore FileHandle in this volume, then we skip other firmware volume and\r
      // return the FileHandle.\r
      //\r
      return FileHandle;\r
    }\r
    //\r
    // We cannot find DxeCore in this firmware volume, then search the next volume.\r
    //\r
    Instance++;\r
  }\r
}\r
\r
\r
\r
/**\r
  The ExtractSection() function processes the input section and\r
  returns a pointer to the section contents. If the section being\r
  extracted does not require processing (if the section\r
  GuidedSectionHeader.Attributes has the\r
  EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
  OutputBuffer is just updated to point to the start of the\r
  section's contents. Otherwise, *Buffer must be allocated\r
  from PEI permanent memory.\r
\r
  @param This                   Indicates the\r
                                EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
                                Buffer containing the input GUIDed section to be\r
                                processed. OutputBuffer OutputBuffer is\r
                                allocated from PEI permanent memory and contains\r
                                the new section stream.\r
  @param InputSection           A pointer to the input buffer, which contains\r
                                the input section to be processed.\r
  @param OutputBuffer           A pointer to a caller-allocated buffer, whose\r
                                size is specified by the contents of OutputSize.\r
  @param OutputSize             A pointer to a caller-allocated\r
                                UINTN in which the size of *OutputBuffer\r
                                allocation is stored. If the function\r
                                returns anything other than EFI_SUCCESS,\r
                                the value of OutputSize is undefined.\r
  @param AuthenticationStatus   A pointer to a caller-allocated\r
                                UINT32 that indicates the\r
                                authentication status of the\r
                                output buffer. If the input\r
                                section's GuidedSectionHeader.\r
                                Attributes field has the\r
                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID\r
                                bit as clear,\r
                                AuthenticationStatus must return\r
                                zero. These bits reflect the\r
                                status of the extraction\r
                                operation. If the function\r
                                returns anything other than\r
                                EFI_SUCCESS, the value of\r
                                AuthenticationStatus is\r
                                undefined.\r
\r
  @retval EFI_SUCCESS           The InputSection was\r
                                successfully processed and the\r
                                section contents were returned.\r
\r
  @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                resources to process the request.\r
\r
  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
                                not match this instance of the\r
                                GUIDed Section Extraction PPI.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CustomGuidedSectionExtract (\r
  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
  IN CONST  VOID                                  *InputSection,\r
  OUT       VOID                                  **OutputBuffer,\r
  OUT       UINTN                                 *OutputSize,\r
  OUT       UINT32                                *AuthenticationStatus\r
)\r
{\r
  EFI_STATUS      Status;\r
  UINT8           *ScratchBuffer;\r
  UINT32          ScratchBufferSize;\r
  UINT32          OutputBufferSize;\r
  UINT16          SectionAttribute;\r
\r
  //\r
  // Init local variable\r
  //\r
  ScratchBuffer = NULL;\r
\r
  //\r
  // Call GetInfo to get the size and attribute of input guided section data.\r
  //\r
  Status = ExtractGuidedSectionGetInfo (\r
             InputSection,\r
             &OutputBufferSize,\r
             &ScratchBufferSize,\r
             &SectionAttribute\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "GetInfo from guided section Failed - %r\n", Status));\r
    return Status;\r
  }\r
\r
  if (ScratchBufferSize != 0) {\r
    //\r
    // Allocate scratch buffer\r
    //\r
    ScratchBuffer = AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize));\r
    if (ScratchBuffer == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  }\r
\r
  if (((SectionAttribute & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) != 0) && OutputBufferSize > 0) {\r
    //\r
    // Allocate output buffer\r
    //\r
    *OutputBuffer = AllocatePages (EFI_SIZE_TO_PAGES (OutputBufferSize));\r
    if (*OutputBuffer == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    DEBUG ((DEBUG_INFO, "Customized Guided section Memory Size required is 0x%x and address is 0x%p\n", OutputBufferSize, *OutputBuffer));\r
  }\r
\r
  Status = ExtractGuidedSectionDecode (\r
             InputSection,\r
             OutputBuffer,\r
             ScratchBuffer,\r
             AuthenticationStatus\r
             );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Decode failed\r
    //\r
    DEBUG ((DEBUG_ERROR, "Extract guided section Failed - %r\n", Status));\r
    return Status;\r
  }\r
\r
  *OutputSize = (UINTN) OutputBufferSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
\r
/**\r
   Decompresses a section to the output buffer.\r
\r
   This function looks up the compression type field in the input section and\r
   applies the appropriate compression algorithm to compress the section to a\r
   callee allocated buffer.\r
\r
   @param  This                  Points to this instance of the\r
                                 EFI_PEI_DECOMPRESS_PEI PPI.\r
   @param  CompressionSection    Points to the compressed section.\r
   @param  OutputBuffer          Holds the returned pointer to the decompressed\r
                                 sections.\r
   @param  OutputSize            Holds the returned size of the decompress\r
                                 section streams.\r
\r
   @retval EFI_SUCCESS           The section was decompressed successfully.\r
                                 OutputBuffer contains the resulting data and\r
                                 OutputSize contains the resulting size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Decompress (\r
  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,\r
  IN CONST  EFI_COMPRESSION_SECTION *CompressionSection,\r
  OUT       VOID                    **OutputBuffer,\r
  OUT       UINTN                   *OutputSize\r
 )\r
{\r
  EFI_STATUS                      Status;\r
  UINT8                           *DstBuffer;\r
  UINT8                           *ScratchBuffer;\r
  UINT32                          DstBufferSize;\r
  UINT32                          ScratchBufferSize;\r
  VOID                            *CompressionSource;\r
  UINT32                          CompressionSourceSize;\r
  UINT32                          UncompressedLength;\r
  UINT8                           CompressionType;\r
\r
  if (CompressionSection->CommonHeader.Type != EFI_SECTION_COMPRESSION) {\r
    ASSERT (FALSE);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (IS_SECTION2 (CompressionSection)) {\r
    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION2));\r
    CompressionSourceSize = (UINT32) (SECTION2_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION2));\r
    UncompressedLength = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->UncompressedLength;\r
    CompressionType = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->CompressionType;\r
  } else {\r
    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION));\r
    CompressionSourceSize = (UINT32) (SECTION_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION));\r
    UncompressedLength = CompressionSection->UncompressedLength;\r
    CompressionType = CompressionSection->CompressionType;\r
  }\r
\r
  //\r
  // This is a compression set, expand it\r
  //\r
  switch (CompressionType) {\r
  case EFI_STANDARD_COMPRESSION:\r
    if (FeaturePcdGet(PcdDxeIplSupportUefiDecompress)) {\r
      //\r
      // Load EFI standard compression.\r
      // For compressed data, decompress them to destination buffer.\r
      //\r
      Status = UefiDecompressGetInfo (\r
                 CompressionSource,\r
                 CompressionSourceSize,\r
                 &DstBufferSize,\r
                 &ScratchBufferSize\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // GetInfo failed\r
        //\r
        DEBUG ((DEBUG_ERROR, "Decompress GetInfo Failed - %r\n", Status));\r
        return EFI_NOT_FOUND;\r
      }\r
      //\r
      // Allocate scratch buffer\r
      //\r
      ScratchBuffer = AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize));\r
      if (ScratchBuffer == NULL) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
      //\r
      // Allocate destination buffer\r
      //\r
      DstBuffer = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));\r
      if (DstBuffer == NULL) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
      //\r
      // Call decompress function\r
      //\r
      Status = UefiDecompress (\r
                  CompressionSource,\r
                  DstBuffer,\r
                  ScratchBuffer\r
                  );\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // Decompress failed\r
        //\r
        DEBUG ((DEBUG_ERROR, "Decompress Failed - %r\n", Status));\r
        return EFI_NOT_FOUND;\r
      }\r
      break;\r
    } else {\r
      //\r
      // PcdDxeIplSupportUefiDecompress is FALSE\r
      // Don't support UEFI decompression algorithm.\r
      //\r
      ASSERT (FALSE);\r
      return EFI_NOT_FOUND;\r
    }\r
\r
  case EFI_NOT_COMPRESSED:\r
    //\r
    // Allocate destination buffer\r
    //\r
    DstBufferSize = UncompressedLength;\r
    DstBuffer     = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));\r
    if (DstBuffer == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    //\r
    // stream is not actually compressed, just encapsulated.  So just copy it.\r
    //\r
    CopyMem (DstBuffer, CompressionSource, DstBufferSize);\r
    break;\r
\r
  default:\r
    //\r
    // Don't support other unknown compression type.\r
    //\r
    ASSERT (FALSE);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *OutputSize = DstBufferSize;\r
  *OutputBuffer = DstBuffer;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
   Updates the Stack HOB passed to DXE phase.\r
\r
   This function traverses the whole HOB list and update the stack HOB to\r
   reflect the real stack that is used by DXE core.\r
\r
   @param BaseAddress           The lower address of stack used by DxeCore.\r
   @param Length                The length of stack used by DxeCore.\r
\r
**/\r
VOID\r
UpdateStackHob (\r
  IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
  IN UINT64                      Length\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS           Hob;\r
\r
  Hob.Raw = GetHobList ();\r
  while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, Hob.Raw)) != NULL) {\r
    if (CompareGuid (&gEfiHobMemoryAllocStackGuid, &(Hob.MemoryAllocationStack->AllocDescriptor.Name))) {\r
      //\r
      // Build a new memory allocation HOB with old stack info with EfiBootServicesData type. Need to\r
      // avoid this region be reclaimed by DXE core as the IDT built in SEC might be on stack, and some\r
      // PEIMs may also keep key information on stack\r
      //\r
      BuildMemoryAllocationHob (\r
        Hob.MemoryAllocationStack->AllocDescriptor.MemoryBaseAddress,\r
        Hob.MemoryAllocationStack->AllocDescriptor.MemoryLength,\r
        EfiBootServicesData\r
        );\r
      //\r
      // Update the BSP Stack Hob to reflect the new stack info.\r
      //\r
      Hob.MemoryAllocationStack->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
      Hob.MemoryAllocationStack->AllocDescriptor.MemoryLength = Length;\r
      break;\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
  }\r
}\r
\r