Documentation/devicetree/bindings/i2c/i2c.txt

   1 Generic device tree bindings for I2C busses
   2 ===========================================
   3
   4 This document describes generic bindings which can be used to describe I2C
   5 busses in a device tree.
   6
   7 Required properties
   8 -------------------
   9
  10 - #address-cells  - should be <1>. Read more about addresses below.
  11 - #size-cells     - should be <0>.
  12 - compatible      - name of I2C bus controller following generic names
  13                     recommended practice.
  14
  15 For other required properties e.g. to describe register sets,
  16 clocks, etc. check the binding documentation of the specific driver.
  17
  18 The cells properties above define that an address of children of an I2C bus
  19 are described by a single value. This is usually a 7 bit address. However,
  20 flags can be attached to the address. I2C_TEN_BIT_ADDRESS is used to mark a 10
  21 bit address. It is needed to avoid the ambiguity between e.g. a 7 bit address
  22 of 0x50 and a 10 bit address of 0x050 which, in theory, can be on the same bus.
  23 Another flag is I2C_OWN_SLAVE_ADDRESS to mark addresses on which we listen to
  24 be devices ourselves.
  25
  26 Optional properties
  27 -------------------
  28
  29 These properties may not be supported by all drivers. However, if a driver
  30 wants to support one of the below features, it should adapt the bindings below.
  31
  32 - clock-frequency
  33         frequency of bus clock in Hz.
  34
  35 - i2c-scl-falling-time-ns
  36         Number of nanoseconds the SCL signal takes to fall; t(f) in the I2C
  37         specification.
  38
  39 - i2c-scl-internal-delay-ns
  40         Number of nanoseconds the IP core additionally needs to setup SCL.
  41
  42 - i2c-scl-rising-time-ns
  43         Number of nanoseconds the SCL signal takes to rise; t(r) in the I2C
  44         specification.
  45
  46 - i2c-sda-falling-time-ns
  47         Number of nanoseconds the SDA signal takes to fall; t(f) in the I2C
  48         specification.
  49
  50 - interrupts
  51         interrupts used by the device.
  52
  53 - interrupt-names
  54         "irq" and "wakeup" names are recognized by I2C core, other names are
  55         left to individual drivers.
  56
  57 - multi-master
  58         states that there is another master active on this bus. The OS can use
  59         this information to adapt power management to keep the arbitration awake
  60         all the time, for example.
  61
  62 - wakeup-source
  63         device can be used as a wakeup source.
  64
  65 - reg
  66         I2C slave addresses
  67
  68 - reg-names
  69         Names of map programmable addresses.
  70         It can contain any map needing another address than default one.
  71
  72 Binding may contain optional "interrupts" property, describing interrupts
  73 used by the device. I2C core will assign "irq" interrupt (or the very first
  74 interrupt if not using interrupt names) as primary interrupt for the slave.
  75
  76 Also, if device is marked as a wakeup source, I2C core will set up "wakeup"
  77 interrupt for the device. If "wakeup" interrupt name is not present in the
  78 binding, then primary interrupt will be used as wakeup interrupt.