MdePkg/Include/Ppi/FirmwareVolumeInfo.h

   1 /** @file
   2   This file provides location and format of a firmware volume.
   3
   4   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7   @par Revision Reference:
   8   This PPI is introduced in PI Version 1.0.
   9
  10 **/
  11
  12 #ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  13 #define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  14
  15 #define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \
  16 { 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }
  17
  18 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;
  19
  20 ///
  21 ///  This PPI describes the location and format of a firmware volume.
  22 ///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for
  23 ///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is
  24 ///  the PI Firmware Volume format.
  25 ///
  26 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {
  27   ///
  28   /// Unique identifier of the format of the memory-mapped firmware volume.
  29   ///
  30   EFI_GUID    FvFormat;
  31   ///
  32   /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process
  33   /// the volume. The format of this buffer is specific to the FvFormat.
  34   /// For memory-mapped firmware volumes, this typically points to the first byte
  35   /// of the firmware volume.
  36   ///
  37   VOID        *FvInfo;
  38   ///
  39   /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,
  40   /// this is typically the size of the firmware volume.
  41   ///
  42   UINT32      FvInfoSize;
  43   ///
  44   /// If the firmware volume originally came from a firmware file, then these
  45   /// point to the parent firmware volume name and firmware volume file.
  46   /// If it did not originally come from a firmware file, these should be NULL.
  47   ///
  48   EFI_GUID    *ParentFvName;
  49   ///
  50   /// If the firmware volume originally came from a firmware file, then these
  51   /// point to the parent firmware volume name and firmware volume file.
  52   /// If it did not originally come from a firmware file, these should be NULL.
  53   ///
  54   EFI_GUID    *ParentFileName;
  55 };
  56
  57 extern EFI_GUID  gEfiPeiFirmwareVolumeInfoPpiGuid;
  58
  59 #endif