[mirror_edk2.git] / EdkModulePkg / 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
\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_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
GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY  gEfiDecompress = {\r
  UefiDecompressGetInfo,\r
  UefiDecompress\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY  gTianoDecompress = {\r
  TianoDecompressGetInfo,\r
  TianoDecompress\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED DECOMPRESS_LIBRARY  gCustomDecompress = {\r
  CustomDecompressGetInfo,\r
  CustomDecompress\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
\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
    // 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
  //\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
  // 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
  if (FeaturePcdGet (PcdDxeIplBuildShareCodeHobs)) {\r
    if (FeaturePcdGet (PcdDxeIplSupportEfiDecompress)) {\r
      //\r
      // Add HOB for the EFI Decompress Protocol\r
      //\r
      BuildGuidDataHob (\r
        &gEfiDecompressProtocolGuid,\r
        (VOID *)&gEfiDecompress,\r
        sizeof (gEfiDecompress)\r
        );\r
    }\r
    if (FeaturePcdGet (PcdDxeIplSupportTianoDecompress)) {\r
      //\r
      // Add HOB for the Tiano Decompress Protocol\r
      //\r
      BuildGuidDataHob (\r
        &gEfiTianoDecompressProtocolGuid,\r
        (VOID *)&gTianoDecompress,\r
        sizeof (gTianoDecompress)\r
        );\r
    }\r
    if (FeaturePcdGet (PcdDxeIplSupportCustomDecompress)) {\r
      //\r
      // Add HOB for the user customized Decompress Protocol\r
      //\r
      BuildGuidDataHob (\r
        &gEfiCustomizedDecompressProtocolGuid,\r
        (VOID *)&gCustomDecompress,\r
        sizeof (gCustomDecompress)\r
        );\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
\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  UINT16                 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
  VOID                        *SectionData;\r
  EFI_STATUS                  Status;\r
  EFI_PEI_HOB_POINTERS        Hob;\r
\r
\r
  FwVolHeader   = NULL;\r
  FfsFileHeader = NULL;\r
  SectionData   = 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
    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
      if (!EFI_ERROR (Status)) {\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) (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      UINT16                 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
  VOID                            *SectionData;\r
  DECOMPRESS_LIBRARY              *DecompressLibrary;\r
  UINT8                           *DstBuffer;\r
  UINT8                           *ScratchBuffer;\r
  UINT32                          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
  UINT64                          FileSize;\r
  EFI_GUID_DEFINED_SECTION        *GuidedSectionHeader;\r
  UINT32                          AuthenticationStatus;\r
  EFI_PEI_SECTION_EXTRACTION_PPI  *SectionExtract;\r
  UINT32                          BufferSize;\r
  UINT8                           *Buffer;\r
  EFI_PEI_SECURITY_PPI            *Security;\r
  BOOLEAN                         StartCrisisRecovery;\r
  EFI_GUID                        TempGuid;\r
  EFI_FIRMWARE_VOLUME_HEADER      *FvHeader;\r
  EFI_COMPRESSION_SECTION         *CompressionSection;\r
  UINT32                          FvAlignment;\r
\r
  //\r
  // Initialize local variables.\r
  //\r
  DecompressLibrary = NULL;\r
  DstBuffer         = NULL;\r
  DstBufferSize     = 0;\r
\r
  Status = PeiServicesFfsFindSectionData (\r
             EFI_SECTION_COMPRESSION,\r
             FfsFileHeader,\r
             &SectionData\r
             );\r
\r
  //\r
  // First process the compression section\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Yes, there is a compression section, so extract the contents\r
    // Decompress the image here\r
    //\r
    Section = (EFI_COMMON_SECTION_HEADER *) (UINTN) (VOID *) ((UINT8 *) (FfsFileHeader) + (UINTN) sizeof (EFI_FFS_FILE_HEADER));\r
\r
    do {\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
        // Locate the GUID'd Section Extractor\r
        //\r
        GuidedSectionHeader = (VOID *) (Section + 1);\r
\r
        //\r
        // This following code constitutes the addition of the security model\r
        // to the DXE IPL.\r
        //\r
        //\r
        // Set a default authenticatino state\r
        //\r
        AuthenticationStatus = 0;\r
\r
        Status = PeiServicesLocatePpi (\r
                   &gEfiPeiSectionExtractionPpiGuid,\r
                   0,\r
                   NULL,\r
                   (VOID **)&SectionExtract\r
                   );\r
\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
        //\r
        // Verify Authentication State\r
        //\r
        CopyMem (&TempGuid, Section + 1, sizeof (EFI_GUID));\r
\r
        Status = SectionExtract->PeiGetSection (\r
                                  GetPeiServicesTablePointer(),\r
                                  SectionExtract,\r
                                  (EFI_SECTION_TYPE *) &SectionType,\r
                                  &TempGuid,\r
                                  0,\r
                                  (VOID **) &Buffer,\r
                                  &BufferSize,\r
                                  &AuthenticationStatus\r
                                  );\r
\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
        //\r
        // If not ask the Security PPI, if exists, for disposition\r
        //\r
        //\r
        Status = PeiServicesLocatePpi (\r
                   &gEfiPeiSecurityPpiGuid,\r
                   0,\r
                   NULL,\r
                   (VOID **)&Security\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
\r
        Status = Security->AuthenticationState (\r
                            GetPeiServicesTablePointer(),\r
                            (struct _EFI_PEI_SECURITY_PPI *) Security,\r
                            AuthenticationStatus,\r
                            FfsFileHeader,\r
                            &StartCrisisRecovery\r
                            );\r
\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
        //\r
        // If there is a security violation, report to caller and have\r
        // the upper-level logic possible engender a crisis recovery\r
        //\r
        if (StartCrisisRecovery) {\r
          return EFI_SECURITY_VIOLATION;\r
        }\r
      }\r
\r
      if (Section->Type == EFI_SECTION_PE32) {\r
        //\r
        // This is what we want\r
        //\r
        *Pe32Data = (VOID *) (Section + 1);\r
        return EFI_SUCCESS;\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
          //\r
          if (FeaturePcdGet (PcdDxeIplSupportTianoDecompress)) {\r
            DecompressLibrary = &gEfiDecompress;\r
          } else {\r
            ASSERT (FALSE);\r
            return EFI_NOT_FOUND;\r
          }\r
          break;\r
\r
        case EFI_CUSTOMIZED_COMPRESSION:\r
          //\r
          // Load user customized compression.\r
          //\r
          if (FeaturePcdGet (PcdDxeIplSupportCustomDecompress)) {\r
            DecompressLibrary = &gCustomDecompress;\r
          } else {\r
            ASSERT (FALSE);\r
            return EFI_NOT_FOUND;\r
          }\r
          break;\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
        \r
        if (CompressionSection->CompressionType != EFI_NOT_COMPRESSED) {\r
          //\r
          // For compressed data, decompress them to dstbuffer.\r
          //\r
          Status = DecompressLibrary->GetInfo (\r
                     (UINT8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
                     (UINT32) SectionLength - sizeof (EFI_COMPRESSION_SECTION),\r
                     &DstBufferSize,\r
                     &ScratchBufferSize\r
                     );\r
          if (EFI_ERROR (Status)) {\r
            //\r
            // GetInfo failed\r
            //\r
            return EFI_NOT_FOUND;\r
          }\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
          //\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
          //\r
          // Call decompress function\r
          //\r
          Status = DecompressLibrary->Decompress (\r
                      (CHAR8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
                      DstBuffer,\r
                      ScratchBuffer\r
                      );\r
        }\r
        \r
        CmpSection = (EFI_COMMON_SECTION_HEADER *) DstBuffer;\r
        if (CmpSection->Type == 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
            // Adjust Fv Base Address Alignment based on Align Attributes in Fv Header\r
            //\r
            \r
            //\r
            // When FvImage support Alignment, we need to check whether \r
            // its alignment is correct. \r
            //\r
            if (FvHeader->Attributes | EFI_FVB_ALIGNMENT_CAP) {\r
              \r
              //\r
              // Calculate the mini alignment for this FvImage\r
              //\r
              FvAlignment = 1 << (LowBitSet32 (FvHeader->Attributes >> 16) + 1);\r
              \r
              //\r
              // If current FvImage base address doesn't meet the its alignment,\r
              // we need to reload this FvImage to another correct memory address.\r
              //\r
              if (((UINTN) FvHeader % FvAlignment) != 0) {\r
                DstBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINTN) FvHeader->FvLength), FvAlignment);\r
                if (DstBuffer == NULL) {\r
                  return EFI_OUT_OF_RESOURCES;\r
                }\r
                CopyMem (DstBuffer, FvHeader, (UINTN) FvHeader->FvLength);\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
            //\r
            // when search FvImage Section return true.\r
            //\r
            if (SectionType == EFI_SECTION_FIRMWARE_VOLUME_IMAGE) {\r
              *Pe32Data = (VOID *) FvHeader;\r
              return EFI_SUCCESS;\r
            } else {\r
              return EFI_NOT_FOUND;\r
            }\r
          }\r
        }\r
        //\r
        // Decompress successfully.\r
        // Loop the decompressed data searching for expected section.\r
        //\r
        CmpFileData = (VOID *) DstBuffer;\r
        CmpFileSize = DstBufferSize;\r
        do {\r
          CmpSectionLength = *(UINT32 *) (CmpSection->Size) & 0x00ffffff;\r
          if (CmpSection->Type == EFI_SECTION_PE32) {\r
            //\r
            // This is what we want\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
      }\r
      //\r
      // End of the decompression activity\r
      //\r
\r
      Section   = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) Section + OccupiedSectionLength);\r
      FileSize  = FfsFileHeader->Size[0] & 0xFF;\r
      FileSize += (FfsFileHeader->Size[1] << 8) & 0xFF00;\r
      FileSize += (FfsFileHeader->Size[2] << 16) & 0xFF0000;\r
      FileSize &= 0x00FFFFFF;\r
    } while (Section->Type != 0 && (UINTN) ((UINT8 *) Section - (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
  } else {\r
    //\r
    // For those FFS that doesn't contain compression section, directly search \r
    // PE or TE section in this FFS.\r
    //\r
\r
    Status = PeiServicesFfsFindSectionData (\r
               EFI_SECTION_PE32,\r
               FfsFileHeader,\r
               &SectionData\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      Status = PeiServicesFfsFindSectionData (\r
                 EFI_SECTION_TE,\r
                 FfsFileHeader,\r
                 &SectionData\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
    }\r
  }\r
\r
  *Pe32Data = SectionData;\r
\r
  return EFI_SUCCESS;\r
}\r
\r