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