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,rk3368-i2c
33          - const: rockchip,rk3288-i2c
34      - items:
35          - enum:
36              - rockchip,px30-i2c
37              - rockchip,rk3308-i2c
38              - rockchip,rk3328-i2c
39              - rockchip,rk3568-i2c
40              - rockchip,rk3588-i2c
41          - const: rockchip,rk3399-i2c
42
43  reg:
44    maxItems: 1
45
46  interrupts:
47    maxItems: 1
48
49  clocks:
50    minItems: 1
51    items:
52      - description:
53          For older hardware (rk3066, rk3188, rk3228, rk3288)
54          there is one clock that is used both to derive the functional clock
55          for the device and as the bus clock.
56          For newer hardware (rk3399) this clock is used to derive
57          the functional clock
58      - description:
59          For newer hardware (rk3399) this is the bus clock
60
61  clock-names:
62    minItems: 1
63    items:
64      - const: i2c
65      - const: pclk
66
67  rockchip,grf:
68    $ref: /schemas/types.yaml#/definitions/phandle
69    description:
70      Required on RK3066, RK3188 the phandle of the syscon node for
71      the general register file (GRF)
72      On those SoCs an alias with the correct I2C bus ID
73      (bit offset in the GRF) is also required.
74
75  clock-frequency:
76    default: 100000
77    description:
78      SCL frequency to use (in Hz). If omitted, 100kHz is used.
79
80  i2c-scl-rising-time-ns:
81    default: 1000
82    description:
83      Number of nanoseconds the SCL signal takes to rise
84      (t(r) in I2C specification). If not specified this is assumed to be
85      the maximum the specification allows(1000 ns for Standard-mode,
86      300 ns for Fast-mode) which might cause slightly slower communication.
87
88  i2c-scl-falling-time-ns:
89    default: 300
90    description:
91      Number of nanoseconds the SCL signal takes to fall
92      (t(f) in the I2C specification). If not specified this is assumed to
93      be the maximum the specification allows (300 ns) which might cause
94      slightly slower communication.
95
96  i2c-sda-falling-time-ns:
97    default: 300
98    description:
99      Number of nanoseconds the SDA signal takes to fall
100      (t(f) in the I2C specification). If not specified we will use the SCL
101      value since they are the same in nearly all cases.
102
103required:
104  - compatible
105  - reg
106  - interrupts
107  - clocks
108  - clock-names
109
110if:
111  properties:
112    compatible:
113      contains:
114        enum:
115          - rockchip,rk3066-i2c
116          - rockchip,rk3188-i2c
117
118then:
119  required:
120    - rockchip,grf
121
122unevaluatedProperties: false
123
124examples:
125  - |
126    #include <dt-bindings/clock/rk3188-cru-common.h>
127    #include <dt-bindings/interrupt-controller/arm-gic.h>
128    #include <dt-bindings/interrupt-controller/irq.h>
129    i2c0: i2c@2002d000 {
130      compatible = "rockchip,rk3188-i2c";
131      reg = <0x2002d000 0x1000>;
132      interrupts = <GIC_SPI 40 IRQ_TYPE_LEVEL_HIGH>;
133      clocks = <&cru PCLK_I2C0>;
134      clock-names = "i2c";
135      rockchip,grf = <&grf>;
136      i2c-scl-falling-time-ns = <100>;
137      i2c-scl-rising-time-ns = <800>;
138      #address-cells = <1>;
139      #size-cells = <0>;
140    };
141