MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c File Reference


Functions

EFI_STATUS EFIAPI SmbusLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
UINTN InternalSmBusExec (IN EFI_SMBUS_OPERATION SmbusOperation, IN UINTN SmBusAddress, IN UINTN Length, IN OUT VOID *Buffer, OUT RETURN_STATUS *Status)

Variables

EFI_SMBUS_HC_PROTOCOLmSmbus = NULL

Detailed Description

Implementation of SmBusLib class library for DXE 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

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.

EFI_STATUS EFIAPI SmbusLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

The constructor function caches the pointer to Smbus protocol.

The constructor function locates Smbus protocol from protocol database. It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

Parameters:
ImageHandle The firmware allocated handle for the EFI image.
SystemTable A pointer to the EFI System Table.
Return values:
EFI_SUCCESS The constructor always returns EFI_SUCCESS.

References ASSERT, ASSERT_EFI_ERROR, gBS, gEfiSmbusHcProtocolGuid, EFI_BOOT_SERVICES::LocateProtocol, NULL, and VOID.


Variable Documentation


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