]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Pi/PiFirmwareFile.h
Fix doxygen issue:
[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareFile.h
index f8abcc78c0e397c6f3df4cb19a695b62d4b46b4c..1fd9da37fa9a245dc989a7b5a38675ea0313108d 100644 (file)
@@ -22,9 +22,9 @@
 #include <ProcessorBind.h>\r
 \r
 #pragma pack(1)\r
-//\r
-// Used to verify the integrity of the file.\r
-// \r
+///\r
+/// Used to verify the integrity of the file.\r
+/// \r
 typedef union {\r
   struct {\r
     UINT8   Header;\r
@@ -37,9 +37,9 @@ typedef UINT8 EFI_FV_FILETYPE;
 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
 typedef UINT8 EFI_FFS_FILE_STATE;\r
 \r
-//\r
-// File Types Definitions\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
@@ -58,16 +58,16 @@ 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
-// FFS File Attributes.\r
-// \r
+/// \r
+/// FFS File Attributes.\r
+/// \r
 #define FFS_ATTRIB_FIXED              0x04\r
 #define FFS_ATTRIB_DATA_ALIGNMENT     0x38\r
 #define FFS_ATTRIB_CHECKSUM           0x40\r
 \r
-// \r
-// FFS File State Bits.\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
@@ -76,10 +76,10 @@ typedef UINT8 EFI_FFS_FILE_STATE;
 #define EFI_FILE_HEADER_INVALID       0x20\r
 \r
 \r
-//\r
-// Each file begins with the header that describe the \r
-// contents and state of the files.\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
@@ -92,23 +92,23 @@ typedef struct {
 \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
+///\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
+///\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
+///\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
@@ -121,58 +121,61 @@ typedef UINT8 EFI_SECTION_TYPE;
 #define EFI_SECTION_RAW                   0x19\r
 #define EFI_SECTION_PEI_DEPEX             0x1B\r
 \r
+///\r
+/// Common section header\r
+/// \r
 typedef struct {\r
   UINT8             Size[3];\r
   EFI_SECTION_TYPE  Type;\r
 } EFI_COMMON_SECTION_HEADER;\r
 \r
-//\r
-// Leaf section type that contains an \r
-// IA-32 16-bit executable image.\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
 \r
-//\r
-// CompressionType of EFI_COMPRESSION_SECTION.\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
+///\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
-//\r
-// Leaf section which could be used to determine the dispatch order of DXEs.\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
 \r
-//\r
-// Leaf section witch contains a PI FV.\r
-// \r
+///\r
+/// Leaf section witch contains a PI FV.\r
+/// \r
 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
 \r
-//\r
-// Leaf section which contains a single GUID.\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
-//\r
-// Attributes of EFI_GUID_DEFINED_SECTION\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
+///\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
@@ -180,45 +183,45 @@ typedef struct {
   UINT16                      Attributes;\r
 } EFI_GUID_DEFINED_SECTION;\r
 \r
-//\r
-// Leaf section which contains PE32+ image.\r
-// \r
+///\r
+/// Leaf section which contains PE32+ image.\r
+/// \r
 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
 \r
 \r
-//\r
-// Leaf section which used to determine the dispatch order of PEIMs.\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
 \r
-//\r
-// Leaf section which constains the position-independent-code image.\r
-// \r
+///\r
+/// Leaf section which constains the position-independent-code image.\r
+/// \r
 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
 \r
-//\r
-// Leaf section which contains an array of zero or more bytes.\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
 \r
-//\r
-// Leaf section which contains a unicode string that \r
-// is human readable file name.\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
+  ///\r
+  /// Array of unicode string.\r
+  /// \r
   CHAR16                      FileNameString[1];\r
 } EFI_USER_INTERFACE_SECTION;\r
 \r
 \r
-//\r
-// Leaf section which contains a numeric build number and\r
-// an optional unicode string that represent the file revision. \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