TianoCore EDK2 master
Loading...
Searching...
No Matches
DxeSmbusLib.c File Reference
#include "InternalSmbusLib.h"

Go to the source code of this file.

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 OPTIONAL)
 

Variables

EFI_SMBUS_HC_PROTOCOLmSmbus = NULL
 

Detailed Description

Implementation of SmBusLib class library for DXE phase.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DxeSmbusLib.c.

Function Documentation

◆ InternalSmBusExec()

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

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
SmbusOperationSignifies which particular SMBus hardware protocol instance that it will use to execute the SMBus transactions.
SmBusAddressThe address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
LengthSignifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific.
BufferContains 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.
StatusReturn 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.

Definition at line 69 of file DxeSmbusLib.c.

◆ SmbusLibConstructor()

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
ImageHandleThe firmware allocated handle for the EFI image.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe constructor always returns EFI_SUCCESS.

Definition at line 31 of file DxeSmbusLib.c.

Variable Documentation

◆ mSmbus

Definition at line 15 of file DxeSmbusLib.c.