diff options
Diffstat (limited to 'MdePkg/Include/Pi/PiFirmwareFile.h')
| -rw-r--r-- | MdePkg/Include/Pi/PiFirmwareFile.h | 155 |
1 files changed, 79 insertions, 76 deletions
diff --git a/MdePkg/Include/Pi/PiFirmwareFile.h b/MdePkg/Include/Pi/PiFirmwareFile.h index f8abcc78c0..1fd9da37fa 100644 --- a/MdePkg/Include/Pi/PiFirmwareFile.h +++ b/MdePkg/Include/Pi/PiFirmwareFile.h @@ -22,9 +22,9 @@ #include <ProcessorBind.h>
#pragma pack(1)
-//
-// Used to verify the integrity of the file.
-//
+///
+/// Used to verify the integrity of the file.
+///
typedef union {
struct {
UINT8 Header;
@@ -37,9 +37,9 @@ typedef UINT8 EFI_FV_FILETYPE; typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;
typedef UINT8 EFI_FFS_FILE_STATE;
-//
-// File Types Definitions
-//
+///
+/// File Types Definitions
+///
#define EFI_FV_FILETYPE_ALL 0x00
#define EFI_FV_FILETYPE_RAW 0x01
#define EFI_FV_FILETYPE_FREEFORM 0x02
@@ -58,16 +58,16 @@ typedef UINT8 EFI_FFS_FILE_STATE; #define EFI_FV_FILETYPE_FFS_MIN 0xf0
#define EFI_FV_FILETYPE_FFS_MAX 0xff
#define EFI_FV_FILETYPE_FFS_PAD 0xf0
-//
-// FFS File Attributes.
-//
+///
+/// FFS File Attributes.
+///
#define FFS_ATTRIB_FIXED 0x04
#define FFS_ATTRIB_DATA_ALIGNMENT 0x38
#define FFS_ATTRIB_CHECKSUM 0x40
-//
-// FFS File State Bits.
-//
+///
+/// FFS File State Bits.
+///
#define EFI_FILE_HEADER_CONSTRUCTION 0x01
#define EFI_FILE_HEADER_VALID 0x02
#define EFI_FILE_DATA_VALID 0x04
@@ -76,10 +76,10 @@ typedef UINT8 EFI_FFS_FILE_STATE; #define EFI_FILE_HEADER_INVALID 0x20
-//
-// Each file begins with the header that describe the
-// contents and state of the files.
-//
+///
+/// Each file begins with the header that describe the
+/// contents and state of the files.
+///
typedef struct {
EFI_GUID Name;
EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
@@ -92,23 +92,23 @@ typedef struct { typedef UINT8 EFI_SECTION_TYPE;
-//
-// Pseudo type. It is
-// used as a wild card when retrieving sections. The section
-// type EFI_SECTION_ALL matches all section types.
-//
+///
+/// Pseudo type. It is
+/// used as a wild card when retrieving sections. The section
+/// type EFI_SECTION_ALL matches all section types.
+///
#define EFI_SECTION_ALL 0x00
-//
-// Encapsulation section Type values
-//
+///
+/// Encapsulation section Type values
+///
#define EFI_SECTION_COMPRESSION 0x01
#define EFI_SECTION_GUID_DEFINED 0x02
-//
-// Leaf section Type values
-//
+///
+/// Leaf section Type values
+///
#define EFI_SECTION_PE32 0x10
#define EFI_SECTION_PIC 0x11
#define EFI_SECTION_TE 0x12
@@ -121,58 +121,61 @@ typedef UINT8 EFI_SECTION_TYPE; #define EFI_SECTION_RAW 0x19
#define EFI_SECTION_PEI_DEPEX 0x1B
+///
+/// Common section header
+///
typedef struct {
UINT8 Size[3];
EFI_SECTION_TYPE Type;
} EFI_COMMON_SECTION_HEADER;
-//
-// Leaf section type that contains an
-// IA-32 16-bit executable image.
-//
+///
+/// Leaf section type that contains an
+/// IA-32 16-bit executable image.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
-//
-// CompressionType of EFI_COMPRESSION_SECTION.
-//
+///
+/// CompressionType of EFI_COMPRESSION_SECTION.
+///
#define EFI_NOT_COMPRESSED 0x00
#define EFI_STANDARD_COMPRESSION 0x01
-//
-// An encapsulation section type in which the
-// section data is compressed.
-//
+///
+/// An encapsulation section type in which the
+/// section data is compressed.
+///
typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader;
UINT32 UncompressedLength;
UINT8 CompressionType;
} EFI_COMPRESSION_SECTION;
-//
-// Leaf section which could be used to determine the dispatch order of DXEs.
-//
+///
+/// Leaf section which could be used to determine the dispatch order of DXEs.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
-//
-// Leaf section witch contains a PI FV.
-//
+///
+/// Leaf section witch contains a PI FV.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
-//
-// Leaf section which contains a single GUID.
-//
+///
+/// Leaf section which contains a single GUID.
+///
typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader;
EFI_GUID SubTypeGuid;
} EFI_FREEFORM_SUBTYPE_GUID_SECTION;
-//
-// Attributes of EFI_GUID_DEFINED_SECTION
-//
+///
+/// Attributes of EFI_GUID_DEFINED_SECTION
+///
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
-//
-// Leaf section which is encapsulation defined by specific GUID
-//
+///
+/// Leaf section which is encapsulation defined by specific GUID
+///
typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader;
EFI_GUID SectionDefinitionGuid;
@@ -180,45 +183,45 @@ typedef struct { UINT16 Attributes;
} EFI_GUID_DEFINED_SECTION;
-//
-// Leaf section which contains PE32+ image.
-//
+///
+/// Leaf section which contains PE32+ image.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
-//
-// Leaf section which used to determine the dispatch order of PEIMs.
-//
+///
+/// Leaf section which used to determine the dispatch order of PEIMs.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
-//
-// Leaf section which constains the position-independent-code image.
-//
+///
+/// Leaf section which constains the position-independent-code image.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
-//
-// Leaf section which contains an array of zero or more bytes.
-//
+///
+/// Leaf section which contains an array of zero or more bytes.
+///
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
-//
-// Leaf section which contains a unicode string that
-// is human readable file name.
-//
+///
+/// Leaf section which contains a unicode string that
+/// is human readable file name.
+///
typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader;
- //
- // Array of unicode string.
- //
+ ///
+ /// Array of unicode string.
+ ///
CHAR16 FileNameString[1];
} EFI_USER_INTERFACE_SECTION;
-//
-// Leaf section which contains a numeric build number and
-// an optional unicode string that represent the file revision.
-//
+///
+/// Leaf section which contains a numeric build number and
+/// an optional unicode string that represent the file revision.
+///
typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader;
UINT16 BuildNumber;
|