[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.0.\r
\r
  Copyright (c) 2006 - 2014, 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_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_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
  UINT32                  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
97fa0ee9 YL	3	\r
	4	@par Revision Reference:\r
	5	Version 1.0.\r
30fdf114	6	\r
97fa0ee9	7	Copyright (c) 2006 - 2014, 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
	25	// \r
	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
	40	// \r
	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
30fdf114 LG	55	#define EFI_FV_FILETYPE_OEM_MIN 0xc0\r
	56	#define EFI_FV_FILETYPE_OEM_MAX 0xdf\r
	57	#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0\r
	58	#define EFI_FV_FILETYPE_DEBUG_MAX 0xef\r
	59	#define EFI_FV_FILETYPE_FFS_MIN 0xf0\r
	60	#define EFI_FV_FILETYPE_FFS_MAX 0xff\r
	61	#define EFI_FV_FILETYPE_FFS_PAD 0xf0\r
	62	// \r
	63	// FFS File Attributes.\r
	64	// \r
e8a47801	65	#define FFS_ATTRIB_LARGE_FILE 0x01\r
30fdf114 LG	66	#define FFS_ATTRIB_FIXED 0x04\r
	67	#define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r
	68	#define FFS_ATTRIB_CHECKSUM 0x40\r
	69	//\r
52302d4d	70	// FFS_FIXED_CHECKSUM is the checksum value used when the\r
30fdf114	71	// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
30fdf114	72	//\r
52302d4d	73	#define FFS_FIXED_CHECKSUM 0xAA\r
30fdf114 LG	74	\r
	75	// \r
	76	// FFS File State Bits.\r
	77	// \r
	78	#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
	79	#define EFI_FILE_HEADER_VALID 0x02\r
	80	#define EFI_FILE_DATA_VALID 0x04\r
	81	#define EFI_FILE_MARKED_FOR_UPDATE 0x08\r
	82	#define EFI_FILE_DELETED 0x10\r
	83	#define EFI_FILE_HEADER_INVALID 0x20\r
	84	\r
	85	#define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION \| \\r
	86	EFI_FILE_HEADER_VALID \| \\r
	87	EFI_FILE_DATA_VALID \| \\r
	88	EFI_FILE_MARKED_FOR_UPDATE \| \\r
	89	EFI_FILE_DELETED \| \\r
	90	EFI_FILE_HEADER_INVALID \\r
	91	)\r
	92	\r
	93	//\r
	94	// Each file begins with the header that describe the \r
	95	// contents and state of the files.\r
	96	// \r
	97	typedef struct {\r
	98	EFI_GUID Name;\r
	99	EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
	100	EFI_FV_FILETYPE Type;\r
	101	EFI_FFS_FILE_ATTRIBUTES Attributes;\r
	102	UINT8 Size[3];\r
	103	EFI_FFS_FILE_STATE State;\r
	104	} EFI_FFS_FILE_HEADER;\r
	105	\r
e8a47801 LG	106	typedef struct {\r
	107	EFI_GUID Name;\r
	108	EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
	109	EFI_FV_FILETYPE Type;\r
	110	EFI_FFS_FILE_ATTRIBUTES Attributes;\r
	111	UINT8 Size[3];\r
	112	EFI_FFS_FILE_STATE State;\r
	113	UINT32 ExtendedSize;\r
	114	} EFI_FFS_FILE_HEADER2;\r
	115	\r
	116	#define MAX_FFS_SIZE 0x1000000\r
30fdf114 LG	117	\r
	118	typedef UINT8 EFI_SECTION_TYPE;\r
	119	\r
	120	//\r
	121	// Pseudo type. It is\r
	122	// used as a wild card when retrieving sections. The section\r
	123	// type EFI_SECTION_ALL matches all section types.\r
	124	//\r
	125	#define EFI_SECTION_ALL 0x00\r
	126	\r
	127	//\r
	128	// Encapsulation section Type values\r
	129	//\r
	130	#define EFI_SECTION_COMPRESSION 0x01\r
	131	\r
	132	#define EFI_SECTION_GUID_DEFINED 0x02\r
	133	\r
	134	//\r
	135	// Leaf section Type values\r
	136	//\r
	137	#define EFI_SECTION_PE32 0x10\r
	138	#define EFI_SECTION_PIC 0x11\r
	139	#define EFI_SECTION_TE 0x12\r
	140	#define EFI_SECTION_DXE_DEPEX 0x13\r
	141	#define EFI_SECTION_VERSION 0x14\r
	142	#define EFI_SECTION_USER_INTERFACE 0x15\r
	143	#define EFI_SECTION_COMPATIBILITY16 0x16\r
	144	#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
	145	#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
	146	#define EFI_SECTION_RAW 0x19\r
	147	#define EFI_SECTION_PEI_DEPEX 0x1B\r
fd171542	148	#define EFI_SECTION_SMM_DEPEX 0x1C\r
30fdf114 LG	149	\r
	150	typedef struct {\r
	151	UINT8 Size[3];\r
	152	EFI_SECTION_TYPE Type;\r
	153	} EFI_COMMON_SECTION_HEADER;\r
	154	\r
e8a47801 LG	155	typedef struct {\r
	156	UINT8 Size[3];\r
	157	EFI_SECTION_TYPE Type;\r
	158	UINT32 ExtendedSize;\r
	159	} EFI_COMMON_SECTION_HEADER2;\r
	160	\r
	161	#define MAX_SECTION_SIZE 0x1000000\r
	162	\r
30fdf114 LG	163	//\r
	164	// Leaf section type that contains an \r
	165	// IA-32 16-bit executable image.\r
	166	// \r
	167	typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
e8a47801	168	typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r
30fdf114 LG	169	\r
	170	//\r
	171	// CompressionType of EFI_COMPRESSION_SECTION.\r
	172	// \r
	173	#define EFI_NOT_COMPRESSED 0x00\r
	174	#define EFI_STANDARD_COMPRESSION 0x01\r
	175	//\r
	176	// An encapsulation section type in which the \r
	177	// section data is compressed.\r
	178	// \r
	179	typedef struct {\r
	180	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	181	UINT32 UncompressedLength;\r
	182	UINT8 CompressionType;\r
	183	} EFI_COMPRESSION_SECTION;\r
	184	\r
e8a47801 LG	185	typedef struct {\r
	186	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	187	UINT32 UncompressedLength;\r
	188	UINT8 CompressionType;\r
	189	} EFI_COMPRESSION_SECTION2;\r
	190	\r
30fdf114 LG	191	//\r
	192	// Leaf section which could be used to determine the dispatch order of DXEs.\r
	193	// \r
	194	typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
e8a47801	195	typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r
30fdf114 LG	196	\r
	197	//\r
	198	// Leaf section witch contains a PI FV.\r
	199	// \r
	200	typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
e8a47801	201	typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
30fdf114 LG	202	\r
	203	//\r
	204	// Leaf section which contains a single GUID.\r
	205	// \r
	206	typedef struct {\r
	207	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	208	EFI_GUID SubTypeGuid;\r
	209	} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
	210	\r
e8a47801 LG	211	typedef struct {\r
	212	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	213	EFI_GUID SubTypeGuid;\r
	214	} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
	215	\r
30fdf114 LG	216	//\r
	217	// Attributes of EFI_GUID_DEFINED_SECTION\r
	218	// \r
	219	#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
	220	#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
	221	//\r
	222	// Leaf section which is encapsulation defined by specific GUID\r
	223	// \r
	224	typedef struct {\r
	225	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	226	EFI_GUID SectionDefinitionGuid;\r
	227	UINT16 DataOffset;\r
	228	UINT16 Attributes;\r
	229	} EFI_GUID_DEFINED_SECTION;\r
	230	\r
e8a47801 LG	231	typedef struct {\r
	232	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	233	EFI_GUID SectionDefinitionGuid;\r
	234	UINT16 DataOffset;\r
	235	UINT16 Attributes;\r
	236	} EFI_GUID_DEFINED_SECTION2;\r
	237	\r
30fdf114 LG	238	//\r
	239	// Leaf section which contains PE32+ image.\r
	240	// \r
	241	typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
e8a47801	242	typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r
30fdf114 LG	243	\r
	244	//\r
	245	// Leaf section which contains PIC image.\r
	246	// \r
	247	typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
e8a47801	248	typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r
30fdf114 LG	249	\r
	250	//\r
	251	// Leaf section which used to determine the dispatch order of PEIMs.\r
	252	// \r
	253	typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
e8a47801	254	typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r
30fdf114 LG	255	\r
	256	//\r
	257	// Leaf section which constains the position-independent-code image.\r
	258	// \r
	259	typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
e8a47801	260	typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r
30fdf114 LG	261	\r
	262	//\r
	263	// Leaf section which contains an array of zero or more bytes.\r
	264	// \r
	265	typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
e8a47801	266	typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r
30fdf114 LG	267	\r
	268	//\r
	269	// Leaf section which contains a unicode string that \r
	270	// is human readable file name.\r
	271	// \r
	272	typedef struct {\r
	273	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	274	\r
	275	//\r
	276	// Array of unicode string.\r
	277	// \r
	278	CHAR16 FileNameString[1];\r
	279	} EFI_USER_INTERFACE_SECTION;\r
	280	\r
e8a47801 LG	281	typedef struct {\r
	282	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	283	\r
	284	//\r
	285	// Array of unicode string.\r
	286	// \r
	287	CHAR16 FileNameString[1];\r
	288	} EFI_USER_INTERFACE_SECTION2;\r
30fdf114 LG	289	\r
	290	//\r
	291	// Leaf section which contains a numeric build number and\r
	292	// an optional unicode string that represent the file revision. \r
	293	// \r
	294	typedef struct {\r
	295	EFI_COMMON_SECTION_HEADER CommonHeader;\r
	296	UINT16 BuildNumber;\r
	297	CHAR16 VersionString[1];\r
	298	} EFI_VERSION_SECTION;\r
	299	\r
e8a47801 LG	300	typedef struct {\r
	301	EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
	302	UINT16 BuildNumber;\r
	303	CHAR16 VersionString[1];\r
	304	} EFI_VERSION_SECTION2;\r
30fdf114 LG	305	\r
	306	#define SECTION_SIZE(SectionHeaderPtr) \\r
	307	((UINT32) (((UINT32 ) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
	308	\r
	309	#pragma pack()\r
	310	\r
	311	typedef union {\r
	312	EFI_COMMON_SECTION_HEADER *CommonHeader;\r
	313	EFI_COMPRESSION_SECTION *CompressionSection;\r
	314	EFI_GUID_DEFINED_SECTION *GuidDefinedSection;\r
	315	EFI_PE32_SECTION *Pe32Section;\r
	316	EFI_PIC_SECTION *PicSection;\r
	317	EFI_TE_SECTION *TeSection;\r
	318	EFI_PEI_DEPEX_SECTION *PeimHeaderSection;\r
	319	EFI_DXE_DEPEX_SECTION *DependencySection;\r
	320	EFI_VERSION_SECTION *VersionSection;\r
	321	EFI_USER_INTERFACE_SECTION *UISection;\r
	322	EFI_COMPATIBILITY16_SECTION *Code16Section;\r
	323	EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
	324	EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
	325	EFI_RAW_SECTION *RawSection;\r
e8a47801 LG	326	//\r
	327	// For section whose size is equal or greater than 0x1000000\r
	328	//\r
	329	EFI_COMMON_SECTION_HEADER2 *CommonHeader2;\r
	330	EFI_COMPRESSION_SECTION2 *CompressionSection2;\r
	331	EFI_GUID_DEFINED_SECTION2 *GuidDefinedSection2;\r
	332	EFI_PE32_SECTION2 *Pe32Section2;\r
	333	EFI_PIC_SECTION2 *PicSection2;\r
	334	EFI_TE_SECTION2 *TeSection2;\r
	335	EFI_PEI_DEPEX_SECTION2 *PeimHeaderSection2;\r
	336	EFI_DXE_DEPEX_SECTION2 *DependencySection2;\r
	337	EFI_VERSION_SECTION2 *VersionSection2;\r
	338	EFI_USER_INTERFACE_SECTION2 *UISection2;\r
	339	EFI_COMPATIBILITY16_SECTION2 *Code16Section2;\r
	340	EFI_FIRMWARE_VOLUME_IMAGE_SECTION2 *FVImageSection2;\r
	341	EFI_FREEFORM_SUBTYPE_GUID_SECTION2 *FreeformSubtypeSection2;\r
	342	EFI_RAW_SECTION2 *RawSection2;\r
30fdf114 LG	343	} EFI_FILE_SECTION_POINTER;\r
	344	\r
	345	#endif\r
	346	\r