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)
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,
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:
78 	saves and restores the alarm value and use the previously-defined
80 	Charger Manager does not interfere with previously-defined alarms.
83 	This callback should let CM know whether
84 	the wakeup-from-suspend is caused only by the alarm of "rtc" in the
91 	the timer (CM uses jiffies as timer) stops during suspend. Then, CM
92 	assumes that the suspend-duration is same as the alarm length.
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
124 		do not poll this battery.
126 		always poll this battery.
128 		poll this battery if and only if an external power
131 		poll this battery if and only if the battery is being charged.
134 	If both have non-zero values, Charger Manager will check the
143 	If specified with a non-zero value, Charger Manager assumes
149 	Required polling interval in ms. Charger Manager will poll
163 	An array ending with NULL that has power-supply-class names of
164 	chargers. Each power-supply-class should provide "PRESENT" (if
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,
203 a) charger-on/off b) external-power-in/out c) battery-in/out (while charging)