Update the copyright notice format

[mirror_edk2.git] / MdePkg / Include / Protocol / SmbusHc.h

diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h
index 59826b7e9bb81d0ad149ae3789ee14a92b65baac..9d11f5652518725acc507cc940dde1e75fe3699a 100644 (file)
--- a/MdePkg/Include/Protocol/SmbusHc.h
+++ b/MdePkg/Include/Protocol/SmbusHc.h
@@ -2,8 +2,8 @@
   The file provides basic SMBus host controller management \r
   and basic data transactions over the SMBus.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                          \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2009, 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
@@ -19,7 +19,7 @@
 #ifndef __SMBUS_HC_H__\r
 #define __SMBUS_HC_H__\r
 \r
-#include <Ppi/Smbus2.h>\r
+#include <IndustryStandard/SmBus.h>\r
 \r
 #define EFI_SMBUS_HC_PROTOCOL_GUID \\r
   {0xe49d33ed, 0x513d, 0x4634, { 0xb6, 0x98, 0x6f, 0x55, 0xaa, 0x75, 0x1c, 0x1b} }\r
@@ -32,7 +32,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
   operation as defined in the System Management Bus (SMBus)\r
   Specification. The resulting transaction will be either that\r
   the SMBus slave devices accept this transaction or that this\r
-  function returns with error. Status Codes Returned\r
+  function returns with error. \r
   \r
   @param This     A pointer to the EFI_SMBUS_HC_PROTOCOL instance.\r
                   SlaveAddress The SMBus slave address of the device\r
@@ -51,8 +51,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
                   EFI_SMBUS_DEVICE_COMMAND is defined in\r
                   EFI_PEI_SMBUS_PPI.Execute() in the Platform\r
                   Initialization SMBus PPI Specification.\r
-                  Operation Signifies which particular SMBus\r
-                  hardware protocol instance that it will use to\r
+\r
+ @param Operation Signifies the particular SMBus\r
+                  hardware protocol instance it will use to\r
                   execute the SMBus transactions. This SMBus\r
                   hardware protocol is defined by the SMBus\r
                   Specification and is not related to PI\r
@@ -64,8 +65,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
   @param PecCheck Defines if Packet Error Code (PEC) checking\r
                   is required for this operation. SMBus Host\r
                   Controller Code Definitions Version 1.0\r
-                  August 21, 2006 13 Length Signifies the\r
-                  number of bytes that this operation will do.\r
+                  August 21, 2006 13 \r
+                  \r
+ @param Length    Signifies the number of bytes that this operation will do.\r
                   The maximum number of bytes can be revision\r
                   specific and operation specific. This field\r
                   will contain the actual number of bytes that\r
@@ -274,29 +276,11 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data\r
-  transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus\r
-  host controller.\r
-\r
-  @param Execute    Executes the SMBus operation to an SMBus slave\r
-                    device. See the Execute() function description.\r
-  \r
-  @param ArpDevice  Allows an SMBus 2.0 device(s) to be Address\r
-                    Resolution Protocol (ARP).\r
-  \r
-  @param GetArpMap  Allows a driver to retrieve the address that\r
-                    was allocated by the SMBus host controller\r
-                    during enumeration/ARP. See the GetArpMap()\r
-                    function description.\r
-  \r
-  @param  Notify    Allows a driver to register for a callback\r
-                    to the SMBus host controller driver when the\r
-                    bus issues a notification to the bus\r
-                    controller driver. See the Notify() function\r
-                    description.\r
-**/\r
+///\r
+/// The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data\r
+/// transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus\r
+/// host controller.\r
+///\r
 struct _EFI_SMBUS_HC_PROTOCOL {\r
   EFI_SMBUS_HC_EXECUTE_OPERATION    Execute;\r
   EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE  ArpDevice;\r