]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.\r | |
3 | \r | |
4 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
6 | \r | |
7 | @par Revision Reference:\r | |
8 | This PPI is defined in PEI CIS\r | |
9 | Version 0.91.\r | |
10 | \r | |
11 | **/\r | |
12 | \r | |
13 | #ifndef _FIND_FV_H_\r | |
14 | #define _FIND_FV_H_\r | |
15 | \r | |
16 | ///\r | |
17 | /// Inconsistent with specification here:\r | |
18 | /// GUID value format has been changed to the standard GUID format.\r | |
19 | ///\r | |
20 | #define EFI_PEI_FIND_FV_PPI_GUID \\r | |
21 | { \\r | |
22 | 0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \\r | |
23 | }\r | |
24 | \r | |
25 | typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;\r | |
26 | \r | |
27 | /**\r | |
28 | This interface returns the base address of the firmware volume whose index\r | |
29 | was passed in FvNumber. Once this function reports a firmware volume\r | |
30 | index/base address pair, that index/address pairing must continue throughout PEI.\r | |
31 | \r | |
32 | @param PeiServices The pointer to the PEI Services Table.\r | |
33 | @param This Interface pointer that implements the Find FV service.\r | |
34 | @param FvNumber The index of the firmware volume to locate.\r | |
35 | @param FvAddress The address of the volume to discover.\r | |
36 | \r | |
37 | @retval EFI_SUCCESS An additional firmware volume was found.\r | |
38 | @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.\r | |
39 | @retval EFI_INVALID_PARAMETER *FvAddress is NULL.\r | |
40 | \r | |
41 | **/\r | |
42 | typedef\r | |
43 | EFI_STATUS\r | |
44 | (EFIAPI *EFI_PEI_FIND_FV_FINDFV)(\r | |
45 | IN EFI_PEI_FIND_FV_PPI *This,\r | |
46 | IN EFI_PEI_SERVICES **PeiServices,\r | |
47 | IN UINT8 *FvNumber,\r | |
48 | IN OUT EFI_FIRMWARE_VOLUME_HEADER **FVAddress\r | |
49 | );\r | |
50 | \r | |
51 | /**\r | |
52 | Hardware mechanisms for locating FVs in a platform vary widely.\r | |
53 | EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the\r | |
54 | PEI Foundation can remain standard across a wide variety of platforms.\r | |
55 | **/\r | |
56 | struct _EFI_PEI_FIND_FV_PPI {\r | |
57 | EFI_PEI_FIND_FV_FINDFV FindFv; ///< Service that abstracts the location of additional firmware volumes.\r | |
58 | };\r | |
59 | \r | |
60 | extern EFI_GUID gEfiFindFvPpiGuid;\r | |
61 | \r | |
62 | #endif\r |