MdePkg/BaseLib: Add more comments for safe string functions.

[mirror_edk2.git] / MdePkg / Include / Ppi / Smbus2.h

diff --git a/MdePkg/Include/Ppi/Smbus2.h b/MdePkg/Include/Ppi/Smbus2.h
index 1cc546782b980f6bc0478f2df65a73ffbe53e585..a0aac6d8eb584febf99f928070cd415177214fe1 100644 (file)
--- a/MdePkg/Include/Ppi/Smbus2.h
+++ b/MdePkg/Include/Ppi/Smbus2.h
@@ -3,8 +3,8 @@
   This PPI provides the basic I/O interfaces that a PEIM uses to access its \r
   SMBus controller and the slave devices attached to it.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -13,8 +13,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  This PPI is defined in PI.\r
-  Version 1.00\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -29,13 +28,7 @@
 \r
 typedef struct _EFI_PEI_SMBUS2_PPI EFI_PEI_SMBUS2_PPI;\r
 \r
-//\r
-// EFI_SMBUS_DEVICE_COMMAND\r
-//\r
-typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;\r
-\r
-\r
-/*\r
+/**\r
   Executes an SMBus operation to an SMBus controller. Returns when either \r
   the command has been executed or an error is encountered in doing the operation.\r
 \r
@@ -122,20 +115,6 @@ EFI_STATUS
   IN OUT    EFI_SMBUS_DEVICE_ADDRESS  *SlaveAddress OPTIONAL\r
 );\r
 \r
-\r
-typedef struct {\r
-  ///\r
-  /// The SMBUS hardware address to which the SMBUS device is preassigned or\r
-  /// allocated. Type EFI_SMBUS_DEVICE_ADDRESS is defined in EFI_PEI_SMBUS2_PPI.Execute().\r
-  ///\r
-  EFI_SMBUS_DEVICE_ADDRESS  SmbusDeviceAddress;\r
-  ///\r
-  /// The SMBUS Unique Device Identifier (UDID) as defined in EFI_SMBUS_UDID.\r
-  /// Type EFI_SMBUS_UDID is defined in EFI_PEI_SMBUS2_PPI.ArpDevice().\r
-  ///\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
@@ -209,23 +188,9 @@ EFI_STATUS
 ///  its SMBus controller and the slave devices attached to it.\r
 ///\r
 struct _EFI_PEI_SMBUS2_PPI {\r
-  ///\r
-  /// Executes the SMBus operation to an SMBus slave device.\r
-  ///\r
   EFI_PEI_SMBUS2_PPI_EXECUTE_OPERATION  Execute;\r
-  ///\r
-  /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP).\r
-  ///\r
   EFI_PEI_SMBUS2_PPI_ARP_DEVICE         ArpDevice;\r
-  ///\r
-  /// Allows a PEIM to retrieve the address that was allocated by the SMBus \r
-  /// host controller during enumeration/ARP.\r
-  ///\r
   EFI_PEI_SMBUS2_PPI_GET_ARP_MAP        GetArpMap;\r
-  ///\r
-  /// Allows a driver to register for a callback to the SMBus host \r
-  /// controller driver when the bus issues a notification to the bus controller PEIM.\r
-  ///\r
   EFI_PEI_SMBUS2_PPI_NOTIFY             Notify;\r
   ///\r
   /// Identifier which uniquely identifies this SMBus controller in a system.\r