]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: FindFv.h\r | |
14 | \r | |
15 | @par Revision Reference:\r | |
16 | This PPI is defined in PEI CIS\r | |
17 | Version 0.91\r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | #ifndef __FIND_FV_H__\r | |
22 | #define __FIND_FV_H__\r | |
23 | \r | |
24 | #define EFI_PEI_FIND_FV_PPI_GUID \\r | |
25 | { \\r | |
26 | 0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \\r | |
27 | }\r | |
28 | \r | |
29 | typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;\r | |
30 | \r | |
31 | /**\r | |
32 | This interface returns the base address of the firmware volume whose index \r | |
33 | was passed in FvNumber.Once this function reports a firmware volume \r | |
34 | index/base address pair, that index/address pairing must continue throughout PEI.\r | |
35 | \r | |
36 | @param PeiServices Pointer to the PEI Services Table.\r | |
37 | \r | |
38 | @param This Interface pointer that implements the Find FV service.\r | |
39 | \r | |
40 | @param FvNumber The index of the firmware volume to locate.\r | |
41 | \r | |
42 | @param FvAddress The address of the volume to discover.\r | |
43 | \r | |
44 | @retval EFI_SUCCESS An additional firmware volume was found.\r | |
45 | \r | |
46 | @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.\r | |
47 | \r | |
48 | @retval EFI_INVALID_PARAMETER *FvAddress is NULL.\r | |
49 | \r | |
50 | **/\r | |
51 | typedef\r | |
52 | EFI_STATUS\r | |
53 | (EFIAPI *EFI_PEI_FIND_FV_FINDFV) (\r | |
54 | IN EFI_PEI_FIND_FV_PPI *This,\r | |
55 | IN EFI_PEI_SERVICES **PeiServices,\r | |
56 | UINT8 *FvNumber,\r | |
57 | EFI_FIRMWARE_VOLUME_HEADER **FVAddress\r | |
58 | );\r | |
59 | \r | |
60 | /**\r | |
61 | @par Ppi Description:\r | |
62 | Hardware mechanisms for locating FVs in a platform vary widely.\r | |
63 | EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the \r | |
64 | PEI Foundation can remain standard across a wide variety of platforms.\r | |
65 | \r | |
66 | @param FindFv\r | |
67 | Service that abstracts the location of additional firmware volumes.\r | |
68 | \r | |
69 | **/\r | |
70 | struct _EFI_PEI_FIND_FV_PPI {\r | |
71 | EFI_PEI_FIND_FV_FINDFV FindFv;\r | |
72 | };\r | |
73 | \r | |
74 | extern EFI_GUID gEfiFindFvPpiGuid;\r | |
75 | \r | |
76 | #endif\r |