MdeModulePkg/Include/Ppi/FindFv.h

   1 /** @file
   2   This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI
   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:  FindFv.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PEI CIS
  17   Version 0.91
  18
  19 **/
  20
  21 #ifndef __FIND_FV_H__
  22 #define __FIND_FV_H__
  23
  24 #define EFI_PEI_FIND_FV_PPI_GUID \
  25   { \
  26     0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
  27   }
  28
  29 typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
  30
  31 /**
  32   This interface returns the base address of the firmware volume whose index
  33   was passed in FvNumber.Once this function reports a firmware volume
  34   index/base address pair, that index/address pairing must continue throughout PEI.
  35
  36   @param  PeiServices    Pointer to the PEI Services Table.
  37   @param  This           Interface pointer that implements the Find FV service.
  38   @param  FvNumber       The index of the firmware volume to locate.
  39   @param  FvAddress      The address of the volume to discover.
  40
  41   @retval EFI_SUCCESS           An additional firmware volume was found.
  42   @retval EFI_OUT_OF_RESOURCES  There are no firmware volumes for the given FvNumber.
  43   @retval EFI_INVALID_PARAMETER *FvAddress is NULL.
  44
  45 **/
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EFI_PEI_FIND_FV_FINDFV) (
  49   IN EFI_PEI_FIND_FV_PPI      *This,
  50   IN EFI_PEI_SERVICES         **PeiServices,
  51   UINT8                       *FvNumber,
  52   EFI_FIRMWARE_VOLUME_HEADER  **FVAddress
  53   );
  54
  55 /**
  56   @par Ppi Description:
  57   Hardware mechanisms for locating FVs in a platform vary widely.
  58   EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the
  59   PEI Foundation can remain standard across a wide variety of platforms.
  60
  61   @param FindFv
  62   Service that abstracts the location of additional firmware volumes.
  63
  64 **/
  65 struct _EFI_PEI_FIND_FV_PPI {
  66   EFI_PEI_FIND_FV_FINDFV  FindFv;
  67 };
  68
  69 extern EFI_GUID gEfiFindFvPpiGuid;
  70
  71 #endif