InternalSmbusLib.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal header file for Smbus library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Declaration for internal functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets Smbus PPIs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This internal function retrieves Smbus PPI from PPI database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to Smbus PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBus operation to an SMBus controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function provides a standard way to execute Smbus script
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as defined in the SmBus Specification. The data can either be of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Length byte, word, or a block of data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execute the SMBus transactions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length Signifies the number of bytes that this operation will do. The maximum number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes can be revision specific and operation specific.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync require this argument. The length of this buffer is identified by Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The actual number of bytes that are executed for this operation.