BaseTools: Clean up source files

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

diff --git a/BaseTools/Source/C/Include/Common/PiFirmwareFile.h b/BaseTools/Source/C/Include/Common/PiFirmwareFile.h
index ec31eab8a88361548a5dcd4f1369cb4db2da4e37..737f63bbb242c082d7cc16efffb80ef7b1f69cb6 100644 (file)
--- a/BaseTools/Source/C/Include/Common/PiFirmwareFile.h
+++ b/BaseTools/Source/C/Include/Common/PiFirmwareFile.h
@@ -1,10 +1,10 @@
 /** @file\r
   The firmware file related definitions in PI.\r
-  \r
+\r
   @par Revision Reference:\r
-  Version 1.0.\r
+  Version 1.4.\r
 \r
-  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -22,7 +22,7 @@
 #pragma pack(1)\r
 //\r
 // Used to verify the integrity of the file.\r
-// \r
+//\r
 typedef union {\r
   struct {\r
     UINT8   Header;\r
@@ -37,7 +37,7 @@ typedef UINT8 EFI_FFS_FILE_STATE;
 \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
@@ -52,6 +52,8 @@ typedef UINT8 EFI_FFS_FILE_STATE;
 #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
@@ -59,10 +61,11 @@ typedef UINT8 EFI_FFS_FILE_STATE;
 #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
@@ -72,9 +75,9 @@ typedef UINT8 EFI_FFS_FILE_STATE;
 //\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
@@ -91,9 +94,9 @@ typedef UINT8 EFI_FFS_FILE_STATE;
                                   )\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
@@ -110,7 +113,7 @@ typedef struct {
   EFI_FFS_FILE_ATTRIBUTES Attributes;\r
   UINT8                   Size[3];\r
   EFI_FFS_FILE_STATE      State;\r
-  UINT32                  ExtendedSize;\r
+  UINT64                  ExtendedSize;\r
 } EFI_FFS_FILE_HEADER2;\r
 \r
 #define MAX_FFS_SIZE        0x1000000\r
@@ -161,21 +164,21 @@ typedef struct {
 #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
@@ -190,19 +193,19 @@ typedef struct {
 \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
@@ -215,12 +218,12 @@ typedef struct {
 \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
@@ -237,44 +240,44 @@ typedef struct {
 \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
@@ -283,14 +286,14 @@ typedef struct {
 \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