c1d8b697cf
Fix various typos in documentation, comments and strings, and remove the duplicated 'the'. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <liming.gao@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-25-philmd@redhat.com>
99 lines
3.2 KiB
C
99 lines
3.2 KiB
C
/** @file
|
|
Implementation of SmBusLib class library for DXE phase.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
|
|
**/
|
|
|
|
|
|
#include "InternalSmbusLib.h"
|
|
|
|
|
|
//
|
|
// Global variable to cache pointer to Smbus protocol.
|
|
//
|
|
EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL;
|
|
|
|
/**
|
|
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.
|
|
|
|
@param ImageHandle The firmware allocated handle for the EFI image.
|
|
@param SystemTable A pointer to the EFI System Table.
|
|
|
|
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmbusLibConstructor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
|
|
Status = gBS->LocateProtocol (&gEfiSmbusHcProtocolGuid, NULL, (VOID**) &mSmbus);
|
|
ASSERT_EFI_ERROR (Status);
|
|
ASSERT (mSmbus != NULL);
|
|
|
|
return 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.
|
|
|
|
@param SmbusOperation Signifies which particular SMBus hardware protocol instance
|
|
that it will use to execute the SMBus transactions.
|
|
@param SmBusAddress The 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
|
|
)
|
|
{
|
|
RETURN_STATUS ReturnStatus;
|
|
EFI_SMBUS_DEVICE_ADDRESS SmbusDeviceAddress;
|
|
|
|
SmbusDeviceAddress.SmbusDeviceAddress = SMBUS_LIB_SLAVE_ADDRESS (SmBusAddress);
|
|
|
|
ReturnStatus = mSmbus->Execute (
|
|
mSmbus,
|
|
SmbusDeviceAddress,
|
|
SMBUS_LIB_COMMAND (SmBusAddress),
|
|
SmbusOperation,
|
|
SMBUS_LIB_PEC (SmBusAddress),
|
|
&Length,
|
|
Buffer
|
|
);
|
|
if (Status != NULL) {
|
|
*Status = ReturnStatus;
|
|
}
|
|
|
|
return Length;
|
|
}
|