IntelFrameworkPkg/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) 2007 - 2009, 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 #include <PiPei.h>
  25
  26 ///
  27 ///  Inconsistent with specification here:
  28 ///  GUID value format has been changed to the standard guid format.
  29 ///
  30 #define EFI_PEI_FIND_FV_PPI_GUID \
  31   { \
  32     0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
  33   }
  34
  35 typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
  36
  37 /**
  38   This interface returns the base address of the firmware volume whose index
  39   was passed in FvNumber.Once this function reports a firmware volume
  40   index/base address pair, that index/address pairing must continue throughout PEI.
  41
  42   @param  PeiServices    Pointer to the PEI Services Table.
  43   @param  This           Interface pointer that implements the Find FV service.
  44   @param  FvNumber       The index of the firmware volume to locate.
  45   @param  FvAddress      The address of the volume to discover.
  46
  47   @retval EFI_SUCCESS           An additional firmware volume was found.
  48   @retval EFI_OUT_OF_RESOURCES  There are no firmware volumes for the given FvNumber.
  49   @retval EFI_INVALID_PARAMETER *FvAddress is NULL.
  50
  51 **/
  52 typedef
  53 EFI_STATUS
  54 (EFIAPI *EFI_PEI_FIND_FV_FINDFV)(
  55   IN EFI_PEI_FIND_FV_PPI             *This,
  56   IN EFI_PEI_SERVICES                **PeiServices,
  57   IN UINT8                           *FvNumber,
  58   IN OUT EFI_FIRMWARE_VOLUME_HEADER  **FVAddress
  59   );
  60
  61 /**
  62   Hardware mechanisms for locating FVs in a platform vary widely.
  63   EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the
  64   PEI Foundation can remain standard across a wide variety of platforms.
  65 **/
  66 struct _EFI_PEI_FIND_FV_PPI {
  67   EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.
  68 };
  69
  70 extern EFI_GUID gEfiFindFvPpiGuid;
  71
  72 #endif