drivers/power/supply/power_supply_core.c

   1 /*
   2  *  Universal power supply monitor class
   3  *
   4  *  Copyright © 2007  Anton Vorontsov <cbou@mail.ru>
   5  *  Copyright © 2004  Szabolcs Gyurko
   6  *  Copyright © 2003  Ian Molton <spyro@f2s.com>
   7  *
   8  *  Modified: 2004, Oct     Szabolcs Gyurko
   9  *
  10  *  You may use this code as per GPL version 2
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/types.h>
  15 #include <linux/init.h>
  16 #include <linux/slab.h>
  17 #include <linux/delay.h>
  18 #include <linux/device.h>
  19 #include <linux/notifier.h>
  20 #include <linux/err.h>
  21 #include <linux/of.h>
  22 #include <linux/power_supply.h>
  23 #include <linux/property.h>
  24 #include <linux/thermal.h>
  25 #include "power_supply.h"
  26
  27 /* exported for the APM Power driver, APM emulation */
  28 struct class *power_supply_class;
  29 EXPORT_SYMBOL_GPL(power_supply_class);
  30
  31 ATOMIC_NOTIFIER_HEAD(power_supply_notifier);
  32 EXPORT_SYMBOL_GPL(power_supply_notifier);
  33
  34 static struct device_type power_supply_dev_type;
  35
  36 #define POWER_SUPPLY_DEFERRED_REGISTER_TIME     msecs_to_jiffies(10)
  37
  38 static bool __power_supply_is_supplied_by(struct power_supply *supplier,
  39                                          struct power_supply *supply)
  40 {
  41         int i;
  42
  43         if (!supply->supplied_from && !supplier->supplied_to)
  44                 return false;
  45
  46         /* Support both supplied_to and supplied_from modes */
  47         if (supply->supplied_from) {
  48                 if (!supplier->desc->name)
  49                         return false;
  50                 for (i = 0; i < supply->num_supplies; i++)
  51                         if (!strcmp(supplier->desc->name, supply->supplied_from[i]))
  52                                 return true;
  53         } else {
  54                 if (!supply->desc->name)
  55                         return false;
  56                 for (i = 0; i < supplier->num_supplicants; i++)
  57                         if (!strcmp(supplier->supplied_to[i], supply->desc->name))
  58                                 return true;
  59         }
  60
  61         return false;
  62 }
  63
  64 static int __power_supply_changed_work(struct device *dev, void *data)
  65 {
  66         struct power_supply *psy = data;
  67         struct power_supply *pst = dev_get_drvdata(dev);
  68
  69         if (__power_supply_is_supplied_by(psy, pst)) {
  70                 if (pst->desc->external_power_changed)
  71                         pst->desc->external_power_changed(pst);
  72         }
  73
  74         return 0;
  75 }
  76
  77 static void power_supply_changed_work(struct work_struct *work)
  78 {
  79         unsigned long flags;
  80         struct power_supply *psy = container_of(work, struct power_supply,
  81                                                 changed_work);
  82
  83         dev_dbg(&psy->dev, "%s\n", __func__);
  84
  85         spin_lock_irqsave(&psy->changed_lock, flags);
  86         /*
  87          * Check 'changed' here to avoid issues due to race between
  88          * power_supply_changed() and this routine. In worst case
  89          * power_supply_changed() can be called again just before we take above
  90          * lock. During the first call of this routine we will mark 'changed' as
  91          * false and it will stay false for the next call as well.
  92          */
  93         if (likely(psy->changed)) {
  94                 psy->changed = false;
  95                 spin_unlock_irqrestore(&psy->changed_lock, flags);
  96                 class_for_each_device(power_supply_class, NULL, psy,
  97                                       __power_supply_changed_work);
  98                 power_supply_update_leds(psy);
  99                 atomic_notifier_call_chain(&power_supply_notifier,
 100                                 PSY_EVENT_PROP_CHANGED, psy);
 101                 kobject_uevent(&psy->dev.kobj, KOBJ_CHANGE);
 102                 spin_lock_irqsave(&psy->changed_lock, flags);
 103         }
 104
 105         /*
 106          * Hold the wakeup_source until all events are processed.
 107          * power_supply_changed() might have called again and have set 'changed'
 108          * to true.
 109          */
 110         if (likely(!psy->changed))
 111                 pm_relax(&psy->dev);
 112         spin_unlock_irqrestore(&psy->changed_lock, flags);
 113 }
 114
 115 void power_supply_changed(struct power_supply *psy)
 116 {
 117         unsigned long flags;
 118
 119         dev_dbg(&psy->dev, "%s\n", __func__);
 120
 121         spin_lock_irqsave(&psy->changed_lock, flags);
 122         psy->changed = true;
 123         pm_stay_awake(&psy->dev);
 124         spin_unlock_irqrestore(&psy->changed_lock, flags);
 125         schedule_work(&psy->changed_work);
 126 }
 127 EXPORT_SYMBOL_GPL(power_supply_changed);
 128
 129 /*
 130  * Notify that power supply was registered after parent finished the probing.
 131  *
 132  * Often power supply is registered from driver's probe function. However
 133  * calling power_supply_changed() directly from power_supply_register()
 134  * would lead to execution of get_property() function provided by the driver
 135  * too early - before the probe ends.
 136  *
 137  * Avoid that by waiting on parent's mutex.
 138  */
 139 static void power_supply_deferred_register_work(struct work_struct *work)
 140 {
 141         struct power_supply *psy = container_of(work, struct power_supply,
 142                                                 deferred_register_work.work);
 143
 144         if (psy->dev.parent) {
 145                 while (!mutex_trylock(&psy->dev.parent->mutex)) {
 146                         if (psy->removing)
 147                                 return;
 148                         msleep(10);
 149                 }
 150         }
 151
 152         power_supply_changed(psy);
 153
 154         if (psy->dev.parent)
 155                 mutex_unlock(&psy->dev.parent->mutex);
 156 }
 157
 158 #ifdef CONFIG_OF
 159 #include <linux/of.h>
 160
 161 static int __power_supply_populate_supplied_from(struct device *dev,
 162                                                  void *data)
 163 {
 164         struct power_supply *psy = data;
 165         struct power_supply *epsy = dev_get_drvdata(dev);
 166         struct device_node *np;
 167         int i = 0;
 168
 169         do {
 170                 np = of_parse_phandle(psy->of_node, "power-supplies", i++);
 171                 if (!np)
 172                         break;
 173
 174                 if (np == epsy->of_node) {
 175                         dev_info(&psy->dev, "%s: Found supply : %s\n",
 176                                 psy->desc->name, epsy->desc->name);
 177                         psy->supplied_from[i-1] = (char *)epsy->desc->name;
 178                         psy->num_supplies++;
 179                         of_node_put(np);
 180                         break;
 181                 }
 182                 of_node_put(np);
 183         } while (np);
 184
 185         return 0;
 186 }
 187
 188 static int power_supply_populate_supplied_from(struct power_supply *psy)
 189 {
 190         int error;
 191
 192         error = class_for_each_device(power_supply_class, NULL, psy,
 193                                       __power_supply_populate_supplied_from);
 194
 195         dev_dbg(&psy->dev, "%s %d\n", __func__, error);
 196
 197         return error;
 198 }
 199
 200 static int  __power_supply_find_supply_from_node(struct device *dev,
 201                                                  void *data)
 202 {
 203         struct device_node *np = data;
 204         struct power_supply *epsy = dev_get_drvdata(dev);
 205
 206         /* returning non-zero breaks out of class_for_each_device loop */
 207         if (epsy->of_node == np)
 208                 return 1;
 209
 210         return 0;
 211 }
 212
 213 static int power_supply_find_supply_from_node(struct device_node *supply_node)
 214 {
 215         int error;
 216
 217         /*
 218          * class_for_each_device() either returns its own errors or values
 219          * returned by __power_supply_find_supply_from_node().
 220          *
 221          * __power_supply_find_supply_from_node() will return 0 (no match)
 222          * or 1 (match).
 223          *
 224          * We return 0 if class_for_each_device() returned 1, -EPROBE_DEFER if
 225          * it returned 0, or error as returned by it.
 226          */
 227         error = class_for_each_device(power_supply_class, NULL, supply_node,
 228                                        __power_supply_find_supply_from_node);
 229
 230         return error ? (error == 1 ? 0 : error) : -EPROBE_DEFER;
 231 }
 232
 233 static int power_supply_check_supplies(struct power_supply *psy)
 234 {
 235         struct device_node *np;
 236         int cnt = 0;
 237
 238         /* If there is already a list honor it */
 239         if (psy->supplied_from && psy->num_supplies > 0)
 240                 return 0;
 241
 242         /* No device node found, nothing to do */
 243         if (!psy->of_node)
 244                 return 0;
 245
 246         do {
 247                 int ret;
 248
 249                 np = of_parse_phandle(psy->of_node, "power-supplies", cnt++);
 250                 if (!np)
 251                         break;
 252
 253                 ret = power_supply_find_supply_from_node(np);
 254                 of_node_put(np);
 255
 256                 if (ret) {
 257                         dev_dbg(&psy->dev, "Failed to find supply!\n");
 258                         return ret;
 259                 }
 260         } while (np);
 261
 262         /* Missing valid "power-supplies" entries */
 263         if (cnt == 1)
 264                 return 0;
 265
 266         /* All supplies found, allocate char ** array for filling */
 267         psy->supplied_from = devm_kzalloc(&psy->dev, sizeof(psy->supplied_from),
 268                                           GFP_KERNEL);
 269         if (!psy->supplied_from)
 270                 return -ENOMEM;
 271
 272         *psy->supplied_from = devm_kcalloc(&psy->dev,
 273                                            cnt - 1, sizeof(char *),
 274                                            GFP_KERNEL);
 275         if (!*psy->supplied_from)
 276                 return -ENOMEM;
 277
 278         return power_supply_populate_supplied_from(psy);
 279 }
 280 #else
 281 static int power_supply_check_supplies(struct power_supply *psy)
 282 {
 283         int nval, ret;
 284
 285         if (!psy->dev.parent)
 286                 return 0;
 287
 288         nval = device_property_read_string_array(psy->dev.parent,
 289                                                  "supplied-from", NULL, 0);
 290         if (nval <= 0)
 291                 return 0;
 292
 293         psy->supplied_from = devm_kmalloc_array(&psy->dev, nval,
 294                                                 sizeof(char *), GFP_KERNEL);
 295         if (!psy->supplied_from)
 296                 return -ENOMEM;
 297
 298         ret = device_property_read_string_array(psy->dev.parent,
 299                 "supplied-from", (const char **)psy->supplied_from, nval);
 300         if (ret < 0)
 301                 return ret;
 302
 303         psy->num_supplies = nval;
 304
 305         return 0;
 306 }
 307 #endif
 308
 309 struct psy_am_i_supplied_data {
 310         struct power_supply *psy;
 311         unsigned int count;
 312 };
 313
 314 static int __power_supply_am_i_supplied(struct device *dev, void *_data)
 315 {
 316         union power_supply_propval ret = {0,};
 317         struct power_supply *epsy = dev_get_drvdata(dev);
 318         struct psy_am_i_supplied_data *data = _data;
 319
 320         if (__power_supply_is_supplied_by(epsy, data->psy)) {
 321                 data->count++;
 322                 if (!epsy->desc->get_property(epsy, POWER_SUPPLY_PROP_ONLINE,
 323                                         &ret))
 324                         return ret.intval;
 325         }
 326
 327         return 0;
 328 }
 329
 330 int power_supply_am_i_supplied(struct power_supply *psy)
 331 {
 332         struct psy_am_i_supplied_data data = { psy, 0 };
 333         int error;
 334
 335         error = class_for_each_device(power_supply_class, NULL, &data,
 336                                       __power_supply_am_i_supplied);
 337
 338         dev_dbg(&psy->dev, "%s count %u err %d\n", __func__, data.count, error);
 339
 340         if (data.count == 0)
 341                 return -ENODEV;
 342
 343         return error;
 344 }
 345 EXPORT_SYMBOL_GPL(power_supply_am_i_supplied);
 346
 347 static int __power_supply_is_system_supplied(struct device *dev, void *data)
 348 {
 349         union power_supply_propval ret = {0,};
 350         struct power_supply *psy = dev_get_drvdata(dev);
 351         unsigned int *count = data;
 352
 353         (*count)++;
 354         if (psy->desc->type != POWER_SUPPLY_TYPE_BATTERY)
 355                 if (!psy->desc->get_property(psy, POWER_SUPPLY_PROP_ONLINE,
 356                                         &ret))
 357                         return ret.intval;
 358
 359         return 0;
 360 }
 361
 362 int power_supply_is_system_supplied(void)
 363 {
 364         int error;
 365         unsigned int count = 0;
 366
 367         error = class_for_each_device(power_supply_class, NULL, &count,
 368                                       __power_supply_is_system_supplied);
 369
 370         /*
 371          * If no power class device was found at all, most probably we are
 372          * running on a desktop system, so assume we are on mains power.
 373          */
 374         if (count == 0)
 375                 return 1;
 376
 377         return error;
 378 }
 379 EXPORT_SYMBOL_GPL(power_supply_is_system_supplied);
 380
 381 static int __power_supply_get_supplier_max_current(struct device *dev,
 382                                                    void *data)
 383 {
 384         union power_supply_propval ret = {0,};
 385         struct power_supply *epsy = dev_get_drvdata(dev);
 386         struct power_supply *psy = data;
 387
 388         if (__power_supply_is_supplied_by(epsy, psy))
 389                 if (!epsy->desc->get_property(epsy,
 390                                               POWER_SUPPLY_PROP_CURRENT_MAX,
 391                                               &ret))
 392                         return ret.intval;
 393
 394         return 0;
 395 }
 396
 397 int power_supply_set_input_current_limit_from_supplier(struct power_supply *psy)
 398 {
 399         union power_supply_propval val = {0,};
 400         int curr;
 401
 402         if (!psy->desc->set_property)
 403                 return -EINVAL;
 404
 405         /*
 406          * This function is not intended for use with a supply with multiple
 407          * suppliers, we simply pick the first supply to report a non 0
 408          * max-current.
 409          */
 410         curr = class_for_each_device(power_supply_class, NULL, psy,
 411                                       __power_supply_get_supplier_max_current);
 412         if (curr <= 0)
 413                 return (curr == 0) ? -ENODEV : curr;
 414
 415         val.intval = curr;
 416
 417         return psy->desc->set_property(psy,
 418                                 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT, &val);
 419 }
 420 EXPORT_SYMBOL_GPL(power_supply_set_input_current_limit_from_supplier);
 421
 422 int power_supply_set_battery_charged(struct power_supply *psy)
 423 {
 424         if (atomic_read(&psy->use_cnt) >= 0 &&
 425                         psy->desc->type == POWER_SUPPLY_TYPE_BATTERY &&
 426                         psy->desc->set_charged) {
 427                 psy->desc->set_charged(psy);
 428                 return 0;
 429         }
 430
 431         return -EINVAL;
 432 }
 433 EXPORT_SYMBOL_GPL(power_supply_set_battery_charged);
 434
 435 static int power_supply_match_device_by_name(struct device *dev, const void *data)
 436 {
 437         const char *name = data;
 438         struct power_supply *psy = dev_get_drvdata(dev);
 439
 440         return strcmp(psy->desc->name, name) == 0;
 441 }
 442
 443 /**
 444  * power_supply_get_by_name() - Search for a power supply and returns its ref
 445  * @name: Power supply name to fetch
 446  *
 447  * If power supply was found, it increases reference count for the
 448  * internal power supply's device. The user should power_supply_put()
 449  * after usage.
 450  *
 451  * Return: On success returns a reference to a power supply with
 452  * matching name equals to @name, a NULL otherwise.
 453  */
 454 struct power_supply *power_supply_get_by_name(const char *name)
 455 {
 456         struct power_supply *psy = NULL;
 457         struct device *dev = class_find_device(power_supply_class, NULL, name,
 458                                         power_supply_match_device_by_name);
 459
 460         if (dev) {
 461                 psy = dev_get_drvdata(dev);
 462                 atomic_inc(&psy->use_cnt);
 463         }
 464
 465         return psy;
 466 }
 467 EXPORT_SYMBOL_GPL(power_supply_get_by_name);
 468
 469 /**
 470  * power_supply_put() - Drop reference obtained with power_supply_get_by_name
 471  * @psy: Reference to put
 472  *
 473  * The reference to power supply should be put before unregistering
 474  * the power supply.
 475  */
 476 void power_supply_put(struct power_supply *psy)
 477 {
 478         might_sleep();
 479
 480         atomic_dec(&psy->use_cnt);
 481         put_device(&psy->dev);
 482 }
 483 EXPORT_SYMBOL_GPL(power_supply_put);
 484
 485 #ifdef CONFIG_OF
 486 static int power_supply_match_device_node(struct device *dev, const void *data)
 487 {
 488         return dev->parent && dev->parent->of_node == data;
 489 }
 490
 491 /**
 492  * power_supply_get_by_phandle() - Search for a power supply and returns its ref
 493  * @np: Pointer to device node holding phandle property
 494  * @property: Name of property holding a power supply name
 495  *
 496  * If power supply was found, it increases reference count for the
 497  * internal power supply's device. The user should power_supply_put()
 498  * after usage.
 499  *
 500  * Return: On success returns a reference to a power supply with
 501  * matching name equals to value under @property, NULL or ERR_PTR otherwise.
 502  */
 503 struct power_supply *power_supply_get_by_phandle(struct device_node *np,
 504                                                         const char *property)
 505 {
 506         struct device_node *power_supply_np;
 507         struct power_supply *psy = NULL;
 508         struct device *dev;
 509
 510         power_supply_np = of_parse_phandle(np, property, 0);
 511         if (!power_supply_np)
 512                 return ERR_PTR(-ENODEV);
 513
 514         dev = class_find_device(power_supply_class, NULL, power_supply_np,
 515                                                 power_supply_match_device_node);
 516
 517         of_node_put(power_supply_np);
 518
 519         if (dev) {
 520                 psy = dev_get_drvdata(dev);
 521                 atomic_inc(&psy->use_cnt);
 522         }
 523
 524         return psy;
 525 }
 526 EXPORT_SYMBOL_GPL(power_supply_get_by_phandle);
 527
 528 static void devm_power_supply_put(struct device *dev, void *res)
 529 {
 530         struct power_supply **psy = res;
 531
 532         power_supply_put(*psy);
 533 }
 534
 535 /**
 536  * devm_power_supply_get_by_phandle() - Resource managed version of
 537  *  power_supply_get_by_phandle()
 538  * @dev: Pointer to device holding phandle property
 539  * @property: Name of property holding a power supply phandle
 540  *
 541  * Return: On success returns a reference to a power supply with
 542  * matching name equals to value under @property, NULL or ERR_PTR otherwise.
 543  */
 544 struct power_supply *devm_power_supply_get_by_phandle(struct device *dev,
 545                                                       const char *property)
 546 {
 547         struct power_supply **ptr, *psy;
 548
 549         if (!dev->of_node)
 550                 return ERR_PTR(-ENODEV);
 551
 552         ptr = devres_alloc(devm_power_supply_put, sizeof(*ptr), GFP_KERNEL);
 553         if (!ptr)
 554                 return ERR_PTR(-ENOMEM);
 555
 556         psy = power_supply_get_by_phandle(dev->of_node, property);
 557         if (IS_ERR_OR_NULL(psy)) {
 558                 devres_free(ptr);
 559         } else {
 560                 *ptr = psy;
 561                 devres_add(dev, ptr);
 562         }
 563         return psy;
 564 }
 565 EXPORT_SYMBOL_GPL(devm_power_supply_get_by_phandle);
 566 #endif /* CONFIG_OF */
 567
 568 int power_supply_get_battery_info(struct power_supply *psy,
 569                                   struct power_supply_battery_info *info)
 570 {
 571         struct device_node *battery_np;
 572         const char *value;
 573         int err, len, index;
 574
 575         info->energy_full_design_uwh         = -EINVAL;
 576         info->charge_full_design_uah         = -EINVAL;
 577         info->voltage_min_design_uv          = -EINVAL;
 578         info->precharge_current_ua           = -EINVAL;
 579         info->charge_term_current_ua         = -EINVAL;
 580         info->constant_charge_current_max_ua = -EINVAL;
 581         info->constant_charge_voltage_max_uv = -EINVAL;
 582         info->factory_internal_resistance_uohm  = -EINVAL;
 583
 584         for (index = 0; index < POWER_SUPPLY_OCV_TEMP_MAX; index++) {
 585                 info->ocv_table[index]       = NULL;
 586                 info->ocv_temp[index]        = -EINVAL;
 587                 info->ocv_table_size[index]  = -EINVAL;
 588         }
 589
 590         if (!psy->of_node) {
 591                 dev_warn(&psy->dev, "%s currently only supports devicetree\n",
 592                          __func__);
 593                 return -ENXIO;
 594         }
 595
 596         battery_np = of_parse_phandle(psy->of_node, "monitored-battery", 0);
 597         if (!battery_np)
 598                 return -ENODEV;
 599
 600         err = of_property_read_string(battery_np, "compatible", &value);
 601         if (err)
 602                 return err;
 603
 604         if (strcmp("simple-battery", value))
 605                 return -ENODEV;
 606
 607         /* The property and field names below must correspond to elements
 608          * in enum power_supply_property. For reasoning, see
 609          * Documentation/power/power_supply_class.txt.
 610          */
 611
 612         of_property_read_u32(battery_np, "energy-full-design-microwatt-hours",
 613                              &info->energy_full_design_uwh);
 614         of_property_read_u32(battery_np, "charge-full-design-microamp-hours",
 615                              &info->charge_full_design_uah);
 616         of_property_read_u32(battery_np, "voltage-min-design-microvolt",
 617                              &info->voltage_min_design_uv);
 618         of_property_read_u32(battery_np, "precharge-current-microamp",
 619                              &info->precharge_current_ua);
 620         of_property_read_u32(battery_np, "charge-term-current-microamp",
 621                              &info->charge_term_current_ua);
 622         of_property_read_u32(battery_np, "constant_charge_current_max_microamp",
 623                              &info->constant_charge_current_max_ua);
 624         of_property_read_u32(battery_np, "constant_charge_voltage_max_microvolt",
 625                              &info->constant_charge_voltage_max_uv);
 626         of_property_read_u32(battery_np, "factory-internal-resistance-micro-ohms",
 627                              &info->factory_internal_resistance_uohm);
 628
 629         len = of_property_count_u32_elems(battery_np, "ocv-capacity-celsius");
 630         if (len < 0 && len != -EINVAL) {
 631                 return len;
 632         } else if (len > POWER_SUPPLY_OCV_TEMP_MAX) {
 633                 dev_err(&psy->dev, "Too many temperature values\n");
 634                 return -EINVAL;
 635         } else if (len > 0) {
 636                 of_property_read_u32_array(battery_np, "ocv-capacity-celsius",
 637                                            info->ocv_temp, len);
 638         }
 639
 640         for (index = 0; index < len; index++) {
 641                 struct power_supply_battery_ocv_table *table;
 642                 char *propname;
 643                 const __be32 *list;
 644                 int i, tab_len, size;
 645
 646                 propname = kasprintf(GFP_KERNEL, "ocv-capacity-table-%d", index);
 647                 list = of_get_property(battery_np, propname, &size);
 648                 if (!list || !size) {
 649                         dev_err(&psy->dev, "failed to get %s\n", propname);
 650                         kfree(propname);
 651                         power_supply_put_battery_info(psy, info);
 652                         return -EINVAL;
 653                 }
 654
 655                 kfree(propname);
 656                 tab_len = size / (2 * sizeof(__be32));
 657                 info->ocv_table_size[index] = tab_len;
 658
 659                 table = info->ocv_table[index] =
 660                         devm_kcalloc(&psy->dev, tab_len, sizeof(*table), GFP_KERNEL);
 661                 if (!info->ocv_table[index]) {
 662                         power_supply_put_battery_info(psy, info);
 663                         return -ENOMEM;
 664                 }
 665
 666                 for (i = 0; i < tab_len; i++) {
 667                         table[i].ocv = be32_to_cpu(*list++);
 668                         table[i].capacity = be32_to_cpu(*list++);
 669                 }
 670         }
 671
 672         return 0;
 673 }
 674 EXPORT_SYMBOL_GPL(power_supply_get_battery_info);
 675
 676 void power_supply_put_battery_info(struct power_supply *psy,
 677                                    struct power_supply_battery_info *info)
 678 {
 679         int i;
 680
 681         for (i = 0; i < POWER_SUPPLY_OCV_TEMP_MAX; i++) {
 682                 if (info->ocv_table[i])
 683                         devm_kfree(&psy->dev, info->ocv_table[i]);
 684         }
 685 }
 686 EXPORT_SYMBOL_GPL(power_supply_put_battery_info);
 687
 688 /**
 689  * power_supply_ocv2cap_simple() - find the battery capacity
 690  * @table: Pointer to battery OCV lookup table
 691  * @table_len: OCV table length
 692  * @ocv: Current OCV value
 693  *
 694  * This helper function is used to look up battery capacity according to
 695  * current OCV value from one OCV table, and the OCV table must be ordered
 696  * descending.
 697  *
 698  * Return: the battery capacity.
 699  */
 700 int power_supply_ocv2cap_simple(struct power_supply_battery_ocv_table *table,
 701                                 int table_len, int ocv)
 702 {
 703         int i, cap, tmp;
 704
 705         for (i = 0; i < table_len; i++)
 706                 if (ocv > table[i].ocv)
 707                         break;
 708
 709         if (i > 0 && i < table_len) {
 710                 tmp = (table[i - 1].capacity - table[i].capacity) *
 711                         (ocv - table[i].ocv);
 712                 tmp /= table[i - 1].ocv - table[i].ocv;
 713                 cap = tmp + table[i].capacity;
 714         } else if (i == 0) {
 715                 cap = table[0].capacity;
 716         } else {
 717                 cap = table[table_len - 1].capacity;
 718         }
 719
 720         return cap;
 721 }
 722 EXPORT_SYMBOL_GPL(power_supply_ocv2cap_simple);
 723
 724 struct power_supply_battery_ocv_table *
 725 power_supply_find_ocv2cap_table(struct power_supply_battery_info *info,
 726                                 int temp, int *table_len)
 727 {
 728         int best_temp_diff = INT_MAX, temp_diff;
 729         u8 i, best_index = 0;
 730
 731         if (!info->ocv_table[0])
 732                 return NULL;
 733
 734         for (i = 0; i < POWER_SUPPLY_OCV_TEMP_MAX; i++) {
 735                 temp_diff = abs(info->ocv_temp[i] - temp);
 736
 737                 if (temp_diff < best_temp_diff) {
 738                         best_temp_diff = temp_diff;
 739                         best_index = i;
 740                 }
 741         }
 742
 743         *table_len = info->ocv_table_size[best_index];
 744         return info->ocv_table[best_index];
 745 }
 746 EXPORT_SYMBOL_GPL(power_supply_find_ocv2cap_table);
 747
 748 int power_supply_batinfo_ocv2cap(struct power_supply_battery_info *info,
 749                                  int ocv, int temp)
 750 {
 751         struct power_supply_battery_ocv_table *table;
 752         int table_len;
 753
 754         table = power_supply_find_ocv2cap_table(info, temp, &table_len);
 755         if (!table)
 756                 return -EINVAL;
 757
 758         return power_supply_ocv2cap_simple(table, table_len, ocv);
 759 }
 760 EXPORT_SYMBOL_GPL(power_supply_batinfo_ocv2cap);
 761
 762 int power_supply_get_property(struct power_supply *psy,
 763                             enum power_supply_property psp,
 764                             union power_supply_propval *val)
 765 {
 766         if (atomic_read(&psy->use_cnt) <= 0) {
 767                 if (!psy->initialized)
 768                         return -EAGAIN;
 769                 return -ENODEV;
 770         }
 771
 772         return psy->desc->get_property(psy, psp, val);
 773 }
 774 EXPORT_SYMBOL_GPL(power_supply_get_property);
 775
 776 int power_supply_set_property(struct power_supply *psy,
 777                             enum power_supply_property psp,
 778                             const union power_supply_propval *val)
 779 {
 780         if (atomic_read(&psy->use_cnt) <= 0 || !psy->desc->set_property)
 781                 return -ENODEV;
 782
 783         return psy->desc->set_property(psy, psp, val);
 784 }
 785 EXPORT_SYMBOL_GPL(power_supply_set_property);
 786
 787 int power_supply_property_is_writeable(struct power_supply *psy,
 788                                         enum power_supply_property psp)
 789 {
 790         if (atomic_read(&psy->use_cnt) <= 0 ||
 791                         !psy->desc->property_is_writeable)
 792                 return -ENODEV;
 793
 794         return psy->desc->property_is_writeable(psy, psp);
 795 }
 796 EXPORT_SYMBOL_GPL(power_supply_property_is_writeable);
 797
 798 void power_supply_external_power_changed(struct power_supply *psy)
 799 {
 800         if (atomic_read(&psy->use_cnt) <= 0 ||
 801                         !psy->desc->external_power_changed)
 802                 return;
 803
 804         psy->desc->external_power_changed(psy);
 805 }
 806 EXPORT_SYMBOL_GPL(power_supply_external_power_changed);
 807
 808 int power_supply_powers(struct power_supply *psy, struct device *dev)
 809 {
 810         return sysfs_create_link(&psy->dev.kobj, &dev->kobj, "powers");
 811 }
 812 EXPORT_SYMBOL_GPL(power_supply_powers);
 813
 814 static void power_supply_dev_release(struct device *dev)
 815 {
 816         struct power_supply *psy = to_power_supply(dev);
 817         dev_dbg(dev, "%s\n", __func__);
 818         kfree(psy);
 819 }
 820
 821 int power_supply_reg_notifier(struct notifier_block *nb)
 822 {
 823         return atomic_notifier_chain_register(&power_supply_notifier, nb);
 824 }
 825 EXPORT_SYMBOL_GPL(power_supply_reg_notifier);
 826
 827 void power_supply_unreg_notifier(struct notifier_block *nb)
 828 {
 829         atomic_notifier_chain_unregister(&power_supply_notifier, nb);
 830 }
 831 EXPORT_SYMBOL_GPL(power_supply_unreg_notifier);
 832
 833 #ifdef CONFIG_THERMAL
 834 static int power_supply_read_temp(struct thermal_zone_device *tzd,
 835                 int *temp)
 836 {
 837         struct power_supply *psy;
 838         union power_supply_propval val;
 839         int ret;
 840
 841         WARN_ON(tzd == NULL);
 842         psy = tzd->devdata;
 843         ret = power_supply_get_property(psy, POWER_SUPPLY_PROP_TEMP, &val);
 844         if (ret)
 845                 return ret;
 846
 847         /* Convert tenths of degree Celsius to milli degree Celsius. */
 848         *temp = val.intval * 100;
 849
 850         return ret;
 851 }
 852
 853 static struct thermal_zone_device_ops psy_tzd_ops = {
 854         .get_temp = power_supply_read_temp,
 855 };
 856
 857 static int psy_register_thermal(struct power_supply *psy)
 858 {
 859         int i;
 860
 861         if (psy->desc->no_thermal)
 862                 return 0;
 863
 864         /* Register battery zone device psy reports temperature */
 865         for (i = 0; i < psy->desc->num_properties; i++) {
 866                 if (psy->desc->properties[i] == POWER_SUPPLY_PROP_TEMP) {
 867                         psy->tzd = thermal_zone_device_register(psy->desc->name,
 868                                         0, 0, psy, &psy_tzd_ops, NULL, 0, 0);
 869                         return PTR_ERR_OR_ZERO(psy->tzd);
 870                 }
 871         }
 872         return 0;
 873 }
 874
 875 static void psy_unregister_thermal(struct power_supply *psy)
 876 {
 877         if (IS_ERR_OR_NULL(psy->tzd))
 878                 return;
 879         thermal_zone_device_unregister(psy->tzd);
 880 }
 881
 882 /* thermal cooling device callbacks */
 883 static int ps_get_max_charge_cntl_limit(struct thermal_cooling_device *tcd,
 884                                         unsigned long *state)
 885 {
 886         struct power_supply *psy;
 887         union power_supply_propval val;
 888         int ret;
 889
 890         psy = tcd->devdata;
 891         ret = power_supply_get_property(psy,
 892                         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX, &val);
 893         if (ret)
 894                 return ret;
 895
 896         *state = val.intval;
 897
 898         return ret;
 899 }
 900
 901 static int ps_get_cur_chrage_cntl_limit(struct thermal_cooling_device *tcd,
 902                                         unsigned long *state)
 903 {
 904         struct power_supply *psy;
 905         union power_supply_propval val;
 906         int ret;
 907
 908         psy = tcd->devdata;
 909         ret = power_supply_get_property(psy,
 910                         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT, &val);
 911         if (ret)
 912                 return ret;
 913
 914         *state = val.intval;
 915
 916         return ret;
 917 }
 918
 919 static int ps_set_cur_charge_cntl_limit(struct thermal_cooling_device *tcd,
 920                                         unsigned long state)
 921 {
 922         struct power_supply *psy;
 923         union power_supply_propval val;
 924         int ret;
 925
 926         psy = tcd->devdata;
 927         val.intval = state;
 928         ret = psy->desc->set_property(psy,
 929                 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT, &val);
 930
 931         return ret;
 932 }
 933
 934 static const struct thermal_cooling_device_ops psy_tcd_ops = {
 935         .get_max_state = ps_get_max_charge_cntl_limit,
 936         .get_cur_state = ps_get_cur_chrage_cntl_limit,
 937         .set_cur_state = ps_set_cur_charge_cntl_limit,
 938 };
 939
 940 static int psy_register_cooler(struct power_supply *psy)
 941 {
 942         int i;
 943
 944         /* Register for cooling device if psy can control charging */
 945         for (i = 0; i < psy->desc->num_properties; i++) {
 946                 if (psy->desc->properties[i] ==
 947                                 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT) {
 948                         psy->tcd = thermal_cooling_device_register(
 949                                                         (char *)psy->desc->name,
 950                                                         psy, &psy_tcd_ops);
 951                         return PTR_ERR_OR_ZERO(psy->tcd);
 952                 }
 953         }
 954         return 0;
 955 }
 956
 957 static void psy_unregister_cooler(struct power_supply *psy)
 958 {
 959         if (IS_ERR_OR_NULL(psy->tcd))
 960                 return;
 961         thermal_cooling_device_unregister(psy->tcd);
 962 }
 963 #else
 964 static int psy_register_thermal(struct power_supply *psy)
 965 {
 966         return 0;
 967 }
 968
 969 static void psy_unregister_thermal(struct power_supply *psy)
 970 {
 971 }
 972
 973 static int psy_register_cooler(struct power_supply *psy)
 974 {
 975         return 0;
 976 }
 977
 978 static void psy_unregister_cooler(struct power_supply *psy)
 979 {
 980 }
 981 #endif
 982
 983 static struct power_supply *__must_check
 984 __power_supply_register(struct device *parent,
 985                                    const struct power_supply_desc *desc,
 986                                    const struct power_supply_config *cfg,
 987                                    bool ws)
 988 {
 989         struct device *dev;
 990         struct power_supply *psy;
 991         int i, rc;
 992
 993         if (!parent)
 994                 pr_warn("%s: Expected proper parent device for '%s'\n",
 995                         __func__, desc->name);
 996
 997         if (!desc || !desc->name || !desc->properties || !desc->num_properties)
 998                 return ERR_PTR(-EINVAL);
 999
1000         for (i = 0; i < desc->num_properties; ++i) {
1001                 if ((desc->properties[i] == POWER_SUPPLY_PROP_USB_TYPE) &&
1002                     (!desc->usb_types || !desc->num_usb_types))
1003                         return ERR_PTR(-EINVAL);
1004         }
1005
1006         psy = kzalloc(sizeof(*psy), GFP_KERNEL);
1007         if (!psy)
1008                 return ERR_PTR(-ENOMEM);
1009
1010         dev = &psy->dev;
1011
1012         device_initialize(dev);
1013
1014         dev->class = power_supply_class;
1015         dev->type = &power_supply_dev_type;
1016         dev->parent = parent;
1017         dev->release = power_supply_dev_release;
1018         dev_set_drvdata(dev, psy);
1019         psy->desc = desc;
1020         if (cfg) {
1021                 dev->groups = cfg->attr_grp;
1022                 psy->drv_data = cfg->drv_data;
1023                 psy->of_node =
1024                         cfg->fwnode ? to_of_node(cfg->fwnode) : cfg->of_node;
1025                 psy->supplied_to = cfg->supplied_to;
1026                 psy->num_supplicants = cfg->num_supplicants;
1027         }
1028
1029         rc = dev_set_name(dev, "%s", desc->name);
1030         if (rc)
1031                 goto dev_set_name_failed;
1032
1033         INIT_WORK(&psy->changed_work, power_supply_changed_work);
1034         INIT_DELAYED_WORK(&psy->deferred_register_work,
1035                           power_supply_deferred_register_work);
1036
1037         rc = power_supply_check_supplies(psy);
1038         if (rc) {
1039                 dev_info(dev, "Not all required supplies found, defer probe\n");
1040                 goto check_supplies_failed;
1041         }
1042
1043         spin_lock_init(&psy->changed_lock);
1044         rc = device_init_wakeup(dev, ws);
1045         if (rc)
1046                 goto wakeup_init_failed;
1047
1048         rc = device_add(dev);
1049         if (rc)
1050                 goto device_add_failed;
1051
1052         rc = psy_register_thermal(psy);
1053         if (rc)
1054                 goto register_thermal_failed;
1055
1056         rc = psy_register_cooler(psy);
1057         if (rc)
1058                 goto register_cooler_failed;
1059
1060         rc = power_supply_create_triggers(psy);
1061         if (rc)
1062                 goto create_triggers_failed;
1063
1064         /*
1065          * Update use_cnt after any uevents (most notably from device_add()).
1066          * We are here still during driver's probe but
1067          * the power_supply_uevent() calls back driver's get_property
1068          * method so:
1069          * 1. Driver did not assigned the returned struct power_supply,
1070          * 2. Driver could not finish initialization (anything in its probe
1071          *    after calling power_supply_register()).
1072          */
1073         atomic_inc(&psy->use_cnt);
1074         psy->initialized = true;
1075
1076         queue_delayed_work(system_power_efficient_wq,
1077                            &psy->deferred_register_work,
1078                            POWER_SUPPLY_DEFERRED_REGISTER_TIME);
1079
1080         return psy;
1081
1082 create_triggers_failed:
1083         psy_unregister_cooler(psy);
1084 register_cooler_failed:
1085         psy_unregister_thermal(psy);
1086 register_thermal_failed:
1087         device_del(dev);
1088 device_add_failed:
1089 wakeup_init_failed:
1090 check_supplies_failed:
1091 dev_set_name_failed:
1092         put_device(dev);
1093         return ERR_PTR(rc);
1094 }
1095
1096 /**
1097  * power_supply_register() - Register new power supply
1098  * @parent:     Device to be a parent of power supply's device, usually
1099  *              the device which probe function calls this
1100  * @desc:       Description of power supply, must be valid through whole
1101  *              lifetime of this power supply
1102  * @cfg:        Run-time specific configuration accessed during registering,
1103  *              may be NULL
1104  *
1105  * Return: A pointer to newly allocated power_supply on success
1106  * or ERR_PTR otherwise.
1107  * Use power_supply_unregister() on returned power_supply pointer to release
1108  * resources.
1109  */
1110 struct power_supply *__must_check power_supply_register(struct device *parent,
1111                 const struct power_supply_desc *desc,
1112                 const struct power_supply_config *cfg)
1113 {
1114         return __power_supply_register(parent, desc, cfg, true);
1115 }
1116 EXPORT_SYMBOL_GPL(power_supply_register);
1117
1118 /**
1119  * power_supply_register_no_ws() - Register new non-waking-source power supply
1120  * @parent:     Device to be a parent of power supply's device, usually
1121  *              the device which probe function calls this
1122  * @desc:       Description of power supply, must be valid through whole
1123  *              lifetime of this power supply
1124  * @cfg:        Run-time specific configuration accessed during registering,
1125  *              may be NULL
1126  *
1127  * Return: A pointer to newly allocated power_supply on success
1128  * or ERR_PTR otherwise.
1129  * Use power_supply_unregister() on returned power_supply pointer to release
1130  * resources.
1131  */
1132 struct power_supply *__must_check
1133 power_supply_register_no_ws(struct device *parent,
1134                 const struct power_supply_desc *desc,
1135                 const struct power_supply_config *cfg)
1136 {
1137         return __power_supply_register(parent, desc, cfg, false);
1138 }
1139 EXPORT_SYMBOL_GPL(power_supply_register_no_ws);
1140
1141 static void devm_power_supply_release(struct device *dev, void *res)
1142 {
1143         struct power_supply **psy = res;
1144
1145         power_supply_unregister(*psy);
1146 }
1147
1148 /**
1149  * devm_power_supply_register() - Register managed power supply
1150  * @parent:     Device to be a parent of power supply's device, usually
1151  *              the device which probe function calls this
1152  * @desc:       Description of power supply, must be valid through whole
1153  *              lifetime of this power supply
1154  * @cfg:        Run-time specific configuration accessed during registering,
1155  *              may be NULL
1156  *
1157  * Return: A pointer to newly allocated power_supply on success
1158  * or ERR_PTR otherwise.
1159  * The returned power_supply pointer will be automatically unregistered
1160  * on driver detach.
1161  */
1162 struct power_supply *__must_check
1163 devm_power_supply_register(struct device *parent,
1164                 const struct power_supply_desc *desc,
1165                 const struct power_supply_config *cfg)
1166 {
1167         struct power_supply **ptr, *psy;
1168
1169         ptr = devres_alloc(devm_power_supply_release, sizeof(*ptr), GFP_KERNEL);
1170
1171         if (!ptr)
1172                 return ERR_PTR(-ENOMEM);
1173         psy = __power_supply_register(parent, desc, cfg, true);
1174         if (IS_ERR(psy)) {
1175                 devres_free(ptr);
1176         } else {
1177                 *ptr = psy;
1178                 devres_add(parent, ptr);
1179         }
1180         return psy;
1181 }
1182 EXPORT_SYMBOL_GPL(devm_power_supply_register);
1183
1184 /**
1185  * devm_power_supply_register_no_ws() - Register managed non-waking-source power supply
1186  * @parent:     Device to be a parent of power supply's device, usually
1187  *              the device which probe function calls this
1188  * @desc:       Description of power supply, must be valid through whole
1189  *              lifetime of this power supply
1190  * @cfg:        Run-time specific configuration accessed during registering,
1191  *              may be NULL
1192  *
1193  * Return: A pointer to newly allocated power_supply on success
1194  * or ERR_PTR otherwise.
1195  * The returned power_supply pointer will be automatically unregistered
1196  * on driver detach.
1197  */
1198 struct power_supply *__must_check
1199 devm_power_supply_register_no_ws(struct device *parent,
1200                 const struct power_supply_desc *desc,
1201                 const struct power_supply_config *cfg)
1202 {
1203         struct power_supply **ptr, *psy;
1204
1205         ptr = devres_alloc(devm_power_supply_release, sizeof(*ptr), GFP_KERNEL);
1206
1207         if (!ptr)
1208                 return ERR_PTR(-ENOMEM);
1209         psy = __power_supply_register(parent, desc, cfg, false);
1210         if (IS_ERR(psy)) {
1211                 devres_free(ptr);
1212         } else {
1213                 *ptr = psy;
1214                 devres_add(parent, ptr);
1215         }
1216         return psy;
1217 }
1218 EXPORT_SYMBOL_GPL(devm_power_supply_register_no_ws);
1219
1220 /**
1221  * power_supply_unregister() - Remove this power supply from system
1222  * @psy:        Pointer to power supply to unregister
1223  *
1224  * Remove this power supply from the system. The resources of power supply
1225  * will be freed here or on last power_supply_put() call.
1226  */
1227 void power_supply_unregister(struct power_supply *psy)
1228 {
1229         WARN_ON(atomic_dec_return(&psy->use_cnt));
1230         psy->removing = true;
1231         cancel_work_sync(&psy->changed_work);
1232         cancel_delayed_work_sync(&psy->deferred_register_work);
1233         sysfs_remove_link(&psy->dev.kobj, "powers");
1234         power_supply_remove_triggers(psy);
1235         psy_unregister_cooler(psy);
1236         psy_unregister_thermal(psy);
1237         device_init_wakeup(&psy->dev, false);
1238         device_unregister(&psy->dev);
1239 }
1240 EXPORT_SYMBOL_GPL(power_supply_unregister);
1241
1242 void *power_supply_get_drvdata(struct power_supply *psy)
1243 {
1244         return psy->drv_data;
1245 }
1246 EXPORT_SYMBOL_GPL(power_supply_get_drvdata);
1247
1248 static int __init power_supply_class_init(void)
1249 {
1250         power_supply_class = class_create(THIS_MODULE, "power_supply");
1251
1252         if (IS_ERR(power_supply_class))
1253                 return PTR_ERR(power_supply_class);
1254
1255         power_supply_class->dev_uevent = power_supply_uevent;
1256         power_supply_init_attrs(&power_supply_dev_type);
1257
1258         return 0;
1259 }
1260
1261 static void __exit power_supply_class_exit(void)
1262 {
1263         class_destroy(power_supply_class);
1264 }
1265
1266 subsys_initcall(power_supply_class_init);
1267 module_exit(power_supply_class_exit);
1268
1269 MODULE_DESCRIPTION("Universal power supply monitor class");
1270 MODULE_AUTHOR("Ian Molton <spyro@f2s.com>, "
1271               "Szabolcs Gyurko, "
1272               "Anton Vorontsov <cbou@mail.ru>");
1273 MODULE_LICENSE("GPL");