]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Library / PeiSmbusLibSmbus2Ppi / InternalSmbusLib.h
index 0ba5d63575e3612cb7fc89312b0c18ee5589b642..633b18bc2905e7e526980fad8b0b2abc55bb53d4 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
 Internal header file for Smbus library.\r
 \r
-Copyright (c) 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2018, 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,31 +13,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef __INTERNAL_SMBUS_LIB_H\r
-#define __INTERNAL_SMBUS_LIB_H\r
+#ifndef __INTERNAL_SMBUS_LIB_H_\r
+#define __INTERNAL_SMBUS_LIB_H_\r
+\r
 \r
-//\r
-// The package level header files this module uses\r
-//\r
 #include <PiPei.h>\r
-//\r
-// The protocols, PPI and GUID defintions for this module\r
-//\r
+\r
 #include <Ppi/Smbus2.h>\r
-//\r
-// The Library classes this module consumes\r
-//\r
+\r
 #include <Library/SmbusLib.h>\r
 #include <Library/DebugLib.h>\r
-#include <Library/PeiServicesTablePointerLib.h>\r
+#include <Library/PeiServicesLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
 \r
-#define SMBUS_LIB_SLAVE_ADDRESS(SmBusAddress)      (((SmBusAddress) >> 1)  & 0x7f)\r
-#define SMBUS_LIB_COMMAND(SmBusAddress)            (((SmBusAddress) >> 8)  & 0xff)\r
-#define SMBUS_LIB_LENGTH(SmBusAddress)             (((SmBusAddress) >> 16) & 0x3f)\r
-#define SMBUS_LIB_PEC(SmBusAddress)     ((BOOLEAN) (((SmBusAddress) & SMBUS_LIB_PEC_BIT) != 0))\r
-#define SMBUS_LIB_RESEARVED(SmBusAddress)          ((SmBusAddress) & ~(((1 << 22) - 2) | SMBUS_LIB_PEC_BIT))\r
-\r
 //\r
 // Declaration for internal functions\r
 //\r
@@ -47,14 +35,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   This internal function retrieves Smbus PPI from PPI database.\r
 \r
-  @param  PeiServices   An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
+  @param  VOID\r
 \r
   @return The pointer to Smbus PPI.\r
 \r
 **/\r
 EFI_PEI_SMBUS2_PPI *\r
 InternalGetSmbusPpi (\r
-  EFI_PEI_SERVICES      **PeiServices\r
+  VOID\r
   );\r
 \r
 /**\r
@@ -64,14 +52,16 @@ InternalGetSmbusPpi (
   as defined in the SmBus Specification. The data can either be of\r
   the Length byte, word, or a block of data.\r
 \r
-  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance that it will use to\r
-                          execute the SMBus transactions.\r
-  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
+  @param  SmbusOperation  Signifies which particular SMBus hardware protocol\r
+                          instance that it will use to execute the SMBus transactions.\r
+  @param  SmBusAddress    The address that encodes the SMBUS Slave Address,\r
                           SMBUS Command, SMBUS Data Length, and PEC.\r
-  @param  Length          Signifies the number of bytes that this operation will do. The maximum number of\r
-                          bytes can be revision specific and operation specific.\r
-  @param  Buffer          Contains the value of data to execute to the SMBus slave device. Not all operations\r
-                          require this argument. The length of this buffer is identified by Length.\r
+  @param  Length          Signifies the number of bytes that this operation will\r
+                          do. The maximum number of bytes can be revision specific\r
+                          and operation specific.\r
+  @param  Buffer          Contains the value of data to execute to the SMBus slave\r
+                          device. Not all operations require this argument. The\r
+                          length of this buffer is identified by Length.\r
   @param  Status          Return status for the executed command.\r
                           This is an optional parameter and may be NULL.\r
 \r