1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/afe/current-sense-shunt.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Current Sense Shunt
8
9maintainers:
10  - Peter Rosin <peda@axentia.se>
11
12description: |
13  When an io-channel measures the voltage over a current sense shunt,
14  the interesting measurement is almost always the current through the
15  shunt, not the voltage over it. This binding describes such a current
16  sense circuit.
17
18properties:
19  compatible:
20    const: current-sense-shunt
21
22  io-channels:
23    maxItems: 1
24    description: |
25      Channel node of a voltage io-channel.
26
27  shunt-resistor-micro-ohms:
28    description: The shunt resistance.
29
30required:
31  - compatible
32  - io-channels
33  - shunt-resistor-micro-ohms
34
35additionalProperties: false
36
37examples:
38  - |
39    i2c {
40        #address-cells = <1>;
41        #size-cells = <0>;
42        tiadc: adc@48 {
43            compatible = "ti,ads1015";
44            reg = <0x48>;
45            #io-channel-cells = <1>;
46
47            #address-cells = <1>;
48            #size-cells = <0>;
49
50            channel@0 { /* IN0,IN1 differential */
51                reg = <0>;
52                ti,gain = <1>;
53                ti,datarate = <4>;
54            };
55        };
56    };
57    sysi {
58        compatible = "current-sense-shunt";
59        io-channels = <&tiadc 0>;
60
61        /* Divide the voltage by 3300000/1000000 (or 3.3) for the current. */
62        shunt-resistor-micro-ohms = <3300000>;
63    };
64...
65