Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Ppi / Decompress.h

/** @file\r
  Provides decompression services to the PEI Foundatoin.\r
\r
  Copyright (c) 2006 - 2008, 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
  @par Revision Reference:\r
  This PPI is defined in PI Version 1.00.\r
\r
**/\r
\r
#ifndef __DECOMPRESS_PPI_H__\r
#define __DECOMPRESS_PPI_H__\r
\r
#define EFI_PEI_DECOMPRESS_PPI_GUID \\r
  { 0x1a36e4e7, 0xfab6, 0x476a, { 0x8e, 0x75, 0x69, 0x5a, 0x5, 0x76, 0xfd, 0xd7 } }\r
\r
typedef struct _EFI_PEI_DECOMPRESS_PPI  EFI_PEI_DECOMPRESS_PPI;\r
\r
/** \r
  Decompress a single compression section in a firmware file.\r
                                                               \r
  Decompresses the data in a compressed section and returns it\r
  as a series of standard PI Firmware File Sections. The\r
  required memory is allocated from permanent memory.\r
\r
  @param This         Points to this instance of the\r
                      EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to\r
                      the compressed section.\r
\r
  @param OutputBuffer Holds the returned pointer to the\r
                      decompressed sections.\r
\r
  @param OutputSize   Holds the returned size of the decompress\r
                      section streams.\r
\r
  @retval EFI_SUCCESS           The section was decompressed\r
                                successfully. OutputBuffer contains the\r
                                resulting data and OutputSize contains\r
                                the resulting size.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Unable to allocate sufficient\r
                                memory to hold the decompressed data.\r
\r
  @retval EFI_UNSUPPORTED       The compression type specified\r
                                in the compression header is unsupported.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_DECOMPRESS_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
/**\r
  @par Ppi Description:                                                              \r
  This PPI's single member function decompresses a compression\r
  encapsulated section. It is used by the PEI Foundation to\r
  process sectioned files. Prior to the installation of this PPI,\r
  compression sections will be ignored.\r
\r
  @param  Decompress  Decompress a single compression section in\r
                     a firmware file.\r
**/\r
struct _EFI_PEI_DECOMPRESS_PPI {\r
  EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;\r
};\r
\r
\r
extern EFI_GUID   gEfiPeiDecompressPpiGuid;\r
\r
#endif\r