Remove IntelFrameworkModulePkg

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / FindFv.h

/** @file\r
  This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is defined in PEI CIS\r
  Version 0.91.\r
\r
**/\r
\r
#ifndef _FIND_FV_H_\r
#define _FIND_FV_H_\r
\r
///\r
///  Inconsistent with specification here:\r
///  GUID value format has been changed to the standard GUID format.\r
///\r
#define EFI_PEI_FIND_FV_PPI_GUID \\r
  { \\r
    0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \\r
  }\r
\r
typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;\r
\r
/**\r
  This interface returns the base address of the firmware volume whose index\r
  was passed in FvNumber. Once this function reports a firmware volume\r
  index/base address pair, that index/address pairing must continue throughout PEI.\r
\r
  @param  PeiServices    The pointer to the PEI Services Table.\r
  @param  This           Interface pointer that implements the Find FV service.\r
  @param  FvNumber       The index of the firmware volume to locate.\r
  @param  FvAddress      The address of the volume to discover.\r
\r
  @retval EFI_SUCCESS           An additional firmware volume was found.\r
  @retval EFI_OUT_OF_RESOURCES  There are no firmware volumes for the given FvNumber.\r
  @retval EFI_INVALID_PARAMETER *FvAddress is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_FIND_FV_FINDFV)(\r
  IN EFI_PEI_FIND_FV_PPI             *This,\r
  IN EFI_PEI_SERVICES                **PeiServices,\r
  IN UINT8                           *FvNumber,\r
  IN OUT EFI_FIRMWARE_VOLUME_HEADER  **FVAddress\r
  );\r
\r
/**\r
  Hardware mechanisms for locating FVs in a platform vary widely.\r
  EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the\r
  PEI Foundation can remain standard across a wide variety of platforms.\r
**/\r
struct _EFI_PEI_FIND_FV_PPI {\r
  EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.\r
};\r
\r
extern EFI_GUID gEfiFindFvPpiGuid;\r
\r
#endif\r