led-class.c 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. /*
  2. * LED Class Core
  3. *
  4. * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
  5. * Copyright (C) 2005-2007 Richard Purdie <rpurdie@openedhand.com>
  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. #include <linux/ctype.h>
  12. #include <linux/device.h>
  13. #include <linux/err.h>
  14. #include <linux/init.h>
  15. #include <linux/kernel.h>
  16. #include <linux/leds.h>
  17. #include <linux/list.h>
  18. #include <linux/module.h>
  19. #include <linux/slab.h>
  20. #include <linux/spinlock.h>
  21. #include <linux/timer.h>
  22. #include <linux/of.h>
  23. #include "leds.h"
  24. static struct class *leds_class;
  25. static ssize_t brightness_show(struct device *dev,
  26. struct device_attribute *attr, char *buf)
  27. {
  28. struct led_classdev *led_cdev = dev_get_drvdata(dev);
  29. /* no lock needed for this */
  30. led_update_brightness(led_cdev);
  31. return sprintf(buf, "%u\n", led_cdev->brightness);
  32. }
  33. static ssize_t brightness_store(struct device *dev,
  34. struct device_attribute *attr, const char *buf, size_t size)
  35. {
  36. struct led_classdev *led_cdev = dev_get_drvdata(dev);
  37. unsigned long state;
  38. ssize_t ret;
  39. mutex_lock(&led_cdev->led_access);
  40. if (led_sysfs_is_disabled(led_cdev)) {
  41. ret = -EBUSY;
  42. goto unlock;
  43. }
  44. ret = kstrtoul(buf, 10, &state);
  45. if (ret)
  46. goto unlock;
  47. if (state == LED_OFF)
  48. led_trigger_remove(led_cdev);
  49. led_set_brightness(led_cdev, state);
  50. ret = size;
  51. unlock:
  52. mutex_unlock(&led_cdev->led_access);
  53. return ret;
  54. }
  55. static DEVICE_ATTR_RW(brightness);
  56. static ssize_t max_brightness_show(struct device *dev,
  57. struct device_attribute *attr, char *buf)
  58. {
  59. struct led_classdev *led_cdev = dev_get_drvdata(dev);
  60. return sprintf(buf, "%u\n", led_cdev->max_brightness);
  61. }
  62. static DEVICE_ATTR_RO(max_brightness);
  63. #ifdef CONFIG_LEDS_TRIGGERS
  64. static DEVICE_ATTR(trigger, 0644, led_trigger_show, led_trigger_store);
  65. static struct attribute *led_trigger_attrs[] = {
  66. &dev_attr_trigger.attr,
  67. NULL,
  68. };
  69. static const struct attribute_group led_trigger_group = {
  70. .attrs = led_trigger_attrs,
  71. };
  72. #endif
  73. static struct attribute *led_class_attrs[] = {
  74. &dev_attr_brightness.attr,
  75. &dev_attr_max_brightness.attr,
  76. NULL,
  77. };
  78. static const struct attribute_group led_group = {
  79. .attrs = led_class_attrs,
  80. };
  81. static const struct attribute_group *led_groups[] = {
  82. &led_group,
  83. #ifdef CONFIG_LEDS_TRIGGERS
  84. &led_trigger_group,
  85. #endif
  86. NULL,
  87. };
  88. /**
  89. * led_classdev_suspend - suspend an led_classdev.
  90. * @led_cdev: the led_classdev to suspend.
  91. */
  92. void led_classdev_suspend(struct led_classdev *led_cdev)
  93. {
  94. led_cdev->flags |= LED_SUSPENDED;
  95. led_set_brightness_nopm(led_cdev, 0);
  96. }
  97. EXPORT_SYMBOL_GPL(led_classdev_suspend);
  98. /**
  99. * led_classdev_resume - resume an led_classdev.
  100. * @led_cdev: the led_classdev to resume.
  101. */
  102. void led_classdev_resume(struct led_classdev *led_cdev)
  103. {
  104. led_set_brightness_nopm(led_cdev, led_cdev->brightness);
  105. if (led_cdev->flash_resume)
  106. led_cdev->flash_resume(led_cdev);
  107. led_cdev->flags &= ~LED_SUSPENDED;
  108. }
  109. EXPORT_SYMBOL_GPL(led_classdev_resume);
  110. #ifdef CONFIG_PM_SLEEP
  111. static int led_suspend(struct device *dev)
  112. {
  113. struct led_classdev *led_cdev = dev_get_drvdata(dev);
  114. if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
  115. led_classdev_suspend(led_cdev);
  116. return 0;
  117. }
  118. static int led_resume(struct device *dev)
  119. {
  120. struct led_classdev *led_cdev = dev_get_drvdata(dev);
  121. if (led_cdev->flags & LED_CORE_SUSPENDRESUME)
  122. led_classdev_resume(led_cdev);
  123. return 0;
  124. }
  125. #endif
  126. static SIMPLE_DEV_PM_OPS(leds_class_dev_pm_ops, led_suspend, led_resume);
  127. /* find OF node for the given led_cdev */
  128. static struct device_node *find_led_of_node(struct led_classdev *led_cdev)
  129. {
  130. struct device *led_dev = led_cdev->dev;
  131. struct device_node *child;
  132. for_each_child_of_node(led_dev->parent->of_node, child) {
  133. if (of_property_match_string(child, "label", led_cdev->name) == 0)
  134. return child;
  135. }
  136. return NULL;
  137. }
  138. static int led_match_led_node(struct device *led_dev, const void *data)
  139. {
  140. struct led_classdev *led_cdev = dev_get_drvdata(led_dev);
  141. const struct device_node *target_node = data;
  142. struct device_node *led_node;
  143. led_node = find_led_of_node(led_cdev);
  144. if (!led_node)
  145. return 0;
  146. of_node_put(led_node);
  147. return led_node == target_node ? 1 : 0;
  148. }
  149. /**
  150. * of_led_get() - request a LED device via the LED framework
  151. * @np: device node to get the LED device from
  152. *
  153. * Returns the LED device parsed from the phandle specified in the "leds"
  154. * property of a device tree node or a negative error-code on failure.
  155. */
  156. struct led_classdev *of_led_get(struct device_node *np)
  157. {
  158. struct device *led_dev;
  159. struct led_classdev *led_cdev;
  160. struct device_node *led_node;
  161. led_node = of_parse_phandle(np, "leds", 0);
  162. if (!led_node)
  163. return ERR_PTR(-ENODEV);
  164. led_dev = class_find_device(leds_class, NULL, led_node,
  165. led_match_led_node);
  166. if (!led_dev) {
  167. of_node_put(led_node);
  168. return ERR_PTR(-EPROBE_DEFER);
  169. }
  170. of_node_put(led_node);
  171. led_cdev = dev_get_drvdata(led_dev);
  172. if (!try_module_get(led_cdev->dev->parent->driver->owner))
  173. return ERR_PTR(-ENODEV);
  174. return led_cdev;
  175. }
  176. EXPORT_SYMBOL_GPL(of_led_get);
  177. /**
  178. * led_put() - release a LED device
  179. * @led_cdev: LED device
  180. */
  181. void led_put(struct led_classdev *led_cdev)
  182. {
  183. module_put(led_cdev->dev->parent->driver->owner);
  184. }
  185. EXPORT_SYMBOL_GPL(led_put);
  186. static int match_name(struct device *dev, const void *data)
  187. {
  188. if (!dev_name(dev))
  189. return 0;
  190. return !strcmp(dev_name(dev), (char *)data);
  191. }
  192. static int led_classdev_next_name(const char *init_name, char *name,
  193. size_t len)
  194. {
  195. unsigned int i = 0;
  196. int ret = 0;
  197. struct device *dev;
  198. strlcpy(name, init_name, len);
  199. while ((ret < len) &&
  200. (dev = class_find_device(leds_class, NULL, name, match_name))) {
  201. put_device(dev);
  202. ret = snprintf(name, len, "%s_%u", init_name, ++i);
  203. }
  204. if (ret >= len)
  205. return -ENOMEM;
  206. return i;
  207. }
  208. /**
  209. * led_classdev_register - register a new object of led_classdev class.
  210. * @parent: The device to register.
  211. * @led_cdev: the led_classdev structure for this device.
  212. */
  213. int led_classdev_register(struct device *parent, struct led_classdev *led_cdev)
  214. {
  215. char name[64];
  216. int ret;
  217. ret = led_classdev_next_name(led_cdev->name, name, sizeof(name));
  218. if (ret < 0)
  219. return ret;
  220. led_cdev->dev = device_create_with_groups(leds_class, parent, 0,
  221. led_cdev, led_cdev->groups, "%s", name);
  222. if (IS_ERR(led_cdev->dev))
  223. return PTR_ERR(led_cdev->dev);
  224. if (ret)
  225. dev_warn(parent, "Led %s renamed to %s due to name collision",
  226. led_cdev->name, dev_name(led_cdev->dev));
  227. #ifdef CONFIG_LEDS_TRIGGERS
  228. init_rwsem(&led_cdev->trigger_lock);
  229. #endif
  230. mutex_init(&led_cdev->led_access);
  231. /* add to the list of leds */
  232. down_write(&leds_list_lock);
  233. list_add_tail(&led_cdev->node, &leds_list);
  234. up_write(&leds_list_lock);
  235. if (!led_cdev->max_brightness)
  236. led_cdev->max_brightness = LED_FULL;
  237. led_update_brightness(led_cdev);
  238. led_init_core(led_cdev);
  239. #ifdef CONFIG_LEDS_TRIGGERS
  240. led_trigger_set_default(led_cdev);
  241. #endif
  242. dev_dbg(parent, "Registered led device: %s\n",
  243. led_cdev->name);
  244. return 0;
  245. }
  246. EXPORT_SYMBOL_GPL(led_classdev_register);
  247. /**
  248. * led_classdev_unregister - unregisters a object of led_properties class.
  249. * @led_cdev: the led device to unregister
  250. *
  251. * Unregisters a previously registered via led_classdev_register object.
  252. */
  253. void led_classdev_unregister(struct led_classdev *led_cdev)
  254. {
  255. #ifdef CONFIG_LEDS_TRIGGERS
  256. down_write(&led_cdev->trigger_lock);
  257. if (led_cdev->trigger)
  258. led_trigger_set(led_cdev, NULL);
  259. up_write(&led_cdev->trigger_lock);
  260. #endif
  261. led_cdev->flags |= LED_UNREGISTERING;
  262. /* Stop blinking */
  263. led_stop_software_blink(led_cdev);
  264. led_set_brightness(led_cdev, LED_OFF);
  265. flush_work(&led_cdev->set_brightness_work);
  266. device_unregister(led_cdev->dev);
  267. down_write(&leds_list_lock);
  268. list_del(&led_cdev->node);
  269. up_write(&leds_list_lock);
  270. mutex_destroy(&led_cdev->led_access);
  271. }
  272. EXPORT_SYMBOL_GPL(led_classdev_unregister);
  273. static void devm_led_classdev_release(struct device *dev, void *res)
  274. {
  275. led_classdev_unregister(*(struct led_classdev **)res);
  276. }
  277. /**
  278. * devm_led_classdev_register - resource managed led_classdev_register()
  279. * @parent: The device to register.
  280. * @led_cdev: the led_classdev structure for this device.
  281. */
  282. int devm_led_classdev_register(struct device *parent,
  283. struct led_classdev *led_cdev)
  284. {
  285. struct led_classdev **dr;
  286. int rc;
  287. dr = devres_alloc(devm_led_classdev_release, sizeof(*dr), GFP_KERNEL);
  288. if (!dr)
  289. return -ENOMEM;
  290. rc = led_classdev_register(parent, led_cdev);
  291. if (rc) {
  292. devres_free(dr);
  293. return rc;
  294. }
  295. *dr = led_cdev;
  296. devres_add(parent, dr);
  297. return 0;
  298. }
  299. EXPORT_SYMBOL_GPL(devm_led_classdev_register);
  300. static int devm_led_classdev_match(struct device *dev, void *res, void *data)
  301. {
  302. struct led_cdev **p = res;
  303. if (WARN_ON(!p || !*p))
  304. return 0;
  305. return *p == data;
  306. }
  307. /**
  308. * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
  309. * @parent: The device to unregister.
  310. * @led_cdev: the led_classdev structure for this device.
  311. */
  312. void devm_led_classdev_unregister(struct device *dev,
  313. struct led_classdev *led_cdev)
  314. {
  315. WARN_ON(devres_release(dev,
  316. devm_led_classdev_release,
  317. devm_led_classdev_match, led_cdev));
  318. }
  319. EXPORT_SYMBOL_GPL(devm_led_classdev_unregister);
  320. static int __init leds_init(void)
  321. {
  322. leds_class = class_create(THIS_MODULE, "leds");
  323. if (IS_ERR(leds_class))
  324. return PTR_ERR(leds_class);
  325. leds_class->pm = &leds_class_dev_pm_ops;
  326. leds_class->dev_groups = led_groups;
  327. return 0;
  328. }
  329. static void __exit leds_exit(void)
  330. {
  331. class_destroy(leds_class);
  332. }
  333. subsys_initcall(leds_init);
  334. module_exit(leds_exit);
  335. MODULE_AUTHOR("John Lenz, Richard Purdie");
  336. MODULE_LICENSE("GPL");
  337. MODULE_DESCRIPTION("LED Class Interface");