mirror of https://github.com/acidanthera/audk.git
61 lines
2.8 KiB
C
61 lines
2.8 KiB
C
|
/** @file
|
||
|
|
Internal header file for Smbus library.
|
||
|
|
|
||
|
|
Copyright (c) 2006, Intel Corporation<BR>
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef __INTERNAL_SMBUS_LIB_H
|
||
|
|
#define __INTERNAL_SMBUS_LIB_H
|
||
|
|
|
||
|
|
#include <IndustryStandard/Smbus.h>
|
||
|
|
|
||
|
|
#define SMBUS_LIB_SLAVE_ADDRESS(SmBusAddress) (((SmBusAddress) >> 1) & 0x7f)
|
||
|
|
#define SMBUS_LIB_COMMAND(SmBusAddress) (((SmBusAddress) >> 8) & 0xff)
|
||
|
|
#define SMBUS_LIB_LENGTH(SmBusAddress) (((SmBusAddress) >> 16) & 0x3f)
|
||
|
|
#define SMBUS_LIB_PEC(SmBusAddress) ((BOOLEAN) (((SmBusAddress) & SMBUS_LIB_PEC_BIT) != 0))
|
||
|
|
#define SMBUS_LIB_RESEARVED(SmBusAddress) ((SmBusAddress) & ~(((1 << 22) - 2) | SMBUS_LIB_PEC_BIT))
|
||
|
|
|
||
|
|
//
|
||
|
|
// Declaration for internal functions
|
||
|
|
//
|
||
|
|
/**
|
||
|
|
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 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
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|