Decompress.h File Reference

Go to the source code of this file.

Classes
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(EFIAPI *	EFI_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 Foundatoin.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:

This PPI is introduced in PI Version 1.0.

Macro Definition Documentation

EFI_PEI_DECOMPRESS_PPI_GUID

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

Typedef Documentation

EFI_PEI_DECOMPRESS_DECOMPRESS

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

This	Points to this instance of the EFI_PEI_DECOMPRESS_PEI PPI.
InputSection	Points to the compressed section.
OutputBuffer	Holds the returned pointer to the decompressed sections.
OutputSize	Holds the returned size of the decompress section streams.

Return values

EFI_SUCCESS	The section was decompressed successfully. OutputBuffer contains the resulting data and OutputSize contains the resulting size.
EFI_OUT_OF_RESOURCES	Unable to allocate sufficient memory to hold the decompressed data.
EFI_UNSUPPORTED	The compression type specified in the compression header is unsupported.

EFI_PEI_DECOMPRESS_PPI

typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI

Variable Documentation

gEfiPeiDecompressPpiGuid

EFI_GUID gEfiPeiDecompressPpiGuid

extern