IntelFrameworkPkg/Include/Ppi/Smbus.h File Reference


Data Structures

struct  _EFI_PEI_SMBUS_PPI

Defines

#define EFI_PEI_SMBUS_PPI_GUID

Typedefs

typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI
typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN EFI_SMBUS_DEVICE_COMMAND Command, IN EFI_SMBUS_OPERATION Operation, IN BOOLEAN PecCheck, IN OUT UINTN *Length, IN OUT VOID *Buffer)
typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_NOTIFY_FUNCTION )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *SmbusPpi, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN UINTN Data)
typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_ARP_DEVICE )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN BOOLEAN ArpAll, IN EFI_SMBUS_UDID *SmbusUdid, IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress)
typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_GET_ARP_MAP )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN OUT UINTN *Length, IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap)
typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_NOTIFY )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN UINTN Data, IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction)

Variables

EFI_GUID gEfiPeiSmbusPpiGuid

Detailed Description

This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM uses to access its SMBus controller and the slave devices attached to it.

Copyright (c) 2007 - 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 that 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.

Revision Reference:
This PPI is defined in Framework of EFI SmBus PPI spec. Version 0.9.

Define Documentation

#define EFI_PEI_SMBUS_PPI_GUID

Value:

{ \
    0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0xb, 0xfb, 0xda } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_NOTIFY_FUNCTION)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *SmbusPpi, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN UINTN Data)

This function is user-defined, and is called when the SlaveAddress/Data pair happens.

Parameters:
[in] PeiServices A pointer to the system PEI Services Table.
[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
[in] SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or allocated.
[in] Data Data of the SMBus host notify command, which denotes that the caller wants to be called.
Returns:
Status Code returned by callback function.

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_ARP_DEVICE)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN BOOLEAN ArpAll, IN EFI_SMBUS_UDID *SmbusUdid, IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress)

The ArpDevice() function enumerates either the entire bus or a specific device identified by SmbusUdid.

Parameters:
[in] PeiServices A pointer to the system PEI Services Table.
[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
[in] ArpAll A Boolean expression that indicates if the host drivers need to enumerate all the devices or to enumerate only the device that is identified by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional and ignored if entered. If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid, and the address will be at SlaveAddress.
[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID). The UDID may not exist for SMBus devices with fixed addresses.
[in,out] SlaveAddress The new SMBus address for the slave device for which the operation is targeted. This address may be NULL.
Return values:
EFI_SUCCESS The SMBus slave device address was set.
EFI_INVALID_PARAMETER SlaveAddress is NULL.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_TIMEOUT The SMBus slave device did not respond.
EFI_DEVICE_ERROR The request was not completed because the transaction failed.
EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM. This return value is not defined in the Framework Specification. This return value was introduced in the PI Specification.

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN EFI_SMBUS_DEVICE_COMMAND Command, IN EFI_SMBUS_OPERATION Operation, IN BOOLEAN PecCheck, IN OUT UINTN *Length, IN OUT VOID *Buffer)

Executes an SMBus operation to an SMBus controller.

Parameters:
[in] PeiServices A pointer to the system PEI Services Table.
[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
[in] SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or allocated.
[in] Command This command is transmitted by the SMBus host controller to the SMBus slave device, and the interpretation is SMBus slave device specific.
[in] Operation Signifies which particular SMBus hardware protocol instance to use to execute the SMBus transactions.
[in] PecCheck Defines if Packet Error Code (PEC) checking is required for this operation.
[in,out] Length The number of bytes for this operation.
[in,out] Buffer Contains the value of data to execute to the SMBus slave device.
Return values:
EFI_SUCCESS The last data that was returned from the access matched the poll exit criteria.
EFI_CRC_ERROR The checksum is not correct (PEC is incorrect).
EFI_TIMEOUT Timeout expired before the operation was completed. Timeout is determined by the SMBus host controller device.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_DEVICE_ERROR The request was not completed because a failure was recorded in the Host Status Register bit.
EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.
EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for EfiSmbusQuickRead and EfiSmbusQuickWrite. Length is outside the range of valid values.
EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN OUT UINTN *Length, IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap)

The GetArpMap() function returns the mapping of all the SMBus devices that are enumerated by the SMBus host driver.

Parameters:
[in] PeiServices A pointer to the system PEI Services Table.
[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
[in,out] Length The size of the buffer that contains the SMBus device map.
[in,out] SmbusDeviceMap The pointer to the device map as enumerated by the SMBus controller driver.
Return values:
EFI_SUCCESS The device map was returned correctly in the buffer.
EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM. This return value was not defined in the Framework Specification. This return value was introduced in the PI Specification.

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMBUS_PPI_NOTIFY)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SMBUS_PPI *This, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN UINTN Data, IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction)

Allows a device driver to register for a callback when the bus driver detects a state that it needs to propagate to other PEIMs that are registered for a callback.

The Notify() function registers all the callback functions to allow the bus driver to call these functions when the SlaveAddress/Data pair occur. All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type EFI_PEI_SMBUS_NOTIFY_FUNCTION.

Parameters:
[in] PeiServices A pointer to the system PEI Services Table.
[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
[in] SlaveAddress The address that the host controller detects as sending a message and triggers all the registered functions.
[in] Data Data that the host controller detects as sending a message and triggers all the registered functions.
[in] NotifyFunction The function to call when the bus driver detects the SlaveAddress and Data pair.
Return values:
EFI_SUCCESS NotifyFunction has been registered.
EFI_UNSUPPORTED Notify() are not implemented by this PEIM. This return value is not defined in the Framework Specification. This return value was introduced in the PI Specification.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1