MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c File Reference


Functions

EFI_PEI_SMBUS2_PPIInternalGetSmbusPpi (VOID)
UINTN InternalSmBusExec (IN EFI_SMBUS_OPERATION SmbusOperation, IN UINTN SmBusAddress, IN UINTN Length, IN OUT VOID *Buffer, OUT RETURN_STATUS *Status)

Detailed Description

Implementation of SmBusLib class library for PEI phase.

Copyright (c) 2006 - 2010, Intel Corporation. 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.


Function Documentation

EFI_PEI_SMBUS2_PPI* InternalGetSmbusPpi ( VOID   ) 

Gets Smbus PPIs.

This internal function retrieves Smbus PPI from PPI database.

Parameters:
VOID 
Returns:
The pointer to Smbus PPI.

References ASSERT, ASSERT_EFI_ERROR, gEfiPeiSmbus2PpiGuid, NULL, PeiServicesLocatePpi(), and VOID.

Referenced by InternalSmBusExec().

UINTN InternalSmBusExec ( IN EFI_SMBUS_OPERATION  SmbusOperation,
IN UINTN  SmBusAddress,
IN UINTN  Length,
IN OUT VOID *  Buffer,
OUT RETURN_STATUS Status 
)

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.

Parameters:
SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to execute the SMBus transactions.
SmBusAddress The address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Length Signifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific.
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.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The actual number of bytes that are executed for this operation.

References _EFI_PEI_SMBUS2_PPI::Execute, _EFI_SMBUS_HC_PROTOCOL::Execute, InternalGetSmbusPpi(), NULL, SMBUS_LIB_COMMAND, SMBUS_LIB_PEC, SMBUS_LIB_SLAVE_ADDRESS, and EFI_SMBUS_DEVICE_ADDRESS::SmbusDeviceAddress.

Referenced by SmBusBlockProcessCall(), SmBusProcessCall(), SmBusQuickRead(), SmBusQuickWrite(), SmBusReadBlock(), SmBusReadDataByte(), SmBusReadDataWord(), SmBusReceiveByte(), SmBusSendByte(), SmBusWriteBlock(), SmBusWriteDataByte(), and SmBusWriteDataWord().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1