2 * Sysfs interface for the universal power supply monitor class
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>
9 * Modified: 2004, Oct Szabolcs Gyurko
11 * You may use this code as per GPL version 2
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>
20 #include "power_supply.h"
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.
27 * The source of this definition is the device.h which calls __ATTR
28 * macro in sysfs.h which calls the __stringify macro.
30 * Only modification that the name is not tried to be resolved
31 * (as a macro let's say).
34 #define POWER_SUPPLY_ATTR(_name) \
36 .attr = { .name = #_name }, \
37 .show = power_supply_show_property, \
38 .store = power_supply_store_property, \
41 static struct device_attribute power_supply_attrs[];
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"
49 static const char * const power_supply_status_text[] = {
50 "Unknown", "Charging", "Discharging", "Not charging", "Full"
53 static const char * const power_supply_charge_type_text[] = {
54 "Unknown", "N/A", "Trickle", "Fast"
57 static const char * const power_supply_health_text[] = {
58 "Unknown", "Good", "Overheat", "Dead", "Over voltage",
59 "Unspecified failure", "Cold", "Watchdog timer expire",
63 static const char * const power_supply_technology_text[] = {
64 "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", "NiCd",
68 static const char * const power_supply_capacity_level_text[] = {
69 "Unknown", "Critical", "Low", "Normal", "High", "Full"
72 static const char * const power_supply_scope_text[] = {
73 "Unknown", "System", "Device"
76 static ssize_t power_supply_show_property(struct device *dev,
77 struct device_attribute *attr,
80 struct power_supply *psy = dev_get_drvdata(dev);
81 const ptrdiff_t off = attr - power_supply_attrs;
82 union power_supply_propval value;
84 if (off == POWER_SUPPLY_PROP_TYPE) {
85 value.intval = psy->desc->type;
87 ret = power_supply_get_property(psy, off, &value);
91 dev_dbg(dev, "driver has no data for `%s' property\n",
93 else if (ret != -ENODEV && ret != -EAGAIN)
94 dev_err_ratelimited(dev,
95 "driver failed to report `%s' property: %zd\n",
96 attr->attr.name, ret);
101 if (off == POWER_SUPPLY_PROP_STATUS)
102 return sprintf(buf, "%s\n",
103 power_supply_status_text[value.intval]);
104 else if (off == POWER_SUPPLY_PROP_CHARGE_TYPE)
105 return sprintf(buf, "%s\n",
106 power_supply_charge_type_text[value.intval]);
107 else if (off == POWER_SUPPLY_PROP_HEALTH)
108 return sprintf(buf, "%s\n",
109 power_supply_health_text[value.intval]);
110 else if (off == POWER_SUPPLY_PROP_TECHNOLOGY)
111 return sprintf(buf, "%s\n",
112 power_supply_technology_text[value.intval]);
113 else if (off == POWER_SUPPLY_PROP_CAPACITY_LEVEL)
114 return sprintf(buf, "%s\n",
115 power_supply_capacity_level_text[value.intval]);
116 else if (off == POWER_SUPPLY_PROP_TYPE)
117 return sprintf(buf, "%s\n",
118 power_supply_type_text[value.intval]);
119 else if (off == POWER_SUPPLY_PROP_SCOPE)
120 return sprintf(buf, "%s\n",
121 power_supply_scope_text[value.intval]);
122 else if (off >= POWER_SUPPLY_PROP_MODEL_NAME)
123 return sprintf(buf, "%s\n", value.strval);
125 return sprintf(buf, "%d\n", value.intval);
128 static ssize_t power_supply_store_property(struct device *dev,
129 struct device_attribute *attr,
130 const char *buf, size_t count) {
132 struct power_supply *psy = dev_get_drvdata(dev);
133 const ptrdiff_t off = attr - power_supply_attrs;
134 union power_supply_propval value;
136 /* maybe it is a enum property? */
138 case POWER_SUPPLY_PROP_STATUS:
139 ret = sysfs_match_string(power_supply_status_text, buf);
141 case POWER_SUPPLY_PROP_CHARGE_TYPE:
142 ret = sysfs_match_string(power_supply_charge_type_text, buf);
144 case POWER_SUPPLY_PROP_HEALTH:
145 ret = sysfs_match_string(power_supply_health_text, buf);
147 case POWER_SUPPLY_PROP_TECHNOLOGY:
148 ret = sysfs_match_string(power_supply_technology_text, buf);
150 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
151 ret = sysfs_match_string(power_supply_capacity_level_text, buf);
153 case POWER_SUPPLY_PROP_SCOPE:
154 ret = sysfs_match_string(power_supply_scope_text, buf);
161 * If no match was found, then check to see if it is an integer.
162 * Integer values are valid for enums in addition to the text value.
167 ret = kstrtol(buf, 10, &long_val);
176 ret = power_supply_set_property(psy, off, &value);
183 /* Must be in the same order as POWER_SUPPLY_PROP_* */
184 static struct device_attribute power_supply_attrs[] = {
185 /* Properties of type `int' */
186 POWER_SUPPLY_ATTR(status),
187 POWER_SUPPLY_ATTR(charge_type),
188 POWER_SUPPLY_ATTR(health),
189 POWER_SUPPLY_ATTR(present),
190 POWER_SUPPLY_ATTR(online),
191 POWER_SUPPLY_ATTR(authentic),
192 POWER_SUPPLY_ATTR(technology),
193 POWER_SUPPLY_ATTR(cycle_count),
194 POWER_SUPPLY_ATTR(voltage_max),
195 POWER_SUPPLY_ATTR(voltage_min),
196 POWER_SUPPLY_ATTR(voltage_max_design),
197 POWER_SUPPLY_ATTR(voltage_min_design),
198 POWER_SUPPLY_ATTR(voltage_now),
199 POWER_SUPPLY_ATTR(voltage_avg),
200 POWER_SUPPLY_ATTR(voltage_ocv),
201 POWER_SUPPLY_ATTR(voltage_boot),
202 POWER_SUPPLY_ATTR(current_max),
203 POWER_SUPPLY_ATTR(current_now),
204 POWER_SUPPLY_ATTR(current_avg),
205 POWER_SUPPLY_ATTR(current_boot),
206 POWER_SUPPLY_ATTR(power_now),
207 POWER_SUPPLY_ATTR(power_avg),
208 POWER_SUPPLY_ATTR(charge_full_design),
209 POWER_SUPPLY_ATTR(charge_empty_design),
210 POWER_SUPPLY_ATTR(charge_full),
211 POWER_SUPPLY_ATTR(charge_empty),
212 POWER_SUPPLY_ATTR(charge_now),
213 POWER_SUPPLY_ATTR(charge_avg),
214 POWER_SUPPLY_ATTR(charge_counter),
215 POWER_SUPPLY_ATTR(constant_charge_current),
216 POWER_SUPPLY_ATTR(constant_charge_current_max),
217 POWER_SUPPLY_ATTR(constant_charge_voltage),
218 POWER_SUPPLY_ATTR(constant_charge_voltage_max),
219 POWER_SUPPLY_ATTR(charge_control_limit),
220 POWER_SUPPLY_ATTR(charge_control_limit_max),
221 POWER_SUPPLY_ATTR(input_current_limit),
222 POWER_SUPPLY_ATTR(energy_full_design),
223 POWER_SUPPLY_ATTR(energy_empty_design),
224 POWER_SUPPLY_ATTR(energy_full),
225 POWER_SUPPLY_ATTR(energy_empty),
226 POWER_SUPPLY_ATTR(energy_now),
227 POWER_SUPPLY_ATTR(energy_avg),
228 POWER_SUPPLY_ATTR(capacity),
229 POWER_SUPPLY_ATTR(capacity_alert_min),
230 POWER_SUPPLY_ATTR(capacity_alert_max),
231 POWER_SUPPLY_ATTR(capacity_level),
232 POWER_SUPPLY_ATTR(temp),
233 POWER_SUPPLY_ATTR(temp_max),
234 POWER_SUPPLY_ATTR(temp_min),
235 POWER_SUPPLY_ATTR(temp_alert_min),
236 POWER_SUPPLY_ATTR(temp_alert_max),
237 POWER_SUPPLY_ATTR(temp_ambient),
238 POWER_SUPPLY_ATTR(temp_ambient_alert_min),
239 POWER_SUPPLY_ATTR(temp_ambient_alert_max),
240 POWER_SUPPLY_ATTR(time_to_empty_now),
241 POWER_SUPPLY_ATTR(time_to_empty_avg),
242 POWER_SUPPLY_ATTR(time_to_full_now),
243 POWER_SUPPLY_ATTR(time_to_full_avg),
244 POWER_SUPPLY_ATTR(type),
245 POWER_SUPPLY_ATTR(scope),
246 POWER_SUPPLY_ATTR(precharge_current),
247 POWER_SUPPLY_ATTR(charge_term_current),
248 POWER_SUPPLY_ATTR(calibrate),
249 /* Properties of type `const char *' */
250 POWER_SUPPLY_ATTR(model_name),
251 POWER_SUPPLY_ATTR(manufacturer),
252 POWER_SUPPLY_ATTR(serial_number),
255 static struct attribute *
256 __power_supply_attrs[ARRAY_SIZE(power_supply_attrs) + 1];
258 static umode_t power_supply_attr_is_visible(struct kobject *kobj,
259 struct attribute *attr,
262 struct device *dev = container_of(kobj, struct device, kobj);
263 struct power_supply *psy = dev_get_drvdata(dev);
264 umode_t mode = S_IRUSR | S_IRGRP | S_IROTH;
267 if (attrno == POWER_SUPPLY_PROP_TYPE)
270 for (i = 0; i < psy->desc->num_properties; i++) {
271 int property = psy->desc->properties[i];
273 if (property == attrno) {
274 if (psy->desc->property_is_writeable &&
275 psy->desc->property_is_writeable(psy, property) > 0)
285 static struct attribute_group power_supply_attr_group = {
286 .attrs = __power_supply_attrs,
287 .is_visible = power_supply_attr_is_visible,
290 static const struct attribute_group *power_supply_attr_groups[] = {
291 &power_supply_attr_group,
295 void power_supply_init_attrs(struct device_type *dev_type)
299 dev_type->groups = power_supply_attr_groups;
301 for (i = 0; i < ARRAY_SIZE(power_supply_attrs); i++)
302 __power_supply_attrs[i] = &power_supply_attrs[i].attr;
305 static char *kstruprdup(const char *str, gfp_t gfp)
309 ustr = ret = kmalloc(strlen(str) + 1, gfp);
315 *ustr++ = toupper(*str++);
322 int power_supply_uevent(struct device *dev, struct kobj_uevent_env *env)
324 struct power_supply *psy = dev_get_drvdata(dev);
329 if (!psy || !psy->desc) {
330 dev_dbg(dev, "No power supply yet\n");
334 ret = add_uevent_var(env, "POWER_SUPPLY_NAME=%s", psy->desc->name);
338 prop_buf = (char *)get_zeroed_page(GFP_KERNEL);
342 for (j = 0; j < psy->desc->num_properties; j++) {
343 struct device_attribute *attr;
346 attr = &power_supply_attrs[psy->desc->properties[j]];
348 ret = power_supply_show_property(dev, attr, prop_buf);
349 if (ret == -ENODEV || ret == -ENODATA) {
350 /* When a battery is absent, we expect -ENODEV. Don't abort;
351 send the uevent with at least the the PRESENT=0 property */
359 line = strchr(prop_buf, '\n');
363 attrname = kstruprdup(attr->attr.name, GFP_KERNEL);
369 ret = add_uevent_var(env, "POWER_SUPPLY_%s=%s", attrname, prop_buf);
376 free_page((unsigned long)prop_buf);