1 /*
2  *  Sysfs interface for the universal power supply monitor class
3  *
4  *  Copyright © 2007  David Woodhouse <dwmw2@infradead.org>
5  *  Copyright © 2007  Anton Vorontsov <cbou@mail.ru>
6  *  Copyright © 2004  Szabolcs Gyurko
7  *  Copyright © 2003  Ian Molton <spyro@f2s.com>
8  *
9  *  Modified: 2004, Oct     Szabolcs Gyurko
10  *
11  *  You may use this code as per GPL version 2
12  */
13 
14 #include <linux/ctype.h>
15 #include <linux/device.h>
16 #include <linux/power_supply.h>
17 #include <linux/slab.h>
18 #include <linux/stat.h>
19 
20 #include "power_supply.h"
21 
22 /*
23  * This is because the name "current" breaks the device attr macro.
24  * The "current" word resolves to "(get_current())" so instead of
25  * "current" "(get_current())" appears in the sysfs.
26  *
27  * The source of this definition is the device.h which calls __ATTR
28  * macro in sysfs.h which calls the __stringify macro.
29  *
30  * Only modification that the name is not tried to be resolved
31  * (as a macro let's say).
32  */
33 
34 #define POWER_SUPPLY_ATTR(_name)					\
35 {									\
36 	.attr = { .name = #_name },					\
37 	.show = power_supply_show_property,				\
38 	.store = power_supply_store_property,				\
39 }
40 
41 static struct device_attribute power_supply_attrs[];
42 
power_supply_show_property(struct device * dev,struct device_attribute * attr,char * buf)43 static ssize_t power_supply_show_property(struct device *dev,
44 					  struct device_attribute *attr,
45 					  char *buf) {
46 	static char *type_text[] = {
47 		"Unknown", "Battery", "UPS", "Mains", "USB",
48 		"USB_DCP", "USB_CDP", "USB_ACA"
49 	};
50 	static char *status_text[] = {
51 		"Unknown", "Charging", "Discharging", "Not charging", "Full"
52 	};
53 	static char *charge_type[] = {
54 		"Unknown", "N/A", "Trickle", "Fast"
55 	};
56 	static char *health_text[] = {
57 		"Unknown", "Good", "Overheat", "Dead", "Over voltage",
58 		"Unspecified failure", "Cold", "Watchdog timer expire",
59 		"Safety timer expire"
60 	};
61 	static char *technology_text[] = {
62 		"Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", "NiCd",
63 		"LiMn"
64 	};
65 	static char *capacity_level_text[] = {
66 		"Unknown", "Critical", "Low", "Normal", "High", "Full"
67 	};
68 	static char *scope_text[] = {
69 		"Unknown", "System", "Device"
70 	};
71 	ssize_t ret = 0;
72 	struct power_supply *psy = dev_get_drvdata(dev);
73 	const ptrdiff_t off = attr - power_supply_attrs;
74 	union power_supply_propval value;
75 
76 	if (off == POWER_SUPPLY_PROP_TYPE) {
77 		value.intval = psy->desc->type;
78 	} else {
79 		ret = power_supply_get_property(psy, off, &value);
80 
81 		if (ret < 0) {
82 			if (ret == -ENODATA)
83 				dev_dbg(dev, "driver has no data for `%s' property\n",
84 					attr->attr.name);
85 			else if (ret != -ENODEV)
86 				dev_err(dev, "driver failed to report `%s' property: %zd\n",
87 					attr->attr.name, ret);
88 			return ret;
89 		}
90 	}
91 
92 	if (off == POWER_SUPPLY_PROP_STATUS)
93 		return sprintf(buf, "%s\n", status_text[value.intval]);
94 	else if (off == POWER_SUPPLY_PROP_CHARGE_TYPE)
95 		return sprintf(buf, "%s\n", charge_type[value.intval]);
96 	else if (off == POWER_SUPPLY_PROP_HEALTH)
97 		return sprintf(buf, "%s\n", health_text[value.intval]);
98 	else if (off == POWER_SUPPLY_PROP_TECHNOLOGY)
99 		return sprintf(buf, "%s\n", technology_text[value.intval]);
100 	else if (off == POWER_SUPPLY_PROP_CAPACITY_LEVEL)
101 		return sprintf(buf, "%s\n", capacity_level_text[value.intval]);
102 	else if (off == POWER_SUPPLY_PROP_TYPE)
103 		return sprintf(buf, "%s\n", type_text[value.intval]);
104 	else if (off == POWER_SUPPLY_PROP_SCOPE)
105 		return sprintf(buf, "%s\n", scope_text[value.intval]);
106 	else if (off >= POWER_SUPPLY_PROP_MODEL_NAME)
107 		return sprintf(buf, "%s\n", value.strval);
108 
109 	return sprintf(buf, "%d\n", value.intval);
110 }
111 
power_supply_store_property(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)112 static ssize_t power_supply_store_property(struct device *dev,
113 					   struct device_attribute *attr,
114 					   const char *buf, size_t count) {
115 	ssize_t ret;
116 	struct power_supply *psy = dev_get_drvdata(dev);
117 	const ptrdiff_t off = attr - power_supply_attrs;
118 	union power_supply_propval value;
119 	long long_val;
120 
121 	/* TODO: support other types than int */
122 	ret = kstrtol(buf, 10, &long_val);
123 	if (ret < 0)
124 		return ret;
125 
126 	value.intval = long_val;
127 
128 	ret = power_supply_set_property(psy, off, &value);
129 	if (ret < 0)
130 		return ret;
131 
132 	return count;
133 }
134 
135 /* Must be in the same order as POWER_SUPPLY_PROP_* */
136 static struct device_attribute power_supply_attrs[] = {
137 	/* Properties of type `int' */
138 	POWER_SUPPLY_ATTR(status),
139 	POWER_SUPPLY_ATTR(charge_type),
140 	POWER_SUPPLY_ATTR(health),
141 	POWER_SUPPLY_ATTR(present),
142 	POWER_SUPPLY_ATTR(online),
143 	POWER_SUPPLY_ATTR(authentic),
144 	POWER_SUPPLY_ATTR(technology),
145 	POWER_SUPPLY_ATTR(cycle_count),
146 	POWER_SUPPLY_ATTR(voltage_max),
147 	POWER_SUPPLY_ATTR(voltage_min),
148 	POWER_SUPPLY_ATTR(voltage_max_design),
149 	POWER_SUPPLY_ATTR(voltage_min_design),
150 	POWER_SUPPLY_ATTR(voltage_now),
151 	POWER_SUPPLY_ATTR(voltage_avg),
152 	POWER_SUPPLY_ATTR(voltage_ocv),
153 	POWER_SUPPLY_ATTR(voltage_boot),
154 	POWER_SUPPLY_ATTR(current_max),
155 	POWER_SUPPLY_ATTR(current_now),
156 	POWER_SUPPLY_ATTR(current_avg),
157 	POWER_SUPPLY_ATTR(current_boot),
158 	POWER_SUPPLY_ATTR(power_now),
159 	POWER_SUPPLY_ATTR(power_avg),
160 	POWER_SUPPLY_ATTR(charge_full_design),
161 	POWER_SUPPLY_ATTR(charge_empty_design),
162 	POWER_SUPPLY_ATTR(charge_full),
163 	POWER_SUPPLY_ATTR(charge_empty),
164 	POWER_SUPPLY_ATTR(charge_now),
165 	POWER_SUPPLY_ATTR(charge_avg),
166 	POWER_SUPPLY_ATTR(charge_counter),
167 	POWER_SUPPLY_ATTR(constant_charge_current),
168 	POWER_SUPPLY_ATTR(constant_charge_current_max),
169 	POWER_SUPPLY_ATTR(constant_charge_voltage),
170 	POWER_SUPPLY_ATTR(constant_charge_voltage_max),
171 	POWER_SUPPLY_ATTR(charge_control_limit),
172 	POWER_SUPPLY_ATTR(charge_control_limit_max),
173 	POWER_SUPPLY_ATTR(input_current_limit),
174 	POWER_SUPPLY_ATTR(energy_full_design),
175 	POWER_SUPPLY_ATTR(energy_empty_design),
176 	POWER_SUPPLY_ATTR(energy_full),
177 	POWER_SUPPLY_ATTR(energy_empty),
178 	POWER_SUPPLY_ATTR(energy_now),
179 	POWER_SUPPLY_ATTR(energy_avg),
180 	POWER_SUPPLY_ATTR(capacity),
181 	POWER_SUPPLY_ATTR(capacity_alert_min),
182 	POWER_SUPPLY_ATTR(capacity_alert_max),
183 	POWER_SUPPLY_ATTR(capacity_level),
184 	POWER_SUPPLY_ATTR(temp),
185 	POWER_SUPPLY_ATTR(temp_max),
186 	POWER_SUPPLY_ATTR(temp_min),
187 	POWER_SUPPLY_ATTR(temp_alert_min),
188 	POWER_SUPPLY_ATTR(temp_alert_max),
189 	POWER_SUPPLY_ATTR(temp_ambient),
190 	POWER_SUPPLY_ATTR(temp_ambient_alert_min),
191 	POWER_SUPPLY_ATTR(temp_ambient_alert_max),
192 	POWER_SUPPLY_ATTR(time_to_empty_now),
193 	POWER_SUPPLY_ATTR(time_to_empty_avg),
194 	POWER_SUPPLY_ATTR(time_to_full_now),
195 	POWER_SUPPLY_ATTR(time_to_full_avg),
196 	POWER_SUPPLY_ATTR(type),
197 	POWER_SUPPLY_ATTR(scope),
198 	POWER_SUPPLY_ATTR(charge_term_current),
199 	POWER_SUPPLY_ATTR(calibrate),
200 	/* Properties of type `const char *' */
201 	POWER_SUPPLY_ATTR(model_name),
202 	POWER_SUPPLY_ATTR(manufacturer),
203 	POWER_SUPPLY_ATTR(serial_number),
204 };
205 
206 static struct attribute *
207 __power_supply_attrs[ARRAY_SIZE(power_supply_attrs) + 1];
208 
power_supply_attr_is_visible(struct kobject * kobj,struct attribute * attr,int attrno)209 static umode_t power_supply_attr_is_visible(struct kobject *kobj,
210 					   struct attribute *attr,
211 					   int attrno)
212 {
213 	struct device *dev = container_of(kobj, struct device, kobj);
214 	struct power_supply *psy = dev_get_drvdata(dev);
215 	umode_t mode = S_IRUSR | S_IRGRP | S_IROTH;
216 	int i;
217 
218 	if (attrno == POWER_SUPPLY_PROP_TYPE)
219 		return mode;
220 
221 	for (i = 0; i < psy->desc->num_properties; i++) {
222 		int property = psy->desc->properties[i];
223 
224 		if (property == attrno) {
225 			if (psy->desc->property_is_writeable &&
226 			    psy->desc->property_is_writeable(psy, property) > 0)
227 				mode |= S_IWUSR;
228 
229 			return mode;
230 		}
231 	}
232 
233 	return 0;
234 }
235 
236 static struct attribute_group power_supply_attr_group = {
237 	.attrs = __power_supply_attrs,
238 	.is_visible = power_supply_attr_is_visible,
239 };
240 
241 static const struct attribute_group *power_supply_attr_groups[] = {
242 	&power_supply_attr_group,
243 	NULL,
244 };
245 
power_supply_init_attrs(struct device_type * dev_type)246 void power_supply_init_attrs(struct device_type *dev_type)
247 {
248 	int i;
249 
250 	dev_type->groups = power_supply_attr_groups;
251 
252 	for (i = 0; i < ARRAY_SIZE(power_supply_attrs); i++)
253 		__power_supply_attrs[i] = &power_supply_attrs[i].attr;
254 }
255 
kstruprdup(const char * str,gfp_t gfp)256 static char *kstruprdup(const char *str, gfp_t gfp)
257 {
258 	char *ret, *ustr;
259 
260 	ustr = ret = kmalloc(strlen(str) + 1, gfp);
261 
262 	if (!ret)
263 		return NULL;
264 
265 	while (*str)
266 		*ustr++ = toupper(*str++);
267 
268 	*ustr = 0;
269 
270 	return ret;
271 }
272 
power_supply_uevent(struct device * dev,struct kobj_uevent_env * env)273 int power_supply_uevent(struct device *dev, struct kobj_uevent_env *env)
274 {
275 	struct power_supply *psy = dev_get_drvdata(dev);
276 	int ret = 0, j;
277 	char *prop_buf;
278 	char *attrname;
279 
280 	dev_dbg(dev, "uevent\n");
281 
282 	if (!psy || !psy->desc) {
283 		dev_dbg(dev, "No power supply yet\n");
284 		return ret;
285 	}
286 
287 	dev_dbg(dev, "POWER_SUPPLY_NAME=%s\n", psy->desc->name);
288 
289 	ret = add_uevent_var(env, "POWER_SUPPLY_NAME=%s", psy->desc->name);
290 	if (ret)
291 		return ret;
292 
293 	prop_buf = (char *)get_zeroed_page(GFP_KERNEL);
294 	if (!prop_buf)
295 		return -ENOMEM;
296 
297 	for (j = 0; j < psy->desc->num_properties; j++) {
298 		struct device_attribute *attr;
299 		char *line;
300 
301 		attr = &power_supply_attrs[psy->desc->properties[j]];
302 
303 		ret = power_supply_show_property(dev, attr, prop_buf);
304 		if (ret == -ENODEV || ret == -ENODATA) {
305 			/* When a battery is absent, we expect -ENODEV. Don't abort;
306 			   send the uevent with at least the the PRESENT=0 property */
307 			ret = 0;
308 			continue;
309 		}
310 
311 		if (ret < 0)
312 			goto out;
313 
314 		line = strchr(prop_buf, '\n');
315 		if (line)
316 			*line = 0;
317 
318 		attrname = kstruprdup(attr->attr.name, GFP_KERNEL);
319 		if (!attrname) {
320 			ret = -ENOMEM;
321 			goto out;
322 		}
323 
324 		dev_dbg(dev, "prop %s=%s\n", attrname, prop_buf);
325 
326 		ret = add_uevent_var(env, "POWER_SUPPLY_%s=%s", attrname, prop_buf);
327 		kfree(attrname);
328 		if (ret)
329 			goto out;
330 	}
331 
332 out:
333 	free_page((unsigned long)prop_buf);
334 
335 	return ret;
336 }
337