bindings/iio/iio-bindings.txt

1 This binding is derived from clock bindings, and based on suggestions
2 from Lars-Peter Clausen [1].
4 Sources of IIO channels can be represented by any node in the device
5 tree. Those nodes are designated as IIO providers. IIO consumer
6 nodes use a phandle and IIO specifier pair to connect IIO provider
7 outputs to IIO inputs. Similar to the gpio specifiers, an IIO
8 specifier is an array of one or more cells identifying the IIO
9 output on a device. The length of an IIO specifier is defined by the
10 value of a #io-channel-cells property in the IIO provider node.
12 [1] https://marc.info/?l=linux-iio&m=135902119507483&w=2
14 ==IIO providers==
17 #io-channel-cells: Number of cells in an IIO specifier; Typically 0 for nodes
18 		   with a single IIO output and 1 for nodes with multiple
19 		   IIO outputs.
27 	adc: voltage-sensor@35 {
30 		#io-channel-cells = <1>;
37 		compatible = "some-vendor,some-adc";
40 		adc1: iio-device@0 {
41 			#io-channel-cells = <1>;
44 		adc2: iio-device@1 {
45 			#io-channel-cells = <1>;
50 ==IIO consumers==
53 io-channels:	List of phandle and IIO specifier pairs, one pair
54 		for each IIO input to the device. Note: if the
55 		IIO provider specifies '0' for #io-channel-cells,
59 io-channel-names:
60 		List of IIO input name strings sorted in the same
61 		order as the io-channels property. Consumers drivers
62 		will use io-channel-names to match IIO input names
63 		with IIO specifiers.
64 io-channel-ranges:
66 		IIO channels from this node. Useful for bus nodes to provide
67 		and IIO channel to their children.
72 		io-channels = <&adc 1>, <&ref 0>;
73 		io-channel-names = "vcc", "vdd";
76 This represents a device with two IIO inputs, named "vcc" and "vdd".
85 		#io-channel-cells = <1>;
90 	iio-hwmon {
91 		compatible = "iio-hwmon";
92 		io-channels = <&adc 0>, <&adc 1>, <&adc 2>,
99 		compatible = "some-consumer";
100 		io-channels = <&adc 10>, <&adc 11>;
101 		io-channel-names = "adc1", "adc2";