Merge tag 'gcc-plugins-v4.9-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git...
[cascardo/linux.git] / Documentation / devicetree / bindings / input / rmi4 / rmi_i2c.txt
1 Synaptics RMI4 I2C Device Binding
2
3 The Synaptics RMI4 core is able to support RMI4 devices using different
4 transports and different functions. This file describes the device tree
5 bindings for devices using the I2C transport driver. Complete documentation
6 for other transports and functions can be found in
7 Documentation/devicetree/bindings/input/rmi4.
8
9 Required Properties:
10 - compatible: syna,rmi4-i2c
11 - reg: I2C address
12 - #address-cells: Set to 1 to indicate that the function child nodes
13                     consist of only on uint32 value.
14 - #size-cells: Set to 0 to indicate that the function child nodes do not
15                 have a size property.
16
17 Optional Properties:
18 - interrupts: interrupt which the rmi device is connected to.
19 - interrupt-parent: The interrupt controller.
20 See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
21
22 - syna,reset-delay-ms: The number of milliseconds to wait after resetting the
23                         device.
24
25 - syna,startup-delay-ms: The number of milliseconds to wait after powering on
26                          the device.
27
28 - vdd-supply: VDD power supply.
29 See ../regulator/regulator.txt
30
31 - vio-supply: VIO power supply
32 See ../regulator/regulator.txt
33
34 Function Parameters:
35 Parameters specific to RMI functions are contained in child nodes of the rmi device
36  node. Documentation for the parameters of each function can be found in:
37 Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
38
39
40
41 Example:
42         &i2c1 {
43                 rmi4-i2c-dev@2c {
44                         compatible = "syna,rmi4-i2c";
45                         reg = <0x2c>;
46                         #address-cells = <1>;
47                         #size-cells = <0>;
48                         interrupt-parent = <&gpio>;
49                         interrupts = <4 2>;
50
51                         rmi4-f01@1 {
52                                 reg = <0x1>;
53                                 syna,nosleep-mode = <1>;
54                         };
55
56                         rmi4-f11@11 {
57                                 reg = <0x11>;
58                                 touchscreen-inverted-y;
59                                 syna,sensor-type = <2>;
60                         };
61                 };
62         };