1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Driver model for leds and led triggers
5 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
6 * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
8 #ifndef __LINUX_LEDS_H_INCLUDED
9 #define __LINUX_LEDS_H_INCLUDED
11 #include <dt-bindings/leds/common.h>
12 #include <linux/device.h>
13 #include <linux/mutex.h>
14 #include <linux/rwsem.h>
15 #include <linux/spinlock.h>
16 #include <linux/timer.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
20 struct attribute_group
;
26 struct platform_device
;
32 /* This is obsolete/useless. We now support variable maximum brightness. */
40 enum led_default_state
{
41 LEDS_DEFSTATE_OFF
= 0,
43 LEDS_DEFSTATE_KEEP
= 2,
47 * struct led_lookup_data - represents a single LED lookup entry
49 * @list: internal list of all LED lookup entries
50 * @provider: name of led_classdev providing the LED
51 * @dev_id: name of the device associated with this LED
52 * @con_id: name of the LED from the device's point of view
54 struct led_lookup_data
{
55 struct list_head list
;
61 struct led_init_data
{
62 /* device fwnode handle */
63 struct fwnode_handle
*fwnode
;
65 * default <color:function> tuple, for backward compatibility
66 * with in-driver hard-coded LED names used as a fallback when
67 * DT "label" property is absent; it should be set to NULL
68 * in new LED class drivers.
70 const char *default_label
;
72 * string to be used for devicename section of LED class device
73 * either for label based LED name composition path or for fwnode
74 * based when devname_mandatory is true
76 const char *devicename
;
78 * indicates if LED name should always comprise devicename section;
79 * only LEDs exposed by drivers of hot-pluggable devices should
82 bool devname_mandatory
;
85 #if IS_ENABLED(CONFIG_NEW_LEDS)
86 enum led_default_state
led_init_default_state_get(struct fwnode_handle
*fwnode
);
88 static inline enum led_default_state
89 led_init_default_state_get(struct fwnode_handle
*fwnode
)
91 return LEDS_DEFSTATE_OFF
;
95 struct led_hw_trigger_type
{
101 unsigned int brightness
;
102 unsigned int max_brightness
;
105 /* Lower 16 bits reflect status */
106 #define LED_SUSPENDED BIT(0)
107 #define LED_UNREGISTERING BIT(1)
108 /* Upper 16 bits reflect control information */
109 #define LED_CORE_SUSPENDRESUME BIT(16)
110 #define LED_SYSFS_DISABLE BIT(17)
111 #define LED_DEV_CAP_FLASH BIT(18)
112 #define LED_HW_PLUGGABLE BIT(19)
113 #define LED_PANIC_INDICATOR BIT(20)
114 #define LED_BRIGHT_HW_CHANGED BIT(21)
115 #define LED_RETAIN_AT_SHUTDOWN BIT(22)
116 #define LED_INIT_DEFAULT_TRIGGER BIT(23)
118 /* set_brightness_work / blink_timer flags, atomic, private. */
119 unsigned long work_flags
;
121 #define LED_BLINK_SW 0
122 #define LED_BLINK_ONESHOT 1
123 #define LED_BLINK_ONESHOT_STOP 2
124 #define LED_BLINK_INVERT 3
125 #define LED_BLINK_BRIGHTNESS_CHANGE 4
126 #define LED_BLINK_DISABLE 5
128 /* Set LED brightness level
129 * Must not sleep. Use brightness_set_blocking for drivers
130 * that can sleep while setting brightness.
132 void (*brightness_set
)(struct led_classdev
*led_cdev
,
133 enum led_brightness brightness
);
135 * Set LED brightness level immediately - it can block the caller for
136 * the time required for accessing a LED device register.
138 int (*brightness_set_blocking
)(struct led_classdev
*led_cdev
,
139 enum led_brightness brightness
);
140 /* Get LED brightness level */
141 enum led_brightness (*brightness_get
)(struct led_classdev
*led_cdev
);
144 * Activate hardware accelerated blink, delays are in milliseconds
145 * and if both are zero then a sensible default should be chosen.
146 * The call should adjust the timings in that case and if it can't
147 * match the values specified exactly.
148 * Deactivate blinking again when the brightness is set to LED_OFF
149 * via the brightness_set() callback.
151 int (*blink_set
)(struct led_classdev
*led_cdev
,
152 unsigned long *delay_on
,
153 unsigned long *delay_off
);
155 int (*pattern_set
)(struct led_classdev
*led_cdev
,
156 struct led_pattern
*pattern
, u32 len
, int repeat
);
157 int (*pattern_clear
)(struct led_classdev
*led_cdev
);
160 const struct attribute_group
**groups
;
162 struct list_head node
; /* LED Device list */
163 const char *default_trigger
; /* Trigger to use */
165 unsigned long blink_delay_on
, blink_delay_off
;
166 struct timer_list blink_timer
;
167 int blink_brightness
;
168 int new_blink_brightness
;
169 void (*flash_resume
)(struct led_classdev
*led_cdev
);
171 struct work_struct set_brightness_work
;
172 int delayed_set_value
;
174 #ifdef CONFIG_LEDS_TRIGGERS
175 /* Protects the trigger data below */
176 struct rw_semaphore trigger_lock
;
178 struct led_trigger
*trigger
;
179 struct list_head trig_list
;
181 /* true if activated - deactivate routine uses it to do cleanup */
184 /* LEDs that have private triggers have this set */
185 struct led_hw_trigger_type
*trigger_type
;
188 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
189 int brightness_hw_changed
;
190 struct kernfs_node
*brightness_hw_changed_kn
;
193 /* Ensures consistent access to the LED Flash Class device */
194 struct mutex led_access
;
198 * led_classdev_register_ext - register a new object of LED class with
200 * @parent: LED controller device this LED is driven by
201 * @led_cdev: the led_classdev structure for this device
202 * @init_data: the LED class device initialization data
204 * Register a new object of LED class, with name derived from init_data.
206 * Returns: 0 on success or negative error value on failure
208 int led_classdev_register_ext(struct device
*parent
,
209 struct led_classdev
*led_cdev
,
210 struct led_init_data
*init_data
);
213 * led_classdev_register - register a new object of LED class
214 * @parent: LED controller device this LED is driven by
215 * @led_cdev: the led_classdev structure for this device
217 * Register a new object of LED class, with name derived from the name property
218 * of passed led_cdev argument.
220 * Returns: 0 on success or negative error value on failure
222 static inline int led_classdev_register(struct device
*parent
,
223 struct led_classdev
*led_cdev
)
225 return led_classdev_register_ext(parent
, led_cdev
, NULL
);
228 #if IS_ENABLED(CONFIG_LEDS_CLASS)
229 int devm_led_classdev_register_ext(struct device
*parent
,
230 struct led_classdev
*led_cdev
,
231 struct led_init_data
*init_data
);
234 devm_led_classdev_register_ext(struct device
*parent
,
235 struct led_classdev
*led_cdev
,
236 struct led_init_data
*init_data
)
242 static inline int devm_led_classdev_register(struct device
*parent
,
243 struct led_classdev
*led_cdev
)
245 return devm_led_classdev_register_ext(parent
, led_cdev
, NULL
);
247 void led_classdev_unregister(struct led_classdev
*led_cdev
);
248 void devm_led_classdev_unregister(struct device
*parent
,
249 struct led_classdev
*led_cdev
);
250 void led_classdev_suspend(struct led_classdev
*led_cdev
);
251 void led_classdev_resume(struct led_classdev
*led_cdev
);
253 void led_add_lookup(struct led_lookup_data
*led_lookup
);
254 void led_remove_lookup(struct led_lookup_data
*led_lookup
);
256 struct led_classdev
*__must_check
led_get(struct device
*dev
, char *con_id
);
257 struct led_classdev
*__must_check
devm_led_get(struct device
*dev
, char *con_id
);
259 extern struct led_classdev
*of_led_get(struct device_node
*np
, int index
);
260 extern void led_put(struct led_classdev
*led_cdev
);
261 struct led_classdev
*__must_check
devm_of_led_get(struct device
*dev
,
265 * led_blink_set - set blinking with software fallback
266 * @led_cdev: the LED to start blinking
267 * @delay_on: the time it should be on (in ms)
268 * @delay_off: the time it should ble off (in ms)
270 * This function makes the LED blink, attempting to use the
271 * hardware acceleration if possible, but falling back to
272 * software blinking if there is no hardware blinking or if
273 * the LED refuses the passed values.
275 * Note that if software blinking is active, simply calling
276 * led_cdev->brightness_set() will not stop the blinking,
277 * use led_set_brightness() instead.
279 void led_blink_set(struct led_classdev
*led_cdev
, unsigned long *delay_on
,
280 unsigned long *delay_off
);
282 * led_blink_set_oneshot - do a oneshot software blink
283 * @led_cdev: the LED to start blinking
284 * @delay_on: the time it should be on (in ms)
285 * @delay_off: the time it should ble off (in ms)
286 * @invert: blink off, then on, leaving the led on
288 * This function makes the LED blink one time for delay_on +
289 * delay_off time, ignoring the request if another one-shot
290 * blink is already in progress.
292 * If invert is set, led blinks for delay_off first, then for
293 * delay_on and leave the led on after the on-off cycle.
295 void led_blink_set_oneshot(struct led_classdev
*led_cdev
,
296 unsigned long *delay_on
, unsigned long *delay_off
,
299 * led_set_brightness - set LED brightness
300 * @led_cdev: the LED to set
301 * @brightness: the brightness to set it to
303 * Set an LED's brightness, and, if necessary, cancel the
304 * software blink timer that implements blinking when the
305 * hardware doesn't. This function is guaranteed not to sleep.
307 void led_set_brightness(struct led_classdev
*led_cdev
, unsigned int brightness
);
310 * led_set_brightness_sync - set LED brightness synchronously
311 * @led_cdev: the LED to set
312 * @value: the brightness to set it to
314 * Set an LED's brightness immediately. This function will block
315 * the caller for the time required for accessing device registers,
318 * Returns: 0 on success or negative error value on failure
320 int led_set_brightness_sync(struct led_classdev
*led_cdev
, unsigned int value
);
323 * led_update_brightness - update LED brightness
324 * @led_cdev: the LED to query
326 * Get an LED's current brightness and update led_cdev->brightness
327 * member with the obtained value.
329 * Returns: 0 on success or negative error value on failure
331 int led_update_brightness(struct led_classdev
*led_cdev
);
334 * led_get_default_pattern - return default pattern
336 * @led_cdev: the LED to get default pattern for
337 * @size: pointer for storing the number of elements in returned array,
338 * modified only if return != NULL
340 * Return: Allocated array of integers with default pattern from device tree
341 * or NULL. Caller is responsible for kfree().
343 u32
*led_get_default_pattern(struct led_classdev
*led_cdev
, unsigned int *size
);
346 * led_sysfs_disable - disable LED sysfs interface
347 * @led_cdev: the LED to set
349 * Disable the led_cdev's sysfs interface.
351 void led_sysfs_disable(struct led_classdev
*led_cdev
);
354 * led_sysfs_enable - enable LED sysfs interface
355 * @led_cdev: the LED to set
357 * Enable the led_cdev's sysfs interface.
359 void led_sysfs_enable(struct led_classdev
*led_cdev
);
362 * led_compose_name - compose LED class device name
363 * @dev: LED controller device object
364 * @init_data: the LED class device initialization data
365 * @led_classdev_name: composed LED class device name
367 * Create LED class device name basing on the provided init_data argument.
368 * The name can have <devicename:color:function> or <color:function>.
369 * form, depending on the init_data configuration.
371 * Returns: 0 on success or negative error value on failure
373 int led_compose_name(struct device
*dev
, struct led_init_data
*init_data
,
374 char *led_classdev_name
);
377 * led_sysfs_is_disabled - check if LED sysfs interface is disabled
378 * @led_cdev: the LED to query
380 * Returns: true if the led_cdev's sysfs interface is disabled.
382 static inline bool led_sysfs_is_disabled(struct led_classdev
*led_cdev
)
384 return led_cdev
->flags
& LED_SYSFS_DISABLE
;
390 /* Registration functions for simple triggers */
391 #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
392 #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
394 #ifdef CONFIG_LEDS_TRIGGERS
396 #define TRIG_NAME_MAX 50
399 /* Trigger Properties */
401 int (*activate
)(struct led_classdev
*led_cdev
);
402 void (*deactivate
)(struct led_classdev
*led_cdev
);
404 /* LED-private triggers have this set */
405 struct led_hw_trigger_type
*trigger_type
;
407 /* LEDs under control by this trigger (for simple triggers) */
408 spinlock_t leddev_list_lock
;
409 struct list_head led_cdevs
;
411 /* Link to next registered trigger */
412 struct list_head next_trig
;
414 const struct attribute_group
**groups
;
418 * Currently the attributes in struct led_trigger::groups are added directly to
419 * the LED device. As this might change in the future, the following
420 * macros abstract getting the LED device and its trigger_data from the dev
421 * parameter passed to the attribute accessor functions.
423 #define led_trigger_get_led(dev) ((struct led_classdev *)dev_get_drvdata((dev)))
424 #define led_trigger_get_drvdata(dev) (led_get_trigger_data(led_trigger_get_led(dev)))
426 /* Registration functions for complex triggers */
427 int led_trigger_register(struct led_trigger
*trigger
);
428 void led_trigger_unregister(struct led_trigger
*trigger
);
429 int devm_led_trigger_register(struct device
*dev
,
430 struct led_trigger
*trigger
);
432 void led_trigger_register_simple(const char *name
,
433 struct led_trigger
**trigger
);
434 void led_trigger_unregister_simple(struct led_trigger
*trigger
);
435 void led_trigger_event(struct led_trigger
*trigger
, enum led_brightness event
);
436 void led_trigger_blink(struct led_trigger
*trigger
, unsigned long *delay_on
,
437 unsigned long *delay_off
);
438 void led_trigger_blink_oneshot(struct led_trigger
*trigger
,
439 unsigned long *delay_on
,
440 unsigned long *delay_off
,
442 void led_trigger_set_default(struct led_classdev
*led_cdev
);
443 int led_trigger_set(struct led_classdev
*led_cdev
, struct led_trigger
*trigger
);
444 void led_trigger_remove(struct led_classdev
*led_cdev
);
446 static inline void led_set_trigger_data(struct led_classdev
*led_cdev
,
449 led_cdev
->trigger_data
= trigger_data
;
452 static inline void *led_get_trigger_data(struct led_classdev
*led_cdev
)
454 return led_cdev
->trigger_data
;
458 * led_trigger_rename_static - rename a trigger
459 * @name: the new trigger name
460 * @trig: the LED trigger to rename
462 * Change a LED trigger name by copying the string passed in
463 * name into current trigger name, which MUST be large
464 * enough for the new string.
466 * Note that name must NOT point to the same string used
467 * during LED registration, as that could lead to races.
469 * This is meant to be used on triggers with statically
472 void led_trigger_rename_static(const char *name
, struct led_trigger
*trig
);
474 #define module_led_trigger(__led_trigger) \
475 module_driver(__led_trigger, led_trigger_register, \
476 led_trigger_unregister)
480 /* Trigger has no members */
481 struct led_trigger
{};
483 /* Trigger inline empty functions */
484 static inline void led_trigger_register_simple(const char *name
,
485 struct led_trigger
**trigger
) {}
486 static inline void led_trigger_unregister_simple(struct led_trigger
*trigger
) {}
487 static inline void led_trigger_event(struct led_trigger
*trigger
,
488 enum led_brightness event
) {}
489 static inline void led_trigger_blink(struct led_trigger
*trigger
,
490 unsigned long *delay_on
,
491 unsigned long *delay_off
) {}
492 static inline void led_trigger_blink_oneshot(struct led_trigger
*trigger
,
493 unsigned long *delay_on
,
494 unsigned long *delay_off
,
496 static inline void led_trigger_set_default(struct led_classdev
*led_cdev
) {}
497 static inline int led_trigger_set(struct led_classdev
*led_cdev
,
498 struct led_trigger
*trigger
)
503 static inline void led_trigger_remove(struct led_classdev
*led_cdev
) {}
504 static inline void led_set_trigger_data(struct led_classdev
*led_cdev
) {}
505 static inline void *led_get_trigger_data(struct led_classdev
*led_cdev
)
510 #endif /* CONFIG_LEDS_TRIGGERS */
512 /* Trigger specific functions */
513 #ifdef CONFIG_LEDS_TRIGGER_DISK
514 void ledtrig_disk_activity(bool write
);
516 static inline void ledtrig_disk_activity(bool write
) {}
519 #ifdef CONFIG_LEDS_TRIGGER_MTD
520 void ledtrig_mtd_activity(void);
522 static inline void ledtrig_mtd_activity(void) {}
525 #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
526 void ledtrig_flash_ctrl(bool on
);
527 void ledtrig_torch_ctrl(bool on
);
529 static inline void ledtrig_flash_ctrl(bool on
) {}
530 static inline void ledtrig_torch_ctrl(bool on
) {}
534 * Generic LED platform data for describing LED names and default triggers.
538 const char *default_trigger
;
542 struct led_platform_data
{
544 struct led_info
*leds
;
547 struct led_properties
{
550 const char *function
;
552 bool func_enum_present
;
556 typedef int (*gpio_blink_set_t
)(struct gpio_desc
*desc
, int state
,
557 unsigned long *delay_on
,
558 unsigned long *delay_off
);
560 /* For the leds-gpio driver */
563 const char *default_trigger
;
565 unsigned active_low
: 1;
566 unsigned retain_state_suspended
: 1;
567 unsigned panic_indicator
: 1;
568 unsigned default_state
: 2;
569 unsigned retain_state_shutdown
: 1;
570 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
571 struct gpio_desc
*gpiod
;
573 #define LEDS_GPIO_DEFSTATE_OFF LEDS_DEFSTATE_OFF
574 #define LEDS_GPIO_DEFSTATE_ON LEDS_DEFSTATE_ON
575 #define LEDS_GPIO_DEFSTATE_KEEP LEDS_DEFSTATE_KEEP
577 struct gpio_led_platform_data
{
579 const struct gpio_led
*leds
;
581 #define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
582 #define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
583 #define GPIO_LED_BLINK 2 /* Please, blink */
584 gpio_blink_set_t gpio_blink_set
;
587 #ifdef CONFIG_NEW_LEDS
588 struct platform_device
*gpio_led_register_device(
589 int id
, const struct gpio_led_platform_data
*pdata
);
591 static inline struct platform_device
*gpio_led_register_device(
592 int id
, const struct gpio_led_platform_data
*pdata
)
599 CPU_LED_IDLE_START
, /* CPU enters idle */
600 CPU_LED_IDLE_END
, /* CPU idle ends */
601 CPU_LED_START
, /* Machine starts, especially resume */
602 CPU_LED_STOP
, /* Machine stops, especially suspend */
603 CPU_LED_HALTED
, /* Machine shutdown */
605 #ifdef CONFIG_LEDS_TRIGGER_CPU
606 void ledtrig_cpu(enum cpu_led_event evt
);
608 static inline void ledtrig_cpu(enum cpu_led_event evt
)
614 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
615 void led_classdev_notify_brightness_hw_changed(
616 struct led_classdev
*led_cdev
, unsigned int brightness
);
618 static inline void led_classdev_notify_brightness_hw_changed(
619 struct led_classdev
*led_cdev
, enum led_brightness brightness
) { }
623 * struct led_pattern - pattern interval settings
624 * @delta_t: pattern interval delay, in milliseconds
625 * @brightness: pattern interval brightness
633 LED_AUDIO_MUTE
, /* master mute LED */
634 LED_AUDIO_MICMUTE
, /* mic mute LED */
638 #if IS_ENABLED(CONFIG_LEDS_TRIGGER_AUDIO)
639 enum led_brightness
ledtrig_audio_get(enum led_audio type
);
640 void ledtrig_audio_set(enum led_audio type
, enum led_brightness state
);
642 static inline enum led_brightness
ledtrig_audio_get(enum led_audio type
)
646 static inline void ledtrig_audio_set(enum led_audio type
,
647 enum led_brightness state
)
652 #endif /* __LINUX_LEDS_H_INCLUDED */