1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Driver model for leds and led triggers
11 #include <dt-bindings/leds/common.h>
47  * struct led_lookup_data - represents a single LED lookup entry
66 	 * with in-driver hard-coded LED names used as a fallback when
79 	 * only LEDs exposed by drivers of hot-pluggable devices should
128 	/* Brightness off also disables hw-blinking so it is a separate action */
140 	 * Set LED brightness level immediately - it can block the caller for
165 			   struct led_pattern *pattern, u32 len, int repeat);
172 	const char		*default_trigger;	/* Trigger to use */
186 	/* Protects the trigger data below */
189 	struct led_trigger	*trigger;  member
192 	/* true if activated - deactivate routine uses it to do cleanup */
195 	/* LEDs that have private triggers have this set */
198 	/* Unique trigger name supported by LED set in hw control mode */
202 	 * defined supported trigger to setup the LED to hw control mode.
204 	 * Return 0 on success. Return -EOPNOTSUPP when the passed flags are not
213 	 * from the supported trigger and setup the LED to be driven by hardware
214 	 * following the requested mode from the trigger flags.
225 	 * Trigger can use this to get the initial state of a LED already set in
230 	 * may be in a not supported initial state by the attached LED trigger.
252  * led_classdev_register_ext - register a new object of LED class with
267  * led_classdev_register - register a new object of LED class
321  * led_blink_set - set blinking with software fallback
334  * led_cdev->brightness_set() will not stop the blinking,
341  * led_blink_set_nosleep - set blinking, guaranteed to not sleep
353  * led_blink_set_oneshot - do a oneshot software blink
360  * delay_off time, ignoring the request if another one-shot
364  * delay_on and leave the led on after the on-off cycle.
372  * led_set_brightness - set LED brightness
383  * led_set_brightness_sync - set LED brightness synchronously
396  * led_update_brightness - update LED brightness
399  * Get an LED's current brightness and update led_cdev->brightness
407  * led_get_default_pattern - return default pattern
409  * @led_cdev: the LED to get default pattern for
413  * Return:    Allocated array of integers with default pattern from device tree
419  * led_sysfs_disable - disable LED sysfs interface
427  * led_sysfs_enable - enable LED sysfs interface
435  * led_compose_name - compose LED class device name
450  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
457 	return led_cdev->flags & LED_SYSFS_DISABLE;  in led_sysfs_is_disabled()
472 	/* Trigger Properties */
477 	/* LED-private triggers have this set */
480 	/* LEDs under control by this trigger (for simple triggers) */
484 	/* Link to next registered trigger */
500 int led_trigger_register(struct led_trigger *trigger);
501 void led_trigger_unregister(struct led_trigger *trigger);
503 				     struct led_trigger *trigger);
506 				struct led_trigger **trigger);
507 void led_trigger_unregister_simple(struct led_trigger *trigger);
508 void led_trigger_event(struct led_trigger *trigger,  enum led_brightness event);
509 void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
511 void led_trigger_blink_oneshot(struct led_trigger *trigger,
516 int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
522 	led_cdev->trigger_data = trigger_data;  in led_set_trigger_data()
527 	return led_cdev->trigger_data;  in led_get_trigger_data()
536 /* Trigger has no members */
539 /* Trigger inline empty functions */
541 					struct led_trigger **trigger) {}  in led_trigger_register_simple()  argument
542 static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}  in led_trigger_unregister_simple()  argument
543 static inline void led_trigger_event(struct led_trigger *trigger,  in led_trigger_event()  argument
545 static inline void led_trigger_blink(struct led_trigger *trigger,  in led_trigger_blink()  argument
548 static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,  in led_trigger_blink_oneshot()  argument
554 				  struct led_trigger *trigger)  in led_trigger_set()  argument
568 /* Trigger specific enum */
586 /* Trigger specific functions */
618 	struct led_info	*leds;  member
634 /* For the leds-gpio driver */
653 	const struct gpio_led *leds;  member
697  * struct led_pattern - pattern interval settings
698  * @delta_t: pattern interval delay, in milliseconds
699  * @brightness: pattern interval brightness