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-amplifier.yaml#
5
$schema: http://devicetree.org/meta-schemas/core.yaml#
6

7
title: Current Sense Amplifier
8

9
maintainers:
10
  - Peter Rosin <peda@axentia.se>
11

12
description: |
13
  When an io-channel measures the output voltage from a current sense
14
  amplifier, the interesting measurement is almost always the current
15
  through the sense resistor, not the voltage output. This binding
16
  describes such a current sense circuit.
17

18
properties:
19
  compatible:
20
    const: current-sense-amplifier
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
  sense-resistor-micro-ohms:
31
    description: The sense resistance.
32

33
  sense-gain-mult:
34
    $ref: /schemas/types.yaml#/definitions/uint32
35
    description: Amplifier gain multiplier. The default is <1>.
36

37
  sense-gain-div:
38
    $ref: /schemas/types.yaml#/definitions/uint32
39
    description: Amplifier gain divider. The default is <1>.
40

41
required:
42
  - compatible
43
  - io-channels
44
  - sense-resistor-micro-ohms
45

46
additionalProperties: false
47

48
examples:
49
  - |
50
    sysi {
51
        compatible = "current-sense-amplifier";
52
        #io-channel-cells = <0>;
53
        io-channels = <&tiadc 0>;
54

55
        sense-resistor-micro-ohms = <20000>;
56
        sense-gain-mult = <50>;
57
    };
58
...
59

60