MdePkg/Include/Ppi/Decompress.h

   1 /* @file
   2   Provides decompression services to the PEI Foundatoin.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  Decompress.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PI Version 1.00.
  17
  18 **/
  19
  20 #ifndef __DECOMPRESS_PPI_H__
  21 #define __DECOMPRESS_PPI_H__
  22
  23 #define EFI_PEI_DECOMPRESS_PPI_GUID \
  24         { 0x1a36e4e7, 0xfab6, 0x476a, { 0x8e, 0x75, 0x69, 0x5a, 0x5, 0x76, 0xfd, 0xd7 } }
  25
  26 typedef struct _EFI_PEI_DECOMPRESS_PPI  EFI_PEI_DECOMPRESS_PPI;;
  27
  28 /**
  29   Decompresses the data in a compressed section and returns it
  30   as a series of standard PI Firmware File Sections. The
  31   required memory is allocated from permanent memory.
  32
  33   @param This                           Points to this instance of the
  34                                                                                         EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to
  35                                                                                         the compressed section.
  36
  37   @param OutputBuffer Holds the returned pointer to the
  38                       decompressed sections.
  39
  40   @param OutputSize     Holds the returned size of the decompress
  41                       section streams.
  42
  43   @retval EFI_SUCCESS                                   The section was decompressed
  44                                                                                                                                 successfully. OutputBuffer contains the
  45                                                                                                                                 resulting data and OutputSize contains
  46                                                                                                                                 the resulting size.
  47
  48   @retval EFI_OUT_OF_RESOURCES  Unable to allocate sufficient
  49                                 memory to hold the decompressed data.
  50
  51   @retval       EFI_UNSUPPORTED                         The compression type specified
  52                                                                                                                                 in the compression header is unsupported.
  53 **/
  54 typedef
  55 EFI_STATUS
  56 (EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(
  57         IN CONST        EFI_PEI_DECOMPRESS_PPI  *This,
  58         IN CONST        EFI_COMPRESSION_SECTION *InputSection,
  59         OUT                     VOID                                                                            **OutputBuffer,
  60         OUT                     UINTN                                                                   *OutputSize
  61 );
  62
  63
  64 /**
  65   This PPI¡¯s single member function decompresses a compression
  66         encapsulated section. It is used by the PEI Foundation to
  67         process sectioned files. Prior to the installation of this PPI,
  68   compression sections will be ignored.
  69
  70   @param        Decompress      Decompress a single compression section in
  71                      a firmware file.
  72 **/
  73 struct _EFI_PEI_DECOMPRESS_PPI {
  74         EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;
  75 };
  76
  77
  78 extern EFI_GUID         gEfiPeiDecompressPpiGuid;
  79
  80 #endif