2 This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI
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
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.
15 @par Revision Reference:
16 This PPI is defined in PEI CIS
25 /// Inconsistent with specification here:
26 /// GUID value format has been changed to the standard guid format.
28 #define EFI_PEI_FIND_FV_PPI_GUID \
30 0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
33 typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI
;
36 This interface returns the base address of the firmware volume whose index
37 was passed in FvNumber.Once this function reports a firmware volume
38 index/base address pair, that index/address pairing must continue throughout PEI.
40 @param PeiServices Pointer to the PEI Services Table.
41 @param This Interface pointer that implements the Find FV service.
42 @param FvNumber The index of the firmware volume to locate.
43 @param FvAddress The address of the volume to discover.
45 @retval EFI_SUCCESS An additional firmware volume was found.
46 @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
47 @retval EFI_INVALID_PARAMETER *FvAddress is NULL.
52 (EFIAPI
*EFI_PEI_FIND_FV_FINDFV
)(
53 IN EFI_PEI_FIND_FV_PPI
*This
,
54 IN EFI_PEI_SERVICES
**PeiServices
,
56 IN OUT EFI_FIRMWARE_VOLUME_HEADER
**FVAddress
60 Hardware mechanisms for locating FVs in a platform vary widely.
61 EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the
62 PEI Foundation can remain standard across a wide variety of platforms.
64 struct _EFI_PEI_FIND_FV_PPI
{
65 EFI_PEI_FIND_FV_FINDFV FindFv
; ///< Service that abstracts the location of additional firmware volumes.
68 extern EFI_GUID gEfiFindFvPpiGuid
;