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