[mirror_edk2.git] / BaseTools / Source / C / Include / Common / PiFirmwareVolume.h

/** @file\r
  The firmware volume related definitions in PI.\r
\r
  @par Revision Reference:\r
  Version 1.2C\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\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
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_WEAK_ALIGNMENT     0x80000000\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
\r
\r
typedef struct {\r
  UINT32 NumBlocks;\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
  UINT8                     ZeroVector[16];\r
  EFI_GUID                  FileSystemGuid;\r
  UINT64                    FvLength;\r
  UINT32                    Signature;\r
  EFI_FVB_ATTRIBUTES_2      Attributes;\r
  UINT16                    HeaderLength;\r
  UINT16                    Checksum;\r
  UINT16                    ExtHeaderOffset;\r
  UINT8                     Reserved[1];\r
  UINT8                     Revision;\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
  EFI_GUID  FvName;\r
  UINT32    ExtHeaderSize;\r
} EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
\r
typedef struct {\r
  UINT16    ExtEntrySize;\r
  UINT16    ExtEntryType;\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
\r
#define EFI_FV_EXT_TYPE_OEM_TYPE  0x01\r
typedef struct {\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
  UINT32    TypeMask;\r
\r
  //\r
  // Array of GUIDs.\r
  // Each GUID represents 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
typedef struct {\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY     Hdr;\r
  EFI_GUID                          FormatType;\r
\r
  //\r
  // An array 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
typedef struct {\r
  EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
  UINT32 UsedSize;\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE;\r
\r
#endif\r
Commit	Line	Data
30fdf114 LG	1	/** @file\r
	2	The firmware volume related definitions in PI.\r
	3	\r
97fa0ee9 YL	4	@par Revision Reference:\r
	5	Version 1.2C\r
	6	\r
f7496d71	7	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
30fdf114	8	\r
2e351cbe	9	SPDX-License-Identifier: BSD-2-Clause-Patent\r
30fdf114	10	\r
30fdf114 LG	11	**/\r
	12	\r
	13	#ifndef __PI_FIRMWAREVOLUME_H__\r
	14	#define __PI_FIRMWAREVOLUME_H__\r
	15	\r
	16	//\r
	17	// EFI_FV_FILE_ATTRIBUTES\r
	18	//\r
	19	typedef UINT32 EFI_FV_FILE_ATTRIBUTES;\r
	20	\r
	21	//\r
	22	// Value of EFI_FV_FILE_ATTRIBUTES.\r
f7496d71	23	//\r
30fdf114 LG	24	#define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F\r
	25	#define EFI_FV_FILE_ATTRIB_FIXED 0x00000100\r
	26	#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200\r
	27	\r
2bcc713e	28	typedef UINT32 EFI_FVB_ATTRIBUTES_2;\r
30fdf114	29	\r
f7496d71	30	//\r
30fdf114	31	// Attributes bit definitions\r
f7496d71	32	//\r
30fdf114 LG	33	#define EFI_FVB2_READ_DISABLED_CAP 0x00000001\r
	34	#define EFI_FVB2_READ_ENABLED_CAP 0x00000002\r
	35	#define EFI_FVB2_READ_STATUS 0x00000004\r
	36	#define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008\r
	37	#define EFI_FVB2_WRITE_ENABLED_CAP 0x00000010\r
	38	#define EFI_FVB2_WRITE_STATUS 0x00000020\r
	39	#define EFI_FVB2_LOCK_CAP 0x00000040\r
	40	#define EFI_FVB2_LOCK_STATUS 0x00000080\r
	41	#define EFI_FVB2_STICKY_WRITE 0x00000200\r
	42	#define EFI_FVB2_MEMORY_MAPPED 0x00000400\r
	43	#define EFI_FVB2_ERASE_POLARITY 0x00000800\r
	44	#define EFI_FVB2_READ_LOCK_CAP 0x00001000\r
	45	#define EFI_FVB2_READ_LOCK_STATUS 0x00002000\r
	46	#define EFI_FVB2_WRITE_LOCK_CAP 0x00004000\r
	47	#define EFI_FVB2_WRITE_LOCK_STATUS 0x00008000\r
	48	#define EFI_FVB2_ALIGNMENT 0x001F0000\r
e8a47801	49	#define EFI_FVB2_WEAK_ALIGNMENT 0x80000000\r
30fdf114 LG	50	#define EFI_FVB2_ALIGNMENT_1 0x00000000\r
	51	#define EFI_FVB2_ALIGNMENT_2 0x00010000\r
	52	#define EFI_FVB2_ALIGNMENT_4 0x00020000\r
	53	#define EFI_FVB2_ALIGNMENT_8 0x00030000\r
	54	#define EFI_FVB2_ALIGNMENT_16 0x00040000\r
	55	#define EFI_FVB2_ALIGNMENT_32 0x00050000\r
	56	#define EFI_FVB2_ALIGNMENT_64 0x00060000\r
	57	#define EFI_FVB2_ALIGNMENT_128 0x00070000\r
	58	#define EFI_FVB2_ALIGNMENT_256 0x00080000\r
	59	#define EFI_FVB2_ALIGNMENT_512 0x00090000\r
	60	#define EFI_FVB2_ALIGNMENT_1K 0x000A0000\r
	61	#define EFI_FVB2_ALIGNMENT_2K 0x000B0000\r
	62	#define EFI_FVB2_ALIGNMENT_4K 0x000C0000\r
	63	#define EFI_FVB2_ALIGNMENT_8K 0x000D0000\r
	64	#define EFI_FVB2_ALIGNMENT_16K 0x000E0000\r
	65	#define EFI_FVB2_ALIGNMENT_32K 0x000F0000\r
	66	#define EFI_FVB2_ALIGNMENT_64K 0x00100000\r
	67	#define EFI_FVB2_ALIGNMENT_128K 0x00110000\r
	68	#define EFI_FVB2_ALIGNMENT_256K 0x00120000\r
2bcc713e	69	#define EFI_FVB2_ALIGNMENT_512K 0x00130000\r
30fdf114 LG	70	#define EFI_FVB2_ALIGNMENT_1M 0x00140000\r
	71	#define EFI_FVB2_ALIGNMENT_2M 0x00150000\r
	72	#define EFI_FVB2_ALIGNMENT_4M 0x00160000\r
	73	#define EFI_FVB2_ALIGNMENT_8M 0x00170000\r
	74	#define EFI_FVB2_ALIGNMENT_16M 0x00180000\r
	75	#define EFI_FVB2_ALIGNMENT_32M 0x00190000\r
	76	#define EFI_FVB2_ALIGNMENT_64M 0x001A0000\r
	77	#define EFI_FVB2_ALIGNMENT_128M 0x001B0000\r
	78	#define EFI_FVB2_ALIGNMENT_256M 0x001C0000\r
	79	#define EFI_FVB2_ALIGNMENT_512M 0x001D0000\r
	80	#define EFI_FVB2_ALIGNMENT_1G 0x001E0000\r
	81	#define EFI_FVB2_ALIGNMENT_2G 0x001F0000\r
	82	\r
	83	\r
	84	typedef struct {\r
	85	UINT32 NumBlocks;\r
	86	UINT32 Length;\r
	87	} EFI_FV_BLOCK_MAP_ENTRY;\r
	88	\r
	89	//\r
	90	// Describes the features and layout of the firmware volume.\r
	91	//\r
	92	typedef struct {\r
	93	UINT8 ZeroVector[16];\r
	94	EFI_GUID FileSystemGuid;\r
	95	UINT64 FvLength;\r
	96	UINT32 Signature;\r
2bcc713e	97	EFI_FVB_ATTRIBUTES_2 Attributes;\r
30fdf114 LG	98	UINT16 HeaderLength;\r
	99	UINT16 Checksum;\r
	100	UINT16 ExtHeaderOffset;\r
	101	UINT8 Reserved[1];\r
	102	UINT8 Revision;\r
	103	EFI_FV_BLOCK_MAP_ENTRY BlockMap[1];\r
	104	} EFI_FIRMWARE_VOLUME_HEADER;\r
	105	\r
2bc3256c	106	#define EFI_FVH_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', 'H')\r
30fdf114 LG	107	\r
	108	///\r
	109	/// Firmware Volume Header Revision definition\r
	110	///\r
	111	#define EFI_FVH_REVISION 0x02\r
	112	\r
	113	//\r
	114	// Extension header pointed by ExtHeaderOffset of volume header.\r
f7496d71	115	//\r
30fdf114 LG	116	typedef struct {\r
	117	EFI_GUID FvName;\r
	118	UINT32 ExtHeaderSize;\r
	119	} EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
	120	\r
	121	typedef struct {\r
	122	UINT16 ExtEntrySize;\r
	123	UINT16 ExtEntryType;\r
	124	} EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
	125	\r
	126	#define EFI_FV_EXT_TYPE_OEM_TYPE 0x01\r
	127	typedef struct {\r
	128	EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
	129	UINT32 TypeMask;\r
	130	\r
	131	//\r
f7496d71	132	// Array of GUIDs.\r
30fdf114	133	// Each GUID represents an OEM file type.\r
f7496d71	134	//\r
2bcc713e LG	135	// EFI_GUID Types[1];\r
2bcc713e LG	136	//\r
30fdf114 LG	137	} EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;\r
30fdf114 LG	138	\r
2bcc713e LG	139	#define EFI_FV_EXT_TYPE_GUID_TYPE 0x0002\r
	140	typedef struct {\r
	141	EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
	142	EFI_GUID FormatType;\r
	143	\r
	144	//\r
fb0b35e0	145	// An array of bytes of length Length.\r
2bcc713e LG	146	//\r
	147	// UINT8 Data[1];\r
	148	//\r
	149	} EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE;\r
30fdf114	150	\r
9425b349 YF	151	#define EFI_FV_EXT_TYPE_USED_SIZE_TYPE 0x03\r
	152	typedef struct {\r
	153	EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
	154	UINT32 UsedSize;\r
	155	} EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE;\r
	156	\r
30fdf114	157	#endif\r