]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SmbusHc.h
Add the detailed descriptions for the structure data member in these protocol.
[mirror_edk2.git] / MdePkg / Include / Protocol / SmbusHc.h
index 59826b7e9bb81d0ad149ae3789ee14a92b65baac..5431c49d5e9a715755d01ed7b0157dd3c0b2a3cd 100644 (file)
@@ -19,7 +19,7 @@
 #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
@@ -274,29 +274,11 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data\r
-  transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus\r
-  host controller.\r
-\r
-  @param Execute    Executes the SMBus operation to an SMBus slave\r
-                    device. See the Execute() function description.\r
-  \r
-  @param ArpDevice  Allows an SMBus 2.0 device(s) to be Address\r
-                    Resolution Protocol (ARP).\r
-  \r
-  @param GetArpMap  Allows a driver to retrieve the address that\r
-                    was allocated by the SMBus host controller\r
-                    during enumeration/ARP. See the GetArpMap()\r
-                    function description.\r
-  \r
-  @param  Notify    Allows a driver to register for a callback\r
-                    to the SMBus host controller driver when the\r
-                    bus issues a notification to the bus\r
-                    controller driver. See the Notify() function\r
-                    description.\r
-**/\r
+///\r
+/// The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data\r
+/// transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus\r
+/// host controller.\r
+///\r
 struct _EFI_SMBUS_HC_PROTOCOL {\r
   EFI_SMBUS_HC_EXECUTE_OPERATION    Execute;\r
   EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE  ArpDevice;\r