blob: 14139c337312c574c82a98bee4c163834cad6bc5 [file] [log] [blame]
Richard Purdiec72a1d62006-03-31 02:31:04 -08001/*
2 * LED Class Core
3 *
4 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
Richard Purdief8a7c6f2007-07-08 23:19:31 +01005 * Copyright (C) 2005-2007 Richard Purdie <rpurdie@openedhand.com>
Richard Purdiec72a1d62006-03-31 02:31:04 -08006 *
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
Richard Purdie3dc7b822006-05-15 09:44:17 -070012#include <linux/ctype.h>
Jacek Anaszewski04713302014-08-07 05:10:22 -070013#include <linux/device.h>
14#include <linux/err.h>
15#include <linux/init.h>
16#include <linux/kernel.h>
Richard Purdiec72a1d62006-03-31 02:31:04 -080017#include <linux/leds.h>
Jacek Anaszewski04713302014-08-07 05:10:22 -070018#include <linux/list.h>
19#include <linux/module.h>
20#include <linux/slab.h>
21#include <linux/spinlock.h>
22#include <linux/timer.h>
Richard Purdiec72a1d62006-03-31 02:31:04 -080023#include "leds.h"
24
25static struct class *leds_class;
26
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -070027static ssize_t brightness_show(struct device *dev,
Richard Purdief8a7c6f2007-07-08 23:19:31 +010028 struct device_attribute *attr, char *buf)
Richard Purdiec72a1d62006-03-31 02:31:04 -080029{
Richard Purdief8a7c6f2007-07-08 23:19:31 +010030 struct led_classdev *led_cdev = dev_get_drvdata(dev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080031
32 /* no lock needed for this */
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +000033 led_update_brightness(led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080034
Sven Wegenerdd8e5a22008-10-13 10:41:39 +010035 return sprintf(buf, "%u\n", led_cdev->brightness);
Richard Purdiec72a1d62006-03-31 02:31:04 -080036}
37
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -070038static ssize_t brightness_store(struct device *dev,
Richard Purdief8a7c6f2007-07-08 23:19:31 +010039 struct device_attribute *attr, const char *buf, size_t size)
Richard Purdiec72a1d62006-03-31 02:31:04 -080040{
Richard Purdief8a7c6f2007-07-08 23:19:31 +010041 struct led_classdev *led_cdev = dev_get_drvdata(dev);
Shuah Khan872b86b2012-05-29 15:07:26 -070042 unsigned long state;
Jacek Anaszewskiacd899e2014-09-22 08:21:04 -070043 ssize_t ret;
44
45 mutex_lock(&led_cdev->led_access);
46
47 if (led_sysfs_is_disabled(led_cdev)) {
48 ret = -EBUSY;
49 goto unlock;
50 }
Richard Purdiec72a1d62006-03-31 02:31:04 -080051
Shuah Khan872b86b2012-05-29 15:07:26 -070052 ret = kstrtoul(buf, 10, &state);
53 if (ret)
Jacek Anaszewskiacd899e2014-09-22 08:21:04 -070054 goto unlock;
Richard Purdie3dc7b822006-05-15 09:44:17 -070055
Shuah Khan872b86b2012-05-29 15:07:26 -070056 if (state == LED_OFF)
57 led_trigger_remove(led_cdev);
Jacek Anaszewski4d71a4a2014-11-14 02:50:18 -080058 led_set_brightness(led_cdev, state);
Németh Márton0013b232008-03-09 20:54:37 +000059
Jacek Anaszewskiacd899e2014-09-22 08:21:04 -070060 ret = size;
61unlock:
62 mutex_unlock(&led_cdev->led_access);
63 return ret;
Richard Purdiec72a1d62006-03-31 02:31:04 -080064}
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -070065static DEVICE_ATTR_RW(brightness);
Richard Purdiec72a1d62006-03-31 02:31:04 -080066
Jacek Anaszewski384196122014-08-07 05:10:24 -070067static ssize_t max_brightness_show(struct device *dev,
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +000068 struct device_attribute *attr, char *buf)
69{
70 struct led_classdev *led_cdev = dev_get_drvdata(dev);
71
72 return sprintf(buf, "%u\n", led_cdev->max_brightness);
73}
Jacek Anaszewski384196122014-08-07 05:10:24 -070074static DEVICE_ATTR_RO(max_brightness);
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +000075
Richard Purdiec3bc9952006-03-31 02:31:05 -080076#ifdef CONFIG_LEDS_TRIGGERS
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -070077static DEVICE_ATTR(trigger, 0644, led_trigger_show, led_trigger_store);
78static struct attribute *led_trigger_attrs[] = {
79 &dev_attr_trigger.attr,
80 NULL,
81};
82static const struct attribute_group led_trigger_group = {
83 .attrs = led_trigger_attrs,
84};
Richard Purdiec3bc9952006-03-31 02:31:05 -080085#endif
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -070086
87static struct attribute *led_class_attrs[] = {
88 &dev_attr_brightness.attr,
89 &dev_attr_max_brightness.attr,
90 NULL,
91};
92
93static const struct attribute_group led_group = {
94 .attrs = led_class_attrs,
95};
96
97static const struct attribute_group *led_groups[] = {
98 &led_group,
99#ifdef CONFIG_LEDS_TRIGGERS
100 &led_trigger_group,
101#endif
102 NULL,
Florian Fainelli14b5d6d2010-03-10 18:32:18 +0100103};
Richard Purdiec72a1d62006-03-31 02:31:04 -0800104
105/**
106 * led_classdev_suspend - suspend an led_classdev.
107 * @led_cdev: the led_classdev to suspend.
108 */
109void led_classdev_suspend(struct led_classdev *led_cdev)
110{
111 led_cdev->flags |= LED_SUSPENDED;
Jacek Anaszewski81fe8e52015-10-07 11:10:41 +0200112 led_set_brightness_nopm(led_cdev, 0);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800113}
114EXPORT_SYMBOL_GPL(led_classdev_suspend);
115
116/**
117 * led_classdev_resume - resume an led_classdev.
118 * @led_cdev: the led_classdev to resume.
119 */
120void led_classdev_resume(struct led_classdev *led_cdev)
121{
Jacek Anaszewski81fe8e52015-10-07 11:10:41 +0200122 led_set_brightness_nopm(led_cdev, led_cdev->brightness);
Jacek Anaszewski7aea8382015-01-09 07:22:51 -0800123
124 if (led_cdev->flash_resume)
125 led_cdev->flash_resume(led_cdev);
126
Richard Purdiec72a1d62006-03-31 02:31:04 -0800127 led_cdev->flags &= ~LED_SUSPENDED;
128}
129EXPORT_SYMBOL_GPL(led_classdev_resume);
130
Grygorii Strashko084609b2015-04-24 14:57:10 +0300131#ifdef CONFIG_PM_SLEEP
Shuah Khan73e1ab42013-06-20 12:08:44 -0700132static int led_suspend(struct device *dev)
Richard Purdie859cb7f2009-01-08 17:55:03 +0000133{
134 struct led_classdev *led_cdev = dev_get_drvdata(dev);
135
136 if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
137 led_classdev_suspend(led_cdev);
138
139 return 0;
140}
141
142static int led_resume(struct device *dev)
143{
144 struct led_classdev *led_cdev = dev_get_drvdata(dev);
145
146 if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
147 led_classdev_resume(led_cdev);
148
149 return 0;
150}
Grygorii Strashko084609b2015-04-24 14:57:10 +0300151#endif
Richard Purdie859cb7f2009-01-08 17:55:03 +0000152
Grygorii Strashko084609b2015-04-24 14:57:10 +0300153static SIMPLE_DEV_PM_OPS(leds_class_dev_pm_ops, led_suspend, led_resume);
Shuah Khan73e1ab42013-06-20 12:08:44 -0700154
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700155static int match_name(struct device *dev, const void *data)
156{
157 if (!dev_name(dev))
158 return 0;
159 return !strcmp(dev_name(dev), (char *)data);
160}
161
162static int led_classdev_next_name(const char *init_name, char *name,
163 size_t len)
164{
165 unsigned int i = 0;
166 int ret = 0;
Ricardo Ribalda Delgadoe5b5a612015-07-31 13:36:21 +0200167 struct device *dev;
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700168
169 strlcpy(name, init_name, len);
170
Ricardo Ribalda Delgadoe5b5a612015-07-31 13:36:21 +0200171 while ((ret < len) &&
172 (dev = class_find_device(leds_class, NULL, name, match_name))) {
173 put_device(dev);
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700174 ret = snprintf(name, len, "%s_%u", init_name, ++i);
Ricardo Ribalda Delgadoe5b5a612015-07-31 13:36:21 +0200175 }
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700176
177 if (ret >= len)
178 return -ENOMEM;
179
180 return i;
181}
182
Richard Purdiec72a1d62006-03-31 02:31:04 -0800183/**
184 * led_classdev_register - register a new object of led_classdev class.
Sven Wegenerff8649a2008-12-03 08:04:57 +0000185 * @parent: The device to register.
Richard Purdiec72a1d62006-03-31 02:31:04 -0800186 * @led_cdev: the led_classdev structure for this device.
187 */
188int led_classdev_register(struct device *parent, struct led_classdev *led_cdev)
189{
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700190 char name[64];
191 int ret;
192
193 ret = led_classdev_next_name(led_cdev->name, name, sizeof(name));
194 if (ret < 0)
195 return ret;
196
Johan Hovoldd0d480c2014-06-25 10:08:44 -0700197 led_cdev->dev = device_create_with_groups(leds_class, parent, 0,
Sakari Ailusccdc4502015-03-26 16:42:06 -0700198 led_cdev, led_cdev->groups, "%s", name);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -0700199 if (IS_ERR(led_cdev->dev))
Richard Purdief8a7c6f2007-07-08 23:19:31 +0100200 return PTR_ERR(led_cdev->dev);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800201
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700202 if (ret)
Sakari Ailus6f06c7f2015-03-26 16:42:05 -0700203 dev_warn(parent, "Led %s renamed to %s due to name collision",
Ricardo Ribalda Delgadoa96aa642015-03-30 10:45:59 -0700204 led_cdev->name, dev_name(led_cdev->dev));
205
Richard Purdie270c3952008-10-20 23:16:17 +0100206#ifdef CONFIG_LEDS_TRIGGERS
207 init_rwsem(&led_cdev->trigger_lock);
208#endif
Jacek Anaszewskiacd899e2014-09-22 08:21:04 -0700209 mutex_init(&led_cdev->led_access);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800210 /* add to the list of leds */
Richard Purdie72f8da32007-12-31 23:09:44 +0000211 down_write(&leds_list_lock);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800212 list_add_tail(&led_cdev->node, &leds_list);
Richard Purdie72f8da32007-12-31 23:09:44 +0000213 up_write(&leds_list_lock);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800214
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +0000215 if (!led_cdev->max_brightness)
216 led_cdev->max_brightness = LED_FULL;
217
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +0000218 led_update_brightness(led_cdev);
219
Jacek Anaszewski757b06a2015-09-28 14:38:04 +0200220 led_init_core(led_cdev);
Johannes Berg5ada28b2010-11-11 14:05:21 -0800221
Richard Purdiec3bc9952006-03-31 02:31:05 -0800222#ifdef CONFIG_LEDS_TRIGGERS
Jeff Garzik12fda162006-10-17 00:10:20 -0700223 led_trigger_set_default(led_cdev);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800224#endif
225
Sachin Kamatd23e7b82012-11-25 10:57:35 +0530226 dev_dbg(parent, "Registered led device: %s\n",
Richard Purdief8a7c6f2007-07-08 23:19:31 +0100227 led_cdev->name);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800228
229 return 0;
230}
231EXPORT_SYMBOL_GPL(led_classdev_register);
232
233/**
Qinghuang Feng0266a452008-10-20 23:04:36 +0100234 * led_classdev_unregister - unregisters a object of led_properties class.
Henrik Kretzschmar70d63cc2006-10-03 23:31:30 +0200235 * @led_cdev: the led device to unregister
Richard Purdiec72a1d62006-03-31 02:31:04 -0800236 *
237 * Unregisters a previously registered via led_classdev_register object.
238 */
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100239void led_classdev_unregister(struct led_classdev *led_cdev)
Richard Purdiec72a1d62006-03-31 02:31:04 -0800240{
Richard Purdiec3bc9952006-03-31 02:31:05 -0800241#ifdef CONFIG_LEDS_TRIGGERS
Richard Purdiedc472062007-11-10 13:29:04 +0000242 down_write(&led_cdev->trigger_lock);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800243 if (led_cdev->trigger)
244 led_trigger_set(led_cdev, NULL);
Richard Purdiedc472062007-11-10 13:29:04 +0000245 up_write(&led_cdev->trigger_lock);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800246#endif
Richard Purdiec72a1d62006-03-31 02:31:04 -0800247
Johannes Berg5ada28b2010-11-11 14:05:21 -0800248 /* Stop blinking */
Fabio Baltierid23a22a2012-08-15 21:44:34 +0800249 led_stop_software_blink(led_cdev);
Milo Kimd1aa5772015-11-20 17:03:00 +0900250
Shuah Khan19cd67e2012-06-14 04:34:30 +0800251 led_set_brightness(led_cdev, LED_OFF);
Johannes Berg5ada28b2010-11-11 14:05:21 -0800252
Milo Kimd1aa5772015-11-20 17:03:00 +0900253 flush_work(&led_cdev->set_brightness_work);
254
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100255 device_unregister(led_cdev->dev);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800256
Richard Purdie72f8da32007-12-31 23:09:44 +0000257 down_write(&leds_list_lock);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800258 list_del(&led_cdev->node);
Richard Purdie72f8da32007-12-31 23:09:44 +0000259 up_write(&leds_list_lock);
Jacek Anaszewskiacd899e2014-09-22 08:21:04 -0700260
261 mutex_destroy(&led_cdev->led_access);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800262}
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100263EXPORT_SYMBOL_GPL(led_classdev_unregister);
Richard Purdiec72a1d62006-03-31 02:31:04 -0800264
Bjorn Anderssonca1bb4e2015-02-23 16:11:41 -0800265static void devm_led_classdev_release(struct device *dev, void *res)
266{
267 led_classdev_unregister(*(struct led_classdev **)res);
268}
269
270/**
271 * devm_led_classdev_register - resource managed led_classdev_register()
272 * @parent: The device to register.
273 * @led_cdev: the led_classdev structure for this device.
274 */
275int devm_led_classdev_register(struct device *parent,
276 struct led_classdev *led_cdev)
277{
278 struct led_classdev **dr;
279 int rc;
280
281 dr = devres_alloc(devm_led_classdev_release, sizeof(*dr), GFP_KERNEL);
282 if (!dr)
283 return -ENOMEM;
284
285 rc = led_classdev_register(parent, led_cdev);
286 if (rc) {
287 devres_free(dr);
288 return rc;
289 }
290
291 *dr = led_cdev;
292 devres_add(parent, dr);
293
294 return 0;
295}
296EXPORT_SYMBOL_GPL(devm_led_classdev_register);
297
298static int devm_led_classdev_match(struct device *dev, void *res, void *data)
299{
300 struct led_cdev **p = res;
301
302 if (WARN_ON(!p || !*p))
303 return 0;
304
305 return *p == data;
306}
307
308/**
309 * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
310 * @parent: The device to unregister.
311 * @led_cdev: the led_classdev structure for this device.
312 */
313void devm_led_classdev_unregister(struct device *dev,
314 struct led_classdev *led_cdev)
315{
316 WARN_ON(devres_release(dev,
317 devm_led_classdev_release,
318 devm_led_classdev_match, led_cdev));
319}
320EXPORT_SYMBOL_GPL(devm_led_classdev_unregister);
321
Richard Purdiec72a1d62006-03-31 02:31:04 -0800322static int __init leds_init(void)
323{
324 leds_class = class_create(THIS_MODULE, "leds");
325 if (IS_ERR(leds_class))
326 return PTR_ERR(leds_class);
Shuah Khan73e1ab42013-06-20 12:08:44 -0700327 leds_class->pm = &leds_class_dev_pm_ops;
Greg Kroah-Hartman5baa7502013-07-24 15:05:13 -0700328 leds_class->dev_groups = led_groups;
Richard Purdiec72a1d62006-03-31 02:31:04 -0800329 return 0;
330}
331
332static void __exit leds_exit(void)
333{
334 class_destroy(leds_class);
335}
336
337subsys_initcall(leds_init);
338module_exit(leds_exit);
339
340MODULE_AUTHOR("John Lenz, Richard Purdie");
341MODULE_LICENSE("GPL");
342MODULE_DESCRIPTION("LED Class Interface");