dt-bindings: power: Add Spreadtrum SC2731 charger documentation
authorBaolin Wang <baolin.wang@linaro.org>
Mon, 17 Sep 2018 20:03:30 +0000 (13:03 -0700)
committerSebastian Reichel <sebastian.reichel@collabora.com>
Thu, 20 Sep 2018 00:58:08 +0000 (02:58 +0200)
This patch adds the binding documentation for Spreadtrum SC2731 charger
device.

Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
Documentation/devicetree/bindings/power/supply/sc2731_charger.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/power/supply/sc2731_charger.txt b/Documentation/devicetree/bindings/power/supply/sc2731_charger.txt
new file mode 100644 (file)
index 0000000..5266fab
--- /dev/null
@@ -0,0 +1,40 @@
+Spreadtrum SC2731 PMIC battery charger binding
+
+Required properties:
+ - compatible: Should be "sprd,sc2731-charger".
+ - reg: Address offset of charger register.
+ - phys: Contains a phandle to the USB phy.
+
+Optional Properties:
+- monitored-battery: phandle of battery characteristics devicetree node.
+  The charger uses the following battery properties:
+- charge-term-current-microamp: current for charge termination phase.
+- constant-charge-voltage-max-microvolt: maximum constant input voltage.
+  See Documentation/devicetree/bindings/power/supply/battery.txt
+
+Example:
+
+       bat: battery {
+               compatible = "simple-battery";
+               charge-term-current-microamp = <120000>;
+               constant-charge-voltage-max-microvolt = <4350000>;
+               ......
+       };
+
+       sc2731_pmic: pmic@0 {
+               compatible = "sprd,sc2731";
+               reg = <0>;
+               spi-max-frequency = <26000000>;
+               interrupts = <GIC_SPI 31 IRQ_TYPE_LEVEL_HIGH>;
+               interrupt-controller;
+               #interrupt-cells = <2>;
+               #address-cells = <1>;
+               #size-cells = <0>;
+
+               charger@0 {
+                       compatible = "sprd,sc2731-charger";
+                       reg = <0x0>;
+                       phys = <&ssphy>;
+                       monitored-battery = <&bat>;
+               };
+       };