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

/** @file\r
  The firmware file related definitions in PI.\r
\r
  @par Revision Reference:\r
  Version 1.4.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution.  The full text of the license may be found at\r
    http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __PI_FIRMWARE_FILE_H__\r
#define __PI_FIRMWARE_FILE_H__\r
\r
#pragma pack(1)\r
//\r
// Used to verify the integrity of the file.\r
//\r
typedef union {\r
  struct {\r
    UINT8   Header;\r
    UINT8   File;\r
  } Checksum;\r
  UINT16    Checksum16;\r
} EFI_FFS_INTEGRITY_CHECK;\r
\r
typedef UINT8 EFI_FV_FILETYPE;\r
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
typedef UINT8 EFI_FFS_FILE_STATE;\r
\r
//\r
// File Types Definitions\r
//\r
#define EFI_FV_FILETYPE_ALL                   0x00\r
#define EFI_FV_FILETYPE_RAW                   0x01\r
#define EFI_FV_FILETYPE_FREEFORM              0x02\r
#define EFI_FV_FILETYPE_SECURITY_CORE         0x03\r
#define EFI_FV_FILETYPE_PEI_CORE              0x04\r
#define EFI_FV_FILETYPE_DXE_CORE              0x05\r
#define EFI_FV_FILETYPE_PEIM                  0x06\r
#define EFI_FV_FILETYPE_DRIVER                0x07\r
#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  0x08\r
#define EFI_FV_FILETYPE_APPLICATION           0x09\r
#define EFI_FV_FILETYPE_SMM                   0x0A\r
#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r
#define EFI_FV_FILETYPE_COMBINED_SMM_DXE      0x0C\r
#define EFI_FV_FILETYPE_SMM_CORE              0x0D\r
#define EFI_FV_FILETYPE_MM_STANDALONE         0x0E\r
#define EFI_FV_FILETYPE_MM_CORE_STANDALONE    0x0F\r
#define EFI_FV_FILETYPE_OEM_MIN               0xc0\r
#define EFI_FV_FILETYPE_OEM_MAX               0xdf\r
#define EFI_FV_FILETYPE_DEBUG_MIN             0xe0\r
#define EFI_FV_FILETYPE_DEBUG_MAX             0xef\r
#define EFI_FV_FILETYPE_FFS_MIN               0xf0\r
#define EFI_FV_FILETYPE_FFS_MAX               0xff\r
#define EFI_FV_FILETYPE_FFS_PAD               0xf0\r
//\r
// FFS File Attributes.\r
//\r
#define FFS_ATTRIB_LARGE_FILE         0x01\r
#define FFS_ATTRIB_DATA_ALIGNMENT2    0x02\r
#define FFS_ATTRIB_FIXED              0x04\r
#define FFS_ATTRIB_DATA_ALIGNMENT     0x38\r
#define FFS_ATTRIB_CHECKSUM           0x40\r
//\r
// FFS_FIXED_CHECKSUM is the checksum value used when the\r
// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
//\r
#define FFS_FIXED_CHECKSUM  0xAA\r
\r
//\r
// FFS File State Bits.\r
//\r
#define EFI_FILE_HEADER_CONSTRUCTION  0x01\r
#define EFI_FILE_HEADER_VALID         0x02\r
#define EFI_FILE_DATA_VALID           0x04\r
#define EFI_FILE_MARKED_FOR_UPDATE    0x08\r
#define EFI_FILE_DELETED              0x10\r
#define EFI_FILE_HEADER_INVALID       0x20\r
\r
#define EFI_FILE_ALL_STATE_BITS       (EFI_FILE_HEADER_CONSTRUCTION | \\r
                                 EFI_FILE_HEADER_VALID | \\r
                                 EFI_FILE_DATA_VALID | \\r
                                 EFI_FILE_MARKED_FOR_UPDATE | \\r
                                 EFI_FILE_DELETED | \\r
                                 EFI_FILE_HEADER_INVALID \\r
                                  )\r
\r
//\r
// Each file begins with the header that describe the\r
// contents and state of the files.\r
//\r
typedef struct {\r
  EFI_GUID                Name;\r
  EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
  EFI_FV_FILETYPE         Type;\r
  EFI_FFS_FILE_ATTRIBUTES Attributes;\r
  UINT8                   Size[3];\r
  EFI_FFS_FILE_STATE      State;\r
} EFI_FFS_FILE_HEADER;\r
\r
typedef struct {\r
  EFI_GUID                Name;\r
  EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
  EFI_FV_FILETYPE         Type;\r
  EFI_FFS_FILE_ATTRIBUTES Attributes;\r
  UINT8                   Size[3];\r
  EFI_FFS_FILE_STATE      State;\r
  UINT64                  ExtendedSize;\r
} EFI_FFS_FILE_HEADER2;\r
\r
#define MAX_FFS_SIZE        0x1000000\r
\r
typedef UINT8 EFI_SECTION_TYPE;\r
\r
//\r
// Pseudo type. It is\r
// used as a wild card when retrieving sections. The section\r
// type EFI_SECTION_ALL matches all section types.\r
//\r
#define EFI_SECTION_ALL                   0x00\r
\r
//\r
// Encapsulation section Type values\r
//\r
#define EFI_SECTION_COMPRESSION           0x01\r
\r
#define EFI_SECTION_GUID_DEFINED          0x02\r
\r
//\r
// Leaf section Type values\r
//\r
#define EFI_SECTION_PE32                  0x10\r
#define EFI_SECTION_PIC                   0x11\r
#define EFI_SECTION_TE                    0x12\r
#define EFI_SECTION_DXE_DEPEX             0x13\r
#define EFI_SECTION_VERSION               0x14\r
#define EFI_SECTION_USER_INTERFACE        0x15\r
#define EFI_SECTION_COMPATIBILITY16       0x16\r
#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
#define EFI_SECTION_RAW                   0x19\r
#define EFI_SECTION_PEI_DEPEX             0x1B\r
#define EFI_SECTION_SMM_DEPEX             0x1C\r
\r
typedef struct {\r
  UINT8             Size[3];\r
  EFI_SECTION_TYPE  Type;\r
} EFI_COMMON_SECTION_HEADER;\r
\r
typedef struct {\r
  UINT8             Size[3];\r
  EFI_SECTION_TYPE  Type;\r
  UINT32            ExtendedSize;\r
} EFI_COMMON_SECTION_HEADER2;\r
\r
#define MAX_SECTION_SIZE        0x1000000\r
\r
//\r
// Leaf section type that contains an\r
// IA-32 16-bit executable image.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r
\r
//\r
// CompressionType of EFI_COMPRESSION_SECTION.\r
//\r
#define EFI_NOT_COMPRESSED        0x00\r
#define EFI_STANDARD_COMPRESSION  0x01\r
//\r
// An encapsulation section type in which the\r
// section data is compressed.\r
//\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  UINT32                      UncompressedLength;\r
  UINT8                       CompressionType;\r
} EFI_COMPRESSION_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2  CommonHeader;\r
  UINT32                      UncompressedLength;\r
  UINT8                       CompressionType;\r
} EFI_COMPRESSION_SECTION2;\r
\r
//\r
// Leaf section which could be used to determine the dispatch order of DXEs.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r
\r
//\r
// Leaf section witch contains a PI FV.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
\r
//\r
// Leaf section which contains a single GUID.\r
//\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  EFI_GUID                    SubTypeGuid;\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2  CommonHeader;\r
  EFI_GUID                    SubTypeGuid;\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
\r
//\r
// Attributes of EFI_GUID_DEFINED_SECTION\r
//\r
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01\r
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02\r
//\r
// Leaf section which is encapsulation defined by specific GUID\r
//\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  EFI_GUID                    SectionDefinitionGuid;\r
  UINT16                      DataOffset;\r
  UINT16                      Attributes;\r
} EFI_GUID_DEFINED_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2  CommonHeader;\r
  EFI_GUID                    SectionDefinitionGuid;\r
  UINT16                      DataOffset;\r
  UINT16                      Attributes;\r
} EFI_GUID_DEFINED_SECTION2;\r
\r
//\r
// Leaf section which contains PE32+ image.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r
\r
//\r
// Leaf section which contains PIC image.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r
\r
//\r
// Leaf section which used to determine the dispatch order of PEIMs.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r
\r
//\r
// Leaf section which constains the position-independent-code image.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r
\r
//\r
// Leaf section which contains an array of zero or more bytes.\r
//\r
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r
\r
//\r
// Leaf section which contains a unicode string that\r
// is human readable file name.\r
//\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
\r
  //\r
  // Array of unicode string.\r
  //\r
  CHAR16                      FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2  CommonHeader;\r
\r
  //\r
  // Array of unicode string.\r
  //\r
  CHAR16                      FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION2;\r
\r
//\r
// Leaf section which contains a numeric build number and\r
// an optional unicode string that represent the file revision.\r
//\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  UINT16                      BuildNumber;\r
  CHAR16                      VersionString[1];\r
} EFI_VERSION_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2  CommonHeader;\r
  UINT16                      BuildNumber;\r
  CHAR16                      VersionString[1];\r
} EFI_VERSION_SECTION2;\r
\r
#define SECTION_SIZE(SectionHeaderPtr) \\r
    ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
\r
#pragma pack()\r
\r
typedef union {\r
  EFI_COMMON_SECTION_HEADER         *CommonHeader;\r
  EFI_COMPRESSION_SECTION           *CompressionSection;\r
  EFI_GUID_DEFINED_SECTION          *GuidDefinedSection;\r
  EFI_PE32_SECTION                  *Pe32Section;\r
  EFI_PIC_SECTION                   *PicSection;\r
  EFI_TE_SECTION                    *TeSection;\r
  EFI_PEI_DEPEX_SECTION             *PeimHeaderSection;\r
  EFI_DXE_DEPEX_SECTION             *DependencySection;\r
  EFI_VERSION_SECTION               *VersionSection;\r
  EFI_USER_INTERFACE_SECTION        *UISection;\r
  EFI_COMPATIBILITY16_SECTION       *Code16Section;\r
  EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
  EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
  EFI_RAW_SECTION                   *RawSection;\r
  //\r
  // For section whose size is equal or greater than 0x1000000\r
  //\r
  EFI_COMMON_SECTION_HEADER2         *CommonHeader2;\r
  EFI_COMPRESSION_SECTION2           *CompressionSection2;\r
  EFI_GUID_DEFINED_SECTION2          *GuidDefinedSection2;\r
  EFI_PE32_SECTION2                  *Pe32Section2;\r
  EFI_PIC_SECTION2                   *PicSection2;\r
  EFI_TE_SECTION2                    *TeSection2;\r
  EFI_PEI_DEPEX_SECTION2             *PeimHeaderSection2;\r
  EFI_DXE_DEPEX_SECTION2             *DependencySection2;\r
  EFI_VERSION_SECTION2               *VersionSection2;\r
  EFI_USER_INTERFACE_SECTION2        *UISection2;\r
  EFI_COMPATIBILITY16_SECTION2       *Code16Section2;\r
  EFI_FIRMWARE_VOLUME_IMAGE_SECTION2 *FVImageSection2;\r
  EFI_FREEFORM_SUBTYPE_GUID_SECTION2 *FreeformSubtypeSection2;\r
  EFI_RAW_SECTION2                   *RawSection2;\r
} EFI_FILE_SECTION_POINTER;\r
\r
#endif\r
\r
Commit	Line	Data
30fdf114 LG	1	/** @file\r
30fdf114 LG	2	The firmware file related definitions in PI.\r
f7496d71	3	\r
97fa0ee9	4	@par Revision Reference:\r
6eff5d22	5	Version 1.4.\r
30fdf114	6	\r
f7496d71	7	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
30fdf114 LG	8	\r
	9	This program and the accompanying materials are licensed and made available\r
	10	under the terms and conditions of the BSD License which accompanies this\r
97fa0ee9	11	distribution. The full text of the license may be found at\r
30fdf114 LG	12	http://opensource.org/licenses/bsd-license.php\r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	\r
30fdf114 LG	17	**/\r
	18	\r
	19	#ifndef __PI_FIRMWARE_FILE_H__\r
	20	#define __PI_FIRMWARE_FILE_H__\r
	21	\r
	22	#pragma pack(1)\r
	23	//\r
	24	// Used to verify the integrity of the file.\r
f7496d71	25	//\r
30fdf114 LG	26	typedef union {\r
	27	struct {\r
	28	UINT8 Header;\r
	29	UINT8 File;\r
	30	} Checksum;\r
	31	UINT16 Checksum16;\r
	32	} EFI_FFS_INTEGRITY_CHECK;\r
	33	\r
	34	typedef UINT8 EFI_FV_FILETYPE;\r
	35	typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
	36	typedef UINT8 EFI_FFS_FILE_STATE;\r
	37	\r
	38	//\r
	39	// File Types Definitions\r
f7496d71	40	//\r
30fdf114 LG	41	#define EFI_FV_FILETYPE_ALL 0x00\r
	42	#define EFI_FV_FILETYPE_RAW 0x01\r
	43	#define EFI_FV_FILETYPE_FREEFORM 0x02\r
	44	#define EFI_FV_FILETYPE_SECURITY_CORE 0x03\r
	45	#define EFI_FV_FILETYPE_PEI_CORE 0x04\r
	46	#define EFI_FV_FILETYPE_DXE_CORE 0x05\r
	47	#define EFI_FV_FILETYPE_PEIM 0x06\r
	48	#define EFI_FV_FILETYPE_DRIVER 0x07\r
	49	#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08\r
	50	#define EFI_FV_FILETYPE_APPLICATION 0x09\r
b303ea72	51	#define EFI_FV_FILETYPE_SMM 0x0A\r
30fdf114	52	#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r
b303ea72 LG	53	#define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C\r
b303ea72 LG	54	#define EFI_FV_FILETYPE_SMM_CORE 0x0D\r
116f23e8 SV	55	#define EFI_FV_FILETYPE_MM_STANDALONE 0x0E\r
116f23e8 SV	56	#define EFI_FV_FILETYPE_MM_CORE_STANDALONE 0x0F\r
30fdf114 LG	57	#define EFI_FV_FILETYPE_OEM_MIN 0xc0\r
	58	#define EFI_FV_FILETYPE_OEM_MAX 0xdf\r
	59	#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0\r
	60	#define EFI_FV_FILETYPE_DEBUG_MAX 0xef\r
	61	#define EFI_FV_FILETYPE_FFS_MIN 0xf0\r
	62	#define EFI_FV_FILETYPE_FFS_MAX 0xff\r
	63	#define EFI_FV_FILETYPE_FFS_PAD 0xf0\r
f7496d71	64	//\r
30fdf114	65	// FFS File Attributes.\r
f7496d71	66	//\r
e8a47801	67	#define FFS_ATTRIB_LARGE_FILE 0x01\r
e921f58d	68	#define FFS_ATTRIB_DATA_ALIGNMENT2 0x02\r
30fdf114 LG	69	#define FFS_ATTRIB_FIXED 0x04\r
	70	#define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r
	71	#define FFS_ATTRIB_CHECKSUM 0x40\r
	72	//\r
52302d4d	73	// FFS_FIXED_CHECKSUM is the checksum value used when the\r
30fdf114	74	// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
30fdf114	75	//\r
52302d4d	76	#define FFS_FIXED_CHECKSUM 0xAA\r
30fdf114	77	\r
f7496d71	78	//\r
30fdf114	79	// FFS File State Bits.\r
f7496d71	80	//\r
30fdf114 LG	81	#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
	82	#define EFI_FILE_HEADER_VALID 0x02\r
	83	#define EFI_FILE_DATA_VALID 0x04\r
	84	#define EFI_FILE_MARKED_FOR_UPDATE 0x08\r
	85	#define EFI_FILE_DELETED 0x10\r
	86	#define EFI_FILE_HEADER_INVALID 0x20\r
	87	\r
	88	#define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION \| \\r
	89	EFI_FILE_HEADER_VALID \| \\r
	90	EFI_FILE_DATA_VALID \| \\r
	91	EFI_FILE_MARKED_FOR_UPDATE \| \\r
	92	EFI_FILE_DELETED \| \\r
	93	EFI_FILE_HEADER_INVALID \\r
	94	)\r
	95	\r
	96	//\r
f7496d71	97	// Each file begins with the header that describe the\r
30fdf114	98	// contents and state of the files.\r
f7496d71	99	//\r
30fdf114 LG	100	typedef struct {\r
	101	EFI_GUID Name;\r
	102	EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
	103	EFI_FV_FILETYPE Type;\r
	104	EFI_FFS_FILE_ATTRIBUTES Attributes;\r
	105	UINT8 Size[3];\r
	106	EFI_FFS_FILE_STATE State;\r
	107	} EFI_FFS_FILE_HEADER;\r
	108	\r
e8a47801 LG	109	typedef struct {\r
	110	EFI_GUID Name;\r
	111	EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
	112	EFI_FV_FILETYPE Type;\r
	113	EFI_FFS_FILE_ATTRIBUTES Attributes;\r
	114	UINT8 Size[3];\r
	115	EFI_FFS_FILE_STATE State;\r
6eff5d22	116	UINT64 ExtendedSize;\r
e8a47801 LG	117	} EFI_FFS_FILE_HEADER2;\r
	118	\r
	119	#define MAX_FFS_SIZE 0x1000000\r
30fdf114 LG	120	\r
	121	typedef UINT8 EFI_SECTION_TYPE;\r
	122	\r
	123	//\r
	124	// Pseudo type. It is\r
	125	// used as a wild card when retrieving sections. The section\r
	126	// type EFI_SECTION_ALL matches all section types.\r
	127	//\r
	128	#define EFI_SECTION_ALL 0x00\r
	129	\r
	130	//\r
	131	// Encapsulation section Type values\r
	132	//\r
	133	#define EFI_SECTION_COMPRESSION 0x01\r
	134	\r
	135	#define EFI_SECTION_GUID_DEFINED 0x02\r
	136	\r
	137	//\r
	138	// Leaf section Type values\r
	139	//\r
	140	#define EFI_SECTION_PE32 0x10\r
	141	#define EFI_SECTION_PIC 0x11\r
	142	#define EFI_SECTION_TE 0x12\r
	143	#define EFI_SECTION_DXE_DEPEX 0x13\r
	144	#define EFI_SECTION_VERSION 0x14\r
	145	#define EFI_SECTION_USER_INTERFACE 0x15\r
	146	#define EFI_SECTION_COMPATIBILITY16 0x16\r
	147	#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
	148	#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
	149	#define EFI_SECTION_RAW 0x19\r
	150	#define EFI_SECTION_PEI_DEPEX 0x1B\r
fd171542	151	#define EFI_SECTION_SMM_DEPEX 0x1C\r
30fdf114 LG	152	\r
	153	typedef struct {\r
	154	UINT8 Size[3];\r
	155	EFI_SECTION_TYPE Type;\r
	156	} EFI_COMMON_SECTION_HEADER;\r
	157	\r
e8a47801 LG	158	typedef struct {\r
	159	UINT8 Size[3];\r
	160	EFI_SECTION_TYPE Type;\r
	161	UINT32 ExtendedSize;\r
	162	} EFI_COMMON_SECTION_HEADER2;\r
	163	\r
	164	#define MAX_SECTION_SIZE 0x1000000\r
	165	\r
30fdf114	166	//\r
f7496d71	167	// Leaf section type that contains an\r
30fdf114	168	// IA-32 16-bit executable image.\r
f7496d71	169	//\r
30fdf114	170	typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
e8a47801	171	typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r
30fdf114 LG	172	\r
	173	//\r
	174	// CompressionType of EFI_COMPRESSION_SECTION.\r
f7496d71	175	//\r
30fdf114 LG	176	#define EFI_NOT_COMPRESSED 0x00\r
	177	#define EFI_STANDARD_COMPRESSION 0x01\r
	178	//\r
f7496d71	179	// An encapsulation section type in which the\r
30fdf114	180	// section data is compressed.\r
f7496d71	181	//\r
30fdf114 LG	182	typedef struct {\r
	183	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	184	UINT32 UncompressedLength;\r
	185	UINT8 CompressionType;\r
	186	} EFI_COMPRESSION_SECTION;\r
	187	\r
e8a47801 LG	188	typedef struct {\r
	189	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	190	UINT32 UncompressedLength;\r
	191	UINT8 CompressionType;\r
	192	} EFI_COMPRESSION_SECTION2;\r
	193	\r
30fdf114 LG	194	//\r
30fdf114 LG	195	// Leaf section which could be used to determine the dispatch order of DXEs.\r
f7496d71	196	//\r
30fdf114	197	typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
e8a47801	198	typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r
30fdf114 LG	199	\r
	200	//\r
	201	// Leaf section witch contains a PI FV.\r
f7496d71	202	//\r
30fdf114	203	typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
e8a47801	204	typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
30fdf114 LG	205	\r
	206	//\r
	207	// Leaf section which contains a single GUID.\r
f7496d71	208	//\r
30fdf114 LG	209	typedef struct {\r
	210	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	211	EFI_GUID SubTypeGuid;\r
	212	} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
	213	\r
e8a47801 LG	214	typedef struct {\r
	215	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	216	EFI_GUID SubTypeGuid;\r
	217	} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
	218	\r
30fdf114 LG	219	//\r
30fdf114 LG	220	// Attributes of EFI_GUID_DEFINED_SECTION\r
f7496d71	221	//\r
30fdf114 LG	222	#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
	223	#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
	224	//\r
	225	// Leaf section which is encapsulation defined by specific GUID\r
f7496d71	226	//\r
30fdf114 LG	227	typedef struct {\r
	228	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	229	EFI_GUID SectionDefinitionGuid;\r
	230	UINT16 DataOffset;\r
	231	UINT16 Attributes;\r
	232	} EFI_GUID_DEFINED_SECTION;\r
	233	\r
e8a47801 LG	234	typedef struct {\r
	235	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	236	EFI_GUID SectionDefinitionGuid;\r
	237	UINT16 DataOffset;\r
	238	UINT16 Attributes;\r
	239	} EFI_GUID_DEFINED_SECTION2;\r
	240	\r
30fdf114 LG	241	//\r
30fdf114 LG	242	// Leaf section which contains PE32+ image.\r
f7496d71	243	//\r
30fdf114	244	typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
e8a47801	245	typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r
30fdf114 LG	246	\r
	247	//\r
	248	// Leaf section which contains PIC image.\r
f7496d71	249	//\r
30fdf114	250	typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
e8a47801	251	typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r
30fdf114 LG	252	\r
	253	//\r
	254	// Leaf section which used to determine the dispatch order of PEIMs.\r
f7496d71	255	//\r
30fdf114	256	typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
e8a47801	257	typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r
30fdf114 LG	258	\r
	259	//\r
	260	// Leaf section which constains the position-independent-code image.\r
f7496d71	261	//\r
30fdf114	262	typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
e8a47801	263	typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r
30fdf114 LG	264	\r
	265	//\r
	266	// Leaf section which contains an array of zero or more bytes.\r
f7496d71	267	//\r
30fdf114	268	typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
e8a47801	269	typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r
30fdf114 LG	270	\r
30fdf114 LG	271	//\r
f7496d71	272	// Leaf section which contains a unicode string that\r
30fdf114	273	// is human readable file name.\r
f7496d71	274	//\r
30fdf114 LG	275	typedef struct {\r
	276	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	277	\r
	278	//\r
	279	// Array of unicode string.\r
f7496d71	280	//\r
30fdf114 LG	281	CHAR16 FileNameString[1];\r
	282	} EFI_USER_INTERFACE_SECTION;\r
	283	\r
e8a47801 LG	284	typedef struct {\r
	285	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	286	\r
	287	//\r
	288	// Array of unicode string.\r
f7496d71	289	//\r
e8a47801 LG	290	CHAR16 FileNameString[1];\r
e8a47801 LG	291	} EFI_USER_INTERFACE_SECTION2;\r
30fdf114 LG	292	\r
	293	//\r
	294	// Leaf section which contains a numeric build number and\r
f7496d71 LG	295	// an optional unicode string that represent the file revision.\r
f7496d71 LG	296	//\r
30fdf114 LG	297	typedef struct {\r
	298	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	299	UINT16 BuildNumber;\r
	300	CHAR16 VersionString[1];\r
	301	} EFI_VERSION_SECTION;\r
	302	\r
e8a47801 LG	303	typedef struct {\r
	304	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	305	UINT16 BuildNumber;\r
	306	CHAR16 VersionString[1];\r
	307	} EFI_VERSION_SECTION2;\r
30fdf114 LG	308	\r
	309	#define SECTION_SIZE(SectionHeaderPtr) \\r
	310	((UINT32) (((UINT32 ) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
	311	\r
	312	#pragma pack()\r
	313	\r
	314	typedef union {\r
	315	EFI_COMMON_SECTION_HEADER *CommonHeader;\r
	316	EFI_COMPRESSION_SECTION *CompressionSection;\r
	317	EFI_GUID_DEFINED_SECTION *GuidDefinedSection;\r
	318	EFI_PE32_SECTION *Pe32Section;\r
	319	EFI_PIC_SECTION *PicSection;\r
	320	EFI_TE_SECTION *TeSection;\r
	321	EFI_PEI_DEPEX_SECTION *PeimHeaderSection;\r
	322	EFI_DXE_DEPEX_SECTION *DependencySection;\r
	323	EFI_VERSION_SECTION *VersionSection;\r
	324	EFI_USER_INTERFACE_SECTION *UISection;\r
	325	EFI_COMPATIBILITY16_SECTION *Code16Section;\r
	326	EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
	327	EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
	328	EFI_RAW_SECTION *RawSection;\r
e8a47801 LG	329	//\r
	330	// For section whose size is equal or greater than 0x1000000\r
	331	//\r
	332	EFI_COMMON_SECTION_HEADER2 *CommonHeader2;\r
	333	EFI_COMPRESSION_SECTION2 *CompressionSection2;\r
	334	EFI_GUID_DEFINED_SECTION2 *GuidDefinedSection2;\r
	335	EFI_PE32_SECTION2 *Pe32Section2;\r
	336	EFI_PIC_SECTION2 *PicSection2;\r
	337	EFI_TE_SECTION2 *TeSection2;\r
	338	EFI_PEI_DEPEX_SECTION2 *PeimHeaderSection2;\r
	339	EFI_DXE_DEPEX_SECTION2 *DependencySection2;\r
	340	EFI_VERSION_SECTION2 *VersionSection2;\r
	341	EFI_USER_INTERFACE_SECTION2 *UISection2;\r
	342	EFI_COMPATIBILITY16_SECTION2 *Code16Section2;\r
	343	EFI_FIRMWARE_VOLUME_IMAGE_SECTION2 *FVImageSection2;\r
	344	EFI_FREEFORM_SUBTYPE_GUID_SECTION2 *FreeformSubtypeSection2;\r
	345	EFI_RAW_SECTION2 *RawSection2;\r
30fdf114 LG	346	} EFI_FILE_SECTION_POINTER;\r
	347	\r
	348	#endif\r
	349	\r