Vlv2TbltDevicePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Vlv2TbltDevicePkg / Include / Protocol / I2cHostMcg.h

/*++\r
\r
  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
                                                                                   \r\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
                                                                                   \r\r
\r
**/\r
\r
#ifndef __I2C_HOST_H__\r
#define __I2C_HOST_H__\r
\r
#include <Protocol/I2cMasterMcg.h>\r
\r
/**\r
  Declare the forward references\r
\r
**/\r
typedef struct _EFI_I2C_HOST_PROTOCOL EFI_I2C_HOST_PROTOCOL;\r
typedef struct _EFI_I2C_HOST_CALLBACKS EFI_I2C_HOST_CALLBACKS;\r
\r
\r
/**\r
  Queue an I2C operation for execution on the I2C controller.\r
\r
  This routine must be called at or below TPL_NOTIFY.  For synchronous\r
  requests this routine must be called at or below TPL_CALLBACK.\r
\r
  N.B. The typical consumers of this API are the I2C bus driver and\r
  on rare occasions the I2C test application.  Extreme care must be\r
  taken by other consumers of this API to prevent confusing the\r
  third party I2C drivers due to a state change at the I2C device\r
  which the third party I2C drivers did not initiate.  I2C platform\r
  drivers may use this API within these guidelines.\r
\r
  This layer uses the concept of I2C bus configurations to describe\r
  the I2C bus.  An I2C bus configuration is defined as a unique\r
  setting of the multiplexers and switches in the I2C bus which\r
  enable access to one or more I2C devices.  When using a switch\r
  to divide a bus, due to speed differences, the I2C platform layer\r
  would define an I2C bus configuration for the I2C devices on each\r
  side of the switch.  When using a multiplexer, the I2C platform\r
  layer defines an I2C bus configuration for each of the selector\r
  values required to control the multiplexer.  See Figure 1 in the\r
  <a href="http://www.nxp.com/documents/user_manual/UM10204.pdf">I<sup>2</sup>C\r
  Specification</a> for a complex I2C bus configuration.\r
\r
  The I2C host driver processes all operations in FIFO order.  Prior to\r
  performing the operation, the I2C host driver calls the I2C platform\r
  driver to reconfigure the switches and multiplexers in the I2C bus\r
  enabling access to the specified I2C device.  The I2C platform driver\r
  also selects the maximum bus speed for the device.  After the I2C bus\r
  is configured, the I2C host driver calls the I2C port driver to\r
  initialize the I2C controller and start the I2C operation.\r
\r
  @param[in] This             Address of an EFI_I2C_HOST_PROTOCOL instance.\r
  @param[in] I2cBusConfiguration  I2C bus configuration to access the I2C\r
                                  device.\r
  @param[in] SlaveAddress     Address of the device on the I2C bus.\r
  @param[in] Event            Event to set for asynchronous operations,\r
                              NULL for synchronous operations\r
  @param[in] RequestPacket    Address of an EFI_I2C_REQUEST_PACKET\r
                              structure describing the I2C operation\r
  @param[out] I2cStatus       Optional buffer to receive the I2C operation\r
                              completion status\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_ABORTED           The request did not complete because the driver\r
                                was shutdown.\r
  @retval EFI_BAD_BUFFER_SIZE   The WriteBytes or ReadBytes buffer size is too large.\r
  @retval EFI_DEVICE_ERROR      There was an I2C error (NACK) during the operation.\r
                                This could indicate the slave device is not present.\r
  @retval EFI_INVALID_PARAMETER RequestPacket is NULL\r
  @retval EFI_INVALID_PARAMETER TPL is too high\r
  @retval EFI_NO_MAPPING        Invalid I2cBusConfiguration value\r
  @retval EFI_NO_RESPONSE       The I2C device is not responding to the\r
                                slave address.  EFI_DEVICE_ERROR may also be\r
                                returned if the controller cannot distinguish\r
                                when the NACK occurred.\r
  @retval EFI_NOT_FOUND         I2C slave address exceeds maximum address\r
  @retval EFI_NOT_READY         I2C bus is busy or operation pending, wait for\r
                                the event and then read status pointed to by\r
                                the request packet.\r
  @retval EFI_OUT_OF_RESOURCES  Insufficient memory for I2C operation\r
  @retval EFI_TIMEOUT           The transaction did not complete within an internally\r
                                specified timeout period.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_HOST_QUEUE_REQUEST) (\r
  IN CONST EFI_I2C_HOST_PROTOCOL *This,\r
  IN UINTN I2cBusConfiguration,\r
  IN UINTN SlaveAddress,\r
  IN EFI_EVENT Event OPTIONAL,\r
  IN CONST EFI_I2C_REQUEST_PACKET *RequestPacket,\r
  OUT EFI_STATUS *I2cStatus OPTIONAL\r
  );\r
\r
///\r
/// Host access to the I2C bus.\r
///\r
struct _EFI_I2C_HOST_PROTOCOL {\r
  ///\r
  /// Queue an operation for execution on the I2C bus\r
  ///\r
  EFI_I2C_HOST_QUEUE_REQUEST QueueRequest;\r
\r
  ///\r
  /// The maximum number of I2C bus configurations\r
  ///\r
  UINTN I2cBusConfigurationCount;\r
\r
  ///\r
  /// The maximum number of bytes the I2C host controller\r
  /// is able to receive from the I2C bus.\r
  ///\r
  UINT32 MaximumReceiveBytes;\r
\r
  ///\r
  /// The maximum number of bytes the I2C host controller\r
  /// is able to send on the I2C bus.\r
  ///\r
  UINT32 MaximumTransmitBytes;\r
\r
  ///\r
  /// The maximum number of bytes in the I2C bus transaction.\r
  ///\r
  UINT32 MaximumTotalBytes;\r
};\r
\r
///\r
/// GUID for the EFI_I2C_HOST_PROTOCOL\r
///\r
extern EFI_GUID gEfiI2cHostProtocolGuid;\r
\r
#endif  //  __I2C_HOST_H__\r