update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 54e6f5896317f23f7f27b2768ad0700ba9aef76b..dff06ce7bb89b03ee572236b662420f073588a91 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -1,5 +1,6 @@
 /** @file\r
-  This file declares Smbus PPI.\r
+  This file declares 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, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -18,10 +19,11 @@
 \r
 **/\r
 \r
-#ifndef _PEI_SMBUS_PPI_H\r
-#define _PEI_SMBUS_PPI_H\r
+#ifndef _PEI_SMBUS_PPI_H_\r
+#define _PEI_SMBUS_PPI_H_\r
 \r
-#include <IndustryStandard/SmBus.h>\r
+#include <PiPei.h>\r
+#include <Ppi/Smbus2.h>\r
 \r
 #define EFI_PEI_SMBUS_PPI_GUID \\r
   { \\r
@@ -65,9 +67,9 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION) (\r
+(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(\r
   IN      EFI_PEI_SERVICES          **PeiServices,\r
-  IN EFI_PEI_SMBUS_PPI              *This,\r
+  IN      EFI_PEI_SMBUS_PPI         *This,\r
   IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
   IN      EFI_SMBUS_DEVICE_COMMAND  Command,\r
   IN      EFI_SMBUS_OPERATION       Operation,\r
@@ -76,17 +78,6 @@ EFI_STATUS
   IN OUT  VOID                      *Buffer\r
   );\r
 \r
-typedef struct {\r
-  UINT32  VendorSpecificId;\r
-  UINT16  SubsystemDeviceId;\r
-  UINT16  SubsystemVendorId;\r
-  UINT16  Interface;\r
-  UINT16  DeviceId;\r
-  UINT16  VendorId;\r
-  UINT8   VendorRevision;\r
-  UINT8   DeviceCapabilities;\r
-} EFI_SMBUS_UDID;\r
-\r
 /**\r
   CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
 \r
@@ -102,9 +93,9 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION) (\r
+(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(\r
   IN      EFI_PEI_SERVICES              **PeiServices,\r
-  IN EFI_PEI_SMBUS_PPI                  *SmbusPpi,\r
+  IN      EFI_PEI_SMBUS_PPI             *SmbusPpi,\r
   IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,\r
   IN      UINTN                         Data\r
   );\r
@@ -135,19 +126,14 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE) (\r
+(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(\r
   IN      EFI_PEI_SERVICES          **PeiServices,\r
-  IN EFI_PEI_SMBUS_PPI              *This,\r
+  IN      EFI_PEI_SMBUS_PPI         *This,\r
   IN      BOOLEAN                   ArpAll,\r
   IN      EFI_SMBUS_UDID            *SmbusUdid, OPTIONAL\r
   IN OUT  EFI_SMBUS_DEVICE_ADDRESS  *SlaveAddress OPTIONAL\r
   );\r
 \r
-typedef struct {\r
-  EFI_SMBUS_DEVICE_ADDRESS  SmbusDeviceAddress;\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
@@ -158,14 +144,14 @@ typedef struct {
   @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
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP) (\r
+(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(\r
   IN      EFI_PEI_SERVICES          **PeiServices,\r
-  IN EFI_PEI_SMBUS_PPI              *This,\r
+  IN      EFI_PEI_SMBUS_PPI         *This,\r
   IN OUT  UINTN                     *Length,\r
   IN OUT  EFI_SMBUS_DEVICE_MAP      **SmbusDeviceMap\r
   );\r
@@ -183,17 +169,17 @@ 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
+(EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(\r
   IN      EFI_PEI_SERVICES          **PeiServices,\r
-  IN EFI_PEI_SMBUS_PPI              *This,\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
+  IN      EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction\r
   );\r
 \r
 /**\r