]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/leds/led-class.c
treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 499
[mirror_ubuntu-hirsute-kernel.git] / drivers / leds / led-class.c
CommitLineData
c72a1d60
RP
1/*
2 * LED Class Core
3 *
4 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
f8a7c6fe 5 * Copyright (C) 2005-2007 Richard Purdie <rpurdie@openedhand.com>
c72a1d60
RP
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
04713306
JA
12#include <linux/ctype.h>
13#include <linux/device.h>
14#include <linux/err.h>
c72a1d60 15#include <linux/init.h>
04713306
JA
16#include <linux/kernel.h>
17#include <linux/leds.h>
c72a1d60 18#include <linux/list.h>
04713306
JA
19#include <linux/module.h>
20#include <linux/slab.h>
c72a1d60 21#include <linux/spinlock.h>
9067359f 22#include <linux/timer.h>
eb1ce746 23#include <uapi/linux/uleds.h>
c72a1d60
RP
24#include "leds.h"
25
26static struct class *leds_class;
27
5baa7503 28static ssize_t brightness_show(struct device *dev,
f8a7c6fe 29 struct device_attribute *attr, char *buf)
c72a1d60 30{
f8a7c6fe 31 struct led_classdev *led_cdev = dev_get_drvdata(dev);
c72a1d60
RP
32
33 /* no lock needed for this */
29d76dfa 34 led_update_brightness(led_cdev);
c72a1d60 35
dd8e5a20 36 return sprintf(buf, "%u\n", led_cdev->brightness);
c72a1d60
RP
37}
38
5baa7503 39static ssize_t brightness_store(struct device *dev,
f8a7c6fe 40 struct device_attribute *attr, const char *buf, size_t size)
c72a1d60 41{
f8a7c6fe 42 struct led_classdev *led_cdev = dev_get_drvdata(dev);
872b86be 43 unsigned long state;
acd899e4
JA
44 ssize_t ret;
45
46 mutex_lock(&led_cdev->led_access);
47
48 if (led_sysfs_is_disabled(led_cdev)) {
49 ret = -EBUSY;
50 goto unlock;
51 }
c72a1d60 52
872b86be
SK
53 ret = kstrtoul(buf, 10, &state);
54 if (ret)
acd899e4 55 goto unlock;
3dc7b82e 56
872b86be
SK
57 if (state == LED_OFF)
58 led_trigger_remove(led_cdev);
4d71a4a1 59 led_set_brightness(led_cdev, state);
0db37915 60 flush_work(&led_cdev->set_brightness_work);
0013b23d 61
acd899e4
JA
62 ret = size;
63unlock:
64 mutex_unlock(&led_cdev->led_access);
65 return ret;
c72a1d60 66}
5baa7503 67static DEVICE_ATTR_RW(brightness);
c72a1d60 68
38419612 69static ssize_t max_brightness_show(struct device *dev,
1bd465e6
GL
70 struct device_attribute *attr, char *buf)
71{
72 struct led_classdev *led_cdev = dev_get_drvdata(dev);
73
74 return sprintf(buf, "%u\n", led_cdev->max_brightness);
75}
38419612 76static DEVICE_ATTR_RO(max_brightness);
1bd465e6 77
c3bc9956 78#ifdef CONFIG_LEDS_TRIGGERS
5baa7503
GKH
79static DEVICE_ATTR(trigger, 0644, led_trigger_show, led_trigger_store);
80static struct attribute *led_trigger_attrs[] = {
81 &dev_attr_trigger.attr,
82 NULL,
83};
84static const struct attribute_group led_trigger_group = {
85 .attrs = led_trigger_attrs,
86};
87#endif
88
89static struct attribute *led_class_attrs[] = {
90 &dev_attr_brightness.attr,
91 &dev_attr_max_brightness.attr,
92 NULL,
93};
94
95static const struct attribute_group led_group = {
96 .attrs = led_class_attrs,
97};
98
99static const struct attribute_group *led_groups[] = {
100 &led_group,
101#ifdef CONFIG_LEDS_TRIGGERS
102 &led_trigger_group,
c3bc9956 103#endif
5baa7503 104 NULL,
14b5d6dd 105};
c72a1d60 106
0cb8eb30
HG
107#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
108static ssize_t brightness_hw_changed_show(struct device *dev,
109 struct device_attribute *attr, char *buf)
110{
111 struct led_classdev *led_cdev = dev_get_drvdata(dev);
112
113 if (led_cdev->brightness_hw_changed == -1)
114 return -ENODATA;
115
116 return sprintf(buf, "%u\n", led_cdev->brightness_hw_changed);
117}
118
119static DEVICE_ATTR_RO(brightness_hw_changed);
120
121static int led_add_brightness_hw_changed(struct led_classdev *led_cdev)
122{
123 struct device *dev = led_cdev->dev;
124 int ret;
125
126 ret = device_create_file(dev, &dev_attr_brightness_hw_changed);
127 if (ret) {
128 dev_err(dev, "Error creating brightness_hw_changed\n");
129 return ret;
130 }
131
132 led_cdev->brightness_hw_changed_kn =
133 sysfs_get_dirent(dev->kobj.sd, "brightness_hw_changed");
134 if (!led_cdev->brightness_hw_changed_kn) {
135 dev_err(dev, "Error getting brightness_hw_changed kn\n");
136 device_remove_file(dev, &dev_attr_brightness_hw_changed);
137 return -ENXIO;
138 }
139
140 return 0;
141}
142
143static void led_remove_brightness_hw_changed(struct led_classdev *led_cdev)
144{
145 sysfs_put(led_cdev->brightness_hw_changed_kn);
146 device_remove_file(led_cdev->dev, &dev_attr_brightness_hw_changed);
147}
148
149void led_classdev_notify_brightness_hw_changed(struct led_classdev *led_cdev,
150 enum led_brightness brightness)
151{
152 if (WARN_ON(!led_cdev->brightness_hw_changed_kn))
153 return;
154
155 led_cdev->brightness_hw_changed = brightness;
156 sysfs_notify_dirent(led_cdev->brightness_hw_changed_kn);
157}
158EXPORT_SYMBOL_GPL(led_classdev_notify_brightness_hw_changed);
159#else
160static int led_add_brightness_hw_changed(struct led_classdev *led_cdev)
161{
162 return 0;
163}
164static void led_remove_brightness_hw_changed(struct led_classdev *led_cdev)
165{
166}
167#endif
168
c72a1d60
RP
169/**
170 * led_classdev_suspend - suspend an led_classdev.
171 * @led_cdev: the led_classdev to suspend.
172 */
173void led_classdev_suspend(struct led_classdev *led_cdev)
174{
175 led_cdev->flags |= LED_SUSPENDED;
81fe8e5b 176 led_set_brightness_nopm(led_cdev, 0);
c72a1d60
RP
177}
178EXPORT_SYMBOL_GPL(led_classdev_suspend);
179
180/**
181 * led_classdev_resume - resume an led_classdev.
182 * @led_cdev: the led_classdev to resume.
183 */
184void led_classdev_resume(struct led_classdev *led_cdev)
185{
81fe8e5b 186 led_set_brightness_nopm(led_cdev, led_cdev->brightness);
7aea8389
JA
187
188 if (led_cdev->flash_resume)
189 led_cdev->flash_resume(led_cdev);
190
c72a1d60
RP
191 led_cdev->flags &= ~LED_SUSPENDED;
192}
193EXPORT_SYMBOL_GPL(led_classdev_resume);
194
084609bf 195#ifdef CONFIG_PM_SLEEP
73e1ab41 196static int led_suspend(struct device *dev)
859cb7f2
RP
197{
198 struct led_classdev *led_cdev = dev_get_drvdata(dev);
199
200 if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
201 led_classdev_suspend(led_cdev);
202
203 return 0;
204}
205
206static int led_resume(struct device *dev)
207{
208 struct led_classdev *led_cdev = dev_get_drvdata(dev);
209
210 if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
211 led_classdev_resume(led_cdev);
212
213 return 0;
214}
084609bf 215#endif
859cb7f2 216
084609bf 217static SIMPLE_DEV_PM_OPS(leds_class_dev_pm_ops, led_suspend, led_resume);
73e1ab41 218
a96aa64c
RR
219static int match_name(struct device *dev, const void *data)
220{
221 if (!dev_name(dev))
222 return 0;
223 return !strcmp(dev_name(dev), (char *)data);
224}
225
226static int led_classdev_next_name(const char *init_name, char *name,
227 size_t len)
228{
229 unsigned int i = 0;
230 int ret = 0;
e5b5a61f 231 struct device *dev;
a96aa64c
RR
232
233 strlcpy(name, init_name, len);
234
e5b5a61f
RR
235 while ((ret < len) &&
236 (dev = class_find_device(leds_class, NULL, name, match_name))) {
237 put_device(dev);
a96aa64c 238 ret = snprintf(name, len, "%s_%u", init_name, ++i);
e5b5a61f 239 }
a96aa64c
RR
240
241 if (ret >= len)
242 return -ENOMEM;
243
244 return i;
245}
246
c72a1d60 247/**
442c6098
RM
248 * of_led_classdev_register - register a new object of led_classdev class.
249 *
250 * @parent: parent of LED device
c72a1d60 251 * @led_cdev: the led_classdev structure for this device.
442c6098 252 * @np: DT node describing this LED
c72a1d60 253 */
442c6098
RM
254int of_led_classdev_register(struct device *parent, struct device_node *np,
255 struct led_classdev *led_cdev)
c72a1d60 256{
eb1ce746 257 char name[LED_MAX_NAME_SIZE];
a96aa64c
RR
258 int ret;
259
260 ret = led_classdev_next_name(led_cdev->name, name, sizeof(name));
261 if (ret < 0)
262 return ret;
263
6d71021a
LH
264 mutex_init(&led_cdev->led_access);
265 mutex_lock(&led_cdev->led_access);
d0d480cc 266 led_cdev->dev = device_create_with_groups(leds_class, parent, 0,
ccdc4507 267 led_cdev, led_cdev->groups, "%s", name);
6d71021a
LH
268 if (IS_ERR(led_cdev->dev)) {
269 mutex_unlock(&led_cdev->led_access);
f8a7c6fe 270 return PTR_ERR(led_cdev->dev);
6d71021a 271 }
442c6098 272 led_cdev->dev->of_node = np;
c72a1d60 273
a96aa64c 274 if (ret)
6f06c7f8 275 dev_warn(parent, "Led %s renamed to %s due to name collision",
a96aa64c
RR
276 led_cdev->name, dev_name(led_cdev->dev));
277
0cb8eb30
HG
278 if (led_cdev->flags & LED_BRIGHT_HW_CHANGED) {
279 ret = led_add_brightness_hw_changed(led_cdev);
280 if (ret) {
281 device_unregister(led_cdev->dev);
6d71021a 282 mutex_unlock(&led_cdev->led_access);
0cb8eb30
HG
283 return ret;
284 }
285 }
286
a9c6ce57 287 led_cdev->work_flags = 0;
270c3957
RP
288#ifdef CONFIG_LEDS_TRIGGERS
289 init_rwsem(&led_cdev->trigger_lock);
0cb8eb30
HG
290#endif
291#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
292 led_cdev->brightness_hw_changed = -1;
270c3957 293#endif
c72a1d60 294 /* add to the list of leds */
72f8da32 295 down_write(&leds_list_lock);
c72a1d60 296 list_add_tail(&led_cdev->node, &leds_list);
72f8da32 297 up_write(&leds_list_lock);
c72a1d60 298
1bd465e6
GL
299 if (!led_cdev->max_brightness)
300 led_cdev->max_brightness = LED_FULL;
301
29d76dfa
HMH
302 led_update_brightness(led_cdev);
303
757b06ae 304 led_init_core(led_cdev);
5ada28bf 305
c3bc9956 306#ifdef CONFIG_LEDS_TRIGGERS
12fda168 307 led_trigger_set_default(led_cdev);
c3bc9956
RP
308#endif
309
6d71021a
LH
310 mutex_unlock(&led_cdev->led_access);
311
d23e7b8b 312 dev_dbg(parent, "Registered led device: %s\n",
f8a7c6fe 313 led_cdev->name);
c72a1d60
RP
314
315 return 0;
316}
442c6098 317EXPORT_SYMBOL_GPL(of_led_classdev_register);
c72a1d60
RP
318
319/**
0266a458 320 * led_classdev_unregister - unregisters a object of led_properties class.
70d63ccc 321 * @led_cdev: the led device to unregister
c72a1d60
RP
322 *
323 * Unregisters a previously registered via led_classdev_register object.
324 */
b844eba2 325void led_classdev_unregister(struct led_classdev *led_cdev)
c72a1d60 326{
c3bc9956 327#ifdef CONFIG_LEDS_TRIGGERS
dc47206e 328 down_write(&led_cdev->trigger_lock);
c3bc9956
RP
329 if (led_cdev->trigger)
330 led_trigger_set(led_cdev, NULL);
dc47206e 331 up_write(&led_cdev->trigger_lock);
c3bc9956 332#endif
c72a1d60 333
d84d80f3
HK
334 led_cdev->flags |= LED_UNREGISTERING;
335
5ada28bf 336 /* Stop blinking */
d23a22a7 337 led_stop_software_blink(led_cdev);
d1aa577f 338
19cd67e2 339 led_set_brightness(led_cdev, LED_OFF);
5ada28bf 340
d1aa577f
MK
341 flush_work(&led_cdev->set_brightness_work);
342
0cb8eb30
HG
343 if (led_cdev->flags & LED_BRIGHT_HW_CHANGED)
344 led_remove_brightness_hw_changed(led_cdev);
345
b844eba2 346 device_unregister(led_cdev->dev);
c72a1d60 347
72f8da32 348 down_write(&leds_list_lock);
c72a1d60 349 list_del(&led_cdev->node);
72f8da32 350 up_write(&leds_list_lock);
acd899e4
JA
351
352 mutex_destroy(&led_cdev->led_access);
c72a1d60 353}
b844eba2 354EXPORT_SYMBOL_GPL(led_classdev_unregister);
c72a1d60 355
ca1bb4ee
BA
356static void devm_led_classdev_release(struct device *dev, void *res)
357{
358 led_classdev_unregister(*(struct led_classdev **)res);
359}
360
361/**
442c6098
RM
362 * devm_of_led_classdev_register - resource managed led_classdev_register()
363 *
364 * @parent: parent of LED device
ca1bb4ee
BA
365 * @led_cdev: the led_classdev structure for this device.
366 */
442c6098
RM
367int devm_of_led_classdev_register(struct device *parent,
368 struct device_node *np,
369 struct led_classdev *led_cdev)
ca1bb4ee
BA
370{
371 struct led_classdev **dr;
372 int rc;
373
374 dr = devres_alloc(devm_led_classdev_release, sizeof(*dr), GFP_KERNEL);
375 if (!dr)
376 return -ENOMEM;
377
442c6098 378 rc = of_led_classdev_register(parent, np, led_cdev);
ca1bb4ee
BA
379 if (rc) {
380 devres_free(dr);
381 return rc;
382 }
383
384 *dr = led_cdev;
385 devres_add(parent, dr);
386
387 return 0;
388}
442c6098 389EXPORT_SYMBOL_GPL(devm_of_led_classdev_register);
ca1bb4ee
BA
390
391static int devm_led_classdev_match(struct device *dev, void *res, void *data)
392{
393 struct led_cdev **p = res;
394
395 if (WARN_ON(!p || !*p))
396 return 0;
397
398 return *p == data;
399}
400
401/**
402 * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
403 * @parent: The device to unregister.
404 * @led_cdev: the led_classdev structure for this device.
405 */
406void devm_led_classdev_unregister(struct device *dev,
407 struct led_classdev *led_cdev)
408{
409 WARN_ON(devres_release(dev,
410 devm_led_classdev_release,
411 devm_led_classdev_match, led_cdev));
412}
413EXPORT_SYMBOL_GPL(devm_led_classdev_unregister);
414
c72a1d60
RP
415static int __init leds_init(void)
416{
417 leds_class = class_create(THIS_MODULE, "leds");
418 if (IS_ERR(leds_class))
419 return PTR_ERR(leds_class);
73e1ab41 420 leds_class->pm = &leds_class_dev_pm_ops;
5baa7503 421 leds_class->dev_groups = led_groups;
c72a1d60
RP
422 return 0;
423}
424
425static void __exit leds_exit(void)
426{
427 class_destroy(leds_class);
428}
429
430subsys_initcall(leds_init);
431module_exit(leds_exit);
432
433MODULE_AUTHOR("John Lenz, Richard Purdie");
434MODULE_LICENSE("GPL");
435MODULE_DESCRIPTION("LED Class Interface");