|author||Chanwoo Choi <firstname.lastname@example.org>||2012-05-05 06:26:47 -0700|
|committer||Anton Vorontsov <email@example.com>||2012-05-05 19:51:58 -0700|
charger-manager: Provide cm_notify_event function for in-kernel use
By using cm_notify_event function, charger driver can report several charger events (e.g. battery full and external power in/out, etc) to Charger-Manager. Charger-Manager can properly and immediately control chargers by the reported event. Signed-off-by: MyungJoo Ham <firstname.lastname@example.org> Signed-off-by: Donggeun Kim <email@example.com> Signed-off-by: Kyungmin Park <firstname.lastname@example.org> Signed-off-by: Anton Vorontsov <email@example.com>
Diffstat (limited to 'Documentation/power')
1 files changed, 15 insertions, 1 deletions
diff --git a/Documentation/power/charger-manager.txt b/Documentation/power/charger-manager.txt
index 9b3863386e54..b4f7f4b23f64 100644
@@ -50,6 +50,10 @@ Charger Manager supports the following:
restarts charging. This check is also performed while suspended by
setting wakeup time accordingly and using suspend_again.
+* Support for uevent-notify
+ With the charger-related events, the device sends
+ notification to users with UEVENT.
2. Global Charger-Manager Data related with suspend_again
In order to setup Charger Manager with suspend-again feature
@@ -174,7 +178,17 @@ bool measure_battery_temp;
the value of measure_battery_temp.
-5. Other Considerations
+5. Notify Charger-Manager of charger events: cm_notify_event()
+If there is an charger event is required to notify
+Charger Manager, a charger device driver that triggers the event can call
+cm_notify_event(psy, type, msg) to notify the corresponding Charger Manager.
+In the function, psy is the charger driver's power_supply pointer, which is
+associated with Charger-Manager. The parameter "type"
+is the same as irq's type (enum cm_event_types). The event message "msg" is
+optional and is effective only if the event type is "UNDESCRIBED" or "OTHERS".
+6. Other Considerations
At the charger/battery-related events such as battery-pulled-out,