diff options
| author | Wolfram Sang <wsa+renesas@sang-engineering.com> | 2015-12-08 04:37:45 -0500 |
|---|---|---|
| committer | Wolfram Sang <wsa@the-dreams.de> | 2015-12-14 04:39:01 -0500 |
| commit | 99b809d7bdd17de7a68f1625a8973052c8311657 (patch) | |
| tree | e2048c0ea9099daad6a2342c9e30670fafe69bc4 | |
| parent | c31d0a00021d7289c01edc3d9670da52132d0457 (diff) | |
i2c: document generic DT bindings for timing parameters
Also, sort the properties alphabetically and make indentation
consistent. Wording largely taken from i2c-rk3x.txt, thanks guys!
Only "i2c-scl-internal-delay-ns" is new, the rest is used by two drivers
already and was documented in their driver binding documentation.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
| -rw-r--r-- | Documentation/devicetree/bindings/i2c/i2c.txt | 31 |
1 files changed, 26 insertions, 5 deletions
diff --git a/Documentation/devicetree/bindings/i2c/i2c.txt b/Documentation/devicetree/bindings/i2c/i2c.txt index 8a99150ac3a7..a00219f5ee07 100644 --- a/Documentation/devicetree/bindings/i2c/i2c.txt +++ b/Documentation/devicetree/bindings/i2c/i2c.txt | |||
| @@ -29,12 +29,33 @@ Optional properties | |||
| 29 | These properties may not be supported by all drivers. However, if a driver | 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. | 30 | wants to support one of the below features, it should adapt the bindings below. |
| 31 | 31 | ||
| 32 | - clock-frequency - frequency of bus clock in Hz. | 32 | - clock-frequency |
| 33 | - wakeup-source - device can be used as a wakeup source. | 33 | frequency of bus clock in Hz. |
| 34 | 34 | ||
| 35 | - interrupts - interrupts used by the device. | 35 | - i2c-scl-falling-time-ns |
| 36 | - interrupt-names - "irq" and "wakeup" names are recognized by I2C core, | 36 | Number of nanoseconds the SCL signal takes to fall; t(f) in the I2C |
| 37 | other names are left to individual drivers. | 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 | - wakeup-source | ||
| 58 | device can be used as a wakeup source. | ||
| 38 | 59 | ||
| 39 | Binding may contain optional "interrupts" property, describing interrupts | 60 | Binding may contain optional "interrupts" property, describing interrupts |
| 40 | used by the device. I2C core will assign "irq" interrupt (or the very first | 61 | used by the device. I2C core will assign "irq" interrupt (or the very first |