Rename Framework SmbusLib instance

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3329 6f19259b-4bc3-4df7-8a09-765794883524
2007-07-18 14:53:54 +00:00
parent aa4165e44b
commit 1257d0d837
5 changed files with 0 additions and 0 deletions
--- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
+++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
@@ -0,0 +1,99 @@
+/** @file
+Implementation of SmBusLib class library for PEI phase.
+
+Copyright (c) 2006, Intel Corporation<BR>
+All rights reserved. This program and the accompanying materials                          
+are licensed and made available under the terms and conditions of the BSD License         
+which accompanies this distribution.  The full text of the license may be found at        
+http://opensource.org/licenses/bsd-license.php                                            
+                                                                                          
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+
+
+Module Name: PeiSmbusLib.c
+
+**/
+
+#include "InternalSmbusLib.h"
+
+/**
+  Gets Smbus PPIs.
+
+  This internal function retrieves Smbus PPI from PPI database.
+
+  @param  PeiServices   An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
+
+  @return The pointer to Smbus PPI.
+
+**/
+EFI_PEI_SMBUS_PPI *
+InternalGetSmbusPpi (
+  EFI_PEI_SERVICES      **PeiServices
+  ) 
+{
+  EFI_STATUS            Status;
+  EFI_PEI_SMBUS_PPI     *SmbusPpi;
+
+  Status = (*PeiServices)->LocatePpi (PeiServices, &gEfiPeiSmbusPpiGuid, 0, NULL, (VOID **) &SmbusPpi);
+  ASSERT_EFI_ERROR (Status);
+  ASSERT (SmbusPpi != NULL);
+
+  return SmbusPpi;
+}
+
+/**
+  Executes an SMBus operation to an SMBus controller. 
+
+  This function provides a standard way to execute Smbus script
+  as defined in the SmBus Specification. The data can either be of
+  the Length byte, word, or a block of data.
+
+  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance that it will use to
+                          execute the SMBus transactions.
+  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,
+                          SMBUS Command, SMBUS Data Length, and PEC.
+  @param  Length          Signifies the number of bytes that this operation will do. The maximum number of
+                          bytes can be revision specific and operation specific.
+  @param  Buffer          Contains the value of data to execute to the SMBus slave device. Not all operations
+                          require this argument. The length of this buffer is identified by Length.
+  @param  Status          Return status for the executed command.
+                          This is an optional parameter and may be NULL.
+
+  @return The actual number of bytes that are executed for this operation..
+
+**/
+UINTN
+InternalSmBusExec (
+  IN     EFI_SMBUS_OPERATION        SmbusOperation,
+  IN     UINTN                      SmBusAddress,
+  IN     UINTN                      Length,
+  IN OUT VOID                       *Buffer,
+     OUT RETURN_STATUS              *Status        OPTIONAL
+  )
+{
+  EFI_PEI_SMBUS_PPI         *SmbusPpi;
+  EFI_PEI_SERVICES          **PeiServices;
+  RETURN_STATUS             ReturnStatus;
+  EFI_SMBUS_DEVICE_ADDRESS  SmbusDeviceAddress;
+
+  PeiServices = GetPeiServicesTablePointer ();
+  SmbusPpi    = InternalGetSmbusPpi (PeiServices);
+  SmbusDeviceAddress.SmbusDeviceAddress = SMBUS_LIB_SLAVE_ADDRESS (SmBusAddress);
+
+  ReturnStatus = SmbusPpi->Execute (
+                             PeiServices,
+                             SmbusPpi,
+                             SmbusDeviceAddress,
+                             SMBUS_LIB_COMMAND (SmBusAddress),
+                             SmbusOperation,
+                             SMBUS_LIB_PEC (SmBusAddress),  
+                             &Length,
+                             Buffer
+                             );
+  if (Status != NULL) {
+    *Status = ReturnStatus;
+  }
+
+  return Length;
+}