summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/iio/afe/current-sense-shunt.txt
blob: 0f67108a07b6327bfa0f1de99b8781715a0c2734 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Current Sense Shunt
===================

When an io-channel measures the voltage over a current sense shunt,
the interesting measurement is almost always the current through the
shunt, not the voltage over it. This binding describes such a current
sense circuit.

Required properties:
- compatible : "current-sense-shunt"
- io-channels : Channel node of a voltage io-channel.
- shunt-resistor-micro-ohms : The shunt resistance in microohms.

Example:
The system current is measured by measuring the voltage over a
3.3 ohms shunt resistor.

sysi {
	compatible = "current-sense-shunt";
	io-channels = <&tiadc 0>;

	/* Divide the voltage by 3300000/1000000 (or 3.3) for the current. */
	shunt-resistor-micro-ohms = <3300000>;
};

&i2c {
	tiadc: adc@48 {
		compatible = "ti,ads1015";
		reg = <0x48>;
		#io-channel-cells = <1>;

		#address-cells = <1>;
		#size-cells = <0>;

		channel@0 { /* IN0,IN1 differential */
			reg = <0>;
			ti,gain = <1>;
			ti,datarate = <4>;
		};
	};
};