xref: /linux-6.15/include/linux/leds.h (revision 4ca7cd93)
1d2912cb1SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
2c72a1d60SRichard Purdie /*
3c72a1d60SRichard Purdie  * Driver model for leds and led triggers
4c72a1d60SRichard Purdie  *
5c72a1d60SRichard Purdie  * Copyright (C) 2005 John Lenz <[email protected]>
6c72a1d60SRichard Purdie  * Copyright (C) 2005 Richard Purdie <[email protected]>
7c72a1d60SRichard Purdie  */
8c72a1d60SRichard Purdie #ifndef __LINUX_LEDS_H_INCLUDED
9c72a1d60SRichard Purdie #define __LINUX_LEDS_H_INCLUDED
10c72a1d60SRichard Purdie 
11bb4e9af0SJacek Anaszewski #include <dt-bindings/leds/common.h>
1220f56758SJacek Anaszewski #include <linux/device.h>
13acd899e4SJacek Anaszewski #include <linux/mutex.h>
14dc47206eSRichard Purdie #include <linux/rwsem.h>
1504713306SJacek Anaszewski #include <linux/spinlock.h>
169067359fSJiri Kosina #include <linux/timer.h>
17d35d0c9dSAndy Shevchenko #include <linux/types.h>
18d23a22a7SFabio Baltieri #include <linux/workqueue.h>
19af410fc1SJohannes Berg 
20d35d0c9dSAndy Shevchenko struct attribute_group;
21699a8c7cSTomi Valkeinen struct device_node;
22d35d0c9dSAndy Shevchenko struct fwnode_handle;
23d35d0c9dSAndy Shevchenko struct gpio_desc;
24d35d0c9dSAndy Shevchenko struct kernfs_node;
25d35d0c9dSAndy Shevchenko struct led_pattern;
26d35d0c9dSAndy Shevchenko struct platform_device;
27d35d0c9dSAndy Shevchenko 
28c72a1d60SRichard Purdie /*
29c72a1d60SRichard Purdie  * LED Core
30c72a1d60SRichard Purdie  */
31c72a1d60SRichard Purdie 
32c7e4ea68SPavel Machek /* This is obsolete/useless. We now support variable maximum brightness. */
33c72a1d60SRichard Purdie enum led_brightness {
34c72a1d60SRichard Purdie 	LED_OFF		= 0,
354e552c8cSAndi Shyti 	LED_ON		= 1,
36c72a1d60SRichard Purdie 	LED_HALF	= 127,
37c72a1d60SRichard Purdie 	LED_FULL	= 255,
38c72a1d60SRichard Purdie };
39c72a1d60SRichard Purdie 
40791bc411SDenis Osterland-Heim enum led_default_state {
41791bc411SDenis Osterland-Heim 	LEDS_DEFSTATE_OFF	= 0,
42791bc411SDenis Osterland-Heim 	LEDS_DEFSTATE_ON	= 1,
43791bc411SDenis Osterland-Heim 	LEDS_DEFSTATE_KEEP	= 2,
44791bc411SDenis Osterland-Heim };
45791bc411SDenis Osterland-Heim 
46abc3100fSHans de Goede /**
47abc3100fSHans de Goede  * struct led_lookup_data - represents a single LED lookup entry
48abc3100fSHans de Goede  *
49abc3100fSHans de Goede  * @list: internal list of all LED lookup entries
50abc3100fSHans de Goede  * @provider: name of led_classdev providing the LED
51abc3100fSHans de Goede  * @dev_id: name of the device associated with this LED
52abc3100fSHans de Goede  * @con_id: name of the LED from the device's point of view
53abc3100fSHans de Goede  */
54abc3100fSHans de Goede struct led_lookup_data {
55abc3100fSHans de Goede 	struct list_head list;
56abc3100fSHans de Goede 	const char *provider;
57abc3100fSHans de Goede 	const char *dev_id;
58abc3100fSHans de Goede 	const char *con_id;
59abc3100fSHans de Goede };
60abc3100fSHans de Goede 
61b2b998c0SJacek Anaszewski struct led_init_data {
62b2b998c0SJacek Anaszewski 	/* device fwnode handle */
63b2b998c0SJacek Anaszewski 	struct fwnode_handle *fwnode;
64bb4e9af0SJacek Anaszewski 	/*
65bb4e9af0SJacek Anaszewski 	 * default <color:function> tuple, for backward compatibility
66bb4e9af0SJacek Anaszewski 	 * with in-driver hard-coded LED names used as a fallback when
67bb4e9af0SJacek Anaszewski 	 * DT "label" property is absent; it should be set to NULL
68bb4e9af0SJacek Anaszewski 	 * in new LED class drivers.
69bb4e9af0SJacek Anaszewski 	 */
70bb4e9af0SJacek Anaszewski 	const char *default_label;
71bb4e9af0SJacek Anaszewski 	/*
72bb4e9af0SJacek Anaszewski 	 * string to be used for devicename section of LED class device
73bb4e9af0SJacek Anaszewski 	 * either for label based LED name composition path or for fwnode
74bb4e9af0SJacek Anaszewski 	 * based when devname_mandatory is true
75bb4e9af0SJacek Anaszewski 	 */
76bb4e9af0SJacek Anaszewski 	const char *devicename;
77bb4e9af0SJacek Anaszewski 	/*
78bb4e9af0SJacek Anaszewski 	 * indicates if LED name should always comprise devicename section;
79bb4e9af0SJacek Anaszewski 	 * only LEDs exposed by drivers of hot-pluggable devices should
80bb4e9af0SJacek Anaszewski 	 * set it to true
81bb4e9af0SJacek Anaszewski 	 */
82bb4e9af0SJacek Anaszewski 	bool devname_mandatory;
83b2b998c0SJacek Anaszewski };
84b2b998c0SJacek Anaszewski 
85156a5bb8SAndy Shevchenko enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode);
86156a5bb8SAndy Shevchenko 
8793690cdfSMarek Behún struct led_hw_trigger_type {
8893690cdfSMarek Behún 	int dummy;
8993690cdfSMarek Behún };
9093690cdfSMarek Behún 
91c72a1d60SRichard Purdie struct led_classdev {
92c72a1d60SRichard Purdie 	const char		*name;
93af0bfab9SAbanoub Sameh 	unsigned int brightness;
94af0bfab9SAbanoub Sameh 	unsigned int max_brightness;
95c7d80059SJean-Jacques Hiblot 	unsigned int color;
96c72a1d60SRichard Purdie 	int			 flags;
97fb5035dbSBen Dooks 
98859cb7f2SRichard Purdie 	/* Lower 16 bits reflect status */
9955edd1daSDavid Lin #define LED_SUSPENDED		BIT(0)
10055edd1daSDavid Lin #define LED_UNREGISTERING	BIT(1)
101859cb7f2SRichard Purdie 	/* Upper 16 bits reflect control information */
10255edd1daSDavid Lin #define LED_CORE_SUSPENDRESUME	BIT(16)
10355edd1daSDavid Lin #define LED_SYSFS_DISABLE	BIT(17)
10455edd1daSDavid Lin #define LED_DEV_CAP_FLASH	BIT(18)
10555edd1daSDavid Lin #define LED_HW_PLUGGABLE	BIT(19)
10655edd1daSDavid Lin #define LED_PANIC_INDICATOR	BIT(20)
10755edd1daSDavid Lin #define LED_BRIGHT_HW_CHANGED	BIT(21)
10855edd1daSDavid Lin #define LED_RETAIN_AT_SHUTDOWN	BIT(22)
10902d31765SJacek Anaszewski #define LED_INIT_DEFAULT_TRIGGER BIT(23)
1106b0d3355SThomas Weißschuh #define LED_REJECT_NAME_CONFLICT BIT(24)
11159561ccdSLee Jones #define LED_MULTI_COLOR		BIT(25)
112a9c6ce57SHans de Goede 
113a9c6ce57SHans de Goede 	/* set_brightness_work / blink_timer flags, atomic, private. */
114a9c6ce57SHans de Goede 	unsigned long		work_flags;
115a9c6ce57SHans de Goede 
116a9c6ce57SHans de Goede #define LED_BLINK_SW			0
117a9c6ce57SHans de Goede #define LED_BLINK_ONESHOT		1
118a9c6ce57SHans de Goede #define LED_BLINK_ONESHOT_STOP		2
119a9c6ce57SHans de Goede #define LED_BLINK_INVERT		3
120a9c6ce57SHans de Goede #define LED_BLINK_BRIGHTNESS_CHANGE 	4
121a9c6ce57SHans de Goede #define LED_BLINK_DISABLE		5
122fa15d8c6SHans de Goede 	/* Brightness off also disables hw-blinking so it is a separate action */
123fa15d8c6SHans de Goede #define LED_SET_BRIGHTNESS_OFF		6
124fa15d8c6SHans de Goede #define LED_SET_BRIGHTNESS		7
12522720a87SHans de Goede #define LED_SET_BLINK			8
126c72a1d60SRichard Purdie 
12770b2563bSHeiner Kallweit 	/* Set LED brightness level
12870b2563bSHeiner Kallweit 	 * Must not sleep. Use brightness_set_blocking for drivers
12970b2563bSHeiner Kallweit 	 * that can sleep while setting brightness.
13070b2563bSHeiner Kallweit 	 */
131c72a1d60SRichard Purdie 	void		(*brightness_set)(struct led_classdev *led_cdev,
132c72a1d60SRichard Purdie 					  enum led_brightness brightness);
1334d71a4a1SJacek Anaszewski 	/*
1344d71a4a1SJacek Anaszewski 	 * Set LED brightness level immediately - it can block the caller for
1354d71a4a1SJacek Anaszewski 	 * the time required for accessing a LED device register.
1364d71a4a1SJacek Anaszewski 	 */
137437a4240SJacek Anaszewski 	int (*brightness_set_blocking)(struct led_classdev *led_cdev,
1384d71a4a1SJacek Anaszewski 				       enum led_brightness brightness);
13929d76dfaSHenrique de Moraes Holschuh 	/* Get LED brightness level */
14029d76dfaSHenrique de Moraes Holschuh 	enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
141c72a1d60SRichard Purdie 
1425ada28bfSJohannes Berg 	/*
1435ada28bfSJohannes Berg 	 * Activate hardware accelerated blink, delays are in milliseconds
1445ada28bfSJohannes Berg 	 * and if both are zero then a sensible default should be chosen.
1455ada28bfSJohannes Berg 	 * The call should adjust the timings in that case and if it can't
1465ada28bfSJohannes Berg 	 * match the values specified exactly.
1477cfe749fSTony Makkiel 	 * Deactivate blinking again when the brightness is set to LED_OFF
1487cfe749fSTony Makkiel 	 * via the brightness_set() callback.
14922720a87SHans de Goede 	 * For led_blink_set_nosleep() the LED core assumes that blink_set
15022720a87SHans de Goede 	 * implementations, of drivers which do not use brightness_set_blocking,
15122720a87SHans de Goede 	 * will not sleep. Therefor if brightness_set_blocking is not set
15222720a87SHans de Goede 	 * this function must not sleep!
1535ada28bfSJohannes Berg 	 */
1544c79141dSMárton Németh 	int		(*blink_set)(struct led_classdev *led_cdev,
1554c79141dSMárton Németh 				     unsigned long *delay_on,
1564c79141dSMárton Németh 				     unsigned long *delay_off);
1574c79141dSMárton Németh 
1585fd752b6SBaolin Wang 	int (*pattern_set)(struct led_classdev *led_cdev,
1595fd752b6SBaolin Wang 			   struct led_pattern *pattern, u32 len, int repeat);
1605fd752b6SBaolin Wang 	int (*pattern_clear)(struct led_classdev *led_cdev);
1615fd752b6SBaolin Wang 
162f8a7c6feSRichard Purdie 	struct device		*dev;
163d0d480ccSJohan Hovold 	const struct attribute_group	**groups;
164d0d480ccSJohan Hovold 
165fb5035dbSBen Dooks 	struct list_head	 node;			/* LED Device list */
166781a54e7SAnton Vorontsov 	const char		*default_trigger;	/* Trigger to use */
167c72a1d60SRichard Purdie 
1685ada28bfSJohannes Berg 	unsigned long		 blink_delay_on, blink_delay_off;
1699067359fSJiri Kosina 	struct timer_list	 blink_timer;
1705ada28bfSJohannes Berg 	int			 blink_brightness;
171eb1610b4SHans de Goede 	int			 new_blink_brightness;
1727aea8389SJacek Anaszewski 	void			(*flash_resume)(struct led_classdev *led_cdev);
1735ada28bfSJohannes Berg 
17432360bf6SDmitry Rokosov 	struct workqueue_struct *wq;			/* LED workqueue */
175d23a22a7SFabio Baltieri 	struct work_struct	set_brightness_work;
176d23a22a7SFabio Baltieri 	int			delayed_set_value;
17722720a87SHans de Goede 	unsigned long		delayed_delay_on;
17822720a87SHans de Goede 	unsigned long		delayed_delay_off;
179d23a22a7SFabio Baltieri 
180c3bc9956SRichard Purdie #ifdef CONFIG_LEDS_TRIGGERS
181c3bc9956SRichard Purdie 	/* Protects the trigger data below */
182dc47206eSRichard Purdie 	struct rw_semaphore	 trigger_lock;
183c3bc9956SRichard Purdie 
184c3bc9956SRichard Purdie 	struct led_trigger	*trigger;
185c3bc9956SRichard Purdie 	struct list_head	 trig_list;
186c3bc9956SRichard Purdie 	void			*trigger_data;
187b0096182SShuah Khan 	/* true if activated - deactivate routine uses it to do cleanup */
188b0096182SShuah Khan 	bool			activated;
18993690cdfSMarek Behún 
19093690cdfSMarek Behún 	/* LEDs that have private triggers have this set */
19193690cdfSMarek Behún 	struct led_hw_trigger_type	*trigger_type;
192ed554d3fSChristian Marangi 
193ed554d3fSChristian Marangi 	/* Unique trigger name supported by LED set in hw control mode */
194ed554d3fSChristian Marangi 	const char		*hw_control_trigger;
195ed554d3fSChristian Marangi 	/*
196ed554d3fSChristian Marangi 	 * Check if the LED driver supports the requested mode provided by the
197ed554d3fSChristian Marangi 	 * defined supported trigger to setup the LED to hw control mode.
198ed554d3fSChristian Marangi 	 *
199ed554d3fSChristian Marangi 	 * Return 0 on success. Return -EOPNOTSUPP when the passed flags are not
200ed554d3fSChristian Marangi 	 * supported and software fallback needs to be used.
201ed554d3fSChristian Marangi 	 * Return a negative error number on any other case  for check fail due
202ed554d3fSChristian Marangi 	 * to various reason like device not ready or timeouts.
203ed554d3fSChristian Marangi 	 */
204ed554d3fSChristian Marangi 	int			(*hw_control_is_supported)(struct led_classdev *led_cdev,
205ed554d3fSChristian Marangi 							   unsigned long flags);
206ed554d3fSChristian Marangi 	/*
207ed554d3fSChristian Marangi 	 * Activate hardware control, LED driver will use the provided flags
208ed554d3fSChristian Marangi 	 * from the supported trigger and setup the LED to be driven by hardware
209ed554d3fSChristian Marangi 	 * following the requested mode from the trigger flags.
210ed554d3fSChristian Marangi 	 * Deactivate hardware blink control by setting brightness to LED_OFF via
211ed554d3fSChristian Marangi 	 * the brightness_set() callback.
212ed554d3fSChristian Marangi 	 *
213ed554d3fSChristian Marangi 	 * Return 0 on success, a negative error number on flags apply fail.
214ed554d3fSChristian Marangi 	 */
215ed554d3fSChristian Marangi 	int			(*hw_control_set)(struct led_classdev *led_cdev,
216ed554d3fSChristian Marangi 						  unsigned long flags);
217ed554d3fSChristian Marangi 	/*
218ed554d3fSChristian Marangi 	 * Get from the LED driver the current mode that the LED is set in hw
219ed554d3fSChristian Marangi 	 * control mode and put them in flags.
220ed554d3fSChristian Marangi 	 * Trigger can use this to get the initial state of a LED already set in
221ed554d3fSChristian Marangi 	 * hardware blink control.
222ed554d3fSChristian Marangi 	 *
223ed554d3fSChristian Marangi 	 * Return 0 on success, a negative error number on failing parsing the
224ed554d3fSChristian Marangi 	 * initial mode. Error from this function is NOT FATAL as the device
225ed554d3fSChristian Marangi 	 * may be in a not supported initial state by the attached LED trigger.
226ed554d3fSChristian Marangi 	 */
227ed554d3fSChristian Marangi 	int			(*hw_control_get)(struct led_classdev *led_cdev,
228ed554d3fSChristian Marangi 						  unsigned long *flags);
229052c38ebSAndrew Lunn 	/*
230052c38ebSAndrew Lunn 	 * Get the device this LED blinks in response to.
231052c38ebSAndrew Lunn 	 * e.g. for a PHY LED, it is the network device. If the LED is
232052c38ebSAndrew Lunn 	 * not yet associated to a device, return NULL.
233052c38ebSAndrew Lunn 	 */
234052c38ebSAndrew Lunn 	struct device		*(*hw_control_get_device)(struct led_classdev *led_cdev);
235c3bc9956SRichard Purdie #endif
236acd899e4SJacek Anaszewski 
2370cb8eb30SHans de Goede #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
2380cb8eb30SHans de Goede 	int			 brightness_hw_changed;
2390cb8eb30SHans de Goede 	struct kernfs_node	*brightness_hw_changed_kn;
2400cb8eb30SHans de Goede #endif
2410cb8eb30SHans de Goede 
242*4ca7cd93SMukesh Ojha 	/* Ensures consistent access to the LED class device */
243acd899e4SJacek Anaszewski 	struct mutex		led_access;
244c72a1d60SRichard Purdie };
245c72a1d60SRichard Purdie 
246b2b998c0SJacek Anaszewski /**
247b2b998c0SJacek Anaszewski  * led_classdev_register_ext - register a new object of LED class with
248b2b998c0SJacek Anaszewski  *			       init data
249b2b998c0SJacek Anaszewski  * @parent: LED controller device this LED is driven by
250b2b998c0SJacek Anaszewski  * @led_cdev: the led_classdev structure for this device
251b2b998c0SJacek Anaszewski  * @init_data: the LED class device initialization data
252b2b998c0SJacek Anaszewski  *
2537c322056SJacek Anaszewski  * Register a new object of LED class, with name derived from init_data.
2547c322056SJacek Anaszewski  *
255b2b998c0SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
256b2b998c0SJacek Anaszewski  */
257ec28a8cfSDan Murphy int led_classdev_register_ext(struct device *parent,
258b2b998c0SJacek Anaszewski 				     struct led_classdev *led_cdev,
259b2b998c0SJacek Anaszewski 				     struct led_init_data *init_data);
2607c322056SJacek Anaszewski 
2617c322056SJacek Anaszewski /**
2627c322056SJacek Anaszewski  * led_classdev_register - register a new object of LED class
2637c322056SJacek Anaszewski  * @parent: LED controller device this LED is driven by
2647c322056SJacek Anaszewski  * @led_cdev: the led_classdev structure for this device
2657c322056SJacek Anaszewski  *
2667c322056SJacek Anaszewski  * Register a new object of LED class, with name derived from the name property
2677c322056SJacek Anaszewski  * of passed led_cdev argument.
2687c322056SJacek Anaszewski  *
2697c322056SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
2707c322056SJacek Anaszewski  */
led_classdev_register(struct device * parent,struct led_classdev * led_cdev)2717c322056SJacek Anaszewski static inline int led_classdev_register(struct device *parent,
2727c322056SJacek Anaszewski 					struct led_classdev *led_cdev)
2737c322056SJacek Anaszewski {
2747c322056SJacek Anaszewski 	return led_classdev_register_ext(parent, led_cdev, NULL);
2757c322056SJacek Anaszewski }
2767c322056SJacek Anaszewski 
277ec28a8cfSDan Murphy int devm_led_classdev_register_ext(struct device *parent,
278b2b998c0SJacek Anaszewski 					  struct led_classdev *led_cdev,
279b2b998c0SJacek Anaszewski 					  struct led_init_data *init_data);
devm_led_classdev_register(struct device * parent,struct led_classdev * led_cdev)2807c322056SJacek Anaszewski static inline int devm_led_classdev_register(struct device *parent,
2817c322056SJacek Anaszewski 					     struct led_classdev *led_cdev)
2827c322056SJacek Anaszewski {
2837c322056SJacek Anaszewski 	return devm_led_classdev_register_ext(parent, led_cdev, NULL);
2847c322056SJacek Anaszewski }
285ec28a8cfSDan Murphy void led_classdev_unregister(struct led_classdev *led_cdev);
286ec28a8cfSDan Murphy void devm_led_classdev_unregister(struct device *parent,
287ca1bb4eeSBjorn Andersson 				  struct led_classdev *led_cdev);
288ec28a8cfSDan Murphy void led_classdev_suspend(struct led_classdev *led_cdev);
289ec28a8cfSDan Murphy void led_classdev_resume(struct led_classdev *led_cdev);
290c72a1d60SRichard Purdie 
291abc3100fSHans de Goede void led_add_lookup(struct led_lookup_data *led_lookup);
292abc3100fSHans de Goede void led_remove_lookup(struct led_lookup_data *led_lookup);
293abc3100fSHans de Goede 
294abc3100fSHans de Goede struct led_classdev *__must_check led_get(struct device *dev, char *con_id);
295abc3100fSHans de Goede struct led_classdev *__must_check devm_led_get(struct device *dev, char *con_id);
296abc3100fSHans de Goede 
297699a8c7cSTomi Valkeinen extern struct led_classdev *of_led_get(struct device_node *np, int index);
298699a8c7cSTomi Valkeinen extern void led_put(struct led_classdev *led_cdev);
299e389240aSJean-Jacques Hiblot struct led_classdev *__must_check devm_of_led_get(struct device *dev,
300e389240aSJean-Jacques Hiblot 						  int index);
301afb48153SJean-Jacques Hiblot struct led_classdev *__must_check devm_of_led_get_optional(struct device *dev,
302afb48153SJean-Jacques Hiblot 						  int index);
303699a8c7cSTomi Valkeinen 
3045ada28bfSJohannes Berg /**
3055ada28bfSJohannes Berg  * led_blink_set - set blinking with software fallback
3065ada28bfSJohannes Berg  * @led_cdev: the LED to start blinking
3075ada28bfSJohannes Berg  * @delay_on: the time it should be on (in ms)
3085ada28bfSJohannes Berg  * @delay_off: the time it should ble off (in ms)
3095ada28bfSJohannes Berg  *
3105ada28bfSJohannes Berg  * This function makes the LED blink, attempting to use the
3115ada28bfSJohannes Berg  * hardware acceleration if possible, but falling back to
3125ada28bfSJohannes Berg  * software blinking if there is no hardware blinking or if
3135ada28bfSJohannes Berg  * the LED refuses the passed values.
3145ada28bfSJohannes Berg  *
31522720a87SHans de Goede  * This function may sleep!
31622720a87SHans de Goede  *
3175ada28bfSJohannes Berg  * Note that if software blinking is active, simply calling
3185ada28bfSJohannes Berg  * led_cdev->brightness_set() will not stop the blinking,
3198af70e20SThomas Weißschuh  * use led_set_brightness() instead.
3205ada28bfSJohannes Berg  */
321ec28a8cfSDan Murphy void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
3225ada28bfSJohannes Berg 		   unsigned long *delay_off);
32322720a87SHans de Goede 
32422720a87SHans de Goede /**
32522720a87SHans de Goede  * led_blink_set_nosleep - set blinking, guaranteed to not sleep
32622720a87SHans de Goede  * @led_cdev: the LED to start blinking
32722720a87SHans de Goede  * @delay_on: the time it should be on (in ms)
32822720a87SHans de Goede  * @delay_off: the time it should ble off (in ms)
32922720a87SHans de Goede  *
33022720a87SHans de Goede  * This function makes the LED blink and is guaranteed to not sleep. Otherwise
33122720a87SHans de Goede  * this is the same as led_blink_set(), see led_blink_set() for details.
33222720a87SHans de Goede  */
33322720a87SHans de Goede void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
33422720a87SHans de Goede 			   unsigned long delay_off);
33522720a87SHans de Goede 
3365ada28bfSJohannes Berg /**
3375bb629c5SFabio Baltieri  * led_blink_set_oneshot - do a oneshot software blink
3385bb629c5SFabio Baltieri  * @led_cdev: the LED to start blinking
3395bb629c5SFabio Baltieri  * @delay_on: the time it should be on (in ms)
3405bb629c5SFabio Baltieri  * @delay_off: the time it should ble off (in ms)
3415bb629c5SFabio Baltieri  * @invert: blink off, then on, leaving the led on
3425bb629c5SFabio Baltieri  *
3435bb629c5SFabio Baltieri  * This function makes the LED blink one time for delay_on +
3445bb629c5SFabio Baltieri  * delay_off time, ignoring the request if another one-shot
3455bb629c5SFabio Baltieri  * blink is already in progress.
3465bb629c5SFabio Baltieri  *
3475bb629c5SFabio Baltieri  * If invert is set, led blinks for delay_off first, then for
3485bb629c5SFabio Baltieri  * delay_on and leave the led on after the on-off cycle.
34922720a87SHans de Goede  *
35022720a87SHans de Goede  * This function is guaranteed not to sleep.
3515bb629c5SFabio Baltieri  */
352ec28a8cfSDan Murphy void led_blink_set_oneshot(struct led_classdev *led_cdev,
353ec28a8cfSDan Murphy 			   unsigned long *delay_on, unsigned long *delay_off,
3545bb629c5SFabio Baltieri 			   int invert);
3555bb629c5SFabio Baltieri /**
35619cd67e2SShuah Khan  * led_set_brightness - set LED brightness
3575ada28bfSJohannes Berg  * @led_cdev: the LED to set
3585ada28bfSJohannes Berg  * @brightness: the brightness to set it to
3595ada28bfSJohannes Berg  *
3605ada28bfSJohannes Berg  * Set an LED's brightness, and, if necessary, cancel the
3615ada28bfSJohannes Berg  * software blink timer that implements blinking when the
3621afcadfcSJacek Anaszewski  * hardware doesn't. This function is guaranteed not to sleep.
3635ada28bfSJohannes Berg  */
364af0bfab9SAbanoub Sameh void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness);
36513ae79bbSJacek Anaszewski 
36613ae79bbSJacek Anaszewski /**
36713ae79bbSJacek Anaszewski  * led_set_brightness_sync - set LED brightness synchronously
36813ae79bbSJacek Anaszewski  * @led_cdev: the LED to set
3699cc93be7SDan Murphy  * @value: the brightness to set it to
37013ae79bbSJacek Anaszewski  *
37113ae79bbSJacek Anaszewski  * Set an LED's brightness immediately. This function will block
37213ae79bbSJacek Anaszewski  * the caller for the time required for accessing device registers,
37313ae79bbSJacek Anaszewski  * and it can sleep.
37413ae79bbSJacek Anaszewski  *
37513ae79bbSJacek Anaszewski  * Returns: 0 on success or negative error value on failure
37613ae79bbSJacek Anaszewski  */
377af0bfab9SAbanoub Sameh int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value);
37813ae79bbSJacek Anaszewski 
3793ef7de53SJacek Anaszewski /**
3805607ca92SHans de Goede  * led_mc_set_brightness - set mc LED color intensity values and brightness
3815607ca92SHans de Goede  * @led_cdev: the LED to set
3825607ca92SHans de Goede  * @intensity_value: array of per color intensity values to set
3835607ca92SHans de Goede  * @num_colors: amount of entries in intensity_value array
3845607ca92SHans de Goede  * @brightness: the brightness to set the LED to
3855607ca92SHans de Goede  *
3865607ca92SHans de Goede  * Set a multi-color LED's per color intensity values and brightness.
3875607ca92SHans de Goede  * If necessary, this cancels the software blink timer. This function is
3885607ca92SHans de Goede  * guaranteed not to sleep.
3895607ca92SHans de Goede  *
3905607ca92SHans de Goede  * Calling this function on a non multi-color led_classdev or with the wrong
3915607ca92SHans de Goede  * num_colors value is an error. In this case an error will be logged once
3925607ca92SHans de Goede  * and the call will do nothing.
3935607ca92SHans de Goede  */
3945607ca92SHans de Goede void led_mc_set_brightness(struct led_classdev *led_cdev,
3955607ca92SHans de Goede 			   unsigned int *intensity_value, unsigned int num_colors,
3965607ca92SHans de Goede 			   unsigned int brightness);
3975607ca92SHans de Goede 
3985607ca92SHans de Goede /**
3993ef7de53SJacek Anaszewski  * led_update_brightness - update LED brightness
4003ef7de53SJacek Anaszewski  * @led_cdev: the LED to query
4013ef7de53SJacek Anaszewski  *
4023ef7de53SJacek Anaszewski  * Get an LED's current brightness and update led_cdev->brightness
4033ef7de53SJacek Anaszewski  * member with the obtained value.
4043ef7de53SJacek Anaszewski  *
4053ef7de53SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
4063ef7de53SJacek Anaszewski  */
407ec28a8cfSDan Murphy int led_update_brightness(struct led_classdev *led_cdev);
4085ada28bfSJohannes Berg 
409acd899e4SJacek Anaszewski /**
4108e1f4561SKrzysztof Kozlowski  * led_get_default_pattern - return default pattern
4118e1f4561SKrzysztof Kozlowski  *
4128e1f4561SKrzysztof Kozlowski  * @led_cdev: the LED to get default pattern for
4138e1f4561SKrzysztof Kozlowski  * @size:     pointer for storing the number of elements in returned array,
4148e1f4561SKrzysztof Kozlowski  *            modified only if return != NULL
4158e1f4561SKrzysztof Kozlowski  *
4168e1f4561SKrzysztof Kozlowski  * Return:    Allocated array of integers with default pattern from device tree
4178e1f4561SKrzysztof Kozlowski  *            or NULL.  Caller is responsible for kfree().
4188e1f4561SKrzysztof Kozlowski  */
419ec28a8cfSDan Murphy u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
4208e1f4561SKrzysztof Kozlowski 
4218e1f4561SKrzysztof Kozlowski /**
422acd899e4SJacek Anaszewski  * led_sysfs_disable - disable LED sysfs interface
423acd899e4SJacek Anaszewski  * @led_cdev: the LED to set
424acd899e4SJacek Anaszewski  *
425acd899e4SJacek Anaszewski  * Disable the led_cdev's sysfs interface.
426acd899e4SJacek Anaszewski  */
427ec28a8cfSDan Murphy void led_sysfs_disable(struct led_classdev *led_cdev);
428acd899e4SJacek Anaszewski 
429acd899e4SJacek Anaszewski /**
430acd899e4SJacek Anaszewski  * led_sysfs_enable - enable LED sysfs interface
431acd899e4SJacek Anaszewski  * @led_cdev: the LED to set
432acd899e4SJacek Anaszewski  *
433acd899e4SJacek Anaszewski  * Enable the led_cdev's sysfs interface.
434acd899e4SJacek Anaszewski  */
435ec28a8cfSDan Murphy void led_sysfs_enable(struct led_classdev *led_cdev);
436acd899e4SJacek Anaszewski 
437acd899e4SJacek Anaszewski /**
438bb4e9af0SJacek Anaszewski  * led_compose_name - compose LED class device name
439bb4e9af0SJacek Anaszewski  * @dev: LED controller device object
4409cc93be7SDan Murphy  * @init_data: the LED class device initialization data
441bb4e9af0SJacek Anaszewski  * @led_classdev_name: composed LED class device name
442bb4e9af0SJacek Anaszewski  *
443bb4e9af0SJacek Anaszewski  * Create LED class device name basing on the provided init_data argument.
444bb4e9af0SJacek Anaszewski  * The name can have <devicename:color:function> or <color:function>.
445bb4e9af0SJacek Anaszewski  * form, depending on the init_data configuration.
446bb4e9af0SJacek Anaszewski  *
447bb4e9af0SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
448bb4e9af0SJacek Anaszewski  */
449ec28a8cfSDan Murphy int led_compose_name(struct device *dev, struct led_init_data *init_data,
450bb4e9af0SJacek Anaszewski 		     char *led_classdev_name);
451bb4e9af0SJacek Anaszewski 
452bb4e9af0SJacek Anaszewski /**
4535f2e9507SThomas Weißschuh  * led_get_color_name - get string representation of color ID
4545f2e9507SThomas Weißschuh  * @color_id: The LED_COLOR_ID_* constant
4555f2e9507SThomas Weißschuh  *
4565f2e9507SThomas Weißschuh  * Get the string name of a LED_COLOR_ID_* constant.
4575f2e9507SThomas Weißschuh  *
4585f2e9507SThomas Weißschuh  * Returns: A string constant or NULL on an invalid ID.
4595f2e9507SThomas Weißschuh  */
4605f2e9507SThomas Weißschuh const char *led_get_color_name(u8 color_id);
4615f2e9507SThomas Weißschuh 
4625f2e9507SThomas Weißschuh /**
463acd899e4SJacek Anaszewski  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
464acd899e4SJacek Anaszewski  * @led_cdev: the LED to query
465acd899e4SJacek Anaszewski  *
466acd899e4SJacek Anaszewski  * Returns: true if the led_cdev's sysfs interface is disabled.
467acd899e4SJacek Anaszewski  */
led_sysfs_is_disabled(struct led_classdev * led_cdev)468acd899e4SJacek Anaszewski static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
469acd899e4SJacek Anaszewski {
470acd899e4SJacek Anaszewski 	return led_cdev->flags & LED_SYSFS_DISABLE;
471acd899e4SJacek Anaszewski }
472acd899e4SJacek Anaszewski 
473c3bc9956SRichard Purdie /*
474c3bc9956SRichard Purdie  * LED Triggers
475c3bc9956SRichard Purdie  */
47639f7e08aSKim, Milo /* Registration functions for simple triggers */
47739f7e08aSKim, Milo #define DEFINE_LED_TRIGGER(x)		static struct led_trigger *x;
47839f7e08aSKim, Milo #define DEFINE_LED_TRIGGER_GLOBAL(x)	struct led_trigger *x;
47939f7e08aSKim, Milo 
480c3bc9956SRichard Purdie #ifdef CONFIG_LEDS_TRIGGERS
481c3bc9956SRichard Purdie 
482c3bc9956SRichard Purdie #define TRIG_NAME_MAX 50
483c3bc9956SRichard Purdie 
484c3bc9956SRichard Purdie struct led_trigger {
485c3bc9956SRichard Purdie 	/* Trigger Properties */
486c3bc9956SRichard Purdie 	const char	 *name;
4872282e125SUwe Kleine-König 	int		(*activate)(struct led_classdev *led_cdev);
488c3bc9956SRichard Purdie 	void		(*deactivate)(struct led_classdev *led_cdev);
489c3bc9956SRichard Purdie 
490822c91e7SHeiner Kallweit 	/* Brightness set by led_trigger_event */
491822c91e7SHeiner Kallweit 	enum led_brightness brightness;
492822c91e7SHeiner Kallweit 
49393690cdfSMarek Behún 	/* LED-private triggers have this set */
49493690cdfSMarek Behún 	struct led_hw_trigger_type *trigger_type;
49593690cdfSMarek Behún 
496c3bc9956SRichard Purdie 	/* LEDs under control by this trigger (for simple triggers) */
4972a5a8fa8SJohannes Berg 	spinlock_t	  leddev_list_lock;
498c3bc9956SRichard Purdie 	struct list_head  led_cdevs;
499c3bc9956SRichard Purdie 
500c3bc9956SRichard Purdie 	/* Link to next registered trigger */
501c3bc9956SRichard Purdie 	struct list_head  next_trig;
502a7e7a315SUwe Kleine-König 
503a7e7a315SUwe Kleine-König 	const struct attribute_group **groups;
504c3bc9956SRichard Purdie };
505c3bc9956SRichard Purdie 
506a7e7a315SUwe Kleine-König /*
507a7e7a315SUwe Kleine-König  * Currently the attributes in struct led_trigger::groups are added directly to
508a7e7a315SUwe Kleine-König  * the LED device. As this might change in the future, the following
509a7e7a315SUwe Kleine-König  * macros abstract getting the LED device and its trigger_data from the dev
510a7e7a315SUwe Kleine-König  * parameter passed to the attribute accessor functions.
511a7e7a315SUwe Kleine-König  */
512a7e7a315SUwe Kleine-König #define led_trigger_get_led(dev)	((struct led_classdev *)dev_get_drvdata((dev)))
513a7e7a315SUwe Kleine-König #define led_trigger_get_drvdata(dev)	(led_get_trigger_data(led_trigger_get_led(dev)))
514a7e7a315SUwe Kleine-König 
515c3bc9956SRichard Purdie /* Registration functions for complex triggers */
516ec28a8cfSDan Murphy int led_trigger_register(struct led_trigger *trigger);
517ec28a8cfSDan Murphy void led_trigger_unregister(struct led_trigger *trigger);
518ec28a8cfSDan Murphy int devm_led_trigger_register(struct device *dev,
5199534cc31SHeiner Kallweit 				     struct led_trigger *trigger);
520c3bc9956SRichard Purdie 
521ec28a8cfSDan Murphy void led_trigger_register_simple(const char *name,
522c3bc9956SRichard Purdie 				struct led_trigger **trigger);
523ec28a8cfSDan Murphy void led_trigger_unregister_simple(struct led_trigger *trigger);
524ec28a8cfSDan Murphy void led_trigger_event(struct led_trigger *trigger,  enum led_brightness event);
5250921a57cSHans de Goede void led_mc_trigger_event(struct led_trigger *trig,
5260921a57cSHans de Goede 			  unsigned int *intensity_value, unsigned int num_colors,
5270921a57cSHans de Goede 			  enum led_brightness brightness);
528e298d8a3SHans de Goede void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
529e298d8a3SHans de Goede 		       unsigned long delay_off);
530ec28a8cfSDan Murphy void led_trigger_blink_oneshot(struct led_trigger *trigger,
531e298d8a3SHans de Goede 			       unsigned long delay_on,
532e298d8a3SHans de Goede 			       unsigned long delay_off,
5335bb629c5SFabio Baltieri 			       int invert);
534ec28a8cfSDan Murphy void led_trigger_set_default(struct led_classdev *led_cdev);
535ec28a8cfSDan Murphy int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
536ec28a8cfSDan Murphy void led_trigger_remove(struct led_classdev *led_cdev);
53720f56758SJacek Anaszewski 
led_set_trigger_data(struct led_classdev * led_cdev,void * trigger_data)5389acc560dSUwe Kleine-König static inline void led_set_trigger_data(struct led_classdev *led_cdev,
5399acc560dSUwe Kleine-König 					void *trigger_data)
5409acc560dSUwe Kleine-König {
5419acc560dSUwe Kleine-König 	led_cdev->trigger_data = trigger_data;
5429acc560dSUwe Kleine-König }
5439acc560dSUwe Kleine-König 
led_get_trigger_data(struct led_classdev * led_cdev)54420f56758SJacek Anaszewski static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
54520f56758SJacek Anaszewski {
54620f56758SJacek Anaszewski 	return led_cdev->trigger_data;
54720f56758SJacek Anaszewski }
54820f56758SJacek Anaszewski 
549822c91e7SHeiner Kallweit static inline enum led_brightness
led_trigger_get_brightness(const struct led_trigger * trigger)550822c91e7SHeiner Kallweit led_trigger_get_brightness(const struct led_trigger *trigger)
551822c91e7SHeiner Kallweit {
552822c91e7SHeiner Kallweit 	return trigger ? trigger->brightness : LED_OFF;
553822c91e7SHeiner Kallweit }
554822c91e7SHeiner Kallweit 
555a0b75076SUwe Kleine-König #define module_led_trigger(__led_trigger) \
556a0b75076SUwe Kleine-König 	module_driver(__led_trigger, led_trigger_register, \
557a0b75076SUwe Kleine-König 		      led_trigger_unregister)
558a0b75076SUwe Kleine-König 
559c3bc9956SRichard Purdie #else
560c3bc9956SRichard Purdie 
56139f7e08aSKim, Milo /* Trigger has no members */
56239f7e08aSKim, Milo struct led_trigger {};
563c3bc9956SRichard Purdie 
56439f7e08aSKim, Milo /* Trigger inline empty functions */
led_trigger_register_simple(const char * name,struct led_trigger ** trigger)56539f7e08aSKim, Milo static inline void led_trigger_register_simple(const char *name,
56639f7e08aSKim, Milo 					struct led_trigger **trigger) {}
led_trigger_unregister_simple(struct led_trigger * trigger)56739f7e08aSKim, Milo static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
led_trigger_event(struct led_trigger * trigger,enum led_brightness event)56839f7e08aSKim, Milo static inline void led_trigger_event(struct led_trigger *trigger,
56939f7e08aSKim, Milo 				enum led_brightness event) {}
led_mc_trigger_event(struct led_trigger * trig,unsigned int * intensity_value,unsigned int num_colors,enum led_brightness brightness)5700921a57cSHans de Goede static inline void led_mc_trigger_event(struct led_trigger *trig,
5710921a57cSHans de Goede 				unsigned int *intensity_value, unsigned int num_colors,
5720921a57cSHans de Goede 				enum led_brightness brightness) {}
led_trigger_blink(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off)5738890624aSMichael Grzeschik static inline void led_trigger_blink(struct led_trigger *trigger,
574e298d8a3SHans de Goede 				      unsigned long delay_on,
575e298d8a3SHans de Goede 				      unsigned long delay_off) {}
led_trigger_blink_oneshot(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off,int invert)5768890624aSMichael Grzeschik static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
577e298d8a3SHans de Goede 				      unsigned long delay_on,
578e298d8a3SHans de Goede 				      unsigned long delay_off,
5798890624aSMichael Grzeschik 				      int invert) {}
led_trigger_set_default(struct led_classdev * led_cdev)58020f56758SJacek Anaszewski static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
led_trigger_set(struct led_classdev * led_cdev,struct led_trigger * trigger)5812282e125SUwe Kleine-König static inline int led_trigger_set(struct led_classdev *led_cdev,
5822282e125SUwe Kleine-König 				  struct led_trigger *trigger)
5832282e125SUwe Kleine-König {
5842282e125SUwe Kleine-König 	return 0;
5852282e125SUwe Kleine-König }
5862282e125SUwe Kleine-König 
led_trigger_remove(struct led_classdev * led_cdev)58720f56758SJacek Anaszewski static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
led_set_trigger_data(struct led_classdev * led_cdev)5889acc560dSUwe Kleine-König static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
led_get_trigger_data(struct led_classdev * led_cdev)58920f56758SJacek Anaszewski static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
59020f56758SJacek Anaszewski {
59120f56758SJacek Anaszewski 	return NULL;
59220f56758SJacek Anaszewski }
59320f56758SJacek Anaszewski 
594822c91e7SHeiner Kallweit static inline enum led_brightness
led_trigger_get_brightness(const struct led_trigger * trigger)595822c91e7SHeiner Kallweit led_trigger_get_brightness(const struct led_trigger *trigger)
596822c91e7SHeiner Kallweit {
597822c91e7SHeiner Kallweit 	return LED_OFF;
598822c91e7SHeiner Kallweit }
599822c91e7SHeiner Kallweit 
60039f7e08aSKim, Milo #endif /* CONFIG_LEDS_TRIGGERS */
6012bfb646cSRichard Purdie 
602947acacaSChristian Marangi /* Trigger specific enum */
603947acacaSChristian Marangi enum led_trigger_netdev_modes {
604947acacaSChristian Marangi 	TRIGGER_NETDEV_LINK = 0,
605d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_10,
606d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_100,
607d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_1000,
60859b3e31eSDaniel Golle 	TRIGGER_NETDEV_LINK_2500,
60959b3e31eSDaniel Golle 	TRIGGER_NETDEV_LINK_5000,
61059b3e31eSDaniel Golle 	TRIGGER_NETDEV_LINK_10000,
611f22f95b9SChristian Marangi 	TRIGGER_NETDEV_HALF_DUPLEX,
612f22f95b9SChristian Marangi 	TRIGGER_NETDEV_FULL_DUPLEX,
613947acacaSChristian Marangi 	TRIGGER_NETDEV_TX,
614947acacaSChristian Marangi 	TRIGGER_NETDEV_RX,
6156b08d07cSLukasz Majewski 	TRIGGER_NETDEV_TX_ERR,
6166b08d07cSLukasz Majewski 	TRIGGER_NETDEV_RX_ERR,
617947acacaSChristian Marangi 
618947acacaSChristian Marangi 	/* Keep last */
619947acacaSChristian Marangi 	__TRIGGER_NETDEV_MAX,
620947acacaSChristian Marangi };
621947acacaSChristian Marangi 
6222bfb646cSRichard Purdie /* Trigger specific functions */
623eb25cb99SStephan Linz #ifdef CONFIG_LEDS_TRIGGER_DISK
624ec28a8cfSDan Murphy void ledtrig_disk_activity(bool write);
6252bfb646cSRichard Purdie #else
ledtrig_disk_activity(bool write)626d1ed7c55SLinus Walleij static inline void ledtrig_disk_activity(bool write) {}
6272bfb646cSRichard Purdie #endif
6282bfb646cSRichard Purdie 
6294b721174SEzequiel Garcia #ifdef CONFIG_LEDS_TRIGGER_MTD
630ec28a8cfSDan Murphy void ledtrig_mtd_activity(void);
6314b721174SEzequiel Garcia #else
ledtrig_mtd_activity(void)6324b721174SEzequiel Garcia static inline void ledtrig_mtd_activity(void) {}
6334b721174SEzequiel Garcia #endif
6344b721174SEzequiel Garcia 
63548a1d032SKim, Milo #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
636ec28a8cfSDan Murphy void ledtrig_flash_ctrl(bool on);
637ec28a8cfSDan Murphy void ledtrig_torch_ctrl(bool on);
63848a1d032SKim, Milo #else
ledtrig_flash_ctrl(bool on)63948a1d032SKim, Milo static inline void ledtrig_flash_ctrl(bool on) {}
ledtrig_torch_ctrl(bool on)64048a1d032SKim, Milo static inline void ledtrig_torch_ctrl(bool on) {}
64148a1d032SKim, Milo #endif
64248a1d032SKim, Milo 
643f46e9203SNate Case /*
644f46e9203SNate Case  * Generic LED platform data for describing LED names and default triggers.
645f46e9203SNate Case  */
646f46e9203SNate Case struct led_info {
647f46e9203SNate Case 	const char	*name;
648326bb8a5STrent Piepho 	const char	*default_trigger;
649f46e9203SNate Case 	int		flags;
650f46e9203SNate Case };
651f46e9203SNate Case 
652f46e9203SNate Case struct led_platform_data {
653f46e9203SNate Case 	int		num_leds;
654f46e9203SNate Case 	struct led_info	*leds;
655f46e9203SNate Case };
656f46e9203SNate Case 
657bb4e9af0SJacek Anaszewski struct led_properties {
658bb4e9af0SJacek Anaszewski 	u32		color;
659bb4e9af0SJacek Anaszewski 	bool		color_present;
660bb4e9af0SJacek Anaszewski 	const char	*function;
661bb4e9af0SJacek Anaszewski 	u32		func_enum;
662bb4e9af0SJacek Anaszewski 	bool		func_enum_present;
663bb4e9af0SJacek Anaszewski 	const char	*label;
664bb4e9af0SJacek Anaszewski };
665bb4e9af0SJacek Anaszewski 
66668620e59SHeiner Kallweit typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
66768620e59SHeiner Kallweit 				unsigned long *delay_on,
66868620e59SHeiner Kallweit 				unsigned long *delay_off);
66968620e59SHeiner Kallweit 
67022e03f3bSRaphael Assenat /* For the leds-gpio driver */
67122e03f3bSRaphael Assenat struct gpio_led {
67222e03f3bSRaphael Assenat 	const char *name;
673326bb8a5STrent Piepho 	const char *default_trigger;
67422e03f3bSRaphael Assenat 	unsigned 	gpio;
675ed88bae6STrent Piepho 	unsigned	active_low : 1;
676ed88bae6STrent Piepho 	unsigned	retain_state_suspended : 1;
67780d6737bSEzequiel Garcia 	unsigned	panic_indicator : 1;
678ed88bae6STrent Piepho 	unsigned	default_state : 2;
679f5808ac1SAndrew Jeffery 	unsigned	retain_state_shutdown : 1;
680ed88bae6STrent Piepho 	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
6815c51277aSMika Westerberg 	struct gpio_desc *gpiod;
68222e03f3bSRaphael Assenat };
683791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_OFF		LEDS_DEFSTATE_OFF
684791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_ON		LEDS_DEFSTATE_ON
685791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_KEEP		LEDS_DEFSTATE_KEEP
68622e03f3bSRaphael Assenat 
68722e03f3bSRaphael Assenat struct gpio_led_platform_data {
68822e03f3bSRaphael Assenat 	int 		num_leds;
6899517f925SUwe Kleine-König 	const struct gpio_led *leds;
6902146325dSBenjamin Herrenschmidt 
6912146325dSBenjamin Herrenschmidt #define GPIO_LED_NO_BLINK_LOW	0	/* No blink GPIO state low */
6922146325dSBenjamin Herrenschmidt #define GPIO_LED_NO_BLINK_HIGH	1	/* No blink GPIO state high */
6939517f925SUwe Kleine-König #define GPIO_LED_BLINK		2	/* Please, blink */
69468620e59SHeiner Kallweit 	gpio_blink_set_t	gpio_blink_set;
69522e03f3bSRaphael Assenat };
69622e03f3bSRaphael Assenat 
69708b7dab9SArnd Bergmann #ifdef CONFIG_LEDS_GPIO_REGISTER
6984440673aSUwe Kleine-König struct platform_device *gpio_led_register_device(
6994440673aSUwe Kleine-König 		int id, const struct gpio_led_platform_data *pdata);
700fca23e47SAndrew F. Davis #else
gpio_led_register_device(int id,const struct gpio_led_platform_data * pdata)701fca23e47SAndrew F. Davis static inline struct platform_device *gpio_led_register_device(
702fca23e47SAndrew F. Davis 		int id, const struct gpio_led_platform_data *pdata)
703fca23e47SAndrew F. Davis {
704fca23e47SAndrew F. Davis 	return 0;
705fca23e47SAndrew F. Davis }
706fca23e47SAndrew F. Davis #endif
70722e03f3bSRaphael Assenat 
7088f88731dSBryan Wu enum cpu_led_event {
7098f88731dSBryan Wu 	CPU_LED_IDLE_START,	/* CPU enters idle */
7108f88731dSBryan Wu 	CPU_LED_IDLE_END,	/* CPU idle ends */
7118f88731dSBryan Wu 	CPU_LED_START,		/* Machine starts, especially resume */
7128f88731dSBryan Wu 	CPU_LED_STOP,		/* Machine stops, especially suspend */
7138f88731dSBryan Wu 	CPU_LED_HALTED,		/* Machine shutdown */
7148f88731dSBryan Wu };
7158f88731dSBryan Wu #ifdef CONFIG_LEDS_TRIGGER_CPU
716ec28a8cfSDan Murphy void ledtrig_cpu(enum cpu_led_event evt);
7178f88731dSBryan Wu #else
ledtrig_cpu(enum cpu_led_event evt)7188f88731dSBryan Wu static inline void ledtrig_cpu(enum cpu_led_event evt)
7198f88731dSBryan Wu {
7208f88731dSBryan Wu 	return;
7218f88731dSBryan Wu }
7228f88731dSBryan Wu #endif
7238f88731dSBryan Wu 
7240cb8eb30SHans de Goede #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
725ec28a8cfSDan Murphy void led_classdev_notify_brightness_hw_changed(
726af0bfab9SAbanoub Sameh 	struct led_classdev *led_cdev, unsigned int brightness);
7270cb8eb30SHans de Goede #else
led_classdev_notify_brightness_hw_changed(struct led_classdev * led_cdev,enum led_brightness brightness)7280cb8eb30SHans de Goede static inline void led_classdev_notify_brightness_hw_changed(
7290cb8eb30SHans de Goede 	struct led_classdev *led_cdev, enum led_brightness brightness) { }
7300cb8eb30SHans de Goede #endif
7310cb8eb30SHans de Goede 
7325fd752b6SBaolin Wang /**
7335fd752b6SBaolin Wang  * struct led_pattern - pattern interval settings
7345fd752b6SBaolin Wang  * @delta_t: pattern interval delay, in milliseconds
7355fd752b6SBaolin Wang  * @brightness: pattern interval brightness
7365fd752b6SBaolin Wang  */
7375fd752b6SBaolin Wang struct led_pattern {
7385fd752b6SBaolin Wang 	u32 delta_t;
7395fd752b6SBaolin Wang 	int brightness;
7405fd752b6SBaolin Wang };
7415fd752b6SBaolin Wang 
742faa2541fSTakashi Iwai enum led_audio {
743faa2541fSTakashi Iwai 	LED_AUDIO_MUTE,		/* master mute LED */
744faa2541fSTakashi Iwai 	LED_AUDIO_MICMUTE,	/* mic mute LED */
745faa2541fSTakashi Iwai 	NUM_AUDIO_LEDS
746faa2541fSTakashi Iwai };
747faa2541fSTakashi Iwai 
748c72a1d60SRichard Purdie #endif		/* __LINUX_LEDS_H_INCLUDED */
749