dt-bindings: hwmon: Add adm127x documentation
authorKun Yi <kunyi@google.com>
Wed, 17 Oct 2018 22:27:09 +0000 (15:27 -0700)
committerGuenter Roeck <linux@roeck-us.net>
Mon, 3 Dec 2018 00:25:28 +0000 (16:25 -0800)
adm127x are hot-swap controllers that allow a circuit board to be removed from
or inserted into a live backplane. This patch adds the device tree
bindings documentation.

Signed-off-by: Kun Yi <kunyi@google.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/devicetree/bindings/hwmon/adm1275.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/hwmon/adm1275.txt b/Documentation/devicetree/bindings/hwmon/adm1275.txt
new file mode 100644 (file)
index 0000000..1ecd03f
--- /dev/null
@@ -0,0 +1,25 @@
+adm1275 properties
+
+Required properties:
+- compatible: Must be one of the supported compatible strings:
+       - "adi,adm1075" for adm1075
+       - "adi,adm1272" for adm1272
+       - "adi,adm1275" for adm1275
+       - "adi,adm1276" for adm1276
+       - "adi,adm1278" for adm1278
+       - "adi,adm1293" for adm1293
+       - "adi,adm1294" for adm1294
+- reg: I2C address
+
+Optional properties:
+
+- shunt-resistor-micro-ohms
+       Shunt resistor value in micro-Ohm
+
+Example:
+
+adm1272@10 {
+       compatible = "adi,adm1272";
+       reg = <0x10>;
+       shunt-resistor-micro-ohms = <500>;
+};