Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/s390/linux
[sfrench/cifs-2.6.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 See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
20
21 - syna,reset-delay-ms: The number of milliseconds to wait after resetting the
22                         device.
23
24 - syna,startup-delay-ms: The number of milliseconds to wait after powering on
25                          the device.
26
27 - vdd-supply: VDD power supply.
28 See ../regulator/regulator.txt
29
30 - vio-supply: VIO power supply
31 See ../regulator/regulator.txt
32
33 Function Parameters:
34 Parameters specific to RMI functions are contained in child nodes of the rmi device
35  node. Documentation for the parameters of each function can be found in:
36 Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
37
38
39
40 Example:
41         &i2c1 {
42                 rmi4-i2c-dev@2c {
43                         compatible = "syna,rmi4-i2c";
44                         reg = <0x2c>;
45                         #address-cells = <1>;
46                         #size-cells = <0>;
47                         interrupt-parent = <&gpio>;
48                         interrupts = <4 2>;
49
50                         rmi4-f01@1 {
51                                 reg = <0x1>;
52                                 syna,nosleep-mode = <1>;
53                         };
54
55                         rmi4-f11@11 {
56                                 reg = <0x11>;
57                                 touchscreen-inverted-y;
58                                 syna,sensor-type = <2>;
59                         };
60                 };
61         };