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