IntelFrameworkPkg/Include/Ppi/FindFv.h

   1 /** @file
   2   This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.
   3
   4 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7   @par Revision Reference:
   8   This PPI is defined in PEI CIS
   9   Version 0.91.
  10
  11 **/
  12
  13 #ifndef _FIND_FV_H_
  14 #define _FIND_FV_H_
  15
  16 ///
  17 ///  Inconsistent with specification here:
  18 ///  GUID value format has been changed to the standard GUID format.
  19 ///
  20 #define EFI_PEI_FIND_FV_PPI_GUID \
  21   { \
  22     0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
  23   }
  24
  25 typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
  26
  27 /**
  28   This interface returns the base address of the firmware volume whose index
  29   was passed in FvNumber. Once this function reports a firmware volume
  30   index/base address pair, that index/address pairing must continue throughout PEI.
  31
  32   @param  PeiServices    The pointer to the PEI Services Table.
  33   @param  This           Interface pointer that implements the Find FV service.
  34   @param  FvNumber       The index of the firmware volume to locate.
  35   @param  FvAddress      The address of the volume to discover.
  36
  37   @retval EFI_SUCCESS           An additional firmware volume was found.
  38   @retval EFI_OUT_OF_RESOURCES  There are no firmware volumes for the given FvNumber.
  39   @retval EFI_INVALID_PARAMETER *FvAddress is NULL.
  40
  41 **/
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *EFI_PEI_FIND_FV_FINDFV)(
  45   IN EFI_PEI_FIND_FV_PPI             *This,
  46   IN EFI_PEI_SERVICES                **PeiServices,
  47   IN UINT8                           *FvNumber,
  48   IN OUT EFI_FIRMWARE_VOLUME_HEADER  **FVAddress
  49   );
  50
  51 /**
  52   Hardware mechanisms for locating FVs in a platform vary widely.
  53   EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the
  54   PEI Foundation can remain standard across a wide variety of platforms.
  55 **/
  56 struct _EFI_PEI_FIND_FV_PPI {
  57   EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.
  58 };
  59
  60 extern EFI_GUID gEfiFindFvPpiGuid;
  61
  62 #endif