1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/i2c/i2c-rk3x.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Rockchip RK3xxx I2C controller
8
9description:
10  This driver interfaces with the native I2C controller present in Rockchip
11  RK3xxx SoCs.
12
13allOf:
14  - $ref: /schemas/i2c/i2c-controller.yaml#
15
16maintainers:
17  - Heiko Stuebner <heiko@sntech.de>
18
19# Everything else is described in the common file
20properties:
21  compatible:
22    oneOf:
23      - const: rockchip,rv1108-i2c
24      - const: rockchip,rk3066-i2c
25      - const: rockchip,rk3188-i2c
26      - const: rockchip,rk3228-i2c
27      - const: rockchip,rk3288-i2c
28      - const: rockchip,rk3399-i2c
29      - items:
30          - enum:
31              - rockchip,rk3036-i2c
32              - rockchip,rk3128-i2c
33              - rockchip,rk3368-i2c
34          - const: rockchip,rk3288-i2c
35      - items:
36          - enum:
37              - rockchip,px30-i2c
38              - rockchip,rk3308-i2c
39              - rockchip,rk3328-i2c
40              - rockchip,rk3562-i2c
41              - rockchip,rk3568-i2c
42              - rockchip,rk3576-i2c
43              - rockchip,rk3588-i2c
44              - rockchip,rv1126-i2c
45          - const: rockchip,rk3399-i2c
46
47  reg:
48    maxItems: 1
49
50  interrupts:
51    maxItems: 1
52
53  clocks:
54    minItems: 1
55    items:
56      - description:
57          For older hardware (rk3066, rk3188, rk3228, rk3288)
58          there is one clock that is used both to derive the functional clock
59          for the device and as the bus clock.
60          For newer hardware (rk3399) this clock is used to derive
61          the functional clock
62      - description:
63          For newer hardware (rk3399) this is the bus clock
64
65  clock-names:
66    minItems: 1
67    items:
68      - const: i2c
69      - const: pclk
70
71  rockchip,grf:
72    $ref: /schemas/types.yaml#/definitions/phandle
73    description:
74      Required on RK3066, RK3188 the phandle of the syscon node for
75      the general register file (GRF)
76      On those SoCs an alias with the correct I2C bus ID
77      (bit offset in the GRF) is also required.
78
79  clock-frequency:
80    default: 100000
81    description:
82      SCL frequency to use (in Hz). If omitted, 100kHz is used.
83
84  i2c-scl-rising-time-ns:
85    default: 1000
86    description:
87      Number of nanoseconds the SCL signal takes to rise
88      (t(r) in I2C specification). If not specified this is assumed to be
89      the maximum the specification allows(1000 ns for Standard-mode,
90      300 ns for Fast-mode) which might cause slightly slower communication.
91
92  i2c-scl-falling-time-ns:
93    default: 300
94    description:
95      Number of nanoseconds the SCL signal takes to fall
96      (t(f) in the I2C specification). If not specified this is assumed to
97      be the maximum the specification allows (300 ns) which might cause
98      slightly slower communication.
99
100  i2c-sda-falling-time-ns:
101    default: 300
102    description:
103      Number of nanoseconds the SDA signal takes to fall
104      (t(f) in the I2C specification). If not specified we will use the SCL
105      value since they are the same in nearly all cases.
106
107required:
108  - compatible
109  - reg
110  - interrupts
111  - clocks
112  - clock-names
113
114if:
115  properties:
116    compatible:
117      contains:
118        enum:
119          - rockchip,rk3066-i2c
120          - rockchip,rk3188-i2c
121
122then:
123  required:
124    - rockchip,grf
125
126unevaluatedProperties: false
127
128examples:
129  - |
130    #include <dt-bindings/clock/rk3188-cru-common.h>
131    #include <dt-bindings/interrupt-controller/arm-gic.h>
132    #include <dt-bindings/interrupt-controller/irq.h>
133    i2c0: i2c@2002d000 {
134      compatible = "rockchip,rk3188-i2c";
135      reg = <0x2002d000 0x1000>;
136      interrupts = <GIC_SPI 40 IRQ_TYPE_LEVEL_HIGH>;
137      clocks = <&cru PCLK_I2C0>;
138      clock-names = "i2c";
139      rockchip,grf = <&grf>;
140      i2c-scl-falling-time-ns = <100>;
141      i2c-scl-rising-time-ns = <800>;
142      #address-cells = <1>;
143      #size-cells = <0>;
144    };
145