MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / I2cMaster.h

/** @file\r
  I2C Master Protocol as defined in the PI 1.3 specification.\r
\r
  This protocol manipulates the I2C host controller to perform transactions as a master\r
  on the I2C bus using the current state of any switches or multiplexers in the I2C bus.\r
\r
  Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This protocol is from PI Version 1.3.\r
\r
**/\r
\r
#ifndef __I2C_MASTER_H__\r
#define __I2C_MASTER_H__\r
\r
#include <Pi/PiI2c.h>\r
\r
#define EFI_I2C_MASTER_PROTOCOL_GUID { 0xcd72881f, 0x45b5, 0x4feb, { 0x98, 0xc8, 0x31, 0x3d, 0xa8, 0x11, 0x74, 0x62 }}\r
\r
typedef struct _EFI_I2C_MASTER_PROTOCOL EFI_I2C_MASTER_PROTOCOL;\r
\r
/**\r
  Set the frequency for the I2C clock line.\r
\r
  This routine must be called at or below TPL_NOTIFY.\r
\r
  The software and controller do a best case effort of using the specified\r
  frequency for the I2C bus.  If the frequency does not match exactly then\r
  the I2C master protocol selects the next lower frequency to avoid\r
  exceeding the operating conditions for any of the I2C devices on the bus.\r
  For example if 400 KHz was specified and the controller's divide network\r
  only supports 402 KHz or 398 KHz then the I2C master protocol selects 398\r
  KHz.  If there are not lower frequencies available, then return\r
  EFI_UNSUPPORTED.\r
\r
  @param[in] This           Pointer to an EFI_I2C_MASTER_PROTOCOL structure\r
  @param[in] BusClockHertz  Pointer to the requested I2C bus clock frequency\r
                            in Hertz.  Upon return this value contains the\r
                            actual frequency in use by the I2C controller.\r
\r
  @retval EFI_SUCCESS           The bus frequency was set successfully.\r
  @retval EFI_ALREADY_STARTED   The controller is busy with another transaction.\r
  @retval EFI_INVALID_PARAMETER BusClockHertz is NULL\r
  @retval EFI_UNSUPPORTED       The controller does not support this frequency.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_MASTER_PROTOCOL_SET_BUS_FREQUENCY) (\r
  IN CONST EFI_I2C_MASTER_PROTOCOL   *This,\r
  IN OUT UINTN                       *BusClockHertz\r
  );\r
\r
/**\r
  Reset the I2C controller and configure it for use\r
\r
  This routine must be called at or below TPL_NOTIFY.\r
\r
  The I2C controller is reset.  The caller must call SetBusFrequench() after\r
  calling Reset().\r
\r
  @param[in]     This       Pointer to an EFI_I2C_MASTER_PROTOCOL structure.\r
\r
  @retval EFI_SUCCESS         The reset completed successfully.\r
  @retval EFI_ALREADY_STARTED The controller is busy with another transaction.\r
  @retval EFI_DEVICE_ERROR    The reset operation failed.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_MASTER_PROTOCOL_RESET) (\r
  IN CONST EFI_I2C_MASTER_PROTOCOL *This\r
  );\r
\r
/**\r
  Start an I2C transaction on the host 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
  This function initiates an I2C transaction on the controller.  To\r
  enable proper error handling by the I2C protocol stack, the I2C\r
  master protocol does not support queuing but instead only manages\r
  one I2C transaction at a time.  This API requires that the I2C bus\r
  is in the correct configuration for the I2C transaction.\r
\r
  The transaction is performed by sending a start-bit and selecting the\r
  I2C device with the specified I2C slave address and then performing\r
  the specified I2C operations.  When multiple operations are requested\r
  they are separated with a repeated start bit and the slave address.\r
  The transaction is terminated with a stop bit.\r
\r
  When Event is NULL, StartRequest operates synchronously and returns\r
  the I2C completion status as its return value.\r
\r
  When Event is not NULL, StartRequest synchronously returns EFI_SUCCESS\r
  indicating that the I2C transaction was started asynchronously.  The\r
  transaction status value is returned in the buffer pointed to by\r
  I2cStatus upon the completion of the I2C transaction when I2cStatus\r
  is not NULL.  After the transaction status is returned the Event is\r
  signaled.\r
\r
  Note: The typical consumer of this API is the I2C host protocol.\r
  Extreme care must be taken by other consumers of this API to prevent\r
  confusing the third party I2C drivers due to a state change at the\r
  I2C device which the third party I2C drivers did not initiate.  I2C\r
  platform specific code may use this API within these guidelines.\r
\r
  @param[in] This           Pointer to an EFI_I2C_MASTER_PROTOCOL structure.\r
  @param[in] SlaveAddress   Address of the device on the I2C bus.  Set the\r
                            I2C_ADDRESSING_10_BIT when using 10-bit addresses,\r
                            clear this bit for 7-bit addressing.  Bits 0-6\r
                            are used for 7-bit I2C slave addresses and bits\r
                            0-9 are used for 10-bit I2C slave addresses.\r
  @param[in] RequestPacket  Pointer to an EFI_I2C_REQUEST_PACKET\r
                            structure describing the I2C transaction.\r
  @param[in] Event          Event to signal for asynchronous transactions,\r
                            NULL for asynchronous transactions\r
  @param[out] I2cStatus     Optional buffer to receive the I2C transaction\r
                            completion status\r
\r
  @retval EFI_SUCCESS           The asynchronous transaction was successfully\r
                                started when Event is not NULL.\r
  @retval EFI_SUCCESS           The transaction completed successfully when\r
                                Event is NULL.\r
  @retval EFI_ALREADY_STARTED   The controller is busy with another transaction.\r
  @retval EFI_BAD_BUFFER_SIZE   The RequestPacket->LengthInBytes value is too\r
                                large.\r
  @retval EFI_DEVICE_ERROR      There was an I2C error (NACK) during the\r
                                transaction.\r
  @retval EFI_INVALID_PARAMETER RequestPacket is NULL\r
  @retval EFI_NOT_FOUND         Reserved bit set in the SlaveAddress parameter\r
  @retval EFI_NO_RESPONSE       The I2C device is not responding to the slave\r
                                address.  EFI_DEVICE_ERROR will be returned if\r
                                the controller cannot distinguish when the NACK\r
                                occurred.\r
  @retval EFI_OUT_OF_RESOURCES  Insufficient memory for I2C transaction\r
  @retval EFI_UNSUPPORTED       The controller does not support the requested\r
                                transaction.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_MASTER_PROTOCOL_START_REQUEST) (\r
  IN CONST EFI_I2C_MASTER_PROTOCOL *This,\r
  IN UINTN                         SlaveAddress,\r
  IN EFI_I2C_REQUEST_PACKET        *RequestPacket,\r
  IN EFI_EVENT                     Event      OPTIONAL,\r
  OUT EFI_STATUS                   *I2cStatus OPTIONAL\r
  );\r
\r
///\r
/// I2C master mode protocol\r
///\r
/// This protocol manipulates the I2C host controller to perform transactions as a\r
/// master on the I2C bus using the current state of any switches or multiplexers\r
/// in the I2C bus.\r
///\r
struct _EFI_I2C_MASTER_PROTOCOL {\r
  ///\r
  /// Set the clock frequency for the I2C bus.\r
  ///\r
  EFI_I2C_MASTER_PROTOCOL_SET_BUS_FREQUENCY SetBusFrequency;\r
\r
  ///\r
  /// Reset the I2C host controller.\r
  ///\r
  EFI_I2C_MASTER_PROTOCOL_RESET             Reset;\r
\r
  ///\r
  /// Start an I2C transaction in master mode on the host controller.\r
  ///\r
  EFI_I2C_MASTER_PROTOCOL_START_REQUEST     StartRequest;\r
\r
  ///\r
  /// Pointer to an EFI_I2C_CONTROLLER_CAPABILITIES data structure containing\r
  /// the capabilities of the I2C host controller.\r
  ///\r
  CONST EFI_I2C_CONTROLLER_CAPABILITIES     *I2cControllerCapabilities;\r
};\r
\r
extern EFI_GUID gEfiI2cMasterProtocolGuid;\r
\r
#endif  //  __I2C_MASTER_H__\r