]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
dt-bindings: power: supply: Add docs for Ingenic JZ47xx SoCs battery.
authorArtur Rojek <contact@artur-rojek.eu>
Sat, 23 Mar 2019 17:28:08 +0000 (18:28 +0100)
committerSebastian Reichel <sre@kernel.org>
Thu, 18 Apr 2019 19:34:56 +0000 (21:34 +0200)
Add documentation for the ingenic-battery driver, used on JZ47xx SoCs.

Signed-off-by: Artur Rojek <contact@artur-rojek.eu>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
Documentation/devicetree/bindings/power/supply/ingenic,battery.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt b/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt
new file mode 100644 (file)
index 0000000..66430bf
--- /dev/null
@@ -0,0 +1,31 @@
+* Ingenic JZ47xx battery bindings
+
+Required properties:
+
+- compatible: Must be "ingenic,jz4740-battery".
+- io-channels: phandle and IIO specifier pair to the IIO device.
+  Format described in iio-bindings.txt.
+- monitored-battery: phandle to a "simple-battery" compatible node.
+
+The "monitored-battery" property must be a phandle to a node using the format
+described in battery.txt, with the following properties being required:
+
+- voltage-min-design-microvolt: Drained battery voltage.
+- voltage-max-design-microvolt: Fully charged battery voltage.
+
+Example:
+
+#include <dt-bindings/iio/adc/ingenic,adc.h>
+
+simple_battery: battery {
+       compatible = "simple-battery";
+       voltage-min-design-microvolt = <3600000>;
+       voltage-max-design-microvolt = <4200000>;
+};
+
+ingenic_battery {
+       compatible = "ingenic,jz4740-battery";
+       io-channels = <&adc INGENIC_ADC_BATTERY>;
+       io-channel-names = "battery";
+       monitored-battery = <&simple_battery>;
+};