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