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