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

/*++\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  DxeLoad.c\r
\r
Abstract:\r
\r
  Last PEIM.\r
  Responsibility of this module is to load the DXE Core from a Firmware Volume.\r
\r
--*/\r
\r
#include "DxeIpl.h"\r
#include <Ppi/GuidedSectionExtraction.h>\r
\r
// porting note remove later\r
#include "FrameworkPei.h"\r
// end of remove later\r
\r
EFI_STATUS\r
CustomDecompressExtractSection (\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
BOOLEAN gInMemory = FALSE;\r
\r
//\r
// Module Globals used in the DXE to PEI handoff\r
// These must be module globals, so the stack can be switched\r
//\r
static EFI_DXE_IPL_PPI mDxeIplPpi = {\r
  DxeLoadCore\r
};\r
\r
static EFI_PEI_FV_FILE_LOADER_PPI mLoadFilePpi = {\r
  DxeIplLoadFile\r
};\r
\r
static EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomDecompressExtractiongPpi = {\r
  CustomDecompressExtractSection\r
};\r
\r
static EFI_PEI_PPI_DESCRIPTOR     mPpiList[] = {\r
  {\r
  EFI_PEI_PPI_DESCRIPTOR_PPI,\r
  &gEfiPeiFvFileLoaderPpiGuid,\r
  &mLoadFilePpi\r
  },\r
  {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiDxeIplPpiGuid,\r
  &mDxeIplPpi\r
  }\r
};\r
\r
static EFI_PEI_PPI_DESCRIPTOR     mPpiSignal = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiEndOfPeiSignalPpiGuid,\r
  NULL\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Initializes the Dxe Ipl PPI\r
\r
Arguments:\r
\r
  FfsHeader   - Pointer to FFS file header\r
  PeiServices - General purpose services available to every PEIM.\r
\r
Returns:\r
\r
  EFI_SUCCESS\r
\r
--*/\r
{\r
  EFI_STATUS                                Status;\r
  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader;\r
  EFI_BOOT_MODE                             BootMode;\r
  EFI_GUID                                  **DecompressGuidList;\r
  UINT32                                    DecompressMethodNumber;\r
  EFI_PEI_PPI_DESCRIPTOR                    *GuidPpi;\r
  \r
  Status = PeiServicesGetBootMode (&BootMode);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (!gInMemory && (BootMode != BOOT_ON_S3_RESUME)) {   \r
    //\r
    // The DxeIpl has not yet been shadowed\r
    //\r
    PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();\r
\r
    //\r
    // Shadow DxeIpl and then re-run its entry point\r
    //\r
    Status = ShadowDxeIpl (FfsHeader, PeiEfiPeiPeCoffLoader);\r
  } else {\r
    //\r
    // Get custom decompress method guid list \r
    //\r
    DecompressGuidList     = NULL;\r
    DecompressMethodNumber = 0;\r
    Status = CustomDecompressGetAlgorithms (DecompressGuidList, &DecompressMethodNumber);\r
    if (Status == EFI_OUT_OF_RESOURCES) {\r
      DecompressGuidList = (EFI_GUID **) AllocatePages (EFI_SIZE_TO_PAGES (DecompressMethodNumber * sizeof (EFI_GUID *)));\r
      ASSERT (DecompressGuidList != NULL);\r
      Status = CustomDecompressGetAlgorithms (DecompressGuidList, &DecompressMethodNumber);\r
    }\r
    ASSERT_EFI_ERROR(Status);\r
\r
    //\r
    // Install custom decompress extraction guid ppi\r
    //\r
    if (DecompressMethodNumber > 0) {\r
      GuidPpi = NULL;\r
      GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePages (EFI_SIZE_TO_PAGES (DecompressMethodNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR)));\r
      ASSERT (GuidPpi != NULL);\r
      while (DecompressMethodNumber-- > 0) {\r
        GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
        GuidPpi->Ppi   = &mCustomDecompressExtractiongPpi;\r
        GuidPpi->Guid  = DecompressGuidList [DecompressMethodNumber];\r
        Status = PeiServicesInstallPpi (GuidPpi++);\r
        ASSERT_EFI_ERROR(Status);\r
      }\r
    }\r
    \r
    //\r
    // Install FvFileLoader and DxeIpl PPIs.\r
    //\r
    Status = PeiServicesInstallPpi (mPpiList);\r
    ASSERT_EFI_ERROR(Status);\r
  }\r
  \r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
DxeLoadCore (\r
  IN EFI_DXE_IPL_PPI       *This,\r
  IN EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_PEI_HOB_POINTERS  HobList\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Main entry point to last PEIM\r
\r
Arguments:\r
  This         - Entry point for DXE IPL PPI\r
  PeiServices  - General purpose services available to every PEIM.\r
  HobList      - Address to the Pei HOB list\r
\r
Returns:\r
\r
  EFI_SUCCESS          - DEX core was successfully loaded.\r
  EFI_OUT_OF_RESOURCES - There are not enough resources to load DXE core.\r
\r
--*/\r
{\r
  EFI_STATUS                                Status;\r
  EFI_GUID                                  DxeCoreFileName;\r
  EFI_GUID                                  FirmwareFileName;\r
  VOID                                      *Pe32Data;\r
  VOID                                      *FvImageData;     \r
  EFI_PHYSICAL_ADDRESS                      DxeCoreAddress;\r
  UINT64                                    DxeCoreSize;\r
  EFI_PHYSICAL_ADDRESS                      DxeCoreEntryPoint;\r
  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader;\r
  EFI_BOOT_MODE                             BootMode;\r
  EFI_PEI_RECOVERY_MODULE_PPI               *PeiRecovery;\r
  EFI_PEI_S3_RESUME_PPI                     *S3Resume;\r
\r
//  PERF_START (PeiServices, L"DxeIpl", NULL, 0);\r
\r
  //\r
  // if in S3 Resume, restore configure\r
  //\r
  Status = PeiServicesGetBootMode (&BootMode);\r
  ASSERT_EFI_ERROR(Status);\r
\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiS3ResumePpiGuid,\r
               0,\r
               NULL,\r
               (VOID **)&S3Resume\r
               );\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = S3Resume->S3RestoreConfig (PeiServices);\r
    ASSERT_EFI_ERROR (Status);\r
  } else if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
\r
    Status = PeiServicesLocatePpi (\r
               &gEfiPeiRecoveryModulePpiGuid,\r
               0,\r
               NULL,\r
               (VOID **)&PeiRecovery\r
               );\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = PeiRecovery->LoadRecoveryCapsule (PeiServices, PeiRecovery);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "Load Recovery Capsule Failed.(Status = %r)\n", Status));\r
      CpuDeadLoop ();\r
    }\r
\r
    //\r
    // Now should have a HOB with the DXE core w/ the old HOB destroyed\r
    //\r
  }\r
\r
  //\r
  // Install the PEI Protocols that are shared between PEI and DXE\r
  //\r
  PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();\r
  ASSERT (PeiEfiPeiPeCoffLoader != NULL);\r
\r
  //\r
  // Find the EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE type compressed Firmware Volume file\r
  // The file found will be processed by PeiProcessFile: It will first be decompressed to\r
  // a normal FV, then a corresponding FV type hob will be built. \r
  //\r
  Status = PeiFindFile (\r
             EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,\r
             EFI_SECTION_FIRMWARE_VOLUME_IMAGE,\r
             &FirmwareFileName,\r
             &FvImageData\r
             );\r
\r
  //\r
  // Find the DXE Core in a Firmware Volume\r
  //\r
  Status = PeiFindFile (\r
            EFI_FV_FILETYPE_DXE_CORE,\r
            EFI_SECTION_PE32,\r
            &DxeCoreFileName,\r
            &Pe32Data\r
            );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Load the DXE Core from a Firmware Volume\r
  //\r
  Status = PeiLoadFile (\r
             PeiEfiPeiPeCoffLoader,\r
             Pe32Data,\r
             &DxeCoreAddress,\r
             &DxeCoreSize,\r
             &DxeCoreEntryPoint\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Add HOB for the DXE Core\r
  //\r
  BuildModuleHob (\r
    &DxeCoreFileName,\r
    DxeCoreAddress,\r
    DxeCoreSize,\r
    DxeCoreEntryPoint\r
    );\r
\r
  //\r
  // Add HOB for the PE/COFF Loader Protocol\r
  //\r
  BuildGuidDataHob (\r
    &gEfiPeiPeCoffLoaderGuid,\r
    (VOID *)&PeiEfiPeiPeCoffLoader,\r
    sizeof (VOID *)\r
    );\r
  //\r
  // Report Status Code EFI_SW_PEI_PC_HANDOFF_TO_NEXT\r
  //\r
  REPORT_STATUS_CODE (\r
    EFI_PROGRESS_CODE,\r
    EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT\r
    );\r
\r
  //\r
  // Transfer control to the DXE Core\r
  // The handoff state is simply a pointer to the HOB list\r
  //\r
\r
  DEBUG ((EFI_D_INFO, "DXE Core Entry Point 0x%08x\n", (UINTN) DxeCoreEntryPoint));\r
  HandOffToDxeCore (DxeCoreEntryPoint, HobList, &mPpiSignal);\r
  //\r
  // If we get here, then the DXE Core returned.  This is an error\r
  // Dxe Core should not return.\r
  //\r
  ASSERT (FALSE);\r
  CpuDeadLoop ();\r
\r
  return EFI_OUT_OF_RESOURCES;\r
}\r
\r
EFI_STATUS\r
PeiFindFile (\r
  IN  UINT8                  Type,\r
  IN  EFI_SECTION_TYPE       SectionType,\r
  OUT EFI_GUID               *FileName,\r
  OUT VOID                   **Pe32Data\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Finds a PE/COFF of a specific Type and SectionType in the Firmware Volumes\r
  described in the HOB list. Able to search in a compression set in a FFS file.\r
  But only one level of compression is supported, that is, not able to search\r
  in a compression set that is within another compression set.\r
\r
Arguments:\r
\r
  Type        - The Type of file to retrieve\r
\r
  SectionType - The type of section to retrieve from a file\r
\r
  FileName    - The name of the file found in the Firmware Volume\r
\r
  Pe32Data    - Pointer to the beginning of the PE/COFF file found in the Firmware Volume\r
\r
Returns:\r
\r
  EFI_SUCCESS   - The file was found, and the name is returned in FileName, and a pointer to\r
                  the PE/COFF image is returned in Pe32Data\r
\r
  EFI_NOT_FOUND - The file was not found in the Firmware Volumes present in the HOB List\r
\r
--*/\r
{\r
  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;\r
  EFI_FFS_FILE_HEADER         *FfsFileHeader;\r
  EFI_STATUS                  Status;\r
  EFI_PEI_HOB_POINTERS        Hob;\r
\r
\r
  FwVolHeader   = NULL;\r
  FfsFileHeader = NULL;\r
  Status        = EFI_SUCCESS;\r
\r
  //\r
  // For each Firmware Volume, look for a specified type\r
  // of file and break out until no one is found \r
  //\r
  Hob.Raw = GetHobList ();\r
  while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_FV, Hob.Raw)) != NULL) {\r
    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) (Hob.FirmwareVolume->BaseAddress);\r
    //\r
    // Make sure the FV HOB does not get corrupted.\r
    //\r
    ASSERT (FwVolHeader->Signature == EFI_FVH_SIGNATURE);\r
\r
    Status = PeiServicesFfsFindNextFile (\r
               Type,\r
               FwVolHeader,\r
               &FfsFileHeader\r
               );\r
    if (!EFI_ERROR (Status)) {\r
      Status = PeiProcessFile (\r
                 SectionType,\r
                 FfsFileHeader,\r
                 Pe32Data,\r
                 &Hob\r
                 );\r
      CopyMem (FileName, &FfsFileHeader->Name, sizeof (EFI_GUID));\r
      //\r
      // Find all Fv type ffs to get all FvImage and add them into FvHob\r
      //\r
      if (!EFI_ERROR (Status) && (Type != EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) {\r
        return EFI_SUCCESS;\r
      }\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
  }\r
  return EFI_NOT_FOUND;\r
}\r
\r
EFI_STATUS\r
PeiLoadFile (\r
  IN  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader,\r
  IN  VOID                                      *Pe32Data,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Loads and relocates a PE/COFF image into memory.\r
\r
Arguments:\r
\r
  PeiEfiPeiPeCoffLoader - Pointer to a PE COFF loader protocol\r
\r
  Pe32Data         - The base address of the PE/COFF file that is to be loaded and relocated\r
\r
  ImageAddress     - The base address of the relocated PE/COFF image\r
\r
  ImageSize        - The size of the relocated PE/COFF image\r
\r
  EntryPoint       - The entry point of the relocated PE/COFF image\r
\r
Returns:\r
\r
  EFI_SUCCESS   - The file was loaded and relocated\r
\r
  EFI_OUT_OF_RESOURCES - There was not enough memory to load and relocate the PE/COFF file\r
\r
--*/\r
{\r
  EFI_STATUS                            Status;\r
  PE_COFF_LOADER_IMAGE_CONTEXT          ImageContext;\r
\r
  ZeroMem (&ImageContext, sizeof (ImageContext));\r
  ImageContext.Handle = Pe32Data;\r
  Status              = GetImageReadFunction (&ImageContext);\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = PeiEfiPeiPeCoffLoader->GetImageInfo (PeiEfiPeiPeCoffLoader, &ImageContext);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Allocate Memory for the image\r
  //\r
  ImageContext.ImageAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) AllocatePages (EFI_SIZE_TO_PAGES ((UINT32) ImageContext.ImageSize));\r
  ASSERT (ImageContext.ImageAddress != 0);\r
\r
  //\r
  // Load the image to our new buffer\r
  //\r
  Status = PeiEfiPeiPeCoffLoader->LoadImage (PeiEfiPeiPeCoffLoader, &ImageContext);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Relocate the image in our new buffer\r
  //\r
  Status = PeiEfiPeiPeCoffLoader->RelocateImage (PeiEfiPeiPeCoffLoader, &ImageContext);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Flush the instruction cache so the image data is written before we execute it\r
  //\r
  InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
\r
  *ImageAddress = ImageContext.ImageAddress;\r
  *ImageSize    = ImageContext.ImageSize;\r
  *EntryPoint   = ImageContext.EntryPoint;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
ShadowDxeIpl (\r
  IN EFI_FFS_FILE_HEADER                       *DxeIplFileHeader,\r
  IN EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Shadow the DXE IPL to a different memory location. This occurs after permanent\r
  memory has been discovered.\r
\r
Arguments:\r
\r
  DxeIplFileHeader      - Pointer to the FFS file header of the DXE IPL driver\r
\r
  PeiEfiPeiPeCoffLoader - Pointer to a PE COFF loader protocol\r
\r
Returns:\r
\r
  EFI_SUCCESS   - DXE IPL was successfully shadowed to a different memory location.\r
\r
  EFI_ ERROR    - The shadow was unsuccessful.\r
\r
\r
--*/\r
{\r
  UINTN                     SectionLength;\r
  UINTN                     OccupiedSectionLength;\r
  EFI_PHYSICAL_ADDRESS      DxeIplAddress;\r
  UINT64                    DxeIplSize;\r
  EFI_PHYSICAL_ADDRESS      DxeIplEntryPoint;\r
  EFI_STATUS                Status;\r
  EFI_COMMON_SECTION_HEADER *Section;\r
\r
  Section = (EFI_COMMON_SECTION_HEADER *) (DxeIplFileHeader + 1);\r
\r
  while ((Section->Type != EFI_SECTION_PE32) && (Section->Type != EFI_SECTION_TE)) {\r
    SectionLength         = *(UINT32 *) (Section->Size) & 0x00ffffff;\r
    OccupiedSectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
    Section               = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + OccupiedSectionLength);\r
  }\r
  //\r
  // Relocate DxeIpl into memory by using loadfile service\r
  //\r
  Status = PeiLoadFile (\r
            PeiEfiPeiPeCoffLoader,\r
            (VOID *) (Section + 1),\r
            &DxeIplAddress,\r
            &DxeIplSize,\r
            &DxeIplEntryPoint\r
            );\r
\r
  if (Status == EFI_SUCCESS) {\r
    //\r
    // Set gInMemory global variable to TRUE to indicate the dxeipl is shadowed.\r
    //\r
    *(BOOLEAN *) ((UINTN) &gInMemory + (UINTN) DxeIplEntryPoint - (UINTN) _ModuleEntryPoint) = TRUE;\r
    Status = ((EFI_PEIM_ENTRY_POINT) (UINTN) DxeIplEntryPoint) ((EFI_PEI_FILE_HANDLE *) DxeIplFileHeader, GetPeiServicesTablePointer());\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
DxeIplLoadFile (\r
  IN EFI_PEI_FV_FILE_LOADER_PPI                 *This,\r
  IN  EFI_FFS_FILE_HEADER                       *FfsHeader,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Given a pointer to an FFS file containing a PE32 image, get the\r
  information on the PE32 image, and then "load" it so that it\r
  can be executed.\r
\r
Arguments:\r
\r
  This  - pointer to our file loader protocol\r
\r
  FfsHeader - pointer to the FFS file header of the FFS file that\r
              contains the PE32 image we want to load\r
\r
  ImageAddress  - returned address where the PE32 image is loaded\r
\r
  ImageSize     - returned size of the loaded PE32 image\r
\r
  EntryPoint    - entry point to the loaded PE32 image\r
\r
Returns:\r
\r
  EFI_SUCCESS  - The FFS file was successfully loaded.\r
\r
  EFI_ERROR    - Unable to load the FFS file.\r
\r
--*/\r
{\r
  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader;\r
  EFI_STATUS                                Status;\r
  VOID                                      *Pe32Data;\r
\r
  Pe32Data = NULL;\r
  PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();\r
\r
  //\r
  // Preprocess the FFS file to get a pointer to the PE32 information\r
  // in the enclosed PE32 image.\r
  //\r
  Status = PeiProcessFile (\r
            EFI_SECTION_PE32,\r
            FfsHeader,\r
            &Pe32Data,\r
            NULL\r
            );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Load the PE image from the FFS file\r
  //\r
  Status = PeiLoadFile (\r
            PeiEfiPeiPeCoffLoader,\r
            Pe32Data,\r
            ImageAddress,\r
            ImageSize,\r
            EntryPoint\r
            );\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
PeiProcessFile (\r
  IN      EFI_SECTION_TYPE       SectionType,\r
  IN      EFI_FFS_FILE_HEADER    *FfsFileHeader,\r
  OUT     VOID                   **Pe32Data,\r
  IN      EFI_PEI_HOB_POINTERS   *OrigHob\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
  SectionType       - The type of section in the FFS file to process.\r
\r
  FfsFileHeader     - Pointer to the FFS file to process, looking for the\r
                      specified SectionType\r
\r
  Pe32Data          - returned pointer to the start of the PE32 image found\r
                      in the FFS file.\r
\r
Returns:\r
\r
  EFI_SUCCESS       - found the PE32 section in the FFS file\r
\r
--*/\r
{\r
  EFI_STATUS                      Status;\r
  UINT8                           *DstBuffer;\r
  UINT8                           *ScratchBuffer;\r
  UINTN                           DstBufferSize;\r
  UINT32                          ScratchBufferSize;\r
  EFI_COMMON_SECTION_HEADER       *CmpSection;\r
  UINTN                           CmpSectionLength;\r
  UINTN                           OccupiedCmpSectionLength;\r
  VOID                            *CmpFileData;\r
  UINTN                           CmpFileSize;\r
  EFI_COMMON_SECTION_HEADER       *Section;\r
  UINTN                           SectionLength;\r
  UINTN                           OccupiedSectionLength;\r
  UINTN                           FileSize;\r
  EFI_FIRMWARE_VOLUME_HEADER      *FvHeader;\r
  EFI_COMPRESSION_SECTION         *CompressionSection;\r
  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI  *SectionExtract;\r
  UINT32                          AuthenticationStatus;\r
\r
  //\r
  // First try to find the required section in this ffs file.\r
  //\r
  Status = PeiServicesFfsFindSectionData (\r
             SectionType,\r
             FfsFileHeader,\r
             Pe32Data\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  \r
  //\r
  // If not found, the required section may be in guided or compressed section.\r
  // So, search guided or compressed section to process\r
  //\r
  Section   = (EFI_COMMON_SECTION_HEADER *) (UINTN) (VOID *) ((UINT8 *) (FfsFileHeader) + (UINTN) sizeof (EFI_FFS_FILE_HEADER));\r
  FileSize  = FfsFileHeader->Size[0] & 0xFF;\r
  FileSize += (FfsFileHeader->Size[1] << 8) & 0xFF00;\r
  FileSize += (FfsFileHeader->Size[2] << 16) & 0xFF0000;\r
  FileSize &= 0x00FFFFFF;\r
  OccupiedSectionLength = 0;\r
\r
  do {\r
    //\r
    // Initialize local variables.\r
    //\r
    DstBuffer         = NULL;\r
    DstBufferSize     = 0; \r
\r
    Section               = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + OccupiedSectionLength);\r
    SectionLength         = *(UINT32 *) (Section->Size) & 0x00ffffff;\r
    OccupiedSectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
\r
    //\r
    // Was the DXE Core file encapsulated in a GUID'd section?\r
    //\r
    if (Section->Type == EFI_SECTION_GUID_DEFINED) {\r
      //\r
      // Set a default authenticatino state\r
      //\r
      AuthenticationStatus = 0;\r
      //\r
      // Locate extract guid section ppi\r
      //\r
      Status = PeiServicesLocatePpi (\r
                 (EFI_GUID *) (Section + 1),\r
                 0,\r
                 NULL,\r
                 (VOID **)&SectionExtract\r
                 );\r
\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // ignore the unknown guid section\r
        //\r
        continue;\r
      }\r
      //\r
      // Extract the contents from guid section\r
      //\r
      Status = SectionExtract->ExtractSection (\r
                                SectionExtract,\r
                                (VOID *) Section,\r
                                (VOID **) &DstBuffer,\r
                                &DstBufferSize,\r
                                &AuthenticationStatus\r
                                );\r
\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((EFI_D_ERROR, "Extract section content failed - %r\n", Status));\r
        return Status;\r
      }\r
      \r
      //\r
      // Todo check AuthenticationStatus and do the verify\r
      //\r
    } else if (Section->Type == EFI_SECTION_COMPRESSION) {\r
      //\r
      // This is a compression set, expand it\r
      //\r
      CompressionSection  = (EFI_COMPRESSION_SECTION *) Section;\r
\r
      switch (CompressionSection->CompressionType) {\r
      case EFI_STANDARD_COMPRESSION:\r
        //\r
        // Load EFI standard compression.\r
        // For compressed data, decompress them to dstbuffer.\r
        //\r
        Status = UefiDecompressGetInfo (\r
                   (UINT8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
                   (UINT32) SectionLength - sizeof (EFI_COMPRESSION_SECTION),\r
                   (UINT32 *) &DstBufferSize,\r
                   &ScratchBufferSize\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          //\r
          // GetInfo failed\r
          //\r
          DEBUG ((EFI_D_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
                    (CHAR8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
                    DstBuffer,\r
                    ScratchBuffer\r
                    );\r
        if (EFI_ERROR (Status)) {\r
          //\r
          // Decompress failed\r
          //\r
          DEBUG ((EFI_D_ERROR, "Decompress Failed - %r\n", Status));\r
          return EFI_NOT_FOUND;\r
        }\r
        break;\r
\r
      // porting note the original branch for customized compress is removed, it should be change to use GUID compress\r
\r
      case EFI_NOT_COMPRESSED:\r
        //\r
        // Allocate destination buffer\r
        //\r
        DstBufferSize = CompressionSection->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, CompressionSection + 1, DstBufferSize);\r
        break;\r
\r
      default:\r
        //\r
        // Don't support other unknown compression type.\r
        //\r
        ASSERT_EFI_ERROR (Status);\r
        return EFI_NOT_FOUND;\r
      }\r
    } else {\r
      //\r
      // ignore other type sections\r
      //\r
      continue;\r
    }\r
\r
    //\r
    // Extract contents from guided or compressed sections.\r
    // Loop the decompressed data searching for expected section.\r
    //\r
    CmpSection = (EFI_COMMON_SECTION_HEADER *) DstBuffer;\r
    CmpFileData = (VOID *) DstBuffer;\r
    CmpFileSize = DstBufferSize;\r
    do {\r
      CmpSectionLength          = *(UINT32 *) (CmpSection->Size) & 0x00ffffff;\r
      if (CmpSection->Type == SectionType) {\r
        //\r
        // This is what we want\r
        //\r
        if (SectionType == EFI_SECTION_FIRMWARE_VOLUME_IMAGE) {\r
          // \r
          // Firmware Volume Image in this Section\r
          // Skip the section header to get FvHeader\r
          //\r
          FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (CmpSection + 1);\r
\r
          if (FvHeader->Signature == EFI_FVH_SIGNATURE) {\r
            //\r
            // Because FvLength in FvHeader is UINT64 type, \r
            // so FvHeader must meed at least 8 bytes alignment.\r
            // If current FvImage base address doesn't meet its alignment,\r
            // we need to reload this FvImage to another correct memory address.\r
            //\r
            if (((UINTN) FvHeader % sizeof (UINT64)) != 0) {\r
              CopyMem (DstBuffer, FvHeader, (UINTN) CmpSectionLength - sizeof (EFI_COMMON_SECTION_HEADER));\r
              FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) DstBuffer;  \r
            }\r
\r
            //\r
            // Build new FvHob for new decompressed Fv image.\r
            //\r
            BuildFvHob ((EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader, FvHeader->FvLength);\r
            \r
            //\r
            // Set the original FvHob to unused.\r
            //\r
            if (OrigHob != NULL) {\r
              OrigHob->Header->HobType = EFI_HOB_TYPE_UNUSED;\r
            }\r
            //\r
            // return found FvImage data.\r
            //\r
            *Pe32Data = (VOID *) FvHeader;\r
            return EFI_SUCCESS;\r
          }\r
        } else {\r
          //\r
          // direct return the found section.\r
          //\r
          *Pe32Data = (VOID *) (CmpSection + 1);\r
          return EFI_SUCCESS;\r
        }\r
      }\r
      OccupiedCmpSectionLength  = GET_OCCUPIED_SIZE (CmpSectionLength, 4);\r
      CmpSection                = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) CmpSection + OccupiedCmpSectionLength);\r
    } while (CmpSection->Type != 0 && (UINTN) ((UINT8 *) CmpSection - (UINT8 *) CmpFileData) < CmpFileSize);\r
  } while (Section->Type != 0 && (UINTN) ((UINT8 *) Section + OccupiedSectionLength - (UINT8 *) FfsFileHeader) < FileSize);\r
\r
  //\r
  // search all sections (compression and non compression) in this FFS, don't \r
  // find expected section.\r
  //\r
  return EFI_NOT_FOUND;\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
  \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
  \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
  @reteval EFI_INVALID_PARAMETER The GUID in InputSection does\r
                                not match this instance of the\r
                                GUIDed Section Extraction PPI.\r
**/\r
EFI_STATUS\r
CustomDecompressExtractSection (\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          ScratchSize;\r
  UINT32          SectionLength;\r
  UINT32          DestinationSize;  \r
  \r
  //\r
  // Set authentic value to zero.\r
  //\r
  *AuthenticationStatus = 0;\r
  //\r
  // Calculate Section data Size\r
  //\r
  SectionLength   = *(UINT32 *) (((EFI_COMMON_SECTION_HEADER *) InputSection)->Size) & 0x00ffffff;\r
  //\r
  // Get compressed data information\r
  //\r
  Status = CustomDecompressGetInfo (\r
             (GUID *) ((UINT8 *) InputSection + sizeof (EFI_COMMON_SECTION_HEADER)),\r
             (UINT8 *) InputSection + sizeof (EFI_GUID_DEFINED_SECTION),\r
             SectionLength - sizeof (EFI_GUID_DEFINED_SECTION),\r
             &DestinationSize,\r
             &ScratchSize\r
             );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // GetInfo failed\r
    //\r
    DEBUG ((EFI_D_ERROR, "Extract guided section Failed - %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // Allocate scratch buffer\r
  //\r
  ScratchBuffer = AllocatePages (EFI_SIZE_TO_PAGES (ScratchSize));\r
  if (ScratchBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // Allocate destination buffer\r
  //\r
  *OutputSize   = (UINTN) DestinationSize;\r
  *OutputBuffer = AllocatePages (EFI_SIZE_TO_PAGES (*OutputSize));\r
  if (*OutputBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Call decompress function\r
  //\r
  Status = CustomDecompress (\r
             (GUID *) ((UINT8 *) InputSection + sizeof (EFI_COMMON_SECTION_HEADER)),\r
             (UINT8 *) InputSection + sizeof (EFI_GUID_DEFINED_SECTION),\r
             *OutputBuffer,\r
             ScratchBuffer\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Decompress failed\r
    //\r
    DEBUG ((EFI_D_ERROR, "Extract guided section Failed - %r\n", Status));\r
    return Status;\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r