drivers/leds/leds-gpio.c

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