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 ssize_t power_supply_show_property(struct device *dev,
44 struct device_attribute *attr,
46 static char *type_text[] = {
47 "Unknown", "Battery", "UPS", "Mains", "USB",
48 "USB_DCP", "USB_CDP", "USB_ACA", "USB_C",
49 "USB_PD", "USB_PD_DRP"
51 static char *status_text[] = {
52 "Unknown", "Charging", "Discharging", "Not charging", "Full"
54 static char *charge_type[] = {
55 "Unknown", "N/A", "Trickle", "Fast"
57 static char *health_text[] = {
58 "Unknown", "Good", "Overheat", "Dead", "Over voltage",
59 "Unspecified failure", "Cold", "Watchdog timer expire",
62 static char *technology_text[] = {
63 "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", "NiCd",
66 static char *capacity_level_text[] = {
67 "Unknown", "Critical", "Low", "Normal", "High", "Full"
69 static char *scope_text[] = {
70 "Unknown", "System", "Device"
73 struct power_supply *psy = dev_get_drvdata(dev);
74 const ptrdiff_t off = attr - power_supply_attrs;
75 union power_supply_propval value;
77 if (off == POWER_SUPPLY_PROP_TYPE) {
78 value.intval = psy->desc->type;
80 ret = power_supply_get_property(psy, off, &value);
84 dev_dbg(dev, "driver has no data for `%s' property\n",
86 else if (ret != -ENODEV && ret != -EAGAIN)
87 dev_err_ratelimited(dev,
88 "driver failed to report `%s' property: %zd\n",
89 attr->attr.name, ret);
94 if (off == POWER_SUPPLY_PROP_STATUS)
95 return sprintf(buf, "%s\n", status_text[value.intval]);
96 else if (off == POWER_SUPPLY_PROP_CHARGE_TYPE)
97 return sprintf(buf, "%s\n", charge_type[value.intval]);
98 else if (off == POWER_SUPPLY_PROP_HEALTH)
99 return sprintf(buf, "%s\n", health_text[value.intval]);
100 else if (off == POWER_SUPPLY_PROP_TECHNOLOGY)
101 return sprintf(buf, "%s\n", technology_text[value.intval]);
102 else if (off == POWER_SUPPLY_PROP_CAPACITY_LEVEL)
103 return sprintf(buf, "%s\n", capacity_level_text[value.intval]);
104 else if (off == POWER_SUPPLY_PROP_TYPE)
105 return sprintf(buf, "%s\n", type_text[value.intval]);
106 else if (off == POWER_SUPPLY_PROP_SCOPE)
107 return sprintf(buf, "%s\n", scope_text[value.intval]);
108 else if (off >= POWER_SUPPLY_PROP_MODEL_NAME)
109 return sprintf(buf, "%s\n", value.strval);
111 return sprintf(buf, "%d\n", value.intval);
114 static ssize_t power_supply_store_property(struct device *dev,
115 struct device_attribute *attr,
116 const char *buf, size_t count) {
118 struct power_supply *psy = dev_get_drvdata(dev);
119 const ptrdiff_t off = attr - power_supply_attrs;
120 union power_supply_propval value;
123 /* TODO: support other types than int */
124 ret = kstrtol(buf, 10, &long_val);
128 value.intval = long_val;
130 ret = power_supply_set_property(psy, off, &value);
137 /* Must be in the same order as POWER_SUPPLY_PROP_* */
138 static struct device_attribute power_supply_attrs[] = {
139 /* Properties of type `int' */
140 POWER_SUPPLY_ATTR(status),
141 POWER_SUPPLY_ATTR(charge_type),
142 POWER_SUPPLY_ATTR(health),
143 POWER_SUPPLY_ATTR(present),
144 POWER_SUPPLY_ATTR(online),
145 POWER_SUPPLY_ATTR(authentic),
146 POWER_SUPPLY_ATTR(technology),
147 POWER_SUPPLY_ATTR(cycle_count),
148 POWER_SUPPLY_ATTR(voltage_max),
149 POWER_SUPPLY_ATTR(voltage_min),
150 POWER_SUPPLY_ATTR(voltage_max_design),
151 POWER_SUPPLY_ATTR(voltage_min_design),
152 POWER_SUPPLY_ATTR(voltage_now),
153 POWER_SUPPLY_ATTR(voltage_avg),
154 POWER_SUPPLY_ATTR(voltage_ocv),
155 POWER_SUPPLY_ATTR(voltage_boot),
156 POWER_SUPPLY_ATTR(current_max),
157 POWER_SUPPLY_ATTR(current_now),
158 POWER_SUPPLY_ATTR(current_avg),
159 POWER_SUPPLY_ATTR(current_boot),
160 POWER_SUPPLY_ATTR(power_now),
161 POWER_SUPPLY_ATTR(power_avg),
162 POWER_SUPPLY_ATTR(charge_full_design),
163 POWER_SUPPLY_ATTR(charge_empty_design),
164 POWER_SUPPLY_ATTR(charge_full),
165 POWER_SUPPLY_ATTR(charge_empty),
166 POWER_SUPPLY_ATTR(charge_now),
167 POWER_SUPPLY_ATTR(charge_avg),
168 POWER_SUPPLY_ATTR(charge_counter),
169 POWER_SUPPLY_ATTR(constant_charge_current),
170 POWER_SUPPLY_ATTR(constant_charge_current_max),
171 POWER_SUPPLY_ATTR(constant_charge_voltage),
172 POWER_SUPPLY_ATTR(constant_charge_voltage_max),
173 POWER_SUPPLY_ATTR(charge_control_limit),
174 POWER_SUPPLY_ATTR(charge_control_limit_max),
175 POWER_SUPPLY_ATTR(input_current_limit),
176 POWER_SUPPLY_ATTR(energy_full_design),
177 POWER_SUPPLY_ATTR(energy_empty_design),
178 POWER_SUPPLY_ATTR(energy_full),
179 POWER_SUPPLY_ATTR(energy_empty),
180 POWER_SUPPLY_ATTR(energy_now),
181 POWER_SUPPLY_ATTR(energy_avg),
182 POWER_SUPPLY_ATTR(capacity),
183 POWER_SUPPLY_ATTR(capacity_alert_min),
184 POWER_SUPPLY_ATTR(capacity_alert_max),
185 POWER_SUPPLY_ATTR(capacity_level),
186 POWER_SUPPLY_ATTR(temp),
187 POWER_SUPPLY_ATTR(temp_max),
188 POWER_SUPPLY_ATTR(temp_min),
189 POWER_SUPPLY_ATTR(temp_alert_min),
190 POWER_SUPPLY_ATTR(temp_alert_max),
191 POWER_SUPPLY_ATTR(temp_ambient),
192 POWER_SUPPLY_ATTR(temp_ambient_alert_min),
193 POWER_SUPPLY_ATTR(temp_ambient_alert_max),
194 POWER_SUPPLY_ATTR(time_to_empty_now),
195 POWER_SUPPLY_ATTR(time_to_empty_avg),
196 POWER_SUPPLY_ATTR(time_to_full_now),
197 POWER_SUPPLY_ATTR(time_to_full_avg),
198 POWER_SUPPLY_ATTR(type),
199 POWER_SUPPLY_ATTR(scope),
200 POWER_SUPPLY_ATTR(charge_term_current),
201 POWER_SUPPLY_ATTR(calibrate),
202 /* Properties of type `const char *' */
203 POWER_SUPPLY_ATTR(model_name),
204 POWER_SUPPLY_ATTR(manufacturer),
205 POWER_SUPPLY_ATTR(serial_number),
208 static struct attribute *
209 __power_supply_attrs[ARRAY_SIZE(power_supply_attrs) + 1];
211 static umode_t power_supply_attr_is_visible(struct kobject *kobj,
212 struct attribute *attr,
215 struct device *dev = container_of(kobj, struct device, kobj);
216 struct power_supply *psy = dev_get_drvdata(dev);
217 umode_t mode = S_IRUSR | S_IRGRP | S_IROTH;
220 if (attrno == POWER_SUPPLY_PROP_TYPE)
223 for (i = 0; i < psy->desc->num_properties; i++) {
224 int property = psy->desc->properties[i];
226 if (property == attrno) {
227 if (psy->desc->property_is_writeable &&
228 psy->desc->property_is_writeable(psy, property) > 0)
238 static struct attribute_group power_supply_attr_group = {
239 .attrs = __power_supply_attrs,
240 .is_visible = power_supply_attr_is_visible,
243 static const struct attribute_group *power_supply_attr_groups[] = {
244 &power_supply_attr_group,
248 void power_supply_init_attrs(struct device_type *dev_type)
252 dev_type->groups = power_supply_attr_groups;
254 for (i = 0; i < ARRAY_SIZE(power_supply_attrs); i++)
255 __power_supply_attrs[i] = &power_supply_attrs[i].attr;
258 static char *kstruprdup(const char *str, gfp_t gfp)
262 ustr = ret = kmalloc(strlen(str) + 1, gfp);
268 *ustr++ = toupper(*str++);
275 int power_supply_uevent(struct device *dev, struct kobj_uevent_env *env)
277 struct power_supply *psy = dev_get_drvdata(dev);
282 if (!psy || !psy->desc) {
283 dev_dbg(dev, "No power supply yet\n");
287 ret = add_uevent_var(env, "POWER_SUPPLY_NAME=%s", psy->desc->name);
291 prop_buf = (char *)get_zeroed_page(GFP_KERNEL);
295 for (j = 0; j < psy->desc->num_properties; j++) {
296 struct device_attribute *attr;
299 attr = &power_supply_attrs[psy->desc->properties[j]];
301 ret = power_supply_show_property(dev, attr, prop_buf);
302 if (ret == -ENODEV || ret == -ENODATA) {
303 /* When a battery is absent, we expect -ENODEV. Don't abort;
304 send the uevent with at least the the PRESENT=0 property */
312 line = strchr(prop_buf, '\n');
316 attrname = kstruprdup(attr->attr.name, GFP_KERNEL);
322 ret = add_uevent_var(env, "POWER_SUPPLY_%s=%s", attrname, prop_buf);
329 free_page((unsigned long)prop_buf);