aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/input/rmi4
diff options
context:
space:
mode:
authorAndrew Duggan <aduggan@synaptics.com>2016-03-10 18:46:32 -0500
committerDmitry Torokhov <dmitry.torokhov@gmail.com>2016-03-10 19:02:41 -0500
commitd8a8b3edfd922e3886684a3434bd2b752167ff29 (patch)
tree7a43bd47dfdab7f209bf6aa68698401db679241d /Documentation/devicetree/bindings/input/rmi4
parentfdf51604f104f95bbb828019e6b8f17e7a0f834a (diff)
Input: synaptics-rmi4 - add device tree support for RMI4 I2C devices
Add devicetree binding for I2C devices and add bindings for optional parameters in the function drivers. Parameters for function drivers are defined in child nodes for each of the functions. Signed-off-by: Andrew Duggan <aduggan@synaptics.com> Acked-by: Rob Herring <robh@kernel.org> Tested-by: Benjamin Tissoires <benjamin.tissoires@redhat.com> Tested-by: Linus Walleij <linus.walleij@linaro.org> Tested-by: Bjorn Andersson <bjorn.andersson@linaro.org> Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Diffstat (limited to 'Documentation/devicetree/bindings/input/rmi4')
-rw-r--r--Documentation/devicetree/bindings/input/rmi4/rmi_f01.txt39
-rw-r--r--Documentation/devicetree/bindings/input/rmi4/rmi_i2c.txt53
2 files changed, 92 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/input/rmi4/rmi_f01.txt b/Documentation/devicetree/bindings/input/rmi4/rmi_f01.txt
new file mode 100644
index 000000000000..079cad2b6843
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/rmi4/rmi_f01.txt
@@ -0,0 +1,39 @@
1Synaptics RMI4 F01 Device Binding
2
3The Synaptics RMI4 core is able to support RMI4 devices using different
4transports and different functions. This file describes the device tree
5bindings for devices which contain Function 1. Complete documentation
6for transports and other functions can be found in:
7Documentation/devicetree/bindings/input/rmi4.
8
9Additional documentation for F01 can be found at:
10http://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
11
12Optional Properties:
13- syna,nosleep-mode: If set the device will run at full power without sleeping.
14 nosleep has 3 modes, 0 will not change the default
15 setting, 1 will disable nosleep (allow sleeping),
16 and 2 will enable nosleep (disabling sleep).
17- syna,wakeup-threshold: Defines the amplitude of the disturbance to the
18 background capacitance that will cause the
19 device to wake from dozing.
20- syna,doze-holdoff-ms: The delay to wait after the last finger lift and the
21 first doze cycle.
22- syna,doze-interval-ms: The time period that the device sleeps between finger
23 activity.
24
25
26Example of a RMI4 I2C device with F01:
27 Example:
28 &i2c1 {
29 rmi4-i2c-dev@2c {
30 compatible = "syna,rmi4-i2c";
31
32 ...
33
34 rmi4-f01@1 {
35 reg = <0x1>;
36 syna,nosleep-mode = <1>;
37 };
38 };
39 };
diff --git a/Documentation/devicetree/bindings/input/rmi4/rmi_i2c.txt b/Documentation/devicetree/bindings/input/rmi4/rmi_i2c.txt
new file mode 100644
index 000000000000..95fa715c6046
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/rmi4/rmi_i2c.txt
@@ -0,0 +1,53 @@
1Synaptics RMI4 I2C Device Binding
2
3The Synaptics RMI4 core is able to support RMI4 devices using different
4transports and different functions. This file describes the device tree
5bindings for devices using the I2C transport driver. Complete documentation
6for other transports and functions can be found in
7Documentation/devicetree/bindings/input/rmi4.
8
9Required 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
17Optional Properties:
18- interrupts: interrupt which the rmi device is connected to.
19- interrupt-parent: The interrupt controller.
20See 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
25Function Parameters:
26Parameters specific to RMI functions are contained in child nodes of the rmi device
27 node. Documentation for the parameters of each function can be found in:
28Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
29
30
31
32Example:
33 &i2c1 {
34 rmi4-i2c-dev@2c {
35 compatible = "syna,rmi4-i2c";
36 reg = <0x2c>;
37 #address-cells = <1>;
38 #size-cells = <0>;
39 interrupt-parent = <&gpio>;
40 interrupts = <4 2>;
41
42 rmi4-f01@1 {
43 reg = <0x1>;
44 syna,nosleep-mode = <1>;
45 };
46
47 rmi4-f11@11 {
48 reg = <0x11>;
49 touchscreen-inverted-y;
50 syna,sensor-type = <2>;
51 };
52 };
53 };