Add more comments for IntelFramework's header files.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / Smbus.h

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 54e6f5896317f23f7f27b2768ad0700ba9aef76b..afb2491086520b8a19e2f005bbd190bd28b5548e 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -1,5 +1,6 @@
 /** @file\r
-  This file declares Smbus PPI.\r
+  This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM \r
+  uses to access its SMBus controller and the slave devices attached to it.\r
 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -21,7 +22,8 @@
 #ifndef _PEI_SMBUS_PPI_H\r
 #define _PEI_SMBUS_PPI_H\r
 \r
-#include <IndustryStandard/SmBus.h>\r
+#include <PiPei.h>\r
+#include <Ppi/Smbus2.h>\r
 \r
 #define EFI_PEI_SMBUS_PPI_GUID \\r
   { \\r
@@ -76,17 +78,6 @@ EFI_STATUS
   IN OUT  VOID                      *Buffer\r
   );\r
 \r
-typedef struct {\r
-  UINT32  VendorSpecificId;\r
-  UINT16  SubsystemDeviceId;\r
-  UINT16  SubsystemVendorId;\r
-  UINT16  Interface;\r
-  UINT16  DeviceId;\r
-  UINT16  VendorId;\r
-  UINT8   VendorRevision;\r
-  UINT8   DeviceCapabilities;\r
-} EFI_SMBUS_UDID;\r
-\r
 /**\r
   CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
 \r
@@ -143,11 +134,6 @@ EFI_STATUS
   IN OUT  EFI_SMBUS_DEVICE_ADDRESS  *SlaveAddress OPTIONAL\r
   );\r
 \r
-typedef struct {\r
-  EFI_SMBUS_DEVICE_ADDRESS  SmbusDeviceAddress;\r
-  EFI_SMBUS_UDID            SmbusDeviceUdid;\r
-} EFI_SMBUS_DEVICE_MAP;\r
-\r
 /**\r
   The GetArpMap() function returns the mapping of all the SMBus devices\r
   that are enumerated by the SMBus host driver.\r