include/linux/leds.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Driver model for leds and led triggers
11 #include <dt-bindings/leds/common.h>
25  * LED Core
41 	 * with in-driver hard-coded LED names used as a fallback when
43 	 * in new LED class drivers.
47 	 * string to be used for devicename section of LED class device
48 	 * either for label based LED name composition path or for fwnode
53 	 * indicates if LED name should always comprise devicename section;
54 	 * only LEDs exposed by drivers of hot-pluggable devices should
93 	/* Set LED brightness level
100 	 * Set LED brightness level immediately - it can block the caller for
101 	 * the time required for accessing a LED device register.
105 	/* Get LED brightness level */
121 			   struct led_pattern *pattern, u32 len, int repeat);
127 	struct list_head	 node;			/* LED Device list */
146 	/* true if activated - deactivate routine uses it to do cleanup */
158 	/* Ensures consistent access to the LED Flash Class device */
163  * led_classdev_register_ext - register a new object of LED class with
165  * @parent: LED controller device this LED is driven by
167  * @init_data: the LED class device initialization data
169  * Register a new object of LED class, with name derived from init_data.
178  * led_classdev_register - register a new object of LED class
179  * @parent: LED controller device this LED is driven by
182  * Register a new object of LED class, with name derived from the name property
214  * led_blink_set - set blinking with software fallback
215  * @led_cdev: the LED to start blinking
219  * This function makes the LED blink, attempting to use the
222  * the LED refuses the passed values.
225  * led_cdev->brightness_set() will not stop the blinking,
231  * led_blink_set_oneshot - do a oneshot software blink
232  * @led_cdev: the LED to start blinking
235  * @invert: blink off, then on, leaving the led on
237  * This function makes the LED blink one time for delay_on +
238  * delay_off time, ignoring the request if another one-shot
241  * If invert is set, led blinks for delay_off first, then for
242  * delay_on and leave the led on after the on-off cycle.
248  * led_set_brightness - set LED brightness
249  * @led_cdev: the LED to set
252  * Set an LED's brightness, and, if necessary, cancel the
260  * led_set_brightness_sync - set LED brightness synchronously
261  * @led_cdev: the LED to set
264  * Set an LED's brightness immediately. This function will block
274  * led_update_brightness - update LED brightness
275  * @led_cdev: the LED to query
277  * Get an LED's current brightness and update led_cdev->brightness
285  * led_get_default_pattern - return default pattern
287  * @led_cdev: the LED to get default pattern for
291  * Return:    Allocated array of integers with default pattern from device tree
297  * led_sysfs_disable - disable LED sysfs interface
298  * @led_cdev: the LED to set
305  * led_sysfs_enable - enable LED sysfs interface
306  * @led_cdev: the LED to set
313  * led_compose_name - compose LED class device name
314  * @dev: LED controller device object
315  * @init_data: the LED class device initialization data
316  * @led_classdev_name: composed LED class device name
318  * Create LED class device name basing on the provided init_data argument.
328  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
329  * @led_cdev: the LED to query
335 	return led_cdev->flags & LED_SYSFS_DISABLE;  in led_sysfs_is_disabled()
339  * LED Triggers
355 	/* LED-private triggers have this set */
370  * the LED device. As this might change in the future, the following
371  * macros abstract getting the LED device and its trigger_data from the dev
400 	led_cdev->trigger_data = trigger_data;  in led_set_trigger_data()
405 	return led_cdev->trigger_data;  in led_get_trigger_data()
409  * led_trigger_rename_static - rename a trigger
411  * @trig: the LED trigger to rename
413  * Change a LED trigger name by copying the string passed in
418  * during LED registration, as that could lead to races.
485  * Generic LED platform data for describing LED names and default triggers.
512 /* For the leds-gpio driver */
575  * struct led_pattern - pattern interval settings
576  * @delta_t: pattern interval delay, in milliseconds
577  * @brightness: pattern interval brightness
585 	LED_AUDIO_MUTE,		/* master mute LED */
586 	LED_AUDIO_MICMUTE,	/* mic mute LED */