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