2 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
3 * MyungJoo.Ham <myungjoo.ham@samsung.com>
6 * This framework enables to control and multiple chargers and to
7 * monitor charging even in the context of suspend-to-RAM with
8 * an interface combining the chargers.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #ifndef _CHARGER_MANAGER_H
16 #define _CHARGER_MANAGER_H
18 #include <linux/power_supply.h>
19 #include <linux/extcon.h>
31 CM_POLL_EXTERNAL_POWER_ONLY,
32 CM_POLL_CHARGING_ONLY,
40 CM_EVENT_EXT_PWR_IN_OUT,
41 CM_EVENT_CHG_START_STOP,
46 * struct charger_global_desc
47 * @rtc_name: the name of RTC used to wake up the system from suspend.
49 * If the system is woken up by waekup-sources other than the RTC or
50 * callbacks, Charger Manager should recognize with
51 * rtc_only_wakeup() returning false.
52 * If the RTC given to CM is the only wakeup reason,
53 * rtc_only_wakeup should return true.
54 * @assume_timer_stops_in_suspend:
55 * Assume that the jiffy timer stops in suspend-to-RAM.
56 * When enabled, CM does not rely on jiffies value in
57 * suspend_again and assumes that jiffies value does not
58 * change during suspend.
60 struct charger_global_desc {
63 bool (*rtc_only_wakeup)(void);
65 bool assume_timer_stops_in_suspend;
69 * struct charger_cable
70 * @extcon_name: the name of extcon device.
71 * @name: the name of charger cable(external connector).
72 * @extcon_dev: the extcon device.
73 * @wq: the workqueue to control charger according to the state of
74 * charger cable. If charger cable is attached, enable charger.
75 * But if charger cable is detached, disable charger.
76 * @nb: the notifier block to receive changed state from EXTCON
77 * (External Connector) when charger cable is attached/detached.
78 * @attached: the state of charger cable.
79 * true: the charger cable is attached
80 * false: the charger cable is detached
81 * @charger: the instance of struct charger_regulator.
82 * @cm: the Charger Manager representing the battery.
84 struct charger_cable {
85 const char *extcon_name;
88 /* The charger-manager use Exton framework*/
89 struct extcon_specific_cable_nb extcon_dev;
90 struct work_struct wq;
91 struct notifier_block nb;
93 /* The state of charger cable */
96 struct charger_regulator *charger;
99 * Set min/max current of regulator to protect over-current issue
100 * according to a kind of charger cable when cable is attached.
105 struct charger_manager *cm;
109 * struct charger_regulator
110 * @regulator_name: the name of regulator for using charger.
111 * @consumer: the regulator consumer for the charger.
112 * @externally_control:
113 * Set if the charger-manager cannot control charger,
114 * the charger will be maintained with disabled state.
116 * the array of charger cables to enable/disable charger
117 * and set current limit according to constratint data of
118 * struct charger_cable if only charger cable included
119 * in the array of charger cables is attached/detached.
120 * @num_cables: the number of charger cables.
121 * @attr_g: Attribute group for the charger(regulator)
122 * @attr_name: "name" sysfs entry
123 * @attr_state: "state" sysfs entry
124 * @attr_externally_control: "externally_control" sysfs entry
125 * @attrs: Arrays pointing to attr_name/state/externally_control for attr_g
127 struct charger_regulator {
128 /* The name of regulator for charging */
129 const char *regulator_name;
130 struct regulator *consumer;
132 /* charger never on when system is on */
133 int externally_control;
136 * Store constraint information related to current limit,
137 * each cable have different condition for charging.
139 struct charger_cable *cables;
142 struct attribute_group attr_g;
143 struct device_attribute attr_name;
144 struct device_attribute attr_state;
145 struct device_attribute attr_externally_control;
146 struct attribute *attrs[4];
148 struct charger_manager *cm;
152 * struct charger_desc
153 * @psy_name: the name of power-supply-class for charger manager
155 * Determine which polling mode will be used
156 * @fullbatt_vchkdrop_ms:
157 * @fullbatt_vchkdrop_uV:
158 * Check voltage drop after the battery is fully charged.
159 * If it has dropped more than fullbatt_vchkdrop_uV after
160 * fullbatt_vchkdrop_ms, CM will restart charging.
161 * @fullbatt_uV: voltage in microvolt
162 * If VBATT >= fullbatt_uV, it is assumed to be full.
163 * @fullbatt_soc: state of Charge in %
164 * If state of Charge >= fullbatt_soc, it is assumed to be full.
165 * @fullbatt_full_capacity: full capacity measure
166 * If full capacity of battery >= fullbatt_full_capacity,
167 * it is assumed to be full.
168 * @polling_interval_ms: interval in millisecond at which
169 * charger manager will monitor battery health
171 * Specify where information for existance of battery can be obtained
172 * @psy_charger_stat: the names of power-supply for chargers
173 * @num_charger_regulator: the number of entries in charger_regulators
174 * @charger_regulators: array of charger regulators
175 * @psy_fuel_gauge: the name of power-supply for fuel gauge
176 * @temperature_out_of_range:
177 * Determine whether the status is overheat or cold or normal.
178 * return_value > 0: overheat
179 * return_value == 0: normal
180 * return_value < 0: cold
181 * @measure_battery_temp:
182 * true: measure battery temperature
183 * false: measure ambient temperature
184 * @charging_max_duration_ms: Maximum possible duration for charging
185 * If whole charging duration exceed 'charging_max_duration_ms',
187 * @discharging_max_duration_ms:
188 * Maximum possible duration for discharging with charger cable
189 * after full-batt. If discharging duration exceed 'discharging
190 * max_duration_ms', cm start charging.
192 struct charger_desc {
195 enum polling_modes polling_mode;
196 unsigned int polling_interval_ms;
198 unsigned int fullbatt_vchkdrop_ms;
199 unsigned int fullbatt_vchkdrop_uV;
200 unsigned int fullbatt_uV;
201 unsigned int fullbatt_soc;
202 unsigned int fullbatt_full_capacity;
204 enum data_source battery_present;
206 char **psy_charger_stat;
208 int num_charger_regulators;
209 struct charger_regulator *charger_regulators;
211 char *psy_fuel_gauge;
213 int (*temperature_out_of_range)(int *mC);
214 bool measure_battery_temp;
216 u64 charging_max_duration_ms;
217 u64 discharging_max_duration_ms;
220 #define PSY_NAME_MAX 30
223 * struct charger_manager
224 * @entry: entry for list
225 * @dev: device pointer
226 * @desc: instance of charger_desc
227 * @fuel_gauge: power_supply for fuel gauge
228 * @charger_stat: array of power_supply for chargers
229 * @charger_enabled: the state of charger
230 * @fullbatt_vchk_jiffies_at:
231 * jiffies at the time full battery check will occur.
232 * @fullbatt_vchk_work: work queue for full battery check
234 * When setting true, stop charging
235 * @last_temp_mC: the measured temperature in milli-Celsius
236 * @psy_name_buf: the name of power-supply-class for charger manager
237 * @charger_psy: power_supply for charger manager
238 * @status_save_ext_pwr_inserted:
239 * saved status of external power before entering suspend-to-RAM
241 * saved status of battery before entering suspend-to-RAM
242 * @charging_start_time: saved start time of enabling charging
243 * @charging_end_time: saved end time of disabling charging
245 struct charger_manager {
246 struct list_head entry;
248 struct charger_desc *desc;
250 struct power_supply *fuel_gauge;
251 struct power_supply **charger_stat;
253 bool charger_enabled;
255 unsigned long fullbatt_vchk_jiffies_at;
256 struct delayed_work fullbatt_vchk_work;
261 char psy_name_buf[PSY_NAME_MAX + 1];
262 struct power_supply charger_psy;
264 bool status_save_ext_pwr_inserted;
265 bool status_save_batt;
267 u64 charging_start_time;
268 u64 charging_end_time;
271 #ifdef CONFIG_CHARGER_MANAGER
272 extern int setup_charger_manager(struct charger_global_desc *gd);
273 extern bool cm_suspend_again(void);
274 extern void cm_notify_event(struct power_supply *psy,
275 enum cm_event_types type, char *msg);
277 static inline int setup_charger_manager(struct charger_global_desc *gd)
279 static inline bool cm_suspend_again(void) { return false; }
280 static inline void cm_notify_event(struct power_supply *psy,
281 enum cm_event_types type, char *msg) { }
283 #endif /* _CHARGER_MANAGER_H */