1/* 2 * Copyright (C) 2011 Samsung Electronics Co., Ltd. 3 * MyungJoo.Ham <myungjoo.ham@samsung.com> 4 * 5 * Charger Manager. 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. 9 * 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. 13**/ 14 15#ifndef _CHARGER_MANAGER_H 16#define _CHARGER_MANAGER_H 17 18#include <linux/power_supply.h> 19#include <linux/extcon.h> 20#include <linux/alarmtimer.h> 21 22enum data_source { 23 CM_BATTERY_PRESENT, 24 CM_NO_BATTERY, 25 CM_FUEL_GAUGE, 26 CM_CHARGER_STAT, 27}; 28 29enum polling_modes { 30 CM_POLL_DISABLE = 0, 31 CM_POLL_ALWAYS, 32 CM_POLL_EXTERNAL_POWER_ONLY, 33 CM_POLL_CHARGING_ONLY, 34}; 35 36enum cm_event_types { 37 CM_EVENT_UNKNOWN = 0, 38 CM_EVENT_BATT_FULL, 39 CM_EVENT_BATT_IN, 40 CM_EVENT_BATT_OUT, 41 CM_EVENT_BATT_OVERHEAT, 42 CM_EVENT_BATT_COLD, 43 CM_EVENT_EXT_PWR_IN_OUT, 44 CM_EVENT_CHG_START_STOP, 45 CM_EVENT_OTHERS, 46}; 47 48/** 49 * struct charger_cable 50 * @extcon_name: the name of extcon device. 51 * @name: the name of charger cable(external connector). 52 * @extcon_dev: the extcon device. 53 * @wq: the workqueue to control charger according to the state of 54 * charger cable. If charger cable is attached, enable charger. 55 * But if charger cable is detached, disable charger. 56 * @nb: the notifier block to receive changed state from EXTCON 57 * (External Connector) when charger cable is attached/detached. 58 * @attached: the state of charger cable. 59 * true: the charger cable is attached 60 * false: the charger cable is detached 61 * @charger: the instance of struct charger_regulator. 62 * @cm: the Charger Manager representing the battery. 63 */ 64struct charger_cable { 65 const char *extcon_name; 66 const char *name; 67 68 /* The charger-manager use Exton framework*/ 69 struct extcon_specific_cable_nb extcon_dev; 70 struct work_struct wq; 71 struct notifier_block nb; 72 73 /* The state of charger cable */ 74 bool attached; 75 76 struct charger_regulator *charger; 77 78 /* 79 * Set min/max current of regulator to protect over-current issue 80 * according to a kind of charger cable when cable is attached. 81 */ 82 int min_uA; 83 int max_uA; 84 85 struct charger_manager *cm; 86}; 87 88/** 89 * struct charger_regulator 90 * @regulator_name: the name of regulator for using charger. 91 * @consumer: the regulator consumer for the charger. 92 * @externally_control: 93 * Set if the charger-manager cannot control charger, 94 * the charger will be maintained with disabled state. 95 * @cables: 96 * the array of charger cables to enable/disable charger 97 * and set current limit according to constratint data of 98 * struct charger_cable if only charger cable included 99 * in the array of charger cables is attached/detached. 100 * @num_cables: the number of charger cables. 101 * @attr_g: Attribute group for the charger(regulator) 102 * @attr_name: "name" sysfs entry 103 * @attr_state: "state" sysfs entry 104 * @attr_externally_control: "externally_control" sysfs entry 105 * @attrs: Arrays pointing to attr_name/state/externally_control for attr_g 106 */ 107struct charger_regulator { 108 /* The name of regulator for charging */ 109 const char *regulator_name; 110 struct regulator *consumer; 111 112 /* charger never on when system is on */ 113 int externally_control; 114 115 /* 116 * Store constraint information related to current limit, 117 * each cable have different condition for charging. 118 */ 119 struct charger_cable *cables; 120 int num_cables; 121 122 struct attribute_group attr_g; 123 struct device_attribute attr_name; 124 struct device_attribute attr_state; 125 struct device_attribute attr_externally_control; 126 struct attribute *attrs[4]; 127 128 struct charger_manager *cm; 129}; 130 131/** 132 * struct charger_desc 133 * @psy_name: the name of power-supply-class for charger manager 134 * @polling_mode: 135 * Determine which polling mode will be used 136 * @fullbatt_vchkdrop_ms: 137 * @fullbatt_vchkdrop_uV: 138 * Check voltage drop after the battery is fully charged. 139 * If it has dropped more than fullbatt_vchkdrop_uV after 140 * fullbatt_vchkdrop_ms, CM will restart charging. 141 * @fullbatt_uV: voltage in microvolt 142 * If VBATT >= fullbatt_uV, it is assumed to be full. 143 * @fullbatt_soc: state of Charge in % 144 * If state of Charge >= fullbatt_soc, it is assumed to be full. 145 * @fullbatt_full_capacity: full capacity measure 146 * If full capacity of battery >= fullbatt_full_capacity, 147 * it is assumed to be full. 148 * @polling_interval_ms: interval in millisecond at which 149 * charger manager will monitor battery health 150 * @battery_present: 151 * Specify where information for existance of battery can be obtained 152 * @psy_charger_stat: the names of power-supply for chargers 153 * @num_charger_regulator: the number of entries in charger_regulators 154 * @charger_regulators: array of charger regulators 155 * @psy_fuel_gauge: the name of power-supply for fuel gauge 156 * @thermal_zone : the name of thermal zone for battery 157 * @temp_min : Minimum battery temperature for charging. 158 * @temp_max : Maximum battery temperature for charging. 159 * @temp_diff : Temperature diffential to restart charging. 160 * @measure_battery_temp: 161 * true: measure battery temperature 162 * false: measure ambient temperature 163 * @charging_max_duration_ms: Maximum possible duration for charging 164 * If whole charging duration exceed 'charging_max_duration_ms', 165 * cm stop charging. 166 * @discharging_max_duration_ms: 167 * Maximum possible duration for discharging with charger cable 168 * after full-batt. If discharging duration exceed 'discharging 169 * max_duration_ms', cm start charging. 170 */ 171struct charger_desc { 172 const char *psy_name; 173 174 enum polling_modes polling_mode; 175 unsigned int polling_interval_ms; 176 177 unsigned int fullbatt_vchkdrop_ms; 178 unsigned int fullbatt_vchkdrop_uV; 179 unsigned int fullbatt_uV; 180 unsigned int fullbatt_soc; 181 unsigned int fullbatt_full_capacity; 182 183 enum data_source battery_present; 184 185 const char **psy_charger_stat; 186 187 int num_charger_regulators; 188 struct charger_regulator *charger_regulators; 189 190 const char *psy_fuel_gauge; 191 192 const char *thermal_zone; 193 194 int temp_min; 195 int temp_max; 196 int temp_diff; 197 198 bool measure_battery_temp; 199 200 u32 charging_max_duration_ms; 201 u32 discharging_max_duration_ms; 202}; 203 204#define PSY_NAME_MAX 30 205 206/** 207 * struct charger_manager 208 * @entry: entry for list 209 * @dev: device pointer 210 * @desc: instance of charger_desc 211 * @fuel_gauge: power_supply for fuel gauge 212 * @charger_stat: array of power_supply for chargers 213 * @tzd_batt : thermal zone device for battery 214 * @charger_enabled: the state of charger 215 * @fullbatt_vchk_jiffies_at: 216 * jiffies at the time full battery check will occur. 217 * @fullbatt_vchk_work: work queue for full battery check 218 * @emergency_stop: 219 * When setting true, stop charging 220 * @psy_name_buf: the name of power-supply-class for charger manager 221 * @charger_psy: power_supply for charger manager 222 * @status_save_ext_pwr_inserted: 223 * saved status of external power before entering suspend-to-RAM 224 * @status_save_batt: 225 * saved status of battery before entering suspend-to-RAM 226 * @charging_start_time: saved start time of enabling charging 227 * @charging_end_time: saved end time of disabling charging 228 */ 229struct charger_manager { 230 struct list_head entry; 231 struct device *dev; 232 struct charger_desc *desc; 233 234#ifdef CONFIG_THERMAL 235 struct thermal_zone_device *tzd_batt; 236#endif 237 bool charger_enabled; 238 239 unsigned long fullbatt_vchk_jiffies_at; 240 struct delayed_work fullbatt_vchk_work; 241 242 int emergency_stop; 243 244 char psy_name_buf[PSY_NAME_MAX + 1]; 245 struct power_supply_desc charger_psy_desc; 246 struct power_supply *charger_psy; 247 248 u64 charging_start_time; 249 u64 charging_end_time; 250}; 251 252#ifdef CONFIG_CHARGER_MANAGER 253extern void cm_notify_event(struct power_supply *psy, 254 enum cm_event_types type, char *msg); 255#else 256static inline void cm_notify_event(struct power_supply *psy, 257 enum cm_event_types type, char *msg) { } 258#endif 259#endif /* _CHARGER_MANAGER_H */ 260