Merge tag 'usb-for-v4.7' of git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb...
[linux/fpc-iii.git] / drivers / power / power_supply_core.c
blob456987c88baab9f4b8a0d2b7224b10d659b8bddc
1 /*
2 * Universal power supply monitor class
4 * Copyright © 2007 Anton Vorontsov <cbou@mail.ru>
5 * Copyright © 2004 Szabolcs Gyurko
6 * Copyright © 2003 Ian Molton <spyro@f2s.com>
8 * Modified: 2004, Oct Szabolcs Gyurko
10 * You may use this code as per GPL version 2
13 #include <linux/module.h>
14 #include <linux/types.h>
15 #include <linux/init.h>
16 #include <linux/slab.h>
17 #include <linux/device.h>
18 #include <linux/notifier.h>
19 #include <linux/err.h>
20 #include <linux/power_supply.h>
21 #include <linux/thermal.h>
22 #include "power_supply.h"
24 /* exported for the APM Power driver, APM emulation */
25 struct class *power_supply_class;
26 EXPORT_SYMBOL_GPL(power_supply_class);
28 ATOMIC_NOTIFIER_HEAD(power_supply_notifier);
29 EXPORT_SYMBOL_GPL(power_supply_notifier);
31 static struct device_type power_supply_dev_type;
33 #define POWER_SUPPLY_DEFERRED_REGISTER_TIME msecs_to_jiffies(10)
35 static bool __power_supply_is_supplied_by(struct power_supply *supplier,
36 struct power_supply *supply)
38 int i;
40 if (!supply->supplied_from && !supplier->supplied_to)
41 return false;
43 /* Support both supplied_to and supplied_from modes */
44 if (supply->supplied_from) {
45 if (!supplier->desc->name)
46 return false;
47 for (i = 0; i < supply->num_supplies; i++)
48 if (!strcmp(supplier->desc->name, supply->supplied_from[i]))
49 return true;
50 } else {
51 if (!supply->desc->name)
52 return false;
53 for (i = 0; i < supplier->num_supplicants; i++)
54 if (!strcmp(supplier->supplied_to[i], supply->desc->name))
55 return true;
58 return false;
61 static int __power_supply_changed_work(struct device *dev, void *data)
63 struct power_supply *psy = data;
64 struct power_supply *pst = dev_get_drvdata(dev);
66 if (__power_supply_is_supplied_by(psy, pst)) {
67 if (pst->desc->external_power_changed)
68 pst->desc->external_power_changed(pst);
71 return 0;
74 static void power_supply_changed_work(struct work_struct *work)
76 unsigned long flags;
77 struct power_supply *psy = container_of(work, struct power_supply,
78 changed_work);
80 dev_dbg(&psy->dev, "%s\n", __func__);
82 spin_lock_irqsave(&psy->changed_lock, flags);
84 * Check 'changed' here to avoid issues due to race between
85 * power_supply_changed() and this routine. In worst case
86 * power_supply_changed() can be called again just before we take above
87 * lock. During the first call of this routine we will mark 'changed' as
88 * false and it will stay false for the next call as well.
90 if (likely(psy->changed)) {
91 psy->changed = false;
92 spin_unlock_irqrestore(&psy->changed_lock, flags);
93 class_for_each_device(power_supply_class, NULL, psy,
94 __power_supply_changed_work);
95 power_supply_update_leds(psy);
96 atomic_notifier_call_chain(&power_supply_notifier,
97 PSY_EVENT_PROP_CHANGED, psy);
98 kobject_uevent(&psy->dev.kobj, KOBJ_CHANGE);
99 spin_lock_irqsave(&psy->changed_lock, flags);
103 * Hold the wakeup_source until all events are processed.
104 * power_supply_changed() might have called again and have set 'changed'
105 * to true.
107 if (likely(!psy->changed))
108 pm_relax(&psy->dev);
109 spin_unlock_irqrestore(&psy->changed_lock, flags);
112 void power_supply_changed(struct power_supply *psy)
114 unsigned long flags;
116 dev_dbg(&psy->dev, "%s\n", __func__);
118 spin_lock_irqsave(&psy->changed_lock, flags);
119 psy->changed = true;
120 pm_stay_awake(&psy->dev);
121 spin_unlock_irqrestore(&psy->changed_lock, flags);
122 schedule_work(&psy->changed_work);
124 EXPORT_SYMBOL_GPL(power_supply_changed);
127 * Notify that power supply was registered after parent finished the probing.
129 * Often power supply is registered from driver's probe function. However
130 * calling power_supply_changed() directly from power_supply_register()
131 * would lead to execution of get_property() function provided by the driver
132 * too early - before the probe ends.
134 * Avoid that by waiting on parent's mutex.
136 static void power_supply_deferred_register_work(struct work_struct *work)
138 struct power_supply *psy = container_of(work, struct power_supply,
139 deferred_register_work.work);
141 if (psy->dev.parent)
142 mutex_lock(&psy->dev.parent->mutex);
144 power_supply_changed(psy);
146 if (psy->dev.parent)
147 mutex_unlock(&psy->dev.parent->mutex);
150 #ifdef CONFIG_OF
151 #include <linux/of.h>
153 static int __power_supply_populate_supplied_from(struct device *dev,
154 void *data)
156 struct power_supply *psy = data;
157 struct power_supply *epsy = dev_get_drvdata(dev);
158 struct device_node *np;
159 int i = 0;
161 do {
162 np = of_parse_phandle(psy->of_node, "power-supplies", i++);
163 if (!np)
164 break;
166 if (np == epsy->of_node) {
167 dev_info(&psy->dev, "%s: Found supply : %s\n",
168 psy->desc->name, epsy->desc->name);
169 psy->supplied_from[i-1] = (char *)epsy->desc->name;
170 psy->num_supplies++;
171 of_node_put(np);
172 break;
174 of_node_put(np);
175 } while (np);
177 return 0;
180 static int power_supply_populate_supplied_from(struct power_supply *psy)
182 int error;
184 error = class_for_each_device(power_supply_class, NULL, psy,
185 __power_supply_populate_supplied_from);
187 dev_dbg(&psy->dev, "%s %d\n", __func__, error);
189 return error;
192 static int __power_supply_find_supply_from_node(struct device *dev,
193 void *data)
195 struct device_node *np = data;
196 struct power_supply *epsy = dev_get_drvdata(dev);
198 /* returning non-zero breaks out of class_for_each_device loop */
199 if (epsy->of_node == np)
200 return 1;
202 return 0;
205 static int power_supply_find_supply_from_node(struct device_node *supply_node)
207 int error;
210 * class_for_each_device() either returns its own errors or values
211 * returned by __power_supply_find_supply_from_node().
213 * __power_supply_find_supply_from_node() will return 0 (no match)
214 * or 1 (match).
216 * We return 0 if class_for_each_device() returned 1, -EPROBE_DEFER if
217 * it returned 0, or error as returned by it.
219 error = class_for_each_device(power_supply_class, NULL, supply_node,
220 __power_supply_find_supply_from_node);
222 return error ? (error == 1 ? 0 : error) : -EPROBE_DEFER;
225 static int power_supply_check_supplies(struct power_supply *psy)
227 struct device_node *np;
228 int cnt = 0;
230 /* If there is already a list honor it */
231 if (psy->supplied_from && psy->num_supplies > 0)
232 return 0;
234 /* No device node found, nothing to do */
235 if (!psy->of_node)
236 return 0;
238 do {
239 int ret;
241 np = of_parse_phandle(psy->of_node, "power-supplies", cnt++);
242 if (!np)
243 break;
245 ret = power_supply_find_supply_from_node(np);
246 of_node_put(np);
248 if (ret) {
249 dev_dbg(&psy->dev, "Failed to find supply!\n");
250 return ret;
252 } while (np);
254 /* Missing valid "power-supplies" entries */
255 if (cnt == 1)
256 return 0;
258 /* All supplies found, allocate char ** array for filling */
259 psy->supplied_from = devm_kzalloc(&psy->dev, sizeof(psy->supplied_from),
260 GFP_KERNEL);
261 if (!psy->supplied_from) {
262 dev_err(&psy->dev, "Couldn't allocate memory for supply list\n");
263 return -ENOMEM;
266 *psy->supplied_from = devm_kzalloc(&psy->dev,
267 sizeof(char *) * (cnt - 1),
268 GFP_KERNEL);
269 if (!*psy->supplied_from) {
270 dev_err(&psy->dev, "Couldn't allocate memory for supply list\n");
271 return -ENOMEM;
274 return power_supply_populate_supplied_from(psy);
276 #else
277 static inline int power_supply_check_supplies(struct power_supply *psy)
279 return 0;
281 #endif
283 static int __power_supply_am_i_supplied(struct device *dev, void *data)
285 union power_supply_propval ret = {0,};
286 struct power_supply *psy = data;
287 struct power_supply *epsy = dev_get_drvdata(dev);
289 if (__power_supply_is_supplied_by(epsy, psy))
290 if (!epsy->desc->get_property(epsy, POWER_SUPPLY_PROP_ONLINE,
291 &ret))
292 return ret.intval;
294 return 0;
297 int power_supply_am_i_supplied(struct power_supply *psy)
299 int error;
301 error = class_for_each_device(power_supply_class, NULL, psy,
302 __power_supply_am_i_supplied);
304 dev_dbg(&psy->dev, "%s %d\n", __func__, error);
306 return error;
308 EXPORT_SYMBOL_GPL(power_supply_am_i_supplied);
310 static int __power_supply_is_system_supplied(struct device *dev, void *data)
312 union power_supply_propval ret = {0,};
313 struct power_supply *psy = dev_get_drvdata(dev);
314 unsigned int *count = data;
316 (*count)++;
317 if (psy->desc->type != POWER_SUPPLY_TYPE_BATTERY)
318 if (!psy->desc->get_property(psy, POWER_SUPPLY_PROP_ONLINE,
319 &ret))
320 return ret.intval;
322 return 0;
325 int power_supply_is_system_supplied(void)
327 int error;
328 unsigned int count = 0;
330 error = class_for_each_device(power_supply_class, NULL, &count,
331 __power_supply_is_system_supplied);
334 * If no power class device was found at all, most probably we are
335 * running on a desktop system, so assume we are on mains power.
337 if (count == 0)
338 return 1;
340 return error;
342 EXPORT_SYMBOL_GPL(power_supply_is_system_supplied);
344 int power_supply_set_battery_charged(struct power_supply *psy)
346 if (atomic_read(&psy->use_cnt) >= 0 &&
347 psy->desc->type == POWER_SUPPLY_TYPE_BATTERY &&
348 psy->desc->set_charged) {
349 psy->desc->set_charged(psy);
350 return 0;
353 return -EINVAL;
355 EXPORT_SYMBOL_GPL(power_supply_set_battery_charged);
357 static int power_supply_match_device_by_name(struct device *dev, const void *data)
359 const char *name = data;
360 struct power_supply *psy = dev_get_drvdata(dev);
362 return strcmp(psy->desc->name, name) == 0;
366 * power_supply_get_by_name() - Search for a power supply and returns its ref
367 * @name: Power supply name to fetch
369 * If power supply was found, it increases reference count for the
370 * internal power supply's device. The user should power_supply_put()
371 * after usage.
373 * Return: On success returns a reference to a power supply with
374 * matching name equals to @name, a NULL otherwise.
376 struct power_supply *power_supply_get_by_name(const char *name)
378 struct power_supply *psy = NULL;
379 struct device *dev = class_find_device(power_supply_class, NULL, name,
380 power_supply_match_device_by_name);
382 if (dev) {
383 psy = dev_get_drvdata(dev);
384 atomic_inc(&psy->use_cnt);
387 return psy;
389 EXPORT_SYMBOL_GPL(power_supply_get_by_name);
392 * power_supply_put() - Drop reference obtained with power_supply_get_by_name
393 * @psy: Reference to put
395 * The reference to power supply should be put before unregistering
396 * the power supply.
398 void power_supply_put(struct power_supply *psy)
400 might_sleep();
402 atomic_dec(&psy->use_cnt);
403 put_device(&psy->dev);
405 EXPORT_SYMBOL_GPL(power_supply_put);
407 #ifdef CONFIG_OF
408 static int power_supply_match_device_node(struct device *dev, const void *data)
410 return dev->parent && dev->parent->of_node == data;
414 * power_supply_get_by_phandle() - Search for a power supply and returns its ref
415 * @np: Pointer to device node holding phandle property
416 * @phandle_name: Name of property holding a power supply name
418 * If power supply was found, it increases reference count for the
419 * internal power supply's device. The user should power_supply_put()
420 * after usage.
422 * Return: On success returns a reference to a power supply with
423 * matching name equals to value under @property, NULL or ERR_PTR otherwise.
425 struct power_supply *power_supply_get_by_phandle(struct device_node *np,
426 const char *property)
428 struct device_node *power_supply_np;
429 struct power_supply *psy = NULL;
430 struct device *dev;
432 power_supply_np = of_parse_phandle(np, property, 0);
433 if (!power_supply_np)
434 return ERR_PTR(-ENODEV);
436 dev = class_find_device(power_supply_class, NULL, power_supply_np,
437 power_supply_match_device_node);
439 of_node_put(power_supply_np);
441 if (dev) {
442 psy = dev_get_drvdata(dev);
443 atomic_inc(&psy->use_cnt);
446 return psy;
448 EXPORT_SYMBOL_GPL(power_supply_get_by_phandle);
450 static void devm_power_supply_put(struct device *dev, void *res)
452 struct power_supply **psy = res;
454 power_supply_put(*psy);
458 * devm_power_supply_get_by_phandle() - Resource managed version of
459 * power_supply_get_by_phandle()
460 * @dev: Pointer to device holding phandle property
461 * @phandle_name: Name of property holding a power supply phandle
463 * Return: On success returns a reference to a power supply with
464 * matching name equals to value under @property, NULL or ERR_PTR otherwise.
466 struct power_supply *devm_power_supply_get_by_phandle(struct device *dev,
467 const char *property)
469 struct power_supply **ptr, *psy;
471 if (!dev->of_node)
472 return ERR_PTR(-ENODEV);
474 ptr = devres_alloc(devm_power_supply_put, sizeof(*ptr), GFP_KERNEL);
475 if (!ptr)
476 return ERR_PTR(-ENOMEM);
478 psy = power_supply_get_by_phandle(dev->of_node, property);
479 if (IS_ERR_OR_NULL(psy)) {
480 devres_free(ptr);
481 } else {
482 *ptr = psy;
483 devres_add(dev, ptr);
485 return psy;
487 EXPORT_SYMBOL_GPL(devm_power_supply_get_by_phandle);
488 #endif /* CONFIG_OF */
490 int power_supply_get_property(struct power_supply *psy,
491 enum power_supply_property psp,
492 union power_supply_propval *val)
494 if (atomic_read(&psy->use_cnt) <= 0)
495 return -ENODEV;
497 return psy->desc->get_property(psy, psp, val);
499 EXPORT_SYMBOL_GPL(power_supply_get_property);
501 int power_supply_set_property(struct power_supply *psy,
502 enum power_supply_property psp,
503 const union power_supply_propval *val)
505 if (atomic_read(&psy->use_cnt) <= 0 || !psy->desc->set_property)
506 return -ENODEV;
508 return psy->desc->set_property(psy, psp, val);
510 EXPORT_SYMBOL_GPL(power_supply_set_property);
512 int power_supply_property_is_writeable(struct power_supply *psy,
513 enum power_supply_property psp)
515 if (atomic_read(&psy->use_cnt) <= 0 ||
516 !psy->desc->property_is_writeable)
517 return -ENODEV;
519 return psy->desc->property_is_writeable(psy, psp);
521 EXPORT_SYMBOL_GPL(power_supply_property_is_writeable);
523 void power_supply_external_power_changed(struct power_supply *psy)
525 if (atomic_read(&psy->use_cnt) <= 0 ||
526 !psy->desc->external_power_changed)
527 return;
529 psy->desc->external_power_changed(psy);
531 EXPORT_SYMBOL_GPL(power_supply_external_power_changed);
533 int power_supply_powers(struct power_supply *psy, struct device *dev)
535 return sysfs_create_link(&psy->dev.kobj, &dev->kobj, "powers");
537 EXPORT_SYMBOL_GPL(power_supply_powers);
539 static void power_supply_dev_release(struct device *dev)
541 struct power_supply *psy = container_of(dev, struct power_supply, dev);
542 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
543 kfree(psy);
546 int power_supply_reg_notifier(struct notifier_block *nb)
548 return atomic_notifier_chain_register(&power_supply_notifier, nb);
550 EXPORT_SYMBOL_GPL(power_supply_reg_notifier);
552 void power_supply_unreg_notifier(struct notifier_block *nb)
554 atomic_notifier_chain_unregister(&power_supply_notifier, nb);
556 EXPORT_SYMBOL_GPL(power_supply_unreg_notifier);
558 #ifdef CONFIG_THERMAL
559 static int power_supply_read_temp(struct thermal_zone_device *tzd,
560 int *temp)
562 struct power_supply *psy;
563 union power_supply_propval val;
564 int ret;
566 WARN_ON(tzd == NULL);
567 psy = tzd->devdata;
568 ret = psy->desc->get_property(psy, POWER_SUPPLY_PROP_TEMP, &val);
570 /* Convert tenths of degree Celsius to milli degree Celsius. */
571 if (!ret)
572 *temp = val.intval * 100;
574 return ret;
577 static struct thermal_zone_device_ops psy_tzd_ops = {
578 .get_temp = power_supply_read_temp,
581 static int psy_register_thermal(struct power_supply *psy)
583 int i;
585 if (psy->desc->no_thermal)
586 return 0;
588 /* Register battery zone device psy reports temperature */
589 for (i = 0; i < psy->desc->num_properties; i++) {
590 if (psy->desc->properties[i] == POWER_SUPPLY_PROP_TEMP) {
591 psy->tzd = thermal_zone_device_register(psy->desc->name,
592 0, 0, psy, &psy_tzd_ops, NULL, 0, 0);
593 return PTR_ERR_OR_ZERO(psy->tzd);
596 return 0;
599 static void psy_unregister_thermal(struct power_supply *psy)
601 if (IS_ERR_OR_NULL(psy->tzd))
602 return;
603 thermal_zone_device_unregister(psy->tzd);
606 /* thermal cooling device callbacks */
607 static int ps_get_max_charge_cntl_limit(struct thermal_cooling_device *tcd,
608 unsigned long *state)
610 struct power_supply *psy;
611 union power_supply_propval val;
612 int ret;
614 psy = tcd->devdata;
615 ret = psy->desc->get_property(psy,
616 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX, &val);
617 if (!ret)
618 *state = val.intval;
620 return ret;
623 static int ps_get_cur_chrage_cntl_limit(struct thermal_cooling_device *tcd,
624 unsigned long *state)
626 struct power_supply *psy;
627 union power_supply_propval val;
628 int ret;
630 psy = tcd->devdata;
631 ret = psy->desc->get_property(psy,
632 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT, &val);
633 if (!ret)
634 *state = val.intval;
636 return ret;
639 static int ps_set_cur_charge_cntl_limit(struct thermal_cooling_device *tcd,
640 unsigned long state)
642 struct power_supply *psy;
643 union power_supply_propval val;
644 int ret;
646 psy = tcd->devdata;
647 val.intval = state;
648 ret = psy->desc->set_property(psy,
649 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT, &val);
651 return ret;
654 static struct thermal_cooling_device_ops psy_tcd_ops = {
655 .get_max_state = ps_get_max_charge_cntl_limit,
656 .get_cur_state = ps_get_cur_chrage_cntl_limit,
657 .set_cur_state = ps_set_cur_charge_cntl_limit,
660 static int psy_register_cooler(struct power_supply *psy)
662 int i;
664 /* Register for cooling device if psy can control charging */
665 for (i = 0; i < psy->desc->num_properties; i++) {
666 if (psy->desc->properties[i] ==
667 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT) {
668 psy->tcd = thermal_cooling_device_register(
669 (char *)psy->desc->name,
670 psy, &psy_tcd_ops);
671 return PTR_ERR_OR_ZERO(psy->tcd);
674 return 0;
677 static void psy_unregister_cooler(struct power_supply *psy)
679 if (IS_ERR_OR_NULL(psy->tcd))
680 return;
681 thermal_cooling_device_unregister(psy->tcd);
683 #else
684 static int psy_register_thermal(struct power_supply *psy)
686 return 0;
689 static void psy_unregister_thermal(struct power_supply *psy)
693 static int psy_register_cooler(struct power_supply *psy)
695 return 0;
698 static void psy_unregister_cooler(struct power_supply *psy)
701 #endif
703 static struct power_supply *__must_check
704 __power_supply_register(struct device *parent,
705 const struct power_supply_desc *desc,
706 const struct power_supply_config *cfg,
707 bool ws)
709 struct device *dev;
710 struct power_supply *psy;
711 int rc;
713 if (!parent)
714 pr_warn("%s: Expected proper parent device for '%s'\n",
715 __func__, desc->name);
717 psy = kzalloc(sizeof(*psy), GFP_KERNEL);
718 if (!psy)
719 return ERR_PTR(-ENOMEM);
721 dev = &psy->dev;
723 device_initialize(dev);
725 dev->class = power_supply_class;
726 dev->type = &power_supply_dev_type;
727 dev->parent = parent;
728 dev->release = power_supply_dev_release;
729 dev_set_drvdata(dev, psy);
730 psy->desc = desc;
731 if (cfg) {
732 psy->drv_data = cfg->drv_data;
733 psy->of_node = cfg->of_node;
734 psy->supplied_to = cfg->supplied_to;
735 psy->num_supplicants = cfg->num_supplicants;
738 rc = dev_set_name(dev, "%s", desc->name);
739 if (rc)
740 goto dev_set_name_failed;
742 INIT_WORK(&psy->changed_work, power_supply_changed_work);
743 INIT_DELAYED_WORK(&psy->deferred_register_work,
744 power_supply_deferred_register_work);
746 rc = power_supply_check_supplies(psy);
747 if (rc) {
748 dev_info(dev, "Not all required supplies found, defer probe\n");
749 goto check_supplies_failed;
752 spin_lock_init(&psy->changed_lock);
753 rc = device_init_wakeup(dev, ws);
754 if (rc)
755 goto wakeup_init_failed;
757 rc = device_add(dev);
758 if (rc)
759 goto device_add_failed;
761 rc = psy_register_thermal(psy);
762 if (rc)
763 goto register_thermal_failed;
765 rc = psy_register_cooler(psy);
766 if (rc)
767 goto register_cooler_failed;
769 rc = power_supply_create_triggers(psy);
770 if (rc)
771 goto create_triggers_failed;
774 * Update use_cnt after any uevents (most notably from device_add()).
775 * We are here still during driver's probe but
776 * the power_supply_uevent() calls back driver's get_property
777 * method so:
778 * 1. Driver did not assigned the returned struct power_supply,
779 * 2. Driver could not finish initialization (anything in its probe
780 * after calling power_supply_register()).
782 atomic_inc(&psy->use_cnt);
784 queue_delayed_work(system_power_efficient_wq,
785 &psy->deferred_register_work,
786 POWER_SUPPLY_DEFERRED_REGISTER_TIME);
788 return psy;
790 create_triggers_failed:
791 psy_unregister_cooler(psy);
792 register_cooler_failed:
793 psy_unregister_thermal(psy);
794 register_thermal_failed:
795 device_del(dev);
796 device_add_failed:
797 wakeup_init_failed:
798 check_supplies_failed:
799 dev_set_name_failed:
800 put_device(dev);
801 return ERR_PTR(rc);
805 * power_supply_register() - Register new power supply
806 * @parent: Device to be a parent of power supply's device, usually
807 * the device which probe function calls this
808 * @desc: Description of power supply, must be valid through whole
809 * lifetime of this power supply
810 * @cfg: Run-time specific configuration accessed during registering,
811 * may be NULL
813 * Return: A pointer to newly allocated power_supply on success
814 * or ERR_PTR otherwise.
815 * Use power_supply_unregister() on returned power_supply pointer to release
816 * resources.
818 struct power_supply *__must_check power_supply_register(struct device *parent,
819 const struct power_supply_desc *desc,
820 const struct power_supply_config *cfg)
822 return __power_supply_register(parent, desc, cfg, true);
824 EXPORT_SYMBOL_GPL(power_supply_register);
827 * power_supply_register_no_ws() - Register new non-waking-source power supply
828 * @parent: Device to be a parent of power supply's device, usually
829 * the device which probe function calls this
830 * @desc: Description of power supply, must be valid through whole
831 * lifetime of this power supply
832 * @cfg: Run-time specific configuration accessed during registering,
833 * may be NULL
835 * Return: A pointer to newly allocated power_supply on success
836 * or ERR_PTR otherwise.
837 * Use power_supply_unregister() on returned power_supply pointer to release
838 * resources.
840 struct power_supply *__must_check
841 power_supply_register_no_ws(struct device *parent,
842 const struct power_supply_desc *desc,
843 const struct power_supply_config *cfg)
845 return __power_supply_register(parent, desc, cfg, false);
847 EXPORT_SYMBOL_GPL(power_supply_register_no_ws);
849 static void devm_power_supply_release(struct device *dev, void *res)
851 struct power_supply **psy = res;
853 power_supply_unregister(*psy);
857 * devm_power_supply_register() - Register managed power supply
858 * @parent: Device to be a parent of power supply's device, usually
859 * the device which probe function calls this
860 * @desc: Description of power supply, must be valid through whole
861 * lifetime of this power supply
862 * @cfg: Run-time specific configuration accessed during registering,
863 * may be NULL
865 * Return: A pointer to newly allocated power_supply on success
866 * or ERR_PTR otherwise.
867 * The returned power_supply pointer will be automatically unregistered
868 * on driver detach.
870 struct power_supply *__must_check
871 devm_power_supply_register(struct device *parent,
872 const struct power_supply_desc *desc,
873 const struct power_supply_config *cfg)
875 struct power_supply **ptr, *psy;
877 ptr = devres_alloc(devm_power_supply_release, sizeof(*ptr), GFP_KERNEL);
879 if (!ptr)
880 return ERR_PTR(-ENOMEM);
881 psy = __power_supply_register(parent, desc, cfg, true);
882 if (IS_ERR(psy)) {
883 devres_free(ptr);
884 } else {
885 *ptr = psy;
886 devres_add(parent, ptr);
888 return psy;
890 EXPORT_SYMBOL_GPL(devm_power_supply_register);
893 * devm_power_supply_register_no_ws() - Register managed non-waking-source power supply
894 * @parent: Device to be a parent of power supply's device, usually
895 * the device which probe function calls this
896 * @desc: Description of power supply, must be valid through whole
897 * lifetime of this power supply
898 * @cfg: Run-time specific configuration accessed during registering,
899 * may be NULL
901 * Return: A pointer to newly allocated power_supply on success
902 * or ERR_PTR otherwise.
903 * The returned power_supply pointer will be automatically unregistered
904 * on driver detach.
906 struct power_supply *__must_check
907 devm_power_supply_register_no_ws(struct device *parent,
908 const struct power_supply_desc *desc,
909 const struct power_supply_config *cfg)
911 struct power_supply **ptr, *psy;
913 ptr = devres_alloc(devm_power_supply_release, sizeof(*ptr), GFP_KERNEL);
915 if (!ptr)
916 return ERR_PTR(-ENOMEM);
917 psy = __power_supply_register(parent, desc, cfg, false);
918 if (IS_ERR(psy)) {
919 devres_free(ptr);
920 } else {
921 *ptr = psy;
922 devres_add(parent, ptr);
924 return psy;
926 EXPORT_SYMBOL_GPL(devm_power_supply_register_no_ws);
929 * power_supply_unregister() - Remove this power supply from system
930 * @psy: Pointer to power supply to unregister
932 * Remove this power supply from the system. The resources of power supply
933 * will be freed here or on last power_supply_put() call.
935 void power_supply_unregister(struct power_supply *psy)
937 WARN_ON(atomic_dec_return(&psy->use_cnt));
938 cancel_work_sync(&psy->changed_work);
939 cancel_delayed_work_sync(&psy->deferred_register_work);
940 sysfs_remove_link(&psy->dev.kobj, "powers");
941 power_supply_remove_triggers(psy);
942 psy_unregister_cooler(psy);
943 psy_unregister_thermal(psy);
944 device_init_wakeup(&psy->dev, false);
945 device_unregister(&psy->dev);
947 EXPORT_SYMBOL_GPL(power_supply_unregister);
949 void *power_supply_get_drvdata(struct power_supply *psy)
951 return psy->drv_data;
953 EXPORT_SYMBOL_GPL(power_supply_get_drvdata);
955 static int __init power_supply_class_init(void)
957 power_supply_class = class_create(THIS_MODULE, "power_supply");
959 if (IS_ERR(power_supply_class))
960 return PTR_ERR(power_supply_class);
962 power_supply_class->dev_uevent = power_supply_uevent;
963 power_supply_init_attrs(&power_supply_dev_type);
965 return 0;
968 static void __exit power_supply_class_exit(void)
970 class_destroy(power_supply_class);
973 subsys_initcall(power_supply_class_init);
974 module_exit(power_supply_class_exit);
976 MODULE_DESCRIPTION("Universal power supply monitor class");
977 MODULE_AUTHOR("Ian Molton <spyro@f2s.com>, "
978 "Szabolcs Gyurko, "
979 "Anton Vorontsov <cbou@mail.ru>");
980 MODULE_LICENSE("GPL");