MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  I2C Device Enumerate Protocol as defined in the PI 1.3 specification.\r
\r
  This protocol supports the enumerations of device on 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_ENUMERATE_H__\r
#define __I2C_ENUMERATE_H__\r
\r
#include <Pi/PiI2c.h>\r
\r
#define EFI_I2C_ENUMERATE_PROTOCOL_GUID   { 0xda8cd7c4, 0x1c00, 0x49e2, { 0x80, 0x3e, 0x52, 0x14, 0xe7, 0x01, 0x89, 0x4c }}\r
\r
typedef struct _EFI_I2C_ENUMERATE_PROTOCOL  EFI_I2C_ENUMERATE_PROTOCOL;\r
\r
/**\r
  Enumerate the I2C devices\r
\r
  This function enables the caller to traverse the set of I2C devices\r
  on an I2C bus.\r
\r
  @param[in]  This              The platform data for the next device on\r
                                the I2C bus was returned successfully.\r
  @param[in, out] Device        Pointer to a buffer containing an\r
                                EFI_I2C_DEVICE structure.  Enumeration is\r
                                started by setting the initial EFI_I2C_DEVICE\r
                                structure pointer to NULL.  The buffer\r
                                receives an EFI_I2C_DEVICE structure pointer\r
                                to the next I2C device.\r
\r
  @retval EFI_SUCCESS           The platform data for the next device on\r
                                the I2C bus was returned successfully.\r
  @retval EFI_INVALID_PARAMETER Device is NULL\r
  @retval EFI_NO_MAPPING        *Device does not point to a valid\r
                                EFI_I2C_DEVICE structure returned in a\r
                                previous call Enumerate().\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_ENUMERATE_PROTOCOL_ENUMERATE) (\r
  IN CONST EFI_I2C_ENUMERATE_PROTOCOL *This,\r
  IN OUT CONST EFI_I2C_DEVICE         **Device\r
  );\r
\r
/**\r
  Get the requested I2C bus frequency for a specified bus configuration.\r
\r
  This function returns the requested I2C bus clock frequency for the\r
  I2cBusConfiguration.  This routine is provided for diagnostic purposes\r
  and is meant to be called after calling Enumerate to get the\r
  I2cBusConfiguration value.\r
\r
  @param[in] This                 Pointer to an EFI_I2C_ENUMERATE_PROTOCOL\r
                                  structure.\r
  @param[in] I2cBusConfiguration  I2C bus configuration to access the I2C\r
                                  device\r
  @param[out] *BusClockHertz      Pointer to a buffer to receive the I2C\r
                                  bus clock frequency in Hertz\r
\r
  @retval EFI_SUCCESS           The I2C bus frequency was returned\r
                                successfully.\r
  @retval EFI_INVALID_PARAMETER BusClockHertz was NULL\r
  @retval EFI_NO_MAPPING        Invalid I2cBusConfiguration value\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_I2C_ENUMERATE_PROTOCOL_GET_BUS_FREQUENCY) (\r
  IN CONST EFI_I2C_ENUMERATE_PROTOCOL *This,\r
  IN UINTN                            I2cBusConfiguration,\r
  OUT UINTN                           *BusClockHertz\r
  );\r
\r
///\r
/// I2C Enumerate protocol\r
///\r
struct _EFI_I2C_ENUMERATE_PROTOCOL {\r
  ///\r
  /// Traverse the set of I2C devices on an I2C bus.  This routine\r
  /// returns the next I2C device on an I2C bus.\r
  ///\r
  EFI_I2C_ENUMERATE_PROTOCOL_ENUMERATE         Enumerate;\r
\r
  ///\r
  /// Get the requested I2C bus frequency for a specified bus\r
  /// configuration.\r
  ///\r
  EFI_I2C_ENUMERATE_PROTOCOL_GET_BUS_FREQUENCY GetBusFrequency;\r
};\r
\r
///\r
/// Reference to variable defined in the .DEC file\r
///\r
extern EFI_GUID gEfiI2cEnumerateProtocolGuid;\r
\r
#endif  //  __I2C_ENUMERATE_H__\r