Branch data     Line data    Source code

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