Documentation on battery properties that can be defined for
fine tuning fuel gauge state machines.
Cc: Rob Herring <robh@xxxxxxxxxx>
Cc: devicetree@xxxxxxxxxxxxxxx
Signed-off-by: Matt Ranostay <matt@ranostay.consulting>
---
.../devicetree/bindings/power/supply/battery.txt | 24 ++++++++++++++++++++++
1 file changed, 24 insertions(+)
create mode 100644 Documentation/devicetree/bindings/power/supply/battery.txt
diff --git a/Documentation/devicetree/bindings/power/supply/battery.txt b/Documentation/devicetree/bindings/power/supply/battery.txt
new file mode 100644
index 000000000000..398b4d622883
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/battery.txt
@@ -0,0 +1,24 @@
+Battery State Machine Support
+
+Required Properties:
+ - compatible: Must be "fixed-battery"
+
+Optional Properties:
+ - nominal-microvolt: dead battery voltage in microvolts
+ - design-microwatt-hours: battery design mWh in microwatts
+ - design-microamp-hours: battery design mAh in microamps
+
+Example:
+
+ bat: battery@0 {
+ compatible = "fixed-battery";
+ nominal-microvolt = <3700000>;
+ design-microwatt-hours = <5290000>;
+ design-microamp-hours = <1430000>;
+ };
+
+ fuel_gauge: fuel_gauge@0 {
+ ....
+ monitored-battery = <&bat>;
+ ...
+ };
--
2.10.2
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
