MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Decompress.h File Reference

Data Structures

struct  _EFI_PEI_DECOMPRESS_PPI
 

Macros

#define EFI_PEI_DECOMPRESS_PPI_GUID   { 0x1a36e4e7, 0xfab6, 0x476a, { 0x8e, 0x75, 0x69, 0x5a, 0x5, 0x76, 0xfd, 0xd7 } }
 

Typedefs

typedef struct
_EFI_PEI_DECOMPRESS_PPI 
EFI_PEI_DECOMPRESS_PPI
 
typedef EFI_STATUS(EFIAPIEFI_PEI_DECOMPRESS_DECOMPRESS )(IN CONST EFI_PEI_DECOMPRESS_PPI *This, IN CONST EFI_COMPRESSION_SECTION *InputSection, OUT VOID **OutputBuffer, OUT UINTN *OutputSize)
 

Variables

EFI_GUID gEfiPeiDecompressPpiGuid
 

Detailed Description

Provides decompression services to the PEI Foundation.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:
This PPI is introduced in PI Version 1.0.

Macro Definition Documentation

#define EFI_PEI_DECOMPRESS_PPI_GUID   { 0x1a36e4e7, 0xfab6, 0x476a, { 0x8e, 0x75, 0x69, 0x5a, 0x5, 0x76, 0xfd, 0xd7 } }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_DECOMPRESS_DECOMPRESS)(IN CONST EFI_PEI_DECOMPRESS_PPI *This, IN CONST EFI_COMPRESSION_SECTION *InputSection, OUT VOID **OutputBuffer, OUT UINTN *OutputSize)

Decompress a single compression section in a firmware file.

Decompresses the data in a compressed section and returns it as a series of standard PI Firmware File Sections. The required memory is allocated from permanent memory.

Parameters
ThisPoints to this instance of the EFI_PEI_DECOMPRESS_PEI PPI.
InputSectionPoints to the compressed section.
OutputBufferHolds the returned pointer to the decompressed sections.
OutputSizeHolds the returned size of the decompress section streams.
Return values
EFI_SUCCESSThe section was decompressed successfully. OutputBuffer contains the resulting data and OutputSize contains the resulting size.
EFI_OUT_OF_RESOURCESUnable to allocate sufficient memory to hold the decompressed data.
EFI_UNSUPPORTEDThe compression type specified in the compression header is unsupported.

Variable Documentation

EFI_GUID gEfiPeiDecompressPpiGuid