drivers/power/supply/power_supply_sysfs.c

   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 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", "USB_C",
  49                 "USB_PD", "USB_PD_DRP"
  50         };
  51         static char *status_text[] = {
  52                 "Unknown", "Charging", "Discharging", "Not charging", "Full"
  53         };
  54         static char *charge_type[] = {
  55                 "Unknown", "N/A", "Trickle", "Fast"
  56         };
  57         static char *health_text[] = {
  58                 "Unknown", "Good", "Overheat", "Dead", "Over voltage",
  59                 "Unspecified failure", "Cold", "Watchdog timer expire",
  60                 "Safety timer expire"
  61         };
  62         static char *technology_text[] = {
  63                 "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", "NiCd",
  64                 "LiMn"
  65         };
  66         static char *capacity_level_text[] = {
  67                 "Unknown", "Critical", "Low", "Normal", "High", "Full"
  68         };
  69         static char *scope_text[] = {
  70                 "Unknown", "System", "Device"
  71         };
  72         ssize_t ret = 0;
  73         struct power_supply *psy = dev_get_drvdata(dev);
  74         const ptrdiff_t off = attr - power_supply_attrs;
  75         union power_supply_propval value;
  76
  77         if (off == POWER_SUPPLY_PROP_TYPE) {
  78                 value.intval = psy->desc->type;
  79         } else {
  80                 ret = power_supply_get_property(psy, off, &value);
  81
  82                 if (ret < 0) {
  83                         if (ret == -ENODATA)
  84                                 dev_dbg(dev, "driver has no data for `%s' property\n",
  85                                         attr->attr.name);
  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);
  90                         return ret;
  91                 }
  92         }
  93
  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);
 110
 111         return sprintf(buf, "%d\n", value.intval);
 112 }
 113
 114 static ssize_t power_supply_store_property(struct device *dev,
 115                                            struct device_attribute *attr,
 116                                            const char *buf, size_t count) {
 117         ssize_t ret;
 118         struct power_supply *psy = dev_get_drvdata(dev);
 119         const ptrdiff_t off = attr - power_supply_attrs;
 120         union power_supply_propval value;
 121         long long_val;
 122
 123         /* TODO: support other types than int */
 124         ret = kstrtol(buf, 10, &long_val);
 125         if (ret < 0)
 126                 return ret;
 127
 128         value.intval = long_val;
 129
 130         ret = power_supply_set_property(psy, off, &value);
 131         if (ret < 0)
 132                 return ret;
 133
 134         return count;
 135 }
 136
 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),
 206 };
 207
 208 static struct attribute *
 209 __power_supply_attrs[ARRAY_SIZE(power_supply_attrs) + 1];
 210
 211 static umode_t power_supply_attr_is_visible(struct kobject *kobj,
 212                                            struct attribute *attr,
 213                                            int attrno)
 214 {
 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;
 218         int i;
 219
 220         if (attrno == POWER_SUPPLY_PROP_TYPE)
 221                 return mode;
 222
 223         for (i = 0; i < psy->desc->num_properties; i++) {
 224                 int property = psy->desc->properties[i];
 225
 226                 if (property == attrno) {
 227                         if (psy->desc->property_is_writeable &&
 228                             psy->desc->property_is_writeable(psy, property) > 0)
 229                                 mode |= S_IWUSR;
 230
 231                         return mode;
 232                 }
 233         }
 234
 235         return 0;
 236 }
 237
 238 static struct attribute_group power_supply_attr_group = {
 239         .attrs = __power_supply_attrs,
 240         .is_visible = power_supply_attr_is_visible,
 241 };
 242
 243 static const struct attribute_group *power_supply_attr_groups[] = {
 244         &power_supply_attr_group,
 245         NULL,
 246 };
 247
 248 void power_supply_init_attrs(struct device_type *dev_type)
 249 {
 250         int i;
 251
 252         dev_type->groups = power_supply_attr_groups;
 253
 254         for (i = 0; i < ARRAY_SIZE(power_supply_attrs); i++)
 255                 __power_supply_attrs[i] = &power_supply_attrs[i].attr;
 256 }
 257
 258 static char *kstruprdup(const char *str, gfp_t gfp)
 259 {
 260         char *ret, *ustr;
 261
 262         ustr = ret = kmalloc(strlen(str) + 1, gfp);
 263
 264         if (!ret)
 265                 return NULL;
 266
 267         while (*str)
 268                 *ustr++ = toupper(*str++);
 269
 270         *ustr = 0;
 271
 272         return ret;
 273 }
 274
 275 int power_supply_uevent(struct device *dev, struct kobj_uevent_env *env)
 276 {
 277         struct power_supply *psy = dev_get_drvdata(dev);
 278         int ret = 0, j;
 279         char *prop_buf;
 280         char *attrname;
 281
 282         if (!psy || !psy->desc) {
 283                 dev_dbg(dev, "No power supply yet\n");
 284                 return ret;
 285         }
 286
 287         ret = add_uevent_var(env, "POWER_SUPPLY_NAME=%s", psy->desc->name);
 288         if (ret)
 289                 return ret;
 290
 291         prop_buf = (char *)get_zeroed_page(GFP_KERNEL);
 292         if (!prop_buf)
 293                 return -ENOMEM;
 294
 295         for (j = 0; j < psy->desc->num_properties; j++) {
 296                 struct device_attribute *attr;
 297                 char *line;
 298
 299                 attr = &power_supply_attrs[psy->desc->properties[j]];
 300
 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 */
 305                         ret = 0;
 306                         continue;
 307                 }
 308
 309                 if (ret < 0)
 310                         goto out;
 311
 312                 line = strchr(prop_buf, '\n');
 313                 if (line)
 314                         *line = 0;
 315
 316                 attrname = kstruprdup(attr->attr.name, GFP_KERNEL);
 317                 if (!attrname) {
 318                         ret = -ENOMEM;
 319                         goto out;
 320                 }
 321
 322                 ret = add_uevent_var(env, "POWER_SUPPLY_%s=%s", attrname, prop_buf);
 323                 kfree(attrname);
 324                 if (ret)
 325                         goto out;
 326         }
 327
 328 out:
 329         free_page((unsigned long)prop_buf);
 330
 331         return ret;
 332 }