summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/power/supply/max17042_battery.txt
diff options
context:
space:
mode:
authorSebastian Reichel <sre@kernel.org>2016-06-17 14:12:47 +0200
committerSebastian Reichel <sre@kernel.org>2016-08-11 01:11:29 +0200
commitf3332532463fef7d56507c08b33993db398d7a91 (patch)
treee0fc566c557d70e103c51c7276c33ca57db37041 /Documentation/devicetree/bindings/power/supply/max17042_battery.txt
parent8c0984e5a75337df513047ec92a6c09d78e3e5cd (diff)
power/supply: unify DT documentation
Currently the power supply device tree documentation is spread in .../bindings/power_supply and .../bindings/power. This unifies the files for chargers and battery fuel gauges in .../bindings/power/supply and the ones for system reset/shutdown in .../bindings/power/reset (same structure as used for the drivers itself). Signed-off-by: Sebastian Reichel <sre@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings/power/supply/max17042_battery.txt')
-rw-r--r--Documentation/devicetree/bindings/power/supply/max17042_battery.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/power/supply/max17042_battery.txt b/Documentation/devicetree/bindings/power/supply/max17042_battery.txt
new file mode 100644
index 000000000000..3f3894aaeebc
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/max17042_battery.txt
@@ -0,0 +1,31 @@
+max17042_battery
+~~~~~~~~~~~~~~~~
+
+Required properties :
+ - compatible : "maxim,max17042"
+
+Optional properties :
+ - maxim,rsns-microohm : Resistance of rsns resistor in micro Ohms
+ (datasheet-recommended value is 10000).
+ Defining this property enables current-sense functionality.
+
+Optional threshold properties :
+ If skipped the condition won't be reported.
+ - maxim,cold-temp : Temperature threshold to report battery
+ as cold (in tenths of degree Celsius).
+ - maxim,over-heat-temp : Temperature threshold to report battery
+ as over heated (in tenths of degree Celsius).
+ - maxim,dead-volt : Voltage threshold to report battery
+ as dead (in mV).
+ - maxim,over-volt : Voltage threshold to report battery
+ as over voltage (in mV).
+
+Example:
+
+ battery-charger@36 {
+ compatible = "maxim,max17042";
+ reg = <0x36>;
+ maxim,rsns-microohm = <10000>;
+ maxim,over-heat-temp = <600>;
+ maxim,over-volt = <4300>;
+ };