xref: /linux-6.15/include/linux/leds.h (revision 4c4ade1a)
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/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>
19 
20 struct attribute_group;
21 struct device_node;
22 struct fwnode_handle;
23 struct gpio_desc;
24 struct kernfs_node;
25 struct led_pattern;
26 struct platform_device;
27 
28 /*
29  * LED Core
30  */
31 
32 /* This is obsolete/useless. We now support variable maximum brightness. */
33 enum led_brightness {
34 	LED_OFF		= 0,
35 	LED_ON		= 1,
36 	LED_HALF	= 127,
37 	LED_FULL	= 255,
38 };
39 
40 enum led_default_state {
41 	LEDS_DEFSTATE_OFF	= 0,
42 	LEDS_DEFSTATE_ON	= 1,
43 	LEDS_DEFSTATE_KEEP	= 2,
44 };
45 
46 /**
47  * struct led_lookup_data - represents a single LED lookup entry
48  *
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
53  */
54 struct led_lookup_data {
55 	struct list_head list;
56 	const char *provider;
57 	const char *dev_id;
58 	const char *con_id;
59 };
60 
61 struct led_init_data {
62 	/* device fwnode handle */
63 	struct fwnode_handle *fwnode;
64 	/*
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.
69 	 */
70 	const char *default_label;
71 	/*
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
75 	 */
76 	const char *devicename;
77 	/*
78 	 * indicates if LED name should always comprise devicename section;
79 	 * only LEDs exposed by drivers of hot-pluggable devices should
80 	 * set it to true
81 	 */
82 	bool devname_mandatory;
83 };
84 
85 enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode);
86 
87 struct led_hw_trigger_type {
88 	int dummy;
89 };
90 
91 struct led_classdev {
92 	const char		*name;
93 	unsigned int brightness;
94 	unsigned int max_brightness;
95 	unsigned int color;
96 	int			 flags;
97 
98 	/* Lower 16 bits reflect status */
99 #define LED_SUSPENDED		BIT(0)
100 #define LED_UNREGISTERING	BIT(1)
101 	/* Upper 16 bits reflect control information */
102 #define LED_CORE_SUSPENDRESUME	BIT(16)
103 #define LED_SYSFS_DISABLE	BIT(17)
104 #define LED_DEV_CAP_FLASH	BIT(18)
105 #define LED_HW_PLUGGABLE	BIT(19)
106 #define LED_PANIC_INDICATOR	BIT(20)
107 #define LED_BRIGHT_HW_CHANGED	BIT(21)
108 #define LED_RETAIN_AT_SHUTDOWN	BIT(22)
109 #define LED_INIT_DEFAULT_TRIGGER BIT(23)
110 #define LED_REJECT_NAME_CONFLICT BIT(24)
111 
112 	/* set_brightness_work / blink_timer flags, atomic, private. */
113 	unsigned long		work_flags;
114 
115 #define LED_BLINK_SW			0
116 #define LED_BLINK_ONESHOT		1
117 #define LED_BLINK_ONESHOT_STOP		2
118 #define LED_BLINK_INVERT		3
119 #define LED_BLINK_BRIGHTNESS_CHANGE 	4
120 #define LED_BLINK_DISABLE		5
121 	/* Brightness off also disables hw-blinking so it is a separate action */
122 #define LED_SET_BRIGHTNESS_OFF		6
123 #define LED_SET_BRIGHTNESS		7
124 #define LED_SET_BLINK			8
125 
126 	/* Set LED brightness level
127 	 * Must not sleep. Use brightness_set_blocking for drivers
128 	 * that can sleep while setting brightness.
129 	 */
130 	void		(*brightness_set)(struct led_classdev *led_cdev,
131 					  enum led_brightness brightness);
132 	/*
133 	 * Set LED brightness level immediately - it can block the caller for
134 	 * the time required for accessing a LED device register.
135 	 */
136 	int (*brightness_set_blocking)(struct led_classdev *led_cdev,
137 				       enum led_brightness brightness);
138 	/* Get LED brightness level */
139 	enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
140 
141 	/*
142 	 * Activate hardware accelerated blink, delays are in milliseconds
143 	 * and if both are zero then a sensible default should be chosen.
144 	 * The call should adjust the timings in that case and if it can't
145 	 * match the values specified exactly.
146 	 * Deactivate blinking again when the brightness is set to LED_OFF
147 	 * via the brightness_set() callback.
148 	 * For led_blink_set_nosleep() the LED core assumes that blink_set
149 	 * implementations, of drivers which do not use brightness_set_blocking,
150 	 * will not sleep. Therefor if brightness_set_blocking is not set
151 	 * this function must not sleep!
152 	 */
153 	int		(*blink_set)(struct led_classdev *led_cdev,
154 				     unsigned long *delay_on,
155 				     unsigned long *delay_off);
156 
157 	int (*pattern_set)(struct led_classdev *led_cdev,
158 			   struct led_pattern *pattern, u32 len, int repeat);
159 	int (*pattern_clear)(struct led_classdev *led_cdev);
160 
161 	struct device		*dev;
162 	const struct attribute_group	**groups;
163 
164 	struct list_head	 node;			/* LED Device list */
165 	const char		*default_trigger;	/* Trigger to use */
166 
167 	unsigned long		 blink_delay_on, blink_delay_off;
168 	struct timer_list	 blink_timer;
169 	int			 blink_brightness;
170 	int			 new_blink_brightness;
171 	void			(*flash_resume)(struct led_classdev *led_cdev);
172 
173 	struct work_struct	set_brightness_work;
174 	int			delayed_set_value;
175 	unsigned long		delayed_delay_on;
176 	unsigned long		delayed_delay_off;
177 
178 #ifdef CONFIG_LEDS_TRIGGERS
179 	/* Protects the trigger data below */
180 	struct rw_semaphore	 trigger_lock;
181 
182 	struct led_trigger	*trigger;
183 	struct list_head	 trig_list;
184 	void			*trigger_data;
185 	/* true if activated - deactivate routine uses it to do cleanup */
186 	bool			activated;
187 
188 	/* LEDs that have private triggers have this set */
189 	struct led_hw_trigger_type	*trigger_type;
190 
191 	/* Unique trigger name supported by LED set in hw control mode */
192 	const char		*hw_control_trigger;
193 	/*
194 	 * Check if the LED driver supports the requested mode provided by the
195 	 * defined supported trigger to setup the LED to hw control mode.
196 	 *
197 	 * Return 0 on success. Return -EOPNOTSUPP when the passed flags are not
198 	 * supported and software fallback needs to be used.
199 	 * Return a negative error number on any other case  for check fail due
200 	 * to various reason like device not ready or timeouts.
201 	 */
202 	int			(*hw_control_is_supported)(struct led_classdev *led_cdev,
203 							   unsigned long flags);
204 	/*
205 	 * Activate hardware control, LED driver will use the provided flags
206 	 * from the supported trigger and setup the LED to be driven by hardware
207 	 * following the requested mode from the trigger flags.
208 	 * Deactivate hardware blink control by setting brightness to LED_OFF via
209 	 * the brightness_set() callback.
210 	 *
211 	 * Return 0 on success, a negative error number on flags apply fail.
212 	 */
213 	int			(*hw_control_set)(struct led_classdev *led_cdev,
214 						  unsigned long flags);
215 	/*
216 	 * Get from the LED driver the current mode that the LED is set in hw
217 	 * control mode and put them in flags.
218 	 * Trigger can use this to get the initial state of a LED already set in
219 	 * hardware blink control.
220 	 *
221 	 * Return 0 on success, a negative error number on failing parsing the
222 	 * initial mode. Error from this function is NOT FATAL as the device
223 	 * may be in a not supported initial state by the attached LED trigger.
224 	 */
225 	int			(*hw_control_get)(struct led_classdev *led_cdev,
226 						  unsigned long *flags);
227 	/*
228 	 * Get the device this LED blinks in response to.
229 	 * e.g. for a PHY LED, it is the network device. If the LED is
230 	 * not yet associated to a device, return NULL.
231 	 */
232 	struct device		*(*hw_control_get_device)(struct led_classdev *led_cdev);
233 #endif
234 
235 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
236 	int			 brightness_hw_changed;
237 	struct kernfs_node	*brightness_hw_changed_kn;
238 #endif
239 
240 	/* Ensures consistent access to the LED Flash Class device */
241 	struct mutex		led_access;
242 };
243 
244 /**
245  * led_classdev_register_ext - register a new object of LED class with
246  *			       init data
247  * @parent: LED controller device this LED is driven by
248  * @led_cdev: the led_classdev structure for this device
249  * @init_data: the LED class device initialization data
250  *
251  * Register a new object of LED class, with name derived from init_data.
252  *
253  * Returns: 0 on success or negative error value on failure
254  */
255 int led_classdev_register_ext(struct device *parent,
256 				     struct led_classdev *led_cdev,
257 				     struct led_init_data *init_data);
258 
259 /**
260  * led_classdev_register - register a new object of LED class
261  * @parent: LED controller device this LED is driven by
262  * @led_cdev: the led_classdev structure for this device
263  *
264  * Register a new object of LED class, with name derived from the name property
265  * of passed led_cdev argument.
266  *
267  * Returns: 0 on success or negative error value on failure
268  */
269 static inline int led_classdev_register(struct device *parent,
270 					struct led_classdev *led_cdev)
271 {
272 	return led_classdev_register_ext(parent, led_cdev, NULL);
273 }
274 
275 int devm_led_classdev_register_ext(struct device *parent,
276 					  struct led_classdev *led_cdev,
277 					  struct led_init_data *init_data);
278 static inline int devm_led_classdev_register(struct device *parent,
279 					     struct led_classdev *led_cdev)
280 {
281 	return devm_led_classdev_register_ext(parent, led_cdev, NULL);
282 }
283 void led_classdev_unregister(struct led_classdev *led_cdev);
284 void devm_led_classdev_unregister(struct device *parent,
285 				  struct led_classdev *led_cdev);
286 void led_classdev_suspend(struct led_classdev *led_cdev);
287 void led_classdev_resume(struct led_classdev *led_cdev);
288 
289 void led_add_lookup(struct led_lookup_data *led_lookup);
290 void led_remove_lookup(struct led_lookup_data *led_lookup);
291 
292 struct led_classdev *__must_check led_get(struct device *dev, char *con_id);
293 struct led_classdev *__must_check devm_led_get(struct device *dev, char *con_id);
294 
295 extern struct led_classdev *of_led_get(struct device_node *np, int index);
296 extern void led_put(struct led_classdev *led_cdev);
297 struct led_classdev *__must_check devm_of_led_get(struct device *dev,
298 						  int index);
299 struct led_classdev *__must_check devm_of_led_get_optional(struct device *dev,
300 						  int index);
301 
302 /**
303  * led_blink_set - set blinking with software fallback
304  * @led_cdev: the LED to start blinking
305  * @delay_on: the time it should be on (in ms)
306  * @delay_off: the time it should ble off (in ms)
307  *
308  * This function makes the LED blink, attempting to use the
309  * hardware acceleration if possible, but falling back to
310  * software blinking if there is no hardware blinking or if
311  * the LED refuses the passed values.
312  *
313  * This function may sleep!
314  *
315  * Note that if software blinking is active, simply calling
316  * led_cdev->brightness_set() will not stop the blinking,
317  * use led_set_brightness() instead.
318  */
319 void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
320 		   unsigned long *delay_off);
321 
322 /**
323  * led_blink_set_nosleep - set blinking, guaranteed to not sleep
324  * @led_cdev: the LED to start blinking
325  * @delay_on: the time it should be on (in ms)
326  * @delay_off: the time it should ble off (in ms)
327  *
328  * This function makes the LED blink and is guaranteed to not sleep. Otherwise
329  * this is the same as led_blink_set(), see led_blink_set() for details.
330  */
331 void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
332 			   unsigned long delay_off);
333 
334 /**
335  * led_blink_set_oneshot - do a oneshot software blink
336  * @led_cdev: the LED to start blinking
337  * @delay_on: the time it should be on (in ms)
338  * @delay_off: the time it should ble off (in ms)
339  * @invert: blink off, then on, leaving the led on
340  *
341  * This function makes the LED blink one time for delay_on +
342  * delay_off time, ignoring the request if another one-shot
343  * blink is already in progress.
344  *
345  * If invert is set, led blinks for delay_off first, then for
346  * delay_on and leave the led on after the on-off cycle.
347  *
348  * This function is guaranteed not to sleep.
349  */
350 void led_blink_set_oneshot(struct led_classdev *led_cdev,
351 			   unsigned long *delay_on, unsigned long *delay_off,
352 			   int invert);
353 /**
354  * led_set_brightness - set LED brightness
355  * @led_cdev: the LED to set
356  * @brightness: the brightness to set it to
357  *
358  * Set an LED's brightness, and, if necessary, cancel the
359  * software blink timer that implements blinking when the
360  * hardware doesn't. This function is guaranteed not to sleep.
361  */
362 void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness);
363 
364 /**
365  * led_set_brightness_sync - set LED brightness synchronously
366  * @led_cdev: the LED to set
367  * @value: the brightness to set it to
368  *
369  * Set an LED's brightness immediately. This function will block
370  * the caller for the time required for accessing device registers,
371  * and it can sleep.
372  *
373  * Returns: 0 on success or negative error value on failure
374  */
375 int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value);
376 
377 /**
378  * led_update_brightness - update LED brightness
379  * @led_cdev: the LED to query
380  *
381  * Get an LED's current brightness and update led_cdev->brightness
382  * member with the obtained value.
383  *
384  * Returns: 0 on success or negative error value on failure
385  */
386 int led_update_brightness(struct led_classdev *led_cdev);
387 
388 /**
389  * led_get_default_pattern - return default pattern
390  *
391  * @led_cdev: the LED to get default pattern for
392  * @size:     pointer for storing the number of elements in returned array,
393  *            modified only if return != NULL
394  *
395  * Return:    Allocated array of integers with default pattern from device tree
396  *            or NULL.  Caller is responsible for kfree().
397  */
398 u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
399 
400 /**
401  * led_sysfs_disable - disable LED sysfs interface
402  * @led_cdev: the LED to set
403  *
404  * Disable the led_cdev's sysfs interface.
405  */
406 void led_sysfs_disable(struct led_classdev *led_cdev);
407 
408 /**
409  * led_sysfs_enable - enable LED sysfs interface
410  * @led_cdev: the LED to set
411  *
412  * Enable the led_cdev's sysfs interface.
413  */
414 void led_sysfs_enable(struct led_classdev *led_cdev);
415 
416 /**
417  * led_compose_name - compose LED class device name
418  * @dev: LED controller device object
419  * @init_data: the LED class device initialization data
420  * @led_classdev_name: composed LED class device name
421  *
422  * Create LED class device name basing on the provided init_data argument.
423  * The name can have <devicename:color:function> or <color:function>.
424  * form, depending on the init_data configuration.
425  *
426  * Returns: 0 on success or negative error value on failure
427  */
428 int led_compose_name(struct device *dev, struct led_init_data *init_data,
429 		     char *led_classdev_name);
430 
431 /**
432  * led_get_color_name - get string representation of color ID
433  * @color_id: The LED_COLOR_ID_* constant
434  *
435  * Get the string name of a LED_COLOR_ID_* constant.
436  *
437  * Returns: A string constant or NULL on an invalid ID.
438  */
439 const char *led_get_color_name(u8 color_id);
440 
441 /**
442  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
443  * @led_cdev: the LED to query
444  *
445  * Returns: true if the led_cdev's sysfs interface is disabled.
446  */
447 static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
448 {
449 	return led_cdev->flags & LED_SYSFS_DISABLE;
450 }
451 
452 /*
453  * LED Triggers
454  */
455 /* Registration functions for simple triggers */
456 #define DEFINE_LED_TRIGGER(x)		static struct led_trigger *x;
457 #define DEFINE_LED_TRIGGER_GLOBAL(x)	struct led_trigger *x;
458 
459 #ifdef CONFIG_LEDS_TRIGGERS
460 
461 #define TRIG_NAME_MAX 50
462 
463 struct led_trigger {
464 	/* Trigger Properties */
465 	const char	 *name;
466 	int		(*activate)(struct led_classdev *led_cdev);
467 	void		(*deactivate)(struct led_classdev *led_cdev);
468 
469 	/* Brightness set by led_trigger_event */
470 	enum led_brightness brightness;
471 
472 	/* LED-private triggers have this set */
473 	struct led_hw_trigger_type *trigger_type;
474 
475 	/* LEDs under control by this trigger (for simple triggers) */
476 	spinlock_t	  leddev_list_lock;
477 	struct list_head  led_cdevs;
478 
479 	/* Link to next registered trigger */
480 	struct list_head  next_trig;
481 
482 	const struct attribute_group **groups;
483 };
484 
485 /*
486  * Currently the attributes in struct led_trigger::groups are added directly to
487  * the LED device. As this might change in the future, the following
488  * macros abstract getting the LED device and its trigger_data from the dev
489  * parameter passed to the attribute accessor functions.
490  */
491 #define led_trigger_get_led(dev)	((struct led_classdev *)dev_get_drvdata((dev)))
492 #define led_trigger_get_drvdata(dev)	(led_get_trigger_data(led_trigger_get_led(dev)))
493 
494 /* Registration functions for complex triggers */
495 int led_trigger_register(struct led_trigger *trigger);
496 void led_trigger_unregister(struct led_trigger *trigger);
497 int devm_led_trigger_register(struct device *dev,
498 				     struct led_trigger *trigger);
499 
500 void led_trigger_register_simple(const char *name,
501 				struct led_trigger **trigger);
502 void led_trigger_unregister_simple(struct led_trigger *trigger);
503 void led_trigger_event(struct led_trigger *trigger,  enum led_brightness event);
504 void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
505 		       unsigned long delay_off);
506 void led_trigger_blink_oneshot(struct led_trigger *trigger,
507 			       unsigned long delay_on,
508 			       unsigned long delay_off,
509 			       int invert);
510 void led_trigger_set_default(struct led_classdev *led_cdev);
511 int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
512 void led_trigger_remove(struct led_classdev *led_cdev);
513 
514 static inline void led_set_trigger_data(struct led_classdev *led_cdev,
515 					void *trigger_data)
516 {
517 	led_cdev->trigger_data = trigger_data;
518 }
519 
520 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
521 {
522 	return led_cdev->trigger_data;
523 }
524 
525 static inline enum led_brightness
526 led_trigger_get_brightness(const struct led_trigger *trigger)
527 {
528 	return trigger ? trigger->brightness : LED_OFF;
529 }
530 
531 #define module_led_trigger(__led_trigger) \
532 	module_driver(__led_trigger, led_trigger_register, \
533 		      led_trigger_unregister)
534 
535 #else
536 
537 /* Trigger has no members */
538 struct led_trigger {};
539 
540 /* Trigger inline empty functions */
541 static inline void led_trigger_register_simple(const char *name,
542 					struct led_trigger **trigger) {}
543 static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
544 static inline void led_trigger_event(struct led_trigger *trigger,
545 				enum led_brightness event) {}
546 static inline void led_trigger_blink(struct led_trigger *trigger,
547 				      unsigned long delay_on,
548 				      unsigned long delay_off) {}
549 static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
550 				      unsigned long delay_on,
551 				      unsigned long delay_off,
552 				      int invert) {}
553 static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
554 static inline int led_trigger_set(struct led_classdev *led_cdev,
555 				  struct led_trigger *trigger)
556 {
557 	return 0;
558 }
559 
560 static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
561 static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
562 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
563 {
564 	return NULL;
565 }
566 
567 static inline enum led_brightness
568 led_trigger_get_brightness(const struct led_trigger *trigger)
569 {
570 	return LED_OFF;
571 }
572 
573 #endif /* CONFIG_LEDS_TRIGGERS */
574 
575 /* Trigger specific enum */
576 enum led_trigger_netdev_modes {
577 	TRIGGER_NETDEV_LINK = 0,
578 	TRIGGER_NETDEV_LINK_10,
579 	TRIGGER_NETDEV_LINK_100,
580 	TRIGGER_NETDEV_LINK_1000,
581 	TRIGGER_NETDEV_LINK_2500,
582 	TRIGGER_NETDEV_LINK_5000,
583 	TRIGGER_NETDEV_LINK_10000,
584 	TRIGGER_NETDEV_HALF_DUPLEX,
585 	TRIGGER_NETDEV_FULL_DUPLEX,
586 	TRIGGER_NETDEV_TX,
587 	TRIGGER_NETDEV_RX,
588 
589 	/* Keep last */
590 	__TRIGGER_NETDEV_MAX,
591 };
592 
593 /* Trigger specific functions */
594 #ifdef CONFIG_LEDS_TRIGGER_DISK
595 void ledtrig_disk_activity(bool write);
596 #else
597 static inline void ledtrig_disk_activity(bool write) {}
598 #endif
599 
600 #ifdef CONFIG_LEDS_TRIGGER_MTD
601 void ledtrig_mtd_activity(void);
602 #else
603 static inline void ledtrig_mtd_activity(void) {}
604 #endif
605 
606 #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
607 void ledtrig_flash_ctrl(bool on);
608 void ledtrig_torch_ctrl(bool on);
609 #else
610 static inline void ledtrig_flash_ctrl(bool on) {}
611 static inline void ledtrig_torch_ctrl(bool on) {}
612 #endif
613 
614 /*
615  * Generic LED platform data for describing LED names and default triggers.
616  */
617 struct led_info {
618 	const char	*name;
619 	const char	*default_trigger;
620 	int		flags;
621 };
622 
623 struct led_platform_data {
624 	int		num_leds;
625 	struct led_info	*leds;
626 };
627 
628 struct led_properties {
629 	u32		color;
630 	bool		color_present;
631 	const char	*function;
632 	u32		func_enum;
633 	bool		func_enum_present;
634 	const char	*label;
635 };
636 
637 typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
638 				unsigned long *delay_on,
639 				unsigned long *delay_off);
640 
641 /* For the leds-gpio driver */
642 struct gpio_led {
643 	const char *name;
644 	const char *default_trigger;
645 	unsigned 	gpio;
646 	unsigned	active_low : 1;
647 	unsigned	retain_state_suspended : 1;
648 	unsigned	panic_indicator : 1;
649 	unsigned	default_state : 2;
650 	unsigned	retain_state_shutdown : 1;
651 	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
652 	struct gpio_desc *gpiod;
653 };
654 #define LEDS_GPIO_DEFSTATE_OFF		LEDS_DEFSTATE_OFF
655 #define LEDS_GPIO_DEFSTATE_ON		LEDS_DEFSTATE_ON
656 #define LEDS_GPIO_DEFSTATE_KEEP		LEDS_DEFSTATE_KEEP
657 
658 struct gpio_led_platform_data {
659 	int 		num_leds;
660 	const struct gpio_led *leds;
661 
662 #define GPIO_LED_NO_BLINK_LOW	0	/* No blink GPIO state low */
663 #define GPIO_LED_NO_BLINK_HIGH	1	/* No blink GPIO state high */
664 #define GPIO_LED_BLINK		2	/* Please, blink */
665 	gpio_blink_set_t	gpio_blink_set;
666 };
667 
668 #ifdef CONFIG_LEDS_GPIO_REGISTER
669 struct platform_device *gpio_led_register_device(
670 		int id, const struct gpio_led_platform_data *pdata);
671 #else
672 static inline struct platform_device *gpio_led_register_device(
673 		int id, const struct gpio_led_platform_data *pdata)
674 {
675 	return 0;
676 }
677 #endif
678 
679 enum cpu_led_event {
680 	CPU_LED_IDLE_START,	/* CPU enters idle */
681 	CPU_LED_IDLE_END,	/* CPU idle ends */
682 	CPU_LED_START,		/* Machine starts, especially resume */
683 	CPU_LED_STOP,		/* Machine stops, especially suspend */
684 	CPU_LED_HALTED,		/* Machine shutdown */
685 };
686 #ifdef CONFIG_LEDS_TRIGGER_CPU
687 void ledtrig_cpu(enum cpu_led_event evt);
688 #else
689 static inline void ledtrig_cpu(enum cpu_led_event evt)
690 {
691 	return;
692 }
693 #endif
694 
695 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
696 void led_classdev_notify_brightness_hw_changed(
697 	struct led_classdev *led_cdev, unsigned int brightness);
698 #else
699 static inline void led_classdev_notify_brightness_hw_changed(
700 	struct led_classdev *led_cdev, enum led_brightness brightness) { }
701 #endif
702 
703 /**
704  * struct led_pattern - pattern interval settings
705  * @delta_t: pattern interval delay, in milliseconds
706  * @brightness: pattern interval brightness
707  */
708 struct led_pattern {
709 	u32 delta_t;
710 	int brightness;
711 };
712 
713 enum led_audio {
714 	LED_AUDIO_MUTE,		/* master mute LED */
715 	LED_AUDIO_MICMUTE,	/* mic mute LED */
716 	NUM_AUDIO_LEDS
717 };
718 
719 #endif		/* __LINUX_LEDS_H_INCLUDED */
720