xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/input/rmi4/rmi_f01.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunSynaptics RMI4 F01 Device Binding
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunThe Synaptics RMI4 core is able to support RMI4 devices using different
4*4882a593Smuzhiyuntransports and different functions. This file describes the device tree
5*4882a593Smuzhiyunbindings for devices which contain Function 1. Complete documentation
6*4882a593Smuzhiyunfor transports and other functions can be found in:
7*4882a593SmuzhiyunDocumentation/devicetree/bindings/input/rmi4.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunAdditional documentation for F01 can be found at:
10*4882a593Smuzhiyunhttp://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunOptional Properties:
13*4882a593Smuzhiyun- syna,nosleep-mode: If set the device will run at full power without sleeping.
14*4882a593Smuzhiyun			nosleep has 3 modes, 0 will not change the default
15*4882a593Smuzhiyun			setting, 1 will disable nosleep (allow sleeping),
16*4882a593Smuzhiyun			and 2 will enable nosleep (disabling sleep).
17*4882a593Smuzhiyun- syna,wakeup-threshold: Defines the amplitude of the disturbance to the
18*4882a593Smuzhiyun				background capacitance that will cause the
19*4882a593Smuzhiyun				device to wake from dozing.
20*4882a593Smuzhiyun- syna,doze-holdoff-ms: The delay to wait after the last finger lift and the
21*4882a593Smuzhiyun				first doze cycle.
22*4882a593Smuzhiyun- syna,doze-interval-ms: The time period that the device sleeps between finger
23*4882a593Smuzhiyun				activity.
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun
26*4882a593SmuzhiyunExample of a RMI4 I2C device with F01:
27*4882a593Smuzhiyun	Example:
28*4882a593Smuzhiyun	&i2c1 {
29*4882a593Smuzhiyun		rmi4-i2c-dev@2c {
30*4882a593Smuzhiyun			compatible = "syna,rmi4-i2c";
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun			...
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun			rmi4-f01@1 {
35*4882a593Smuzhiyun				reg = <0x1>;
36*4882a593Smuzhiyun				syna,nosleep-mode = <1>;
37*4882a593Smuzhiyun			};
38*4882a593Smuzhiyun		};
39*4882a593Smuzhiyun	};
40