MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareVolume.h

/** @file\r
  The firmware volume related definitions in PI.\r
\r
  Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  PI Version 1.6\r
\r
**/\r
\r
#ifndef __PI_FIRMWAREVOLUME_H__\r
#define __PI_FIRMWAREVOLUME_H__\r
\r
///\r
/// EFI_FV_FILE_ATTRIBUTES\r
///\r
typedef UINT32  EFI_FV_FILE_ATTRIBUTES;\r
\r
//\r
// Value of EFI_FV_FILE_ATTRIBUTES.\r
//\r
#define EFI_FV_FILE_ATTRIB_ALIGNMENT      0x0000001F\r
#define EFI_FV_FILE_ATTRIB_FIXED          0x00000100\r
#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED  0x00000200\r
\r
///\r
/// type of EFI FVB attribute\r
///\r
typedef UINT32  EFI_FVB_ATTRIBUTES_2;\r
\r
//\r
// Attributes bit definitions\r
//\r
#define EFI_FVB2_READ_DISABLED_CAP  0x00000001\r
#define EFI_FVB2_READ_ENABLED_CAP   0x00000002\r
#define EFI_FVB2_READ_STATUS        0x00000004\r
#define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008\r
#define EFI_FVB2_WRITE_ENABLED_CAP  0x00000010\r
#define EFI_FVB2_WRITE_STATUS       0x00000020\r
#define EFI_FVB2_LOCK_CAP           0x00000040\r
#define EFI_FVB2_LOCK_STATUS        0x00000080\r
#define EFI_FVB2_STICKY_WRITE       0x00000200\r
#define EFI_FVB2_MEMORY_MAPPED      0x00000400\r
#define EFI_FVB2_ERASE_POLARITY     0x00000800\r
#define EFI_FVB2_READ_LOCK_CAP      0x00001000\r
#define EFI_FVB2_READ_LOCK_STATUS   0x00002000\r
#define EFI_FVB2_WRITE_LOCK_CAP     0x00004000\r
#define EFI_FVB2_WRITE_LOCK_STATUS  0x00008000\r
#define EFI_FVB2_ALIGNMENT          0x001F0000\r
#define EFI_FVB2_ALIGNMENT_1        0x00000000\r
#define EFI_FVB2_ALIGNMENT_2        0x00010000\r
#define EFI_FVB2_ALIGNMENT_4        0x00020000\r
#define EFI_FVB2_ALIGNMENT_8        0x00030000\r
#define EFI_FVB2_ALIGNMENT_16       0x00040000\r
#define EFI_FVB2_ALIGNMENT_32       0x00050000\r
#define EFI_FVB2_ALIGNMENT_64       0x00060000\r
#define EFI_FVB2_ALIGNMENT_128      0x00070000\r
#define EFI_FVB2_ALIGNMENT_256      0x00080000\r
#define EFI_FVB2_ALIGNMENT_512      0x00090000\r
#define EFI_FVB2_ALIGNMENT_1K       0x000A0000\r
#define EFI_FVB2_ALIGNMENT_2K       0x000B0000\r
#define EFI_FVB2_ALIGNMENT_4K       0x000C0000\r
#define EFI_FVB2_ALIGNMENT_8K       0x000D0000\r
#define EFI_FVB2_ALIGNMENT_16K      0x000E0000\r
#define EFI_FVB2_ALIGNMENT_32K      0x000F0000\r
#define EFI_FVB2_ALIGNMENT_64K      0x00100000\r
#define EFI_FVB2_ALIGNMENT_128K     0x00110000\r
#define EFI_FVB2_ALIGNMENT_256K     0x00120000\r
#define EFI_FVB2_ALIGNMENT_512K     0x00130000\r
#define EFI_FVB2_ALIGNMENT_1M       0x00140000\r
#define EFI_FVB2_ALIGNMENT_2M       0x00150000\r
#define EFI_FVB2_ALIGNMENT_4M       0x00160000\r
#define EFI_FVB2_ALIGNMENT_8M       0x00170000\r
#define EFI_FVB2_ALIGNMENT_16M      0x00180000\r
#define EFI_FVB2_ALIGNMENT_32M      0x00190000\r
#define EFI_FVB2_ALIGNMENT_64M      0x001A0000\r
#define EFI_FVB2_ALIGNMENT_128M     0x001B0000\r
#define EFI_FVB2_ALIGNMENT_256M     0x001C0000\r
#define EFI_FVB2_ALIGNMENT_512M     0x001D0000\r
#define EFI_FVB2_ALIGNMENT_1G       0x001E0000\r
#define EFI_FVB2_ALIGNMENT_2G       0x001F0000\r
#define EFI_FVB2_WEAK_ALIGNMENT     0x80000000\r
\r
typedef struct {\r
  ///\r
  /// The number of sequential blocks which are of the same size.\r
  ///\r
  UINT32 NumBlocks;\r
  ///\r
  /// The size of the blocks.\r
  ///\r
  UINT32 Length;\r
} EFI_FV_BLOCK_MAP_ENTRY;\r
\r
///\r
/// Describes the features and layout of the firmware volume.\r
///\r
typedef struct {\r
  ///\r
  /// The first 16 bytes are reserved to allow for the reset vector of\r
  /// processors whose reset vector is at address 0.\r
  ///\r
  UINT8                     ZeroVector[16];\r
  ///\r
  /// Declares the file system with which the firmware volume is formatted.\r
  ///\r
  EFI_GUID                  FileSystemGuid;\r
  ///\r
  /// Length in bytes of the complete firmware volume, including the header.\r
  ///\r
  UINT64                    FvLength;\r
  ///\r
  /// Set to EFI_FVH_SIGNATURE\r
  ///\r
  UINT32                    Signature;\r
  ///\r
  /// Declares capabilities and power-on defaults for the firmware volume.\r
  ///\r
  EFI_FVB_ATTRIBUTES_2      Attributes;\r
  ///\r
  /// Length in bytes of the complete firmware volume header.\r
  ///\r
  UINT16                    HeaderLength;\r
  ///\r
  /// A 16-bit checksum of the firmware volume header. A valid header sums to zero.\r
  ///\r
  UINT16                    Checksum;\r
  ///\r
  /// Offset, relative to the start of the header, of the extended header\r
  /// (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is no extended header.\r
  ///\r
  UINT16                    ExtHeaderOffset;\r
  ///\r
  /// This field must always be set to zero.\r
  ///\r
  UINT8                     Reserved[1];\r
  ///\r
  /// Set to 2. Future versions of this specification may define new header fields and will\r
  /// increment the Revision field accordingly.\r
  ///\r
  UINT8                     Revision;\r
  ///\r
  /// An array of run-length encoded FvBlockMapEntry structures. The array is\r
  /// terminated with an entry of {0,0}.\r
  ///\r
  EFI_FV_BLOCK_MAP_ENTRY    BlockMap[1];\r
} EFI_FIRMWARE_VOLUME_HEADER;\r
\r
#define EFI_FVH_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', 'H')\r
\r
///\r
/// Firmware Volume Header Revision definition\r
///\r
#define EFI_FVH_REVISION  0x02\r
\r
///\r
/// Extension header pointed by ExtHeaderOffset of volume header.\r
///\r
typedef struct {\r
  ///\r
  /// Firmware volume name.\r
  ///\r
  EFI_GUID  FvName;\r
  ///\r
  /// Size of the rest of the extension header, including this structure.\r
  ///\r
  UINT32    ExtHeaderSize;\r
} EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
\r
///\r
/// Entry struture for describing FV extension header\r
///\r
typedef struct {\r
  ///\r
  /// Size of this header extension.\r
  ///\r
  UINT16    ExtEntrySize;\r
  ///\r
  /// Type of the header.\r
  ///\r
  UINT16    ExtEntryType;\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
\r
#define EFI_FV_EXT_TYPE_OEM_TYPE  0x01\r
///\r
/// This extension header provides a mapping between a GUID and an OEM file type.\r
///\r
typedef struct {\r
  ///\r
  /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.\r
  ///\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
  ///\r
  /// A bit mask, one bit for each file type between 0xC0 (bit 0) and 0xDF (bit 31). If a bit\r
  /// is '1', then the GUID entry exists in Types. If a bit is '0' then no GUID entry exists in Types.\r
  ///\r
  UINT32    TypeMask;\r
  ///\r
  /// An array of GUIDs, each GUID representing an OEM file type.\r
  ///\r
  /// EFI_GUID  Types[1];\r
  ///\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;\r
\r
#define EFI_FV_EXT_TYPE_GUID_TYPE 0x0002\r
\r
///\r
/// This extension header EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE provides a vendor specific\r
/// GUID FormatType type which includes a length and a successive series of data bytes.\r
///\r
typedef struct {\r
  ///\r
  /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.\r
  ///\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY     Hdr;\r
  ///\r
  /// Vendor-specific GUID.\r
  ///\r
  EFI_GUID                          FormatType;\r
  ///\r
  /// An arry of bytes of length Length.\r
  ///\r
  /// UINT8                             Data[1];\r
  ///\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE;\r
\r
#define EFI_FV_EXT_TYPE_USED_SIZE_TYPE 0x03\r
\r
///\r
/// The EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE can be used to find\r
/// out how many EFI_FVB2_ERASE_POLARITY bytes are at the end of the FV.\r
///\r
typedef struct {\r
  ///\r
  /// Standard extension entry, with the type EFI_FV_EXT_TYPE_USED_SIZE_TYPE.\r
  ///\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY     Hdr;\r
  ///\r
  /// The number of bytes of the FV that are in uses. The remaining\r
  /// EFI_FIRMWARE_VOLUME_HEADER FvLength minus UsedSize bytes in\r
  /// the FV must contain the value implied by EFI_FVB2_ERASE_POLARITY.\r
  ///\r
  UINT32                            UsedSize;\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE;\r
\r
#endif\r