diff mbox series

[v2] gpio: Add gpio-charger to the documentation

Message ID 20200620201248.28843-1-linus.walleij@linaro.org
State Accepted
Commit 8cbdc5045df071b146b76a718dd8669e89714057
Headers show
Series [v2] gpio: Add gpio-charger to the documentation | expand

Commit Message

Linus Walleij June 20, 2020, 8:12 p.m. UTC 
The GPIO-based charger is another of the helpful devices built
on top of GPIO.

Cc: Sebastian Reichel <sebastian.reichel@collabora.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

---
ChangeLog v1->v2:
- We are checking for the AC charger not the battery per
  se.
---
 Documentation/driver-api/gpio/drivers-on-gpio.rst | 7 +++++++
 1 file changed, 7 insertions(+)

-- 
2.25.4
diff mbox series

Patch

diff --git a/Documentation/driver-api/gpio/drivers-on-gpio.rst b/Documentation/driver-api/gpio/drivers-on-gpio.rst
index 820b403d50f6..41ec3cc72d32 100644
--- a/Documentation/driver-api/gpio/drivers-on-gpio.rst
+++ b/Documentation/driver-api/gpio/drivers-on-gpio.rst
@@ -89,6 +89,13 @@  hardware descriptions such as device tree or ACPI:
   Consumer Electronics Control bus using only GPIO. It is used to communicate
   with devices on the HDMI bus.
 
+- gpio-charger: drivers/power/supply/gpio-charger.c is used if you need to do
+  battery charging and all you have to go by to check the presence of the
+  AC charger or more complex tasks such as indicating charging status using
+  nothing but GPIO lines, this driver provides that and also a clearly defined
+  way to pass the charging parameters from hardware descriptions such as the
+  device tree.
+
 Apart from this there are special GPIO drivers in subsystems like MMC/SD to
 read card detect and write protect GPIO lines, and in the TTY serial subsystem
 to emulate MCTRL (modem control) signals CTS/RTS by using two GPIO lines. The