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   Module Name:  FirmwareVolumeInfo.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PI.
  17   Version 1.00
  18
  19 **/
  20
  21 #ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  22 #define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
  23
  24
  25
  26 #define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \
  27 { 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }
  28
  29 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;
  30
  31 /**
  32   This PPI describes the location and format of a firmware volume.
  33   The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for
  34   a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is
  35   the PI Firmware Volume format.
  36
  37   @param  FvFormat      Unique identifier of the format of the memory-mapped firmware volume.
  38
  39   @param  FvInfo        Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to
  40                         process the volume. The format of this buffer is
  41                         specific to the FvFormat. For memory-mapped firmware volumes,
  42                         this typically points to the first byte of the firmware volume.
  43
  44   @param  FvInfoSize    Size of the data provided by FvInfo. For memory-mapped firmware volumes,
  45                         this is typically the size of the firmware volume.
  46
  47   @param  ParentFvName  If the firmware volume originally came from a firmware file,
  48                         then these point to the parent firmware volume
  49                         name and firmware volume file. If it did not originally come
  50                         from a firmware file, these should be NULL.
  51
  52   @param  ParentFileName  If the firmware volume originally came from a firmware file,
  53                         then these point to the parent firmware volume
  54                         name and firmware volume file. If it did not originally come
  55                         from a firmware file, these should be NULL.
  56
  57 **/
  58 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {
  59   EFI_GUID  FvFormat;
  60   VOID      *FvInfo;
  61   UINT32    FvInfoSize;
  62   EFI_GUID  *ParentFvName;
  63   EFI_GUID  *ParentFileName;
  64 };
  65
  66 extern EFI_GUID gEfiPeiFirmwareVolumeInfoPpiGuid;
  67
  68 #endif
  69