added comments per framework spec.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / PciHotPlugInit.h

diff --git a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
index 341acb7308e1cb9b4688c8481662ab61dfed7062..623ca7679cc9d3795ef106e745a4ff1deae43efb 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
+++ b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
@@ -1,5 +1,5 @@
 /** @file\r
-  This file declares EFI PCI Hot Plug Init Protocol\r
+  This file declares EFI PCI Hot Plug Init Protocol.\r
   This protocol provides the necessary functionality to initialize the Hot Plug Controllers (HPCs) and\r
   the buses that they control. This protocol also provides information regarding resource padding.\r
 \r
@@ -12,8 +12,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  PciHotPlugInit.h\r
-\r
   @par Revision Reference:\r
   This protocol is defined in Framework of EFI Hot Plug Pci Initialization Protocol Spec\r
   Version 0.9\r
@@ -25,23 +23,46 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the PCI Hot Plug Protocol\r
-//\r
+///\r
+/// Global ID for the PCI Hot Plug Protocol\r
+///\r
 #define EFI_PCI_HOT_PLUG_INIT_PROTOCOL_GUID \\r
   { 0xaa0e8bc1, 0xdabc, 0x46b0, {0xa8, 0x44, 0x37, 0xb8, 0x16, 0x9b, 0x2b, 0xea } }\r
 \r
 \r
 typedef struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL EFI_PCI_HOT_PLUG_INIT_PROTOCOL;\r
 \r
-#define  EFI_HPC_STATE_INITIALIZED    0x01\r
-#define  EFI_HPC_STATE_ENABLED        0x02\r
-\r
+///\r
+/// Current state of an HPC\r
+///\r
 typedef UINT16 EFI_HPC_STATE;\r
 \r
+///\r
+/// The HPC initialization function was called and the HPC completed \r
+/// initialization, but it was not enabled for some reason. The HPC may be \r
+/// disabled in hardware, or it may be disabled due to user preferences, \r
+/// hardware failure, or other reasons. No resource padding is required.\r
+///\r
+#define  EFI_HPC_STATE_INITIALIZED    0x01\r
 \r
+///\r
+/// The HPC initialization function was called, the HPC completed \r
+/// initialization, and it was enabled. Resource padding is required.\r
+///\r
+#define  EFI_HPC_STATE_ENABLED        0x02\r
+\r
+///\r
+/// Location definition for PCI Hot Plug Controller\r
+///\r
 typedef struct{\r
+  ///\r
+  /// The device path to the Root HPC\r
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *HpcDevicePath;\r
+  ///\r
+  /// The device path to the Hot Plug Bus (HPB) that is controlled by \r
+  /// the root HPC.\r
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *HpbDevicePath;\r
 } EFI_HPC_LOCATION;\r
 \r
@@ -142,11 +163,11 @@ EFI_STATUS
 // Prototypes for the PCI Hot Plug Init Protocol\r
 //\r
 \r
-/**\r
-  This protocol provides the necessary functionality to initialize the\r
-  Hot Plug Controllers (HPCs) and the buses that they control. This protocol\r
-  also provides information regarding resource padding.\r
-**/\r
+///\r
+/// This protocol provides the necessary functionality to initialize the\r
+/// Hot Plug Controllers (HPCs) and the buses that they control. This protocol\r
+/// also provides information regarding resource padding.\r
+///\r
 struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL {\r
   ///\r
   /// Returns a list of root HPCs and the buses that they control.\r