xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/input/rmi4/rmi_spi.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunSynaptics RMI4 SPI 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 using the SPI transport driver. Complete documentation
6*4882a593Smuzhiyunfor other transports and functions can be found in
7*4882a593SmuzhiyunDocumentation/devicetree/bindings/input/rmi4.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunRequired Properties:
10*4882a593Smuzhiyun- compatible: syna,rmi4-spi
11*4882a593Smuzhiyun- reg: Chip select address for the device
12*4882a593Smuzhiyun- #address-cells: Set to 1 to indicate that the function child nodes
13*4882a593Smuzhiyun		    consist of only on uint32 value.
14*4882a593Smuzhiyun- #size-cells: Set to 0 to indicate that the function child nodes do not
15*4882a593Smuzhiyun		have a size property.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunOptional Properties:
18*4882a593Smuzhiyun- interrupts: interrupt which the rmi device is connected to.
19*4882a593SmuzhiyunSee Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun- spi-rx-delay-us: microsecond delay after a read transfer.
22*4882a593Smuzhiyun- spi-tx-delay-us: microsecond delay after a write transfer.
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunFunction Parameters:
25*4882a593SmuzhiyunParameters specific to RMI functions are contained in child nodes of the rmi device
26*4882a593Smuzhiyun node. Documentation for the parameters of each function can be found in:
27*4882a593SmuzhiyunDocumentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun
31*4882a593SmuzhiyunExample:
32*4882a593Smuzhiyun	spi@7000d800 {
33*4882a593Smuzhiyun		rmi4-spi-dev@0 {
34*4882a593Smuzhiyun			compatible = "syna,rmi4-spi";
35*4882a593Smuzhiyun			reg = <0x0>;
36*4882a593Smuzhiyun			#address-cells = <1>;
37*4882a593Smuzhiyun			#size-cells = <0>;
38*4882a593Smuzhiyun			spi-max-frequency = <4000000>;
39*4882a593Smuzhiyun			spi-cpha;
40*4882a593Smuzhiyun			spi-cpol;
41*4882a593Smuzhiyun			interrupt-parent = <&gpio>;
42*4882a593Smuzhiyun			interrupts = <TEGRA_GPIO(K, 2) 0x2>;
43*4882a593Smuzhiyun			spi-rx-delay-us = <30>;
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun			rmi4-f01@1 {
46*4882a593Smuzhiyun				reg = <0x1>;
47*4882a593Smuzhiyun				syna,nosleep-mode = <1>;
48*4882a593Smuzhiyun			};
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun			rmi4-f11@11 {
51*4882a593Smuzhiyun				reg = <0x11>;
52*4882a593Smuzhiyun				touchscreen-inverted-y;
53*4882a593Smuzhiyun				syna,sensor-type = <2>;
54*4882a593Smuzhiyun			};
55*4882a593Smuzhiyun		};
56*4882a593Smuzhiyun	};
57