include/linux/leds.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Driver model for leds and led triggers
   4  *
   5  * Copyright (C) 2005 John Lenz <[email protected]>
   6  * Copyright (C) 2005 Richard Purdie <[email protected]>
   7  */
   8 #ifndef __LINUX_LEDS_H_INCLUDED
   9 #define __LINUX_LEDS_H_INCLUDED
  10
  11 #include <dt-bindings/leds/common.h>
  12 #include <linux/device.h>
  13 #include <linux/kernfs.h>
  14 #include <linux/list.h>
  15 #include <linux/mutex.h>
  16 #include <linux/rwsem.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/timer.h>
  19 #include <linux/workqueue.h>
  20
  21 struct device;
  22 struct led_pattern;
  23 /*
  24  * LED Core
  25  */
  26
  27 enum led_brightness {
  28         LED_OFF         = 0,
  29         LED_ON          = 1,
  30         LED_HALF        = 127,
  31         LED_FULL        = 255,
  32 };
  33
  34 struct led_init_data {
  35         /* device fwnode handle */
  36         struct fwnode_handle *fwnode;
  37         /*
  38          * default <color:function> tuple, for backward compatibility
  39          * with in-driver hard-coded LED names used as a fallback when
  40          * DT "label" property is absent; it should be set to NULL
  41          * in new LED class drivers.
  42          */
  43         const char *default_label;
  44         /*
  45          * string to be used for devicename section of LED class device
  46          * either for label based LED name composition path or for fwnode
  47          * based when devname_mandatory is true
  48          */
  49         const char *devicename;
  50         /*
  51          * indicates if LED name should always comprise devicename section;
  52          * only LEDs exposed by drivers of hot-pluggable devices should
  53          * set it to true
  54          */
  55         bool devname_mandatory;
  56 };
  57
  58 struct led_classdev {
  59         const char              *name;
  60         enum led_brightness      brightness;
  61         enum led_brightness      max_brightness;
  62         int                      flags;
  63
  64         /* Lower 16 bits reflect status */
  65 #define LED_SUSPENDED           BIT(0)
  66 #define LED_UNREGISTERING       BIT(1)
  67         /* Upper 16 bits reflect control information */
  68 #define LED_CORE_SUSPENDRESUME  BIT(16)
  69 #define LED_SYSFS_DISABLE       BIT(17)
  70 #define LED_DEV_CAP_FLASH       BIT(18)
  71 #define LED_HW_PLUGGABLE        BIT(19)
  72 #define LED_PANIC_INDICATOR     BIT(20)
  73 #define LED_BRIGHT_HW_CHANGED   BIT(21)
  74 #define LED_RETAIN_AT_SHUTDOWN  BIT(22)
  75 #define LED_INIT_DEFAULT_TRIGGER BIT(23)
  76
  77         /* set_brightness_work / blink_timer flags, atomic, private. */
  78         unsigned long           work_flags;
  79
  80 #define LED_BLINK_SW                    0
  81 #define LED_BLINK_ONESHOT               1
  82 #define LED_BLINK_ONESHOT_STOP          2
  83 #define LED_BLINK_INVERT                3
  84 #define LED_BLINK_BRIGHTNESS_CHANGE     4
  85 #define LED_BLINK_DISABLE               5
  86
  87         /* Set LED brightness level
  88          * Must not sleep. Use brightness_set_blocking for drivers
  89          * that can sleep while setting brightness.
  90          */
  91         void            (*brightness_set)(struct led_classdev *led_cdev,
  92                                           enum led_brightness brightness);
  93         /*
  94          * Set LED brightness level immediately - it can block the caller for
  95          * the time required for accessing a LED device register.
  96          */
  97         int (*brightness_set_blocking)(struct led_classdev *led_cdev,
  98                                        enum led_brightness brightness);
  99         /* Get LED brightness level */
 100         enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
 101
 102         /*
 103          * Activate hardware accelerated blink, delays are in milliseconds
 104          * and if both are zero then a sensible default should be chosen.
 105          * The call should adjust the timings in that case and if it can't
 106          * match the values specified exactly.
 107          * Deactivate blinking again when the brightness is set to LED_OFF
 108          * via the brightness_set() callback.
 109          */
 110         int             (*blink_set)(struct led_classdev *led_cdev,
 111                                      unsigned long *delay_on,
 112                                      unsigned long *delay_off);
 113
 114         int (*pattern_set)(struct led_classdev *led_cdev,
 115                            struct led_pattern *pattern, u32 len, int repeat);
 116         int (*pattern_clear)(struct led_classdev *led_cdev);
 117
 118         struct device           *dev;
 119         const struct attribute_group    **groups;
 120
 121         struct list_head         node;                  /* LED Device list */
 122         const char              *default_trigger;       /* Trigger to use */
 123
 124         unsigned long            blink_delay_on, blink_delay_off;
 125         struct timer_list        blink_timer;
 126         int                      blink_brightness;
 127         int                      new_blink_brightness;
 128         void                    (*flash_resume)(struct led_classdev *led_cdev);
 129
 130         struct work_struct      set_brightness_work;
 131         int                     delayed_set_value;
 132
 133 #ifdef CONFIG_LEDS_TRIGGERS
 134         /* Protects the trigger data below */
 135         struct rw_semaphore      trigger_lock;
 136
 137         struct led_trigger      *trigger;
 138         struct list_head         trig_list;
 139         void                    *trigger_data;
 140         /* true if activated - deactivate routine uses it to do cleanup */
 141         bool                    activated;
 142 #endif
 143
 144 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
 145         int                      brightness_hw_changed;
 146         struct kernfs_node      *brightness_hw_changed_kn;
 147 #endif
 148
 149         /* Ensures consistent access to the LED Flash Class device */
 150         struct mutex            led_access;
 151 };
 152
 153 /**
 154  * led_classdev_register_ext - register a new object of LED class with
 155  *                             init data
 156  * @parent: LED controller device this LED is driven by
 157  * @led_cdev: the led_classdev structure for this device
 158  * @init_data: the LED class device initialization data
 159  *
 160  * Register a new object of LED class, with name derived from init_data.
 161  *
 162  * Returns: 0 on success or negative error value on failure
 163  */
 164 int led_classdev_register_ext(struct device *parent,
 165                                      struct led_classdev *led_cdev,
 166                                      struct led_init_data *init_data);
 167
 168 /**
 169  * led_classdev_register - register a new object of LED class
 170  * @parent: LED controller device this LED is driven by
 171  * @led_cdev: the led_classdev structure for this device
 172  *
 173  * Register a new object of LED class, with name derived from the name property
 174  * of passed led_cdev argument.
 175  *
 176  * Returns: 0 on success or negative error value on failure
 177  */
 178 static inline int led_classdev_register(struct device *parent,
 179                                         struct led_classdev *led_cdev)
 180 {
 181         return led_classdev_register_ext(parent, led_cdev, NULL);
 182 }
 183
 184 int devm_led_classdev_register_ext(struct device *parent,
 185                                           struct led_classdev *led_cdev,
 186                                           struct led_init_data *init_data);
 187
 188 static inline int devm_led_classdev_register(struct device *parent,
 189                                              struct led_classdev *led_cdev)
 190 {
 191         return devm_led_classdev_register_ext(parent, led_cdev, NULL);
 192 }
 193 void led_classdev_unregister(struct led_classdev *led_cdev);
 194 void devm_led_classdev_unregister(struct device *parent,
 195                                   struct led_classdev *led_cdev);
 196 void led_classdev_suspend(struct led_classdev *led_cdev);
 197 void led_classdev_resume(struct led_classdev *led_cdev);
 198
 199 /**
 200  * led_blink_set - set blinking with software fallback
 201  * @led_cdev: the LED to start blinking
 202  * @delay_on: the time it should be on (in ms)
 203  * @delay_off: the time it should ble off (in ms)
 204  *
 205  * This function makes the LED blink, attempting to use the
 206  * hardware acceleration if possible, but falling back to
 207  * software blinking if there is no hardware blinking or if
 208  * the LED refuses the passed values.
 209  *
 210  * Note that if software blinking is active, simply calling
 211  * led_cdev->brightness_set() will not stop the blinking,
 212  * use led_classdev_brightness_set() instead.
 213  */
 214 void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
 215                    unsigned long *delay_off);
 216 /**
 217  * led_blink_set_oneshot - do a oneshot software blink
 218  * @led_cdev: the LED to start blinking
 219  * @delay_on: the time it should be on (in ms)
 220  * @delay_off: the time it should ble off (in ms)
 221  * @invert: blink off, then on, leaving the led on
 222  *
 223  * This function makes the LED blink one time for delay_on +
 224  * delay_off time, ignoring the request if another one-shot
 225  * blink is already in progress.
 226  *
 227  * If invert is set, led blinks for delay_off first, then for
 228  * delay_on and leave the led on after the on-off cycle.
 229  */
 230 void led_blink_set_oneshot(struct led_classdev *led_cdev,
 231                            unsigned long *delay_on, unsigned long *delay_off,
 232                            int invert);
 233 /**
 234  * led_set_brightness - set LED brightness
 235  * @led_cdev: the LED to set
 236  * @brightness: the brightness to set it to
 237  *
 238  * Set an LED's brightness, and, if necessary, cancel the
 239  * software blink timer that implements blinking when the
 240  * hardware doesn't. This function is guaranteed not to sleep.
 241  */
 242 void led_set_brightness(struct led_classdev *led_cdev,
 243                         enum led_brightness brightness);
 244
 245 /**
 246  * led_set_brightness_sync - set LED brightness synchronously
 247  * @led_cdev: the LED to set
 248  * @value: the brightness to set it to
 249  *
 250  * Set an LED's brightness immediately. This function will block
 251  * the caller for the time required for accessing device registers,
 252  * and it can sleep.
 253  *
 254  * Returns: 0 on success or negative error value on failure
 255  */
 256 int led_set_brightness_sync(struct led_classdev *led_cdev,
 257                             enum led_brightness value);
 258
 259 /**
 260  * led_update_brightness - update LED brightness
 261  * @led_cdev: the LED to query
 262  *
 263  * Get an LED's current brightness and update led_cdev->brightness
 264  * member with the obtained value.
 265  *
 266  * Returns: 0 on success or negative error value on failure
 267  */
 268 int led_update_brightness(struct led_classdev *led_cdev);
 269
 270 /**
 271  * led_get_default_pattern - return default pattern
 272  *
 273  * @led_cdev: the LED to get default pattern for
 274  * @size:     pointer for storing the number of elements in returned array,
 275  *            modified only if return != NULL
 276  *
 277  * Return:    Allocated array of integers with default pattern from device tree
 278  *            or NULL.  Caller is responsible for kfree().
 279  */
 280 u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
 281
 282 /**
 283  * led_sysfs_disable - disable LED sysfs interface
 284  * @led_cdev: the LED to set
 285  *
 286  * Disable the led_cdev's sysfs interface.
 287  */
 288 void led_sysfs_disable(struct led_classdev *led_cdev);
 289
 290 /**
 291  * led_sysfs_enable - enable LED sysfs interface
 292  * @led_cdev: the LED to set
 293  *
 294  * Enable the led_cdev's sysfs interface.
 295  */
 296 void led_sysfs_enable(struct led_classdev *led_cdev);
 297
 298 /**
 299  * led_compose_name - compose LED class device name
 300  * @dev: LED controller device object
 301  * @init_data: the LED class device initialization data
 302  * @led_classdev_name: composed LED class device name
 303  *
 304  * Create LED class device name basing on the provided init_data argument.
 305  * The name can have <devicename:color:function> or <color:function>.
 306  * form, depending on the init_data configuration.
 307  *
 308  * Returns: 0 on success or negative error value on failure
 309  */
 310 int led_compose_name(struct device *dev, struct led_init_data *init_data,
 311                      char *led_classdev_name);
 312
 313 /**
 314  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
 315  * @led_cdev: the LED to query
 316  *
 317  * Returns: true if the led_cdev's sysfs interface is disabled.
 318  */
 319 static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
 320 {
 321         return led_cdev->flags & LED_SYSFS_DISABLE;
 322 }
 323
 324 /*
 325  * LED Triggers
 326  */
 327 /* Registration functions for simple triggers */
 328 #define DEFINE_LED_TRIGGER(x)           static struct led_trigger *x;
 329 #define DEFINE_LED_TRIGGER_GLOBAL(x)    struct led_trigger *x;
 330
 331 #ifdef CONFIG_LEDS_TRIGGERS
 332
 333 #define TRIG_NAME_MAX 50
 334
 335 struct led_trigger {
 336         /* Trigger Properties */
 337         const char       *name;
 338         int             (*activate)(struct led_classdev *led_cdev);
 339         void            (*deactivate)(struct led_classdev *led_cdev);
 340
 341         /* LEDs under control by this trigger (for simple triggers) */
 342         rwlock_t          leddev_list_lock;
 343         struct list_head  led_cdevs;
 344
 345         /* Link to next registered trigger */
 346         struct list_head  next_trig;
 347
 348         const struct attribute_group **groups;
 349 };
 350
 351 /*
 352  * Currently the attributes in struct led_trigger::groups are added directly to
 353  * the LED device. As this might change in the future, the following
 354  * macros abstract getting the LED device and its trigger_data from the dev
 355  * parameter passed to the attribute accessor functions.
 356  */
 357 #define led_trigger_get_led(dev)        ((struct led_classdev *)dev_get_drvdata((dev)))
 358 #define led_trigger_get_drvdata(dev)    (led_get_trigger_data(led_trigger_get_led(dev)))
 359
 360 /* Registration functions for complex triggers */
 361 int led_trigger_register(struct led_trigger *trigger);
 362 void led_trigger_unregister(struct led_trigger *trigger);
 363 int devm_led_trigger_register(struct device *dev,
 364                                      struct led_trigger *trigger);
 365
 366 void led_trigger_register_simple(const char *name,
 367                                 struct led_trigger **trigger);
 368 void led_trigger_unregister_simple(struct led_trigger *trigger);
 369 void led_trigger_event(struct led_trigger *trigger,  enum led_brightness event);
 370 void led_trigger_blink(struct led_trigger *trigger, unsigned long *delay_on,
 371                        unsigned long *delay_off);
 372 void led_trigger_blink_oneshot(struct led_trigger *trigger,
 373                                unsigned long *delay_on,
 374                                unsigned long *delay_off,
 375                                int invert);
 376 void led_trigger_set_default(struct led_classdev *led_cdev);
 377 int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
 378 void led_trigger_remove(struct led_classdev *led_cdev);
 379
 380 static inline void led_set_trigger_data(struct led_classdev *led_cdev,
 381                                         void *trigger_data)
 382 {
 383         led_cdev->trigger_data = trigger_data;
 384 }
 385
 386 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
 387 {
 388         return led_cdev->trigger_data;
 389 }
 390
 391 /**
 392  * led_trigger_rename_static - rename a trigger
 393  * @name: the new trigger name
 394  * @trig: the LED trigger to rename
 395  *
 396  * Change a LED trigger name by copying the string passed in
 397  * name into current trigger name, which MUST be large
 398  * enough for the new string.
 399  *
 400  * Note that name must NOT point to the same string used
 401  * during LED registration, as that could lead to races.
 402  *
 403  * This is meant to be used on triggers with statically
 404  * allocated name.
 405  */
 406 void led_trigger_rename_static(const char *name, struct led_trigger *trig);
 407
 408 #define module_led_trigger(__led_trigger) \
 409         module_driver(__led_trigger, led_trigger_register, \
 410                       led_trigger_unregister)
 411
 412 #else
 413
 414 /* Trigger has no members */
 415 struct led_trigger {};
 416
 417 /* Trigger inline empty functions */
 418 static inline void led_trigger_register_simple(const char *name,
 419                                         struct led_trigger **trigger) {}
 420 static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
 421 static inline void led_trigger_event(struct led_trigger *trigger,
 422                                 enum led_brightness event) {}
 423 static inline void led_trigger_blink(struct led_trigger *trigger,
 424                                       unsigned long *delay_on,
 425                                       unsigned long *delay_off) {}
 426 static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
 427                                       unsigned long *delay_on,
 428                                       unsigned long *delay_off,
 429                                       int invert) {}
 430 static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
 431 static inline int led_trigger_set(struct led_classdev *led_cdev,
 432                                   struct led_trigger *trigger)
 433 {
 434         return 0;
 435 }
 436
 437 static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
 438 static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
 439 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
 440 {
 441         return NULL;
 442 }
 443
 444 #endif /* CONFIG_LEDS_TRIGGERS */
 445
 446 /* Trigger specific functions */
 447 #ifdef CONFIG_LEDS_TRIGGER_DISK
 448 void ledtrig_disk_activity(bool write);
 449 #else
 450 static inline void ledtrig_disk_activity(bool write) {}
 451 #endif
 452
 453 #ifdef CONFIG_LEDS_TRIGGER_MTD
 454 void ledtrig_mtd_activity(void);
 455 #else
 456 static inline void ledtrig_mtd_activity(void) {}
 457 #endif
 458
 459 #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
 460 void ledtrig_flash_ctrl(bool on);
 461 void ledtrig_torch_ctrl(bool on);
 462 #else
 463 static inline void ledtrig_flash_ctrl(bool on) {}
 464 static inline void ledtrig_torch_ctrl(bool on) {}
 465 #endif
 466
 467 /*
 468  * Generic LED platform data for describing LED names and default triggers.
 469  */
 470 struct led_info {
 471         const char      *name;
 472         const char      *default_trigger;
 473         int             flags;
 474 };
 475
 476 struct led_platform_data {
 477         int             num_leds;
 478         struct led_info *leds;
 479 };
 480
 481 struct led_properties {
 482         u32             color;
 483         bool            color_present;
 484         const char      *function;
 485         u32             func_enum;
 486         bool            func_enum_present;
 487         const char      *label;
 488 };
 489
 490 struct gpio_desc;
 491 typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
 492                                 unsigned long *delay_on,
 493                                 unsigned long *delay_off);
 494
 495 /* For the leds-gpio driver */
 496 struct gpio_led {
 497         const char *name;
 498         const char *default_trigger;
 499         unsigned        gpio;
 500         unsigned        active_low : 1;
 501         unsigned        retain_state_suspended : 1;
 502         unsigned        panic_indicator : 1;
 503         unsigned        default_state : 2;
 504         unsigned        retain_state_shutdown : 1;
 505         /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
 506         struct gpio_desc *gpiod;
 507 };
 508 #define LEDS_GPIO_DEFSTATE_OFF          0
 509 #define LEDS_GPIO_DEFSTATE_ON           1
 510 #define LEDS_GPIO_DEFSTATE_KEEP         2
 511
 512 struct gpio_led_platform_data {
 513         int             num_leds;
 514         const struct gpio_led *leds;
 515
 516 #define GPIO_LED_NO_BLINK_LOW   0       /* No blink GPIO state low */
 517 #define GPIO_LED_NO_BLINK_HIGH  1       /* No blink GPIO state high */
 518 #define GPIO_LED_BLINK          2       /* Please, blink */
 519         gpio_blink_set_t        gpio_blink_set;
 520 };
 521
 522 #ifdef CONFIG_NEW_LEDS
 523 struct platform_device *gpio_led_register_device(
 524                 int id, const struct gpio_led_platform_data *pdata);
 525 #else
 526 static inline struct platform_device *gpio_led_register_device(
 527                 int id, const struct gpio_led_platform_data *pdata)
 528 {
 529         return 0;
 530 }
 531 #endif
 532
 533 enum cpu_led_event {
 534         CPU_LED_IDLE_START,     /* CPU enters idle */
 535         CPU_LED_IDLE_END,       /* CPU idle ends */
 536         CPU_LED_START,          /* Machine starts, especially resume */
 537         CPU_LED_STOP,           /* Machine stops, especially suspend */
 538         CPU_LED_HALTED,         /* Machine shutdown */
 539 };
 540 #ifdef CONFIG_LEDS_TRIGGER_CPU
 541 void ledtrig_cpu(enum cpu_led_event evt);
 542 #else
 543 static inline void ledtrig_cpu(enum cpu_led_event evt)
 544 {
 545         return;
 546 }
 547 #endif
 548
 549 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
 550 void led_classdev_notify_brightness_hw_changed(
 551         struct led_classdev *led_cdev, enum led_brightness brightness);
 552 #else
 553 static inline void led_classdev_notify_brightness_hw_changed(
 554         struct led_classdev *led_cdev, enum led_brightness brightness) { }
 555 #endif
 556
 557 /**
 558  * struct led_pattern - pattern interval settings
 559  * @delta_t: pattern interval delay, in milliseconds
 560  * @brightness: pattern interval brightness
 561  */
 562 struct led_pattern {
 563         u32 delta_t;
 564         int brightness;
 565 };
 566
 567 enum led_audio {
 568         LED_AUDIO_MUTE,         /* master mute LED */
 569         LED_AUDIO_MICMUTE,      /* mic mute LED */
 570         NUM_AUDIO_LEDS
 571 };
 572
 573 #if IS_ENABLED(CONFIG_LEDS_TRIGGER_AUDIO)
 574 enum led_brightness ledtrig_audio_get(enum led_audio type);
 575 void ledtrig_audio_set(enum led_audio type, enum led_brightness state);
 576 #else
 577 static inline enum led_brightness ledtrig_audio_get(enum led_audio type)
 578 {
 579         return LED_OFF;
 580 }
 581 static inline void ledtrig_audio_set(enum led_audio type,
 582                                      enum led_brightness state)
 583 {
 584 }
 585 #endif
 586
 587 #endif          /* __LINUX_LEDS_H_INCLUDED */