leds-gpio.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * LEDs driver for GPIOs
  4. *
  5. * Copyright (C) 2007 8D Technologies inc.
  6. * Raphael Assenat <[email protected]>
  7. * Copyright (C) 2008 Freescale Semiconductor, Inc.
  8. */
  9. #include <linux/err.h>
  10. #include <linux/gpio.h>
  11. #include <linux/gpio/consumer.h>
  12. #include <linux/kernel.h>
  13. #include <linux/leds.h>
  14. #include <linux/module.h>
  15. #include <linux/of.h>
  16. #include <linux/platform_device.h>
  17. #include <linux/property.h>
  18. #include <linux/slab.h>
  19. #include "leds.h"
  20. struct gpio_led_data {
  21. struct led_classdev cdev;
  22. struct gpio_desc *gpiod;
  23. u8 can_sleep;
  24. u8 blinking;
  25. gpio_blink_set_t platform_gpio_blink_set;
  26. };
  27. static inline struct gpio_led_data *
  28. cdev_to_gpio_led_data(struct led_classdev *led_cdev)
  29. {
  30. return container_of(led_cdev, struct gpio_led_data, cdev);
  31. }
  32. static void gpio_led_set(struct led_classdev *led_cdev,
  33. enum led_brightness value)
  34. {
  35. struct gpio_led_data *led_dat = cdev_to_gpio_led_data(led_cdev);
  36. int level;
  37. if (value == LED_OFF)
  38. level = 0;
  39. else
  40. level = 1;
  41. if (led_dat->blinking) {
  42. led_dat->platform_gpio_blink_set(led_dat->gpiod, level,
  43. NULL, NULL);
  44. led_dat->blinking = 0;
  45. } else {
  46. if (led_dat->can_sleep)
  47. gpiod_set_value_cansleep(led_dat->gpiod, level);
  48. else
  49. gpiod_set_value(led_dat->gpiod, level);
  50. }
  51. }
  52. static int gpio_led_set_blocking(struct led_classdev *led_cdev,
  53. enum led_brightness value)
  54. {
  55. gpio_led_set(led_cdev, value);
  56. return 0;
  57. }
  58. static int gpio_blink_set(struct led_classdev *led_cdev,
  59. unsigned long *delay_on, unsigned long *delay_off)
  60. {
  61. struct gpio_led_data *led_dat = cdev_to_gpio_led_data(led_cdev);
  62. led_dat->blinking = 1;
  63. return led_dat->platform_gpio_blink_set(led_dat->gpiod, GPIO_LED_BLINK,
  64. delay_on, delay_off);
  65. }
  66. static int create_gpio_led(const struct gpio_led *template,
  67. struct gpio_led_data *led_dat, struct device *parent,
  68. struct fwnode_handle *fwnode, gpio_blink_set_t blink_set)
  69. {
  70. struct led_init_data init_data = {};
  71. int ret, state;
  72. led_dat->cdev.default_trigger = template->default_trigger;
  73. led_dat->can_sleep = gpiod_cansleep(led_dat->gpiod);
  74. if (!led_dat->can_sleep)
  75. led_dat->cdev.brightness_set = gpio_led_set;
  76. else
  77. led_dat->cdev.brightness_set_blocking = gpio_led_set_blocking;
  78. led_dat->blinking = 0;
  79. if (blink_set) {
  80. led_dat->platform_gpio_blink_set = blink_set;
  81. led_dat->cdev.blink_set = gpio_blink_set;
  82. }
  83. if (template->default_state == LEDS_GPIO_DEFSTATE_KEEP) {
  84. state = gpiod_get_value_cansleep(led_dat->gpiod);
  85. if (state < 0)
  86. return state;
  87. } else {
  88. state = (template->default_state == LEDS_GPIO_DEFSTATE_ON);
  89. }
  90. led_dat->cdev.brightness = state;
  91. led_dat->cdev.max_brightness = 1;
  92. if (!template->retain_state_suspended)
  93. led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME;
  94. if (template->panic_indicator)
  95. led_dat->cdev.flags |= LED_PANIC_INDICATOR;
  96. if (template->retain_state_shutdown)
  97. led_dat->cdev.flags |= LED_RETAIN_AT_SHUTDOWN;
  98. ret = gpiod_direction_output(led_dat->gpiod, state);
  99. if (ret < 0)
  100. return ret;
  101. if (template->name) {
  102. led_dat->cdev.name = template->name;
  103. ret = devm_led_classdev_register(parent, &led_dat->cdev);
  104. } else {
  105. init_data.fwnode = fwnode;
  106. ret = devm_led_classdev_register_ext(parent, &led_dat->cdev,
  107. &init_data);
  108. }
  109. return ret;
  110. }
  111. struct gpio_leds_priv {
  112. int num_leds;
  113. struct gpio_led_data leds[];
  114. };
  115. static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
  116. {
  117. struct device *dev = &pdev->dev;
  118. struct fwnode_handle *child;
  119. struct gpio_leds_priv *priv;
  120. int count, ret;
  121. count = device_get_child_node_count(dev);
  122. if (!count)
  123. return ERR_PTR(-ENODEV);
  124. priv = devm_kzalloc(dev, struct_size(priv, leds, count), GFP_KERNEL);
  125. if (!priv)
  126. return ERR_PTR(-ENOMEM);
  127. device_for_each_child_node(dev, child) {
  128. struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
  129. struct gpio_led led = {};
  130. /*
  131. * Acquire gpiod from DT with uninitialized label, which
  132. * will be updated after LED class device is registered,
  133. * Only then the final LED name is known.
  134. */
  135. led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child,
  136. GPIOD_ASIS,
  137. NULL);
  138. if (IS_ERR(led.gpiod)) {
  139. fwnode_handle_put(child);
  140. return ERR_CAST(led.gpiod);
  141. }
  142. led_dat->gpiod = led.gpiod;
  143. led.default_state = led_init_default_state_get(child);
  144. if (fwnode_property_present(child, "retain-state-suspended"))
  145. led.retain_state_suspended = 1;
  146. if (fwnode_property_present(child, "retain-state-shutdown"))
  147. led.retain_state_shutdown = 1;
  148. if (fwnode_property_present(child, "panic-indicator"))
  149. led.panic_indicator = 1;
  150. ret = create_gpio_led(&led, led_dat, dev, child, NULL);
  151. if (ret < 0) {
  152. fwnode_handle_put(child);
  153. return ERR_PTR(ret);
  154. }
  155. /* Set gpiod label to match the corresponding LED name. */
  156. gpiod_set_consumer_name(led_dat->gpiod,
  157. led_dat->cdev.dev->kobj.name);
  158. priv->num_leds++;
  159. }
  160. return priv;
  161. }
  162. static const struct of_device_id of_gpio_leds_match[] = {
  163. { .compatible = "gpio-leds", },
  164. {},
  165. };
  166. MODULE_DEVICE_TABLE(of, of_gpio_leds_match);
  167. static struct gpio_desc *gpio_led_get_gpiod(struct device *dev, int idx,
  168. const struct gpio_led *template)
  169. {
  170. struct gpio_desc *gpiod;
  171. unsigned long flags = GPIOF_OUT_INIT_LOW;
  172. int ret;
  173. /*
  174. * This means the LED does not come from the device tree
  175. * or ACPI, so let's try just getting it by index from the
  176. * device, this will hit the board file, if any and get
  177. * the GPIO from there.
  178. */
  179. gpiod = devm_gpiod_get_index(dev, NULL, idx, GPIOD_OUT_LOW);
  180. if (!IS_ERR(gpiod)) {
  181. gpiod_set_consumer_name(gpiod, template->name);
  182. return gpiod;
  183. }
  184. if (PTR_ERR(gpiod) != -ENOENT)
  185. return gpiod;
  186. /*
  187. * This is the legacy code path for platform code that
  188. * still uses GPIO numbers. Ultimately we would like to get
  189. * rid of this block completely.
  190. */
  191. /* skip leds that aren't available */
  192. if (!gpio_is_valid(template->gpio))
  193. return ERR_PTR(-ENOENT);
  194. if (template->active_low)
  195. flags |= GPIOF_ACTIVE_LOW;
  196. ret = devm_gpio_request_one(dev, template->gpio, flags,
  197. template->name);
  198. if (ret < 0)
  199. return ERR_PTR(ret);
  200. gpiod = gpio_to_desc(template->gpio);
  201. if (!gpiod)
  202. return ERR_PTR(-EINVAL);
  203. return gpiod;
  204. }
  205. static int gpio_led_probe(struct platform_device *pdev)
  206. {
  207. struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev);
  208. struct gpio_leds_priv *priv;
  209. int i, ret = 0;
  210. if (pdata && pdata->num_leds) {
  211. priv = devm_kzalloc(&pdev->dev, struct_size(priv, leds, pdata->num_leds),
  212. GFP_KERNEL);
  213. if (!priv)
  214. return -ENOMEM;
  215. priv->num_leds = pdata->num_leds;
  216. for (i = 0; i < priv->num_leds; i++) {
  217. const struct gpio_led *template = &pdata->leds[i];
  218. struct gpio_led_data *led_dat = &priv->leds[i];
  219. if (template->gpiod)
  220. led_dat->gpiod = template->gpiod;
  221. else
  222. led_dat->gpiod =
  223. gpio_led_get_gpiod(&pdev->dev,
  224. i, template);
  225. if (IS_ERR(led_dat->gpiod)) {
  226. dev_info(&pdev->dev, "Skipping unavailable LED gpio %d (%s)\n",
  227. template->gpio, template->name);
  228. continue;
  229. }
  230. ret = create_gpio_led(template, led_dat,
  231. &pdev->dev, NULL,
  232. pdata->gpio_blink_set);
  233. if (ret < 0)
  234. return ret;
  235. }
  236. } else {
  237. priv = gpio_leds_create(pdev);
  238. if (IS_ERR(priv))
  239. return PTR_ERR(priv);
  240. }
  241. platform_set_drvdata(pdev, priv);
  242. return 0;
  243. }
  244. static void gpio_led_shutdown(struct platform_device *pdev)
  245. {
  246. struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
  247. int i;
  248. for (i = 0; i < priv->num_leds; i++) {
  249. struct gpio_led_data *led = &priv->leds[i];
  250. if (!(led->cdev.flags & LED_RETAIN_AT_SHUTDOWN))
  251. gpio_led_set(&led->cdev, LED_OFF);
  252. }
  253. }
  254. static struct platform_driver gpio_led_driver = {
  255. .probe = gpio_led_probe,
  256. .shutdown = gpio_led_shutdown,
  257. .driver = {
  258. .name = "leds-gpio",
  259. .of_match_table = of_gpio_leds_match,
  260. },
  261. };
  262. module_platform_driver(gpio_led_driver);
  263. MODULE_AUTHOR("Raphael Assenat <[email protected]>, Trent Piepho <[email protected]>");
  264. MODULE_DESCRIPTION("GPIO LED driver");
  265. MODULE_LICENSE("GPL");
  266. MODULE_ALIAS("platform:leds-gpio");