1. add some comments for structures

2. refined doxgen format comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6803 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/IndustryStandard/Acpi10.h b/MdePkg/Include/IndustryStandard/Acpi10.h
index 7afb678a9917c8a33b1af96718da49443b0d4d76..c2f3acf75cc33d20596af20786ad3c422d2902c8 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Acpi10.h
+++ b/MdePkg/Include/IndustryStandard/Acpi10.h
@@ -82,6 +82,9 @@ typedef struct {
 \r
 #pragma pack()\r
 \r
+///\r
+/// the End tag identifies an end of resource data.\r
+///\r
 typedef struct {\r
   UINT8 Desc;\r
   UINT8 Checksum;\r

diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h
index 92059b3b5659a4ae032bde3d7357f599179c632a..cba10f6e9b22703ca95f2729254e6bfa26133e1a 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Atapi.h
+++ b/MdePkg/Include/IndustryStandard/Atapi.h
@@ -135,12 +135,8 @@ typedef struct {
   UINT8 sense_key_specific_17;\r
 } ATAPI_REQUEST_SENSE_DATA;\r
 \r
-//\r
-// The followings are defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
-//\r
-\r
 ///\r
-/// READ CAPACITY Data \r
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 LastLba3;\r
@@ -155,6 +151,7 @@ typedef struct {
 \r
 ///\r
 /// Capacity List Header + Current/Maximum Capacity Descriptor,\r
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 reserved_0;\r
@@ -173,7 +170,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAPACITY_DATA;\r
 \r
 ///\r
-/// Test Unit Ready Command\r
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -191,7 +188,7 @@ typedef struct {
 } ATAPI_TEST_UNIT_READY_CMD;\r
 \r
 ///\r
-/// INQUIRY Command\r
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -210,7 +207,7 @@ typedef struct {
 } ATAPI_INQUIRY_CMD;\r
 \r
 ///\r
-/// REQUEST SENSE Command\r
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -229,7 +226,7 @@ typedef struct {
 } ATAPI_REQUEST_SENSE_CMD;\r
 \r
 ///\r
-/// READ (10) Command\r
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -248,7 +245,7 @@ typedef struct {
 } ATAPI_READ10_CMD;\r
 \r
 ///\r
-/// READ Format Capacity Command\r
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -267,7 +264,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAP_CMD;\r
 \r
 ///\r
-/// MODE SENSE Command\r
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r

diff --git a/MdePkg/Include/IndustryStandard/Pci22.h b/MdePkg/Include/IndustryStandard/Pci22.h
index 9ac34aae8229cc37266f35dfd11a46faca500352..d596e926c2d3cdce8c4be447d38794d3f0f1f35e 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Pci22.h
+++ b/MdePkg/Include/IndustryStandard/Pci22.h
@@ -2,8 +2,8 @@
   Support for PCI 2.2 standard.\r
 \r
   This file includes the definitions in the following specifications,\r
-    PCI Local Bus Specification, 2.0\r
-    PCI-to-PCI Bridge Architecture Specification,\r
+    PCI Local Bus Specification, 2.2\r
+    PCI-to-PCI Bridge Architecture Specification, Revision 1.2\r
     PC Card Standard, 8.0\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
@@ -25,8 +25,12 @@
 #define PCI_MAX_DEVICE  31\r
 #define PCI_MAX_FUNC    7\r
 \r
-\r
 #pragma pack(1)\r
+\r
+///\r
+/// Common header region in PCI Configuration Space\r
+/// Section 6.1, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   UINT16  VendorId;\r
   UINT16  DeviceId;\r
@@ -40,6 +44,10 @@ typedef struct {
   UINT8   BIST;\r
 } PCI_DEVICE_INDEPENDENT_REGION;\r
 \r
+///\r
+/// PCI Device header region in PCI Configuration Space\r
+/// Section 6.1, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   UINT32  Bar[6];\r
   UINT32  CISPtr;\r
@@ -55,13 +63,18 @@ typedef struct {
   UINT8   MaxLat;\r
 } PCI_DEVICE_HEADER_TYPE_REGION;\r
 \r
+///\r
+/// PCI Device Configuration Space\r
+/// Section 6.1, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   PCI_DEVICE_INDEPENDENT_REGION Hdr;\r
   PCI_DEVICE_HEADER_TYPE_REGION Device;\r
 } PCI_TYPE00;\r
 \r
 ///\r
-/// defined in PCI-to-PCI Bridge Architecture Specification\r
+/// PCI-PCI Bridge header region in PCI Configuration Space\r
+/// Section 3.2, PCI-PCI Bridge Architecture, Version 1.2\r
 ///\r
 typedef struct {\r
   UINT32  Bar[2];\r
@@ -88,6 +101,10 @@ typedef struct {
   UINT16  BridgeControl;\r
 } PCI_BRIDGE_CONTROL_REGISTER;\r
 \r
+///\r
+/// PCI-to-PCI Bridge Configuration Space\r
+/// Section 3.2, PCI-PCI Bridge Architecture, Version 1.2\r
+///\r
 typedef struct {\r
   PCI_DEVICE_INDEPENDENT_REGION Hdr;\r
   PCI_BRIDGE_CONTROL_REGISTER   Bridge;\r
@@ -99,7 +116,8 @@ typedef union {
 } PCI_TYPE_GENERIC;\r
 \r
 /// \r
-/// CardBus Conroller Configuration Space, defined in PC Card Standard. 8.0\r
+/// CardBus Conroller Configuration Space, \r
+/// Section 4.5.1, PC Card Standard. 8.0\r
 ///\r
 typedef struct {\r
   UINT32  CardBusSocketReg;     ///< Cardus Socket/ExCA Base\r
@@ -437,13 +455,18 @@ typedef union {
 #define EFI_PCI_CAPABILITY_ID_MSI     0x05\r
 #define EFI_PCI_CAPABILITY_ID_HOTPLUG 0x06\r
 \r
+///\r
+/// Capabilities List Header\r
+/// Section 6.7, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   UINT8 CapabilityID;\r
   UINT8 NextItemPtr;\r
 } EFI_PCI_CAPABILITY_HDR;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_PMI, defined in PCI Power Management Interface Specifiction\r
+/// Power Management Register Block Definition \r
+/// Section 3.2, PCI Power Management Interface Specifiction, Revision 1.2\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -454,7 +477,8 @@ typedef struct {
 } EFI_PCI_CAPABILITY_PMI;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_AGP, defined in Accelerated Graphics Port Interface Specification\r
+/// A.G.P Capability\r
+/// Section 6.1.4, Accelerated Graphics Port Interface Specification, Revision 1.0\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -465,7 +489,8 @@ typedef struct {
 } EFI_PCI_CAPABILITY_AGP;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_VPD, in PCI2.2 Spec.\r
+/// VPD Capability Structure\r
+/// Appendix I, PCI Local Bus Specification, 2.2\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -474,7 +499,8 @@ typedef struct {
 } EFI_PCI_CAPABILITY_VPD;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_SLOTID, defined in PCI-to-PCI Bridge Architeture Specification\r
+/// Slot Numbering Capabilities Register\r
+/// Section 3.2.6, PCI-to-PCI Bridge Architeture Specification, Revision 1.2\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -483,7 +509,8 @@ typedef struct {
 } EFI_PCI_CAPABILITY_SLOTID;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_MSI, defined in PCI2.2\r
+/// Message Capability Structure for 32-bit Message Address\r
+/// Section 6.8.1, PCI Local Bus Specification, 2.2\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -492,6 +519,10 @@ typedef struct {
   UINT16                  MsgDataReg;\r
 } EFI_PCI_CAPABILITY_MSI32;\r
 \r
+///\r
+/// Message Capability Structure for 64-bit Message Address\r
+/// Section 6.8.1, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
   UINT16                  MsgCtrlReg;\r
@@ -501,7 +532,8 @@ typedef struct {
 } EFI_PCI_CAPABILITY_MSI64;\r
 \r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_HOTPLUG, defined in CompactPCI Hot Swap Specification PICMG 2.1, R1.0\r
+/// Capability EFI_PCI_CAPABILITY_ID_HOTPLUG, \r
+/// CompactPCI Hot Swap Specification PICMG 2.1, R1.0\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -546,12 +578,20 @@ typedef struct {
 #define PCI_CODE_TYPE_PCAT_IMAGE                        0x00\r
 #define EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED         0x0001  ///< defined in UEFI spec.\r
 \r
+///\r
+/// Standard PCI Expansion ROM Header\r
+/// Section 13.4.2, Unified Extensible Firmware Interface Specification, Version 2.1\r
+///\r
 typedef struct {\r
   UINT16  Signature;    ///< 0xaa55\r
   UINT8   Reserved[0x16];\r
   UINT16  PcirOffset;\r
 } PCI_EXPANSION_ROM_HEADER;\r
 \r
+///\r
+/// Legacy ROM Header Extensions\r
+/// Section 6.3.3.1, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   UINT16  Signature;    ///< 0xaa55\r
   UINT8   Size512;\r
@@ -560,6 +600,10 @@ typedef struct {
   UINT16  PcirOffset;\r
 } EFI_LEGACY_EXPANSION_ROM_HEADER;\r
 \r
+///\r
+/// PCI Data Structure Format\r
+/// Section 6.3.1.2, PCI Local Bus Specification, 2.2\r
+///\r
 typedef struct {\r
   UINT32  Signature;    ///< "PCIR"\r
   UINT16  VendorId;\r
@@ -576,7 +620,8 @@ typedef struct {
 } PCI_DATA_STRUCTURE;\r
 \r
 ///\r
-/// defined in EFI/UEFI Spec\r
+/// EFI PCI Expansion ROM Header\r
+/// Section 13.4.2, Unified Extensible Firmware Interface Specification, Version 2.1\r
 ///\r
 typedef struct {\r
   UINT16  Signature;    ///< 0xaa55\r

diff --git a/MdePkg/Include/IndustryStandard/Pci23.h b/MdePkg/Include/IndustryStandard/Pci23.h
index b100dce1a086022bd6159aa8d0b973ee25df393b..be079835d24acc467295dbed84ff0c25e414b4b6 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Pci23.h
+++ b/MdePkg/Include/IndustryStandard/Pci23.h
@@ -34,7 +34,8 @@
 \r
 #pragma pack(1)\r
 ///\r
-/// Capability EFI_PCI_CAPABILITY_ID_PCIX, defined in PCI-X Addendum to the PCI Local Bus Specification\r
+/// PCI-X Capabilities List, \r
+/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r
@@ -42,8 +43,9 @@ typedef struct {
   UINT32                  StatusReg;\r
 } EFI_PCI_CAPABILITY_PCIX;\r
 \r
-/// \r
-/// Capability EFI_PCI_CAPABILITY_PCIX_BRDG, defined in PCI-X Addendum to the PCI Local Bus Specification\r
+///\r
+/// PCI-X Bridge Capabilities List, \r
+/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
 ///\r
 typedef struct {\r
   EFI_PCI_CAPABILITY_HDR  Hdr;\r

diff --git a/MdePkg/Include/IndustryStandard/Pci30.h b/MdePkg/Include/IndustryStandard/Pci30.h
index 3bcf2327f143e15832727feb1bf8269115642406..505a527ac26f7a9ea47e7ae4ab8f569d783f90eb 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Pci30.h
+++ b/MdePkg/Include/IndustryStandard/Pci30.h
@@ -33,7 +33,8 @@
 #pragma pack(1)\r
 \r
 ///\r
-/// defined in PCI Firmware Specification\r
+/// PCI Data Structure Format\r
+/// Section 5.1.2, PCI Firmware Specification, Revision 3.0\r
 ///\r
 typedef struct {\r
   UINT32  Signature;    ///< "PCIR"\r

diff --git a/MdePkg/Include/IndustryStandard/PeImage.h b/MdePkg/Include/IndustryStandard/PeImage.h
index fc01e78273e2b88795fb50aa58b43d9a017810b2..97a17e5eb5fcf0ce469b6d0e4ba4bcd8730d2d48 100644 (file)
--- a/MdePkg/Include/IndustryStandard/PeImage.h
+++ b/MdePkg/Include/IndustryStandard/PeImage.h
@@ -21,9 +21,9 @@
 #ifndef __PE_IMAGE_H__\r
 #define __PE_IMAGE_H__\r
 \r
-///\r
-/// PE32+ Subsystem type for EFI images\r
-///\r
+//\r
+// PE32+ Subsystem type for EFI images\r
+//\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION         10\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11\r
 #define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER      12\r
@@ -32,9 +32,9 @@
 #define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER      13 ///< defined PI Specification, 1.0\r
 \r
 \r
-///\r
-/// PE32+ Machine type for EFI images\r
-///\r
+//\r
+// PE32+ Machine type for EFI images\r
+//\r
 #define IMAGE_FILE_MACHINE_I386     0x014c\r
 #define IMAGE_FILE_MACHINE_IA64     0x0200\r
 #define IMAGE_FILE_MACHINE_EBC      0x0EBC\r
@@ -48,9 +48,9 @@
 #define EFI_IMAGE_MACHINE_EBC       IMAGE_FILE_MACHINE_EBC  \r
 #define EFI_IMAGE_MACHINE_X64       IMAGE_FILE_MACHINE_X64\r
 \r
-///\r
-/// EXE file formats\r
-///\r
+//\r
+// EXE file formats\r
+//\r
 #define EFI_IMAGE_DOS_SIGNATURE     SIGNATURE_16('M', 'Z')\r
 #define EFI_IMAGE_OS2_SIGNATURE     SIGNATURE_16('N', 'E')\r
 #define EFI_IMAGE_OS2_SIGNATURE_LE  SIGNATURE_16('L', 'E')\r
@@ -100,9 +100,9 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_FILE_HEADER        20\r
 \r
-///\r
-/// Characteristics\r
-///\r
+//\r
+// Characteristics\r
+//\r
 #define EFI_IMAGE_FILE_RELOCS_STRIPPED      BIT0     ///< 0x0001  Relocation info stripped from file.\r
 #define EFI_IMAGE_FILE_EXECUTABLE_IMAGE     BIT1     ///< 0x0002  File is executable  (i.e. no unresolved externel references).\r
 #define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED   BIT2     ///< 0x0004  Line nunbers stripped from file.\r
@@ -114,9 +114,9 @@ typedef struct {
 #define EFI_IMAGE_FILE_DLL                  BIT13    ///< 0x2000  File is a DLL.\r
 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI    BIT15    ///< 0x8000  Bytes of machine word are reversed.\r
 \r
-///\r
-/// Other Machine Types\r
-///\r
+//\r
+// Other Machine Types\r
+//\r
 #define EFI_IMAGE_FILE_MACHINE_UNKNOWN      0       ///< Any machine type\r
 #define EFI_IMAGE_FILE_MACHINE_I386         0x14c   ///< Intel 386.\r
 #define EFI_IMAGE_FILE_MACHINE_R3000        0x162   ///< MIPS* little-endian, 0540 big-endian\r
@@ -136,9 +136,9 @@ typedef struct {
 \r
 #define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC      0x107\r
 \r
-///\r
-/// Directory Entries\r
-///\r
+//\r
+// Directory Entries\r
+//\r
 #define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT      0\r
 #define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT      1\r
 #define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE    2\r
@@ -160,7 +160,10 @@ typedef struct {
 /// after NT additional fields.\r
 ///\r
 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
-\r
+          \r
+///\r
+/// Optional Header Standard Fields for PE32\r
+///\r
 typedef struct {\r
   ///\r
   /// Standard fields.\r
@@ -175,7 +178,7 @@ typedef struct {
   UINT32                    BaseOfCode;\r
   UINT32                    BaseOfData;  ///< PE32 contains this additional field, which is absent in PE32+\r
   ///\r
-  /// NT additional fields.\r
+  /// Optional Header Windows-Specific Fields.\r
   ///\r
   UINT32                    ImageBase;\r
   UINT32                    SectionAlignment;\r
@@ -209,10 +212,13 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
 \r
+///\r
+/// Optional Header Standard Fields for PE32+\r
+///\r
 typedef struct {\r
-  //\r
-  // Standard fields.\r
-  //\r
+  ///\r
+  /// Standard fields.\r
+  ///\r
   UINT16                    Magic;\r
   UINT8                     MajorLinkerVersion;\r
   UINT8                     MinorLinkerVersion;\r
@@ -221,9 +227,9 @@ typedef struct {
   UINT32                    SizeOfUninitializedData;\r
   UINT32                    AddressOfEntryPoint;\r
   UINT32                    BaseOfCode;\r
-  //\r
-  // NT additional fields.\r
-  //\r
+  ///\r
+  /// Optional Header Windows-Specific Fields.\r
+  ///\r
   UINT64                    ImageBase;\r
   UINT32                    SectionAlignment;\r
   UINT32                    FileAlignment;\r
@@ -331,9 +337,9 @@ typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;
         ) \\r
     )\r
 \r
-///\r
-/// Other Windows Subsystem Values\r
-///\r
+//\r
+// Other Windows Subsystem Values\r
+//\r
 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN     0\r
 #define EFI_IMAGE_SUBSYSTEM_NATIVE      1\r
 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2\r
@@ -346,6 +352,9 @@ typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;
 ///\r
 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
 \r
+///\r
+/// Section Table, this table immediately follows the optional header\r
+///\r
 typedef struct {\r
   UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
   union {\r
@@ -367,9 +376,9 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_SECTION_HEADER       40\r
          \r
-///\r
-/// Section Flags Values\r
-///\r
+//\r
+// Section Flags Values\r
+//\r
 #define EFI_IMAGE_SCN_TYPE_NO_PAD                  BIT3   ///< 0x00000008  ///< Reserved.\r
 #define EFI_IMAGE_SCN_CNT_CODE                     BIT5   ///< 0x00000020\r
 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA         BIT6   ///< 0x00000040\r
@@ -401,17 +410,17 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_SYMBOL 18\r
 \r
-///\r
-/// Symbols have a section number of the section in which they are\r
-/// defined. Otherwise, section numbers have the following meanings:\r
-///\r
+//\r
+// Symbols have a section number of the section in which they are\r
+// defined. Otherwise, section numbers have the following meanings:\r
+//\r
 #define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0  ///< Symbol is undefined or is common.\r
 #define EFI_IMAGE_SYM_ABSOLUTE  (UINT16) -1 ///< Symbol is an absolute value.\r
 #define EFI_IMAGE_SYM_DEBUG     (UINT16) -2 ///< Symbol is a special debug item.\r
 \r
-///\r
-/// Symbol Type (fundamental) values.\r
-///\r
+//\r
+// Symbol Type (fundamental) values.\r
+//\r
 #define EFI_IMAGE_SYM_TYPE_NULL   0   ///< no type.\r
 #define EFI_IMAGE_SYM_TYPE_VOID   1   ///< no valid type.\r
 #define EFI_IMAGE_SYM_TYPE_CHAR   2   ///< type character.\r
@@ -429,17 +438,17 @@ typedef struct {
 #define EFI_IMAGE_SYM_TYPE_UINT   14\r
 #define EFI_IMAGE_SYM_TYPE_DWORD  15\r
 \r
-///\r
-/// Symbol Type (derived) values.\r
-///\r
+//\r
+// Symbol Type (derived) values.\r
+//\r
 #define EFI_IMAGE_SYM_DTYPE_NULL      0 ///< no derived type.\r
 #define EFI_IMAGE_SYM_DTYPE_POINTER   1\r
 #define EFI_IMAGE_SYM_DTYPE_FUNCTION  2\r
 #define EFI_IMAGE_SYM_DTYPE_ARRAY     3\r
 \r
-///\r
-/// Storage classes.\r
-///\r
+//\r
+// Storage classes.\r
+//\r
 #define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   ((UINT8) -1)\r
 #define EFI_IMAGE_SYM_CLASS_NULL              0\r
 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC         1\r
@@ -477,18 +486,18 @@ typedef struct {
 #define EFI_IMAGE_N_BTSHFT  4\r
 #define EFI_IMAGE_N_TSHIFT  2\r
 \r
-///\r
-/// Communal selection types.\r
-///\r
+//\r
+// Communal selection types.\r
+//\r
 #define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES    1\r
 #define EFI_IMAGE_COMDAT_SELECT_ANY             2\r
 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE       3\r
 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH     4\r
 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE     5\r
                                        \r
-///\r
-/// the following values only be referred in PeCoff, not defined in PECOFF.\r
-///\r
+//\r
+// the following values only be referred in PeCoff, not defined in PECOFF.\r
+//\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY  1\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY    2\r
 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS      3\r
@@ -507,9 +516,9 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_RELOCATION 10\r
 \r
-///\r
-/// I386 relocation types.\r
-///\r
+//\r
+// I386 relocation types.\r
+//\r
 #define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000  ///< Reference is absolute, no relocation is necessary\r
 #define EFI_IMAGE_REL_I386_DIR16    0x0001  ///< Direct 16-bit reference to the symbols virtual address\r
 #define EFI_IMAGE_REL_I386_REL16    0x0002  ///< PC-relative 16-bit reference to the symbols virtual address\r
@@ -520,9 +529,9 @@ typedef struct {
 #define EFI_IMAGE_REL_I386_SECREL   0x000B\r
 #define EFI_IMAGE_REL_I386_REL32    0x0014  ///< PC-relative 32-bit reference to the symbols virtual address\r
 \r
-/// \r
-/// x64 processor relocation types.\r
-/// \r
+// \r
+// x64 processor relocation types.\r
+// \r
 #define IMAGE_REL_AMD64_ABSOLUTE  0x0000\r
 #define IMAGE_REL_AMD64_ADDR64    0x0001\r
 #define IMAGE_REL_AMD64_ADDR32    0x0002\r
@@ -554,9 +563,9 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8\r
 \r
-///\r
-/// Based relocation types.\r
-///\r
+//\r
+// Based relocation types.\r
+//\r
 #define EFI_IMAGE_REL_BASED_ABSOLUTE      0\r
 #define EFI_IMAGE_REL_BASED_HIGH          1\r
 #define EFI_IMAGE_REL_BASED_LOW           2\r
@@ -583,9 +592,9 @@ typedef struct {
 ///\r
 #define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
 \r
-///\r
-/// Archive format.\r
-///\r
+//\r
+// Archive format.\r
+//\r
 #define EFI_IMAGE_ARCHIVE_START_SIZE        8\r
 #define EFI_IMAGE_ARCHIVE_START             "!<arch>\n"\r
 #define EFI_IMAGE_ARCHIVE_END               "`\n"\r
@@ -593,6 +602,9 @@ typedef struct {
 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER     "/               "\r
 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER  "//              "\r
 \r
+///\r
+/// Archive Member Headers\r
+///\r
 typedef struct {\r
   UINT8 Name[16];     ///< File member name - `/' terminated.\r
   UINT8 Date[12];     ///< File member date - decimal.\r
@@ -609,9 +621,9 @@ typedef struct {
 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
 \r
 \r
-///\r
-/// DLL Support\r
-///\r
+//\r
+// DLL Support\r
+//\r
 \r
 ///\r
 /// Export Directory Table\r
@@ -638,6 +650,9 @@ typedef struct {
   UINT8   Name[1];\r
 } EFI_IMAGE_IMPORT_BY_NAME;\r
 \r
+///\r
+/// Import Address Table RVA (Thunk Table)\r
+///\r
 typedef struct {\r
   union {\r
     UINT32                    Function;\r

diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h b/MdePkg/Include/IndustryStandard/Tpm12.h
index 0c5fac2f9797db4c87477dca35bf70697e5af06f..5f5ce5731dc91cc5fe40b8affd6f9028379e0d52 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Tpm12.h
+++ b/MdePkg/Include/IndustryStandard/Tpm12.h
@@ -22,7 +22,7 @@
 #define TPM_BASE                    (EFI_MAX_BIT + (EFI_MAX_BIT >> 1))\r
 \r
 //\r
-// Structures are all packed on 1-byte alignment\r
+// All structures MUST be packed on a byte boundary.\r
 //\r
 \r
 #pragma pack (1)\r
@@ -281,9 +281,9 @@ typedef UINT32                      TPM_FAMILY_OPERATION;
 // Part 2, section 5: Basic Structures\r
 //\r
 \r
-//\r
-// Part 2, section 5.1: TPM_STRUCT_VER\r
-//\r
+///\r
+/// Part 2, section 5.1: TPM_STRUCT_VER\r
+///\r
 typedef struct tdTPM_STRUCT_VER {\r
   UINT8                             major;\r
   UINT8                             minor;\r
@@ -291,9 +291,9 @@ typedef struct tdTPM_STRUCT_VER {
   UINT8                             revMinor;\r
 } TPM_STRUCT_VER;\r
 \r
-//\r
-// Part 2, section 5.3: TPM_VERSION\r
-//\r
+///\r
+/// Part 2, section 5.3: TPM_VERSION\r
+///\r
 typedef struct tdTPM_VERSION {\r
   TPM_VERSION_BYTE                  major;\r
   TPM_VERSION_BYTE                  minor;\r
@@ -301,16 +301,17 @@ typedef struct tdTPM_VERSION {
   UINT8                             revMinor;\r
 } TPM_VERSION;\r
 \r
-//\r
-// Part 2, section 5.4: TPM_DIGEST\r
-//\r
-#define TPM_SHA1_160_HASH_LEN       0x14\r
-#define TPM_SHA1BASED_NONCE_LEN     TPM_SHA1_160_HASH_LEN\r
 \r
+///\r
+/// Part 2, section 5.4: TPM_DIGEST\r
+///\r
 typedef struct tdTPM_DIGEST{\r
   UINT8                             digest[TPM_SHA1_160_HASH_LEN];\r
 } TPM_DIGEST;\r
 \r
+#define TPM_SHA1_160_HASH_LEN       0x14\r
+#define TPM_SHA1BASED_NONCE_LEN     TPM_SHA1_160_HASH_LEN\r
+\r
 typedef TPM_DIGEST                  TPM_CHOSENID_HASH;\r
 typedef TPM_DIGEST                  TPM_COMPOSITE_HASH;\r
 typedef TPM_DIGEST                  TPM_DIRVALUE;\r
@@ -320,9 +321,9 @@ typedef TPM_DIGEST                  TPM_AUDITDIGEST;
 typedef TPM_DIGEST                  TPM_DAA_TPM_SEED;\r
 typedef TPM_DIGEST                  TPM_DAA_CONTEXT_SEED;\r
 \r
-//\r
-// Part 2, section 5.5: TPM_NONCE\r
-//\r
+///\r
+/// Part 2, section 5.5: TPM_NONCE\r
+///\r
 typedef struct tdTPM_NONCE{\r
   UINT8                             nonce[20];\r
 } TPM_NONCE;\r
@@ -335,10 +336,10 @@ typedef tdTPM_AUTHDATA              TPM_AUTHDATA;
 typedef TPM_AUTHDATA                TPM_SECRET;\r
 typedef TPM_AUTHDATA                TPM_ENCAUTH;\r
 \r
-//\r
-// Part 2, section 5.7: TPM_KEY_HANDLE_LIST\r
-// Size of handle is loaded * sizeof(TPM_KEY_HANDLE)\r
-//\r
+///\r
+/// Part 2, section 5.7: TPM_KEY_HANDLE_LIST\r
+/// Size of handle is loaded * sizeof(TPM_KEY_HANDLE)\r
+///\r
 typedef struct tdTPM_KEY_HANDLE_LIST {\r
   UINT16                            loaded;\r
   TPM_KEY_HANDLE                    handle[1];\r
@@ -409,9 +410,9 @@ typedef struct tdTPM_KEY_HANDLE_LIST {
 #define TPM_AUTH_ALWAYS             ((TPM_AUTH_DATA_USAGE) 0x01)\r
 #define TPM_AUTH_PRIV_USE_ONLY      ((TPM_AUTH_DATA_USAGE) 0x03)\r
 \r
-//\r
-// Part 2, section 5.10: TPM_KEY_FLAGS\r
-//\r
+///\r
+/// Part 2, section 5.10: TPM_KEY_FLAGS\r
+///\r
 typedef enum tdTPM_KEY_FLAGS {\r
   redirection                       = 0x00000001,\r
   migratable                        = 0x00000002,\r
@@ -420,21 +421,21 @@ typedef enum tdTPM_KEY_FLAGS {
   migrateAuthority                  = 0x00000010\r
 } TPM_KEY_FLAGS_BITS;\r
 \r
-//\r
-// Part 2, section 5.11: TPM_CHANGEAUTH_VALIDATE\r
-//\r
+///\r
+/// Part 2, section 5.11: TPM_CHANGEAUTH_VALIDATE\r
+///\r
 typedef struct tdTPM_CHANGEAUTH_VALIDATE {\r
   TPM_SECRET                        newAuthSecret;\r
   TPM_NONCE                         n1;\r
 } TPM_CHANGEAUTH_VALIDATE;\r
 \r
-//\r
-// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH\r
-//   decalared after section 10 to catch declaration of TPM_PUBKEY\r
-//\r
-// Part 2 section 10.1: TPM_KEY_PARMS\r
-//   [size_is(parmSize)] BYTE* parms;\r
-//\r
+///\r
+/// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH\r
+///   decalared after section 10 to catch declaration of TPM_PUBKEY\r
+///\r
+/// Part 2 section 10.1: TPM_KEY_PARMS\r
+///   [size_is(parmSize)] BYTE* parms;\r
+///\r
 typedef struct tdTPM_KEY_PARMS {\r
   TPM_ALGORITHM_ID                  algorithmID;\r
   TPM_ENC_SCHEME                    encScheme;\r
@@ -443,44 +444,44 @@ typedef struct tdTPM_KEY_PARMS {
   UINT8                             *parms;\r
 } TPM_KEY_PARMS;\r
 \r
-//\r
-// Part 2, section 10.4: TPM_STORE_PUBKEY\r
-//\r
+///\r
+/// Part 2, section 10.4: TPM_STORE_PUBKEY\r
+///\r
 typedef struct tdTPM_STORE_PUBKEY {\r
   UINT32                            keyLength;\r
   UINT8                             key[1];\r
 } TPM_STORE_PUBKEY;\r
 \r
-//\r
-// Part 2, section 10.5: TPM_PUBKEY\r
-//\r
+///\r
+/// Part 2, section 10.5: TPM_PUBKEY\r
+///\r
 typedef struct tdTPM_PUBKEY{\r
   TPM_KEY_PARMS                     algorithmParms;\r
   TPM_STORE_PUBKEY                  pubKey;\r
 } TPM_PUBKEY;\r
 \r
-//\r
-// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH\r
-//\r
+///\r
+/// Part 2, section 5.12: TPM_MIGRATIONKEYAUTH\r
+///\r
 typedef struct tdTPM_MIGRATIONKEYAUTH{\r
   TPM_PUBKEY                        migrationKey;\r
   TPM_MIGRATE_SCHEME                migrationScheme;\r
   TPM_DIGEST                        digest;\r
 } TPM_MIGRATIONKEYAUTH;\r
 \r
-//\r
-// Part 2, section 5.13: TPM_COUNTER_VALUE\r
-//\r
+///\r
+/// Part 2, section 5.13: TPM_COUNTER_VALUE\r
+///\r
 typedef struct tdTPM_COUNTER_VALUE{\r
   TPM_STRUCTURE_TAG                 tag;\r
   UINT8                             label[4];\r
   TPM_ACTUAL_COUNT                  counter;\r
 } TPM_COUNTER_VALUE;\r
 \r
-//\r
-// Part 2, section 5.14: TPM_SIGN_INFO\r
-//   Size of data indicated by dataLen\r
-//\r
+///\r
+/// Part 2, section 5.14: TPM_SIGN_INFO\r
+///   Size of data indicated by dataLen\r
+///\r
 typedef struct tdTPM_SIGN_INFO {\r
   TPM_STRUCTURE_TAG                 tag;\r
   UINT8                             fixed[4];\r
@@ -489,18 +490,18 @@ typedef struct tdTPM_SIGN_INFO {
   UINT8                             *data;\r
 } TPM_SIGN_INFO;\r
 \r
-//\r
-// Part 2, section 5.15: TPM_MSA_COMPOSITE\r
-//   Number of migAuthDigest indicated by MSAlist\r
-//\r
+///\r
+/// Part 2, section 5.15: TPM_MSA_COMPOSITE\r
+///   Number of migAuthDigest indicated by MSAlist\r
+///\r
 typedef struct tdTPM_MSA_COMPOSITE {\r
   UINT32                            MSAlist;\r
   TPM_DIGEST                        migAuthDigest[1];\r
 } TPM_MSA_COMPOSITE;\r
 \r
-//\r
-// Part 2, section 5.16: TPM_CMK_AUTH\r
-//\r
+///\r
+/// Part 2, section 5.16: TPM_CMK_AUTH\r
+///\r
 typedef struct tdTPM_CMK_AUTH{\r
   TPM_DIGEST                        migrationAuthorityDigest;\r
   TPM_DIGEST                        destinationKeyDigest;\r
@@ -516,36 +517,36 @@ typedef struct tdTPM_CMK_AUTH{
 #define TPM_CMK_DELEGATE_LEGACY     ((TPM_CMK_DELEGATE) BIT28)\r
 #define TPM_CMK_DELEGATE_MIGRATE    ((TPM_CMK_DELEGATE) BIT27)\r
 \r
-//\r
-// Part 2, section 5.18: TPM_SELECT_SIZE\r
-//\r
+///\r
+/// Part 2, section 5.18: TPM_SELECT_SIZE\r
+///\r
 typedef struct tdTPM_SELECT_SIZE {\r
   UINT8                             major;\r
   UINT8                             minor;\r
   UINT16                            reqSize;\r
 } TPM_SELECT_SIZE;\r
 \r
-//\r
-// Part 2, section 5,19: TPM_CMK_MIGAUTH\r
-//\r
+///\r
+/// Part 2, section 5,19: TPM_CMK_MIGAUTH\r
+///\r
 typedef struct tdTPM_CMK_MIGAUTH{\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_DIGEST                        msaDigest;\r
   TPM_DIGEST                        pubKeyDigest;\r
 } TPM_CMK_MIGAUTH;\r
 \r
-//\r
-// Part 2, section 5.20: TPM_CMK_SIGTICKET\r
-//\r
+///\r
+/// Part 2, section 5.20: TPM_CMK_SIGTICKET\r
+///\r
 typedef struct tdTPM_CMK_SIGTICKET{\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_DIGEST                        verKeyDigest;\r
   TPM_DIGEST                        signedData;\r
 } TPM_CMK_SIGTICKET;\r
 \r
-//\r
-// Part 2, section 5.21: TPM_CMK_MA_APPROVAL\r
-//\r
+///\r
+/// Part 2, section 5.21: TPM_CMK_MA_APPROVAL\r
+///\r
 typedef struct tdTPM_CMK_MA_APPROVAL{\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_DIGEST                        migrationAuthorityDigest;\r
@@ -561,9 +562,9 @@ typedef struct tdTPM_CMK_MA_APPROVAL{
 #define TPM_TAG_RSP_AUTH1_COMMAND   ((TPM_STRUCTURE_TAG) 0x00C5)\r
 #define TPM_TAG_RSP_AUTH2_COMMAND   ((TPM_STRUCTURE_TAG) 0x00C6)\r
 \r
-//\r
-// Part 2, section 7.1: TPM_PERMANENT_FLAGS\r
-//\r
+///\r
+/// Part 2, section 7.1: TPM_PERMANENT_FLAGS\r
+///\r
 typedef struct tdTPM_PERMANENT_FLAGS{\r
   TPM_STRUCTURE_TAG                 tag;\r
   BOOLEAN                           disable;\r
@@ -610,9 +611,9 @@ typedef struct tdTPM_PERMANENT_FLAGS{
 #define TPM_PF_TPMESTABLISHED               ((TPM_CAPABILITY_AREA) 18)\r
 #define TPM_PF_MAINTENANCEDONE              ((TPM_CAPABILITY_AREA) 19)\r
 \r
-//\r
-// Part 2, section 7.2: TPM_STCLEAR_FLAGS\r
-//\r
+///\r
+/// Part 2, section 7.2: TPM_STCLEAR_FLAGS\r
+///\r
 typedef struct tdTPM_STCLEAR_FLAGS{\r
   TPM_STRUCTURE_TAG                 tag;\r
   BOOLEAN                           deactivated;\r
@@ -631,9 +632,9 @@ typedef struct tdTPM_STCLEAR_FLAGS{
 #define TPM_SF_PHYSICALPRESENCELOCK ((TPM_CAPABILITY_AREA) 4)\r
 #define TPM_SF_BGLOBALLOCK          ((TPM_CAPABILITY_AREA) 5)\r
 \r
-//\r
-// Part 2, section 7.3: TPM_STANY_FLAGS\r
-//\r
+///\r
+/// Part 2, section 7.3: TPM_STANY_FLAGS\r
+///\r
 typedef struct tdTPM_STANY_FLAGS{\r
   TPM_STRUCTURE_TAG                 tag;\r
   BOOLEAN                           postInitialise;\r
@@ -659,37 +660,37 @@ typedef struct tdTPM_STANY_FLAGS{
 // Part 2, section 8: PCR Structures\r
 // \r
 \r
-//\r
-// Part 2, section 8.1: TPM_PCR_SELECTION\r
-//   Size of pcrSelect[] indicated by sizeOfSelect\r
-//\r
+///\r
+/// Part 2, section 8.1: TPM_PCR_SELECTION\r
+///   Size of pcrSelect[] indicated by sizeOfSelect\r
+///\r
 typedef struct tdTPM_PCR_SELECTION {\r
   UINT16                            sizeOfSelect;\r
   UINT8                             pcrSelect[1];\r
 } TPM_PCR_SELECTION;\r
 \r
-//\r
-// Part 2, section 8.2: TPM_PCR_COMPOSITE\r
-//   Size of pcrValue[] indicated by valueSize\r
-//\r
+///\r
+/// Part 2, section 8.2: TPM_PCR_COMPOSITE\r
+///   Size of pcrValue[] indicated by valueSize\r
+///\r
 typedef struct tdTPM_PCR_COMPOSITE {\r
   TPM_PCR_SELECTION                 select;\r
   UINT32                            valueSize;\r
   TPM_PCRVALUE                      pcrValue[1];\r
 } TPM_PCR_COMPOSITE;\r
 \r
-//\r
-// Part 2, section 8.3: TPM_PCR_INFO\r
-//\r
+///\r
+/// Part 2, section 8.3: TPM_PCR_INFO\r
+///\r
 typedef struct tdTPM_PCR_INFO {\r
   TPM_PCR_SELECTION                 pcrSelection;\r
   TPM_COMPOSITE_HASH                digestAtRelease;\r
   TPM_COMPOSITE_HASH                digestAtCreation;\r
 } TPM_PCR_INFO;\r
 \r
-//\r
-// Part 2, section 8.6: TPM_LOCALITY_SELECTION\r
-//\r
+///\r
+/// Part 2, section 8.6: TPM_LOCALITY_SELECTION\r
+///\r
 typedef UINT8                       TPM_LOCALITY_SELECTION;\r
 \r
 #define TPM_LOC_FOUR                ((UINT8) 0x10)\r
@@ -698,9 +699,9 @@ typedef UINT8                       TPM_LOCALITY_SELECTION;
 #define TPM_LOC_ONE                 ((UINT8) 0x02)\r
 #define TPM_LOC_ZERO                ((UINT8) 0x01)\r
 \r
-//\r
-// Part 2, section 8.4: TPM_PCR_INFO_LONG\r
-//\r
+///\r
+/// Part 2, section 8.4: TPM_PCR_INFO_LONG\r
+///\r
 typedef struct tdTPM_PCR_INFO_LONG {\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_LOCALITY_SELECTION            localityAtCreation;\r
@@ -711,18 +712,18 @@ typedef struct tdTPM_PCR_INFO_LONG {
   TPM_COMPOSITE_HASH                digestAtRelease;\r
 } TPM_PCR_INFO_LONG;\r
 \r
-//\r
-// Part 2, section 8.5: TPM_PCR_INFO_SHORT\r
-//\r
+///\r
+/// Part 2, section 8.5: TPM_PCR_INFO_SHORT\r
+///\r
 typedef struct tdTPM_PCR_INFO_SHORT{\r
   TPM_PCR_SELECTION                 pcrSelection;\r
   TPM_LOCALITY_SELECTION            localityAtRelease;\r
   TPM_COMPOSITE_HASH                digestAtRelease;\r
 } TPM_PCR_INFO_SHORT;\r
 \r
-//\r
-// Part 2, section 8.8: TPM_PCR_ATTRIBUTES\r
-//\r
+///\r
+/// Part 2, section 8.8: TPM_PCR_ATTRIBUTES\r
+///\r
 typedef struct tdTPM_PCR_ATTRIBUTES{\r
   BOOLEAN                           pcrReset;\r
   TPM_LOCALITY_SELECTION            pcrExtendLocal;\r
@@ -733,11 +734,11 @@ typedef struct tdTPM_PCR_ATTRIBUTES{
 // Part 2, section 9: Storage Structures\r
 //\r
 \r
-//\r
-// Part 2, section 9.1: TPM_STORED_DATA\r
-//   [size_is(sealInfoSize)] BYTE* sealInfo;\r
-//   [size_is(encDataSize)] BYTE* encData;\r
-//\r
+///\r
+/// Part 2, section 9.1: TPM_STORED_DATA\r
+///   [size_is(sealInfoSize)] BYTE* sealInfo;\r
+///   [size_is(encDataSize)] BYTE* encData;\r
+///\r
 typedef struct tdTPM_STORED_DATA {\r
   TPM_STRUCT_VER                    ver;\r
   UINT32                            sealInfoSize;\r
@@ -746,11 +747,11 @@ typedef struct tdTPM_STORED_DATA {
   UINT8                             *encData;\r
 } TPM_STORED_DATA;\r
 \r
-//\r
-// Part 2, section 9.2: TPM_STORED_DATA12\r
-//   [size_is(sealInfoSize)] BYTE* sealInfo;\r
-//   [size_is(encDataSize)] BYTE* encData;\r
-//\r
+///\r
+/// Part 2, section 9.2: TPM_STORED_DATA12\r
+///   [size_is(sealInfoSize)] BYTE* sealInfo;\r
+///   [size_is(encDataSize)] BYTE* encData;\r
+///\r
 typedef struct tdTPM_STORED_DATA12 {\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_ENTITY_TYPE                   et;\r
@@ -760,10 +761,10 @@ typedef struct tdTPM_STORED_DATA12 {
   UINT8                             *encData;\r
 } TPM_STORED_DATA12;\r
 \r
-//\r
-// Part 2, section 9.3: TPM_SEALED_DATA\r
-//   [size_is(dataSize)] BYTE* data;\r
-//\r
+///\r
+/// Part 2, section 9.3: TPM_SEALED_DATA\r
+///   [size_is(dataSize)] BYTE* data;\r
+///\r
 typedef struct tdTPM_SEALED_DATA {\r
   TPM_PAYLOAD_TYPE                  payload;\r
   TPM_SECRET                        authData;\r
@@ -773,10 +774,10 @@ typedef struct tdTPM_SEALED_DATA {
   UINT8                             *data;\r
 } TPM_SEALED_DATA;\r
 \r
-//\r
-// Part 2, section 9.4: TPM_SYMMETRIC_KEY\r
-//   [size_is(size)] BYTE* data;\r
-//\r
+///\r
+/// Part 2, section 9.4: TPM_SYMMETRIC_KEY\r
+///   [size_is(size)] BYTE* data;\r
+///\r
 typedef struct tdTPM_SYMMETRIC_KEY {\r
   TPM_ALGORITHM_ID                  algId;\r
   TPM_ENC_SCHEME                    encScheme;\r
@@ -784,9 +785,9 @@ typedef struct tdTPM_SYMMETRIC_KEY {
   UINT8                             *data;\r
 } TPM_SYMMETRIC_KEY;\r
 \r
-//\r
-// Part 2, section 9.5: TPM_BOUND_DATA\r
-//\r
+///\r
+/// Part 2, section 9.5: TPM_BOUND_DATA\r
+///\r
 typedef struct tdTPM_BOUND_DATA {\r
   TPM_STRUCT_VER                    ver;\r
   TPM_PAYLOAD_TYPE                  payload;\r
@@ -801,10 +802,10 @@ typedef struct tdTPM_BOUND_DATA {
 // Section 10.1, 10.4, and 10.5 have been defined previously\r
 //\r
 \r
-//\r
-// Part 2, section 10.2: TPM_KEY\r
-//   [size_is(encDataSize)] BYTE* encData;\r
-//\r
+///\r
+/// Part 2, section 10.2: TPM_KEY\r
+///   [size_is(encDataSize)] BYTE* encData;\r
+///\r
 typedef struct tdTPM_KEY{\r
   TPM_STRUCT_VER                    ver;\r
   TPM_KEY_USAGE                     keyUsage;\r
@@ -818,10 +819,10 @@ typedef struct tdTPM_KEY{
   UINT8                             *encData;\r
 } TPM_KEY;\r
 \r
-//\r
-// Part 2, section 10.3: TPM_KEY12\r
-//   [size_is(encDataSize)] BYTE* encData;\r
-//\r
+///\r
+/// Part 2, section 10.3: TPM_KEY12\r
+///   [size_is(encDataSize)] BYTE* encData;\r
+///\r
 typedef struct tdTPM_KEY12{\r
   TPM_STRUCTURE_TAG                 tag;\r
   UINT16                            fill;\r
@@ -836,18 +837,18 @@ typedef struct tdTPM_KEY12{
   UINT8                             *encData;\r
 } TPM_KEY12;\r
 \r
-//\r
-// Part 2, section 10.7: TPM_STORE_PRIVKEY\r
-//   [size_is(keyLength)] BYTE* key;\r
-//\r
+///\r
+/// Part 2, section 10.7: TPM_STORE_PRIVKEY\r
+///   [size_is(keyLength)] BYTE* key;\r
+///\r
 typedef struct tdTPM_STORE_PRIVKEY {\r
   UINT32                            keyLength;\r
   UINT8                             *key;\r
 } TPM_STORE_PRIVKEY;\r
 \r
-//\r
-// Part 2, section 10.6: TPM_STORE_ASYMKEY\r
-//\r
+///\r
+/// Part 2, section 10.6: TPM_STORE_ASYMKEY\r
+///\r
 typedef struct tdTPM_STORE_ASYMKEY {                // pos len total\r
   TPM_PAYLOAD_TYPE                  payload;        // 0    1   1\r
   TPM_SECRET                        usageAuth;      // 1    20  21\r
@@ -856,10 +857,10 @@ typedef struct tdTPM_STORE_ASYMKEY {                // pos len total
   TPM_STORE_PRIVKEY                 privKey;        // 61 132-151 193-214\r
 } TPM_STORE_ASYMKEY;\r
 \r
-//\r
-// Part 2, section 10.8: TPM_MIGRATE_ASYMKEY\r
-//   [size_is(partPrivKeyLen)] BYTE* partPrivKey;\r
-//\r
+///\r
+/// Part 2, section 10.8: TPM_MIGRATE_ASYMKEY\r
+///   [size_is(partPrivKeyLen)] BYTE* partPrivKey;\r
+///\r
 typedef struct tdTPM_MIGRATE_ASYMKEY {              // pos  len  total\r
   TPM_PAYLOAD_TYPE                  payload;        //   0    1       1\r
   TPM_SECRET                        usageAuth;      //   1   20      21\r
@@ -868,18 +869,18 @@ typedef struct tdTPM_MIGRATE_ASYMKEY {              // pos  len  total
   UINT8                             *partPrivKey;   //  45 112-127 157-172\r
 } TPM_MIGRATE_ASYMKEY;\r
 \r
-//\r
-// Part 2, section 10.9: TPM_KEY_CONTROL\r
-//\r
+///\r
+/// Part 2, section 10.9: TPM_KEY_CONTROL\r
+///\r
 #define TPM_KEY_CONTROL_OWNER_EVICT ((UINT32) 0x00000001)\r
 \r
 //\r
 // Part 2, section 11: Signed Structures\r
 //\r
 \r
-//\r
-// Part 2, section 11.1: TPM_CERTIFY_INFO Structure\r
-//\r
+///\r
+/// Part 2, section 11.1: TPM_CERTIFY_INFO Structure\r
+///\r
 typedef struct tdTPM_CERTIFY_INFO {\r
   TPM_STRUCT_VER                  version;\r
   TPM_KEY_USAGE                   keyUsage;\r
@@ -893,9 +894,9 @@ typedef struct tdTPM_CERTIFY_INFO {
   UINT8                           *PCRInfo;\r
 } TPM_CERTIFY_INFO;\r
 \r
-//\r
-// Part 2, section 11.2: TPM_CERTIFY_INFO2 Structure\r
-//\r
+///\r
+/// Part 2, section 11.2: TPM_CERTIFY_INFO2 Structure\r
+///\r
 typedef struct tdTPM_CERTIFY_INFO2 {\r
   TPM_STRUCTURE_TAG               tag;\r
   UINT8                           fill;\r
@@ -913,9 +914,9 @@ typedef struct tdTPM_CERTIFY_INFO2 {
   UINT8                           *migrationAuthority;\r
 } TPM_CERTIFY_INFO2;\r
 \r
-//\r
-// Part 2, section 11.3 TPM_QUOTE_INFO Structure\r
-//\r
+///\r
+/// Part 2, section 11.3 TPM_QUOTE_INFO Structure\r
+///\r
 typedef struct tdTPM_QUOTE_INFO {\r
   TPM_STRUCT_VER                  version;\r
   UINT8                           fixed[4];\r
@@ -923,9 +924,9 @@ typedef struct tdTPM_QUOTE_INFO {
   TPM_NONCE                       externalData;\r
 } TPM_QUOTE_INFO;\r
 \r
-//\r
-// Part 2, section 11.4 TPM_QUOTE_INFO2 Structure\r
-//\r
+///\r
+/// Part 2, section 11.4 TPM_QUOTE_INFO2 Structure\r
+///\r
 typedef struct tdTPM_QUOTE_INFO2 {\r
   TPM_STRUCTURE_TAG               tag;\r
   UINT8                           fixed[4];\r
@@ -937,9 +938,9 @@ typedef struct tdTPM_QUOTE_INFO2 {
 // Part 2, section 12: Identity Structures\r
 //\r
 \r
-//\r
-// Part 2, section 12.1 TPM_EK_BLOB\r
-//\r
+///\r
+/// Part 2, section 12.1 TPM_EK_BLOB\r
+///\r
 typedef struct tdTPM_EK_BLOB {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_EK_TYPE                     ekType;\r
@@ -947,9 +948,9 @@ typedef struct tdTPM_EK_BLOB {
   UINT8                           *blob;\r
 } TPM_EK_BLOB;\r
 \r
-//\r
-// Part 2, section 12.2 TPM_EK_BLOB_ACTIVATE\r
-//\r
+///\r
+/// Part 2, section 12.2 TPM_EK_BLOB_ACTIVATE\r
+///\r
 typedef struct tdTPM_EK_BLOB_ACTIVATE {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_SYMMETRIC_KEY               sessionKey;\r
@@ -957,18 +958,18 @@ typedef struct tdTPM_EK_BLOB_ACTIVATE {
   TPM_PCR_INFO_SHORT              pcrInfo;\r
 } TPM_EK_BLOB_ACTIVATE;\r
 \r
-//\r
-// Part 2, section 12.3 TPM_EK_BLOB_AUTH\r
-//\r
+///\r
+/// Part 2, section 12.3 TPM_EK_BLOB_AUTH\r
+///\r
 typedef struct tdTPM_EK_BLOB_AUTH {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_SECRET                      authValue;\r
 } TPM_EK_BLOB_AUTH;\r
 \r
 \r
-//\r
-// Part 2, section 12.5 TPM_IDENTITY_CONTENTS\r
-//\r
+///\r
+/// Part 2, section 12.5 TPM_IDENTITY_CONTENTS\r
+///\r
 typedef struct tdTPM_IDENTITY_CONTENTS {\r
   TPM_STRUCT_VER                  ver;\r
   UINT32                          ordinal;\r
@@ -976,9 +977,9 @@ typedef struct tdTPM_IDENTITY_CONTENTS {
   TPM_PUBKEY                      identityPubKey;\r
 } TPM_IDENTITY_CONTENTS;\r
 \r
-//\r
-// Part 2, section 12.6 TPM_IDENTITY_REQ\r
-//\r
+///\r
+/// Part 2, section 12.6 TPM_IDENTITY_REQ\r
+///\r
 typedef struct tdTPM_IDENTITY_REQ {\r
   UINT32                          asymSize;\r
   UINT32                          symSize;\r
@@ -988,9 +989,9 @@ typedef struct tdTPM_IDENTITY_REQ {
   UINT8                           *symBlob;\r
 } TPM_IDENTITY_REQ;\r
 \r
-//\r
-// Part 2, section 12.7 TPM_IDENTITY_PROOF\r
-//\r
+///\r
+/// Part 2, section 12.7 TPM_IDENTITY_PROOF\r
+///\r
 typedef struct tdTPM_IDENTITY_PROOF {\r
   TPM_STRUCT_VER                  ver;\r
   UINT32                          labelSize;\r
@@ -1006,27 +1007,27 @@ typedef struct tdTPM_IDENTITY_PROOF {
   UINT8                           *conformanceCredential;\r
 } TPM_IDENTITY_PROOF;\r
 \r
-//\r
-// Part 2, section 12.8 TPM_ASYM_CA_CONTENTS\r
-//\r
+///\r
+/// Part 2, section 12.8 TPM_ASYM_CA_CONTENTS\r
+///\r
 typedef struct tdTPM_ASYM_CA_CONTENTS {\r
   TPM_SYMMETRIC_KEY               sessionKey;\r
   TPM_DIGEST                      idDigest;\r
 } TPM_ASYM_CA_CONTENTS;\r
 \r
-//\r
-// Part 2, section 12.9 TPM_SYM_CA_ATTESTATION\r
-//\r
+///\r
+/// Part 2, section 12.9 TPM_SYM_CA_ATTESTATION\r
+///\r
 typedef struct tdTPM_SYM_CA_ATTESTATION {\r
   UINT32                          credSize;\r
   TPM_KEY_PARMS                   algorithm;\r
   UINT8                           *credential;\r
 } TPM_SYM_CA_ATTESTATION;\r
 \r
-//\r
-// Part 2, section 15: Tick Structures\r
-//   Placed here out of order because definitions are used in section 13.\r
-//\r
+///\r
+/// Part 2, section 15: Tick Structures\r
+///   Placed here out of order because definitions are used in section 13.\r
+///\r
 typedef struct tdTPM_CURRENT_TICKS {\r
   TPM_STRUCTURE_TAG                 tag;\r
   UINT64                            currentTicks;\r
@@ -1034,13 +1035,13 @@ typedef struct tdTPM_CURRENT_TICKS {
   TPM_NONCE                         tickNonce;\r
 } TPM_CURRENT_TICKS;\r
 \r
-//\r
-// Part 2, section 13: Transport structures\r
-//\r
+///\r
+/// Part 2, section 13: Transport structures\r
+///\r
 \r
-//\r
-// Part 2, section 13.1: TPM _TRANSPORT_PUBLIC\r
-//\r
+///\r
+/// Part 2, section 13.1: TPM _TRANSPORT_PUBLIC\r
+///\r
 typedef struct tdTPM_TRANSPORT_PUBLIC {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_TRANSPORT_ATTRIBUTES        transAttributes;\r
@@ -1055,9 +1056,9 @@ typedef struct tdTPM_TRANSPORT_PUBLIC {
 #define TPM_TRANSPORT_LOG           ((UINT32)0x00000002)\r
 #define TPM_TRANSPORT_EXCLUSIVE     ((UINT32)0x00000004)\r
 \r
-//\r
-// Part 2, section 13.2 TPM_TRANSPORT_INTERNAL\r
-//\r
+///\r
+/// Part 2, section 13.2 TPM_TRANSPORT_INTERNAL\r
+///\r
 typedef struct tdTPM_TRANSPORT_INTERNAL {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_AUTHDATA                    authData;\r
@@ -1067,18 +1068,18 @@ typedef struct tdTPM_TRANSPORT_INTERNAL {
   TPM_DIGEST                      transDigest;\r
 } TPM_TRANSPORT_INTERNAL;\r
 \r
-//\r
-// Part 2, section 13.3 TPM_TRANSPORT_LOG_IN structure\r
-//\r
+///\r
+/// Part 2, section 13.3 TPM_TRANSPORT_LOG_IN structure\r
+///\r
 typedef struct tdTPM_TRANSPORT_LOG_IN {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DIGEST                      parameters;\r
   TPM_DIGEST                      pubKeyHash;\r
 } TPM_TRANSPORT_LOG_IN;\r
 \r
-//\r
-// Part 2, section 13.4 TPM_TRANSPORT_LOG_OUT structure\r
-//\r
+///\r
+/// Part 2, section 13.4 TPM_TRANSPORT_LOG_OUT structure\r
+///\r
 typedef struct tdTPM_TRANSPORT_LOG_OUT {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_CURRENT_TICKS               currentTicks;\r
@@ -1086,9 +1087,9 @@ typedef struct tdTPM_TRANSPORT_LOG_OUT {
   TPM_MODIFIER_INDICATOR          locality;\r
 } TPM_TRANSPORT_LOG_OUT;\r
 \r
-//\r
-// Part 2, section 13.5 TPM_TRANSPORT_AUTH structure\r
-//\r
+///\r
+/// Part 2, section 13.5 TPM_TRANSPORT_AUTH structure\r
+///\r
 typedef struct tdTPM_TRANSPORT_AUTH {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_AUTHDATA                    authData;\r
@@ -1098,18 +1099,18 @@ typedef struct tdTPM_TRANSPORT_AUTH {
 // Part 2, section 14: Audit Structures\r
 //\r
 \r
-//\r
-// Part 2, section 14.1 TPM_AUDIT_EVENT_IN structure\r
-//\r
+///\r
+/// Part 2, section 14.1 TPM_AUDIT_EVENT_IN structure\r
+///\r
 typedef struct tdTPM_AUDIT_EVENT_IN {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DIGEST                      inputParms;\r
   TPM_COUNTER_VALUE               auditCount;\r
 } TPM_AUDIT_EVENT_IN;\r
 \r
-//\r
-// Part 2, section 14.2 TPM_AUDIT_EVENT_OUT structure\r
-//\r
+///\r
+/// Part 2, section 14.2 TPM_AUDIT_EVENT_OUT structure\r
+///\r
 typedef struct tdTPM_AUDIT_EVENT_OUT {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_COMMAND_CODE                ordinal;\r
@@ -1388,9 +1389,9 @@ typedef struct tdTPM_AUDIT_EVENT_OUT {
 // Part 2, section 18: Context structures\r
 //\r
 \r
-//\r
-// Part 2, section 18.1: TPM_CONTEXT_BLOB\r
-//\r
+///\r
+/// Part 2, section 18.1: TPM_CONTEXT_BLOB\r
+///\r
 typedef struct tdTPM_CONTEXT_BLOB {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_RESOURCE_TYPE               resourceType;\r
@@ -1404,9 +1405,9 @@ typedef struct tdTPM_CONTEXT_BLOB {
   UINT8                           *sensitiveData;\r
 } TPM_CONTEXT_BLOB;\r
 \r
-//\r
-// Part 2, section 18.2 TPM_CONTEXT_SENSITIVE\r
-//\r
+///\r
+/// Part 2, section 18.2 TPM_CONTEXT_SENSITIVE\r
+///\r
 typedef struct tdTPM_CONTEXT_SENSITIVE {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_NONCE                       contextNonce;\r
@@ -1438,15 +1439,20 @@ typedef struct tdTPM_CONTEXT_SENSITIVE {
 #define TPM_NV_INDEX_PERIPHERAL_BASE   ((UINT32)0x00011500)\r
 #define TPM_NV_INDEX_GROUP_RESV_BASE   ((UINT32)0x00010000)\r
 \r
-//\r
-// The typedefs TPM_NV_PER_ATTRIBUTES (not present in TPM 1.2 Spec. have been added \r
-// and structure fields that were to hold the following values\r
-//\r
+///\r
+/// The typedefs TPM_NV_PER_ATTRIBUTES (not present in TPM 1.2 Spec. have been added \r
+/// and structure fields that were to hold the following values\r
+///\r
 typedef UINT32 TPM_NV_PER_ATTRIBUTES;\r
 \r
-//\r
-// Part 2, section 19.2: TPM_NV_ATTRIBUTES\r
-//\r
+///\r
+/// Part 2, section 19.2: TPM_NV_ATTRIBUTES\r
+///\r
+typedef struct tdTPM_NV_ATTRIBUTES {\r
+  TPM_STRUCTURE_TAG               tag;\r
+  TPM_NV_PER_ATTRIBUTES           attributes;\r
+} TPM_NV_ATTRIBUTES;\r
+\r
 #define TPM_NV_PER_READ_STCLEAR        (BIT31)\r
 #define TPM_NV_PER_AUTHREAD            (BIT18)\r
 #define TPM_NV_PER_OWNERREAD           (BIT17)\r
@@ -1459,14 +1465,9 @@ typedef UINT32 TPM_NV_PER_ATTRIBUTES;
 #define TPM_NV_PER_OWNERWRITE          (BIT1)\r
 #define TPM_NV_PER_PPWRITE             (BIT0)\r
 \r
-typedef struct tdTPM_NV_ATTRIBUTES {\r
-  TPM_STRUCTURE_TAG               tag;\r
-  TPM_NV_PER_ATTRIBUTES           attributes;\r
-} TPM_NV_ATTRIBUTES;\r
-\r
-//\r
-// Part 2, section 19.3: TPM_NV_DATA_PUBLIC\r
-//\r
+///\r
+/// Part 2, section 19.3: TPM_NV_DATA_PUBLIC\r
+///\r
 typedef struct tdTPM_NV_DATA_PUBLIC {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_NV_INDEX                    nvIndex;\r
@@ -1567,16 +1568,16 @@ typedef struct tdTPM_DELEGATIONS {
 #define TPM_DELEGATE_ADMIN_LOCK           (BIT1)\r
 #define TPM_FAMFLAG_ENABLE                (BIT0)\r
 \r
-//\r
-// Part 2, section 20.4: TPM_FAMILY_LABEL\r
-//\r
+///\r
+/// Part 2, section 20.4: TPM_FAMILY_LABEL\r
+///\r
 typedef struct tdTPM_FAMILY_LABEL {\r
   UINT8                           label;\r
 } TPM_FAMILY_LABEL;\r
 \r
-//\r
-// Part 2, section 20.5: TPM_FAMILY_TABLE_ENTRY\r
-//\r
+///\r
+/// Part 2, section 20.5: TPM_FAMILY_TABLE_ENTRY\r
+///\r
 typedef struct tdTPM_FAMILY_TABLE_ENTRY {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_FAMILY_LABEL                label;\r
@@ -1594,16 +1595,16 @@ typedef struct tdTPM_FAMILY_TABLE{
   TPM_FAMILY_TABLE_ENTRY famTableRow[TPM_NUM_FAMILY_TABLE_ENTRY_MIN];\r
 } TPM_FAMILY_TABLE;\r
 \r
-//\r
-// Part 2, section 20.7: TPM_DELEGATE_LABEL\r
-//\r
+///\r
+/// Part 2, section 20.7: TPM_DELEGATE_LABEL\r
+///\r
 typedef struct tdTPM_DELEGATE_LABEL {\r
   UINT8                           label;\r
 } TPM_DELEGATE_LABEL;\r
 \r
-//\r
-// Part 2, section 20.8: TPM_DELEGATE_PUBLIC\r
-//\r
+///\r
+/// Part 2, section 20.8: TPM_DELEGATE_PUBLIC\r
+///\r
 typedef struct tdTPM_DELEGATE_PUBLIC {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DELEGATE_LABEL              label;\r
@@ -1613,9 +1614,9 @@ typedef struct tdTPM_DELEGATE_PUBLIC {
   TPM_FAMILY_VERIFICATION         verificationCount;\r
 } TPM_DELEGATE_PUBLIC;\r
 \r
-//\r
-// Part 2, section 20.9: TPM_DELEGATE_TABLE_ROW\r
-//\r
+///\r
+/// Part 2, section 20.9: TPM_DELEGATE_TABLE_ROW\r
+///\r
 typedef struct tdTPM_DELEGATE_TABLE_ROW {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DELEGATE_PUBLIC             pub;\r
@@ -1631,17 +1632,17 @@ typedef struct tdTPM_DELEGATE_TABLE{
   TPM_DELEGATE_TABLE_ROW delRow[TPM_NUM_DELEGATE_TABLE_ENTRY_MIN];\r
 } TPM_DELEGATE_TABLE;\r
 \r
-//\r
-// Part 2, section 20.11: TPM_DELEGATE_SENSITIVE\r
-//\r
+///\r
+/// Part 2, section 20.11: TPM_DELEGATE_SENSITIVE\r
+///\r
 typedef struct tdTPM_DELEGATE_SENSITIVE {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_SECRET                      authValue;\r
 } TPM_DELEGATE_SENSITIVE;\r
 \r
-//\r
-// Part 2, section 20.12: TPM_DELEGATE_OWNER_BLOB\r
-//\r
+///\r
+/// Part 2, section 20.12: TPM_DELEGATE_OWNER_BLOB\r
+///\r
 typedef struct tdTPM_DELEGATE_OWNER_BLOB {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DELEGATE_PUBLIC             pub;\r
@@ -1652,9 +1653,9 @@ typedef struct tdTPM_DELEGATE_OWNER_BLOB {
   UINT8                           *sensitiveArea;\r
 } TPM_DELEGATE_OWNER_BLOB;\r
 \r
-//\r
-// Part 2, section 20.13: TTPM_DELEGATE_KEY_BLOB\r
-//\r
+///\r
+/// Part 2, section 20.13: TTPM_DELEGATE_KEY_BLOB\r
+///\r
 typedef struct tdTPM_DELEGATE_KEY_BLOB {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DELEGATE_PUBLIC             pub;\r
@@ -1734,10 +1735,10 @@ typedef struct tdTPM_DELEGATE_KEY_BLOB {
 #define TPM_CAP_PROP_MAX_NV_AVAILABLE   ((TPM_CAPABILITY_AREA) 0x00000123)\r
 #define TPM_CAP_PROP_INPUT_BUFFER       ((TPM_CAPABILITY_AREA) 0x00000124)\r
 \r
-//\r
-// Part 2, section 21.6: TPM_CAP_VERSION_INFO\r
-//   [size_is(vendorSpecificSize)] BYTE* vendorSpecific;\r
-//\r
+///\r
+/// Part 2, section 21.6: TPM_CAP_VERSION_INFO\r
+///   [size_is(vendorSpecificSize)] BYTE* vendorSpecific;\r
+///\r
 typedef struct tdTPM_CAP_VERSION_INFO {\r
   TPM_STRUCTURE_TAG                 tag;\r
   TPM_VERSION                       version;\r
@@ -1772,9 +1773,9 @@ typedef struct tdTPM_CAP_VERSION_INFO {
 #define TPM_DAA_power0                 (104)\r
 #define TPM_DAA_power1                 (1024)\r
 \r
-//\r
-// Part 2, section 22.3: TPM_DAA_ISSUER\r
-//\r
+///\r
+/// Part 2, section 22.3: TPM_DAA_ISSUER\r
+///\r
 typedef struct tdTPM_DAA_ISSUER {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DIGEST                      DAA_digest_R0;\r
@@ -1786,9 +1787,9 @@ typedef struct tdTPM_DAA_ISSUER {
   UINT8                           DAA_generic_q[26];\r
 } TPM_DAA_ISSUER;\r
 \r
-//\r
-// Part 2, section 22.4: TPM_DAA_TPM\r
-//\r
+///\r
+/// Part 2, section 22.4: TPM_DAA_TPM\r
+///\r
 typedef struct tdTPM_DAA_TPM {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DIGEST                      DAA_digestIssuer;\r
@@ -1798,9 +1799,9 @@ typedef struct tdTPM_DAA_TPM {
   UINT32                          DAA_count;\r
 } TPM_DAA_TPM;\r
 \r
-//\r
-// Part 2, section 22.5: TPM_DAA_CONTEXT\r
-//\r
+///\r
+/// Part 2, section 22.5: TPM_DAA_CONTEXT\r
+///\r
 typedef struct tdTPM_DAA_CONTEXT {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_DIGEST                      DAA_digestContext;\r
@@ -1810,18 +1811,18 @@ typedef struct tdTPM_DAA_CONTEXT {
   UINT8                           DAA_stage;\r
 } TPM_DAA_CONTEXT;\r
 \r
-//\r
-// Part 2, section 22.6: TPM_DAA_JOINDATA\r
-//\r
+///\r
+/// Part 2, section 22.6: TPM_DAA_JOINDATA\r
+///\r
 typedef struct tdTPM_DAA_JOINDATA {\r
   UINT8                           DAA_join_u0[128];\r
   UINT8                           DAA_join_u1[138];\r
   TPM_DIGEST                      DAA_digest_n0;\r
 } TPM_DAA_JOINDATA;\r
 \r
-//\r
-// Part 2, section 22.8: TPM_DAA_BLOB\r
-//\r
+///\r
+/// Part 2, section 22.8: TPM_DAA_BLOB\r
+///\r
 typedef struct tdTPM_DAA_BLOB {\r
   TPM_STRUCTURE_TAG               tag;\r
   TPM_RESOURCE_TYPE               resourceType;\r
@@ -1833,9 +1834,9 @@ typedef struct tdTPM_DAA_BLOB {
   UINT8                           *sensitiveData;\r
 } TPM_DAA_BLOB;\r
 \r
-//\r
-// Part 2, section 22.9: TPM_DAA_SENSITIVE\r
-//\r
+///\r
+/// Part 2, section 22.9: TPM_DAA_SENSITIVE\r
+///\r
 typedef struct tdTPM_DAA_SENSITIVE {\r
   TPM_STRUCTURE_TAG               tag;\r
   UINT32                          internalSize;\r
@@ -1847,18 +1848,18 @@ typedef struct tdTPM_DAA_SENSITIVE {
 // Part 2, section 23: Redirection\r
 //\r
 \r
-//\r
-// Part 2 section 23.1: TPM_REDIR_COMMAND\r
-// This section defines exactly one value but does not\r
-// give it a name. The definition of TPM_SetRedirection in Part3\r
-// refers to exactly one name but does not give its value. We join\r
-// them here.\r
-//\r
+///\r
+/// Part 2 section 23.1: TPM_REDIR_COMMAND\r
+/// This section defines exactly one value but does not\r
+/// give it a name. The definition of TPM_SetRedirection in Part3\r
+/// refers to exactly one name but does not give its value. We join\r
+/// them here.\r
+///\r
 #define TPM_REDIR_GPIO              (0x00000001)\r
 \r
-//\r
-// TPM Command & Response Headers defined in Part 3\r
-//\r
+///\r
+/// TPM Command & Response Headers defined in Part 3\r
+///\r
 typedef struct tdTPM_RQU_COMMAND_HDR {\r
   TPM_STRUCTURE_TAG                 tag;\r
   UINT32                            paramSize;\r

diff --git a/MdePkg/Include/IndustryStandard/Usb.h b/MdePkg/Include/IndustryStandard/Usb.h
index ec86d8b794034439f33f6ac1382975083842b321..142b794167e43034d9363ca6277b594b48c3d2c9 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Usb.h
+++ b/MdePkg/Include/IndustryStandard/Usb.h
@@ -334,6 +334,7 @@ typedef enum {
 #pragma pack(1)\r
 ///\r
 /// Descriptor header for Report/Physical Descriptors\r
+/// HID 1.1, section 6.2.1\r
 ///\r
 typedef struct hid_class_descriptor {\r
   UINT8   DescriptorType;\r
@@ -343,6 +344,7 @@ typedef struct hid_class_descriptor {
 ///\r
 /// The HID descriptor identifies the length and type\r
 /// of subordinate descriptors for a device.\r
+/// HID 1.1, section 6.2.1\r
 ///\r
 typedef struct hid_descriptor {\r
   UINT8                         Length;\r

diff --git a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
index f2026ecd874e78b5ff21e98d4b772ae3381e6d19..ab67c3fd92da070a122514635ec219c08b10550c 100644 (file)
--- a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
+++ b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
@@ -1,6 +1,6 @@
 /** @file   \r
   ACPI Watchdog Action Table (WADT) as defined at\r
-  Microsoft Hardware Watchdog Timers Design Specification\r
+  Microsoft Hardware Watchdog Timers Design Specification.\r
 \r
   Copyright (c) 2008, Intel Corporation\r
   All rights reserved. This program and the accompanying materials                          \r