MdePkg/Include/Ppi/PeiCoreFvLocation.h

   1 /** @file
   2   Header file for Pei Core FV Location PPI.
   3
   4   This PPI contains a pointer to the firmware volume which contains the PEI Foundation.
   5   If the PEI Foundation does not reside in the BFV, then SEC must pass this PPI as a part
   6   of the PPI list provided to the PEI Foundation Entry Point, otherwise the PEI Foundation
   7   shall assume that it resides within the BFV.
   8
   9   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
  10   This program and the accompanying materials
  11   are licensed and made available under the terms and conditions of the BSD License
  12   which accompanies this distribution.  The full text of the license may be found at
  13   http://opensource.org/licenses/bsd-license.php
  14
  15   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  16   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  17
  18   @par Revision Reference:
  19   This PPI is defined in UEFI Platform Initialization Specification 1.7 Volume 1:
  20   Standards
  21
  22 **/
  23
  24
  25 #ifndef _EFI_PEI_CORE_FV_LOCATION_H_
  26 #define _EFI_PEI_CORE_FV_LOCATION_H_
  27
  28 ///
  29 /// Global ID for EFI_PEI_CORE_FV_LOCATION_PPI
  30 ///
  31 #define EFI_PEI_CORE_FV_LOCATION_GUID \
  32   { \
  33     0x52888eae, 0x5b10, 0x47d0, {0xa8, 0x7f, 0xb8, 0x22, 0xab, 0xa0, 0xca, 0xf4 } \
  34   }
  35
  36 ///
  37 /// This PPI provides location of EFI PeiCoreFv.
  38 ///
  39 typedef struct {
  40   ///
  41   /// Pointer to the first byte of the firmware volume which contains the PEI Foundation.
  42   ///
  43   VOID    *PeiCoreFvLocation;
  44 } EFI_PEI_CORE_FV_LOCATION_PPI;
  45
  46 extern EFI_GUID gEfiPeiCoreFvLocationPpiGuid;
  47
  48 #endif // _EFI_PEI_CORE_FV_LOCATION_H_