xref: /freebsd/sys/contrib/device-tree/Bindings/input/rmi4/rmi_spi.txt (revision 7ef62cebc2f965b0f640263e179276928885e33d) 
1Synaptics RMI4 SPI 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 SPI 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-spi
11- reg: Chip select address for the device
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.
19See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
20
21- spi-rx-delay-us: microsecond delay after a read transfer.
22- spi-tx-delay-us: microsecond delay after a write transfer.
23
24Function Parameters:
25Parameters specific to RMI functions are contained in child nodes of the rmi device
26 node. Documentation for the parameters of each function can be found in:
27Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
28
29
30
31Example:
32	spi@7000d800 {
33		rmi4-spi-dev@0 {
34			compatible = "syna,rmi4-spi";
35			reg = <0x0>;
36			#address-cells = <1>;
37			#size-cells = <0>;
38			spi-max-frequency = <4000000>;
39			spi-cpha;
40			spi-cpol;
41			interrupt-parent = <&gpio>;
42			interrupts = <TEGRA_GPIO(K, 2) 0x2>;
43			spi-rx-delay-us = <30>;
44
45			rmi4-f01@1 {
46				reg = <0x1>;
47				syna,nosleep-mode = <1>;
48			};
49
50			rmi4-f11@11 {
51				reg = <0x11>;
52				touchscreen-inverted-y;
53				syna,sensor-type = <2>;
54			};
55		};
56	};
57