]>
Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
22e03f3b RA |
2 | /* |
3 | * LEDs driver for GPIOs | |
4 | * | |
5 | * Copyright (C) 2007 8D Technologies inc. | |
6 | * Raphael Assenat <[email protected]> | |
a7d878af | 7 | * Copyright (C) 2008 Freescale Semiconductor, Inc. |
22e03f3b | 8 | */ |
4cc72346 | 9 | #include <linux/err.h> |
16db7f90 | 10 | #include <linux/gpio.h> |
5c51277a | 11 | #include <linux/gpio/consumer.h> |
4cc72346 | 12 | #include <linux/kernel.h> |
22e03f3b | 13 | #include <linux/leds.h> |
4cc72346 | 14 | #include <linux/module.h> |
403097f7 | 15 | #include <linux/of.h> |
4cc72346 | 16 | #include <linux/platform_device.h> |
a43f2cbb | 17 | #include <linux/property.h> |
5a0e3ad6 | 18 | #include <linux/slab.h> |
00852279 | 19 | |
22e03f3b RA |
20 | struct gpio_led_data { |
21 | struct led_classdev cdev; | |
5c51277a | 22 | struct gpio_desc *gpiod; |
00852279 | 23 | u8 can_sleep; |
2146325d | 24 | u8 blinking; |
68620e59 | 25 | gpio_blink_set_t platform_gpio_blink_set; |
22e03f3b RA |
26 | }; |
27 | ||
45808094 HK |
28 | static 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 | ||
22e03f3b RA |
34 | static void gpio_led_set(struct led_classdev *led_cdev, |
35 | enum led_brightness value) | |
36 | { | |
45808094 | 37 | struct gpio_led_data *led_dat = cdev_to_gpio_led_data(led_cdev); |
22e03f3b RA |
38 | int level; |
39 | ||
40 | if (value == LED_OFF) | |
41 | level = 0; | |
42 | else | |
43 | level = 1; | |
44 | ||
d5b8a090 JA |
45 | if (led_dat->blinking) { |
46 | led_dat->platform_gpio_blink_set(led_dat->gpiod, level, | |
47 | NULL, NULL); | |
48 | led_dat->blinking = 0; | |
2146325d | 49 | } else { |
d5b8a090 JA |
50 | if (led_dat->can_sleep) |
51 | gpiod_set_value_cansleep(led_dat->gpiod, level); | |
52 | else | |
5c51277a | 53 | gpiod_set_value(led_dat->gpiod, level); |
2146325d | 54 | } |
22e03f3b RA |
55 | } |
56 | ||
d5b8a090 JA |
57 | static 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 | ||
ca3259b3 HVR |
64 | static int gpio_blink_set(struct led_classdev *led_cdev, |
65 | unsigned long *delay_on, unsigned long *delay_off) | |
66 | { | |
45808094 | 67 | struct gpio_led_data *led_dat = cdev_to_gpio_led_data(led_cdev); |
ca3259b3 | 68 | |
2146325d | 69 | led_dat->blinking = 1; |
c673a2b4 | 70 | return led_dat->platform_gpio_blink_set(led_dat->gpiod, GPIO_LED_BLINK, |
2146325d | 71 | delay_on, delay_off); |
ca3259b3 HVR |
72 | } |
73 | ||
98ea1ea2 | 74 | static int create_gpio_led(const struct gpio_led *template, |
a7d878af | 75 | struct gpio_led_data *led_dat, struct device *parent, |
7ea79ae8 | 76 | struct device_node *np, gpio_blink_set_t blink_set) |
a7d878af | 77 | { |
ed88bae6 | 78 | int ret, state; |
a7d878af | 79 | |
a7d878af TP |
80 | led_dat->cdev.name = template->name; |
81 | led_dat->cdev.default_trigger = template->default_trigger; | |
ec98a497 | 82 | led_dat->can_sleep = gpiod_cansleep(led_dat->gpiod); |
d5b8a090 JA |
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; | |
2146325d | 87 | led_dat->blinking = 0; |
a7d878af TP |
88 | if (blink_set) { |
89 | led_dat->platform_gpio_blink_set = blink_set; | |
90 | led_dat->cdev.blink_set = gpio_blink_set; | |
91 | } | |
061b5c1d HK |
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 { | |
ed88bae6 | 97 | state = (template->default_state == LEDS_GPIO_DEFSTATE_ON); |
061b5c1d | 98 | } |
ed88bae6 | 99 | led_dat->cdev.brightness = state ? LED_FULL : LED_OFF; |
defb512d RP |
100 | if (!template->retain_state_suspended) |
101 | led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME; | |
80d6737b EG |
102 | if (template->panic_indicator) |
103 | led_dat->cdev.flags |= LED_PANIC_INDICATOR; | |
f5808ac1 AJ |
104 | if (template->retain_state_shutdown) |
105 | led_dat->cdev.flags |= LED_RETAIN_AT_SHUTDOWN; | |
a7d878af | 106 | |
5c51277a | 107 | ret = gpiod_direction_output(led_dat->gpiod, state); |
a7d878af | 108 | if (ret < 0) |
a99d76f9 JH |
109 | return ret; |
110 | ||
7ea79ae8 | 111 | return devm_of_led_classdev_register(parent, np, &led_dat->cdev); |
a7d878af TP |
112 | } |
113 | ||
a314c5c0 GL |
114 | struct gpio_leds_priv { |
115 | int num_leds; | |
116 | struct gpio_led_data leds[]; | |
117 | }; | |
22e03f3b | 118 | |
a314c5c0 | 119 | static inline int sizeof_gpio_leds_priv(int num_leds) |
22e03f3b | 120 | { |
a314c5c0 GL |
121 | return sizeof(struct gpio_leds_priv) + |
122 | (sizeof(struct gpio_led_data) * num_leds); | |
22e03f3b RA |
123 | } |
124 | ||
a43f2cbb | 125 | static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev) |
a7d878af | 126 | { |
a43f2cbb RW |
127 | struct device *dev = &pdev->dev; |
128 | struct fwnode_handle *child; | |
a314c5c0 | 129 | struct gpio_leds_priv *priv; |
127aedc8 | 130 | int count, ret; |
a7d878af | 131 | |
a43f2cbb | 132 | count = device_get_child_node_count(dev); |
a7d878af | 133 | if (!count) |
04553e92 RS |
134 | return ERR_PTR(-ENODEV); |
135 | ||
a43f2cbb | 136 | priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL); |
a314c5c0 | 137 | if (!priv) |
04553e92 | 138 | return ERR_PTR(-ENOMEM); |
a7d878af | 139 | |
a43f2cbb | 140 | device_for_each_child_node(dev, child) { |
bff23714 | 141 | struct gpio_led_data *led_dat = &priv->leds[priv->num_leds]; |
0493a4ff | 142 | struct gpio_led led = {}; |
a43f2cbb | 143 | const char *state = NULL; |
8ca03da5 | 144 | struct device_node *np = to_of_node(child); |
a43f2cbb | 145 | |
bec69de8 HK |
146 | ret = fwnode_property_read_string(child, "label", &led.name); |
147 | if (ret && IS_ENABLED(CONFIG_OF) && np) | |
148 | led.name = np->name; | |
149 | if (!led.name) { | |
74b69e52 HK |
150 | fwnode_handle_put(child); |
151 | return ERR_PTR(-EINVAL); | |
29470ea8 | 152 | } |
bec69de8 | 153 | |
4b094797 BB |
154 | led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child, |
155 | GPIOD_ASIS, | |
156 | led.name); | |
b2987d74 AS |
157 | if (IS_ERR(led.gpiod)) { |
158 | fwnode_handle_put(child); | |
159 | return ERR_CAST(led.gpiod); | |
160 | } | |
161 | ||
72b8ad40 LD |
162 | led_dat->gpiod = led.gpiod; |
163 | ||
a43f2cbb RW |
164 | fwnode_property_read_string(child, "linux,default-trigger", |
165 | &led.default_trigger); | |
166 | ||
d735d25e | 167 | if (!fwnode_property_read_string(child, "default-state", |
a43f2cbb | 168 | &state)) { |
ed88bae6 TP |
169 | if (!strcmp(state, "keep")) |
170 | led.default_state = LEDS_GPIO_DEFSTATE_KEEP; | |
a314c5c0 | 171 | else if (!strcmp(state, "on")) |
ed88bae6 TP |
172 | led.default_state = LEDS_GPIO_DEFSTATE_ON; |
173 | else | |
174 | led.default_state = LEDS_GPIO_DEFSTATE_OFF; | |
175 | } | |
a7d878af | 176 | |
a43f2cbb | 177 | if (fwnode_property_present(child, "retain-state-suspended")) |
4270a78d | 178 | led.retain_state_suspended = 1; |
f5808ac1 AJ |
179 | if (fwnode_property_present(child, "retain-state-shutdown")) |
180 | led.retain_state_shutdown = 1; | |
80d6737b EG |
181 | if (fwnode_property_present(child, "panic-indicator")) |
182 | led.panic_indicator = 1; | |
4270a78d | 183 | |
7ea79ae8 | 184 | ret = create_gpio_led(&led, led_dat, dev, np, NULL); |
a7d878af | 185 | if (ret < 0) { |
a43f2cbb | 186 | fwnode_handle_put(child); |
74b69e52 | 187 | return ERR_PTR(ret); |
a7d878af | 188 | } |
65c6b7e3 | 189 | priv->num_leds++; |
a7d878af TP |
190 | } |
191 | ||
a314c5c0 | 192 | return priv; |
a314c5c0 | 193 | } |
a7d878af | 194 | |
a314c5c0 GL |
195 | static const struct of_device_id of_gpio_leds_match[] = { |
196 | { .compatible = "gpio-leds", }, | |
197 | {}, | |
198 | }; | |
472b854b PP |
199 | |
200 | MODULE_DEVICE_TABLE(of, of_gpio_leds_match); | |
a7d878af | 201 | |
45d4c6de LW |
202 | static 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, flags); | |
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 | ||
98ea1ea2 | 248 | static int gpio_led_probe(struct platform_device *pdev) |
a314c5c0 | 249 | { |
87aae1ea | 250 | struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev); |
a314c5c0 GL |
251 | struct gpio_leds_priv *priv; |
252 | int i, ret = 0; | |
253 | ||
254 | if (pdata && pdata->num_leds) { | |
198b8611 SK |
255 | priv = devm_kzalloc(&pdev->dev, |
256 | sizeof_gpio_leds_priv(pdata->num_leds), | |
257 | GFP_KERNEL); | |
a314c5c0 GL |
258 | if (!priv) |
259 | return -ENOMEM; | |
260 | ||
261 | priv->num_leds = pdata->num_leds; | |
262 | for (i = 0; i < priv->num_leds; i++) { | |
45d4c6de LW |
263 | const struct gpio_led *template = &pdata->leds[i]; |
264 | struct gpio_led_data *led_dat = &priv->leds[i]; | |
265 | ||
266 | if (template->gpiod) | |
267 | led_dat->gpiod = template->gpiod; | |
268 | else | |
269 | led_dat->gpiod = | |
270 | gpio_led_get_gpiod(&pdev->dev, | |
271 | i, template); | |
272 | if (IS_ERR(led_dat->gpiod)) { | |
273 | dev_info(&pdev->dev, "Skipping unavailable LED gpio %d (%s)\n", | |
274 | template->gpio, template->name); | |
275 | continue; | |
276 | } | |
277 | ||
278 | ret = create_gpio_led(template, led_dat, | |
7ea79ae8 RM |
279 | &pdev->dev, NULL, |
280 | pdata->gpio_blink_set); | |
bc2c0dd8 | 281 | if (ret < 0) |
a314c5c0 | 282 | return ret; |
a314c5c0 GL |
283 | } |
284 | } else { | |
a43f2cbb | 285 | priv = gpio_leds_create(pdev); |
04553e92 RS |
286 | if (IS_ERR(priv)) |
287 | return PTR_ERR(priv); | |
a314c5c0 GL |
288 | } |
289 | ||
290 | platform_set_drvdata(pdev, priv); | |
291 | ||
292 | return 0; | |
a7d878af TP |
293 | } |
294 | ||
707f33ed HS |
295 | static void gpio_led_shutdown(struct platform_device *pdev) |
296 | { | |
297 | struct gpio_leds_priv *priv = platform_get_drvdata(pdev); | |
298 | int i; | |
299 | ||
300 | for (i = 0; i < priv->num_leds; i++) { | |
301 | struct gpio_led_data *led = &priv->leds[i]; | |
302 | ||
f5808ac1 AJ |
303 | if (!(led->cdev.flags & LED_RETAIN_AT_SHUTDOWN)) |
304 | gpio_led_set(&led->cdev, LED_OFF); | |
707f33ed HS |
305 | } |
306 | } | |
307 | ||
a314c5c0 GL |
308 | static struct platform_driver gpio_led_driver = { |
309 | .probe = gpio_led_probe, | |
707f33ed | 310 | .shutdown = gpio_led_shutdown, |
a314c5c0 GL |
311 | .driver = { |
312 | .name = "leds-gpio", | |
a43f2cbb | 313 | .of_match_table = of_gpio_leds_match, |
a7d878af | 314 | }, |
a7d878af | 315 | }; |
a314c5c0 | 316 | |
892a8843 | 317 | module_platform_driver(gpio_led_driver); |
a7d878af TP |
318 | |
319 | MODULE_AUTHOR("Raphael Assenat <[email protected]>, Trent Piepho <[email protected]>"); | |
22e03f3b RA |
320 | MODULE_DESCRIPTION("GPIO LED driver"); |
321 | MODULE_LICENSE("GPL"); | |
892a8843 | 322 | MODULE_ALIAS("platform:leds-gpio"); |