Committing changes to the comments, after review with engineers.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 89d3ecf25128a5b5b75db0fd76e187615e4320cf..8834bd2a7d6f1f02a6878f3e3d327c7b05e61df5 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -1,5 +1,5 @@
 /** @file\r
 /** @file\r

-  This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM \r
+  This file declares the 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 - 2009, Intel Corporation\r
   uses to access its SMBus controller and the slave devices attached to it.\r
 \r
   Copyright (c) 2007 - 2009, Intel Corporation\r


@@ -20,7 +20,6 @@
 #ifndef _PEI_SMBUS_PPI_H_\r
 #define _PEI_SMBUS_PPI_H_\r
 \r
 #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
 #include <Ppi/Smbus2.h>\r
 \r
 #define EFI_PEI_SMBUS_PPI_GUID \\r


@@ -33,19 +32,19 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
 /**\r
   Executes an SMBus operation to an SMBus controller.\r
 \r
 /**\r
   Executes an SMBus operation to an SMBus controller.\r
 \r

-  @param  PeiServices    A pointer to the system PEI Services Table.\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
-                         device is preassigned or allocated.\r
-  @param  Command        This command is transmitted by the SMBus host\r
-                         controller to the SMBus slave device and the interpretation is\r
-                         SMBus slave device specific.\r
-  @param  Operation      Signifies which particular SMBus hardware protocol\r
-                         instance that it will use to execute the SMBus transactions.\r
-  @param  PecCheck       Defines if Packet Error Code (PEC) checking is required\r
-                         for this operation.\r
-  @param  Length         Signifies the number of bytes that this operation will do.\r
-  @param  Buffer         Contains the value of data to execute to the SMBus slave device.\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
+                                device is preassigned or allocated.\r
+  @param[in]      Command       This command is transmitted by the SMBus host\r
+                                controller to the SMBus slave device and the interpretation is\r
+                                SMBus slave device specific.\r
+  @param[in]      Operation     Signifies which particular SMBus hardware protocol\r
+                                instance to use to execute the SMBus transactions.\r
+  @param[in]      PecCheck      Defines if Packet Error Code (PEC) checking is required\r
+                                for this operation.\r
+  @param[in, out] Length        The number of bytes for this operation\r
+  @param[in, out] Buffer        Contains the value of data to execute to the SMBus slave device.\r

 \r
   @retval EFI_SUCCESS           The last data that was returned from the access\r
                                 matched the poll exit criteria.\r
 \r
   @retval EFI_SUCCESS           The last data that was returned from the access\r
                                 matched the poll exit criteria.\r


@@ -55,7 +54,7 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
                                 due to a lack of resources.\r
   @retval EFI_DEVICE_ERROR      The request was not completed because\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
                                 due to a lack of resources.\r
   @retval EFI_DEVICE_ERROR      The request was not completed because\r

-                                a failure reflected in the Host Status Register bit.\r
+                                a failure was recorded in the Host Status Register bit.\r

   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
   @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r
                                 EfiSmbusQuickWrite. Length is outside the range of valid values.\r
   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
   @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r
                                 EfiSmbusQuickWrite. Length is outside the range of valid values.\r


@@ -77,14 +76,14 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
+  This function is user-defined, and is called when the SlaveAddress/Data pair happens.\r

 \r
 \r

-  @param  PeiServices    A pointer to the system PEI Services Table.\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
-                         device is preassigned or allocated.\r
-  @param  Data           Data of the SMBus host notify command that\r
-                         the caller wants to be called.\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
+                             device is preassigned or allocated.\r
+  @param[in]  Data           Data of the SMBus host notify command, which denotes that\r
+                             the caller wants to be called.\r

 \r
   @return Status Code returned by callback function.\r
 \r
 \r
   @return Status Code returned by callback function.\r
 \r


@@ -99,20 +98,21 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  The ArpDevice() function enumerates the entire bus or enumerates a specific\r
-  device that is identified by SmbusUdid.\r
-\r
-  @param  PeiServices    A pointer to the system PEI Services Table.\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  ArpAll         A Boolean expression that indicates if the host drivers need\r
-                         to enumerate all the devices or enumerate only the device that is identified\r
-                         by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r
-                         If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address\r
-                         will be at SlaveAddress.\r
-  @param  SmbusUdid      The targeted SMBus Unique Device Identifier (UDID).\r
-                         The UDID may not exist for SMBus devices with fixed addresses.\r
-  @param  SlaveAddress   The new SMBus address for the slave device for\r
-                         which the operation is targeted.\r
+  The ArpDevice() function enumerates either the entire bus or a specific\r
+  device identified by SmbusUdid.\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]      ArpAll        A Boolean expression that indicates if the host drivers need\r
+                                to enumerate all the devices or enumerate only the device that is identified\r
+                                by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional and ignored if entered.\r
+                                If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address\r
+                                will be at SlaveAddress.\r
+  @param[in]      SmbusUdid     The targeted SMBus Unique Device Identifier (UDID).\r
+                                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
 \r
   @retval EFI_SUCCESS           The SMBus slave device address was set.\r
   @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r


@@ -120,6 +120,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
                                 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() is not implemented by this PEIM. \r
+                                This return value is not defined in Framwork Specification.\r
+                                This return value was introduced in the PI Specification.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -136,13 +139,16 @@ EFI_STATUS
   The GetArpMap() function returns the mapping of all the SMBus devices\r
   that are enumerated by the SMBus host driver.\r
 \r
   The GetArpMap() function returns the mapping of all the SMBus devices\r
   that are enumerated by the SMBus host driver.\r
 \r

-  @param  PeiServices    A pointer to the system PEI Services Table.\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  Length         Size of the buffer that contains the SMBus device map.\r
-  @param  SmbusDeviceMap The pointer to the device map as enumerated\r
-                         by the SMBus controller driver.\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, out] Length         Size of the buffer that contains the SMBus device map.\r
+  @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated\r
+                                 by the SMBus controller driver.\r

 \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 was introduced in the PI Specification.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -160,17 +166,22 @@ 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
 \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

-\r
-  @param  PeiServices    A pointer to the system PEI Services Table.\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  SlaveAddress   Address that the host controller detects as\r
-                         sending a message and calls all the registered functions.\r
-  @param  Data           Data that the host controller detects as sending a message\r
-                         and calls all the registered functions.\r
-  @param  NotifyFunction The function to call when the bus driver\r
-                         detects the SlaveAddress and Data pair.\r
-\r
-  @retval EFI_SUCCESS      NotifyFunction has been registered.\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
+  @param[in] SlaveAddress   Address that the host controller detects as\r
+                            sending a message and triggers all the registered functions.\r
+  @param[in] Data           Data that the host controller detects as sending a message\r
+                            and triggers all the registered functions.\r
+  @param[in] NotifyFunction The function to call when the bus driver\r
+                            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 was introduced in the PI Specification.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r