InternalSmbusLib.h File Reference

#include <PiPei.h>
#include <Ppi/Smbus2.h>
#include <Library/SmbusLib.h>
#include <Library/DebugLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/BaseMemoryLib.h>

Go to the source code of this file.

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

Detailed Description

Internal header file for Smbus library.

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

Definition in file InternalSmbusLib.h.

Function Documentation

InternalGetSmbusPpi()

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.

Definition at line 22 of file PeiSmbusLib.c.

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

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.

Definition at line 69 of file DxeSmbusLib.c.