[deliverable/linux.git] / Documentation / devicetree / bindings / input / rmi4 / rmi_spi.txt

Synaptics RMI4 SPI Device Binding

The Synaptics RMI4 core is able to support RMI4 devices using different
transports and different functions. This file describes the device tree
bindings for devices using the SPI transport driver. Complete documentation
for other transports and functions can be found in
Documentation/devicetree/bindings/input/rmi4.

Required Properties:
- compatible: syna,rmi4-spi
- reg: Chip select address for the device
- #address-cells: Set to 1 to indicate that the function child nodes
		    consist of only on uint32 value.
- #size-cells: Set to 0 to indicate that the function child nodes do not
		have a size property.

Optional Properties:
- interrupts: interrupt which the rmi device is connected to.
- interrupt-parent: The interrupt controller.
See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt

- spi-rx-delay-us: microsecond delay after a read transfer.
- spi-tx-delay-us: microsecond delay after a write transfer.

Function Parameters:
Parameters specific to RMI functions are contained in child nodes of the rmi device
 node. Documentation for the parameters of each function can be found in:
Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.


Example:
	spi@7000d800 {
		rmi4-spi-dev@0 {
			compatible = "syna,rmi4-spi";
			reg = <0x0>;
			#address-cells = <1>;
			#size-cells = <0>;
			spi-max-frequency = <4000000>;
			spi-cpha;
			spi-cpol;
			interrupt-parent = <&gpio>;
			interrupts = <TEGRA_GPIO(K, 2) 0x2>;
			spi-rx-delay-us = <30>;

			rmi4-f01@1 {
				reg = <0x1>;
				syna,nosleep-mode = <1>;
			};

			rmi4-f11@11 {
				reg = <0x11>;
				touchscreen-inverted-y;
				syna,sensor-type = <2>;
			};
		};
	};
Commit	Line	Data
48147b97 AD	1	Synaptics RMI4 SPI 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 using the SPI transport driver. Complete documentation
	6	for other transports and functions can be found in
	7	Documentation/devicetree/bindings/input/rmi4.
	8
	9	Required 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
	17	Optional Properties:
	18	- interrupts: interrupt which the rmi device is connected to.
	19	- interrupt-parent: The interrupt controller.
	20	See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
	21
	22	- spi-rx-delay-us: microsecond delay after a read transfer.
	23	- spi-tx-delay-us: microsecond delay after a write transfer.
	24
	25	Function Parameters:
	26	Parameters 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:
	28	Documentation/devicetree/bindings/input/rmi4/rmi_f*.txt.
	29
	30
	31
	32	Example:
	33	spi@7000d800 {
	34	rmi4-spi-dev@0 {
	35	compatible = "syna,rmi4-spi";
	36	reg = <0x0>;
	37	#address-cells = <1>;
	38	#size-cells = <0>;
	39	spi-max-frequency = <4000000>;
	40	spi-cpha;
	41	spi-cpol;
	42	interrupt-parent = <&gpio>;
	43	interrupts = <TEGRA_GPIO(K, 2) 0x2>;
	44	spi-rx-delay-us = <30>;
	45
	46	rmi4-f01@1 {
	47	reg = <0x1>;
	48	syna,nosleep-mode = <1>;
	49	};
	50
	51	rmi4-f11@11 {
	52	reg = <0x11>;
	53	touchscreen-inverted-y;
	54	syna,sensor-type = <2>;
	55	};
	56	};
	57	};