1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
6 * Copyright (C) 2005-2007 Richard Purdie <rpurdie@openedhand.com>
9 #include <linux/ctype.h>
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/leds.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/property.h>
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
20 #include <linux/timer.h>
21 #include <uapi/linux/uleds.h>
25 static DEFINE_MUTEX(leds_lookup_lock
);
26 static LIST_HEAD(leds_lookup_list
);
28 static struct workqueue_struct
*leds_wq
;
30 static ssize_t
brightness_show(struct device
*dev
,
31 struct device_attribute
*attr
, char *buf
)
33 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
34 unsigned int brightness
;
36 mutex_lock(&led_cdev
->led_access
);
37 led_update_brightness(led_cdev
);
38 brightness
= led_cdev
->brightness
;
39 mutex_unlock(&led_cdev
->led_access
);
41 return sprintf(buf
, "%u\n", brightness
);
44 static ssize_t
brightness_store(struct device
*dev
,
45 struct device_attribute
*attr
, const char *buf
, size_t size
)
47 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
51 mutex_lock(&led_cdev
->led_access
);
53 if (led_sysfs_is_disabled(led_cdev
)) {
58 ret
= kstrtoul(buf
, 10, &state
);
63 led_trigger_remove(led_cdev
);
64 led_set_brightness(led_cdev
, state
);
68 mutex_unlock(&led_cdev
->led_access
);
71 static DEVICE_ATTR_RW(brightness
);
73 static ssize_t
max_brightness_show(struct device
*dev
,
74 struct device_attribute
*attr
, char *buf
)
76 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
77 unsigned int max_brightness
;
79 mutex_lock(&led_cdev
->led_access
);
80 max_brightness
= led_cdev
->max_brightness
;
81 mutex_unlock(&led_cdev
->led_access
);
83 return sprintf(buf
, "%u\n", max_brightness
);
85 static DEVICE_ATTR_RO(max_brightness
);
87 #ifdef CONFIG_LEDS_TRIGGERS
88 static BIN_ATTR(trigger
, 0644, led_trigger_read
, led_trigger_write
, 0);
89 static struct bin_attribute
*led_trigger_bin_attrs
[] = {
93 static const struct attribute_group led_trigger_group
= {
94 .bin_attrs
= led_trigger_bin_attrs
,
98 static struct attribute
*led_class_attrs
[] = {
99 &dev_attr_brightness
.attr
,
100 &dev_attr_max_brightness
.attr
,
104 static const struct attribute_group led_group
= {
105 .attrs
= led_class_attrs
,
108 static const struct attribute_group
*led_groups
[] = {
110 #ifdef CONFIG_LEDS_TRIGGERS
116 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
117 static ssize_t
brightness_hw_changed_show(struct device
*dev
,
118 struct device_attribute
*attr
, char *buf
)
120 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
122 if (led_cdev
->brightness_hw_changed
== -1)
125 return sprintf(buf
, "%u\n", led_cdev
->brightness_hw_changed
);
128 static DEVICE_ATTR_RO(brightness_hw_changed
);
130 static int led_add_brightness_hw_changed(struct led_classdev
*led_cdev
)
132 struct device
*dev
= led_cdev
->dev
;
135 ret
= device_create_file(dev
, &dev_attr_brightness_hw_changed
);
137 dev_err(dev
, "Error creating brightness_hw_changed\n");
141 led_cdev
->brightness_hw_changed_kn
=
142 sysfs_get_dirent(dev
->kobj
.sd
, "brightness_hw_changed");
143 if (!led_cdev
->brightness_hw_changed_kn
) {
144 dev_err(dev
, "Error getting brightness_hw_changed kn\n");
145 device_remove_file(dev
, &dev_attr_brightness_hw_changed
);
152 static void led_remove_brightness_hw_changed(struct led_classdev
*led_cdev
)
154 sysfs_put(led_cdev
->brightness_hw_changed_kn
);
155 device_remove_file(led_cdev
->dev
, &dev_attr_brightness_hw_changed
);
158 void led_classdev_notify_brightness_hw_changed(struct led_classdev
*led_cdev
, unsigned int brightness
)
160 if (WARN_ON(!led_cdev
->brightness_hw_changed_kn
))
163 led_cdev
->brightness_hw_changed
= brightness
;
164 sysfs_notify_dirent(led_cdev
->brightness_hw_changed_kn
);
166 EXPORT_SYMBOL_GPL(led_classdev_notify_brightness_hw_changed
);
168 static int led_add_brightness_hw_changed(struct led_classdev
*led_cdev
)
172 static void led_remove_brightness_hw_changed(struct led_classdev
*led_cdev
)
178 * led_classdev_suspend - suspend an led_classdev.
179 * @led_cdev: the led_classdev to suspend.
181 void led_classdev_suspend(struct led_classdev
*led_cdev
)
183 led_cdev
->flags
|= LED_SUSPENDED
;
184 led_set_brightness_nopm(led_cdev
, 0);
185 flush_work(&led_cdev
->set_brightness_work
);
187 EXPORT_SYMBOL_GPL(led_classdev_suspend
);
190 * led_classdev_resume - resume an led_classdev.
191 * @led_cdev: the led_classdev to resume.
193 void led_classdev_resume(struct led_classdev
*led_cdev
)
195 led_set_brightness_nopm(led_cdev
, led_cdev
->brightness
);
197 if (led_cdev
->flash_resume
)
198 led_cdev
->flash_resume(led_cdev
);
200 led_cdev
->flags
&= ~LED_SUSPENDED
;
202 EXPORT_SYMBOL_GPL(led_classdev_resume
);
204 #ifdef CONFIG_PM_SLEEP
205 static int led_suspend(struct device
*dev
)
207 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
209 if (led_cdev
->flags
& LED_CORE_SUSPENDRESUME
)
210 led_classdev_suspend(led_cdev
);
215 static int led_resume(struct device
*dev
)
217 struct led_classdev
*led_cdev
= dev_get_drvdata(dev
);
219 if (led_cdev
->flags
& LED_CORE_SUSPENDRESUME
)
220 led_classdev_resume(led_cdev
);
226 static SIMPLE_DEV_PM_OPS(leds_class_dev_pm_ops
, led_suspend
, led_resume
);
228 static struct led_classdev
*led_module_get(struct device
*led_dev
)
230 struct led_classdev
*led_cdev
;
233 return ERR_PTR(-EPROBE_DEFER
);
235 led_cdev
= dev_get_drvdata(led_dev
);
237 if (!try_module_get(led_cdev
->dev
->parent
->driver
->owner
)) {
238 put_device(led_cdev
->dev
);
239 return ERR_PTR(-ENODEV
);
245 static const struct class leds_class
= {
247 .dev_groups
= led_groups
,
248 .pm
= &leds_class_dev_pm_ops
,
252 * of_led_get() - request a LED device via the LED framework
253 * @np: device node to get the LED device from
254 * @index: the index of the LED
256 * Returns the LED device parsed from the phandle specified in the "leds"
257 * property of a device tree node or a negative error-code on failure.
259 struct led_classdev
*of_led_get(struct device_node
*np
, int index
)
261 struct device
*led_dev
;
262 struct device_node
*led_node
;
264 led_node
= of_parse_phandle(np
, "leds", index
);
266 return ERR_PTR(-ENOENT
);
268 led_dev
= class_find_device_by_of_node(&leds_class
, led_node
);
269 of_node_put(led_node
);
271 return led_module_get(led_dev
);
273 EXPORT_SYMBOL_GPL(of_led_get
);
276 * led_put() - release a LED device
277 * @led_cdev: LED device
279 void led_put(struct led_classdev
*led_cdev
)
281 module_put(led_cdev
->dev
->parent
->driver
->owner
);
282 put_device(led_cdev
->dev
);
284 EXPORT_SYMBOL_GPL(led_put
);
286 static void devm_led_release(struct device
*dev
, void *res
)
288 struct led_classdev
**p
= res
;
293 static struct led_classdev
*__devm_led_get(struct device
*dev
, struct led_classdev
*led
)
295 struct led_classdev
**dr
;
297 dr
= devres_alloc(devm_led_release
, sizeof(struct led_classdev
*), GFP_KERNEL
);
300 return ERR_PTR(-ENOMEM
);
310 * devm_of_led_get - Resource-managed request of a LED device
312 * @index: index of the LED to obtain in the consumer
314 * The device node of the device is parse to find the request LED device.
315 * The LED device returned from this function is automatically released
318 * @return a pointer to a LED device or ERR_PTR(errno) on failure.
320 struct led_classdev
*__must_check
devm_of_led_get(struct device
*dev
,
323 struct led_classdev
*led
;
326 return ERR_PTR(-EINVAL
);
328 led
= of_led_get(dev
->of_node
, index
);
332 return __devm_led_get(dev
, led
);
334 EXPORT_SYMBOL_GPL(devm_of_led_get
);
337 * led_get() - request a LED device via the LED framework
338 * @dev: device for which to get the LED device
339 * @con_id: name of the LED from the device's point of view
341 * @return a pointer to a LED device or ERR_PTR(errno) on failure.
343 struct led_classdev
*led_get(struct device
*dev
, char *con_id
)
345 struct led_lookup_data
*lookup
;
346 const char *provider
= NULL
;
347 struct device
*led_dev
;
349 mutex_lock(&leds_lookup_lock
);
350 list_for_each_entry(lookup
, &leds_lookup_list
, list
) {
351 if (!strcmp(lookup
->dev_id
, dev_name(dev
)) &&
352 !strcmp(lookup
->con_id
, con_id
)) {
353 provider
= kstrdup_const(lookup
->provider
, GFP_KERNEL
);
357 mutex_unlock(&leds_lookup_lock
);
360 return ERR_PTR(-ENOENT
);
362 led_dev
= class_find_device_by_name(&leds_class
, provider
);
363 kfree_const(provider
);
365 return led_module_get(led_dev
);
367 EXPORT_SYMBOL_GPL(led_get
);
370 * devm_led_get() - request a LED device via the LED framework
371 * @dev: device for which to get the LED device
372 * @con_id: name of the LED from the device's point of view
374 * The LED device returned from this function is automatically released
377 * @return a pointer to a LED device or ERR_PTR(errno) on failure.
379 struct led_classdev
*devm_led_get(struct device
*dev
, char *con_id
)
381 struct led_classdev
*led
;
383 led
= led_get(dev
, con_id
);
387 return __devm_led_get(dev
, led
);
389 EXPORT_SYMBOL_GPL(devm_led_get
);
392 * led_add_lookup() - Add a LED lookup table entry
393 * @led_lookup: the lookup table entry to add
395 * Add a LED lookup table entry. On systems without devicetree the lookup table
396 * is used by led_get() to find LEDs.
398 void led_add_lookup(struct led_lookup_data
*led_lookup
)
400 mutex_lock(&leds_lookup_lock
);
401 list_add_tail(&led_lookup
->list
, &leds_lookup_list
);
402 mutex_unlock(&leds_lookup_lock
);
404 EXPORT_SYMBOL_GPL(led_add_lookup
);
407 * led_remove_lookup() - Remove a LED lookup table entry
408 * @led_lookup: the lookup table entry to remove
410 void led_remove_lookup(struct led_lookup_data
*led_lookup
)
412 mutex_lock(&leds_lookup_lock
);
413 list_del(&led_lookup
->list
);
414 mutex_unlock(&leds_lookup_lock
);
416 EXPORT_SYMBOL_GPL(led_remove_lookup
);
419 * devm_of_led_get_optional - Resource-managed request of an optional LED device
421 * @index: index of the LED to obtain in the consumer
423 * The device node of the device is parsed to find the requested LED device.
424 * The LED device returned from this function is automatically released
427 * @return a pointer to a LED device, ERR_PTR(errno) on failure and NULL if the
430 struct led_classdev
*__must_check
devm_of_led_get_optional(struct device
*dev
,
433 struct led_classdev
*led
;
435 led
= devm_of_led_get(dev
, index
);
436 if (IS_ERR(led
) && PTR_ERR(led
) == -ENOENT
)
441 EXPORT_SYMBOL_GPL(devm_of_led_get_optional
);
443 static int led_classdev_next_name(const char *init_name
, char *name
,
450 strscpy(name
, init_name
, len
);
452 while ((ret
< len
) &&
453 (dev
= class_find_device_by_name(&leds_class
, name
))) {
455 ret
= snprintf(name
, len
, "%s_%u", init_name
, ++i
);
465 * led_classdev_register_ext - register a new object of led_classdev class
468 * @parent: parent of LED device
469 * @led_cdev: the led_classdev structure for this device.
470 * @init_data: LED class device initialization data
472 int led_classdev_register_ext(struct device
*parent
,
473 struct led_classdev
*led_cdev
,
474 struct led_init_data
*init_data
)
476 char composed_name
[LED_MAX_NAME_SIZE
];
477 char final_name
[LED_MAX_NAME_SIZE
];
478 const char *proposed_name
= composed_name
;
482 if (init_data
->devname_mandatory
&& !init_data
->devicename
) {
483 dev_err(parent
, "Mandatory device name is missing");
486 ret
= led_compose_name(parent
, init_data
, composed_name
);
490 if (init_data
->fwnode
) {
491 fwnode_property_read_string(init_data
->fwnode
,
492 "linux,default-trigger",
493 &led_cdev
->default_trigger
);
495 if (fwnode_property_present(init_data
->fwnode
,
496 "retain-state-shutdown"))
497 led_cdev
->flags
|= LED_RETAIN_AT_SHUTDOWN
;
499 fwnode_property_read_u32(init_data
->fwnode
,
501 &led_cdev
->max_brightness
);
503 if (fwnode_property_present(init_data
->fwnode
, "color"))
504 fwnode_property_read_u32(init_data
->fwnode
, "color",
508 proposed_name
= led_cdev
->name
;
511 ret
= led_classdev_next_name(proposed_name
, final_name
, sizeof(final_name
));
514 else if (ret
&& led_cdev
->flags
& LED_REJECT_NAME_CONFLICT
)
517 dev_warn(parent
, "Led %s renamed to %s due to name collision\n",
518 proposed_name
, final_name
);
520 if (led_cdev
->color
>= LED_COLOR_ID_MAX
)
521 dev_warn(parent
, "LED %s color identifier out of range\n", final_name
);
523 mutex_init(&led_cdev
->led_access
);
524 mutex_lock(&led_cdev
->led_access
);
525 led_cdev
->dev
= device_create_with_groups(&leds_class
, parent
, 0,
526 led_cdev
, led_cdev
->groups
, "%s", final_name
);
527 if (IS_ERR(led_cdev
->dev
)) {
528 mutex_unlock(&led_cdev
->led_access
);
529 return PTR_ERR(led_cdev
->dev
);
531 if (init_data
&& init_data
->fwnode
)
532 device_set_node(led_cdev
->dev
, init_data
->fwnode
);
534 if (led_cdev
->flags
& LED_BRIGHT_HW_CHANGED
) {
535 ret
= led_add_brightness_hw_changed(led_cdev
);
537 device_unregister(led_cdev
->dev
);
538 led_cdev
->dev
= NULL
;
539 mutex_unlock(&led_cdev
->led_access
);
544 led_cdev
->work_flags
= 0;
545 #ifdef CONFIG_LEDS_TRIGGERS
546 init_rwsem(&led_cdev
->trigger_lock
);
548 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
549 led_cdev
->brightness_hw_changed
= -1;
551 /* add to the list of leds */
552 down_write(&leds_list_lock
);
553 list_add_tail(&led_cdev
->node
, &leds_list
);
554 up_write(&leds_list_lock
);
556 if (!led_cdev
->max_brightness
)
557 led_cdev
->max_brightness
= LED_FULL
;
559 led_update_brightness(led_cdev
);
561 led_cdev
->wq
= leds_wq
;
563 led_init_core(led_cdev
);
565 #ifdef CONFIG_LEDS_TRIGGERS
566 led_trigger_set_default(led_cdev
);
569 mutex_unlock(&led_cdev
->led_access
);
571 dev_dbg(parent
, "Registered led device: %s\n",
576 EXPORT_SYMBOL_GPL(led_classdev_register_ext
);
579 * led_classdev_unregister - unregisters a object of led_properties class.
580 * @led_cdev: the led device to unregister
582 * Unregisters a previously registered via led_classdev_register object.
584 void led_classdev_unregister(struct led_classdev
*led_cdev
)
586 if (IS_ERR_OR_NULL(led_cdev
->dev
))
589 #ifdef CONFIG_LEDS_TRIGGERS
590 down_write(&led_cdev
->trigger_lock
);
591 if (led_cdev
->trigger
)
592 led_trigger_set(led_cdev
, NULL
);
593 up_write(&led_cdev
->trigger_lock
);
596 led_cdev
->flags
|= LED_UNREGISTERING
;
599 led_stop_software_blink(led_cdev
);
601 if (!(led_cdev
->flags
& LED_RETAIN_AT_SHUTDOWN
))
602 led_set_brightness(led_cdev
, LED_OFF
);
604 flush_work(&led_cdev
->set_brightness_work
);
606 if (led_cdev
->flags
& LED_BRIGHT_HW_CHANGED
)
607 led_remove_brightness_hw_changed(led_cdev
);
609 device_unregister(led_cdev
->dev
);
611 down_write(&leds_list_lock
);
612 list_del(&led_cdev
->node
);
613 up_write(&leds_list_lock
);
615 mutex_destroy(&led_cdev
->led_access
);
617 EXPORT_SYMBOL_GPL(led_classdev_unregister
);
619 static void devm_led_classdev_release(struct device
*dev
, void *res
)
621 led_classdev_unregister(*(struct led_classdev
**)res
);
625 * devm_led_classdev_register_ext - resource managed led_classdev_register_ext()
627 * @parent: parent of LED device
628 * @led_cdev: the led_classdev structure for this device.
629 * @init_data: LED class device initialization data
631 int devm_led_classdev_register_ext(struct device
*parent
,
632 struct led_classdev
*led_cdev
,
633 struct led_init_data
*init_data
)
635 struct led_classdev
**dr
;
638 dr
= devres_alloc(devm_led_classdev_release
, sizeof(*dr
), GFP_KERNEL
);
642 rc
= led_classdev_register_ext(parent
, led_cdev
, init_data
);
649 devres_add(parent
, dr
);
653 EXPORT_SYMBOL_GPL(devm_led_classdev_register_ext
);
655 static int devm_led_classdev_match(struct device
*dev
, void *res
, void *data
)
657 struct led_classdev
**p
= res
;
659 if (WARN_ON(!p
|| !*p
))
666 * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
667 * @dev: The device to unregister.
668 * @led_cdev: the led_classdev structure for this device.
670 void devm_led_classdev_unregister(struct device
*dev
,
671 struct led_classdev
*led_cdev
)
673 WARN_ON(devres_release(dev
,
674 devm_led_classdev_release
,
675 devm_led_classdev_match
, led_cdev
));
677 EXPORT_SYMBOL_GPL(devm_led_classdev_unregister
);
679 static int __init
leds_init(void)
681 leds_wq
= alloc_ordered_workqueue("leds", 0);
683 pr_err("Failed to create LEDs ordered workqueue\n");
687 return class_register(&leds_class
);
690 static void __exit
leds_exit(void)
692 class_unregister(&leds_class
);
693 destroy_workqueue(leds_wq
);
696 subsys_initcall(leds_init
);
697 module_exit(leds_exit
);
699 MODULE_AUTHOR("John Lenz, Richard Purdie");
700 MODULE_LICENSE("GPL");
701 MODULE_DESCRIPTION("LED Class Interface");