[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) 2006 - 2007 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
**/\r
\r
#include "DxeIpl.h"\r
#include <Ppi/GuidedSectionExtraction.h>\r
#include <FrameworkPei.h>\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
STATIC\r
EFI_STATUS\r
EFIAPI \r
Decompress (\r
  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,\r
  IN CONST  EFI_COMPRESSION_SECTION *InputSection,\r
  OUT       VOID                    **OutputBuffer,\r
  OUT       UINTN                   *OutputSize\r
);\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_GUIDED_SECTION_EXTRACTION_PPI mCustomDecompressExtractiongPpi = {\r
  CustomDecompressExtractSection\r
};\r
\r
STATIC EFI_PEI_DECOMPRESS_PPI mDecompressPpi = {\r
  Decompress\r
};\r
\r
static EFI_PEI_PPI_DESCRIPTOR     mPpiList[] = {\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEfiDxeIplPpiGuid,\r
    &mDxeIplPpi\r
  },\r
  {\r
    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
    &gEfiPeiDecompressPpiGuid,\r
    &mDecompressPpi\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
STATIC EFI_PEI_FIRMWARE_VOLUME_INFO_PPI mFvInfoPpiTemplate = {\r
  EFI_FIRMWARE_FILE_SYSTEM2_GUID,\r
  NULL,\r
  0,    //FvInfoSize\r
  NULL, //ParentFvName\r
  NULL //ParentFileName;\r
};\r
\r
/**\r
  Initializes the Dxe Ipl PPI\r
\r
  @param  FfsHandle   The handle of FFS file.\r
  @param  PeiServices General purpose services available to\r
                      every PEIM.\r
  @return EFI_SUCESS \r
*/ \r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN EFI_PEI_FILE_HANDLE       FfsHandle,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  )\r
{\r
  EFI_STATUS                                Status;\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 (BootMode != BOOT_ON_S3_RESUME) {\r
    Status = PeiServicesRegisterForShadow (FfsHandle);\r
    if (Status == EFI_SUCCESS) {\r
      //\r
      // EFI_SUCESS means the first time call register for shadow \r
      // \r
      return Status;\r
    } else if (Status == EFI_ALREADY_STARTED) {\r
      \r
      gInMemory = TRUE;\r
      \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
    } else {\r
      ASSERT_EFI_ERROR (FALSE);\r
    }\r
  }\r
  \r
  //\r
  // Install FvFileLoader and DxeIpl PPIs.\r
  //\r
  Status = PeiServicesInstallPpi (mPpiList);\r
  ASSERT_EFI_ERROR(Status);  \r
	\r
  return Status;\r
}\r
\r
/**\r
   Main entry point to last PEIM \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
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
  EFI_STATUS                                Status;\r
  EFI_GUID                                  DxeCoreFileName;\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_FV_HANDLE                         VolumeHandle;\r
  EFI_PEI_FILE_HANDLE                       FileHandle;\r
  UINTN                                     Instance;\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 = AcpiS3ResumeOs();\r
    ASSERT_EFI_ERROR (Status);\r
  } else if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
    Status = PeiRecoverFirmware ();\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
  // If any FV contains an encapsulated FV extract that FV\r
  //\r
  DxeIplAddEncapsulatedFirmwareVolumes ();\r
  \r
  //\r
  // Look in all the FVs present in PEI and find the DXE Core\r
  //\r
  Instance = 0;\r
  Status = DxeIplFindFirmwareVolumeInstance (&Instance, EFI_FV_FILETYPE_DXE_CORE, &VolumeHandle, &FileHandle);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  CopyMem(&DxeCoreFileName, &(((EFI_FFS_FILE_HEADER*)FileHandle)->Name), sizeof (EFI_GUID));\r
\r
  //\r
  // Load the DXE Core from a Firmware Volume\r
  //\r
  Status = PeiLoadFile (\r
            FileHandle,\r
            &DxeCoreAddress,\r
            &DxeCoreSize,\r
            &DxeCoreEntryPoint\r
            );\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
  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
\r
STATIC\r
EFI_STATUS\r
GetFvAlignment (\r
  IN    EFI_FIRMWARE_VOLUME_HEADER   *FvHeader,\r
  OUT   UINT32                      *FvAlignment\r
  )\r
{\r
  //\r
  // Because FvLength in FvHeader is UINT64 type, \r
  // so FvHeader must meed at least 8 bytes alignment.\r
  // Get the appropriate alignment requirement.\r
  // \r
  if ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) < EFI_FVB2_ALIGNMENT_8) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  \r
   *FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);\r
   return EFI_SUCCESS;\r
}\r
\r
/**\r
   Search EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE image and expand \r
   as memory FV \r
    \r
   @return EFI_OUT_OF_RESOURCES There are no memory space to exstract FV\r
   @return EFI_SUCESS           Sucess to find the FV \r
**/\r
EFI_STATUS\r
DxeIplAddEncapsulatedFirmwareVolumes (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_STATUS                  VolumeStatus;\r
  UINTN                       Index;\r
  EFI_FV_INFO                 VolumeInfo; \r
  EFI_PEI_FV_HANDLE           VolumeHandle;\r
  EFI_PEI_FILE_HANDLE         FileHandle;\r
  UINT32                      SectionLength;\r
  EFI_FIRMWARE_VOLUME_HEADER  *FvHeader;\r
  EFI_FIRMWARE_VOLUME_IMAGE_SECTION *SectionHeader;\r
  VOID                        *DstBuffer;\r
  UINT32                       FvAlignment;\r
  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *FvInfoPpi;\r
  EFI_PEI_PPI_DESCRIPTOR           *FvInfoPpiDescriptor;\r
\r
  Status = EFI_NOT_FOUND;\r
  Index  = 0;\r
\r
  do {\r
    VolumeStatus = DxeIplFindFirmwareVolumeInstance (\r
                    &Index, \r
                    EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE, \r
                    &VolumeHandle, \r
                    &FileHandle\r
                    );\r
                    \r
    if (!EFI_ERROR (VolumeStatus)) {\r
         Status = PeiServicesFfsFindSectionData (\r
                    EFI_SECTION_FIRMWARE_VOLUME_IMAGE, \r
                    (EFI_FFS_FILE_HEADER *)FileHandle, \r
                    (VOID **)&FvHeader\r
                    );\r
                    \r
      if (!EFI_ERROR (Status)) {\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
          Status = GetFvAlignment(FvHeader, &FvAlignment); \r
          if (EFI_ERROR(Status)) {\r
            return Status;\r
          }\r
          if (((UINTN) FvHeader % FvAlignment) != 0) {\r
            SectionHeader = (EFI_FIRMWARE_VOLUME_IMAGE_SECTION*)((UINTN)FvHeader - sizeof(EFI_FIRMWARE_VOLUME_IMAGE_SECTION));\r
            SectionLength =  *(UINT32 *)SectionHeader->Size & 0x00FFFFFF;\r
            \r
            DstBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINTN) SectionLength - sizeof (EFI_COMMON_SECTION_HEADER)), FvAlignment);\r
            if (DstBuffer == NULL) {\r
              return EFI_OUT_OF_RESOURCES;\r
            }\r
            CopyMem (DstBuffer, FvHeader, (UINTN) SectionLength - sizeof (EFI_COMMON_SECTION_HEADER));\r
            FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) DstBuffer;  \r
          }\r
\r
          //\r
          // This new Firmware Volume comes from a firmware file within a firmware volume.\r
          // Record the original Firmware Volume Name.\r
          //\r
          PeiServicesFfsGetVolumeInfo (&VolumeHandle, &VolumeInfo);\r
\r
          //\r
          // Prepare to install FirmwareVolumeInfo PPI to expose new FV to PeiCore.\r
          //\r
          FvInfoPpi = AllocateCopyPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI), &mFvInfoPpiTemplate);\r
          ASSERT(FvInfoPpi != NULL);\r
\r
          FvInfoPpi->FvInfo     = (VOID*)FvHeader;\r
          FvInfoPpi->FvInfoSize = (UINT32)FvHeader->FvLength;\r
          CopyMem (\r
            &FvInfoPpi->ParentFvName,\r
            &(VolumeInfo.FvName),\r
            sizeof (EFI_GUID)\r
            );\r
          CopyMem (\r
            &FvInfoPpi->ParentFileName,\r
            &(((EFI_FFS_FILE_HEADER*)FileHandle)->Name),\r
            sizeof (EFI_GUID)\r
            );\r
\r
          FvInfoPpiDescriptor = AllocatePool (sizeof(EFI_PEI_PPI_DESCRIPTOR));\r
          ASSERT (FvInfoPpiDescriptor != NULL);\r
    	  \r
          FvInfoPpiDescriptor->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI|EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
          FvInfoPpiDescriptor->Guid  = &gEfiPeiFirmwareVolumeInfoPpiGuid;\r
          FvInfoPpiDescriptor->Ppi   = (VOID *) FvInfoPpi;\r
\r
          Status          = PeiServicesInstallPpi (FvInfoPpiDescriptor);\r
          ASSERT_EFI_ERROR (Status);\r
\r
          //\r
          // Makes the encapsulated volume show up in DXE phase to skip processing of\r
          // encapsulated file again.\r
          //\r
          BuildFv2Hob (\r
            (EFI_PHYSICAL_ADDRESS)(UINTN)FvHeader,\r
            FvHeader->FvLength, \r
            &VolumeInfo.FvName,\r
            &(((EFI_FFS_FILE_HEADER *)FileHandle)->Name)\r
            );\r
          return Status;\r
        }\r
      }\r
    }\r
  } while (!EFI_ERROR (VolumeStatus));\r
  \r
  return Status;\r
}\r
\r
/**\r
   Find the First Volume that contains the first FileType.\r
\r
   @param Instance      The Fv instance.\r
   @param SeachType     The type of file to search.\r
   @param VolumeHandle  Pointer to Fv which contains the file to search. \r
   @param FileHandle    Pointer to FFS file to search.\r
   \r
   @return EFI_SUCESS   Success to find the FFS in specificed FV\r
   @return others       Fail to find the FFS in specificed FV\r
 */\r
EFI_STATUS\r
DxeIplFindFirmwareVolumeInstance (\r
  IN OUT UINTN              *Instance,\r
  IN  EFI_FV_FILETYPE       SeachType,\r
  OUT EFI_PEI_FV_HANDLE     *VolumeHandle,\r
  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_STATUS  VolumeStatus;\r
\r
  do {\r
    VolumeStatus = PeiServicesFfsFindNextVolume (*Instance, VolumeHandle);\r
    if (!EFI_ERROR (VolumeStatus)) {\r
      *FileHandle = NULL;\r
      Status = PeiServicesFfsFindNextFile (SeachType, *VolumeHandle, FileHandle);\r
      if (!EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
    }\r
    *Instance += 1;\r
  } while (!EFI_ERROR (VolumeStatus));\r
\r
  return VolumeStatus;\r
}\r
\r
/**\r
   Loads and relocates a PE/COFF image into memory.\r
\r
   @param FileHandle        The image file handle\r
   @param ImageAddress      The base address of the relocated PE/COFF image\r
   @param ImageSize         The size of the relocated PE/COFF image\r
   @param EntryPoint        The entry point of the relocated PE/COFF image\r
   \r
   @return EFI_SUCCESS           The file was loaded and relocated\r
   @return EFI_OUT_OF_RESOURCES  There was not enough memory to load and relocate the PE/COFF file\r
**/\r
EFI_STATUS\r
PeiLoadFile (\r
  IN  EFI_PEI_FILE_HANDLE                       FileHandle,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
{\r
\r
  EFI_STATUS                        Status;\r
  PE_COFF_LOADER_IMAGE_CONTEXT      ImageContext;\r
  VOID                              *Pe32Data;\r
  EFI_PEI_PE_COFF_LOADER_PROTOCOL   *PeiEfiPeiPeCoffLoader;\r
\r
  PeiEfiPeiPeCoffLoader = (EFI_PEI_PE_COFF_LOADER_PROTOCOL *)GetPeCoffLoaderProtocol ();\r
  //\r
  // First try to find the required section in this ffs file.\r
  //\r
  Status = PeiServicesFfsFindSectionData (\r
             EFI_SECTION_PE32,\r
             FileHandle,\r
             &Pe32Data\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    Status = PeiServicesFfsFindSectionData (\r
               EFI_SECTION_TE,\r
               FileHandle,\r
               &Pe32Data\r
               );\r
  }\r
  \r
  if (EFI_ERROR (Status)) {\r
    //\r
    // NO image types we support so exit.\r
    //\r
    return Status;\r
  }\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
/**\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
\r
STATIC\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
  UINTN                           DstBufferSize;\r
  UINT32                          ScratchBufferSize;\r
  EFI_COMMON_SECTION_HEADER       *Section;\r
  UINTN                           SectionLength;\r
\r
  if (CompressionSection->CommonHeader.Type != EFI_SECTION_COMPRESSION) {\r
    ASSERT (FALSE);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Section = (EFI_COMMON_SECTION_HEADER *) CompressionSection;\r
  SectionLength         = *(UINT32 *) (Section->Size) & 0x00ffffff;\r
  \r
  //\r
  // This is a compression set, expand it\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 (FALSE);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *OutputSize = DstBufferSize;\r
  *OutputBuffer = DstBuffer;\r
\r
  return EFI_SUCCESS;\r
}\r
\r