summaryrefslogtreecommitdiffstats
path: root/dts/Bindings/iio/afe/current-sense-amplifier.txt
diff options
context:
space:
mode:
Diffstat (limited to 'dts/Bindings/iio/afe/current-sense-amplifier.txt')
-rw-r--r--dts/Bindings/iio/afe/current-sense-amplifier.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/dts/Bindings/iio/afe/current-sense-amplifier.txt b/dts/Bindings/iio/afe/current-sense-amplifier.txt
new file mode 100644
index 0000000..821b61b
--- /dev/null
+++ b/dts/Bindings/iio/afe/current-sense-amplifier.txt
@@ -0,0 +1,26 @@
+Current Sense Amplifier
+=======================
+
+When an io-channel measures the output voltage from a current sense
+amplifier, the interesting measurement is almost always the current
+through the sense resistor, not the voltage output. This binding
+describes such a current sense circuit.
+
+Required properties:
+- compatible : "current-sense-amplifier"
+- io-channels : Channel node of a voltage io-channel.
+- sense-resistor-micro-ohms : The sense resistance in microohms.
+
+Optional properties:
+- sense-gain-mult: Amplifier gain multiplier. The default is <1>.
+- sense-gain-div: Amplifier gain divider. The default is <1>.
+
+Example:
+
+sysi {
+ compatible = "current-sense-amplifier";
+ io-channels = <&tiadc 0>;
+
+ sense-resistor-micro-ohms = <20000>;
+ sense-gain-mul = <50>;
+};