blob: 9b991d46ed848a0de40185eef30d9691c7e07e88 [file] [log] [blame]
Raphael Assenat22e03f32007-02-27 19:49:53 +00001/*
2 * LEDs driver for GPIOs
3 *
4 * Copyright (C) 2007 8D Technologies inc.
5 * Raphael Assenat <raph@8d.com>
Trent Piephoa7d878a2009-01-10 17:26:01 +00006 * Copyright (C) 2008 Freescale Semiconductor, Inc.
Raphael Assenat22e03f32007-02-27 19:49:53 +00007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 */
Xiubo Li4cc72342014-09-28 01:57:14 -070013#include <linux/err.h>
Mark Brown16db7f92012-03-23 15:02:11 -070014#include <linux/gpio.h>
Mika Westerberg5c512772014-10-27 23:29:32 +010015#include <linux/gpio/consumer.h>
Xiubo Li4cc72342014-09-28 01:57:14 -070016#include <linux/kernel.h>
Raphael Assenat22e03f32007-02-27 19:49:53 +000017#include <linux/leds.h>
Xiubo Li4cc72342014-09-28 01:57:14 -070018#include <linux/module.h>
Geert Uytterhoeven403097f2015-05-07 01:08:09 -070019#include <linux/of.h>
Xiubo Li4cc72342014-09-28 01:57:14 -070020#include <linux/platform_device.h>
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +010021#include <linux/property.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
David Brownell00852272007-05-10 10:51:41 +010023
Raphael Assenat22e03f32007-02-27 19:49:53 +000024struct gpio_led_data {
25 struct led_classdev cdev;
Mika Westerberg5c512772014-10-27 23:29:32 +010026 struct gpio_desc *gpiod;
David Brownell00852272007-05-10 10:51:41 +010027 u8 can_sleep;
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +100028 u8 blinking;
Mika Westerbergc673a2b2014-10-31 13:40:58 +020029 int (*platform_gpio_blink_set)(struct gpio_desc *desc, int state,
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +000030 unsigned long *delay_on, unsigned long *delay_off);
Raphael Assenat22e03f32007-02-27 19:49:53 +000031};
32
Raphael Assenat22e03f32007-02-27 19:49:53 +000033static void gpio_led_set(struct led_classdev *led_cdev,
34 enum led_brightness value)
35{
36 struct gpio_led_data *led_dat =
37 container_of(led_cdev, struct gpio_led_data, cdev);
38 int level;
39
40 if (value == LED_OFF)
41 level = 0;
42 else
43 level = 1;
44
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +020045 if (led_dat->blinking) {
46 led_dat->platform_gpio_blink_set(led_dat->gpiod, level,
47 NULL, NULL);
48 led_dat->blinking = 0;
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +100049 } else {
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +020050 if (led_dat->can_sleep)
51 gpiod_set_value_cansleep(led_dat->gpiod, level);
52 else
Mika Westerberg5c512772014-10-27 23:29:32 +010053 gpiod_set_value(led_dat->gpiod, level);
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +100054 }
Raphael Assenat22e03f32007-02-27 19:49:53 +000055}
56
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +020057static int gpio_led_set_blocking(struct led_classdev *led_cdev,
58 enum led_brightness value)
59{
60 gpio_led_set(led_cdev, value);
61 return 0;
62}
63
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +000064static int gpio_blink_set(struct led_classdev *led_cdev,
65 unsigned long *delay_on, unsigned long *delay_off)
66{
67 struct gpio_led_data *led_dat =
68 container_of(led_cdev, struct gpio_led_data, cdev);
69
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +100070 led_dat->blinking = 1;
Mika Westerbergc673a2b2014-10-31 13:40:58 +020071 return led_dat->platform_gpio_blink_set(led_dat->gpiod, GPIO_LED_BLINK,
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +100072 delay_on, delay_off);
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +000073}
74
Bill Pemberton98ea1ea2012-11-19 13:23:02 -050075static int create_gpio_led(const struct gpio_led *template,
Trent Piephoa7d878a2009-01-10 17:26:01 +000076 struct gpio_led_data *led_dat, struct device *parent,
Mika Westerbergc673a2b2014-10-31 13:40:58 +020077 int (*blink_set)(struct gpio_desc *, int, unsigned long *,
78 unsigned long *))
Trent Piephoa7d878a2009-01-10 17:26:01 +000079{
Trent Piephoed88bae2009-05-12 15:33:12 -070080 int ret, state;
Trent Piephoa7d878a2009-01-10 17:26:01 +000081
Geert Uytterhoevenec98a492014-11-06 12:23:23 +010082 led_dat->gpiod = template->gpiod;
83 if (!led_dat->gpiod) {
Mika Westerbergc673a2b2014-10-31 13:40:58 +020084 /*
85 * This is the legacy code path for platform code that
86 * still uses GPIO numbers. Ultimately we would like to get
87 * rid of this block completely.
88 */
Geert Uytterhoeveneae7c982016-02-19 10:52:34 +010089 unsigned long flags = GPIOF_OUT_INIT_LOW;
Dmitry Eremin-Solenikov0b4634f2009-11-16 01:48:32 +030090
Mika Westerberg5c512772014-10-27 23:29:32 +010091 /* skip leds that aren't available */
92 if (!gpio_is_valid(template->gpio)) {
93 dev_info(parent, "Skipping unavailable LED gpio %d (%s)\n",
94 template->gpio, template->name);
95 return 0;
96 }
97
98 if (template->active_low)
99 flags |= GPIOF_ACTIVE_LOW;
100
101 ret = devm_gpio_request_one(parent, template->gpio, flags,
102 template->name);
103 if (ret < 0)
104 return ret;
105
106 led_dat->gpiod = gpio_to_desc(template->gpio);
Wei Yongjun2d88a332016-02-06 22:37:33 +0800107 if (!led_dat->gpiod)
108 return -EINVAL;
David Brownelld379ee82009-03-05 16:46:44 -0800109 }
110
Trent Piephoa7d878a2009-01-10 17:26:01 +0000111 led_dat->cdev.name = template->name;
112 led_dat->cdev.default_trigger = template->default_trigger;
Geert Uytterhoevenec98a492014-11-06 12:23:23 +0100113 led_dat->can_sleep = gpiod_cansleep(led_dat->gpiod);
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +0200114 if (!led_dat->can_sleep)
115 led_dat->cdev.brightness_set = gpio_led_set;
116 else
117 led_dat->cdev.brightness_set_blocking = gpio_led_set_blocking;
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000118 led_dat->blinking = 0;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000119 if (blink_set) {
120 led_dat->platform_gpio_blink_set = blink_set;
121 led_dat->cdev.blink_set = gpio_blink_set;
122 }
Trent Piephoed88bae2009-05-12 15:33:12 -0700123 if (template->default_state == LEDS_GPIO_DEFSTATE_KEEP)
Mika Westerberg5c512772014-10-27 23:29:32 +0100124 state = !!gpiod_get_value_cansleep(led_dat->gpiod);
Trent Piephoed88bae2009-05-12 15:33:12 -0700125 else
126 state = (template->default_state == LEDS_GPIO_DEFSTATE_ON);
127 led_dat->cdev.brightness = state ? LED_FULL : LED_OFF;
Richard Purdiedefb5122009-02-17 15:04:07 +0000128 if (!template->retain_state_suspended)
129 led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME;
Ezequiel Garcia80d67372016-04-28 19:03:40 -0300130 if (template->panic_indicator)
131 led_dat->cdev.flags |= LED_PANIC_INDICATOR;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000132
Mika Westerberg5c512772014-10-27 23:29:32 +0100133 ret = gpiod_direction_output(led_dat->gpiod, state);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000134 if (ret < 0)
Jingoo Hana99d76f2012-10-23 05:17:11 -0700135 return ret;
136
Mika Westerberg5c512772014-10-27 23:29:32 +0100137 return led_classdev_register(parent, &led_dat->cdev);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000138}
139
Grant Likelya314c5c2011-02-22 20:06:04 -0700140struct gpio_leds_priv {
141 int num_leds;
142 struct gpio_led_data leds[];
Raphael Assenat22e03f32007-02-27 19:49:53 +0000143};
144
Grant Likelya314c5c2011-02-22 20:06:04 -0700145static inline int sizeof_gpio_leds_priv(int num_leds)
146{
147 return sizeof(struct gpio_leds_priv) +
148 (sizeof(struct gpio_led_data) * num_leds);
149}
Trent Piephoa7d878a2009-01-10 17:26:01 +0000150
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100151static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
Trent Piephoa7d878a2009-01-10 17:26:01 +0000152{
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100153 struct device *dev = &pdev->dev;
154 struct fwnode_handle *child;
Grant Likelya314c5c2011-02-22 20:06:04 -0700155 struct gpio_leds_priv *priv;
Tobias Klauser127aedc2012-08-21 17:21:53 +0800156 int count, ret;
Fabio Estevam29470ea2014-12-04 02:28:19 +0100157 struct device_node *np;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000158
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100159 count = device_get_child_node_count(dev);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000160 if (!count)
Roland Stigge04553e92012-10-28 08:34:59 -0700161 return ERR_PTR(-ENODEV);
162
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100163 priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL);
Grant Likelya314c5c2011-02-22 20:06:04 -0700164 if (!priv)
Roland Stigge04553e92012-10-28 08:34:59 -0700165 return ERR_PTR(-ENOMEM);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000166
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100167 device_for_each_child_node(dev, child) {
Rafał Miłeckibff23712016-07-08 14:53:38 +0200168 struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
Anton Vorontsov0493a4f2010-03-11 13:58:47 -0800169 struct gpio_led led = {};
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100170 const char *state = NULL;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000171
Olliver Schinagl1feb57a2015-01-21 22:33:46 +0100172 led.gpiod = devm_get_gpiod_from_child(dev, NULL, child);
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100173 if (IS_ERR(led.gpiod)) {
174 fwnode_handle_put(child);
Soren Brinkmannc6e71f82015-01-31 19:15:00 -0800175 ret = PTR_ERR(led.gpiod);
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100176 goto err;
177 }
178
Alexander Sverdlinc181fb32015-06-22 22:38:53 +0200179 np = to_of_node(child);
Fabio Estevam29470ea2014-12-04 02:28:19 +0100180
181 if (fwnode_property_present(child, "label")) {
182 fwnode_property_read_string(child, "label", &led.name);
183 } else {
184 if (IS_ENABLED(CONFIG_OF) && !led.name && np)
185 led.name = np->name;
Jacek Anaszewski0e14e0b2015-04-16 00:30:50 -0700186 if (!led.name) {
187 ret = -EINVAL;
188 goto err;
189 }
Fabio Estevam29470ea2014-12-04 02:28:19 +0100190 }
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100191 fwnode_property_read_string(child, "linux,default-trigger",
192 &led.default_trigger);
193
Fabio Estevamd735d252014-12-10 01:57:07 +0100194 if (!fwnode_property_read_string(child, "default-state",
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100195 &state)) {
Trent Piephoed88bae2009-05-12 15:33:12 -0700196 if (!strcmp(state, "keep"))
197 led.default_state = LEDS_GPIO_DEFSTATE_KEEP;
Grant Likelya314c5c2011-02-22 20:06:04 -0700198 else if (!strcmp(state, "on"))
Trent Piephoed88bae2009-05-12 15:33:12 -0700199 led.default_state = LEDS_GPIO_DEFSTATE_ON;
200 else
201 led.default_state = LEDS_GPIO_DEFSTATE_OFF;
202 }
Trent Piephoa7d878a2009-01-10 17:26:01 +0000203
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100204 if (fwnode_property_present(child, "retain-state-suspended"))
Robin Gong4270a782014-01-20 03:41:26 -0800205 led.retain_state_suspended = 1;
Ezequiel Garcia80d67372016-04-28 19:03:40 -0300206 if (fwnode_property_present(child, "panic-indicator"))
207 led.panic_indicator = 1;
Robin Gong4270a782014-01-20 03:41:26 -0800208
Rafał Miłeckibff23712016-07-08 14:53:38 +0200209 ret = create_gpio_led(&led, led_dat, dev, NULL);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000210 if (ret < 0) {
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100211 fwnode_handle_put(child);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000212 goto err;
213 }
Rafał Miłeckibff23712016-07-08 14:53:38 +0200214 led_dat->cdev.dev->of_node = np;
Sebastian Hesselbarth65c6b7e2015-04-14 14:23:30 -0700215 priv->num_leds++;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000216 }
217
Grant Likelya314c5c2011-02-22 20:06:04 -0700218 return priv;
Trent Piephoa7d878a2009-01-10 17:26:01 +0000219
220err:
Sebastian Hesselbarth65c6b7e2015-04-14 14:23:30 -0700221 for (count = priv->num_leds - 1; count >= 0; count--)
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +0200222 led_classdev_unregister(&priv->leds[count].cdev);
Soren Brinkmannc6e71f82015-01-31 19:15:00 -0800223 return ERR_PTR(ret);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000224}
225
226static const struct of_device_id of_gpio_leds_match[] = {
227 { .compatible = "gpio-leds", },
228 {},
229};
Paolo Pisati472b8542014-03-06 09:18:37 -0800230
231MODULE_DEVICE_TABLE(of, of_gpio_leds_match);
Trent Piephoa7d878a2009-01-10 17:26:01 +0000232
Bill Pemberton98ea1ea2012-11-19 13:23:02 -0500233static int gpio_led_probe(struct platform_device *pdev)
Grant Likelya314c5c2011-02-22 20:06:04 -0700234{
Jingoo Han87aae1e2013-07-30 01:07:35 -0700235 struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev);
Grant Likelya314c5c2011-02-22 20:06:04 -0700236 struct gpio_leds_priv *priv;
237 int i, ret = 0;
238
239 if (pdata && pdata->num_leds) {
Sachin Kamat198b8612012-07-04 11:35:44 +0800240 priv = devm_kzalloc(&pdev->dev,
241 sizeof_gpio_leds_priv(pdata->num_leds),
242 GFP_KERNEL);
Grant Likelya314c5c2011-02-22 20:06:04 -0700243 if (!priv)
244 return -ENOMEM;
245
246 priv->num_leds = pdata->num_leds;
247 for (i = 0; i < priv->num_leds; i++) {
248 ret = create_gpio_led(&pdata->leds[i],
249 &priv->leds[i],
250 &pdev->dev, pdata->gpio_blink_set);
251 if (ret < 0) {
252 /* On failure: unwind the led creations */
253 for (i = i - 1; i >= 0; i--)
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +0200254 led_classdev_unregister(
255 &priv->leds[i].cdev);
Grant Likelya314c5c2011-02-22 20:06:04 -0700256 return ret;
257 }
258 }
259 } else {
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100260 priv = gpio_leds_create(pdev);
Roland Stigge04553e92012-10-28 08:34:59 -0700261 if (IS_ERR(priv))
262 return PTR_ERR(priv);
Grant Likelya314c5c2011-02-22 20:06:04 -0700263 }
264
265 platform_set_drvdata(pdev, priv);
266
267 return 0;
268}
269
Bill Pemberton678e8a62012-11-19 13:26:00 -0500270static int gpio_led_remove(struct platform_device *pdev)
Grant Likelya314c5c2011-02-22 20:06:04 -0700271{
Tobias Klauser59c4dce2012-08-16 18:36:13 +0800272 struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
Grant Likelya314c5c2011-02-22 20:06:04 -0700273 int i;
274
275 for (i = 0; i < priv->num_leds; i++)
Jacek Anaszewskid5b8a092015-08-20 15:52:32 +0200276 led_classdev_unregister(&priv->leds[i].cdev);
Grant Likelya314c5c2011-02-22 20:06:04 -0700277
Grant Likelya314c5c2011-02-22 20:06:04 -0700278 return 0;
279}
280
Heiko Schocher707f33e2015-10-13 07:17:12 +0200281static void gpio_led_shutdown(struct platform_device *pdev)
282{
283 struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
284 int i;
285
286 for (i = 0; i < priv->num_leds; i++) {
287 struct gpio_led_data *led = &priv->leds[i];
288
289 gpio_led_set(&led->cdev, LED_OFF);
290 }
291}
292
Grant Likelya314c5c2011-02-22 20:06:04 -0700293static struct platform_driver gpio_led_driver = {
294 .probe = gpio_led_probe,
Bill Pembertondf07cf82012-11-19 13:20:20 -0500295 .remove = gpio_led_remove,
Heiko Schocher707f33e2015-10-13 07:17:12 +0200296 .shutdown = gpio_led_shutdown,
Grant Likelya314c5c2011-02-22 20:06:04 -0700297 .driver = {
298 .name = "leds-gpio",
Rafael J. Wysockia43f2cb2014-10-27 23:30:10 +0100299 .of_match_table = of_gpio_leds_match,
Trent Piephoa7d878a2009-01-10 17:26:01 +0000300 },
Trent Piephoa7d878a2009-01-10 17:26:01 +0000301};
Grant Likelya314c5c2011-02-22 20:06:04 -0700302
Axel Lin892a8842012-01-10 15:09:24 -0800303module_platform_driver(gpio_led_driver);
Richard Purdieb2bdc3e2009-02-02 23:04:42 +0000304
Trent Piephoa7d878a2009-01-10 17:26:01 +0000305MODULE_AUTHOR("Raphael Assenat <raph@8d.com>, Trent Piepho <tpiepho@freescale.com>");
Raphael Assenat22e03f32007-02-27 19:49:53 +0000306MODULE_DESCRIPTION("GPIO LED driver");
307MODULE_LICENSE("GPL");
Axel Lin892a8842012-01-10 15:09:24 -0800308MODULE_ALIAS("platform:leds-gpio");