[v3,4/4] mfd: max77620: add documentation for low battery monitoring

Message ID 20190212064353.7451-5-markz@nvidia.com
State New
Headers show
Series
  • Add max77620 charging & low battery support
Related show

Commit Message

Mark Zhang Feb. 12, 2019, 6:43 a.m.
Adding documentation for low battery monitor properties:
- maxim,low-battery-dac-enable
- maxim,low-battery-mode

Signed-off-by: Mark Zhang <markz@nvidia.com>
---
 Documentation/devicetree/bindings/mfd/max77620.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Patch

diff --git a/Documentation/devicetree/bindings/mfd/max77620.txt b/Documentation/devicetree/bindings/mfd/max77620.txt
index 88825eaf2567..f5b298ccc929 100644
--- a/Documentation/devicetree/bindings/mfd/max77620.txt
+++ b/Documentation/devicetree/bindings/mfd/max77620.txt
@@ -142,6 +142,20 @@  Optional properties:
 			Device supports 100/1000/3000/6000 Ohms.
 			Default will be set to 1000 Ohm.
 
+Low-Battery Monitor:
+==================
+max77620 is able to monitor the main battery voltage and shutdown/reset the
+chip connected accordingly.
+
+Optional properties:
+	- maxim,low-battery-dac-enable: Enable low battery monitoring.
+			Low battery monitoring will be disabled if missing
+			this property.
+	- maxim,low-battery-mode: Shutdown or reset the chip.
+			The value of this property is "shutdown" which means
+			a global shutdown will be triggered. Any other values
+			or missing this property causes a chip reset.
+
 Example:
 --------
 #include <dt-bindings/mfd/max77620.h>