MdePkg/Include/Ppi/GuidedSectionExtraction.h

   1 /* @file
   2   If a GUID-defined section is encountered when doing section extraction,
   3   the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
   4   calls the appropriate instance of the GUIDed Section Extraction PPI
   5   to extract the section stream contained therein..
   6
   7   Copyright (c) 2006 - 2007, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   @par Revision Reference:
  17   This PPI is defined in PI Version 1.00.
  18
  19 **/
  20
  21 #ifndef __EFI_GUIDED_SECTION_EXTRACTION_PPI_H__
  22 #define __EFI_GUIDED_SECTION_EXTRACTION_PPI_H__
  23
  24 //
  25 // Typically, protocol interface structures are identified
  26 // by associating them with a GUID. Each instance of
  27 // a protocol with a given GUID must have
  28 // the same interface structure. While all instances of
  29 // the GUIDed Section Extraction PPI must have
  30 // the same interface structure, they do not all have
  31 // te same GUID. The GUID that is associated with
  32 // an instance of the GUIDed Section Extraction Protocol
  33 // is used to correlate it with the GUIDed section type
  34 // that it is intended to process.
  35 //
  36
  37
  38 typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI;
  39
  40
  41 /**
  42   The ExtractSection() function processes the input section and
  43   returns a pointer to the section contents. If the section being
  44   extracted does not require processing (if the section
  45   GuidedSectionHeader.Attributes has the
  46   EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then
  47   OutputBuffer is just updated to point to the start of the
  48   section's contents. Otherwise, *Buffer must be allocated
  49   from PEI permanent memory.
  50
  51   @param This                   Indicates the
  52                                 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.
  53                                 Buffer containing the input GUIDed section to be
  54                                 processed. OutputBuffer OutputBuffer is
  55                                 allocated from PEI permanent memory and contains
  56                                 the new section stream.
  57
  58   @param OutputSize             A pointer to a caller-allocated
  59                                 UINTN in which the size of *OutputBuffer
  60                                 allocation is stored. If the function
  61                                 returns anything other than EFI_SUCCESS,
  62                                 the value of OutputSize is undefined.
  63
  64   @param AuthenticationStatus   A pointer to a caller-allocated
  65                                 UINT32 that indicates the
  66                                 authentication status of the
  67                                 output buffer. If the input
  68                                 section's GuidedSectionHeader.
  69                                 Attributes field has the
  70                                 EFI_GUIDED_SECTION_AUTH_STATUS_VALID
  71                                 bit as clear,
  72                                 AuthenticationStatus must return
  73                                 zero. These bits reflect the
  74                                 status of the extraction
  75                                 operation. If the function
  76                                 returns anything other than
  77                                 EFI_SUCCESS, the value of
  78                                 AuthenticationStatus is
  79                                 undefined.
  80
  81   @retval EFI_SUCCESS           The InputSection was
  82                                 successfully processed and the
  83                                 section contents were returned.
  84
  85   @retval EFI_OUT_OF_RESOURCES  The system has insufficient
  86                                 resources to process the request.
  87
  88   @reteval EFI_INVALID_PARAMETER The GUID in InputSection does
  89                                 not match this instance of the
  90                                 GUIDed Section Extraction PPI.
  91 **/
  92 typedef
  93 EFI_STATUS
  94 (EFIAPI *EFI_PEI_EXTRACT_GUIDED_SECTION)(
  95   IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
  96   IN CONST  VOID                                  *InputSection,
  97   OUT       VOID                                  **OutputBuffer,
  98   OUT       UINTN                                 *OutputSize,
  99   OUT       UINT32                                *AuthenticationStatus
 100 );
 101
 102
 103
 104 /**
 105   If a GUID-defined section is encountered when doing section extraction,
 106   the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
 107   calls the appropriate instance of the GUIDed Section
 108   Extraction PPI to extract the section stream contained
 109   therein.
 110
 111
 112   @param ExtractSection   Takes the GUIDed section as input and
 113                           produces the section stream data. See
 114                           the ExtractSection() function
 115                           description.
 116
 117 **/
 118 struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI {
 119   EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection;
 120 };
 121
 122
 123
 124 #endif
 125