MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Ppi / FirmwareVolumeInfo.h

/** @file\r
  This file provides location and format of a firmware volume.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is introduced in PI Version 1.0.\r
\r
**/\r
\r
#ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__\r
#define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__\r
\r
\r
\r
#define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \\r
{ 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }\r
\r
typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
\r
///\r
///  This PPI describes the location and format of a firmware volume.\r
///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for\r
///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is\r
///  the PI Firmware Volume format.\r
///\r
struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {\r
  ///\r
  /// Unique identifier of the format of the memory-mapped firmware volume.\r
  ///\r
  EFI_GUID  FvFormat;\r
  ///\r
  /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process\r
  /// the volume. The format of this buffer is specific to the FvFormat.\r
  /// For memory-mapped firmware volumes, this typically points to the first byte\r
  /// of the firmware volume.\r
  ///\r
  VOID      *FvInfo;\r
  ///\r
  /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
  /// this is typically the size of the firmware volume.\r
  ///\r
  UINT32    FvInfoSize;\r
  ///\r
  /// If the firmware volume originally came from a firmware file, then these\r
  /// point to the parent firmware volume name and firmware volume file.\r
  /// If it did not originally come from a firmware file, these should be NULL.\r
  ///\r
  EFI_GUID  *ParentFvName;\r
  ///\r
  /// If the firmware volume originally came from a firmware file, then these\r
  /// point to the parent firmware volume name and firmware volume file.\r
  /// If it did not originally come from a firmware file, these should be NULL.\r
  ///\r
  EFI_GUID  *ParentFileName;\r
};\r
\r
extern EFI_GUID gEfiPeiFirmwareVolumeInfoPpiGuid;\r
\r
#endif\r
\r