Linux-libre 4.10.7-gnu
[librecmc/linux-libre.git] / Documentation / devicetree / bindings / input / rmi4 / rmi_f01.txt
1 Synaptics RMI4 F01 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 which contain Function 1. Complete documentation
6 for transports and other functions can be found in:
7 Documentation/devicetree/bindings/input/rmi4.
8
9 Additional documentation for F01 can be found at:
10 http://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
11
12 Optional 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
26 Example 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         };