Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml

   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
   7 title: Current Sense Shunt
   8
   9 maintainers:
  10   - Peter Rosin <peda@axentia.se>
  11
  12 description: |
  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
  18 properties:
  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   "#io-channel-cells":
  28     const: 0
  29
  30   shunt-resistor-micro-ohms:
  31     description: The shunt resistance.
  32
  33 required:
  34   - compatible
  35   - io-channels
  36   - shunt-resistor-micro-ohms
  37
  38 additionalProperties: false
  39
  40 examples:
  41   - |
  42     i2c {
  43         #address-cells = <1>;
  44         #size-cells = <0>;
  45         tiadc: adc@48 {
  46             compatible = "ti,ads1015";
  47             reg = <0x48>;
  48             #io-channel-cells = <1>;
  49
  50             #address-cells = <1>;
  51             #size-cells = <0>;
  52
  53             channel@0 { /* IN0,IN1 differential */
  54                 reg = <0>;
  55                 ti,gain = <1>;
  56                 ti,datarate = <4>;
  57             };
  58         };
  59     };
  60     sysi {
  61         compatible = "current-sense-shunt";
  62         io-channels = <&tiadc 0>;
  63         #io-channel-cells = <0>;
  64
  65         /* Divide the voltage by 3300000/1000000 (or 3.3) for the current. */
  66         shunt-resistor-micro-ohms = <3300000>;
  67     };
  68 ...