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 
43 static const char * const power_supply_type_text[] = {
44 	"Unknown", "Battery", "UPS", "Mains", "USB",
45 	"USB_DCP", "USB_CDP", "USB_ACA", "USB_C",
46 	"USB_PD", "USB_PD_DRP", "BrickID"
47 };
48 
49 static const char * const power_supply_usb_type_text[] = {
50 	"Unknown", "SDP", "DCP", "CDP", "ACA", "C",
51 	"PD", "PD_DRP", "PD_PPS", "BrickID"
52 };
53 
54 static const char * const power_supply_status_text[] = {
55 	"Unknown", "Charging", "Discharging", "Not charging", "Full"
56 };
57 
58 static const char * const power_supply_charge_type_text[] = {
59 	"Unknown", "N/A", "Trickle", "Fast"
60 };
61 
62 static const char * const power_supply_health_text[] = {
63 	"Unknown", "Good", "Overheat", "Dead", "Over voltage",
64 	"Unspecified failure", "Cold", "Watchdog timer expire",
65 	"Safety timer expire"
66 };
67 
68 static const char * const power_supply_technology_text[] = {
69 	"Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", "NiCd",
70 	"LiMn"
71 };
72 
73 static const char * const power_supply_capacity_level_text[] = {
74 	"Unknown", "Critical", "Low", "Normal", "High", "Full"
75 };
76 
77 static const char * const power_supply_scope_text[] = {
78 	"Unknown", "System", "Device"
79 };
80 
81 static ssize_t power_supply_show_usb_type(struct device *dev,
82 					  enum power_supply_usb_type *usb_types,
83 					  ssize_t num_usb_types,
84 					  union power_supply_propval *value,
85 					  char *buf)
86 {
87 	enum power_supply_usb_type usb_type;
88 	ssize_t count = 0;
89 	bool match = false;
90 	int i;
91 
92 	for (i = 0; i < num_usb_types; ++i) {
93 		usb_type = usb_types[i];
94 
95 		if (value->intval == usb_type) {
96 			count += sprintf(buf + count, "[%s] ",
97 					 power_supply_usb_type_text[usb_type]);
98 			match = true;
99 		} else {
100 			count += sprintf(buf + count, "%s ",
101 					 power_supply_usb_type_text[usb_type]);
102 		}
103 	}
104 
105 	if (!match) {
106 		dev_warn(dev, "driver reporting unsupported connected type\n");
107 		return -EINVAL;
108 	}
109 
110 	if (count)
111 		buf[count - 1] = '\n';
112 
113 	return count;
114 }
115 
116 static ssize_t power_supply_show_property(struct device *dev,
117 					  struct device_attribute *attr,
118 					  char *buf) {
119 	ssize_t ret;
120 	struct power_supply *psy = dev_get_drvdata(dev);
121 	enum power_supply_property psp = attr - power_supply_attrs;
122 	union power_supply_propval value;
123 
124 	if (psp == POWER_SUPPLY_PROP_TYPE) {
125 		value.intval = psy->desc->type;
126 	} else {
127 		ret = power_supply_get_property(psy, psp, &value);
128 
129 		if (ret < 0) {
130 			if (ret == -ENODATA)
131 				dev_dbg(dev, "driver has no data for `%s' property\n",
132 					attr->attr.name);
133 			else if (ret != -ENODEV && ret != -EAGAIN)
134 				dev_err(dev, "driver failed to report `%s' property: %zd\n",
135 					attr->attr.name, ret);
136 			return ret;
137 		}
138 	}
139 
140 	switch (psp) {
141 	case POWER_SUPPLY_PROP_STATUS:
142 		ret = sprintf(buf, "%s\n",
143 			      power_supply_status_text[value.intval]);
144 		break;
145 	case POWER_SUPPLY_PROP_CHARGE_TYPE:
146 		ret = sprintf(buf, "%s\n",
147 			      power_supply_charge_type_text[value.intval]);
148 		break;
149 	case POWER_SUPPLY_PROP_HEALTH:
150 		ret = sprintf(buf, "%s\n",
151 			      power_supply_health_text[value.intval]);
152 		break;
153 	case POWER_SUPPLY_PROP_TECHNOLOGY:
154 		ret = sprintf(buf, "%s\n",
155 			      power_supply_technology_text[value.intval]);
156 		break;
157 	case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
158 		ret = sprintf(buf, "%s\n",
159 			      power_supply_capacity_level_text[value.intval]);
160 		break;
161 	case POWER_SUPPLY_PROP_TYPE:
162 		ret = sprintf(buf, "%s\n",
163 			      power_supply_type_text[value.intval]);
164 		break;
165 	case POWER_SUPPLY_PROP_USB_TYPE:
166 		ret = power_supply_show_usb_type(dev, psy->desc->usb_types,
167 						 psy->desc->num_usb_types,
168 						 &value, buf);
169 		break;
170 	case POWER_SUPPLY_PROP_SCOPE:
171 		ret = sprintf(buf, "%s\n",
172 			      power_supply_scope_text[value.intval]);
173 		break;
174 	case POWER_SUPPLY_PROP_MODEL_NAME ... POWER_SUPPLY_PROP_SERIAL_NUMBER:
175 		ret = sprintf(buf, "%s\n", value.strval);
176 		break;
177 	default:
178 		ret = sprintf(buf, "%d\n", value.intval);
179 	}
180 
181 	return ret;
182 }
183 
184 static ssize_t power_supply_store_property(struct device *dev,
185 					   struct device_attribute *attr,
186 					   const char *buf, size_t count) {
187 	ssize_t ret;
188 	struct power_supply *psy = dev_get_drvdata(dev);
189 	enum power_supply_property psp = attr - power_supply_attrs;
190 	union power_supply_propval value;
191 
192 	switch (psp) {
193 	case POWER_SUPPLY_PROP_STATUS:
194 		ret = sysfs_match_string(power_supply_status_text, buf);
195 		break;
196 	case POWER_SUPPLY_PROP_CHARGE_TYPE:
197 		ret = sysfs_match_string(power_supply_charge_type_text, buf);
198 		break;
199 	case POWER_SUPPLY_PROP_HEALTH:
200 		ret = sysfs_match_string(power_supply_health_text, buf);
201 		break;
202 	case POWER_SUPPLY_PROP_TECHNOLOGY:
203 		ret = sysfs_match_string(power_supply_technology_text, buf);
204 		break;
205 	case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
206 		ret = sysfs_match_string(power_supply_capacity_level_text, buf);
207 		break;
208 	case POWER_SUPPLY_PROP_SCOPE:
209 		ret = sysfs_match_string(power_supply_scope_text, buf);
210 		break;
211 	default:
212 		ret = -EINVAL;
213 	}
214 
215 	/*
216 	 * If no match was found, then check to see if it is an integer.
217 	 * Integer values are valid for enums in addition to the text value.
218 	 */
219 	if (ret < 0) {
220 		long long_val;
221 
222 		ret = kstrtol(buf, 10, &long_val);
223 		if (ret < 0)
224 			return ret;
225 
226 		ret = long_val;
227 	}
228 
229 	value.intval = ret;
230 
231 	ret = power_supply_set_property(psy, psp, &value);
232 	if (ret < 0)
233 		return ret;
234 
235 	return count;
236 }
237 
238 /* Must be in the same order as POWER_SUPPLY_PROP_* */
239 static struct device_attribute power_supply_attrs[] = {
240 	/* Properties of type `int' */
241 	POWER_SUPPLY_ATTR(status),
242 	POWER_SUPPLY_ATTR(charge_type),
243 	POWER_SUPPLY_ATTR(health),
244 	POWER_SUPPLY_ATTR(present),
245 	POWER_SUPPLY_ATTR(online),
246 	POWER_SUPPLY_ATTR(authentic),
247 	POWER_SUPPLY_ATTR(technology),
248 	POWER_SUPPLY_ATTR(cycle_count),
249 	POWER_SUPPLY_ATTR(voltage_max),
250 	POWER_SUPPLY_ATTR(voltage_min),
251 	POWER_SUPPLY_ATTR(voltage_max_design),
252 	POWER_SUPPLY_ATTR(voltage_min_design),
253 	POWER_SUPPLY_ATTR(voltage_now),
254 	POWER_SUPPLY_ATTR(voltage_avg),
255 	POWER_SUPPLY_ATTR(voltage_ocv),
256 	POWER_SUPPLY_ATTR(voltage_boot),
257 	POWER_SUPPLY_ATTR(current_max),
258 	POWER_SUPPLY_ATTR(current_now),
259 	POWER_SUPPLY_ATTR(current_avg),
260 	POWER_SUPPLY_ATTR(current_boot),
261 	POWER_SUPPLY_ATTR(power_now),
262 	POWER_SUPPLY_ATTR(power_avg),
263 	POWER_SUPPLY_ATTR(charge_full_design),
264 	POWER_SUPPLY_ATTR(charge_empty_design),
265 	POWER_SUPPLY_ATTR(charge_full),
266 	POWER_SUPPLY_ATTR(charge_empty),
267 	POWER_SUPPLY_ATTR(charge_now),
268 	POWER_SUPPLY_ATTR(charge_avg),
269 	POWER_SUPPLY_ATTR(charge_counter),
270 	POWER_SUPPLY_ATTR(constant_charge_current),
271 	POWER_SUPPLY_ATTR(constant_charge_current_max),
272 	POWER_SUPPLY_ATTR(constant_charge_voltage),
273 	POWER_SUPPLY_ATTR(constant_charge_voltage_max),
274 	POWER_SUPPLY_ATTR(charge_control_limit),
275 	POWER_SUPPLY_ATTR(charge_control_limit_max),
276 	POWER_SUPPLY_ATTR(input_current_limit),
277 	POWER_SUPPLY_ATTR(energy_full_design),
278 	POWER_SUPPLY_ATTR(energy_empty_design),
279 	POWER_SUPPLY_ATTR(energy_full),
280 	POWER_SUPPLY_ATTR(energy_empty),
281 	POWER_SUPPLY_ATTR(energy_now),
282 	POWER_SUPPLY_ATTR(energy_avg),
283 	POWER_SUPPLY_ATTR(capacity),
284 	POWER_SUPPLY_ATTR(capacity_alert_min),
285 	POWER_SUPPLY_ATTR(capacity_alert_max),
286 	POWER_SUPPLY_ATTR(capacity_level),
287 	POWER_SUPPLY_ATTR(temp),
288 	POWER_SUPPLY_ATTR(temp_max),
289 	POWER_SUPPLY_ATTR(temp_min),
290 	POWER_SUPPLY_ATTR(temp_alert_min),
291 	POWER_SUPPLY_ATTR(temp_alert_max),
292 	POWER_SUPPLY_ATTR(temp_ambient),
293 	POWER_SUPPLY_ATTR(temp_ambient_alert_min),
294 	POWER_SUPPLY_ATTR(temp_ambient_alert_max),
295 	POWER_SUPPLY_ATTR(time_to_empty_now),
296 	POWER_SUPPLY_ATTR(time_to_empty_avg),
297 	POWER_SUPPLY_ATTR(time_to_full_now),
298 	POWER_SUPPLY_ATTR(time_to_full_avg),
299 	POWER_SUPPLY_ATTR(type),
300 	POWER_SUPPLY_ATTR(usb_type),
301 	POWER_SUPPLY_ATTR(scope),
302 	POWER_SUPPLY_ATTR(precharge_current),
303 	POWER_SUPPLY_ATTR(charge_term_current),
304 	POWER_SUPPLY_ATTR(calibrate),
305 	/* Properties of type `const char *' */
306 	POWER_SUPPLY_ATTR(model_name),
307 	POWER_SUPPLY_ATTR(manufacturer),
308 	POWER_SUPPLY_ATTR(serial_number),
309 };
310 
311 static struct attribute *
312 __power_supply_attrs[ARRAY_SIZE(power_supply_attrs) + 1];
313 
314 static umode_t power_supply_attr_is_visible(struct kobject *kobj,
315 					   struct attribute *attr,
316 					   int attrno)
317 {
318 	struct device *dev = container_of(kobj, struct device, kobj);
319 	struct power_supply *psy = dev_get_drvdata(dev);
320 	umode_t mode = S_IRUSR | S_IRGRP | S_IROTH;
321 	int i;
322 
323 	if (attrno == POWER_SUPPLY_PROP_TYPE)
324 		return mode;
325 
326 	for (i = 0; i < psy->desc->num_properties; i++) {
327 		int property = psy->desc->properties[i];
328 
329 		if (property == attrno) {
330 			if (psy->desc->property_is_writeable &&
331 			    psy->desc->property_is_writeable(psy, property) > 0)
332 				mode |= S_IWUSR;
333 
334 			return mode;
335 		}
336 	}
337 
338 	return 0;
339 }
340 
341 static struct attribute_group power_supply_attr_group = {
342 	.attrs = __power_supply_attrs,
343 	.is_visible = power_supply_attr_is_visible,
344 };
345 
346 static const struct attribute_group *power_supply_attr_groups[] = {
347 	&power_supply_attr_group,
348 	NULL,
349 };
350 
351 void power_supply_init_attrs(struct device_type *dev_type)
352 {
353 	int i;
354 
355 	dev_type->groups = power_supply_attr_groups;
356 
357 	for (i = 0; i < ARRAY_SIZE(power_supply_attrs); i++)
358 		__power_supply_attrs[i] = &power_supply_attrs[i].attr;
359 }
360 
361 static char *kstruprdup(const char *str, gfp_t gfp)
362 {
363 	char *ret, *ustr;
364 
365 	ustr = ret = kmalloc(strlen(str) + 1, gfp);
366 
367 	if (!ret)
368 		return NULL;
369 
370 	while (*str)
371 		*ustr++ = toupper(*str++);
372 
373 	*ustr = 0;
374 
375 	return ret;
376 }
377 
378 int power_supply_uevent(struct device *dev, struct kobj_uevent_env *env)
379 {
380 	struct power_supply *psy = dev_get_drvdata(dev);
381 	int ret = 0, j;
382 	char *prop_buf;
383 	char *attrname;
384 
385 	dev_dbg(dev, "uevent\n");
386 
387 	if (!psy || !psy->desc) {
388 		dev_dbg(dev, "No power supply yet\n");
389 		return ret;
390 	}
391 
392 	dev_dbg(dev, "POWER_SUPPLY_NAME=%s\n", psy->desc->name);
393 
394 	ret = add_uevent_var(env, "POWER_SUPPLY_NAME=%s", psy->desc->name);
395 	if (ret)
396 		return ret;
397 
398 	prop_buf = (char *)get_zeroed_page(GFP_KERNEL);
399 	if (!prop_buf)
400 		return -ENOMEM;
401 
402 	for (j = 0; j < psy->desc->num_properties; j++) {
403 		struct device_attribute *attr;
404 		char *line;
405 
406 		attr = &power_supply_attrs[psy->desc->properties[j]];
407 
408 		ret = power_supply_show_property(dev, attr, prop_buf);
409 		if (ret == -ENODEV || ret == -ENODATA) {
410 			/* When a battery is absent, we expect -ENODEV. Don't abort;
411 			   send the uevent with at least the the PRESENT=0 property */
412 			ret = 0;
413 			continue;
414 		}
415 
416 		if (ret < 0)
417 			goto out;
418 
419 		line = strchr(prop_buf, '\n');
420 		if (line)
421 			*line = 0;
422 
423 		attrname = kstruprdup(attr->attr.name, GFP_KERNEL);
424 		if (!attrname) {
425 			ret = -ENOMEM;
426 			goto out;
427 		}
428 
429 		dev_dbg(dev, "prop %s=%s\n", attrname, prop_buf);
430 
431 		ret = add_uevent_var(env, "POWER_SUPPLY_%s=%s", attrname, prop_buf);
432 		kfree(attrname);
433 		if (ret)
434 			goto out;
435 	}
436 
437 out:
438 	free_page((unsigned long)prop_buf);
439 
440 	return ret;
441 }
442