/** @file\r
The firmware file related definitions in PI.\r
- \r
+\r
@par Revision Reference:\r
Version 1.4.\r
\r
- Copyright (c) 2006 - 2015, 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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\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
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#pragma pack(1)\r
//\r
// Used to verify the integrity of the file.\r
-// \r
+//\r
typedef union {\r
struct {\r
UINT8 Header;\r
\r
//\r
// File Types Definitions\r
-// \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_FFS_MIN 0xf0\r
#define EFI_FV_FILETYPE_FFS_MAX 0xff\r
#define EFI_FV_FILETYPE_FFS_PAD 0xf0\r
-// \r
+//\r
// FFS File Attributes.\r
-// \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
#define FFS_FIXED_CHECKSUM 0xAA\r
\r
-// \r
+//\r
// FFS File State Bits.\r
-// \r
+//\r
#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
#define EFI_FILE_HEADER_VALID 0x02\r
#define EFI_FILE_DATA_VALID 0x04\r
)\r
\r
//\r
-// Each file begins with the header that describe the \r
+// Each file begins with the header that describe the\r
// contents and state of the files.\r
-// \r
+//\r
typedef struct {\r
EFI_GUID Name;\r
EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
#define MAX_SECTION_SIZE 0x1000000\r
\r
//\r
-// Leaf section type that contains an \r
+// Leaf section type that contains an\r
// IA-32 16-bit executable image.\r
-// \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
+//\r
#define EFI_NOT_COMPRESSED 0x00\r
#define EFI_STANDARD_COMPRESSION 0x01\r
//\r
-// An encapsulation section type in which the \r
+// An encapsulation section type in which the\r
// section data is compressed.\r
-// \r
+//\r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
UINT32 UncompressedLength;\r
\r
//\r
// Leaf section which could be used to determine the dispatch order of DXEs.\r
-// \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
+//\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
+//\r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
EFI_GUID SubTypeGuid;\r
\r
//\r
// Attributes of EFI_GUID_DEFINED_SECTION\r
-// \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
+//\r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
EFI_GUID SectionDefinitionGuid;\r
\r
//\r
// Leaf section which contains PE32+ image.\r
-// \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
+//\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
+//\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
+//\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
+//\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
+// Leaf section which contains a unicode string that\r
// is human readable file name.\r
-// \r
+//\r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
\r
//\r
// Array of unicode string.\r
- // \r
+ //\r
CHAR16 FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION;\r
\r
\r
//\r
// Array of unicode string.\r
- // \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
+// an optional unicode string that represent the file revision.\r
+//\r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
UINT16 BuildNumber;\r