Clean the public header files to remove the unnecessary include files.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 9cfe330f3daae04b9ad712b3f3ecdb87fcfb3eec..3833937adbcf2c36ddf8b75d5efb599400a6b12e 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -20,7 +20,6 @@
 #ifndef _PEI_SMBUS_PPI_H_\r
 #define _PEI_SMBUS_PPI_H_\r
 \r
-#include <PiPei.h>\r
 #include <Ppi/Smbus2.h>\r
 \r
 #define EFI_PEI_SMBUS_PPI_GUID \\r
@@ -79,6 +78,8 @@ EFI_STATUS
 /**\r
   CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
 \r
+  This function is user-defined and will called when the SlaveAddress/Data pair happens.\r
+\r
   @param[in]  PeiServices    A pointer to the system PEI Services Table.\r
   @param[in]  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
   @param[in]  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
@@ -113,6 +114,7 @@ EFI_STATUS
                                 The UDID may not exist for SMBus devices with fixed addresses.\r
   @param[in, out] SlaveAddress  The new SMBus address for the slave device for\r
                                 which the operation is targeted.\r
+                                This address may be NULL.\r
 \r
   @retval EFI_SUCCESS           The SMBus slave device address was set.\r
   @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
@@ -120,6 +122,9 @@ EFI_STATUS
                                 due to a lack of resources.\r
   @retval EFI_TIMEOUT           The SMBus slave device did not respond.\r
   @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.\r
+  @retval EFI_UNSUPPORTED       ArpDevice() are not implemented by this PEIM. \r
+                                This return value is not defined in Framwork Specification.\r
+                                This return value had been intruduced in PI Specification.\r
 \r
 **/\r
 typedef\r
@@ -142,7 +147,10 @@ EFI_STATUS
   @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated\r
                                  by the SMBus controller driver.\r
 \r
-  @retval EFI_SUCCESS   The device map was returned correctly in the buffer.\r
+  @retval EFI_SUCCESS       The device map was returned correctly in the buffer.\r
+  @retval EFI_UNSUPPORTED   GetArpMap() are not implemented by this PEIM. \r
+                            This return value was not defined in Framwork Specification.\r
+                            This return value had been intruduced in PI Specification.\r
 \r
 **/\r
 typedef\r
@@ -160,6 +168,8 @@ EFI_STATUS
 \r
   The Notify() function registers all the callback functions to allow the\r
   bus driver to call these functions when the SlaveAddress/Data pair happens.\r
+  All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type\r
+  EFI_PEI_SMBUS_NOTIFY_FUNCTION.\r
 \r
   @param[in] PeiServices    A pointer to the system PEI Services Table.\r
   @param[in] This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
@@ -171,6 +181,9 @@ EFI_STATUS
                             detects the SlaveAddress and Data pair.\r
 \r
   @retval EFI_SUCCESS       NotifyFunction has been registered.\r
+  @retval EFI_UNSUPPORTED   Notify() are not implemented by this PEIM. \r
+                            This return value is not defined in Framwork Specification.\r
+                            This return value had been intruduced in PI Specification.\r
 \r
 **/\r
 typedef\r