Documentation/power/charger-manager.rst

7 Charger Manager provides in-kernel battery charger management that
8 requires temperature monitoring during suspend-to-RAM state
12 Charger Manager is a platform_driver with power-supply-class entries.
13 An instance of Charger Manager (a platform-device created with Charger-Manager)
24 	A system may have multiple chargers (or power sources) and some of
26 	own power-supply-class and each power-supply-class can provide
28 	aggregates charger-related information from multiple sources and
29 	shows combined information as a single power-supply-class.
31 * Support for in suspend-to-RAM polling (with suspend_again callback)
32 	While the battery is being charged and the system is in suspend-to-RAM,
34 	battery temperature. We can accomplish this by waking up the system
35 	periodically. However, such a method wakes up devices unnecessarily for
37 	supposed to be kept suspended. That, in turn, incurs unnecessary power
38 	consumption and slow down charging process. Or even, such peak power
40 	(external power input < device power consumption), which not
50 * Support for premature full-battery event handling
52 	"fullbatt_vchkdrop_ms" from the full-battery event, the framework
56 * Support for uevent-notify
57 	With the charger-related events, the device sends
60 2. Global Charger-Manager Data related with suspend_again
62 In order to setup Charger Manager with suspend-again feature
63 (in-suspend monitoring), the user should provide charger_global_desc
65 This charger_global_desc data for in-suspend monitoring is global
69 and it will manage in-suspend monitoring for all instances of Charger Manager.
72 properly in order to activate in-suspend monitoring:
77 	should be able to wake up the system from suspend. Charger Manager
78 	saves and restores the alarm value and use the previously-defined
80 	Charger Manager does not interfere with previously-defined alarms.
84 	the wakeup-from-suspend is caused only by the alarm of "rtc" in the
92 	assumes that the suspend-duration is same as the alarm length.
106 if the system was woken up by Charger Manager and the polling
107 (in-suspend monitoring) results in "normal".
109 4. Charger-Manager Data (struct charger_desc)
118 	The power-supply-class name of the battery. Default is
128 		poll this battery if and only if an external power
134 	If both have non-zero values, Charger Manager will check the
143 	If specified with a non-zero value, Charger Manager assumes
163 	An array ending with NULL that has power-supply-class names of
164 	chargers. Each power-supply-class should provide "PRESENT" (if
166 	external power source is attached or not), and "STATUS" (shows whether
175 	Power-supply-class name of the fuel gauge.
186 5. Notify Charger-Manager of charger events: cm_notify_event()
192 associated with Charger-Manager. The parameter "type"
199 At the charger/battery-related events such as battery-pulled-out,
200 charger-pulled-out, charger-inserted, DCIN-over/under-voltage, charger-stopped,
201 and others critical to chargers, the system should be configured to wake up.
202 At least the following should wake up the system from a suspend:
203 a) charger-on/off b) external-power-in/out c) battery-in/out (while charging)