MdePkg/Include/Ppi/FirmwareVolumeInfo.h

   1 /** @file
   2   This file provides location and format of a firmware volume.
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   @par Revision Reference:
  14   This PPI is defined in PI.
  15   Version 1.00
  16
  17 **/
  18
  19 #ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  20 #define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  21
  22
  23
  24 #define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \
  25 { 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }
  26
  27 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;
  28
  29 ///
  30 ///  This PPI describes the location and format of a firmware volume.
  31 ///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for
  32 ///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is
  33 ///  the PI Firmware Volume format.
  34 ///
  35 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {
  36   ///
  37   /// Unique identifier of the format of the memory-mapped firmware volume.
  38   ///
  39   EFI_GUID  FvFormat;
  40   ///
  41   /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process
  42   /// the volume. The format of this buffer is specific to the FvFormat.
  43   /// For memory-mapped firmware volumes, this typically points to the first byte
  44   /// of the firmware volume.
  45   ///
  46   VOID      *FvInfo;
  47   ///
  48   /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,
  49   /// this is typically the size of the firmware volume.
  50   ///
  51   UINT32    FvInfoSize;
  52   ///
  53   /// If the firmware volume originally came from a firmware file, then these
  54   /// point to the parent firmware volume name and firmware volume file.
  55   /// If it did not originally come from a firmware file, these should be NULL.
  56   ///
  57   EFI_GUID  *ParentFvName;
  58   ///
  59   /// If the firmware volume originally came from a firmware file, then these
  60   /// point to the parent firmware volume name and firmware volume file.
  61   /// If it did not originally come from a firmware file, these should be NULL.
  62   ///
  63   EFI_GUID  *ParentFileName;
  64 };
  65
  66 extern EFI_GUID gEfiPeiFirmwareVolumeInfoPpiGuid;
  67
  68 #endif
  69