added comments per framework spec.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 77f52af66ab02d5d6259356382357639aeb767a7..89d3ecf25128a5b5b75db0fd76e187615e4320cf 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -11,8 +11,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:  Smbus.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in Framework of EFI SmBus PPI spec.\r
   Version 0.9\r
@@ -51,7 +49,7 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
 \r
   @retval EFI_SUCCESS           The last data that was returned from the access\r
                                 matched the poll exit criteria.\r
-  @retval EFI_CRC_ERROR         The checksum is not correct (PEC is incorrect)\r
+  @retval EFI_CRC_ERROR         The checksum is not correct (PEC is incorrect).\r
   @retval EFI_TIMEOUT           Timeout expired before the operation was completed.\r
                                 Timeout is determined by the SMBus host controller device.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
@@ -59,7 +57,7 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
   @retval EFI_DEVICE_ERROR      The request was not completed because\r
                                 a failure reflected in the Host Status Register bit.\r
   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
-                                Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\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_UNSUPPORTED       The SMBus operation or PEC is not supported.\r
   @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.\r
@@ -88,7 +86,7 @@ EFI_STATUS
   @param  Data           Data of the SMBus host notify command that\r
                          the caller wants to be called.\r
 \r
-  @return Status Code\r
+  @return Status Code returned by callback function.\r
 \r
 **/\r
 typedef\r
@@ -144,7 +142,7 @@ EFI_STATUS
   @param  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
 \r
 **/\r
 typedef\r
@@ -157,6 +155,9 @@ EFI_STATUS
   );\r
 \r
 /**\r
+  Allows a device driver to register for a callback when the bus driver detects a state that it needs to \r
+  propagate to other PEIMs that are registered for a callback.\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
@@ -169,23 +170,23 @@ EFI_STATUS
   @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
+  @retval EFI_SUCCESS      NotifyFunction has been registered.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(\r
-  IN      EFI_PEI_SERVICES          **PeiServices,\r
-  IN      EFI_PEI_SMBUS_PPI         *This,\r
-  IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
-  IN      UINTN                     Data,\r
+  IN      EFI_PEI_SERVICES              **PeiServices,\r
+  IN      EFI_PEI_SMBUS_PPI             *This,\r
+  IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,\r
+  IN      UINTN                         Data,\r
   IN      EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction\r
   );\r
 \r
-/**\r
-  Provides the basic I/O interfaces that a PEIM uses to access\r
-  its SMBus controller and the slave devices attached to it.\r
-**/\r
+///\r
+/// Provides the basic I/O interfaces that a PEIM uses to access\r
+/// its SMBus controller and the slave devices attached to it.\r
+///\r
 struct _EFI_PEI_SMBUS_PPI {\r
   ///\r
   /// Executes the SMBus operation to an SMBus slave device.\r