| Tom Rini | 53633a8 | 2024-02-29 12:33:36 -0500 | [diff] [blame] | 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 | sense-resistor-micro-ohms: |
| 28 | description: The sense resistance. |
| 29 | |
| 30 | sense-gain-mult: |
| 31 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 32 | description: Amplifier gain multiplier. The default is <1>. |
| 33 | |
| 34 | sense-gain-div: |
| 35 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 36 | description: Amplifier gain divider. The default is <1>. |
| 37 | |
| 38 | required: |
| 39 | - compatible |
| 40 | - io-channels |
| 41 | - sense-resistor-micro-ohms |
| 42 | |
| 43 | additionalProperties: false |
| 44 | |
| 45 | examples: |
| 46 | - | |
| 47 | sysi { |
| 48 | compatible = "current-sense-amplifier"; |
| 49 | io-channels = <&tiadc 0>; |
| 50 | |
| 51 | sense-resistor-micro-ohms = <20000>; |
| 52 | sense-gain-mult = <50>; |
| 53 | }; |
| 54 | ... |