IntelFrameworkPkg/Include/Ppi/Smbus.h

   1 /** @file
   2   This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM
   3   uses to access its SMBus controller and the slave devices attached to it.
   4
   5   Copyright (c) 2007 - 2009, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   @par Revision Reference:
  15   This PPI is defined in Framework of EFI SmBus PPI spec.
  16   Version 0.9
  17
  18 **/
  19
  20 #ifndef _PEI_SMBUS_PPI_H_
  21 #define _PEI_SMBUS_PPI_H_
  22
  23 #include <PiPei.h>
  24 #include <Ppi/Smbus2.h>
  25
  26 #define EFI_PEI_SMBUS_PPI_GUID \
  27   { \
  28     0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0xb, 0xfb, 0xda } \
  29   }
  30
  31 typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
  32
  33 /**
  34   Executes an SMBus operation to an SMBus controller.
  35
  36   @param[in]      PeiServices   A pointer to the system PEI Services Table.
  37   @param[in]      This          A pointer to the EFI_PEI_SMBUS_PPI instance.
  38   @param[in]      SlaveAddress  The SMBUS hardware address to which the SMBUS
  39                                 device is preassigned or allocated.
  40   @param[in]      Command       This command is transmitted by the SMBus host
  41                                 controller to the SMBus slave device and the interpretation is
  42                                 SMBus slave device specific.
  43   @param[in]      Operation     Signifies which particular SMBus hardware protocol
  44                                 instance that it will use to execute the SMBus transactions.
  45   @param[in]      PecCheck      Defines if Packet Error Code (PEC) checking is required
  46                                 for this operation.
  47   @param[in, out] Length        Signifies the number of bytes that this operation will do.
  48   @param[in, out] Buffer        Contains the value of data to execute to the SMBus slave device.
  49
  50   @retval EFI_SUCCESS           The last data that was returned from the access
  51                                 matched the poll exit criteria.
  52   @retval EFI_CRC_ERROR         The checksum is not correct (PEC is incorrect).
  53   @retval EFI_TIMEOUT           Timeout expired before the operation was completed.
  54                                 Timeout is determined by the SMBus host controller device.
  55   @retval EFI_OUT_OF_RESOURCES  The request could not be completed
  56                                 due to a lack of resources.
  57   @retval EFI_DEVICE_ERROR      The request was not completed because
  58                                 a failure reflected in the Host Status Register bit.
  59   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
  60   @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
  61                                 EfiSmbusQuickWrite. Length is outside the range of valid values.
  62   @retval EFI_UNSUPPORTED       The SMBus operation or PEC is not supported.
  63   @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.
  64
  65 **/
  66 typedef
  67 EFI_STATUS
  68 (EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(
  69   IN      EFI_PEI_SERVICES          **PeiServices,
  70   IN      EFI_PEI_SMBUS_PPI         *This,
  71   IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,
  72   IN      EFI_SMBUS_DEVICE_COMMAND  Command,
  73   IN      EFI_SMBUS_OPERATION       Operation,
  74   IN      BOOLEAN                   PecCheck,
  75   IN OUT  UINTN                     *Length,
  76   IN OUT  VOID                      *Buffer
  77   );
  78
  79 /**
  80   CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
  81
  82   This function is user-defined and will called when the SlaveAddress/Data pair happens.
  83
  84   @param[in]  PeiServices    A pointer to the system PEI Services Table.
  85   @param[in]  This           A pointer to the EFI_PEI_SMBUS_PPI instance.
  86   @param[in]  SlaveAddress   The SMBUS hardware address to which the SMBUS
  87                              device is preassigned or allocated.
  88   @param[in]  Data           Data of the SMBus host notify command that
  89                              the caller wants to be called.
  90
  91   @return Status Code returned by callback function.
  92
  93 **/
  94 typedef
  95 EFI_STATUS
  96 (EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(
  97   IN      EFI_PEI_SERVICES              **PeiServices,
  98   IN      EFI_PEI_SMBUS_PPI             *SmbusPpi,
  99   IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,
 100   IN      UINTN                         Data
 101   );
 102
 103 /**
 104   The ArpDevice() function enumerates the entire bus or enumerates a specific
 105   device that is identified by SmbusUdid.
 106
 107   @param[in]      PeiServices   A pointer to the system PEI Services Table.
 108   @param[in]      This          A pointer to the EFI_PEI_SMBUS_PPI instance.
 109   @param[in]      ArpAll        A Boolean expression that indicates if the host drivers need
 110                                 to enumerate all the devices or enumerate only the device that is identified
 111                                 by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
 112                                 If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
 113                                 will be at SlaveAddress.
 114   @param[in]      SmbusUdid     The targeted SMBus Unique Device Identifier (UDID).
 115                                 The UDID may not exist for SMBus devices with fixed addresses.
 116   @param[in, out] SlaveAddress  The new SMBus address for the slave device for
 117                                 which the operation is targeted.
 118                                 This address may be NULL.
 119
 120   @retval EFI_SUCCESS           The SMBus slave device address was set.
 121   @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
 122   @retval EFI_OUT_OF_RESOURCES  The request could not be completed
 123                                 due to a lack of resources.
 124   @retval EFI_TIMEOUT           The SMBus slave device did not respond.
 125   @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.
 126   @retval EFI_UNSUPPORTED       ArpDevice() are not implemented by this PEIM.
 127                                 This return value is not defined in Framwork Specification.
 128                                 This return value had been intruduced in PI Specification.
 129
 130 **/
 131 typedef
 132 EFI_STATUS
 133 (EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(
 134   IN      EFI_PEI_SERVICES          **PeiServices,
 135   IN      EFI_PEI_SMBUS_PPI         *This,
 136   IN      BOOLEAN                   ArpAll,
 137   IN      EFI_SMBUS_UDID            *SmbusUdid, OPTIONAL
 138   IN OUT  EFI_SMBUS_DEVICE_ADDRESS  *SlaveAddress OPTIONAL
 139   );
 140
 141 /**
 142   The GetArpMap() function returns the mapping of all the SMBus devices
 143   that are enumerated by the SMBus host driver.
 144
 145   @param[in]      PeiServices    A pointer to the system PEI Services Table.
 146   @param[in]      This           A pointer to the EFI_PEI_SMBUS_PPI instance.
 147   @param[in, out] Length         Size of the buffer that contains the SMBus device map.
 148   @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated
 149                                  by the SMBus controller driver.
 150
 151   @retval EFI_SUCCESS       The device map was returned correctly in the buffer.
 152   @retval EFI_UNSUPPORTED   GetArpMap() are not implemented by this PEIM.
 153                             This return value was not defined in Framwork Specification.
 154                             This return value had been intruduced in PI Specification.
 155
 156 **/
 157 typedef
 158 EFI_STATUS
 159 (EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(
 160   IN      EFI_PEI_SERVICES          **PeiServices,
 161   IN      EFI_PEI_SMBUS_PPI         *This,
 162   IN OUT  UINTN                     *Length,
 163   IN OUT  EFI_SMBUS_DEVICE_MAP      **SmbusDeviceMap
 164   );
 165
 166 /**
 167   Allows a device driver to register for a callback when the bus driver detects a state that it needs to
 168   propagate to other PEIMs that are registered for a callback.
 169
 170   The Notify() function registers all the callback functions to allow the
 171   bus driver to call these functions when the SlaveAddress/Data pair happens.
 172   All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type
 173   EFI_PEI_SMBUS_NOTIFY_FUNCTION.
 174
 175   @param[in] PeiServices    A pointer to the system PEI Services Table.
 176   @param[in] This           A pointer to the EFI_PEI_SMBUS_PPI instance.
 177   @param[in] SlaveAddress   Address that the host controller detects as
 178                             sending a message and calls all the registered functions.
 179   @param[in] Data           Data that the host controller detects as sending a message
 180                             and calls all the registered functions.
 181   @param[in] NotifyFunction The function to call when the bus driver
 182                             detects the SlaveAddress and Data pair.
 183
 184   @retval EFI_SUCCESS       NotifyFunction has been registered.
 185   @retval EFI_UNSUPPORTED   Notify() are not implemented by this PEIM.
 186                             This return value is not defined in Framwork Specification.
 187                             This return value had been intruduced in PI Specification.
 188
 189 **/
 190 typedef
 191 EFI_STATUS
 192 (EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(
 193   IN      EFI_PEI_SERVICES              **PeiServices,
 194   IN      EFI_PEI_SMBUS_PPI             *This,
 195   IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,
 196   IN      UINTN                         Data,
 197   IN      EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction
 198   );
 199
 200 ///
 201 /// Provides the basic I/O interfaces that a PEIM uses to access
 202 /// its SMBus controller and the slave devices attached to it.
 203 ///
 204 struct _EFI_PEI_SMBUS_PPI {
 205   ///
 206   /// Executes the SMBus operation to an SMBus slave device.
 207   ///
 208   EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;
 209
 210   ///
 211   /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)
 212   ///
 213   EFI_PEI_SMBUS_PPI_ARP_DEVICE        ArpDevice;
 214
 215   ///
 216   /// Allows a PEIM to retrieve the address that was allocated by the SMBus
 217   /// host controller during enumeration/ARP.
 218   ///
 219   EFI_PEI_SMBUS_PPI_GET_ARP_MAP       GetArpMap;
 220
 221   ///
 222   /// Allows a driver to register for a callback to the SMBus host
 223   /// controller driver when the bus issues a notification to the bus controller PEIM.
 224   ///
 225   EFI_PEI_SMBUS_PPI_NOTIFY            Notify;
 226 };
 227
 228 extern EFI_GUID gEfiPeiSmbusPpiGuid;
 229
 230 #endif