]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Add the detailed descriptions for the structure data member in these protocol.
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 9 Dec 2008 14:04:41 +0000 (14:04 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 9 Dec 2008 14:04:41 +0000 (14:04 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6935 6f19259b-4bc3-4df7-8a09-765794883524

30 files changed:
MdePkg/Include/Guid/DebugImageInfoTable.h
MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h
MdePkg/Include/IndustryStandard/Pal.h
MdePkg/Include/IndustryStandard/SmBus.h
MdePkg/Include/Ppi/Smbus2.h
MdePkg/Include/Protocol/DebugSupport.h
MdePkg/Include/Protocol/DevicePath.h
MdePkg/Include/Protocol/FirmwareVolume2.h
MdePkg/Include/Protocol/HiiFont.h
MdePkg/Include/Protocol/HiiImage.h
MdePkg/Include/Protocol/Ip4.h
MdePkg/Include/Protocol/Ip4Config.h
MdePkg/Include/Protocol/ManagedNetwork.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/PciIo.h
MdePkg/Include/Protocol/PciRootBridgeIo.h
MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
MdePkg/Include/Protocol/ScsiIo.h
MdePkg/Include/Protocol/ScsiPassThru.h
MdePkg/Include/Protocol/ScsiPassThruExt.h
MdePkg/Include/Protocol/SimpleFileSystem.h
MdePkg/Include/Protocol/SimpleNetwork.h
MdePkg/Include/Protocol/SimplePointer.h
MdePkg/Include/Protocol/SimpleTextIn.h
MdePkg/Include/Protocol/SimpleTextInEx.h
MdePkg/Include/Protocol/SmbusHc.h
MdePkg/Include/Protocol/TcgService.h
MdePkg/Include/Protocol/Usb2HostController.h
MdePkg/Include/Protocol/UsbIo.h
MdePkg/Include/Uefi/UefiTcgPlatform.h

index 4404ace03b9e9b68998238163de438ad808a5293..19003f958a77f4c1de844e5caf2e4235b8cd3d27 100644 (file)
@@ -34,9 +34,9 @@
 #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL        0x01\r
 \r
 typedef struct {\r
 #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL        0x01\r
 \r
 typedef struct {\r
-  UINT64                Signature;          /// A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE\r
-  EFI_PHYSICAL_ADDRESS  EfiSystemTableBase; /// The physical address of the EFI system table. \r
-  UINT32                Crc32;              /// A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid.\r
+  UINT64                Signature;          ///< A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE\r
+  EFI_PHYSICAL_ADDRESS  EfiSystemTableBase; ///< The physical address of the EFI system table. \r
+  UINT32                Crc32;              ///< A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid.\r
 } EFI_SYSTEM_TABLE_POINTER;\r
 \r
 typedef struct {\r
 } EFI_SYSTEM_TABLE_POINTER;\r
 \r
 typedef struct {\r
index b9c2d4d4a52de7e52ac01e308e1041f63e7280a2..20f798328d107fa4f8a4b2a5cac4d170361cfab9 100644 (file)
 #ifndef __FILE_SYSTEM_VOLUME_LABEL_INFO_H__\r
 #define __FILE_SYSTEM_VOLUME_LABEL_INFO_H__\r
 \r
 #ifndef __FILE_SYSTEM_VOLUME_LABEL_INFO_H__\r
 #define __FILE_SYSTEM_VOLUME_LABEL_INFO_H__\r
 \r
-#define EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID_GUID \\r
+#define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \\r
   { \\r
     0xDB47D7D3, 0xFE81, 0x11d3, {0x9A, 0x35, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \\r
   }\r
 \r
   { \\r
     0xDB47D7D3, 0xFE81, 0x11d3, {0x9A, 0x35, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \\r
   }\r
 \r
-#define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \\r
-        EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID_GUID\r
-\r
 typedef struct {\r
   ///\r
   /// The Null-terminated string that is the volume's label.\r
   ///\r
   CHAR16  VolumeLabel[1];\r
 typedef struct {\r
   ///\r
   /// The Null-terminated string that is the volume's label.\r
   ///\r
   CHAR16  VolumeLabel[1];\r
-} EFI_FILE_SYSTEM_VOLUME_LABEL_INFO;\r
-\r
-typedef EFI_FILE_SYSTEM_VOLUME_LABEL_INFO EFI_FILE_SYSTEM_VOLUME_LABEL;\r
+} EFI_FILE_SYSTEM_VOLUME_LABEL;\r
 \r
 \r
-#define SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO \\r
-        EFI_FIELD_OFFSET (EFI_FILE_SYSTEM_VOLUME_LABEL_INFO, VolumeLabel)\r
+#define SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL \\r
+        EFI_FIELD_OFFSET (EFI_FILE_SYSTEM_VOLUME_LABEL, VolumeLabel)\r
 \r
 extern EFI_GUID gEfiFileSystemVolumeLabelInfoIdGuid;\r
 \r
 \r
 extern EFI_GUID gEfiFileSystemVolumeLabelInfoIdGuid;\r
 \r
index b726201f9c06d377aada8a20dc286ab0236cb49f..e377587759688458bcf59a9849814806fbfb8e4b 100644 (file)
@@ -287,25 +287,25 @@ typedef struct {
 #define PAL_CACHE_PROT_INFO     38\r
 \r
 typedef struct {\r
 #define PAL_CACHE_PROT_INFO     38\r
 \r
 typedef struct {\r
-  UINT64  ThreadId : 16;    /// The thread identifier of the logical\r
-                            /// processor for which information is being\r
-                            /// returned. This value will be unique on a per core basis.\r
+  UINT64  ThreadId : 16;    ///< The thread identifier of the logical\r
+                            ///< processor for which information is being\r
+                            ///< returned. This value will be unique on a per core basis.\r
   UINT64  Reserved1: 16;\r
   UINT64  Reserved1: 16;\r
-  UINT64  CoreId: 16;       /// The core identifier of the logical processor\r
-                            /// for which information is being returned.\r
-                            /// This value will be unique on a per physical\r
-                            /// processor package basis.\r
+  UINT64  CoreId: 16;       ///< The core identifier of the logical processor\r
+                            ///< for which information is being returned.\r
+                            ///< This value will be unique on a per physical\r
+                            ///< processor package basis.\r
   UINT64  Reserved2: 16;\r
 } PAL_PCOC_N_CACHE_INFO1;\r
 \r
 \r
 typedef struct {\r
   UINT64  Reserved2: 16;\r
 } PAL_PCOC_N_CACHE_INFO1;\r
 \r
 \r
 typedef struct {\r
-  UINT64  LogicalAddress : 16;  /// Logical address: geographical address\r
-                                /// of the logical processor for which\r
-                                /// information is being returned. This is\r
-                                /// the same value that is returned by the\r
-                                /// PAL_FIXED_ADDR procedure when it is\r
-                                /// called on the logical processor.\r
+  UINT64  LogicalAddress : 16;  ///< Logical address: geographical address\r
+                                ///< of the logical processor for which\r
+                                ///< information is being returned. This is\r
+                                ///< the same value that is returned by the\r
+                                ///< PAL_FIXED_ADDR procedure when it is\r
+                                ///< called on the logical processor.\r
   UINT64  Reserved1: 16;\r
   UINT64  Reserved2: 32;\r
 } PAL_PCOC_N_CACHE_INFO2;\r
   UINT64  Reserved1: 16;\r
   UINT64  Reserved2: 32;\r
 } PAL_PCOC_N_CACHE_INFO2;\r
@@ -481,26 +481,26 @@ typedef struct {
 #define PAL_PTCE_INFO     6\r
 \r
 typedef struct {\r
 #define PAL_PTCE_INFO     6\r
 \r
 typedef struct {\r
-  UINT64  NumberSets:8;             /// Unsigned 8-bit integer denoting the number\r
-                                    /// of hash sets for the specified level\r
-                                    /// (1=fully associative)\r
-  UINT64  NumberWays:8;             /// Unsigned 8-bit integer denoting the\r
-                                    /// associativity of the specified level\r
-                                    /// (1=direct).\r
-  UINT64  NumberEntries:16;         /// Unsigned 16-bit integer denoting the\r
-                                    /// number of entries in the specified TC.\r
-  UINT64  PageSizeIsOptimized:1;    /// Flag denoting whether the\r
-                                    /// specified level is optimized for\r
-                                    /// the region's preferred page size\r
-                                    /// (1=optimized) tc_pages indicates\r
-                                    /// which page sizes are usable by\r
-                                    /// this translation cache.\r
-  UINT64  TcIsUnified:1;            /// Flag denoting whether the specified TC is\r
-                                    /// unified (1=unified).\r
-  UINT64  EntriesReduction:1;       /// Flag denoting whether installed\r
-                                    /// translation registers will reduce\r
-                                    /// the number of entries within the\r
-                                    /// specified TC.\r
+  UINT64  NumberSets:8;             ///< Unsigned 8-bit integer denoting the number\r
+                                    ///< of hash sets for the specified level\r
+                                    ///< (1=fully associative)\r
+  UINT64  NumberWays:8;             ///< Unsigned 8-bit integer denoting the\r
+                                    ///< associativity of the specified level\r
+                                    ///< (1=direct).\r
+  UINT64  NumberEntries:16;         ///< Unsigned 16-bit integer denoting the\r
+                                    ///< number of entries in the specified TC.\r
+  UINT64  PageSizeIsOptimized:1;    ///< Flag denoting whether the\r
+                                    ///< specified level is optimized for\r
+                                    ///< the region's preferred page size\r
+                                    ///< (1=optimized) tc_pages indicates\r
+                                    ///< which page sizes are usable by\r
+                                    ///< this translation cache.\r
+  UINT64  TcIsUnified:1;            ///< Flag denoting whether the specified TC is\r
+                                    ///< unified (1=unified).\r
+  UINT64  EntriesReduction:1;       ///< Flag denoting whether installed\r
+                                    ///< translation registers will reduce\r
+                                    ///< the number of entries within the\r
+                                    ///< specified TC.\r
 } PAL_TC_INFO;\r
 \r
 /**\r
 } PAL_TC_INFO;\r
 \r
 /**\r
@@ -564,48 +564,48 @@ typedef struct {
 #define PAL_VM_PAGE_SIZE 34\r
 \r
 typedef struct {\r
 #define PAL_VM_PAGE_SIZE 34\r
 \r
 typedef struct {\r
-  UINT64  WalkerPresent:1;              /// 1-bit flag indicating whether a hardware\r
-                                        /// TLB walker is implemented (1 = walker\r
-                                        /// present).\r
-  UINT64  WidthOfPhysicalAddress: 7;    /// Unsigned 7-bit integer\r
-                                        /// denoting the number of bits of\r
-                                        /// physical address implemented.\r
-  UINT64  WidthOfKey:8;                 /// Unsigned 8-bit integer denoting the number\r
-                                        /// of bits mplemented in the PKR.key field.\r
-  UINT64  MaxPkrIndex:8;                /// Unsigned 8-bit integer denoting the\r
-                                        /// maximum PKR index (number of PKRs-1).\r
-  UINT64  HashTagId:8;                  /// Unsigned 8-bit integer which uniquely\r
-                                        /// identifies the processor hash and tag\r
-                                        /// algorithm.\r
-  UINT64  MaxDtrIndex:8;                /// Unsigned 8 bit integer denoting the\r
-                                        /// maximum data translation register index\r
-                                        /// (number of dtr entries - 1).\r
-  UINT64  MaxItrIndex:8;                /// Unsigned 8 bit integer denoting the\r
-                                        /// maximum instruction translation register\r
-                                        /// index (number of itr entries - 1).\r
-  UINT64  NumberOfUniqueTc:8;           /// Unsigned 8-bit integer denoting the\r
-                                        /// number of unique TCs implemented.\r
-                                        /// This is a maximum of\r
-                                        /// 2*num_tc_levels.\r
-  UINT64  NumberOfTcLevels:8;           /// Unsigned 8-bit integer denoting the\r
-                                        /// number of TC levels.\r
+  UINT64  WalkerPresent:1;              ///< 1-bit flag indicating whether a hardware\r
+                                        ///< TLB walker is implemented (1 = walker\r
+                                        ///< present).\r
+  UINT64  WidthOfPhysicalAddress: 7;    ///< Unsigned 7-bit integer\r
+                                        ///< denoting the number of bits of\r
+                                        ///< physical address implemented.\r
+  UINT64  WidthOfKey:8;                 ///< Unsigned 8-bit integer denoting the number\r
+                                        ///< of bits mplemented in the PKR.key field.\r
+  UINT64  MaxPkrIndex:8;                ///< Unsigned 8-bit integer denoting the\r
+                                        ///< maximum PKR index (number of PKRs-1).\r
+  UINT64  HashTagId:8;                  ///< Unsigned 8-bit integer which uniquely\r
+                                        ///< identifies the processor hash and tag\r
+                                        ///< algorithm.\r
+  UINT64  MaxDtrIndex:8;                ///< Unsigned 8 bit integer denoting the\r
+                                        ///< maximum data translation register index\r
+                                        ///< (number of dtr entries - 1).\r
+  UINT64  MaxItrIndex:8;                ///< Unsigned 8 bit integer denoting the\r
+                                        ///< maximum instruction translation register\r
+                                        ///< index (number of itr entries - 1).\r
+  UINT64  NumberOfUniqueTc:8;           ///< Unsigned 8-bit integer denoting the\r
+                                        ///< number of unique TCs implemented.\r
+                                        ///< This is a maximum of\r
+                                        ///< 2*num_tc_levels.\r
+  UINT64  NumberOfTcLevels:8;           ///< Unsigned 8-bit integer denoting the\r
+                                        ///< number of TC levels.\r
 } PAL_VM_INFO1;\r
 \r
 typedef struct {\r
 } PAL_VM_INFO1;\r
 \r
 typedef struct {\r
-  UINT64  WidthOfVirtualAddress:8;  /// Unsigned 8-bit integer denoting\r
-                                    /// is the total number of virtual\r
-                                    /// address bits - 1.\r
-  UINT64  WidthOfRid:8;             /// Unsigned 8-bit integer denoting the number\r
-                                    /// of bits implemented in the RR.rid field.\r
-  UINT64  MaxPurgedTlbs:16;         /// Unsigned 16 bit integer denoting the\r
-                                    /// maximum number of concurrent outstanding\r
-                                    /// TLB purges allowed by the processor. A\r
-                                    /// value of 0 indicates one outstanding\r
-                                    /// purge allowed. A value of 216-1\r
-                                    /// indicates no limit on outstanding\r
-                                    /// purges. All other values indicate the\r
-                                    /// actual number of concurrent outstanding\r
-                                    /// purges allowed.\r
+  UINT64  WidthOfVirtualAddress:8;  ///< Unsigned 8-bit integer denoting\r
+                                    ///< is the total number of virtual\r
+                                    ///< address bits - 1.\r
+  UINT64  WidthOfRid:8;             ///< Unsigned 8-bit integer denoting the number\r
+                                    ///< of bits implemented in the RR.rid field.\r
+  UINT64  MaxPurgedTlbs:16;         ///< Unsigned 16 bit integer denoting the\r
+                                    ///< maximum number of concurrent outstanding\r
+                                    ///< TLB purges allowed by the processor. A\r
+                                    ///< value of 0 indicates one outstanding\r
+                                    ///< purge allowed. A value of 216-1\r
+                                    ///< indicates no limit on outstanding\r
+                                    ///< purges. All other values indicate the\r
+                                    ///< actual number of concurrent outstanding\r
+                                    ///< purges allowed.\r
   UINT64  Reserved:32;\r
 } PAL_VM_INFO2;\r
 \r
   UINT64  Reserved:32;\r
 } PAL_VM_INFO2;\r
 \r
@@ -985,46 +985,46 @@ typedef struct {
 #define PAL_FREQ_RATIOS 14\r
 \r
 typedef struct {\r
 #define PAL_FREQ_RATIOS 14\r
 \r
 typedef struct {\r
-  UINT64  NumberOfLogicalProcessors:16;     /// Total number of logical\r
-                                            /// processors on this physical\r
-                                            /// processor package that are\r
-                                            /// enabled.\r
-  UINT64  ThreadsPerCore:8;                 /// Number of threads per core.\r
+  UINT64  NumberOfLogicalProcessors:16;     ///< Total number of logical\r
+                                            ///< processors on this physical\r
+                                            ///< processor package that are\r
+                                            ///< enabled.\r
+  UINT64  ThreadsPerCore:8;                 ///< Number of threads per core.\r
   UINT64  Reserved1:8;\r
   UINT64  Reserved1:8;\r
-  UINT64  CoresPerProcessor;                /// Total number of cores on this\r
-                                            /// physical processor package.\r
+  UINT64  CoresPerProcessor;                ///< Total number of cores on this\r
+                                            ///< physical processor package.\r
   UINT64  Reserved2:8;\r
   UINT64  Reserved2:8;\r
-  UINT64  PhysicalProcessorPackageId:8;     /// Physical processor package\r
-                                            /// identifier which was\r
-                                            /// assigned at reset by the\r
-                                            /// platform or bus\r
-                                            /// controller. This value may\r
-                                            /// or may not be unique\r
-                                            /// across the entire platform\r
-                                            /// since it depends on the\r
-                                            /// platform vendor's policy.\r
+  UINT64  PhysicalProcessorPackageId:8;     ///< Physical processor package\r
+                                            ///< identifier which was\r
+                                            ///< assigned at reset by the\r
+                                            ///< platform or bus\r
+                                            ///< controller. This value may\r
+                                            ///< or may not be unique\r
+                                            ///< across the entire platform\r
+                                            ///< since it depends on the\r
+                                            ///< platform vendor's policy.\r
   UINT64  Reserved3:8;\r
 } PAL_LOGICAL_PROCESSPR_OVERVIEW;\r
 \r
 typedef struct {\r
   UINT64  Reserved3:8;\r
 } PAL_LOGICAL_PROCESSPR_OVERVIEW;\r
 \r
 typedef struct {\r
-   UINT64 ThreadId:16;      /// The thread identifier of the logical\r
-                            /// processor for which information is being\r
-                            /// returned. This value will be unique on a per\r
-                            /// core basis.\r
+   UINT64 ThreadId:16;      ///< The thread identifier of the logical\r
+                            ///< processor for which information is being\r
+                            ///< returned. This value will be unique on a per\r
+                            ///< core basis.\r
    UINT64 Reserved1:16;\r
    UINT64 Reserved1:16;\r
-   UINT64 CoreId:16;        /// The core identifier of the logical processor\r
-                            /// for which information is being returned.\r
-                            /// This value will be unique on a per physical\r
-                            /// processor package basis.\r
+   UINT64 CoreId:16;        ///< The core identifier of the logical processor\r
+                            ///< for which information is being returned.\r
+                            ///< This value will be unique on a per physical\r
+                            ///< processor package basis.\r
    UINT64 Reserved2:16;\r
 } PAL_LOGICAL_PROCESSORN_INFO1;\r
 \r
 typedef struct {\r
    UINT64 Reserved2:16;\r
 } PAL_LOGICAL_PROCESSORN_INFO1;\r
 \r
 typedef struct {\r
-   UINT64 LogicalAddress:16;    /// Geographical address of the logical\r
-                                /// processor for which information is being\r
-                                /// returned. This is the same value that is\r
-                                /// returned by the PAL_FIXED_ADDR procedure\r
-                                /// when it is called on the logical processor.\r
+   UINT64 LogicalAddress:16;    ///< Geographical address of the logical\r
+                                ///< processor for which information is being\r
+                                ///< returned. This is the same value that is\r
+                                ///< returned by the PAL_FIXED_ADDR procedure\r
+                                ///< when it is called on the logical processor.\r
    UINT64 Reserved:48;\r
 } PAL_LOGICAL_PROCESSORN_INFO2;\r
 \r
    UINT64 Reserved:48;\r
 } PAL_LOGICAL_PROCESSORN_INFO2;\r
 \r
@@ -1063,17 +1063,17 @@ typedef struct {
 #define PAL_LOGICAL_TO_PHYSICAL 42\r
 \r
 typedef struct {\r
 #define PAL_LOGICAL_TO_PHYSICAL 42\r
 \r
 typedef struct {\r
-  UINT64  NumberOfPmcPairs:8;               /// Unsigned 8-bit number defining the\r
-                                            /// number of generic PMC/PMD pairs.\r
-  UINT64  WidthOfCounter:8;                 /// Unsigned 8-bit number in the range\r
-                                            /// 0:60 defining the number of\r
-                                            /// implemented counter bits.\r
-  UINT64  TypeOfCycleCounting:8;            /// Unsigned 8-bit number defining the\r
-                                            /// event type for counting processor cycles.\r
-  UINT64  TypeOfRetiredInstructionBundle:8; /// Retired Unsigned 8-bit\r
-                                            /// number defining the\r
-                                            /// event type for retired\r
-                                            /// instruction bundles.\r
+  UINT64  NumberOfPmcPairs:8;               ///< Unsigned 8-bit number defining the\r
+                                            ///< number of generic PMC/PMD pairs.\r
+  UINT64  WidthOfCounter:8;                 ///< Unsigned 8-bit number in the range\r
+                                            ///< 0:60 defining the number of\r
+                                            ///< implemented counter bits.\r
+  UINT64  TypeOfCycleCounting:8;            ///< Unsigned 8-bit number defining the\r
+                                            ///< event type for counting processor cycles.\r
+  UINT64  TypeOfRetiredInstructionBundle:8; ///< Retired Unsigned 8-bit\r
+                                            ///< number defining the\r
+                                            ///< event type for retired\r
+                                            ///< instruction bundles.\r
   UINT64  Reserved:32;\r
 } PAL_PERFORMANCE_INFO;\r
 \r
   UINT64  Reserved:32;\r
 } PAL_PERFORMANCE_INFO;\r
 \r
@@ -1134,314 +1134,314 @@ typedef struct {
 \r
 typedef struct {\r
   UINT64  Reserved1:36;\r
 \r
 typedef struct {\r
   UINT64  Reserved1:36;\r
-  UINT64  FaultInUndefinedIns:1;                /// Bit36, No Unimplemented\r
-                                                /// instruction address reported as\r
-                                                /// fault. Denotes how the processor\r
-                                                /// reports the detection of\r
-                                                /// unimplemented instruction\r
-                                                /// addresses. When 1, the processor\r
-                                                /// reports an Unimplemented\r
-                                                /// Instruction Address fault on the\r
-                                                /// unimplemented address; when 0, it\r
-                                                /// reports an Unimplemented\r
-                                                /// Instruction Address trap on the\r
-                                                /// previous instruction in program\r
-                                                /// order. This feature may only be\r
-                                                /// interrogated by\r
-                                                /// PAL_PROC_GET_FEATURES. It may not\r
-                                                /// be enabled or disabled by\r
-                                                /// PAL_PROC_SET_FEATURES. The\r
-                                                /// corresponding argument is ignored.\r
+  UINT64  FaultInUndefinedIns:1;                ///< Bit36, No Unimplemented\r
+                                                ///< instruction address reported as\r
+                                                ///< fault. Denotes how the processor\r
+                                                ///< reports the detection of\r
+                                                ///< unimplemented instruction\r
+                                                ///< addresses. When 1, the processor\r
+                                                ///< reports an Unimplemented\r
+                                                ///< Instruction Address fault on the\r
+                                                ///< unimplemented address; when 0, it\r
+                                                ///< reports an Unimplemented\r
+                                                ///< Instruction Address trap on the\r
+                                                ///< previous instruction in program\r
+                                                ///< order. This feature may only be\r
+                                                ///< interrogated by\r
+                                                ///< PAL_PROC_GET_FEATURES. It may not\r
+                                                ///< be enabled or disabled by\r
+                                                ///< PAL_PROC_SET_FEATURES. The\r
+                                                ///< corresponding argument is ignored.\r
                                                 \r
                                                 \r
-  UINT64  NoPresentPmi:1;                       /// Bit37, No INIT, PMI, and LINT pins\r
-                                                /// present. Denotes the absence of INIT,\r
-                                                /// PMI, LINT0 and LINT1 pins on the\r
-                                                /// processor. When 1, the pins are absent.\r
-                                                /// When 0, the pins are present. This\r
-                                                /// feature may only be interrogated by\r
-                                                /// PAL_PROC_GET_FEATURES. It may not be\r
-                                                /// enabled or disabled by\r
-                                                /// PAL_PROC_SET_FEATURES. The corresponding\r
-                                                /// argument is ignored.\r
+  UINT64  NoPresentPmi:1;                       ///< Bit37, No INIT, PMI, and LINT pins\r
+                                                ///< present. Denotes the absence of INIT,\r
+                                                ///< PMI, LINT0 and LINT1 pins on the\r
+                                                ///< processor. When 1, the pins are absent.\r
+                                                ///< When 0, the pins are present. This\r
+                                                ///< feature may only be interrogated by\r
+                                                ///< PAL_PROC_GET_FEATURES. It may not be\r
+                                                ///< enabled or disabled by\r
+                                                ///< PAL_PROC_SET_FEATURES. The corresponding\r
+                                                ///< argument is ignored.\r
                                                 \r
                                                 \r
-  UINT64  NoSimpleImpInUndefinedIns:1;          /// Bit38, No Simple\r
-                                                /// implementation of\r
-                                                /// unimplemented instruction\r
-                                                /// addresses. Denotes how an\r
-                                                /// unimplemented instruction\r
-                                                /// address is recorded in IIP\r
-                                                /// on an Unimplemented\r
-                                                /// Instruction Address trap or\r
-                                                /// fault. When 1, the full\r
-                                                /// unimplemented address is\r
-                                                /// recorded in IIP; when 0, the\r
-                                                /// address is sign extended\r
-                                                /// (virtual addresses) or zero\r
-                                                /// extended (physical\r
-                                                /// addresses). This feature may\r
-                                                /// only be interrogated by\r
-                                                /// PAL_PROC_GET_FEATURES. It\r
-                                                /// may not be enabled or\r
-                                                /// disabled by\r
-                                                /// PAL_PROC_SET_FEATURES. The\r
-                                                /// corresponding argument is\r
-                                                /// ignored.\r
-\r
-  UINT64  NoVariablePState:1;                   /// Bit39, No Variable P-state\r
-                                                /// performance: A value of 1, indicates\r
-                                                /// that a processor implements\r
-                                                /// techniques to optimize performance\r
-                                                /// for the given P-state power budget\r
-                                                /// by dynamically varying the\r
-                                                /// frequency, such that maximum\r
-                                                /// performance is achieved for the\r
-                                                /// power budget. A value of 0,\r
-                                                /// indicates that P-states have no\r
-                                                /// frequency variation or very small\r
-                                                /// frequency variations for their given\r
-                                                /// power budget. This feature may only\r
-                                                /// be interrogated by\r
-                                                /// PAL_PROC_GET_FEATURES. it may not be\r
-                                                /// enabled or disabled by\r
-                                                /// PAL_PROC_SET_FEATURES. The\r
-                                                /// corresponding argument is ignored.\r
-\r
-  UINT64  NoVM:1;                               /// Bit40, No Virtual Machine features implemented.\r
-                                                /// Denotes whether PSR.vm is implemented. This\r
-                                                /// feature may only be interrogated by\r
-                                                /// PAL_PROC_GET_FEATURES. It may not be enabled or\r
-                                                /// disabled by PAL_PROC_SET_FEATURES. The\r
-                                                /// corresponding argument is ignored.\r
-\r
-  UINT64  NoXipXpsrXfs:1;                       /// Bit41, No XIP, XPSR, and XFS\r
-                                                /// implemented. Denotes whether XIP, XPSR,\r
-                                                /// and XFS are implemented for machine\r
-                                                /// check recovery. This feature may only be\r
-                                                /// interrogated by PAL_PROC_GET_FEATURES.\r
-                                                /// It may not be enabled or disabled by\r
-                                                /// PAL_PROC_SET_FEATURES. The corresponding\r
-                                                /// argument is ignored.\r
-\r
-  UINT64  NoXr1ThroughXr3:1;                    /// Bit42, No XR1 through XR3 implemented.\r
-                                                ///   Denotes whether XR1 XR3 are\r
-                                                ///   implemented for machine check\r
-                                                ///   recovery. This feature may only be\r
-                                                ///   interrogated by PAL_PROC_GET_FEATURES.\r
-                                                ///   It may not be enabled or disabled by\r
-                                                ///   PAL_PROC_SET_FEATURES. The\r
-                                                ///   corresponding argument is ignored.\r
-\r
-  UINT64  DisableDynamicPrediction:1;           /// Bit43, Disable Dynamic\r
-                                                /// Predicate Prediction. When\r
-                                                /// 0, the processor may predict\r
-                                                /// predicate results and\r
-                                                /// execute speculatively, but\r
-                                                /// may not commit results until\r
-                                                /// the actual predicates are\r
-                                                /// known. When 1, the processor\r
-                                                /// shall not execute predicated\r
-                                                /// instructions until the\r
-                                                /// actual predicates are known.\r
-\r
-  UINT64  DisableSpontaneousDeferral:1;         /// Bit44, Disable Spontaneous\r
-                                                ///   Deferral. When 1, the\r
-                                                ///   processor may optionally\r
-                                                ///   defer speculative loads\r
-                                                ///   that do not encounter any\r
-                                                ///   exception conditions, but\r
-                                                ///   that trigger other\r
-                                                ///   implementation-dependent\r
-                                                ///   conditions (e.g., cache\r
-                                                ///   miss). When 0, spontaneous\r
-                                                ///   deferral is disabled.\r
-\r
-  UINT64  DisableDynamicDataCachePrefetch:1;    /// Bit45, Disable Dynamic\r
-                                                ///   Data Cache Prefetch.\r
-                                                ///   When 0, the processor\r
-                                                ///   may prefetch into the\r
-                                                ///   caches any data which\r
-                                                ///   has not been accessed\r
-                                                ///   by instruction\r
-                                                ///   execution, but which\r
-                                                ///   is likely to be\r
-                                                ///   accessed. When 1, no\r
-                                                ///   data may be fetched\r
-                                                ///   until it is needed for\r
-                                                ///   instruction execution\r
-                                                ///   or is fetched by an\r
-                                                ///   lfetch instruction.\r
-\r
-  UINT64  DisableDynamicInsCachePrefetch:1;     /// Bit46, Disable\r
-                                                /// DynamicInstruction Cache\r
-                                                /// Prefetch. When 0, the\r
-                                                /// processor may prefetch\r
-                                                /// into the caches any\r
-                                                /// instruction which has\r
-                                                /// not been executed, but\r
-                                                /// whose execution is\r
-                                                /// likely. When 1,\r
-                                                /// instructions may not be\r
-                                                /// fetched until needed or\r
-                                                /// hinted for execution.\r
-                                                /// (Prefetch for a hinted\r
-                                                /// branch is allowed even\r
-                                                /// when dynamic instruction\r
-                                                /// cache prefetch is\r
-                                                /// disabled.)\r
-\r
-  UINT64  DisableBranchPrediction:1;            /// Bit47, Disable Dynamic branch\r
-                                                ///   prediction. When 0, the\r
-                                                ///   processor may predict branch\r
-                                                ///   targets and speculatively\r
-                                                ///   execute, but may not commit\r
-                                                ///   results. When 1, the processor\r
-                                                ///   must wait until branch targets\r
-                                                ///   are known to execute.\r
+  UINT64  NoSimpleImpInUndefinedIns:1;          ///< Bit38, No Simple\r
+                                                ///< implementation of\r
+                                                ///< unimplemented instruction\r
+                                                ///< addresses. Denotes how an\r
+                                                ///< unimplemented instruction\r
+                                                ///< address is recorded in IIP\r
+                                                ///< on an Unimplemented\r
+                                                ///< Instruction Address trap or\r
+                                                ///< fault. When 1, the full\r
+                                                ///< unimplemented address is\r
+                                                ///< recorded in IIP; when 0, the\r
+                                                ///< address is sign extended\r
+                                                ///< (virtual addresses) or zero\r
+                                                ///< extended (physical\r
+                                                ///< addresses). This feature may\r
+                                                ///< only be interrogated by\r
+                                                ///< PAL_PROC_GET_FEATURES. It\r
+                                                ///< may not be enabled or\r
+                                                ///< disabled by\r
+                                                ///< PAL_PROC_SET_FEATURES. The\r
+                                                ///< corresponding argument is\r
+                                                ///< ignored.\r
+\r
+  UINT64  NoVariablePState:1;                   ///< Bit39, No Variable P-state\r
+                                                ///< performance: A value of 1, indicates\r
+                                                ///< that a processor implements\r
+                                                ///< techniques to optimize performance\r
+                                                ///< for the given P-state power budget\r
+                                                ///< by dynamically varying the\r
+                                                ///< frequency, such that maximum\r
+                                                ///< performance is achieved for the\r
+                                                ///< power budget. A value of 0,\r
+                                                ///< indicates that P-states have no\r
+                                                ///< frequency variation or very small\r
+                                                ///< frequency variations for their given\r
+                                                ///< power budget. This feature may only\r
+                                                ///< be interrogated by\r
+                                                ///< PAL_PROC_GET_FEATURES. it may not be\r
+                                                ///< enabled or disabled by\r
+                                                ///< PAL_PROC_SET_FEATURES. The\r
+                                                ///< corresponding argument is ignored.\r
+\r
+  UINT64  NoVM:1;                               ///< Bit40, No Virtual Machine features implemented.\r
+                                                ///< Denotes whether PSR.vm is implemented. This\r
+                                                ///< feature may only be interrogated by\r
+                                                ///< PAL_PROC_GET_FEATURES. It may not be enabled or\r
+                                                ///< disabled by PAL_PROC_SET_FEATURES. The\r
+                                                ///< corresponding argument is ignored.\r
+\r
+  UINT64  NoXipXpsrXfs:1;                       ///< Bit41, No XIP, XPSR, and XFS\r
+                                                ///< implemented. Denotes whether XIP, XPSR,\r
+                                                ///< and XFS are implemented for machine\r
+                                                ///< check recovery. This feature may only be\r
+                                                ///< interrogated by PAL_PROC_GET_FEATURES.\r
+                                                ///< It may not be enabled or disabled by\r
+                                                ///< PAL_PROC_SET_FEATURES. The corresponding\r
+                                                ///< argument is ignored.\r
+\r
+  UINT64  NoXr1ThroughXr3:1;                    ///< Bit42, No XR1 through XR3 implemented.\r
+                                                ///<   Denotes whether XR1 XR3 are\r
+                                                ///<   implemented for machine check\r
+                                                ///<   recovery. This feature may only be\r
+                                                ///<   interrogated by PAL_PROC_GET_FEATURES.\r
+                                                ///<   It may not be enabled or disabled by\r
+                                                ///<   PAL_PROC_SET_FEATURES. The\r
+                                                ///<   corresponding argument is ignored.\r
+\r
+  UINT64  DisableDynamicPrediction:1;           ///< Bit43, Disable Dynamic\r
+                                                ///< Predicate Prediction. When\r
+                                                ///< 0, the processor may predict\r
+                                                ///< predicate results and\r
+                                                ///< execute speculatively, but\r
+                                                ///< may not commit results until\r
+                                                ///< the actual predicates are\r
+                                                ///< known. When 1, the processor\r
+                                                ///< shall not execute predicated\r
+                                                ///< instructions until the\r
+                                                ///< actual predicates are known.\r
+\r
+  UINT64  DisableSpontaneousDeferral:1;         ///< Bit44, Disable Spontaneous\r
+                                                ///<   Deferral. When 1, the\r
+                                                ///<   processor may optionally\r
+                                                ///<   defer speculative loads\r
+                                                ///<   that do not encounter any\r
+                                                ///<   exception conditions, but\r
+                                                ///<   that trigger other\r
+                                                ///<   implementation-dependent\r
+                                                ///<   conditions (e.g., cache\r
+                                                ///<   miss). When 0, spontaneous\r
+                                                ///<   deferral is disabled.\r
+\r
+  UINT64  DisableDynamicDataCachePrefetch:1;    ///< Bit45, Disable Dynamic\r
+                                                ///<   Data Cache Prefetch.\r
+                                                ///<   When 0, the processor\r
+                                                ///<   may prefetch into the\r
+                                                ///<   caches any data which\r
+                                                ///<   has not been accessed\r
+                                                ///<   by instruction\r
+                                                ///<   execution, but which\r
+                                                ///<   is likely to be\r
+                                                ///<   accessed. When 1, no\r
+                                                ///<   data may be fetched\r
+                                                ///<   until it is needed for\r
+                                                ///<   instruction execution\r
+                                                ///<   or is fetched by an\r
+                                                ///<   lfetch instruction.\r
+\r
+  UINT64  DisableDynamicInsCachePrefetch:1;     ///< Bit46, Disable\r
+                                                ///< DynamicInstruction Cache\r
+                                                ///< Prefetch. When 0, the\r
+                                                ///< processor may prefetch\r
+                                                ///< into the caches any\r
+                                                ///< instruction which has\r
+                                                ///< not been executed, but\r
+                                                ///< whose execution is\r
+                                                ///< likely. When 1,\r
+                                                ///< instructions may not be\r
+                                                ///< fetched until needed or\r
+                                                ///< hinted for execution.\r
+                                                ///< (Prefetch for a hinted\r
+                                                ///< branch is allowed even\r
+                                                ///< when dynamic instruction\r
+                                                ///< cache prefetch is\r
+                                                ///< disabled.)\r
+\r
+  UINT64  DisableBranchPrediction:1;            ///< Bit47, Disable Dynamic branch\r
+                                                ///<   prediction. When 0, the\r
+                                                ///<   processor may predict branch\r
+                                                ///<   targets and speculatively\r
+                                                ///<   execute, but may not commit\r
+                                                ///<   results. When 1, the processor\r
+                                                ///<   must wait until branch targets\r
+                                                ///<   are known to execute.\r
   UINT64  Reserved2:4;\r
   UINT64  Reserved2:4;\r
-  UINT64  DisablePState:1;                      /// Bit52, Disable P-states. When 1, the PAL\r
-                                                /// P-state procedures (PAL_PSTATE_INFO,\r
-                                                /// PAL_SET_PSTATE, PAL_GET_PSTATE) will\r
-                                                /// return with a status of -1\r
-                                                /// (Unimplemented procedure).\r
-\r
-  UINT64  EnableMcaOnDataPoisoning:1;           /// Bit53, Enable MCA signaling\r
-                                                /// on data-poisoning event\r
-                                                /// detection. When 0, a CMCI\r
-                                                /// will be signaled on error\r
-                                                /// detection. When 1, an MCA\r
-                                                /// will be signaled on error\r
-                                                /// detection. If this feature\r
-                                                /// is not supported, then the\r
-                                                /// corresponding argument is\r
-                                                /// ignored when calling\r
-                                                /// PAL_PROC_SET_FEATURES. Note\r
-                                                /// that the functionality of\r
-                                                /// this bit is independent of\r
-                                                /// the setting in bit 60\r
-                                                /// (Enable CMCI promotion), and\r
-                                                /// that the bit 60 setting does\r
-                                                /// not affect CMCI signaling\r
-                                                /// for data-poisoning related\r
-                                                /// events. Volume 2: Processor\r
-                                                /// Abstraction Layer 2:431\r
-                                                /// PAL_PROC_GET_FEATURES\r
-\r
-  UINT64  EnableVmsw:1;                         /// Bit54, Enable the use of the vmsw\r
-                                                ///   instruction. When 0, the vmsw instruction\r
-                                                ///   causes a Virtualization fault when\r
-                                                ///   executed at the most privileged level.\r
-                                                ///   When 1, this bit will enable normal\r
-                                                ///   operation of the vmsw instruction.\r
-\r
-  UINT64  EnableEnvNotification:1;              /// Bit55, Enable external\r
-                                                /// notification when the processor\r
-                                                /// detects hardware errors caused\r
-                                                /// by environmental factors that\r
-                                                /// could cause loss of\r
-                                                /// deterministic behavior of the\r
-                                                /// processor. When 1, this bit will\r
-                                                /// enable external notification,\r
-                                                /// when 0 external notification is\r
-                                                /// not provided. The type of\r
-                                                /// external notification of these\r
-                                                /// errors is processor-dependent. A\r
-                                                /// loss of processor deterministic\r
-                                                /// behavior is considered to have\r
-                                                /// occurred if these\r
-                                                /// environmentally induced errors\r
-                                                /// cause the processor to deviate\r
-                                                /// from its normal execution and\r
-                                                /// eventually causes different\r
-                                                /// behavior which can be observed\r
-                                                ///  at the processor bus pins.\r
-                                                /// Processor errors that do not\r
-                                                /// have this effects (i.e.,\r
-                                                /// software induced machine checks)\r
-                                                /// may or may not be promoted\r
-                                                /// depending on the processor\r
-                                                /// implementation.\r
-\r
-  UINT64  DisableBinitWithTimeout:1;            /// Bit56, Disable a BINIT on\r
-                                                ///   internal processor time-out.\r
-                                                ///   When 0, the processor may\r
-                                                ///   generate a BINIT on an\r
-                                                ///   internal processor time-out.\r
-                                                ///   When 1, the processor will not\r
-                                                ///   generate a BINIT on an\r
-                                                ///   internal processor time-out.\r
-                                                ///   The event is silently ignored.\r
-\r
-  UINT64  DisableDPM:1;                         /// Bit57, Disable Dynamic Power Management\r
-                                                ///   (DPM). When 0, the hardware may reduce\r
-                                                ///   power consumption by removing the clock\r
-                                                ///   input from idle functional units. When 1,\r
-                                                ///   all functional units will receive clock\r
-                                                ///   input, even when idle.\r
-\r
-  UINT64  DisableCoherency:1;                   /// Bit58, Disable Coherency. When 0,\r
-                                                /// the processor uses normal coherency\r
-                                                /// requests and responses. When 1, the\r
-                                                /// processor answers all requests as if\r
-                                                /// the line were not present.\r
-\r
-  UINT64  DisableCache:1;                       /// Bit59, Disable Cache. When 0, the\r
-                                                /// processor performs cast outs on\r
-                                                /// cacheable pages and issues and responds\r
-                                                /// to coherency requests normally. When 1,\r
-                                                /// the processor performs a memory access\r
-                                                /// for each reference regardless of cache\r
-                                                /// contents and issues no coherence\r
-                                                /// requests and responds as if the line\r
-                                                /// were not present. Cache contents cannot\r
-                                                /// be relied upon when the cache is\r
-                                                /// disabled. WARNING: Semaphore\r
-                                                /// instructions may not be atomic or may\r
-                                                /// cause Unsupported Data Reference faults\r
-                                                /// if caches are disabled.\r
-\r
-  UINT64  EnableCmciPromotion:1;                /// Bit60, Enable CMCI promotion When\r
-                                                ///   1, Corrected Machine Check\r
-                                                ///   Interrupts (CMCI) are promoted to\r
-                                                ///   MCAs. They are also further\r
-                                                ///   promoted to BERR if bit 39, Enable\r
-                                                ///   MCA promotion, is also set and\r
-                                                ///   they are promoted to BINIT if bit\r
-                                                ///   38, Enable MCA to BINIT promotion,\r
-                                                ///   is also set. This bit has no\r
-                                                ///   effect if MCA signalling is\r
-                                                ///   disabled (see\r
-                                                ///   PAL_BUS_GET/SET_FEATURES)\r
-\r
-  UINT64  EnableMcaToBinitPromotion:1;          /// Bit61, Enable MCA to BINIT\r
-                                                /// promotion. When 1, machine\r
-                                                /// check aborts (MCAs) are\r
-                                                /// promoted to the Bus\r
-                                                /// Initialization signal, and\r
-                                                /// the BINIT pin is assert on\r
-                                                /// each occurrence of an MCA.\r
-                                                /// Setting this bit has no\r
-                                                /// effect if BINIT signalling\r
-                                                /// is disabled. (See\r
-                                                /// PAL_BUS_GET/SET_FEATURES)\r
-\r
-  UINT64  EnableMcaPromotion:1;                 /// Bit62, Enable MCA promotion. When\r
-                                                ///   1, machine check aborts (MCAs) are\r
-                                                ///   promoted to the Bus Error signal,\r
-                                                ///   and the BERR pin is assert on each\r
-                                                ///   occurrence of an MCA. Setting this\r
-                                                ///   bit has no effect if BERR\r
-                                                ///   signalling is disabled. (See\r
-                                                ///   PAL_BUS_GET/SET_FEATURES)\r
+  UINT64  DisablePState:1;                      ///< Bit52, Disable P-states. When 1, the PAL\r
+                                                ///< P-state procedures (PAL_PSTATE_INFO,\r
+                                                ///< PAL_SET_PSTATE, PAL_GET_PSTATE) will\r
+                                                ///< return with a status of -1\r
+                                                ///< (Unimplemented procedure).\r
+\r
+  UINT64  EnableMcaOnDataPoisoning:1;           ///< Bit53, Enable MCA signaling\r
+                                                ///< on data-poisoning event\r
+                                                ///< detection. When 0, a CMCI\r
+                                                ///< will be signaled on error\r
+                                                ///< detection. When 1, an MCA\r
+                                                ///< will be signaled on error\r
+                                                ///< detection. If this feature\r
+                                                ///< is not supported, then the\r
+                                                ///< corresponding argument is\r
+                                                ///< ignored when calling\r
+                                                ///< PAL_PROC_SET_FEATURES. Note\r
+                                                ///< that the functionality of\r
+                                                ///< this bit is independent of\r
+                                                ///< the setting in bit 60\r
+                                                ///< (Enable CMCI promotion), and\r
+                                                ///< that the bit 60 setting does\r
+                                                ///< not affect CMCI signaling\r
+                                                ///< for data-poisoning related\r
+                                                ///< events. Volume 2: Processor\r
+                                                ///< Abstraction Layer 2:431\r
+                                                ///< PAL_PROC_GET_FEATURES\r
+\r
+  UINT64  EnableVmsw:1;                         ///< Bit54, Enable the use of the vmsw\r
+                                                ///<   instruction. When 0, the vmsw instruction\r
+                                                ///<   causes a Virtualization fault when\r
+                                                ///<   executed at the most privileged level.\r
+                                                ///<   When 1, this bit will enable normal\r
+                                                ///<   operation of the vmsw instruction.\r
+\r
+  UINT64  EnableEnvNotification:1;              ///< Bit55, Enable external\r
+                                                ///< notification when the processor\r
+                                                ///< detects hardware errors caused\r
+                                                ///< by environmental factors that\r
+                                                ///< could cause loss of\r
+                                                ///< deterministic behavior of the\r
+                                                ///< processor. When 1, this bit will\r
+                                                ///< enable external notification,\r
+                                                ///< when 0 external notification is\r
+                                                ///< not provided. The type of\r
+                                                ///< external notification of these\r
+                                                ///< errors is processor-dependent. A\r
+                                                ///< loss of processor deterministic\r
+                                                ///< behavior is considered to have\r
+                                                ///< occurred if these\r
+                                                ///< environmentally induced errors\r
+                                                ///< cause the processor to deviate\r
+                                                ///< from its normal execution and\r
+                                                ///< eventually causes different\r
+                                                ///< behavior which can be observed\r
+                                                ///<  at the processor bus pins.\r
+                                                ///< Processor errors that do not\r
+                                                ///< have this effects (i.e.,\r
+                                                ///< software induced machine checks)\r
+                                                ///< may or may not be promoted\r
+                                                ///< depending on the processor\r
+                                                ///< implementation.\r
+\r
+  UINT64  DisableBinitWithTimeout:1;            ///< Bit56, Disable a BINIT on\r
+                                                ///<   internal processor time-out.\r
+                                                ///<   When 0, the processor may\r
+                                                ///<   generate a BINIT on an\r
+                                                ///<   internal processor time-out.\r
+                                                ///<   When 1, the processor will not\r
+                                                ///<   generate a BINIT on an\r
+                                                ///<   internal processor time-out.\r
+                                                ///<   The event is silently ignored.\r
+\r
+  UINT64  DisableDPM:1;                         ///< Bit57, Disable Dynamic Power Management\r
+                                                ///<   (DPM). When 0, the hardware may reduce\r
+                                                ///<   power consumption by removing the clock\r
+                                                ///<   input from idle functional units. When 1,\r
+                                                ///<   all functional units will receive clock\r
+                                                ///<   input, even when idle.\r
+\r
+  UINT64  DisableCoherency:1;                   ///< Bit58, Disable Coherency. When 0,\r
+                                                ///< the processor uses normal coherency\r
+                                                ///< requests and responses. When 1, the\r
+                                                ///< processor answers all requests as if\r
+                                                ///< the line were not present.\r
+\r
+  UINT64  DisableCache:1;                       ///< Bit59, Disable Cache. When 0, the\r
+                                                ///< processor performs cast outs on\r
+                                                ///< cacheable pages and issues and responds\r
+                                                ///< to coherency requests normally. When 1,\r
+                                                ///< the processor performs a memory access\r
+                                                ///< for each reference regardless of cache\r
+                                                ///< contents and issues no coherence\r
+                                                ///< requests and responds as if the line\r
+                                                ///< were not present. Cache contents cannot\r
+                                                ///< be relied upon when the cache is\r
+                                                ///< disabled. WARNING: Semaphore\r
+                                                ///< instructions may not be atomic or may\r
+                                                ///< cause Unsupported Data Reference faults\r
+                                                ///< if caches are disabled.\r
+\r
+  UINT64  EnableCmciPromotion:1;                ///< Bit60, Enable CMCI promotion When\r
+                                                ///<   1, Corrected Machine Check\r
+                                                ///<   Interrupts (CMCI) are promoted to\r
+                                                ///<   MCAs. They are also further\r
+                                                ///<   promoted to BERR if bit 39, Enable\r
+                                                ///<   MCA promotion, is also set and\r
+                                                ///<   they are promoted to BINIT if bit\r
+                                                ///<   38, Enable MCA to BINIT promotion,\r
+                                                ///<   is also set. This bit has no\r
+                                                ///<   effect if MCA signalling is\r
+                                                ///<   disabled (see\r
+                                                ///<   PAL_BUS_GET/SET_FEATURES)\r
+\r
+  UINT64  EnableMcaToBinitPromotion:1;          ///< Bit61, Enable MCA to BINIT\r
+                                                ///< promotion. When 1, machine\r
+                                                ///< check aborts (MCAs) are\r
+                                                ///< promoted to the Bus\r
+                                                ///< Initialization signal, and\r
+                                                ///< the BINIT pin is assert on\r
+                                                ///< each occurrence of an MCA.\r
+                                                ///< Setting this bit has no\r
+                                                ///< effect if BINIT signalling\r
+                                                ///< is disabled. (See\r
+                                                ///< PAL_BUS_GET/SET_FEATURES)\r
+\r
+  UINT64  EnableMcaPromotion:1;                 ///< Bit62, Enable MCA promotion. When\r
+                                                ///<   1, machine check aborts (MCAs) are\r
+                                                ///<   promoted to the Bus Error signal,\r
+                                                ///<   and the BERR pin is assert on each\r
+                                                ///<   occurrence of an MCA. Setting this\r
+                                                ///<   bit has no effect if BERR\r
+                                                ///<   signalling is disabled. (See\r
+                                                ///<   PAL_BUS_GET/SET_FEATURES)\r
                                                 \r
                                                 \r
-  UINT64  EnableBerrPromotion:1;                /// Bit63. Enable BERR promotion. When\r
-                                                ///   1, the Bus Error (BERR) signal is\r
-                                                ///   promoted to the Bus Initialization\r
-                                                ///   (BINIT) signal, and the BINIT pin\r
-                                                ///   is asserted on the occurrence of\r
-                                                ///   each Bus Error. Setting this bit\r
-                                                ///   has no effect if BINIT signalling\r
-                                                ///   is disabled. (See\r
-                                                ///   PAL_BUS_GET/SET_FEATURES)\r
+  UINT64  EnableBerrPromotion:1;                ///< Bit63. Enable BERR promotion. When\r
+                                                ///<   1, the Bus Error (BERR) signal is\r
+                                                ///<   promoted to the Bus Initialization\r
+                                                ///<   (BINIT) signal, and the BINIT pin\r
+                                                ///<   is asserted on the occurrence of\r
+                                                ///<   each Bus Error. Setting this bit\r
+                                                ///<   has no effect if BINIT signalling\r
+                                                ///<   is disabled. (See\r
+                                                ///<   PAL_BUS_GET/SET_FEATURES)\r
 } PAL_PROCESSOR_FEATURES;\r
 \r
 /**\r
 } PAL_PROCESSOR_FEATURES;\r
 \r
 /**\r
@@ -1567,20 +1567,20 @@ typedef struct {
 #define PAL_RSE_INFO 19\r
 \r
 typedef struct {\r
 #define PAL_RSE_INFO 19\r
 \r
 typedef struct {\r
-  UINT64  VersionOfPalB:16;     /// Is a 16-bit binary coded decimal (BCD)\r
-                                /// number that provides identification\r
-                                /// information about the PAL_B firmware.\r
+  UINT64  VersionOfPalB:16;     ///< Is a 16-bit binary coded decimal (BCD)\r
+                                ///< number that provides identification\r
+                                ///< information about the PAL_B firmware.\r
   UINT64  Reserved1:8;\r
   UINT64  Reserved1:8;\r
-  UINT64  PalVendor:8;          /// Is an unsigned 8-bit integer indicating the\r
-                                /// vendor of the PAL code.\r
-  UINT64  VersionOfPalA:16;     /// Is a 16-bit binary coded decimal (BCD)\r
-                                /// number that provides identification\r
-                                /// information about the PAL_A firmware. In\r
-                                /// the split PAL_A model, this return value\r
-                                /// is the version number of the\r
-                                /// processor-specific PAL_A. The generic\r
-                                /// PAL_A version is not returned by this\r
-                                /// procedure in the split PAL_A model.\r
+  UINT64  PalVendor:8;          ///< Is an unsigned 8-bit integer indicating the\r
+                                ///< vendor of the PAL code.\r
+  UINT64  VersionOfPalA:16;     ///< Is a 16-bit binary coded decimal (BCD)\r
+                                ///< number that provides identification\r
+                                ///< information about the PAL_A firmware. In\r
+                                ///< the split PAL_A model, this return value\r
+                                ///< is the version number of the\r
+                                ///< processor-specific PAL_A. The generic\r
+                                ///< PAL_A version is not returned by this\r
+                                ///< procedure in the split PAL_A model.\r
   UINT64  Reserved2:16;\r
 } PAL_VERSION_INFO;\r
 \r
   UINT64  Reserved2:16;\r
 } PAL_VERSION_INFO;\r
 \r
@@ -1693,38 +1693,38 @@ typedef struct {
 #define PAL_STRUCTURE_SPECIFIC_ERROR  2\r
 \r
 typedef struct {\r
 #define PAL_STRUCTURE_SPECIFIC_ERROR  2\r
 \r
 typedef struct {\r
- UINT64 CoreId:4;                   /// Bit3:0,  Processor core ID (default is 0 for\r
-                                    /// processors with a single core)\r
-\r
- UINT64 ThreadId:4;                 /// Bit7:4, Logical thread ID (default is 0 for\r
-                                    /// processors that execute a single thread)\r
-\r
- UINT64 InfoOfInsCache:4;           /// Bit11:8, Error information is\r
-                                    /// available for 1st, 2nd, 3rd, and 4th\r
-                                    /// level instruction caches.\r
-\r
- UINT64 InfoOfDataCache:4;          /// Bit15:12, Error information is\r
-                                    ///   available for 1st, 2nd, 3rd, and 4th\r
-                                    ///   level data/unified caches.\r
-\r
- UINT64 InfoOfInsTlb:4;             /// Bit19:16 Error information is available\r
-                                    /// for 1st, 2nd, 3rd, and 4th level\r
-                                    /// instruction TLB.\r
-\r
- UINT64 InfoOfDataTlb:4;            /// Bit23:20, Error information is available\r
-                                    /// for 1st, 2nd, 3rd, and 4th level\r
-                                    /// data/unified TLB\r
-\r
- UINT64 InfoOfProcessorBus:4;       /// Bit27:24 Error information is\r
-                                    ///   available for the 1st, 2nd, 3rd,\r
-                                    ///   and 4th level processor bus\r
-                                    ///   hierarchy.\r
- UINT64 InfoOfRegisterFile:4;       /// Bit31:28 Error information is\r
-                                    ///   available on register file\r
-                                    ///   structures.\r
- UINT64 InfoOfMicroArch:4;          /// Bit47:32, Error information is\r
-                                    ///   available on micro-architectural\r
-                                    ///   structures.\r
+ UINT64 CoreId:4;                   ///< Bit3:0,  Processor core ID (default is 0 for\r
+                                    ///< processors with a single core)\r
+\r
+ UINT64 ThreadId:4;                 ///< Bit7:4, Logical thread ID (default is 0 for\r
+                                    ///< processors that execute a single thread)\r
+\r
+ UINT64 InfoOfInsCache:4;           ///< Bit11:8, Error information is\r
+                                    ///< available for 1st, 2nd, 3rd, and 4th\r
+                                    ///< level instruction caches.\r
+\r
+ UINT64 InfoOfDataCache:4;          ///< Bit15:12, Error information is\r
+                                    ///<   available for 1st, 2nd, 3rd, and 4th\r
+                                    ///<   level data/unified caches.\r
+\r
+ UINT64 InfoOfInsTlb:4;             ///< Bit19:16 Error information is available\r
+                                    ///< for 1st, 2nd, 3rd, and 4th level\r
+                                    ///< instruction TLB.\r
+\r
+ UINT64 InfoOfDataTlb:4;            ///< Bit23:20, Error information is available\r
+                                    ///< for 1st, 2nd, 3rd, and 4th level\r
+                                    ///< data/unified TLB\r
+\r
+ UINT64 InfoOfProcessorBus:4;       ///< Bit27:24 Error information is\r
+                                    ///<   available for the 1st, 2nd, 3rd,\r
+                                    ///<   and 4th level processor bus\r
+                                    ///<   hierarchy.\r
+ UINT64 InfoOfRegisterFile:4;       ///< Bit31:28 Error information is\r
+                                    ///<   available on register file\r
+                                    ///<   structures.\r
+ UINT64 InfoOfMicroArch:4;          ///< Bit47:32, Error information is\r
+                                    ///<   available on micro-architectural\r
+                                    ///<   structures.\r
  UINT64 Reserved:16;\r
 } PAL_MC_ERROR_INFO_LEVEL_INDEX;\r
 \r
  UINT64 Reserved:16;\r
 } PAL_MC_ERROR_INFO_LEVEL_INDEX;\r
 \r
@@ -1738,178 +1738,178 @@ typedef struct {
 #define PAL_ERR_INFO_PRECISE_INSTRUCTION_POINTER  4\r
 \r
 typedef struct {\r
 #define PAL_ERR_INFO_PRECISE_INSTRUCTION_POINTER  4\r
 \r
 typedef struct {\r
-  UINT64  Operation:4;                  /// Bit3:0, Type of cache operation that caused\r
-                                        /// the machine check: 0 - unknown or internal\r
-                                        /// error 1 - load 2 - store 3 - instruction\r
-                                        /// fetch or instruction prefetch 4 - data\r
-                                        /// prefetch (both hardware and software) 5 -\r
-                                        /// snoop (coherency check) 6 - cast out\r
-                                        /// (explicit or implicit write-back of a cache\r
-                                        /// line) 7 - move in (cache line fill)\r
-\r
-  UINT64  FailedCacheLevel:2;           /// Bit5:4 Level of cache where the\r
-                                        /// error occurred. A value of 0\r
-                                        /// indicates the first level of cache.\r
+  UINT64  Operation:4;                  ///< Bit3:0, Type of cache operation that caused\r
+                                        ///< the machine check: 0 - unknown or internal\r
+                                        ///< error 1 - load 2 - store 3 - instruction\r
+                                        ///< fetch or instruction prefetch 4 - data\r
+                                        ///< prefetch (both hardware and software) 5 -\r
+                                        ///< snoop (coherency check) 6 - cast out\r
+                                        ///< (explicit or implicit write-back of a cache\r
+                                        ///< line) 7 - move in (cache line fill)\r
+\r
+  UINT64  FailedCacheLevel:2;           ///< Bit5:4 Level of cache where the\r
+                                        ///< error occurred. A value of 0\r
+                                        ///< indicates the first level of cache.\r
   UINT64  Reserved1:2;\r
   UINT64  Reserved1:2;\r
-  UINT64  FailedInDataPart:1;           /// Bit8, Failure located in the data part of the cache line.\r
-  UINT64  FailedInTagPart:1;            /// Bit9, Failure located in the tag part of the cache line.\r
-  UINT64  FailedInDataCache:1;          /// Bit10, Failure located in the data cache\r
+  UINT64  FailedInDataPart:1;           ///< Bit8, Failure located in the data part of the cache line.\r
+  UINT64  FailedInTagPart:1;            ///< Bit9, Failure located in the tag part of the cache line.\r
+  UINT64  FailedInDataCache:1;          ///< Bit10, Failure located in the data cache\r
 \r
 \r
-  UINT64  FailedInInsCache:1;           /// Bit11, Failure located in the\r
-                                        /// instruction cache.\r
+  UINT64  FailedInInsCache:1;           ///< Bit11, Failure located in the\r
+                                        ///< instruction cache.\r
                                         \r
                                         \r
-  UINT64  Mesi:3;                       /// Bit14:12,  0 - cache line is invalid. 1 - cache\r
-                                        /// line is held shared. 2 - cache line is held\r
-                                        /// exclusive. 3 - cache line is modified. All other\r
-                                        /// values are reserved.\r
+  UINT64  Mesi:3;                       ///< Bit14:12,  0 - cache line is invalid. 1 - cache\r
+                                        ///< line is held shared. 2 - cache line is held\r
+                                        ///< exclusive. 3 - cache line is modified. All other\r
+                                        ///< values are reserved.\r
                                         \r
                                         \r
-  UINT64  MesiIsValid:1;                /// Bit15, The mesi field in the cache_check\r
-                                        /// parameter is valid.\r
+  UINT64  MesiIsValid:1;                ///< Bit15, The mesi field in the cache_check\r
+                                        ///< parameter is valid.\r
                                         \r
                                         \r
-  UINT64  FailedWay:5;                  /// Bit20:16, Failure located in the way of\r
-                                        /// the cache indicated by this value.\r
+  UINT64  FailedWay:5;                  ///< Bit20:16, Failure located in the way of\r
+                                        ///< the cache indicated by this value.\r
 \r
 \r
-  UINT64  WayIndexIsValid:1;            /// Bit21, The way and index field in the\r
-                                        /// cache_check parameter is valid.\r
+  UINT64  WayIndexIsValid:1;            ///< Bit21, The way and index field in the\r
+                                        ///< cache_check parameter is valid.\r
 \r
   UINT64  Reserved2:1;\r
 \r
   UINT64  Reserved2:1;\r
-  UINT64  MultipleBitsError:1;          /// Bit23, A multiple-bit error was\r
-                                        /// detected, and data was poisoned for\r
-                                        /// the corresponding cache line during\r
-                                        /// castout.\r
+  UINT64  MultipleBitsError:1;          ///< Bit23, A multiple-bit error was\r
+                                        ///< detected, and data was poisoned for\r
+                                        ///< the corresponding cache line during\r
+                                        ///< castout.\r
   UINT64  Reserved3:8;\r
   UINT64  Reserved3:8;\r
-  UINT64  IndexOfCacheLineError:20;     /// Bit51:32, Index of the cache\r
-                                        /// line where the error occurred.\r
+  UINT64  IndexOfCacheLineError:20;     ///< Bit51:32, Index of the cache\r
+                                        ///< line where the error occurred.\r
   UINT64  Reserved4:2;\r
 \r
   UINT64  Reserved4:2;\r
 \r
-  UINT64  InstructionSet:1;             /// Bit54, Instruction set. If this value\r
-                                        ///   is set to zero, the instruction that\r
-                                        ///   generated the machine check was an\r
-                                        ///   Intel Itanium instruction. If this bit\r
-                                        ///   is set to one, the instruction that\r
-                                        ///   generated the machine check was IA-32\r
-                                        ///   instruction.\r
-\r
-  UINT64  InstructionSetIsValid:1;      /// Bit55, The is field in the\r
-                                        /// cache_check parameter is valid.\r
-\r
-  UINT64  PrivilegeLevel:2;             /// Bit57:56, Privilege level. The\r
-                                        ///   privilege level of the instruction\r
-                                        ///   bundle responsible for generating the\r
-                                        ///   machine check.\r
-\r
-  UINT64  PrivilegeLevelIsValide:1;     /// Bit58, The pl field of the\r
-                                        ///   cache_check parameter is\r
-                                        ///   valid.\r
-\r
-  UINT64  McCorrected:1;                /// Bit59, Machine check corrected: This bit\r
-                                        ///   is set to one to indicate that the machine\r
-                                        ///   check has been corrected.\r
-\r
-  UINT64  TargetAddressIsValid:1;       /// Bit60, Target address is valid:\r
-                                        /// This bit is set to one to\r
-                                        /// indicate that a valid target\r
-                                        /// address has been logged.\r
-\r
-  UINT64  RequesterIdentifier:1;        /// Bit61, Requester identifier: This\r
-                                        ///   bit is set to one to indicate that\r
-                                        ///   a valid requester identifier has\r
-                                        ///   been logged.\r
-\r
-  UINT64  ResponserIdentifier:1;        /// Bit62, Responder identifier: This\r
-                                        ///   bit is set to one to indicate that\r
-                                        ///   a valid responder identifier has\r
-                                        ///   been logged.\r
-\r
-  UINT64  PreciseInsPointer:1;          /// Bit63,  Precise instruction pointer.\r
-                                        /// This bit is set to one to indicate\r
-                                        /// that a valid precise instruction\r
-                                        /// pointer has been logged.\r
+  UINT64  InstructionSet:1;             ///< Bit54, Instruction set. If this value\r
+                                        ///<   is set to zero, the instruction that\r
+                                        ///<   generated the machine check was an\r
+                                        ///<   Intel Itanium instruction. If this bit\r
+                                        ///<   is set to one, the instruction that\r
+                                        ///<   generated the machine check was IA-32\r
+                                        ///<   instruction.\r
+\r
+  UINT64  InstructionSetIsValid:1;      ///< Bit55, The is field in the\r
+                                        ///< cache_check parameter is valid.\r
+\r
+  UINT64  PrivilegeLevel:2;             ///< Bit57:56, Privilege level. The\r
+                                        ///<   privilege level of the instruction\r
+                                        ///<   bundle responsible for generating the\r
+                                        ///<   machine check.\r
+\r
+  UINT64  PrivilegeLevelIsValide:1;     ///< Bit58, The pl field of the\r
+                                        ///<   cache_check parameter is\r
+                                        ///<   valid.\r
+\r
+  UINT64  McCorrected:1;                ///< Bit59, Machine check corrected: This bit\r
+                                        ///<   is set to one to indicate that the machine\r
+                                        ///<   check has been corrected.\r
+\r
+  UINT64  TargetAddressIsValid:1;       ///< Bit60, Target address is valid:\r
+                                        ///< This bit is set to one to\r
+                                        ///< indicate that a valid target\r
+                                        ///< address has been logged.\r
+\r
+  UINT64  RequesterIdentifier:1;        ///< Bit61, Requester identifier: This\r
+                                        ///<   bit is set to one to indicate that\r
+                                        ///<   a valid requester identifier has\r
+                                        ///<   been logged.\r
+\r
+  UINT64  ResponserIdentifier:1;        ///< Bit62, Responder identifier: This\r
+                                        ///<   bit is set to one to indicate that\r
+                                        ///<   a valid responder identifier has\r
+                                        ///<   been logged.\r
+\r
+  UINT64  PreciseInsPointer:1;          ///< Bit63,  Precise instruction pointer.\r
+                                        ///< This bit is set to one to indicate\r
+                                        ///< that a valid precise instruction\r
+                                        ///< pointer has been logged.\r
 \r
 } PAL_CACHE_CHECK_INFO;\r
 \r
 \r
 typedef struct {\r
 \r
 } PAL_CACHE_CHECK_INFO;\r
 \r
 \r
 typedef struct {\r
-  UINT64  FailedSlot:8;                 /// Bit7:0, Slot number of the translation\r
-                                        /// register where the failure occurred.\r
-  UINT64  FailedSlotIsValid:1;          /// Bit8, The tr_slot field in the\r
-                                        /// TLB_check parameter is valid.\r
+  UINT64  FailedSlot:8;                 ///< Bit7:0, Slot number of the translation\r
+                                        ///< register where the failure occurred.\r
+  UINT64  FailedSlotIsValid:1;          ///< Bit8, The tr_slot field in the\r
+                                        ///< TLB_check parameter is valid.\r
   UINT64  Reserved1 :1;\r
   UINT64  Reserved1 :1;\r
-  UINT64  TlbLevel:2;                   /// Bit11:10,  The level of the TLB where the\r
-                                        /// error occurred. A value of 0 indicates the\r
-                                        /// first level of TLB\r
+  UINT64  TlbLevel:2;                   ///< Bit11:10,  The level of the TLB where the\r
+                                        ///< error occurred. A value of 0 indicates the\r
+                                        ///< first level of TLB\r
   UINT64  Reserved2 :4;\r
 \r
   UINT64  Reserved2 :4;\r
 \r
-  UINT64  FailedInDataTr:1;             /// Bit16, Error occurred in the data\r
-                                        /// translation registers.\r
-\r
-  UINT64  FailedInInsTr:1;              /// Bit17, Error occurred in the instruction\r
-                                        /// translation registers\r
-\r
-  UINT64  FailedInDataTc:1;             /// Bit18, Error occurred in data\r
-                                        /// translation cache.\r
-\r
-  UINT64  FailedInInsTc:1;              /// Bit19, Error occurred in the instruction\r
-                                        /// translation cache.\r
-\r
-  UINT64  FailedOperation:4;            /// Bit23:20, Type of cache operation that\r
-                                        ///   caused the machine check: 0 - unknown\r
-                                        ///   1 - TLB access due to load instruction\r
-                                        ///   2 - TLB access due to store\r
-                                        ///   instruction 3 - TLB access due to\r
-                                        ///   instruction fetch or instruction\r
-                                        ///   prefetch 4 - TLB access due to data\r
-                                        ///   prefetch (both hardware and software)\r
-                                        ///   5 - TLB shoot down access 6 - TLB\r
-                                        ///   probe instruction (probe, tpa) 7 -\r
-                                        ///   move in (VHPT fill) 8 - purge (insert\r
-                                        ///   operation that purges entries or a TLB\r
-                                        ///   purge instruction) All other values\r
-                                        ///   are reserved.\r
+  UINT64  FailedInDataTr:1;             ///< Bit16, Error occurred in the data\r
+                                        ///< translation registers.\r
+\r
+  UINT64  FailedInInsTr:1;              ///< Bit17, Error occurred in the instruction\r
+                                        ///< translation registers\r
+\r
+  UINT64  FailedInDataTc:1;             ///< Bit18, Error occurred in data\r
+                                        ///< translation cache.\r
+\r
+  UINT64  FailedInInsTc:1;              ///< Bit19, Error occurred in the instruction\r
+                                        ///< translation cache.\r
+\r
+  UINT64  FailedOperation:4;            ///< Bit23:20, Type of cache operation that\r
+                                        ///<   caused the machine check: 0 - unknown\r
+                                        ///<   1 - TLB access due to load instruction\r
+                                        ///<   2 - TLB access due to store\r
+                                        ///<   instruction 3 - TLB access due to\r
+                                        ///<   instruction fetch or instruction\r
+                                        ///<   prefetch 4 - TLB access due to data\r
+                                        ///<   prefetch (both hardware and software)\r
+                                        ///<   5 - TLB shoot down access 6 - TLB\r
+                                        ///<   probe instruction (probe, tpa) 7 -\r
+                                        ///<   move in (VHPT fill) 8 - purge (insert\r
+                                        ///<   operation that purges entries or a TLB\r
+                                        ///<   purge instruction) All other values\r
+                                        ///<   are reserved.\r
 \r
   UINT64  Reserved3:30;\r
 \r
   UINT64  Reserved3:30;\r
-  UINT64  InstructionSet:1;             /// Bit54, Instruction set. If this value\r
-                                        ///   is set to zero, the instruction that\r
-                                        ///   generated the machine check was an\r
-                                        ///   Intel Itanium instruction. If this bit\r
-                                        ///   is set to one, the instruction that\r
-                                        ///   generated the machine check was IA-32\r
-                                        ///   instruction.\r
-\r
-  UINT64  InstructionSetIsValid:1;      /// Bit55, The is field in the\r
-                                        /// TLB_check parameter is valid.\r
-\r
-  UINT64  PrivelegeLevel:2;             /// Bit57:56, Privilege level. The\r
-                                        ///   privilege level of the instruction\r
-                                        ///   bundle responsible for generating the\r
-                                        ///   machine check.\r
-\r
-  UINT64  PrivelegeLevelIsValid:1;      /// Bit58,  The pl field of the\r
-                                        /// TLB_check parameter is valid.\r
-\r
-  UINT64  McCorrected:1;                /// Bit59, Machine check corrected: This bit\r
-                                        ///   is set to one to indicate that the machine\r
-                                        ///   check has been corrected.\r
-\r
-  UINT64  TargetAddressIsValid:1;       /// Bit60, Target address is valid:\r
-                                        /// This bit is set to one to\r
-                                        /// indicate that a valid target\r
-                                        /// address has been logged.\r
-\r
-  UINT64  RequesterIdentifier:1;        /// Bit61 Requester identifier: This\r
-                                        ///   bit is set to one to indicate that\r
-                                        ///   a valid requester identifier has\r
-                                        ///   been logged.\r
-\r
-  UINT64  ResponserIdentifier:1;        /// Bit62, Responder identifier:  This\r
-                                        ///   bit is set to one to indicate that\r
-                                        ///   a valid responder identifier has\r
-                                        ///   been logged.\r
-\r
-  UINT64  PreciseInsPointer:1;          /// Bit63 Precise instruction pointer.\r
-                                        ///   This bit is set to one to indicate\r
-                                        ///   that a valid precise instruction\r
-                                        ///   pointer has been logged.\r
+  UINT64  InstructionSet:1;             ///< Bit54, Instruction set. If this value\r
+                                        ///<   is set to zero, the instruction that\r
+                                        ///<   generated the machine check was an\r
+                                        ///<   Intel Itanium instruction. If this bit\r
+                                        ///<   is set to one, the instruction that\r
+                                        ///<   generated the machine check was IA-32\r
+                                        ///<   instruction.\r
+\r
+  UINT64  InstructionSetIsValid:1;      ///< Bit55, The is field in the\r
+                                        ///< TLB_check parameter is valid.\r
+\r
+  UINT64  PrivelegeLevel:2;             ///< Bit57:56, Privilege level. The\r
+                                        ///<   privilege level of the instruction\r
+                                        ///<   bundle responsible for generating the\r
+                                        ///<   machine check.\r
+\r
+  UINT64  PrivelegeLevelIsValid:1;      ///< Bit58,  The pl field of the\r
+                                        ///< TLB_check parameter is valid.\r
+\r
+  UINT64  McCorrected:1;                ///< Bit59, Machine check corrected: This bit\r
+                                        ///<   is set to one to indicate that the machine\r
+                                        ///<   check has been corrected.\r
+\r
+  UINT64  TargetAddressIsValid:1;       ///< Bit60, Target address is valid:\r
+                                        ///< This bit is set to one to\r
+                                        ///< indicate that a valid target\r
+                                        ///< address has been logged.\r
+\r
+  UINT64  RequesterIdentifier:1;        ///< Bit61 Requester identifier: This\r
+                                        ///<   bit is set to one to indicate that\r
+                                        ///<   a valid requester identifier has\r
+                                        ///<   been logged.\r
+\r
+  UINT64  ResponserIdentifier:1;        ///< Bit62, Responder identifier:  This\r
+                                        ///<   bit is set to one to indicate that\r
+                                        ///<   a valid responder identifier has\r
+                                        ///<   been logged.\r
+\r
+  UINT64  PreciseInsPointer:1;          ///< Bit63 Precise instruction pointer.\r
+                                        ///<   This bit is set to one to indicate\r
+                                        ///<   that a valid precise instruction\r
+                                        ///<   pointer has been logged.\r
 } PAL_TLB_CHECK_INFO;\r
 \r
 /**\r
 } PAL_TLB_CHECK_INFO;\r
 \r
 /**\r
@@ -2217,131 +2217,131 @@ typedef struct {
 #define PAL_TEST_INFO 37\r
 \r
 typedef struct {\r
 #define PAL_TEST_INFO 37\r
 \r
 typedef struct {\r
-  UINT64  BufferSize:56;    /// Indicates the size in bytes of the memory\r
-                            /// buffer that is passed to this procedure.\r
-                            /// BufferSize must be greater than or equal in\r
-                            /// size to the bytes_needed return value from\r
-                            /// PAL_TEST_INFO, otherwise this procedure will\r
-                            /// return with an invalid argument return\r
-                            /// value.\r
-\r
-  UINT64  TestPhase:8;      /// Defines which phase of the processor\r
-                            /// self-tests are requested to be run. A value\r
-                            /// of zero indicates to run phase two of the\r
-                            /// processor self-tests. Phase two of the\r
-                            /// processor self-tests are ones that require\r
-                            /// external memory to execute correctly. A\r
-                            /// value of one indicates to run phase one of\r
-                            /// the processor self-tests. Phase one of the\r
-                            /// processor self-tests are tests run during\r
-                            /// PALE_RESET and do not depend on external\r
-                            /// memory to run correctly. When the caller\r
-                            /// requests to have phase one of the processor\r
-                            /// self-test run via this procedure call, a\r
-                            /// memory buffer may be needed to save and\r
-                            /// restore state as required by the PAL calling\r
-                            /// conventions. The procedure PAL_TEST_INFO\r
-                            /// informs the caller about the requirements of\r
-                            /// the memory buffer.\r
+  UINT64  BufferSize:56;    ///< Indicates the size in bytes of the memory\r
+                            ///< buffer that is passed to this procedure.\r
+                            ///< BufferSize must be greater than or equal in\r
+                            ///< size to the bytes_needed return value from\r
+                            ///< PAL_TEST_INFO, otherwise this procedure will\r
+                            ///< return with an invalid argument return\r
+                            ///< value.\r
+\r
+  UINT64  TestPhase:8;      ///< Defines which phase of the processor\r
+                            ///< self-tests are requested to be run. A value\r
+                            ///< of zero indicates to run phase two of the\r
+                            ///< processor self-tests. Phase two of the\r
+                            ///< processor self-tests are ones that require\r
+                            ///< external memory to execute correctly. A\r
+                            ///< value of one indicates to run phase one of\r
+                            ///< the processor self-tests. Phase one of the\r
+                            ///< processor self-tests are tests run during\r
+                            ///< PALE_RESET and do not depend on external\r
+                            ///< memory to run correctly. When the caller\r
+                            ///< requests to have phase one of the processor\r
+                            ///< self-test run via this procedure call, a\r
+                            ///< memory buffer may be needed to save and\r
+                            ///< restore state as required by the PAL calling\r
+                            ///< conventions. The procedure PAL_TEST_INFO\r
+                            ///< informs the caller about the requirements of\r
+                            ///< the memory buffer.\r
 } PAL_TEST_INFO_INFO;\r
 \r
 typedef struct {\r
 } PAL_TEST_INFO_INFO;\r
 \r
 typedef struct {\r
-  UINT64  TestControl:47;       /// This is an ordered implementation-specific\r
-                                ///   control word that allows the user control\r
-                                ///   over the length and runtime of the\r
-                                ///   processor self-tests. This control word is\r
-                                ///   ordered from the longest running tests up\r
-                                ///   to the shortest running tests with bit 0\r
-                                ///   controlling the longest running test. PAL\r
-                                ///   may not implement all 47-bits of the\r
-                                ///   test_control word. PAL communicates if a\r
-                                ///   bit provides control by placing a zero in\r
-                                ///   that bit. If a bit provides no control,\r
-                                ///   PAL will place a one in it. PAL will have\r
-                                ///   two sets of test_control bits for the two\r
-                                ///   phases of the processor self-test. PAL\r
-                                ///   provides information about implemented\r
-                                ///   test_control bits at the hand-off from PAL\r
-                                ///   to SAL for the firmware recovery check.\r
-                                ///   These test_control bits provide control\r
-                                ///   for phase one of processor self-test. It\r
-                                ///   also provides this information via the PAL\r
-                                ///   procedure call PAL_TEST_INFO for both the\r
-                                ///   phase one and phase two processor tests\r
-                                ///   depending on which information the caller\r
-                                ///   is requesting. PAL interprets these bits\r
-                                ///   as input parameters on two occasions. The\r
-                                ///   first time is when SAL passes control back\r
-                                ///   to PAL after the firmware recovery check.\r
-                                ///   The second time is when a call to\r
-                                ///   PAL_TEST_PROC is made. When PAL interprets\r
-                                ///   these bits it will only interpret\r
-                                ///   implemented test_control bits and will\r
-                                ///   ignore the values located in the\r
-                                ///   unimplemented test_control bits. PAL\r
-                                ///   interprets the implemented bits such that\r
-                                ///   if a bit contains a zero, this indicates\r
-                                ///   to run the test. If a bit contains a one,\r
-                                ///   this indicates to PAL to skip the test. If\r
-                                ///   the cs bit indicates that control is not\r
-                                ///    available, the test_control bits will be\r
-                                ///   ignored or generate an illegal argument in\r
-                                ///   procedure calls if the caller sets these\r
-                                ///   bits.\r
+  UINT64  TestControl:47;       ///< This is an ordered implementation-specific\r
+                                ///<   control word that allows the user control\r
+                                ///<   over the length and runtime of the\r
+                                ///<   processor self-tests. This control word is\r
+                                ///<   ordered from the longest running tests up\r
+                                ///<   to the shortest running tests with bit 0\r
+                                ///<   controlling the longest running test. PAL\r
+                                ///<   may not implement all 47-bits of the\r
+                                ///<   test_control word. PAL communicates if a\r
+                                ///<   bit provides control by placing a zero in\r
+                                ///<   that bit. If a bit provides no control,\r
+                                ///<   PAL will place a one in it. PAL will have\r
+                                ///<   two sets of test_control bits for the two\r
+                                ///<   phases of the processor self-test. PAL\r
+                                ///<   provides information about implemented\r
+                                ///<   test_control bits at the hand-off from PAL\r
+                                ///<   to SAL for the firmware recovery check.\r
+                                ///<   These test_control bits provide control\r
+                                ///<   for phase one of processor self-test. It\r
+                                ///<   also provides this information via the PAL\r
+                                ///<   procedure call PAL_TEST_INFO for both the\r
+                                ///<   phase one and phase two processor tests\r
+                                ///<   depending on which information the caller\r
+                                ///<   is requesting. PAL interprets these bits\r
+                                ///<   as input parameters on two occasions. The\r
+                                ///<   first time is when SAL passes control back\r
+                                ///<   to PAL after the firmware recovery check.\r
+                                ///<   The second time is when a call to\r
+                                ///<   PAL_TEST_PROC is made. When PAL interprets\r
+                                ///<   these bits it will only interpret\r
+                                ///<   implemented test_control bits and will\r
+                                ///<   ignore the values located in the\r
+                                ///<   unimplemented test_control bits. PAL\r
+                                ///<   interprets the implemented bits such that\r
+                                ///<   if a bit contains a zero, this indicates\r
+                                ///<   to run the test. If a bit contains a one,\r
+                                ///<   this indicates to PAL to skip the test. If\r
+                                ///<   the cs bit indicates that control is not\r
+                                ///<    available, the test_control bits will be\r
+                                ///<   ignored or generate an illegal argument in\r
+                                ///<   procedure calls if the caller sets these\r
+                                ///<   bits.\r
                                 \r
                                 \r
-  UINT64  ControlSupport:1;     /// This bit defines if an implementation\r
-                                ///  supports control of the PAL self-tests\r
-                                ///  via the self-test control word. If\r
-                                ///  this bit is 0, the implementation does\r
-                                ///  not support control of the processor\r
-                                ///  self-tests via the self-test control\r
-                                ///  word. If this bit is 1, the\r
-                                ///  implementation does support control of\r
-                                ///  the processor self-tests via the\r
-                                ///  self-test control word. If control is\r
-                                ///  not supported, GR37 will be ignored at\r
-                                ///  the hand-off between SAL and PAL after\r
-                                ///  the firmware recovery check and the\r
-                                ///  PAL procedures related to the\r
-                                ///  processor self-tests may return\r
-                                ///  illegal arguments if a user tries to\r
-                                ///  use the self-test control features.\r
+  UINT64  ControlSupport:1;     ///< This bit defines if an implementation\r
+                                ///<  supports control of the PAL self-tests\r
+                                ///<  via the self-test control word. If\r
+                                ///<  this bit is 0, the implementation does\r
+                                ///<  not support control of the processor\r
+                                ///<  self-tests via the self-test control\r
+                                ///<  word. If this bit is 1, the\r
+                                ///<  implementation does support control of\r
+                                ///<  the processor self-tests via the\r
+                                ///<  self-test control word. If control is\r
+                                ///<  not supported, GR37 will be ignored at\r
+                                ///<  the hand-off between SAL and PAL after\r
+                                ///<  the firmware recovery check and the\r
+                                ///<  PAL procedures related to the\r
+                                ///<  processor self-tests may return\r
+                                ///<  illegal arguments if a user tries to\r
+                                ///<  use the self-test control features.\r
   UINT64  Reserved:16;\r
 } PAL_SELF_TEST_CONTROL;\r
 \r
 typedef struct {\r
   UINT64  Reserved:16;\r
 } PAL_SELF_TEST_CONTROL;\r
 \r
 typedef struct {\r
-  UINT64  Attributes:8;         /// Specifies the memory attributes that are\r
-                                ///  allowed to be used with the memory buffer\r
-                                ///  passed to this procedure. The attributes\r
-                                ///  parameter is a vector where each bit\r
-                                ///  represents one of the virtual memory\r
-                                ///  attributes defined by the architecture.See\r
-                                ///  MEMORY_AATRIBUTES. The caller is required\r
-                                ///  to support the cacheable attribute for the\r
-                                ///  memory buffer, otherwise an invalid\r
-                                ///  argument will be returned.\r
+  UINT64  Attributes:8;         ///< Specifies the memory attributes that are\r
+                                ///<  allowed to be used with the memory buffer\r
+                                ///<  passed to this procedure. The attributes\r
+                                ///<  parameter is a vector where each bit\r
+                                ///<  represents one of the virtual memory\r
+                                ///<  attributes defined by the architecture.See\r
+                                ///<  MEMORY_AATRIBUTES. The caller is required\r
+                                ///<  to support the cacheable attribute for the\r
+                                ///<  memory buffer, otherwise an invalid\r
+                                ///<  argument will be returned.\r
   UINT64  Reserved:8;\r
   UINT64  Reserved:8;\r
-  UINT64  TestControl:48;       /// Is the self-test control word\r
-                                ///  corresponding to the test_phase passed.\r
-                                ///  This test_control directs the coverage and\r
-                                ///  runtime of the processor self-tests\r
-                                ///  specified by the test_phase input\r
-                                ///  argument. Information on if this\r
-                                ///  feature is implemented and the number of\r
-                                ///  bits supported can be obtained by the\r
-                                ///  PAL_TEST_INFO procedure call. If this\r
-                                ///  feature is implemented by the processor,\r
-                                ///  the caller can selectively skip parts of\r
-                                ///  the processor self-test by setting\r
-                                ///  test_control bits to a one. If a bit has a\r
-                                ///  zero, this test will be run. The values in\r
-                                ///  the unimplemented bits are ignored. If\r
-                                ///  PAL_TEST_INFO indicated that the self-test\r
-                                ///  control word is not implemented, this\r
-                                ///  procedure will return with an invalid\r
-                                ///  argument status if the caller sets any of\r
-                                ///  the test_control bits. See\r
-                                ///  PAL_SELF_TEST_CONTROL.\r
+  UINT64  TestControl:48;       ///< Is the self-test control word\r
+                                ///<  corresponding to the test_phase passed.\r
+                                ///<  This test_control directs the coverage and\r
+                                ///<  runtime of the processor self-tests\r
+                                ///<  specified by the test_phase input\r
+                                ///<  argument. Information on if this\r
+                                ///<  feature is implemented and the number of\r
+                                ///<  bits supported can be obtained by the\r
+                                ///<  PAL_TEST_INFO procedure call. If this\r
+                                ///<  feature is implemented by the processor,\r
+                                ///<  the caller can selectively skip parts of\r
+                                ///<  the processor self-test by setting\r
+                                ///<  test_control bits to a one. If a bit has a\r
+                                ///<  zero, this test will be run. The values in\r
+                                ///<  the unimplemented bits are ignored. If\r
+                                ///<  PAL_TEST_INFO indicated that the self-test\r
+                                ///<  control word is not implemented, this\r
+                                ///<  procedure will return with an invalid\r
+                                ///<  argument status if the caller sets any of\r
+                                ///<  the test_control bits. See\r
+                                ///<  PAL_SELF_TEST_CONTROL.\r
 } PAL_TEST_CONTROL;\r
 \r
 /**\r
 } PAL_TEST_CONTROL;\r
 \r
 /**\r
@@ -2379,12 +2379,12 @@ typedef struct {
 #define PAL_TEST_PROC 258\r
 \r
 typedef struct {\r
 #define PAL_TEST_PROC 258\r
 \r
 typedef struct {\r
-  UINT32  NumberOfInterruptControllers;     /// Number of interrupt\r
-                                            /// controllers currently\r
-                                            /// enabled on the system.\r
+  UINT32  NumberOfInterruptControllers;     ///< Number of interrupt\r
+                                            ///< controllers currently\r
+                                            ///< enabled on the system.\r
 \r
 \r
-  UINT32  NumberOfProcessors;               /// Number of processors currently\r
-                                            /// enabled on the system.\r
+  UINT32  NumberOfProcessors;               ///< Number of processors currently\r
+                                            ///< enabled on the system.\r
 } PAL_PLATFORM_INFO;\r
 \r
 /**\r
 } PAL_PLATFORM_INFO;\r
 \r
 /**\r
@@ -2659,150 +2659,150 @@ typedef struct {
 #define PAL_SET_HW_POLICY   49\r
 \r
 typedef struct {\r
 #define PAL_SET_HW_POLICY   49\r
 \r
 typedef struct {\r
-  UINT64  Mode:3;                   /// Bit2:0, Indicates the mode of operation for this\r
-                                    ///    procedure: 0 - Query mode 1 - Error inject mode\r
-                                    ///    (err_inj should also be specified) 2 - Cancel\r
-                                    ///    outstanding trigger. All other fields in\r
-                                    ///    PAL_MC_ERROR_TYPE_INFO,\r
-                                    ///    PAL_MC_ERROR_STRUCTURE_INFO and\r
-                                    ///    PAL_MC_ERROR_DATA_BUFFER are ignored. All other\r
-                                    ///    values are reserved.\r
-\r
-  UINT64  ErrorInjection:3;         /// Bit5:3, indicates the mode of error\r
-                                    ///  injection: 0 - Error inject only (no\r
-                                    ///  error consumption) 1 - Error inject\r
-                                    ///  and consume All other values are\r
-                                    ///  reserved.\r
-\r
-  UINT64  ErrorSeverity:2;          /// Bit7:6, indicates the severity desired\r
-                                    ///  for error injection/query. Definitions\r
-                                    ///  of the different error severity types\r
-                                    ///  0 - Corrected error 1 - Recoverable\r
-                                    ///  error 2 - Fatal error 3 - Reserved\r
-\r
-  UINT64  ErrorStructure:5;         /// Bit12:8, Indicates the structure\r
-                                    ///  identification for error\r
-                                    ///  injection/query: 0 - Any structure\r
-                                    ///  (cannot be used during query mode).\r
-                                    ///  When selected, the structure type used\r
-                                    ///  for error injection is determined by\r
-                                    ///  PAL. 1 - Cache 2 - TLB 3 - Register\r
-                                    ///  file 4 - Bus/System interconnect 5-15\r
-                                    ///  - Reserved 16-31 - Processor\r
-                                    ///  specific error injection\r
-                                    ///  capabilities.ErrorDataBuffer is used\r
-                                    ///  to specify error types. Please refer\r
-                                    ///  to the processor specific\r
-                                    ///  documentation for additional details.\r
-\r
-  UINT64  StructureHierarchy:3;     /// Bit15:13, Indicates the structure\r
-                                    ///  hierarchy for error\r
-                                    ///  injection/query: 0 - Any level of\r
-                                    ///  hierarchy (cannot be used during\r
-                                    ///  query mode). When selected, the\r
-                                    ///  structure hierarchy used for error\r
-                                    ///  injection is determined by PAL. 1\r
-                                    ///  - Error structure hierarchy\r
-                                    ///  level-1 2 - Error structure\r
-                                    ///  hierarchy level-2 3 - Error\r
-                                    ///  structure hierarchy level-3 4 -\r
-                                    ///  Error structure hierarchy level-4\r
-                                    ///  All other values are reserved.\r
-                                    ///  Reserved 63:16 Reserved\r
+  UINT64  Mode:3;                   ///< Bit2:0, Indicates the mode of operation for this\r
+                                    ///<    procedure: 0 - Query mode 1 - Error inject mode\r
+                                    ///<    (err_inj should also be specified) 2 - Cancel\r
+                                    ///<    outstanding trigger. All other fields in\r
+                                    ///<    PAL_MC_ERROR_TYPE_INFO,\r
+                                    ///<    PAL_MC_ERROR_STRUCTURE_INFO and\r
+                                    ///<    PAL_MC_ERROR_DATA_BUFFER are ignored. All other\r
+                                    ///<    values are reserved.\r
+\r
+  UINT64  ErrorInjection:3;         ///< Bit5:3, indicates the mode of error\r
+                                    ///<  injection: 0 - Error inject only (no\r
+                                    ///<  error consumption) 1 - Error inject\r
+                                    ///<  and consume All other values are\r
+                                    ///<  reserved.\r
+\r
+  UINT64  ErrorSeverity:2;          ///< Bit7:6, indicates the severity desired\r
+                                    ///<  for error injection/query. Definitions\r
+                                    ///<  of the different error severity types\r
+                                    ///<  0 - Corrected error 1 - Recoverable\r
+                                    ///<  error 2 - Fatal error 3 - Reserved\r
+\r
+  UINT64  ErrorStructure:5;         ///< Bit12:8, Indicates the structure\r
+                                    ///<  identification for error\r
+                                    ///<  injection/query: 0 - Any structure\r
+                                    ///<  (cannot be used during query mode).\r
+                                    ///<  When selected, the structure type used\r
+                                    ///<  for error injection is determined by\r
+                                    ///<  PAL. 1 - Cache 2 - TLB 3 - Register\r
+                                    ///<  file 4 - Bus/System interconnect 5-15\r
+                                    ///<  - Reserved 16-31 - Processor\r
+                                    ///<  specific error injection\r
+                                    ///<  capabilities.ErrorDataBuffer is used\r
+                                    ///<  to specify error types. Please refer\r
+                                    ///<  to the processor specific\r
+                                    ///<  documentation for additional details.\r
+\r
+  UINT64  StructureHierarchy:3;     ///< Bit15:13, Indicates the structure\r
+                                    ///<  hierarchy for error\r
+                                    ///<  injection/query: 0 - Any level of\r
+                                    ///<  hierarchy (cannot be used during\r
+                                    ///<  query mode). When selected, the\r
+                                    ///<  structure hierarchy used for error\r
+                                    ///<  injection is determined by PAL. 1\r
+                                    ///<  - Error structure hierarchy\r
+                                    ///<  level-1 2 - Error structure\r
+                                    ///<  hierarchy level-2 3 - Error\r
+                                    ///<  structure hierarchy level-3 4 -\r
+                                    ///<  Error structure hierarchy level-4\r
+                                    ///<  All other values are reserved.\r
+                                    ///<  Reserved 63:16 Reserved\r
 \r
   UINT64  Reserved:48;\r
 } PAL_MC_ERROR_TYPE_INFO;\r
 \r
 typedef struct {\r
 \r
   UINT64  Reserved:48;\r
 } PAL_MC_ERROR_TYPE_INFO;\r
 \r
 typedef struct {\r
-  UINT64  StructInfoIsValid:1;              /// Bit0 When 1, indicates that the\r
-                                            /// structure information fields\r
-                                            /// (c_t,cl_p,cl_id) are valid and\r
-                                            /// should be used for error injection.\r
-                                            /// When 0, the structure information\r
-                                            /// fields are ignored, and the values\r
-                                            /// of these fields used for error\r
-                                            /// injection are\r
-                                            /// implementation-specific.\r
-\r
-  UINT64  CacheType:2;                      /// Bit2:1  Indicates which cache should be used\r
-                                            /// for error injection: 0 - Reserved 1 -\r
-                                            /// Instruction cache 2 - Data or unified cache\r
-                                            /// 3 - Reserved\r
-\r
-  UINT64  PortionOfCacheLine:3;             /// Bit5:3 Indicates the portion of the\r
-                                            ///   cache line where the error should\r
-                                            ///   be injected: 0 - Reserved 1 - Tag\r
-                                            ///   2 - Data 3 - mesi All other\r
-                                            ///   values are reserved.\r
-\r
-  UINT64  Mechanism:3;                      /// Bit8:6 Indicates which mechanism is used to\r
-                                            /// identify the cache line to be used for error\r
-                                            /// injection: 0 - Reserved 1 - Virtual address\r
-                                            /// provided in the inj_addr field of the buffer\r
-                                            /// pointed to by err_data_buffer should be used\r
-                                            /// to identify the cache line for error\r
-                                            /// injection. 2 - Physical address provided in\r
-                                            /// the inj_addr field of the buffer pointed to\r
-                                            /// by err_data_buffershould be used to identify\r
-                                            /// the cache line for error injection. 3 - way\r
-                                            /// and index fields provided in err_data_buffer\r
-                                            /// should be used to identify the cache line\r
-                                            /// for error injection. All other values are\r
-                                            /// reserved.\r
-\r
-  UINT64  DataPoisonOfCacheLine:1;          /// Bit9 When 1, indicates that a\r
-                                            /// multiple bit, non-correctable\r
-                                            /// error should be injected in the\r
-                                            /// cache line specified by cl_id.\r
-                                            /// If this injected error is not\r
-                                            /// consumed, it may eventually\r
-                                            /// cause a data-poisoning event\r
-                                            /// resulting in a corrected error\r
-                                            /// signal, when the associated\r
-                                            /// cache line is cast out (implicit\r
-                                            /// or explicit write-back of the\r
-                                            /// cache line). The error severity\r
-                                            /// specified by err_sev in\r
-                                            /// err_type_info must be set to 0\r
-                                            /// (corrected error) when this bit\r
-                                            /// is set.\r
+  UINT64  StructInfoIsValid:1;              ///< Bit0 When 1, indicates that the\r
+                                            ///< structure information fields\r
+                                            ///< (c_t,cl_p,cl_id) are valid and\r
+                                            ///< should be used for error injection.\r
+                                            ///< When 0, the structure information\r
+                                            ///< fields are ignored, and the values\r
+                                            ///< of these fields used for error\r
+                                            ///< injection are\r
+                                            ///< implementation-specific.\r
+\r
+  UINT64  CacheType:2;                      ///< Bit2:1  Indicates which cache should be used\r
+                                            ///< for error injection: 0 - Reserved 1 -\r
+                                            ///< Instruction cache 2 - Data or unified cache\r
+                                            ///< 3 - Reserved\r
+\r
+  UINT64  PortionOfCacheLine:3;             ///< Bit5:3 Indicates the portion of the\r
+                                            ///<   cache line where the error should\r
+                                            ///<   be injected: 0 - Reserved 1 - Tag\r
+                                            ///<   2 - Data 3 - mesi All other\r
+                                            ///<   values are reserved.\r
+\r
+  UINT64  Mechanism:3;                      ///< Bit8:6 Indicates which mechanism is used to\r
+                                            ///< identify the cache line to be used for error\r
+                                            ///< injection: 0 - Reserved 1 - Virtual address\r
+                                            ///< provided in the inj_addr field of the buffer\r
+                                            ///< pointed to by err_data_buffer should be used\r
+                                            ///< to identify the cache line for error\r
+                                            ///< injection. 2 - Physical address provided in\r
+                                            ///< the inj_addr field of the buffer pointed to\r
+                                            ///< by err_data_buffershould be used to identify\r
+                                            ///< the cache line for error injection. 3 - way\r
+                                            ///< and index fields provided in err_data_buffer\r
+                                            ///< should be used to identify the cache line\r
+                                            ///< for error injection. All other values are\r
+                                            ///< reserved.\r
+\r
+  UINT64  DataPoisonOfCacheLine:1;          ///< Bit9 When 1, indicates that a\r
+                                            ///< multiple bit, non-correctable\r
+                                            ///< error should be injected in the\r
+                                            ///< cache line specified by cl_id.\r
+                                            ///< If this injected error is not\r
+                                            ///< consumed, it may eventually\r
+                                            ///< cause a data-poisoning event\r
+                                            ///< resulting in a corrected error\r
+                                            ///< signal, when the associated\r
+                                            ///< cache line is cast out (implicit\r
+                                            ///< or explicit write-back of the\r
+                                            ///< cache line). The error severity\r
+                                            ///< specified by err_sev in\r
+                                            ///< err_type_info must be set to 0\r
+                                            ///< (corrected error) when this bit\r
+                                            ///< is set.\r
 \r
   UINT64  Reserved1:22;\r
 \r
 \r
   UINT64  Reserved1:22;\r
 \r
-  UINT64  TrigerInfoIsValid:1;              /// Bit32 When 1, indicates that the\r
-                                            /// trigger information fields (trigger,\r
-                                            /// trigger_pl) are valid and should be\r
-                                            /// used for error injection. When 0,\r
-                                            /// the trigger information fields are\r
-                                            /// ignored and error injection is\r
-                                            /// performed immediately.\r
-\r
-  UINT64  Triger:4;                         /// Bit36:33 Indicates the operation type to be\r
-                                            ///   used as the error trigger condition. The\r
-                                            ///   address corresponding to the trigger is\r
-                                            ///   specified in the trigger_addr field of the\r
-                                            ///   buffer pointed to by err_data_buffer: 0 -\r
-                                            ///   Instruction memory access. The trigger match\r
-                                            ///   conditions for this operation type are similar\r
-                                            ///   to the IBR address breakpoint match conditions\r
-                                            ///   1 - Data memory access. The trigger match\r
-                                            ///   conditions for this operation type are similar\r
-                                            ///   to the DBR address breakpoint match conditions\r
-                                            ///   All other values are reserved.\r
-\r
-  UINT64  PrivilegeOfTriger:3;              /// Bit39:37  Indicates the privilege\r
-                                            /// level of the context during which\r
-                                            /// the error should be injected: 0 -\r
-                                            /// privilege level 0 1 - privilege\r
-                                            /// level 1 2 - privilege level 2 3 -\r
-                                            /// privilege level 3 All other values\r
-                                            /// are reserved. If the implementation\r
-                                            /// does not support privilege level\r
-                                            /// qualifier for triggers (i.e. if\r
-                                            /// trigger_pl is 0 in the capabilities\r
-                                            /// vector), this field is ignored and\r
-                                            /// triggers can be taken at any\r
-                                            /// privilege level.\r
+  UINT64  TrigerInfoIsValid:1;              ///< Bit32 When 1, indicates that the\r
+                                            ///< trigger information fields (trigger,\r
+                                            ///< trigger_pl) are valid and should be\r
+                                            ///< used for error injection. When 0,\r
+                                            ///< the trigger information fields are\r
+                                            ///< ignored and error injection is\r
+                                            ///< performed immediately.\r
+\r
+  UINT64  Triger:4;                         ///< Bit36:33 Indicates the operation type to be\r
+                                            ///<   used as the error trigger condition. The\r
+                                            ///<   address corresponding to the trigger is\r
+                                            ///<   specified in the trigger_addr field of the\r
+                                            ///<   buffer pointed to by err_data_buffer: 0 -\r
+                                            ///<   Instruction memory access. The trigger match\r
+                                            ///<   conditions for this operation type are similar\r
+                                            ///<   to the IBR address breakpoint match conditions\r
+                                            ///<   1 - Data memory access. The trigger match\r
+                                            ///<   conditions for this operation type are similar\r
+                                            ///<   to the DBR address breakpoint match conditions\r
+                                            ///<   All other values are reserved.\r
+\r
+  UINT64  PrivilegeOfTriger:3;              ///< Bit39:37  Indicates the privilege\r
+                                            ///< level of the context during which\r
+                                            ///< the error should be injected: 0 -\r
+                                            ///< privilege level 0 1 - privilege\r
+                                            ///< level 1 2 - privilege level 2 3 -\r
+                                            ///< privilege level 3 All other values\r
+                                            ///< are reserved. If the implementation\r
+                                            ///< does not support privilege level\r
+                                            ///< qualifier for triggers (i.e. if\r
+                                            ///< trigger_pl is 0 in the capabilities\r
+                                            ///< vector), this field is ignored and\r
+                                            ///< triggers can be taken at any\r
+                                            ///< privilege level.\r
 \r
   UINT64  Reserved2:24;\r
 } PAL_MC_ERROR_STRUCT_INFO;\r
 \r
   UINT64  Reserved2:24;\r
 } PAL_MC_ERROR_STRUCT_INFO;\r
index 89142c1f85d20d5862c759d784323fd0750275da..fd2c253464959b95721ca292cc91bf6cbf0825e3 100644 (file)
@@ -1,5 +1,6 @@
 /** @file\r
 /** @file\r
-  This file declares the SMBus definitions defined in SmBus Specifciation V2.0.\r
+  This file declares the SMBus definitions defined in SmBus Specifciation V2.0\r
+  and defined in PI1.0 specification volume 5.\r
 \r
   Copyright (c) 2007 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
 \r
   Copyright (c) 2007 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -34,14 +35,16 @@ typedef struct {
 /// Smbus Device Address\r
 ///\r
 typedef struct {\r
 /// Smbus Device Address\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// The SMBUS hardware address to which the SMBUS device is preassigned or allocated.\r
+  ///\r
   UINTN SmbusDeviceAddress : 7;\r
 } EFI_SMBUS_DEVICE_ADDRESS;\r
 \r
 ///\r
 /// Smbus Operations\r
 ///\r
   UINTN SmbusDeviceAddress : 7;\r
 } EFI_SMBUS_DEVICE_ADDRESS;\r
 \r
 ///\r
 /// Smbus Operations\r
 ///\r
-typedef enum _EFI_SMBUS_OPERATION\r
-{\r
+typedef enum _EFI_SMBUS_OPERATION {\r
   EfiSmbusQuickRead,\r
   EfiSmbusQuickWrite,\r
   EfiSmbusReceiveByte,\r
   EfiSmbusQuickRead,\r
   EfiSmbusQuickWrite,\r
   EfiSmbusReceiveByte,\r
@@ -56,5 +59,10 @@ typedef enum _EFI_SMBUS_OPERATION
   EfiSmbusBWBRProcessCall\r
 } EFI_SMBUS_OPERATION;\r
 \r
   EfiSmbusBWBRProcessCall\r
 } EFI_SMBUS_OPERATION;\r
 \r
+///\r
+/// EFI_SMBUS_DEVICE_COMMAND\r
+///\r
+typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;\r
+\r
 #endif\r
 \r
 #endif\r
 \r
index 21778ae491c7cd57a3e2791c368899755273f745..175b2b70a79a86bf3e59ceb2b59998d8f2607a75 100644 (file)
 \r
 typedef struct _EFI_PEI_SMBUS2_PPI EFI_PEI_SMBUS2_PPI;\r
 \r
 \r
 typedef struct _EFI_PEI_SMBUS2_PPI EFI_PEI_SMBUS2_PPI;\r
 \r
-//\r
-// EFI_SMBUS_DEVICE_COMMAND\r
-//\r
-typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;\r
-\r
-\r
 /**\r
   Executes an SMBus operation to an SMBus controller. Returns when either \r
   the command has been executed or an error is encountered in doing the operation.\r
 /**\r
   Executes an SMBus operation to an SMBus controller. Returns when either \r
   the command has been executed or an error is encountered in doing the operation.\r
index b59ca4d52e600f75bb279e5e909edfe7b7ee329b..3203f79dd039392f962ef90484b975513014fc38 100644 (file)
@@ -444,12 +444,12 @@ typedef struct {
 #define EXCEPT_EBC_DEBUG                2\r
 #define EXCEPT_EBC_BREAKPOINT           3\r
 #define EXCEPT_EBC_OVERFLOW             4\r
 #define EXCEPT_EBC_DEBUG                2\r
 #define EXCEPT_EBC_BREAKPOINT           3\r
 #define EXCEPT_EBC_OVERFLOW             4\r
-#define EXCEPT_EBC_INVALID_OPCODE       5   /// opcode out of range\r
+#define EXCEPT_EBC_INVALID_OPCODE       5   ///< opcode out of range\r
 #define EXCEPT_EBC_STACK_FAULT          6\r
 #define EXCEPT_EBC_ALIGNMENT_CHECK      7\r
 #define EXCEPT_EBC_STACK_FAULT          6\r
 #define EXCEPT_EBC_ALIGNMENT_CHECK      7\r
-#define EXCEPT_EBC_INSTRUCTION_ENCODING 8   /// malformed instruction\r
-#define EXCEPT_EBC_BAD_BREAK            9   /// BREAK 0 or undefined BREAK\r
-#define EXCEPT_EBC_STEP                 10  /// to support debug stepping\r
+#define EXCEPT_EBC_INSTRUCTION_ENCODING 8   ///< malformed instruction\r
+#define EXCEPT_EBC_BAD_BREAK            9   ///< BREAK 0 or undefined BREAK\r
+#define EXCEPT_EBC_STEP                 10  ///< to support debug stepping\r
 ///\r
 /// For coding convenience, define the maximum valid EBC exception.\r
 ///\r
 ///\r
 /// For coding convenience, define the maximum valid EBC exception.\r
 ///\r
index b5ce7378cfc0b936f9259b318fc32121987ea853..16e8eb4289e3f6c316a7fd8a84f3174bb1223bb2 100644 (file)
@@ -839,7 +839,7 @@ typedef struct {
 //\r
 // Use VENDOR_DEVICE_PATH struct\r
 //\r
 //\r
 // Use VENDOR_DEVICE_PATH struct\r
 //\r
-#define MEDIA_VENDOR_DP           0x03  /// Media vendor device path subtype\r
+#define MEDIA_VENDOR_DP           0x03  ///< Media vendor device path subtype\r
 \r
 ///\r
 /// File Path Media Device Path SubType\r
 \r
 ///\r
 /// File Path Media Device Path SubType\r
index fc743305baaf1bc11183f53fa959f6066d84962d..07767f3c701413e6b190364bc5626cb635bfaa7b 100644 (file)
@@ -418,9 +418,9 @@ EFI_STATUS
   OUT       UINT32                        *AuthenticationStatus\r
 );\r
 \r
   OUT       UINT32                        *AuthenticationStatus\r
 );\r
 \r
-//\r
-// EFI_FV_WRITE_POLICY\r
-//\r
+///\r
+/// EFI_FV_WRITE_POLICY, two policies (unreliable write and reliable write) are defined.\r
+///\r
 typedef UINT32 EFI_FV_WRITE_POLICY;\r
 #define EFI_FV_UNRELIABLE_WRITE   0x00000000\r
 #define EFI_FV_RELIABLE_WRITE     0x00000001\r
 typedef UINT32 EFI_FV_WRITE_POLICY;\r
 #define EFI_FV_UNRELIABLE_WRITE   0x00000000\r
 #define EFI_FV_RELIABLE_WRITE     0x00000001\r
index dd19f29012264ec6fd473129a77cec74a532357a..9145089734ecff62029e8f18d19221a976e6e82f 100644 (file)
@@ -62,8 +62,9 @@ typedef struct _EFI_HII_ROW_INFO {
 } EFI_HII_ROW_INFO;\r
 \r
 ///\r
 } EFI_HII_ROW_INFO;\r
 \r
 ///\r
-/// EFI_FONT_INFO_MASK\r
-/// \r
+/// Font info flag. All flags (FONT, SIZE, STYLE, and COLOR) are defined.\r
+/// They are defined as EFI_FONT_INFO_***\r
+///\r
 typedef UINT32  EFI_FONT_INFO_MASK;\r
 \r
 #define EFI_FONT_INFO_SYS_FONT        0x00000001\r
 typedef UINT32  EFI_FONT_INFO_MASK;\r
 \r
 #define EFI_FONT_INFO_SYS_FONT        0x00000001\r
@@ -87,6 +88,8 @@ typedef struct {
 } EFI_FONT_INFO;\r
 \r
 /**\r
 } EFI_FONT_INFO;\r
 \r
 /**\r
+  Describes font output-related information.\r
+\r
   This structure is used for describing the way in which a string\r
   should be rendered in a particular font. FontInfo specifies the\r
   basic font information and ForegroundColor and BackgroundColor\r
   This structure is used for describing the way in which a string\r
   should be rendered in a particular font. FontInfo specifies the\r
   basic font information and ForegroundColor and BackgroundColor\r
@@ -94,34 +97,7 @@ typedef struct {
   in FontInfoMask describe where the system default should be\r
   supplied instead of the specified information. The flags also\r
   describe what options can be used to make a match between the\r
   in FontInfoMask describe where the system default should be\r
   supplied instead of the specified information. The flags also\r
   describe what options can be used to make a match between the\r
-  font requested and the font available. If EFI_FONT_INFO_SYS_FONT\r
-  is specified, then the font name in FontInfo is ignored and the\r
-  system font name is used. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_FONT. If EFI_FONT_INFO_SYS_SIZE is specified,\r
-  then the font height specified in FontInfo is ignored and the\r
-  system font height is used instead. This flag cannot be used\r
-  with EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_SYS_STYLE is\r
-  specified, then the font style in FontInfo is ignored and the\r
-  system font style is used. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_SYS_FORE_COLOR is\r
-  specified, then ForegroundColor is ignored and the system\r
-  foreground color is used. If EFI_FONT_INFO_SYS_BACK_COLOR is\r
-  specified, then BackgroundColor is ignored and the system\r
-  background color is used. If EFI_FONT_INFO_RESIZE is specified,\r
-  then the system may attempt to stretch or shrink a font to meet\r
-  the size requested. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_RESTYLE is specified,\r
-  then the system may attempt to remove some of the specified\r
-  styles in order to meet the style requested. This flag cannot be\r
-  used with EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_ANY_FONT is\r
-  specified, then the system may attempt to match with any font.\r
-  This flag cannot be used with EFI_FONT_INFO_SYS_FONT. If\r
-  EFI_FONT_INFO_ANY_SIZE is specified, then the system may attempt\r
-  to match with any font size. This flag cannot be used with\r
-  EFI_FONT_INFO_SYS_SIZE or EFI_FONT_INFO_RESIZE. If\r
-  EFI_FONT_INFO_ANY_STYLE is specified, then the system may\r
-  attempt to match with any font style. This flag cannot be used\r
-  with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r
+  font requested and the font available.\r
 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
index 624b354134b47aed15e4e06e083291600377d128..412dcccfa4438953159fe8b8370f3adc02398178 100644 (file)
@@ -160,9 +160,10 @@ EFI_STATUS
 );\r
 \r
 \r
 );\r
 \r
 \r
-//\r
-// EFI_HII_DRAW_FLAGS\r
-// \r
+///\r
+/// EFI_HII_DRAW_FLAGS describes how the image is to be drawn.\r
+/// These flags are defined as EFI_HII_DRAW_FLAG_***\r
+///\r
 typedef UINT32  EFI_HII_DRAW_FLAGS;\r
 \r
 #define EFI_HII_DRAW_FLAG_CLIP          0x00000001\r
 typedef UINT32  EFI_HII_DRAW_FLAGS;\r
 \r
 #define EFI_HII_DRAW_FLAG_CLIP          0x00000001\r
@@ -172,7 +173,6 @@ typedef UINT32  EFI_HII_DRAW_FLAGS;
 #define EFI_HII_DRAW_FLAG_FORCE_OPAQUE  0x00000020\r
 #define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
 \r
 #define EFI_HII_DRAW_FLAG_FORCE_OPAQUE  0x00000020\r
 #define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
 \r
-\r
 /**\r
    \r
   Definition of EFI_IMAGE_OUTPUT.\r
 /**\r
    \r
   Definition of EFI_IMAGE_OUTPUT.\r
index d19cc7b34d380d8626b2beaabe9629f61de4dd23..ab598484af3d95234aa55e4e1e10cdd275518364 100644 (file)
@@ -52,19 +52,74 @@ typedef struct {
 } EFI_IP4_VARIABLE_DATA;\r
 \r
 typedef struct {\r
 } EFI_IP4_VARIABLE_DATA;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The default IPv4 protocol packets to send and receive. Ignored\r
+  /// when AcceptPromiscuous is TRUE.\r
+  ///\r
   UINT8                   DefaultProtocol;\r
   UINT8                   DefaultProtocol;\r
+  ///\r
+  /// Set to TRUE to receive all IPv4 packets that get through the receive filters.\r
+  /// Set to FALSE to receive only the DefaultProtocol IPv4\r
+  /// packets that get through the receive filters.\r
+  ///\r
   BOOLEAN                 AcceptAnyProtocol;\r
   BOOLEAN                 AcceptAnyProtocol;\r
+  ///\r
+  /// Set to TRUE to receive ICMP error report packets. Ignored when\r
+  /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.\r
+  ///\r
   BOOLEAN                 AcceptIcmpErrors;\r
   BOOLEAN                 AcceptIcmpErrors;\r
+  ///\r
+  /// Set to TRUE to receive broadcast IPv4 packets. Ignored when\r
+  /// AcceptPromiscuous is TRUE.\r
+  /// Set to FALSE to stop receiving broadcast IPv4 packets.\r
+  ///\r
   BOOLEAN                 AcceptBroadcast;\r
   BOOLEAN                 AcceptBroadcast;\r
+  ///\r
+  /// Set to TRUE to receive all IPv4 packets that are sent to any\r
+  /// hardware address or any protocol address.\r
+  /// Set to FALSE to stop receiving all promiscuous IPv4 packets\r
+  ///\r
   BOOLEAN                 AcceptPromiscuous;\r
   BOOLEAN                 AcceptPromiscuous;\r
+  ///\r
+  /// Set to TRUE to use the default IPv4 address and default routing table.\r
+  ///\r
   BOOLEAN                 UseDefaultAddress;\r
   BOOLEAN                 UseDefaultAddress;\r
+  ///\r
+  /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.\r
+  ///\r
   EFI_IPv4_ADDRESS        StationAddress;\r
   EFI_IPv4_ADDRESS        StationAddress;\r
+  ///\r
+  /// The subnet address mask that is associated with the station address.\r
+  ///\r
   EFI_IPv4_ADDRESS        SubnetMask;\r
   EFI_IPv4_ADDRESS        SubnetMask;\r
+  ///\r
+  /// TypeOfService field in transmitted IPv4 packets.\r
+  ///\r
   UINT8                   TypeOfService;\r
   UINT8                   TypeOfService;\r
+  ///\r
+  /// TimeToLive field in transmitted IPv4 packets.\r
+  ///\r
   UINT8                   TimeToLive;\r
   UINT8                   TimeToLive;\r
+  ///\r
+  /// State of the DoNotFragment bit in transmitted IPv4 packets.\r
+  ///\r
   BOOLEAN                 DoNotFragment;\r
   BOOLEAN                 DoNotFragment;\r
+  ///\r
+  /// Set to TRUE to send and receive unformatted packets. The other\r
+  /// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.\r
+  ///\r
   BOOLEAN                 RawData;\r
   BOOLEAN                 RawData;\r
+  ///\r
+  /// The timer timeout value (number of microseconds) for the\r
+  /// receive timeout event to be associated with each assembled\r
+  /// packet. Zero means do not drop assembled packets.\r
+  ///\r
   UINT32                  ReceiveTimeout;\r
   UINT32                  ReceiveTimeout;\r
+  ///\r
+  /// The timer timeout value (number of microseconds) for the\r
+  /// transmit timeout event to be associated with each outgoing\r
+  /// packet. Zero means do not drop outgoing packets.\r
+  ///\r
   UINT32                  TransmitTimeout;\r
 } EFI_IP4_CONFIG_DATA;\r
 \r
   UINT32                  TransmitTimeout;\r
 } EFI_IP4_CONFIG_DATA;\r
 \r
@@ -81,14 +136,41 @@ typedef struct {
 } EFI_IP4_ICMP_TYPE;\r
 \r
 typedef struct {\r
 } EFI_IP4_ICMP_TYPE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.\r
+  ///\r
   BOOLEAN                 IsStarted;\r
   BOOLEAN                 IsStarted;\r
+  ///\r
+  /// Current configuration settings.\r
+  ///\r
   EFI_IP4_CONFIG_DATA     ConfigData;\r
   EFI_IP4_CONFIG_DATA     ConfigData;\r
+  ///\r
+  /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.\r
+  ///\r
   BOOLEAN                 IsConfigured;\r
   BOOLEAN                 IsConfigured;\r
+  ///\r
+  /// Number of joined multicast groups.\r
+  ///\r
   UINT32                  GroupCount;\r
   UINT32                  GroupCount;\r
+  ///\r
+  /// List of joined multicast group addresses.\r
+  ///\r
   EFI_IPv4_ADDRESS        *GroupTable;\r
   EFI_IPv4_ADDRESS        *GroupTable;\r
+  ///\r
+  /// Number of entries in the routing table.\r
+  ///\r
   UINT32                  RouteCount;\r
   UINT32                  RouteCount;\r
+  ///\r
+  /// Routing table entries.\r
+  ///\r
   EFI_IP4_ROUTE_TABLE     *RouteTable;\r
   EFI_IP4_ROUTE_TABLE     *RouteTable;\r
+  ///\r
+  /// Number of entries in the supported ICMP types list.\r
+  ///\r
   UINT32                  IcmpTypeCount;\r
   UINT32                  IcmpTypeCount;\r
+  ///\r
+  /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver\r
+  ///\r
   EFI_IP4_ICMP_TYPE       *IcmpTypeList;\r
 } EFI_IP4_MODE_DATA;\r
 \r
   EFI_IP4_ICMP_TYPE       *IcmpTypeList;\r
 } EFI_IP4_MODE_DATA;\r
 \r
@@ -149,10 +231,26 @@ typedef struct {
 } EFI_IP4_TRANSMIT_DATA;\r
 \r
 typedef struct {\r
 } EFI_IP4_TRANSMIT_DATA;\r
 \r
 typedef struct {\r
+  ///\r
+  /// This Event will be signaled after the Status field is updated\r
+  /// by the EFI IPv4 Protocol driver. The type of Event must be\r
+  /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+  /// Event must be lower than or equal to TPL_CALLBACK.\r
+  ///\r
   EFI_EVENT                Event;\r
   EFI_EVENT                Event;\r
+  ///\r
+  /// The status that is returned to the caller at the end of the operation\r
+  /// to indicate whether this operation completed successfully.\r
+  ///\r
   EFI_STATUS               Status;\r
   union {\r
   EFI_STATUS               Status;\r
   union {\r
+    ///\r
+    /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.\r
+    ///\r
     EFI_IP4_RECEIVE_DATA   *RxData;\r
     EFI_IP4_RECEIVE_DATA   *RxData;\r
+    ///\r
+    /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.\r
+    ///\r
     EFI_IP4_TRANSMIT_DATA  *TxData;\r
   } Packet;\r
 } EFI_IP4_COMPLETION_TOKEN;\r
     EFI_IP4_TRANSMIT_DATA  *TxData;\r
   } Packet;\r
 } EFI_IP4_COMPLETION_TOKEN;\r
index 1871489d3016270bda80ba8661ecf9c77b640122..d195ba7e66eb99724670c7d044090a943ef97e09 100644 (file)
@@ -30,10 +30,22 @@ typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL;
          EFI_VARIABLE_RUNTIME_ACCESS)\r
 \r
 typedef struct {\r
          EFI_VARIABLE_RUNTIME_ACCESS)\r
 \r
 typedef struct {\r
+  ///\r
+  /// Default station IP address, stored in network byte order.\r
+  ///\r
   EFI_IPv4_ADDRESS             StationAddress;\r
   EFI_IPv4_ADDRESS             StationAddress;\r
+  ///\r
+  /// Default subnet mask, stored in network byte order.\r
+  ///\r
   EFI_IPv4_ADDRESS             SubnetMask;\r
   EFI_IPv4_ADDRESS             SubnetMask;\r
+  ///\r
+  /// Number of entries in the following RouteTable. May be zero.\r
+  ///\r
   UINT32                       RouteTableSize;\r
   UINT32                       RouteTableSize;\r
-  EFI_IP4_ROUTE_TABLE          *RouteTable;    //OPTIONAL\r
+  ///\r
+  /// Default routing table data (stored in network byte order).\r
+  ///\r
+  EFI_IP4_ROUTE_TABLE          *RouteTable;\r
 } EFI_IP4_IPCONFIG_DATA;\r
 \r
 \r
 } EFI_IP4_IPCONFIG_DATA;\r
 \r
 \r
index 8aedc7f90d6ea449c37b0841734a8281a067a8ac..3f2d05ea7c1d75306e83d8dd72a85270d5b7f09b 100644 (file)
 typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL;\r
 \r
 typedef struct {\r
 typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+  /// from the MNP receive queue will be dropped if its receive timeout expires.\r
+  ///\r
   UINT32     ReceivedQueueTimeoutValue;\r
   UINT32     ReceivedQueueTimeoutValue;\r
+  ///\r
+  /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+  /// from the MNP transmit queue will be dropped if its receive timeout expires.\r
+  ///\r
   UINT32     TransmitQueueTimeoutValue;\r
   UINT32     TransmitQueueTimeoutValue;\r
+  ///\r
+  /// Ethernet type II 16-bit protocol type in host byte order. Valid\r
+  /// values are zero and 1,500 to 65,535.\r
+  ///\r
   UINT16     ProtocolTypeFilter;\r
   UINT16     ProtocolTypeFilter;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to the network\r
+  /// device MAC address. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableUnicastReceive;\r
   BOOLEAN    EnableUnicastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to any of the\r
+  /// active multicast groups. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableMulticastReceive;\r
   BOOLEAN    EnableMulticastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to the network\r
+  /// device broadcast address. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableBroadcastReceive;\r
   BOOLEAN    EnableBroadcastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to any MAC address.\r
+  /// The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnablePromiscuousReceive;\r
   BOOLEAN    EnablePromiscuousReceive;\r
+  ///\r
+  /// Set to TRUE to drop queued packets when the configuration\r
+  /// is changed. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    FlushQueuesOnReset;\r
   BOOLEAN    FlushQueuesOnReset;\r
+  ///\r
+  /// Set to TRUE to timestamp all packets when they are received\r
+  /// by the MNP. Note that timestamps may be unsupported in some\r
+  /// MNP implementations. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableReceiveTimestamps;\r
   BOOLEAN    EnableReceiveTimestamps;\r
+  ///\r
+  /// Set to TRUE to disable background polling in this MNP\r
+  /// instance. Note that background polling may not be supported in\r
+  /// all MNP implementations. The startup default value is FALSE,\r
+  /// unless background polling is not supported.\r
+  ///\r
   BOOLEAN    DisableBackgroundPolling;\r
 } EFI_MANAGED_NETWORK_CONFIG_DATA;\r
 \r
   BOOLEAN    DisableBackgroundPolling;\r
 } EFI_MANAGED_NETWORK_CONFIG_DATA;\r
 \r
@@ -77,10 +120,26 @@ typedef struct {
 \r
 \r
 typedef struct {\r
 \r
 \r
 typedef struct {\r
+  ///\r
+  /// This Event will be signaled after the Status field is updated\r
+  /// by the MNP. The type of Event must be\r
+  /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+  /// Event must be lower than or equal to TPL_CALLBACK.\r
+  ///\r
   EFI_EVENT                             Event;\r
   EFI_EVENT                             Event;\r
+  ///\r
+  /// The status that is returned to the caller at the end of the operation\r
+  /// to indicate whether this operation completed successfully.\r
+  ///\r
   EFI_STATUS                            Status;\r
   union {\r
   EFI_STATUS                            Status;\r
   union {\r
+    ///\r
+    /// When this token is used for receiving, RxData is a pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+    ///\r
     EFI_MANAGED_NETWORK_RECEIVE_DATA    *RxData;\r
     EFI_MANAGED_NETWORK_RECEIVE_DATA    *RxData;\r
+    ///\r
+    /// When this token is used for transmitting, TxData is a pointer to the EFI_MANAGED_NETWORK_TRANSMIT_DATA.\r
+    ///\r
     EFI_MANAGED_NETWORK_TRANSMIT_DATA   *TxData;\r
   } Packet;\r
 } EFI_MANAGED_NETWORK_COMPLETION_TOKEN;\r
     EFI_MANAGED_NETWORK_TRANSMIT_DATA   *TxData;\r
   } Packet;\r
 } EFI_MANAGED_NETWORK_COMPLETION_TOKEN;\r
index f2c3084b8877f48d3da84f139a64f9cbecdd2622..15cfd98831e852c93b649043ba41a0ad6fa31fa1 100644 (file)
@@ -98,14 +98,41 @@ typedef struct {
 } EFI_MTFTP4_ERROR_HEADER;\r
 \r
 typedef union {\r
 } EFI_MTFTP4_ERROR_HEADER;\r
 \r
 typedef union {\r
+  ///\r
+  /// Type of packets as defined by the MTFTPv4 packet opcodes.\r
+  ///\r
   UINT16                  OpCode;\r
   UINT16                  OpCode;\r
+  ///\r
+  /// Read request packet header.\r
+  ///\r
   EFI_MTFTP4_REQ_HEADER   Rrq;\r
   EFI_MTFTP4_REQ_HEADER   Rrq;\r
+  ///\r
+  /// Write request packet header.\r
+  ///\r
   EFI_MTFTP4_REQ_HEADER   Wrq;\r
   EFI_MTFTP4_REQ_HEADER   Wrq;\r
+  ///\r
+  /// Option acknowledge packet header.\r
+  ///\r
   EFI_MTFTP4_OACK_HEADER  Oack;\r
   EFI_MTFTP4_OACK_HEADER  Oack;\r
+  ///\r
+  /// Data packet header.\r
+  ///\r
   EFI_MTFTP4_DATA_HEADER  Data;\r
   EFI_MTFTP4_DATA_HEADER  Data;\r
+  ///\r
+  /// Acknowledgement packet header.\r
+  ///\r
   EFI_MTFTP4_ACK_HEADER   Ack;\r
   EFI_MTFTP4_ACK_HEADER   Ack;\r
+  ///\r
+  /// Data packet header with big block number.\r
+  ///\r
   EFI_MTFTP4_DATA8_HEADER Data8;\r
   EFI_MTFTP4_DATA8_HEADER Data8;\r
+  ///\r
+  /// Acknowledgement header with big block num.\r
+  ///\r
   EFI_MTFTP4_ACK8_HEADER  Ack8;\r
   EFI_MTFTP4_ACK8_HEADER  Ack8;\r
+  ///\r
+  /// Error packet header.\r
+  ///\r
   EFI_MTFTP4_ERROR_HEADER Error;\r
 } EFI_MTFTP4_PACKET;\r
 \r
   EFI_MTFTP4_ERROR_HEADER Error;\r
 } EFI_MTFTP4_PACKET;\r
 \r
@@ -477,17 +504,60 @@ struct _EFI_MTFTP4_PROTOCOL {
 };\r
 \r
 struct _EFI_MTFTP4_TOKEN {\r
 };\r
 \r
 struct _EFI_MTFTP4_TOKEN {\r
+  ///\r
+  /// The status that is returned to the caller at the end of the operation\r
+  /// to indicate whether this operation completed successfully.\r
+  ///\r
   EFI_STATUS                  Status;\r
   EFI_STATUS                  Status;\r
+  ///\r
+  /// The event that will be signaled when the operation completes. If\r
+  /// set to NULL, the corresponding function will wait until the read or\r
+  /// write operation finishes. The type of Event must be\r
+  /// EVT_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+  /// Event must be lower than or equal to TPL_CALLBACK.\r
+  ///\r
   EFI_EVENT                   Event;\r
   EFI_EVENT                   Event;\r
+  ///\r
+  /// If not NULL, the data that will be used to override the existing configure data.\r
+  ///\r
   EFI_MTFTP4_OVERRIDE_DATA    *OverrideData;\r
   EFI_MTFTP4_OVERRIDE_DATA    *OverrideData;\r
+  ///\r
+  /// Pointer to the ASCIIZ file name string.\r
+  ///\r
   UINT8                       *Filename;\r
   UINT8                       *Filename;\r
+  ///\r
+  /// Pointer to the ASCIIZ mode string. If NULL, Â¡Â°octet¡± is used.\r
+  ///\r
   UINT8                       *ModeStr;\r
   UINT8                       *ModeStr;\r
+  ///\r
+  /// Number of option/value string pairs.\r
+  ///\r
   UINT32                      OptionCount;\r
   UINT32                      OptionCount;\r
+  ///\r
+  /// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.\r
+  ///\r
   EFI_MTFTP4_OPTION           *OptionList;\r
   EFI_MTFTP4_OPTION           *OptionList;\r
+  ///\r
+  /// Size of the data buffer.\r
+  ///\r
   OUT UINT64                  BufferSize;\r
   OUT UINT64                  BufferSize;\r
+  ///\r
+  /// Pointer to the data buffer. Data that is downloaded from the\r
+  /// MTFTPv4 server is stored here. Data that is uploaded to the\r
+  /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.\r
+  ///\r
   OUT VOID                    *Buffer;\r
   OUT VOID                    *Buffer;\r
+  ///\r
+  /// Pointer to the callback function to check the contents of the received packet.\r
+  ///\r
   EFI_MTFTP4_CHECK_PACKET     CheckPacket;\r
   EFI_MTFTP4_CHECK_PACKET     CheckPacket;\r
+  ///\r
+  /// Pointer to the function to be called when a timeout occurs.\r
+  ///\r
   EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
   EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
+  ///\r
+  /// Pointer to the function to provide the needed packet contents.\r
+  ///\r
   EFI_MTFTP4_PACKET_NEEDED    PacketNeeded;\r
 };\r
 \r
   EFI_MTFTP4_PACKET_NEEDED    PacketNeeded;\r
 };\r
 \r
index 0aaa71842894f5bcea5df204fe72ca5c274e286b..2a49ea8e5a3a8ce846748a69f62f2b91523b616b 100644 (file)
@@ -81,8 +81,18 @@ typedef enum {
 /// *******************************************************\r
 ///\r
 typedef enum {\r
 /// *******************************************************\r
 ///\r
 typedef enum {\r
+  ///\r
+  /// A read operation from system memory by a bus master.\r
+  ///\r
   EfiPciIoOperationBusMasterRead,\r
   EfiPciIoOperationBusMasterRead,\r
+  ///\r
+  /// A write operation from system memory by a bus master.\r
+  ///\r
   EfiPciIoOperationBusMasterWrite,\r
   EfiPciIoOperationBusMasterWrite,\r
+  ///\r
+  /// Provides both read and write access to system memory by both the processor and a\r
+  /// bus master. The buffer is coherent from both the processor¡¯s and the bus master's point of view.\r
+  ///\r
   EfiPciIoOperationBusMasterCommonBuffer,\r
   EfiPciIoOperationMaximum\r
 } EFI_PCI_IO_PROTOCOL_OPERATION;\r
   EfiPciIoOperationBusMasterCommonBuffer,\r
   EfiPciIoOperationMaximum\r
 } EFI_PCI_IO_PROTOCOL_OPERATION;\r
@@ -93,10 +103,25 @@ typedef enum {
 /// *******************************************************\r
 ///\r
 typedef enum {\r
 /// *******************************************************\r
 ///\r
 typedef enum {\r
+  ///\r
+  /// Retrieve the PCI controller¡¯s current attributes, and return them in Result.\r
+  ///\r
   EfiPciIoAttributeOperationGet,\r
   EfiPciIoAttributeOperationGet,\r
+  ///\r
+  /// Set the PCI controller¡¯s current attributes to Attributes.\r
+  ///\r
   EfiPciIoAttributeOperationSet,\r
   EfiPciIoAttributeOperationSet,\r
+  ///\r
+  /// Enable the attributes specified by the bits that are set in Attributes for this PCI controller.\r
+  ///\r
   EfiPciIoAttributeOperationEnable,\r
   EfiPciIoAttributeOperationEnable,\r
+  ///\r
+  /// Disable the attributes specified by the bits that are set in Attributes for this PCI controller.\r
+  ///\r
   EfiPciIoAttributeOperationDisable,\r
   EfiPciIoAttributeOperationDisable,\r
+  ///\r
+  /// Retrieve the PCI controller's supported attributes, and return them in Result.\r
+  ///\r
   EfiPciIoAttributeOperationSupported,\r
   EfiPciIoAttributeOperationMaximum\r
 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;\r
   EfiPciIoAttributeOperationSupported,\r
   EfiPciIoAttributeOperationMaximum\r
 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;\r
@@ -168,7 +193,13 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
   );\r
 \r
 typedef struct {\r
+  ///\r
+  /// Read PCI controller registers in the PCI memory or I/O space.\r
+  ///\r
   EFI_PCI_IO_PROTOCOL_IO_MEM  Read;\r
   EFI_PCI_IO_PROTOCOL_IO_MEM  Read;\r
+  ///\r
+  /// Write PCI controller registers in the PCI memory or I/O space.\r
+  ///\r
   EFI_PCI_IO_PROTOCOL_IO_MEM  Write;\r
 } EFI_PCI_IO_PROTOCOL_ACCESS;\r
 \r
   EFI_PCI_IO_PROTOCOL_IO_MEM  Write;\r
 } EFI_PCI_IO_PROTOCOL_ACCESS;\r
 \r
@@ -201,7 +232,13 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
   );\r
 \r
 typedef struct {\r
+  ///\r
+  /// Read PCI controller registers in PCI configuration space.\r
+  ///\r
   EFI_PCI_IO_PROTOCOL_CONFIG  Read;\r
   EFI_PCI_IO_PROTOCOL_CONFIG  Read;\r
+  ///\r
+  /// Write PCI controller registers in PCI configuration space.\r
+  ///\r
   EFI_PCI_IO_PROTOCOL_CONFIG  Write;\r
 } EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS;\r
 \r
   EFI_PCI_IO_PROTOCOL_CONFIG  Write;\r
 } EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS;\r
 \r
index a563f94aefdf6e524177f456a09affe3a2d08994..970aee0642cb07da18eeafe24a3bd8ca21842b96 100644 (file)
@@ -169,7 +169,13 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
   );\r
 \r
 typedef struct {\r
+  ///\r
+  /// Read PCI controller registers in the PCI root bridge memory space.\r
+  ///\r
   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Read;\r
   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Read;\r
+  ///\r
+  /// Write PCI controller registers in the PCI root bridge memory space.\r
+  ///\r
   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Write;\r
 } EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS;\r
 \r
   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Write;\r
 } EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS;\r
 \r
index f8267d8610ebf91c846ef4ecc5775158d0107d90..26b1503582cc23652a5df08a2febb09370fa58a0 100644 (file)
     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// UEFI Revision Number Definition\r
-//\r
+///\r
+/// UEFI Revision Number Definition\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\r
 \r
 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\r
 \r
-//\r
-// EFI 1.1 Revision Number defintion\r
-//\r
+///\r
+/// EFI 1.1 Revision Number defintion\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION  \\r
         EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
 \r
 ///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION  \\r
         EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
 \r
 ///\r
-/// Protocol definition\r
+/// UEFI Protocol name\r
 ///\r
 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r
 \r
 ///\r
 ///\r
 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r
 \r
 ///\r
-/// Protocol defined in EFI1.1.\r
+/// EFI1.1 Protocol name\r
 /// \r
 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
 \r
 /// \r
 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
 \r
index cf37eba5e95c048bec5d3fcd17526c9fa7bcbd5c..e0204cce22847cc1a7af562473434dd256f500ce 100644 (file)
@@ -39,16 +39,16 @@ typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
 // SCSI Host Adapter Status definition\r
 //\r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK                     0x00\r
 // SCSI Host Adapter Status definition\r
 //\r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK                     0x00\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND        0x09    // timeout when processing the command\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT                0x0b    // timeout when waiting for the command processing\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT         0x0d    // a message reject was received when processing command\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET              0x0e    // a bus reset was detected\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND        0x09    ///< timeout when processing the command\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT                0x0b    ///< timeout when waiting for the command processing\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT         0x0d    ///< a message reject was received when processing command\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET              0x0e    ///< a bus reset was detected\r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR           0x0f\r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR           0x0f\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED   0x10    // the adapter failed in issuing request sense command\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT      0x11    // selection timeout\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN  0x12    // data overrun or data underrun\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE               0x13    // Unexepected bus free\r
-#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR            0x14    // Target bus phase sequence failure\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED   0x10    ///< the adapter failed in issuing request sense command\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT      0x11    ///< selection timeout\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN  0x12    ///< data overrun or data underrun\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE               0x13    ///< Unexepected bus free\r
+#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR            0x14    ///< Target bus phase sequence failure\r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER                  0x7f\r
 \r
 \r
 #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER                  0x7f\r
 \r
 \r
@@ -56,27 +56,80 @@ typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
 // SCSI Target Status definition\r
 //\r
 #define EFI_SCSI_IO_STATUS_TARGET_GOOD                         0x00\r
 // SCSI Target Status definition\r
 //\r
 #define EFI_SCSI_IO_STATUS_TARGET_GOOD                         0x00\r
-#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION              0x02    // check condition\r
-#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET                0x04    // condition met\r
-#define EFI_SCSI_IO_STATUS_TARGET_BUSY                         0x08    // busy\r
-#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE                 0x10    // intermediate\r
-#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET   0x14    // intermediate-condition met\r
-#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT         0x18    // reservation conflict\r
-#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED           0x22    // command terminated\r
-#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL                   0x28    // queue full\r
+#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION              0x02    ///< check condition\r
+#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET                0x04    ///< condition met\r
+#define EFI_SCSI_IO_STATUS_TARGET_BUSY                         0x08    ///< busy\r
+#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE                 0x10    ///< intermediate\r
+#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET   0x14    ///< intermediate-condition met\r
+#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT         0x18    ///< reservation conflict\r
+#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED           0x22    ///< command terminated\r
+#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL                   0x28    ///< queue full\r
 \r
 typedef struct {\r
 \r
 typedef struct {\r
+  ///\r
+  /// The timeout, in 100 ns units, to use for the execution of this SCSI\r
+  /// Request Packet. A Timeout value of 0 means that this function\r
+  /// will wait indefinitely for the SCSI Request Packet to execute. If\r
+  /// Timeout is greater than zero, then this function will return\r
+  /// EFI_TIMEOUT if the time required to execute the SCSI Request\r
+  /// Packet is greater than Timeout.\r
+  ///\r
   UINT64                              Timeout;\r
   UINT64                              Timeout;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device for SCSI READ command\r
+  ///\r
   VOID                                *InDataBuffer;\r
   VOID                                *InDataBuffer;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device for SCSI WRITE command.\r
+  ///\r
   VOID                                *OutDataBuffer;\r
   VOID                                *OutDataBuffer;\r
+  ///\r
+  /// A pointer to the sense data that was generated by the execution of\r
+  /// the SCSI Request Packet.\r
+  ///\r
   VOID                                *SenseData;\r
   VOID                                *SenseData;\r
+  ///\r
+  /// A pointer to buffer that contains the Command Data Block to\r
+  /// send to the SCSI device.\r
+  ///\r
   VOID                                *Cdb;\r
   VOID                                *Cdb;\r
+  ///\r
+  /// On Input, the size, in bytes, of InDataBuffer. On output, the\r
+  /// number of bytes transferred between the SCSI controller and the SCSI device.\r
+  ///\r
   UINT32                              InTransferLength;\r
   UINT32                              InTransferLength;\r
+  ///\r
+  /// On Input, the size, in bytes of OutDataBuffer. On Output, the\r
+  /// Number of bytes transferred between SCSI Controller and the SCSI device.\r
+  ///\r
   UINT32                              OutTransferLength;\r
   UINT32                              OutTransferLength;\r
+  ///\r
+  /// The length, in bytes, of the buffer Cdb. The standard values are\r
+  /// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used.\r
+  ///\r
   UINT8                               CdbLength;\r
   UINT8                               CdbLength;\r
+  ///\r
+  /// The direction of the data transfer. 0 for reads, 1 for writes. A\r
+  /// value of 2 is Reserved for Bi-Directional SCSI commands.\r
+  ///\r
   UINT8                               DataDirection;\r
   UINT8                               DataDirection;\r
+  ///\r
+  /// The status of the SCSI Host Controller that produces the SCSI\r
+  /// bus where the SCSI device attached when the SCSI Request\r
+  /// Packet was executed on the SCSI Controller.\r
+  ///\r
   UINT8                               HostAdapterStatus;\r
   UINT8                               HostAdapterStatus;\r
+  ///\r
+  /// The status returned by the SCSI device when the SCSI Request\r
+  /// Packet was executed.\r
+  ///\r
   UINT8                               TargetStatus;\r
   UINT8                               TargetStatus;\r
+  ///\r
+  /// On input, the length in bytes of the SenseData buffer. On\r
+  /// output, the number of bytes written to the SenseData buffer.\r
+  ///\r
   UINT8                               SenseDataLength;\r
 } EFI_SCSI_IO_SCSI_REQUEST_PACKET;\r
 \r
   UINT8                               SenseDataLength;\r
 } EFI_SCSI_IO_SCSI_REQUEST_PACKET;\r
 \r
index ee498e0ec32e35b9a788d691a94e6aba1de455c2..1790c1af43db50c33a2a580331182a9919f802ea 100644 (file)
@@ -66,23 +66,85 @@ typedef struct _EFI_SCSI_PASS_THRU_PROTOCOL  EFI_SCSI_PASS_THRU_PROTOCOL;
 #define EFI_SCSI_STATUS_TARGET_QUEUE_FULL                 0x28  // queue full\r
 \r
 typedef struct {\r
 #define EFI_SCSI_STATUS_TARGET_QUEUE_FULL                 0x28  // queue full\r
 \r
 typedef struct {\r
+  ///\r
+  /// The timeout, in 100 ns units, to use for the execution of this SCSI\r
+  /// Request Packet. A Timeout value of 0 means that this function\r
+  /// will wait indefinitely for the SCSI Request Packet to execute. If\r
+  /// Timeout is greater than zero, then this function will return\r
+  /// EFI_TIMEOUT if the time required to execute the SCSI Request\r
+  /// Packet is greater than Timeout.\r
+  ///\r
   UINT64  Timeout;\r
   UINT64  Timeout;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device. Must be aligned to the boundary\r
+  /// specified in the IoAlign field of the\r
+  /// EFI_SCSI_PASS_THRU_MODE structure.\r
+  ///\r
   VOID    *DataBuffer;\r
   VOID    *DataBuffer;\r
+  ///\r
+  /// A pointer to the sense data that was generated by the execution of\r
+  /// the SCSI Request Packet.\r
+  ///\r
   VOID    *SenseData;\r
   VOID    *SenseData;\r
+  ///\r
+  /// A pointer to buffer that contains the Command Data Block to\r
+  /// send to the SCSI device.\r
+  ///\r
   VOID    *Cdb;\r
   VOID    *Cdb;\r
+  ///\r
+  /// On Input, the size, in bytes, of InDataBuffer. On output, the\r
+  /// number of bytes transferred between the SCSI controller and the SCSI device.\r
+  ///\r
   UINT32  TransferLength;\r
   UINT32  TransferLength;\r
+  ///\r
+  /// The length, in bytes, of the buffer Cdb. The standard values are\r
+  /// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used.\r
+  ///\r
   UINT8   CdbLength;\r
   UINT8   CdbLength;\r
+  ///\r
+  /// The direction of the data transfer. 0 for reads, 1 for writes. A\r
+  /// value of 2 is Reserved for Bi-Directional SCSI commands.\r
+  ///\r
   UINT8   DataDirection;\r
   UINT8   DataDirection;\r
+  ///\r
+  /// The status of the SCSI Host Controller that produces the SCSI\r
+  /// bus where the SCSI device attached when the SCSI Request\r
+  /// Packet was executed on the SCSI Controller.\r
+  ///\r
   UINT8   HostAdapterStatus;\r
   UINT8   HostAdapterStatus;\r
+  ///\r
+  /// The status returned by the SCSI device when the SCSI Request\r
+  /// Packet was executed.\r
+  ///\r
   UINT8   TargetStatus;\r
   UINT8   TargetStatus;\r
+  ///\r
+  /// On input, the length in bytes of the SenseData buffer. On\r
+  /// output, the number of bytes written to the SenseData buffer.\r
+  ///\r
   UINT8   SenseDataLength;\r
 } EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r
 typedef struct {\r
   UINT8   SenseDataLength;\r
 } EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r
 typedef struct {\r
+  ///\r
+  /// A Null-terminated Unicode string that represents the printable name of the SCSI controller.\r
+  ///\r
   CHAR16  *ControllerName;\r
   CHAR16  *ControllerName;\r
+  ///\r
+  /// A Null-terminated Unicode string that represents the printable name of the SCSI channel.\r
+  ///\r
   CHAR16  *ChannelName;\r
   CHAR16  *ChannelName;\r
+  ///\r
+  /// The Target ID of the host adapter on the SCSI channel.\r
+  ///\r
   UINT32  AdapterId;\r
   UINT32  AdapterId;\r
+  ///\r
+  /// Additional information on the attributes of the SCSI channel.\r
+  ///\r
   UINT32  Attributes;\r
   UINT32  Attributes;\r
+  ///\r
+  /// Supplies the alignment requirement for any buffer used in a data transfer.\r
+  ///\r
   UINT32  IoAlign;\r
 } EFI_SCSI_PASS_THRU_MODE;\r
 \r
   UINT32  IoAlign;\r
 } EFI_SCSI_PASS_THRU_MODE;\r
 \r
index d63f056c5aa5f2d7048eebb0b928e8a095026067..7ec0dd9737d6c9f9014b5c9f7d66073f91a0287b 100644 (file)
@@ -66,23 +66,84 @@ typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL;
 #define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED                0x40\r
 \r
 typedef struct {\r
 #define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED                0x40\r
 \r
 typedef struct {\r
+  ///\r
+  /// The Target ID of the host adapter on the SCSI channel.\r
+  ///\r
   UINT32 AdapterId;\r
   UINT32 AdapterId;\r
+  ///\r
+  /// Additional information on the attributes of the SCSI channel.\r
+  ///\r
   UINT32 Attributes;\r
   UINT32 Attributes;\r
+  ///\r
+  /// Supplies the alignment requirement for any buffer used in a data transfer.\r
+  ///\r
   UINT32 IoAlign;\r
 } EFI_EXT_SCSI_PASS_THRU_MODE;\r
 \r
 typedef struct {\r
   UINT32 IoAlign;\r
 } EFI_EXT_SCSI_PASS_THRU_MODE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The timeout, in 100 ns units, to use for the execution of this SCSI\r
+  /// Request Packet. A Timeout value of 0 means that this function\r
+  /// will wait indefinitely for the SCSI Request Packet to execute. If\r
+  /// Timeout is greater than zero, then this function will return\r
+  /// EFI_TIMEOUT if the time required to execute the SCSI\r
+  /// Request Packet is greater than Timeout.\r
+  ///\r
   UINT64 Timeout;\r
   UINT64 Timeout;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device for read and bidirectional commands.\r
+  ///\r
   VOID   *InDataBuffer;\r
   VOID   *InDataBuffer;\r
+  ///\r
+  /// A pointer to the data buffer to transfer between the SCSI\r
+  /// controller and the SCSI device for write or bidirectional commands.\r
+  ///\r
   VOID   *OutDataBuffer;\r
   VOID   *OutDataBuffer;\r
+  ///\r
+  /// A pointer to the sense data that was generated by the execution of\r
+  /// the SCSI Request Packet.\r
+  ///\r
   VOID   *SenseData;\r
   VOID   *SenseData;\r
+  ///\r
+  /// A pointer to buffer that contains the Command Data Block to\r
+  /// send to the SCSI device specified by Target and Lun.\r
+  ///\r
   VOID   *Cdb;\r
   VOID   *Cdb;\r
+  ///\r
+  /// On Input, the size, in bytes, of InDataBuffer. On output, the\r
+  /// number of bytes transferred between the SCSI controller and the SCSI device.\r
+  ///\r
   UINT32 InTransferLength;\r
   UINT32 InTransferLength;\r
+  ///\r
+  /// On Input, the size, in bytes of OutDataBuffer. On Output, the\r
+  /// Number of bytes transferred between SCSI Controller and the SCSI device.\r
+  ///\r
   UINT32 OutTransferLength;\r
   UINT32 OutTransferLength;\r
+  ///\r
+  /// The length, in bytes, of the buffer Cdb. The standard values are 6,\r
+  /// 10, 12, and 16, but other values are possible if a variable length CDB is used.\r
+  ///\r
   UINT8  CdbLength;\r
   UINT8  CdbLength;\r
+  ///\r
+  /// The direction of the data transfer. 0 for reads, 1 for writes. A\r
+  /// value of 2 is Reserved for Bi-Directional SCSI commands.\r
+  ///\r
   UINT8  DataDirection;\r
   UINT8  DataDirection;\r
+  ///\r
+  /// The status of the host adapter specified by This when the SCSI\r
+  /// Request Packet was executed on the target device.\r
+  ///\r
   UINT8  HostAdapterStatus;\r
   UINT8  HostAdapterStatus;\r
+  ///\r
+  /// The status returned by the device specified by Target and Lun\r
+  /// when the SCSI Request Packet was executed.\r
+  ///\r
   UINT8  TargetStatus;\r
   UINT8  TargetStatus;\r
+  ///\r
+  /// On input, the length in bytes of the SenseData buffer. On\r
+  /// output, the number of bytes written to the SenseData buffer.\r
+  ///\r
   UINT8  SenseDataLength;\r
 } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r
   UINT8  SenseDataLength;\r
 } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET;\r
 \r
index eb850be94f50c0e54ce4d0f2174cba617a9de11a..ddfbebb80c598bdb97a5fdc36b1dfd9fbd02fe1e 100644 (file)
@@ -31,14 +31,13 @@ typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE_PROTOCOL;\r
 typedef struct _EFI_FILE_PROTOCOL         *EFI_FILE_HANDLE;\r
 \r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE_PROTOCOL;\r
 typedef struct _EFI_FILE_PROTOCOL         *EFI_FILE_HANDLE;\r
 \r
-\r
 ///\r
 ///\r
-/// Protocol GUID defined in EFI1.1.\r
+/// Protocol GUID name defined in EFI1.1.\r
 /// \r
 #define SIMPLE_FILE_SYSTEM_PROTOCOL       EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
 \r
 ///\r
 /// \r
 #define SIMPLE_FILE_SYSTEM_PROTOCOL       EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
 \r
 ///\r
-/// Protocol defined in EFI1.1.\r
+/// Protocol name defined in EFI1.1.\r
 /// \r
 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_FILE_IO_INTERFACE;\r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;\r
 /// \r
 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_FILE_IO_INTERFACE;\r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;\r
@@ -66,12 +65,18 @@ EFI_STATUS
   );\r
 \r
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION  0x00010000\r
   );\r
 \r
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION  0x00010000\r
+\r
 ///\r
 /// Revision defined in EFI1.1\r
 /// \r
 #define EFI_FILE_IO_INTERFACE_REVISION  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
 \r
 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
 ///\r
 /// Revision defined in EFI1.1\r
 /// \r
 #define EFI_FILE_IO_INTERFACE_REVISION  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
 \r
 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
+  ///\r
+  /// The version of the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL. The version\r
+  /// specified by this specification is 0x00010000. All future revisions\r
+  /// must be backwards compatible.\r
+  ///\r
   UINT64                                      Revision;\r
   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume;\r
 };\r
   UINT64                                      Revision;\r
   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume;\r
 };\r
index 252c5bd492dcd83ca835d4b901211c9001ec8ceb..1d9cc67bdf921b4ccb8f85044c2dc9420bc9a229 100644 (file)
@@ -144,24 +144,84 @@ typedef enum {
 \r
 #define MAX_MCAST_FILTER_CNT                              16\r
 typedef struct {\r
 \r
 #define MAX_MCAST_FILTER_CNT                              16\r
 typedef struct {\r
+  ///\r
+  /// Reports the current state of the network interface.\r
+  ///\r
   UINT32          State;\r
   UINT32          State;\r
+  ///\r
+  /// The size, in bytes, of the network interface's HW address.\r
+  ///\r
   UINT32          HwAddressSize;\r
   UINT32          HwAddressSize;\r
+  ///\r
+  /// The size, in bytes, of the network interface's media header.\r
+  ///\r
   UINT32          MediaHeaderSize;\r
   UINT32          MediaHeaderSize;\r
+  ///\r
+  /// The maximum size, in bytes, of the packets supported by the network interface.\r
+  ///\r
   UINT32          MaxPacketSize;\r
   UINT32          MaxPacketSize;\r
+  ///\r
+  /// The size, in bytes, of the NVRAM device attached to the network interface.\r
+  ///\r
   UINT32          NvRamSize;\r
   UINT32          NvRamSize;\r
+  ///\r
+  /// The size that must be used for all NVRAM reads and writes. The\r
+  /// start address for NVRAM read and write operations and the total\r
+  /// length of those operations, must be a multiple of this value. The\r
+  /// legal values for this field are 0, 1, 2, 4, and 8.\r
+  ///\r
   UINT32          NvRamAccessSize;\r
   UINT32          NvRamAccessSize;\r
+  ///\r
+  /// The multicast receive filter settings supported by the network interface.\r
+  ///\r
   UINT32          ReceiveFilterMask;\r
   UINT32          ReceiveFilterMask;\r
+  ///\r
+  /// The current multicast receive filter settings.\r
+  ///\r
   UINT32          ReceiveFilterSetting;\r
   UINT32          ReceiveFilterSetting;\r
+  ///\r
+  /// The maximum number of multicast address receive filters supported by the driver.\r
+  ///\r
   UINT32          MaxMCastFilterCount;\r
   UINT32          MaxMCastFilterCount;\r
+  ///\r
+  /// The current number of multicast address receive filters.\r
+  ///\r
   UINT32          MCastFilterCount;\r
   UINT32          MCastFilterCount;\r
+  ///\r
+  /// Array containing the addresses of the current multicast address receive filters.\r
+  ///\r
   EFI_MAC_ADDRESS MCastFilter[MAX_MCAST_FILTER_CNT];\r
   EFI_MAC_ADDRESS MCastFilter[MAX_MCAST_FILTER_CNT];\r
+  ///\r
+  /// The current HW MAC address for the network interface.\r
+  ///\r
   EFI_MAC_ADDRESS CurrentAddress;\r
   EFI_MAC_ADDRESS CurrentAddress;\r
+  ///\r
+  /// The current HW MAC address for broadcast packets.\r
+  ///\r
   EFI_MAC_ADDRESS BroadcastAddress;\r
   EFI_MAC_ADDRESS BroadcastAddress;\r
+  ///\r
+  /// The permanent HW MAC address for the network interface.\r
+  ///\r
   EFI_MAC_ADDRESS PermanentAddress;\r
   EFI_MAC_ADDRESS PermanentAddress;\r
+  ///\r
+  /// The interface type of the network interface.\r
+  ///\r
   UINT8           IfType;\r
   UINT8           IfType;\r
+  ///\r
+  /// TRUE if the HW MAC address can be changed.\r
+  ///\r
   BOOLEAN         MacAddressChangeable;\r
   BOOLEAN         MacAddressChangeable;\r
+  ///\r
+  /// TRUE if the network interface can transmit more than one packet at a time.\r
+  ///\r
   BOOLEAN         MultipleTxSupported;\r
   BOOLEAN         MultipleTxSupported;\r
+  ///\r
+  /// TRUE if the presence of media can be determined; otherwise FALSE.\r
+  ///\r
   BOOLEAN         MediaPresentSupported;\r
   BOOLEAN         MediaPresentSupported;\r
+  ///\r
+  /// TRUE if media are connected to the network interface; otherwise FALSE.\r
+  ///\r
   BOOLEAN         MediaPresent;\r
 } EFI_SIMPLE_NETWORK_MODE;\r
 \r
   BOOLEAN         MediaPresent;\r
 } EFI_SIMPLE_NETWORK_MODE;\r
 \r
index 5d22bf6e4496b9ff7b979b587e066333c7c7ed95..9b5fb3127b24d1150804a33014a1c3c16cfc5abf 100644 (file)
@@ -28,18 +28,53 @@ typedef struct _EFI_SIMPLE_POINTER_PROTOCOL  EFI_SIMPLE_POINTER_PROTOCOL;
 // Data structures\r
 //\r
 typedef struct {\r
 // Data structures\r
 //\r
 typedef struct {\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the x-axis.\r
+  ///\r
   INT32   RelativeMovementX;\r
   INT32   RelativeMovementX;\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the y-axis.\r
+  ///\r
   INT32   RelativeMovementY;\r
   INT32   RelativeMovementY;\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the z-axis.\r
+  ///\r
   INT32   RelativeMovementZ;\r
   INT32   RelativeMovementZ;\r
+  ///\r
+  /// If TRUE, then the left button of the pointer device is being\r
+  /// pressed. If FALSE, then the left button of the pointer device is not being pressed.\r
+  ///\r
   BOOLEAN LeftButton;\r
   BOOLEAN LeftButton;\r
+  ///\r
+  /// If TRUE, then the right button of the pointer device is being\r
+  /// pressed. If FALSE, then the right button of the pointer device is not being pressed.\r
+  ///\r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_STATE;\r
 \r
 typedef struct {\r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_STATE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The resolution of the pointer device on the x-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionX;\r
   UINT64  ResolutionX;\r
+  ///\r
+  /// The resolution of the pointer device on the y-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionY;\r
   UINT64  ResolutionY;\r
+  ///\r
+  /// The resolution of the pointer device on the z-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionZ;\r
   UINT64  ResolutionZ;\r
+  ///\r
+  /// TRUE if a left button is present on the pointer device. Otherwise FALSE.\r
+  ///\r
   BOOLEAN LeftButton;\r
   BOOLEAN LeftButton;\r
+  ///\r
+  /// TRUE if a right button is present on the pointer device. Otherwise FALSE.\r
+  ///\r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_MODE;\r
 \r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_MODE;\r
 \r
index 0716b736742cfdf2c1b6b472ed6c6ac47535057d..67786cefe9a7e84e5f6424630f0c282364407450 100644 (file)
     0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
     0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
+typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r
+\r
 ///\r
 ///\r
-/// Protocol GUID defined in EFI1.1.\r
+/// Protocol GUID name defined in EFI1.1.\r
 /// \r
 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
 \r
 /// \r
 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
 \r
-typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r
-\r
 ///\r
 ///\r
-/// Backward-compatible with EFI1.1.\r
+/// Protocol name in EFI1.1 for backward-compatible.\r
 /// \r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
 /// \r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
-//\r
-// Data structures\r
-//\r
+\r
+///\r
+/// The keystroke information for the key that was pressed.\r
+///\r
 typedef struct {\r
   UINT16  ScanCode;\r
   CHAR16  UnicodeChar;\r
 typedef struct {\r
   UINT16  ScanCode;\r
   CHAR16  UnicodeChar;\r
index 8dcb5e141906eb80d306f293a7113ad76223aee4..95c5995ce80994f43445d85ada695755e1e3ce5f 100644 (file)
@@ -60,42 +60,38 @@ EFI_STATUS
 );\r
 \r
 \r
 );\r
 \r
 \r
-//\r
-// EFI_KEY_TOGGLE_STATE\r
-//\r
+///\r
+/// EFI_KEY_TOGGLE_STATE. The toggle state are defined.\r
+/// They are EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE\r
+/// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE\r
+///\r
 typedef UINT8 EFI_KEY_TOGGLE_STATE;\r
 \r
 typedef UINT8 EFI_KEY_TOGGLE_STATE;\r
 \r
-/**\r
-  Definition of EFI_KEY_STATE\r
-\r
-  @param KeyShiftState  Reflects the currently pressed shift\r
-                        modifiers for the input device. The\r
-                        returned value is valid only if the high\r
-                        order bit has been set.\r
-\r
-  @param KeyToggleState Reflects the current internal state of\r
-                        various toggled attributes. The returned\r
-                        value is valid only if the high order\r
-                        bit has been set.\r
-\r
-**/\r
 typedef struct _EFI_KEY_STATE {\r
 typedef struct _EFI_KEY_STATE {\r
+  ///\r
+  /// Reflects the currently pressed shift\r
+  /// modifiers for the input device. The\r
+  /// returned value is valid only if the high\r
+  /// order bit has been set.\r
+  ///\r
   UINT32                KeyShiftState;\r
   UINT32                KeyShiftState;\r
+  ///\r
+  /// Reflects the current internal state of\r
+  /// various toggled attributes. The returned\r
+  /// value is valid only if the high order\r
+  /// bit has been set.\r
+  ///\r
   EFI_KEY_TOGGLE_STATE  KeyToggleState;\r
 } EFI_KEY_STATE;\r
 \r
   EFI_KEY_TOGGLE_STATE  KeyToggleState;\r
 } EFI_KEY_STATE;\r
 \r
-/**\r
-  Definition of EFI_KEY_DATA.\r
-\r
-  @param Key      The EFI scan code and Unicode value returned from\r
-                  the input device.\r
-\r
-  @param KeyState The current state of various toggled\r
-                  attributes as well as input modifier values.\r
-\r
-**/\r
 typedef struct {\r
 typedef struct {\r
+  ///\r
+  /// The EFI scan code and Unicode value returned from the input device.\r
+  ///\r
   EFI_INPUT_KEY   Key;\r
   EFI_INPUT_KEY   Key;\r
+  ///\r
+  /// The current state of various toggled attributes as well as input modifier values.\r
+  ///\r
   EFI_KEY_STATE   KeyState;\r
 } EFI_KEY_DATA;\r
 \r
   EFI_KEY_STATE   KeyState;\r
 } EFI_KEY_DATA;\r
 \r
@@ -234,9 +230,9 @@ EFI_STATUS
   IN EFI_KEY_TOGGLE_STATE              *KeyToggleState\r
 );\r
 \r
   IN EFI_KEY_TOGGLE_STATE              *KeyToggleState\r
 );\r
 \r
-//\r
-// EFI_KEY_NOTIFY\r
-//\r
+///\r
+/// The function will be called when the key sequence is typed specified by KeyData.\r
+///\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(\r
index 67a174eec6d5ee14aeba9a4e3c53755626540f5b..5431c49d5e9a715755d01ed7b0157dd3c0b2a3cd 100644 (file)
@@ -19,7 +19,7 @@
 #ifndef __SMBUS_HC_H__\r
 #define __SMBUS_HC_H__\r
 \r
 #ifndef __SMBUS_HC_H__\r
 #define __SMBUS_HC_H__\r
 \r
-#include <Ppi/Smbus2.h>\r
+#include <IndustryStandard/SmBus.h>\r
 \r
 #define EFI_SMBUS_HC_PROTOCOL_GUID \\r
   {0xe49d33ed, 0x513d, 0x4634, { 0xb6, 0x98, 0x6f, 0x55, 0xaa, 0x75, 0x1c, 0x1b} }\r
 \r
 #define EFI_SMBUS_HC_PROTOCOL_GUID \\r
   {0xe49d33ed, 0x513d, 0x4634, { 0xb6, 0x98, 0x6f, 0x55, 0xaa, 0x75, 0x1c, 0x1b} }\r
index 1c9c149d14a166183166c523760a3a8df01baa8b..1f378535cf056f95ed517641fb97e21fd18236e4 100644 (file)
@@ -23,9 +23,6 @@
 \r
 typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL;\r
 \r
 \r
 typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL;\r
 \r
-//\r
-// Set structure alignment to 1-byte\r
-//\r
 typedef struct {\r
   UINT8  Major;\r
   UINT8  Minor;\r
 typedef struct {\r
   UINT8  Major;\r
   UINT8  Minor;\r
@@ -34,13 +31,13 @@ typedef struct {
 } TCG_VERSION;\r
 \r
 typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
 } TCG_VERSION;\r
 \r
 typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
-  UINT8          Size;                // Size of this structure\r
+  UINT8          Size;                /// Size of this structure\r
   TCG_VERSION    StructureVersion;    \r
   TCG_VERSION    ProtocolSpecVersion;\r
   TCG_VERSION    StructureVersion;    \r
   TCG_VERSION    ProtocolSpecVersion;\r
-  UINT8          HashAlgorithmBitmap; // Hash algorithms  \r
-                                      // this protocol is capable of : 01=SHA-1\r
-  BOOLEAN        TPMPresentFlag;      // 00h = TPM not present\r
-  BOOLEAN        TPMDeactivatedFlag;  // 01h = TPM currently deactivated\r
+  UINT8          HashAlgorithmBitmap; /// Hash algorithms  \r
+                                      /// this protocol is capable of : 01=SHA-1\r
+  BOOLEAN        TPMPresentFlag;      /// 00h = TPM not present\r
+  BOOLEAN        TPMDeactivatedFlag;  /// 01h = TPM currently deactivated\r
 } TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
 \r
 typedef UINT32   TCG_ALGORITHM_ID;\r
 } TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
 \r
 typedef UINT32   TCG_ALGORITHM_ID;\r
index 6687e323aaae0f515a8e153b863d1a6a583e4476..bb550a381d103aad046a3e139bb72a4640946dd1 100644 (file)
@@ -33,8 +33,8 @@ typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL;
 \r
 \r
 typedef struct {\r
 \r
 \r
 typedef struct {\r
-  UINT16          PortStatus;        /// Contains current port status bitmap.\r
-  UINT16          PortChangeStatus;  /// Contains current port status change bitmap.\r
+  UINT16          PortStatus;        ///< Contains current port status bitmap.\r
+  UINT16          PortChangeStatus;  ///< Contains current port status change bitmap.\r
 } EFI_USB_PORT_STATUS;\r
 \r
 ///\r
 } EFI_USB_PORT_STATUS;\r
 \r
 ///\r
@@ -78,13 +78,13 @@ typedef enum {
   EfiUsbPortResetChange       = 20\r
 } EFI_USB_PORT_FEATURE;\r
 \r
   EfiUsbPortResetChange       = 20\r
 } EFI_USB_PORT_FEATURE;\r
 \r
-#define EFI_USB_SPEED_FULL      0x0000  /// 12 Mb/s, USB 1.1 OHCI and UHCI HC.\r
-#define EFI_USB_SPEED_LOW       0x0001  /// 1 Mb/s, USB 1.1 OHCI and UHCI HC.\r
-#define EFI_USB_SPEED_HIGH      0x0002  /// 480 Mb/s, USB 2.0 EHCI HC.\r
+#define EFI_USB_SPEED_FULL      0x0000  ///< 12 Mb/s, USB 1.1 OHCI and UHCI HC.\r
+#define EFI_USB_SPEED_LOW       0x0001  ///< 1 Mb/s, USB 1.1 OHCI and UHCI HC.\r
+#define EFI_USB_SPEED_HIGH      0x0002  ///< 480 Mb/s, USB 2.0 EHCI HC.\r
 \r
 typedef struct {\r
 \r
 typedef struct {\r
-  UINT8      TranslatorHubAddress; /// device address\r
-  UINT8      TranslatorPortNumber; /// the port number of the hub that device is connected to.\r
+  UINT8      TranslatorHubAddress; ///< device address\r
+  UINT8      TranslatorPortNumber; ///< the port number of the hub that device is connected to.\r
 } EFI_USB2_HC_TRANSACTION_TRANSLATOR;\r
 \r
 //\r
 } EFI_USB2_HC_TRANSACTION_TRANSLATOR;\r
 \r
 //\r
index 0c5bd70445db4876107302bd3d1cc8f2f27fe7cf..e29f60b19cb86aa18c3614b49eb3789ffaf81e9a 100644 (file)
@@ -44,9 +44,9 @@ typedef USB_CONFIG_DESCRIPTOR     EFI_USB_CONFIG_DESCRIPTOR;
 typedef USB_INTERFACE_DESCRIPTOR  EFI_USB_INTERFACE_DESCRIPTOR;\r
 typedef USB_ENDPOINT_DESCRIPTOR   EFI_USB_ENDPOINT_DESCRIPTOR;\r
 \r
 typedef USB_INTERFACE_DESCRIPTOR  EFI_USB_INTERFACE_DESCRIPTOR;\r
 typedef USB_ENDPOINT_DESCRIPTOR   EFI_USB_ENDPOINT_DESCRIPTOR;\r
 \r
-//\r
-// USB data transfer direction\r
-//\r
+///\r
+/// USB data transfer direction\r
+///\r
 typedef enum {\r
   EfiUsbDataIn,\r
   EfiUsbDataOut,\r
 typedef enum {\r
   EfiUsbDataIn,\r
   EfiUsbDataOut,\r
index 4545f8fc2eb9c06c4c171fde8f61bfb436cdfc55..c99a905ed7f57d59a591ba1ac075f0805b82f908 100644 (file)
 #pragma pack (1)\r
 \r
 typedef UINT32                     TCG_EVENTTYPE;\r
 #pragma pack (1)\r
 \r
 typedef UINT32                     TCG_EVENTTYPE;\r
-\r
-#define TCG_DIGEST                 TPM_DIGEST\r
-#define TCG_PCRINDEX               TPM_PCRINDEX\r
-\r
+typedef TPM_PCRINDEX               TCG_PCRINDEX;\r
+typedef TPM_DIGEST                 TCG_DIGEST;\r
 ///\r
 /// Event Log Entry Structure Definition\r
 ///\r
 ///\r
 /// Event Log Entry Structure Definition\r
 ///\r