xref: /openbmc/linux/include/linux/leds.h (revision c7d80059)
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 <lenz@cs.wisc.edu>
6c72a1d60SRichard Purdie  * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
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 
85e5029eddSAndrew Lunn #if IS_ENABLED(CONFIG_NEW_LEDS)
86156a5bb8SAndy Shevchenko enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode);
87e5029eddSAndrew Lunn #else
88e5029eddSAndrew Lunn static inline enum led_default_state
led_init_default_state_get(struct fwnode_handle * fwnode)89e5029eddSAndrew Lunn led_init_default_state_get(struct fwnode_handle *fwnode)
90e5029eddSAndrew Lunn {
91e5029eddSAndrew Lunn 	return LEDS_DEFSTATE_OFF;
92e5029eddSAndrew Lunn }
93e5029eddSAndrew Lunn #endif
94156a5bb8SAndy Shevchenko 
9593690cdfSMarek Behún struct led_hw_trigger_type {
9693690cdfSMarek Behún 	int dummy;
9793690cdfSMarek Behún };
9893690cdfSMarek Behún 
99c72a1d60SRichard Purdie struct led_classdev {
100c72a1d60SRichard Purdie 	const char		*name;
101af0bfab9SAbanoub Sameh 	unsigned int brightness;
102af0bfab9SAbanoub Sameh 	unsigned int max_brightness;
103*c7d80059SJean-Jacques Hiblot 	unsigned int color;
104c72a1d60SRichard Purdie 	int			 flags;
105fb5035dbSBen Dooks 
106859cb7f2SRichard Purdie 	/* Lower 16 bits reflect status */
10755edd1daSDavid Lin #define LED_SUSPENDED		BIT(0)
10855edd1daSDavid Lin #define LED_UNREGISTERING	BIT(1)
109859cb7f2SRichard Purdie 	/* Upper 16 bits reflect control information */
11055edd1daSDavid Lin #define LED_CORE_SUSPENDRESUME	BIT(16)
11155edd1daSDavid Lin #define LED_SYSFS_DISABLE	BIT(17)
11255edd1daSDavid Lin #define LED_DEV_CAP_FLASH	BIT(18)
11355edd1daSDavid Lin #define LED_HW_PLUGGABLE	BIT(19)
11455edd1daSDavid Lin #define LED_PANIC_INDICATOR	BIT(20)
11555edd1daSDavid Lin #define LED_BRIGHT_HW_CHANGED	BIT(21)
11655edd1daSDavid Lin #define LED_RETAIN_AT_SHUTDOWN	BIT(22)
11702d31765SJacek Anaszewski #define LED_INIT_DEFAULT_TRIGGER BIT(23)
118a9c6ce57SHans de Goede 
119a9c6ce57SHans de Goede 	/* set_brightness_work / blink_timer flags, atomic, private. */
120a9c6ce57SHans de Goede 	unsigned long		work_flags;
121a9c6ce57SHans de Goede 
122a9c6ce57SHans de Goede #define LED_BLINK_SW			0
123a9c6ce57SHans de Goede #define LED_BLINK_ONESHOT		1
124a9c6ce57SHans de Goede #define LED_BLINK_ONESHOT_STOP		2
125a9c6ce57SHans de Goede #define LED_BLINK_INVERT		3
126a9c6ce57SHans de Goede #define LED_BLINK_BRIGHTNESS_CHANGE 	4
127a9c6ce57SHans de Goede #define LED_BLINK_DISABLE		5
128fa15d8c6SHans de Goede 	/* Brightness off also disables hw-blinking so it is a separate action */
129fa15d8c6SHans de Goede #define LED_SET_BRIGHTNESS_OFF		6
130fa15d8c6SHans de Goede #define LED_SET_BRIGHTNESS		7
13122720a87SHans de Goede #define LED_SET_BLINK			8
132c72a1d60SRichard Purdie 
13370b2563bSHeiner Kallweit 	/* Set LED brightness level
13470b2563bSHeiner Kallweit 	 * Must not sleep. Use brightness_set_blocking for drivers
13570b2563bSHeiner Kallweit 	 * that can sleep while setting brightness.
13670b2563bSHeiner Kallweit 	 */
137c72a1d60SRichard Purdie 	void		(*brightness_set)(struct led_classdev *led_cdev,
138c72a1d60SRichard Purdie 					  enum led_brightness brightness);
1394d71a4a1SJacek Anaszewski 	/*
1404d71a4a1SJacek Anaszewski 	 * Set LED brightness level immediately - it can block the caller for
1414d71a4a1SJacek Anaszewski 	 * the time required for accessing a LED device register.
1424d71a4a1SJacek Anaszewski 	 */
143437a4240SJacek Anaszewski 	int (*brightness_set_blocking)(struct led_classdev *led_cdev,
1444d71a4a1SJacek Anaszewski 				       enum led_brightness brightness);
14529d76dfaSHenrique de Moraes Holschuh 	/* Get LED brightness level */
14629d76dfaSHenrique de Moraes Holschuh 	enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
147c72a1d60SRichard Purdie 
1485ada28bfSJohannes Berg 	/*
1495ada28bfSJohannes Berg 	 * Activate hardware accelerated blink, delays are in milliseconds
1505ada28bfSJohannes Berg 	 * and if both are zero then a sensible default should be chosen.
1515ada28bfSJohannes Berg 	 * The call should adjust the timings in that case and if it can't
1525ada28bfSJohannes Berg 	 * match the values specified exactly.
1537cfe749fSTony Makkiel 	 * Deactivate blinking again when the brightness is set to LED_OFF
1547cfe749fSTony Makkiel 	 * via the brightness_set() callback.
15522720a87SHans de Goede 	 * For led_blink_set_nosleep() the LED core assumes that blink_set
15622720a87SHans de Goede 	 * implementations, of drivers which do not use brightness_set_blocking,
15722720a87SHans de Goede 	 * will not sleep. Therefor if brightness_set_blocking is not set
15822720a87SHans de Goede 	 * this function must not sleep!
1595ada28bfSJohannes Berg 	 */
1604c79141dSMárton Németh 	int		(*blink_set)(struct led_classdev *led_cdev,
1614c79141dSMárton Németh 				     unsigned long *delay_on,
1624c79141dSMárton Németh 				     unsigned long *delay_off);
1634c79141dSMárton Németh 
1645fd752b6SBaolin Wang 	int (*pattern_set)(struct led_classdev *led_cdev,
1655fd752b6SBaolin Wang 			   struct led_pattern *pattern, u32 len, int repeat);
1665fd752b6SBaolin Wang 	int (*pattern_clear)(struct led_classdev *led_cdev);
1675fd752b6SBaolin Wang 
168f8a7c6feSRichard Purdie 	struct device		*dev;
169d0d480ccSJohan Hovold 	const struct attribute_group	**groups;
170d0d480ccSJohan Hovold 
171fb5035dbSBen Dooks 	struct list_head	 node;			/* LED Device list */
172781a54e7SAnton Vorontsov 	const char		*default_trigger;	/* Trigger to use */
173c72a1d60SRichard Purdie 
1745ada28bfSJohannes Berg 	unsigned long		 blink_delay_on, blink_delay_off;
1759067359fSJiri Kosina 	struct timer_list	 blink_timer;
1765ada28bfSJohannes Berg 	int			 blink_brightness;
177eb1610b4SHans de Goede 	int			 new_blink_brightness;
1787aea8389SJacek Anaszewski 	void			(*flash_resume)(struct led_classdev *led_cdev);
1795ada28bfSJohannes Berg 
180d23a22a7SFabio Baltieri 	struct work_struct	set_brightness_work;
181d23a22a7SFabio Baltieri 	int			delayed_set_value;
18222720a87SHans de Goede 	unsigned long		delayed_delay_on;
18322720a87SHans de Goede 	unsigned long		delayed_delay_off;
184d23a22a7SFabio Baltieri 
185c3bc9956SRichard Purdie #ifdef CONFIG_LEDS_TRIGGERS
186c3bc9956SRichard Purdie 	/* Protects the trigger data below */
187dc47206eSRichard Purdie 	struct rw_semaphore	 trigger_lock;
188c3bc9956SRichard Purdie 
189c3bc9956SRichard Purdie 	struct led_trigger	*trigger;
190c3bc9956SRichard Purdie 	struct list_head	 trig_list;
191c3bc9956SRichard Purdie 	void			*trigger_data;
192b0096182SShuah Khan 	/* true if activated - deactivate routine uses it to do cleanup */
193b0096182SShuah Khan 	bool			activated;
19493690cdfSMarek Behún 
19593690cdfSMarek Behún 	/* LEDs that have private triggers have this set */
19693690cdfSMarek Behún 	struct led_hw_trigger_type	*trigger_type;
197ed554d3fSChristian Marangi 
198ed554d3fSChristian Marangi 	/* Unique trigger name supported by LED set in hw control mode */
199ed554d3fSChristian Marangi 	const char		*hw_control_trigger;
200ed554d3fSChristian Marangi 	/*
201ed554d3fSChristian Marangi 	 * Check if the LED driver supports the requested mode provided by the
202ed554d3fSChristian Marangi 	 * defined supported trigger to setup the LED to hw control mode.
203ed554d3fSChristian Marangi 	 *
204ed554d3fSChristian Marangi 	 * Return 0 on success. Return -EOPNOTSUPP when the passed flags are not
205ed554d3fSChristian Marangi 	 * supported and software fallback needs to be used.
206ed554d3fSChristian Marangi 	 * Return a negative error number on any other case  for check fail due
207ed554d3fSChristian Marangi 	 * to various reason like device not ready or timeouts.
208ed554d3fSChristian Marangi 	 */
209ed554d3fSChristian Marangi 	int			(*hw_control_is_supported)(struct led_classdev *led_cdev,
210ed554d3fSChristian Marangi 							   unsigned long flags);
211ed554d3fSChristian Marangi 	/*
212ed554d3fSChristian Marangi 	 * Activate hardware control, LED driver will use the provided flags
213ed554d3fSChristian Marangi 	 * from the supported trigger and setup the LED to be driven by hardware
214ed554d3fSChristian Marangi 	 * following the requested mode from the trigger flags.
215ed554d3fSChristian Marangi 	 * Deactivate hardware blink control by setting brightness to LED_OFF via
216ed554d3fSChristian Marangi 	 * the brightness_set() callback.
217ed554d3fSChristian Marangi 	 *
218ed554d3fSChristian Marangi 	 * Return 0 on success, a negative error number on flags apply fail.
219ed554d3fSChristian Marangi 	 */
220ed554d3fSChristian Marangi 	int			(*hw_control_set)(struct led_classdev *led_cdev,
221ed554d3fSChristian Marangi 						  unsigned long flags);
222ed554d3fSChristian Marangi 	/*
223ed554d3fSChristian Marangi 	 * Get from the LED driver the current mode that the LED is set in hw
224ed554d3fSChristian Marangi 	 * control mode and put them in flags.
225ed554d3fSChristian Marangi 	 * Trigger can use this to get the initial state of a LED already set in
226ed554d3fSChristian Marangi 	 * hardware blink control.
227ed554d3fSChristian Marangi 	 *
228ed554d3fSChristian Marangi 	 * Return 0 on success, a negative error number on failing parsing the
229ed554d3fSChristian Marangi 	 * initial mode. Error from this function is NOT FATAL as the device
230ed554d3fSChristian Marangi 	 * may be in a not supported initial state by the attached LED trigger.
231ed554d3fSChristian Marangi 	 */
232ed554d3fSChristian Marangi 	int			(*hw_control_get)(struct led_classdev *led_cdev,
233ed554d3fSChristian Marangi 						  unsigned long *flags);
234052c38ebSAndrew Lunn 	/*
235052c38ebSAndrew Lunn 	 * Get the device this LED blinks in response to.
236052c38ebSAndrew Lunn 	 * e.g. for a PHY LED, it is the network device. If the LED is
237052c38ebSAndrew Lunn 	 * not yet associated to a device, return NULL.
238052c38ebSAndrew Lunn 	 */
239052c38ebSAndrew Lunn 	struct device		*(*hw_control_get_device)(struct led_classdev *led_cdev);
240c3bc9956SRichard Purdie #endif
241acd899e4SJacek Anaszewski 
2420cb8eb30SHans de Goede #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
2430cb8eb30SHans de Goede 	int			 brightness_hw_changed;
2440cb8eb30SHans de Goede 	struct kernfs_node	*brightness_hw_changed_kn;
2450cb8eb30SHans de Goede #endif
2460cb8eb30SHans de Goede 
247acd899e4SJacek Anaszewski 	/* Ensures consistent access to the LED Flash Class device */
248acd899e4SJacek Anaszewski 	struct mutex		led_access;
249c72a1d60SRichard Purdie };
250c72a1d60SRichard Purdie 
251b2b998c0SJacek Anaszewski /**
252b2b998c0SJacek Anaszewski  * led_classdev_register_ext - register a new object of LED class with
253b2b998c0SJacek Anaszewski  *			       init data
254b2b998c0SJacek Anaszewski  * @parent: LED controller device this LED is driven by
255b2b998c0SJacek Anaszewski  * @led_cdev: the led_classdev structure for this device
256b2b998c0SJacek Anaszewski  * @init_data: the LED class device initialization data
257b2b998c0SJacek Anaszewski  *
2587c322056SJacek Anaszewski  * Register a new object of LED class, with name derived from init_data.
2597c322056SJacek Anaszewski  *
260b2b998c0SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
261b2b998c0SJacek Anaszewski  */
262ec28a8cfSDan Murphy int led_classdev_register_ext(struct device *parent,
263b2b998c0SJacek Anaszewski 				     struct led_classdev *led_cdev,
264b2b998c0SJacek Anaszewski 				     struct led_init_data *init_data);
2657c322056SJacek Anaszewski 
2667c322056SJacek Anaszewski /**
2677c322056SJacek Anaszewski  * led_classdev_register - register a new object of LED class
2687c322056SJacek Anaszewski  * @parent: LED controller device this LED is driven by
2697c322056SJacek Anaszewski  * @led_cdev: the led_classdev structure for this device
2707c322056SJacek Anaszewski  *
2717c322056SJacek Anaszewski  * Register a new object of LED class, with name derived from the name property
2727c322056SJacek Anaszewski  * of passed led_cdev argument.
2737c322056SJacek Anaszewski  *
2747c322056SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
2757c322056SJacek Anaszewski  */
led_classdev_register(struct device * parent,struct led_classdev * led_cdev)2767c322056SJacek Anaszewski static inline int led_classdev_register(struct device *parent,
2777c322056SJacek Anaszewski 					struct led_classdev *led_cdev)
2787c322056SJacek Anaszewski {
2797c322056SJacek Anaszewski 	return led_classdev_register_ext(parent, led_cdev, NULL);
2807c322056SJacek Anaszewski }
2817c322056SJacek Anaszewski 
282e5029eddSAndrew Lunn #if IS_ENABLED(CONFIG_LEDS_CLASS)
283ec28a8cfSDan Murphy int devm_led_classdev_register_ext(struct device *parent,
284b2b998c0SJacek Anaszewski 					  struct led_classdev *led_cdev,
285b2b998c0SJacek Anaszewski 					  struct led_init_data *init_data);
286e5029eddSAndrew Lunn #else
287e5029eddSAndrew Lunn static inline int
devm_led_classdev_register_ext(struct device * parent,struct led_classdev * led_cdev,struct led_init_data * init_data)288e5029eddSAndrew Lunn devm_led_classdev_register_ext(struct device *parent,
289e5029eddSAndrew Lunn 			       struct led_classdev *led_cdev,
290e5029eddSAndrew Lunn 			       struct led_init_data *init_data)
291e5029eddSAndrew Lunn {
292e5029eddSAndrew Lunn 	return 0;
293e5029eddSAndrew Lunn }
294e5029eddSAndrew Lunn #endif
2957c322056SJacek Anaszewski 
devm_led_classdev_register(struct device * parent,struct led_classdev * led_cdev)2967c322056SJacek Anaszewski static inline int devm_led_classdev_register(struct device *parent,
2977c322056SJacek Anaszewski 					     struct led_classdev *led_cdev)
2987c322056SJacek Anaszewski {
2997c322056SJacek Anaszewski 	return devm_led_classdev_register_ext(parent, led_cdev, NULL);
3007c322056SJacek Anaszewski }
301ec28a8cfSDan Murphy void led_classdev_unregister(struct led_classdev *led_cdev);
302ec28a8cfSDan Murphy void devm_led_classdev_unregister(struct device *parent,
303ca1bb4eeSBjorn Andersson 				  struct led_classdev *led_cdev);
304ec28a8cfSDan Murphy void led_classdev_suspend(struct led_classdev *led_cdev);
305ec28a8cfSDan Murphy void led_classdev_resume(struct led_classdev *led_cdev);
306c72a1d60SRichard Purdie 
307abc3100fSHans de Goede void led_add_lookup(struct led_lookup_data *led_lookup);
308abc3100fSHans de Goede void led_remove_lookup(struct led_lookup_data *led_lookup);
309abc3100fSHans de Goede 
310abc3100fSHans de Goede struct led_classdev *__must_check led_get(struct device *dev, char *con_id);
311abc3100fSHans de Goede struct led_classdev *__must_check devm_led_get(struct device *dev, char *con_id);
312abc3100fSHans de Goede 
313699a8c7cSTomi Valkeinen extern struct led_classdev *of_led_get(struct device_node *np, int index);
314699a8c7cSTomi Valkeinen extern void led_put(struct led_classdev *led_cdev);
315e389240aSJean-Jacques Hiblot struct led_classdev *__must_check devm_of_led_get(struct device *dev,
316e389240aSJean-Jacques Hiblot 						  int index);
317afb48153SJean-Jacques Hiblot struct led_classdev *__must_check devm_of_led_get_optional(struct device *dev,
318afb48153SJean-Jacques Hiblot 						  int index);
319699a8c7cSTomi Valkeinen 
3205ada28bfSJohannes Berg /**
3215ada28bfSJohannes Berg  * led_blink_set - set blinking with software fallback
3225ada28bfSJohannes Berg  * @led_cdev: the LED to start blinking
3235ada28bfSJohannes Berg  * @delay_on: the time it should be on (in ms)
3245ada28bfSJohannes Berg  * @delay_off: the time it should ble off (in ms)
3255ada28bfSJohannes Berg  *
3265ada28bfSJohannes Berg  * This function makes the LED blink, attempting to use the
3275ada28bfSJohannes Berg  * hardware acceleration if possible, but falling back to
3285ada28bfSJohannes Berg  * software blinking if there is no hardware blinking or if
3295ada28bfSJohannes Berg  * the LED refuses the passed values.
3305ada28bfSJohannes Berg  *
33122720a87SHans de Goede  * This function may sleep!
33222720a87SHans de Goede  *
3335ada28bfSJohannes Berg  * Note that if software blinking is active, simply calling
3345ada28bfSJohannes Berg  * led_cdev->brightness_set() will not stop the blinking,
3358af70e20SThomas Weißschuh  * use led_set_brightness() instead.
3365ada28bfSJohannes Berg  */
337ec28a8cfSDan Murphy void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
3385ada28bfSJohannes Berg 		   unsigned long *delay_off);
33922720a87SHans de Goede 
34022720a87SHans de Goede /**
34122720a87SHans de Goede  * led_blink_set_nosleep - set blinking, guaranteed to not sleep
34222720a87SHans de Goede  * @led_cdev: the LED to start blinking
34322720a87SHans de Goede  * @delay_on: the time it should be on (in ms)
34422720a87SHans de Goede  * @delay_off: the time it should ble off (in ms)
34522720a87SHans de Goede  *
34622720a87SHans de Goede  * This function makes the LED blink and is guaranteed to not sleep. Otherwise
34722720a87SHans de Goede  * this is the same as led_blink_set(), see led_blink_set() for details.
34822720a87SHans de Goede  */
34922720a87SHans de Goede void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
35022720a87SHans de Goede 			   unsigned long delay_off);
35122720a87SHans de Goede 
3525ada28bfSJohannes Berg /**
3535bb629c5SFabio Baltieri  * led_blink_set_oneshot - do a oneshot software blink
3545bb629c5SFabio Baltieri  * @led_cdev: the LED to start blinking
3555bb629c5SFabio Baltieri  * @delay_on: the time it should be on (in ms)
3565bb629c5SFabio Baltieri  * @delay_off: the time it should ble off (in ms)
3575bb629c5SFabio Baltieri  * @invert: blink off, then on, leaving the led on
3585bb629c5SFabio Baltieri  *
3595bb629c5SFabio Baltieri  * This function makes the LED blink one time for delay_on +
3605bb629c5SFabio Baltieri  * delay_off time, ignoring the request if another one-shot
3615bb629c5SFabio Baltieri  * blink is already in progress.
3625bb629c5SFabio Baltieri  *
3635bb629c5SFabio Baltieri  * If invert is set, led blinks for delay_off first, then for
3645bb629c5SFabio Baltieri  * delay_on and leave the led on after the on-off cycle.
36522720a87SHans de Goede  *
36622720a87SHans de Goede  * This function is guaranteed not to sleep.
3675bb629c5SFabio Baltieri  */
368ec28a8cfSDan Murphy void led_blink_set_oneshot(struct led_classdev *led_cdev,
369ec28a8cfSDan Murphy 			   unsigned long *delay_on, unsigned long *delay_off,
3705bb629c5SFabio Baltieri 			   int invert);
3715bb629c5SFabio Baltieri /**
37219cd67e2SShuah Khan  * led_set_brightness - set LED brightness
3735ada28bfSJohannes Berg  * @led_cdev: the LED to set
3745ada28bfSJohannes Berg  * @brightness: the brightness to set it to
3755ada28bfSJohannes Berg  *
3765ada28bfSJohannes Berg  * Set an LED's brightness, and, if necessary, cancel the
3775ada28bfSJohannes Berg  * software blink timer that implements blinking when the
3781afcadfcSJacek Anaszewski  * hardware doesn't. This function is guaranteed not to sleep.
3795ada28bfSJohannes Berg  */
380af0bfab9SAbanoub Sameh void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness);
38113ae79bbSJacek Anaszewski 
38213ae79bbSJacek Anaszewski /**
38313ae79bbSJacek Anaszewski  * led_set_brightness_sync - set LED brightness synchronously
38413ae79bbSJacek Anaszewski  * @led_cdev: the LED to set
3859cc93be7SDan Murphy  * @value: the brightness to set it to
38613ae79bbSJacek Anaszewski  *
38713ae79bbSJacek Anaszewski  * Set an LED's brightness immediately. This function will block
38813ae79bbSJacek Anaszewski  * the caller for the time required for accessing device registers,
38913ae79bbSJacek Anaszewski  * and it can sleep.
39013ae79bbSJacek Anaszewski  *
39113ae79bbSJacek Anaszewski  * Returns: 0 on success or negative error value on failure
39213ae79bbSJacek Anaszewski  */
393af0bfab9SAbanoub Sameh int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value);
39413ae79bbSJacek Anaszewski 
3953ef7de53SJacek Anaszewski /**
3963ef7de53SJacek Anaszewski  * led_update_brightness - update LED brightness
3973ef7de53SJacek Anaszewski  * @led_cdev: the LED to query
3983ef7de53SJacek Anaszewski  *
3993ef7de53SJacek Anaszewski  * Get an LED's current brightness and update led_cdev->brightness
4003ef7de53SJacek Anaszewski  * member with the obtained value.
4013ef7de53SJacek Anaszewski  *
4023ef7de53SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
4033ef7de53SJacek Anaszewski  */
404ec28a8cfSDan Murphy int led_update_brightness(struct led_classdev *led_cdev);
4055ada28bfSJohannes Berg 
406acd899e4SJacek Anaszewski /**
4078e1f4561SKrzysztof Kozlowski  * led_get_default_pattern - return default pattern
4088e1f4561SKrzysztof Kozlowski  *
4098e1f4561SKrzysztof Kozlowski  * @led_cdev: the LED to get default pattern for
4108e1f4561SKrzysztof Kozlowski  * @size:     pointer for storing the number of elements in returned array,
4118e1f4561SKrzysztof Kozlowski  *            modified only if return != NULL
4128e1f4561SKrzysztof Kozlowski  *
4138e1f4561SKrzysztof Kozlowski  * Return:    Allocated array of integers with default pattern from device tree
4148e1f4561SKrzysztof Kozlowski  *            or NULL.  Caller is responsible for kfree().
4158e1f4561SKrzysztof Kozlowski  */
416ec28a8cfSDan Murphy u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
4178e1f4561SKrzysztof Kozlowski 
4188e1f4561SKrzysztof Kozlowski /**
419acd899e4SJacek Anaszewski  * led_sysfs_disable - disable LED sysfs interface
420acd899e4SJacek Anaszewski  * @led_cdev: the LED to set
421acd899e4SJacek Anaszewski  *
422acd899e4SJacek Anaszewski  * Disable the led_cdev's sysfs interface.
423acd899e4SJacek Anaszewski  */
424ec28a8cfSDan Murphy void led_sysfs_disable(struct led_classdev *led_cdev);
425acd899e4SJacek Anaszewski 
426acd899e4SJacek Anaszewski /**
427acd899e4SJacek Anaszewski  * led_sysfs_enable - enable LED sysfs interface
428acd899e4SJacek Anaszewski  * @led_cdev: the LED to set
429acd899e4SJacek Anaszewski  *
430acd899e4SJacek Anaszewski  * Enable the led_cdev's sysfs interface.
431acd899e4SJacek Anaszewski  */
432ec28a8cfSDan Murphy void led_sysfs_enable(struct led_classdev *led_cdev);
433acd899e4SJacek Anaszewski 
434acd899e4SJacek Anaszewski /**
435bb4e9af0SJacek Anaszewski  * led_compose_name - compose LED class device name
436bb4e9af0SJacek Anaszewski  * @dev: LED controller device object
4379cc93be7SDan Murphy  * @init_data: the LED class device initialization data
438bb4e9af0SJacek Anaszewski  * @led_classdev_name: composed LED class device name
439bb4e9af0SJacek Anaszewski  *
440bb4e9af0SJacek Anaszewski  * Create LED class device name basing on the provided init_data argument.
441bb4e9af0SJacek Anaszewski  * The name can have <devicename:color:function> or <color:function>.
442bb4e9af0SJacek Anaszewski  * form, depending on the init_data configuration.
443bb4e9af0SJacek Anaszewski  *
444bb4e9af0SJacek Anaszewski  * Returns: 0 on success or negative error value on failure
445bb4e9af0SJacek Anaszewski  */
446ec28a8cfSDan Murphy int led_compose_name(struct device *dev, struct led_init_data *init_data,
447bb4e9af0SJacek Anaszewski 		     char *led_classdev_name);
448bb4e9af0SJacek Anaszewski 
449bb4e9af0SJacek Anaszewski /**
450acd899e4SJacek Anaszewski  * led_sysfs_is_disabled - check if LED sysfs interface is disabled
451acd899e4SJacek Anaszewski  * @led_cdev: the LED to query
452acd899e4SJacek Anaszewski  *
453acd899e4SJacek Anaszewski  * Returns: true if the led_cdev's sysfs interface is disabled.
454acd899e4SJacek Anaszewski  */
led_sysfs_is_disabled(struct led_classdev * led_cdev)455acd899e4SJacek Anaszewski static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
456acd899e4SJacek Anaszewski {
457acd899e4SJacek Anaszewski 	return led_cdev->flags & LED_SYSFS_DISABLE;
458acd899e4SJacek Anaszewski }
459acd899e4SJacek Anaszewski 
460c3bc9956SRichard Purdie /*
461c3bc9956SRichard Purdie  * LED Triggers
462c3bc9956SRichard Purdie  */
46339f7e08aSKim, Milo /* Registration functions for simple triggers */
46439f7e08aSKim, Milo #define DEFINE_LED_TRIGGER(x)		static struct led_trigger *x;
46539f7e08aSKim, Milo #define DEFINE_LED_TRIGGER_GLOBAL(x)	struct led_trigger *x;
46639f7e08aSKim, Milo 
467c3bc9956SRichard Purdie #ifdef CONFIG_LEDS_TRIGGERS
468c3bc9956SRichard Purdie 
469c3bc9956SRichard Purdie #define TRIG_NAME_MAX 50
470c3bc9956SRichard Purdie 
471c3bc9956SRichard Purdie struct led_trigger {
472c3bc9956SRichard Purdie 	/* Trigger Properties */
473c3bc9956SRichard Purdie 	const char	 *name;
4742282e125SUwe Kleine-König 	int		(*activate)(struct led_classdev *led_cdev);
475c3bc9956SRichard Purdie 	void		(*deactivate)(struct led_classdev *led_cdev);
476c3bc9956SRichard Purdie 
47793690cdfSMarek Behún 	/* LED-private triggers have this set */
47893690cdfSMarek Behún 	struct led_hw_trigger_type *trigger_type;
47993690cdfSMarek Behún 
480c3bc9956SRichard Purdie 	/* LEDs under control by this trigger (for simple triggers) */
4812a5a8fa8SJohannes Berg 	spinlock_t	  leddev_list_lock;
482c3bc9956SRichard Purdie 	struct list_head  led_cdevs;
483c3bc9956SRichard Purdie 
484c3bc9956SRichard Purdie 	/* Link to next registered trigger */
485c3bc9956SRichard Purdie 	struct list_head  next_trig;
486a7e7a315SUwe Kleine-König 
487a7e7a315SUwe Kleine-König 	const struct attribute_group **groups;
488c3bc9956SRichard Purdie };
489c3bc9956SRichard Purdie 
490a7e7a315SUwe Kleine-König /*
491a7e7a315SUwe Kleine-König  * Currently the attributes in struct led_trigger::groups are added directly to
492a7e7a315SUwe Kleine-König  * the LED device. As this might change in the future, the following
493a7e7a315SUwe Kleine-König  * macros abstract getting the LED device and its trigger_data from the dev
494a7e7a315SUwe Kleine-König  * parameter passed to the attribute accessor functions.
495a7e7a315SUwe Kleine-König  */
496a7e7a315SUwe Kleine-König #define led_trigger_get_led(dev)	((struct led_classdev *)dev_get_drvdata((dev)))
497a7e7a315SUwe Kleine-König #define led_trigger_get_drvdata(dev)	(led_get_trigger_data(led_trigger_get_led(dev)))
498a7e7a315SUwe Kleine-König 
499c3bc9956SRichard Purdie /* Registration functions for complex triggers */
500ec28a8cfSDan Murphy int led_trigger_register(struct led_trigger *trigger);
501ec28a8cfSDan Murphy void led_trigger_unregister(struct led_trigger *trigger);
502ec28a8cfSDan Murphy int devm_led_trigger_register(struct device *dev,
5039534cc31SHeiner Kallweit 				     struct led_trigger *trigger);
504c3bc9956SRichard Purdie 
505ec28a8cfSDan Murphy void led_trigger_register_simple(const char *name,
506c3bc9956SRichard Purdie 				struct led_trigger **trigger);
507ec28a8cfSDan Murphy void led_trigger_unregister_simple(struct led_trigger *trigger);
508ec28a8cfSDan Murphy void led_trigger_event(struct led_trigger *trigger,  enum led_brightness event);
509e298d8a3SHans de Goede void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
510e298d8a3SHans de Goede 		       unsigned long delay_off);
511ec28a8cfSDan Murphy void led_trigger_blink_oneshot(struct led_trigger *trigger,
512e298d8a3SHans de Goede 			       unsigned long delay_on,
513e298d8a3SHans de Goede 			       unsigned long delay_off,
5145bb629c5SFabio Baltieri 			       int invert);
515ec28a8cfSDan Murphy void led_trigger_set_default(struct led_classdev *led_cdev);
516ec28a8cfSDan Murphy int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
517ec28a8cfSDan Murphy void led_trigger_remove(struct led_classdev *led_cdev);
51820f56758SJacek Anaszewski 
led_set_trigger_data(struct led_classdev * led_cdev,void * trigger_data)5199acc560dSUwe Kleine-König static inline void led_set_trigger_data(struct led_classdev *led_cdev,
5209acc560dSUwe Kleine-König 					void *trigger_data)
5219acc560dSUwe Kleine-König {
5229acc560dSUwe Kleine-König 	led_cdev->trigger_data = trigger_data;
5239acc560dSUwe Kleine-König }
5249acc560dSUwe Kleine-König 
led_get_trigger_data(struct led_classdev * led_cdev)52520f56758SJacek Anaszewski static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
52620f56758SJacek Anaszewski {
52720f56758SJacek Anaszewski 	return led_cdev->trigger_data;
52820f56758SJacek Anaszewski }
52920f56758SJacek Anaszewski 
530057407c7SJingoo Han /**
531057407c7SJingoo Han  * led_trigger_rename_static - rename a trigger
532057407c7SJingoo Han  * @name: the new trigger name
533057407c7SJingoo Han  * @trig: the LED trigger to rename
534057407c7SJingoo Han  *
535057407c7SJingoo Han  * Change a LED trigger name by copying the string passed in
536057407c7SJingoo Han  * name into current trigger name, which MUST be large
537057407c7SJingoo Han  * enough for the new string.
538057407c7SJingoo Han  *
539057407c7SJingoo Han  * Note that name must NOT point to the same string used
540057407c7SJingoo Han  * during LED registration, as that could lead to races.
541057407c7SJingoo Han  *
542057407c7SJingoo Han  * This is meant to be used on triggers with statically
543057407c7SJingoo Han  * allocated name.
544057407c7SJingoo Han  */
545ec28a8cfSDan Murphy void led_trigger_rename_static(const char *name, struct led_trigger *trig);
546c3bc9956SRichard Purdie 
547a0b75076SUwe Kleine-König #define module_led_trigger(__led_trigger) \
548a0b75076SUwe Kleine-König 	module_driver(__led_trigger, led_trigger_register, \
549a0b75076SUwe Kleine-König 		      led_trigger_unregister)
550a0b75076SUwe Kleine-König 
551c3bc9956SRichard Purdie #else
552c3bc9956SRichard Purdie 
55339f7e08aSKim, Milo /* Trigger has no members */
55439f7e08aSKim, Milo struct led_trigger {};
555c3bc9956SRichard Purdie 
55639f7e08aSKim, Milo /* Trigger inline empty functions */
led_trigger_register_simple(const char * name,struct led_trigger ** trigger)55739f7e08aSKim, Milo static inline void led_trigger_register_simple(const char *name,
55839f7e08aSKim, Milo 					struct led_trigger **trigger) {}
led_trigger_unregister_simple(struct led_trigger * trigger)55939f7e08aSKim, Milo static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
led_trigger_event(struct led_trigger * trigger,enum led_brightness event)56039f7e08aSKim, Milo static inline void led_trigger_event(struct led_trigger *trigger,
56139f7e08aSKim, Milo 				enum led_brightness event) {}
led_trigger_blink(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off)5628890624aSMichael Grzeschik static inline void led_trigger_blink(struct led_trigger *trigger,
563e298d8a3SHans de Goede 				      unsigned long delay_on,
564e298d8a3SHans de Goede 				      unsigned long delay_off) {}
led_trigger_blink_oneshot(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off,int invert)5658890624aSMichael Grzeschik static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
566e298d8a3SHans de Goede 				      unsigned long delay_on,
567e298d8a3SHans de Goede 				      unsigned long delay_off,
5688890624aSMichael Grzeschik 				      int invert) {}
led_trigger_set_default(struct led_classdev * led_cdev)56920f56758SJacek 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)5702282e125SUwe Kleine-König static inline int led_trigger_set(struct led_classdev *led_cdev,
5712282e125SUwe Kleine-König 				  struct led_trigger *trigger)
5722282e125SUwe Kleine-König {
5732282e125SUwe Kleine-König 	return 0;
5742282e125SUwe Kleine-König }
5752282e125SUwe Kleine-König 
led_trigger_remove(struct led_classdev * led_cdev)57620f56758SJacek Anaszewski static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
led_set_trigger_data(struct led_classdev * led_cdev)5779acc560dSUwe Kleine-König static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
led_get_trigger_data(struct led_classdev * led_cdev)57820f56758SJacek Anaszewski static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
57920f56758SJacek Anaszewski {
58020f56758SJacek Anaszewski 	return NULL;
58120f56758SJacek Anaszewski }
58220f56758SJacek Anaszewski 
58339f7e08aSKim, Milo #endif /* CONFIG_LEDS_TRIGGERS */
5842bfb646cSRichard Purdie 
585947acacaSChristian Marangi /* Trigger specific enum */
586947acacaSChristian Marangi enum led_trigger_netdev_modes {
587947acacaSChristian Marangi 	TRIGGER_NETDEV_LINK = 0,
588d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_10,
589d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_100,
590d5e01266SChristian Marangi 	TRIGGER_NETDEV_LINK_1000,
591f22f95b9SChristian Marangi 	TRIGGER_NETDEV_HALF_DUPLEX,
592f22f95b9SChristian Marangi 	TRIGGER_NETDEV_FULL_DUPLEX,
593947acacaSChristian Marangi 	TRIGGER_NETDEV_TX,
594947acacaSChristian Marangi 	TRIGGER_NETDEV_RX,
595947acacaSChristian Marangi 
596947acacaSChristian Marangi 	/* Keep last */
597947acacaSChristian Marangi 	__TRIGGER_NETDEV_MAX,
598947acacaSChristian Marangi };
599947acacaSChristian Marangi 
6002bfb646cSRichard Purdie /* Trigger specific functions */
601eb25cb99SStephan Linz #ifdef CONFIG_LEDS_TRIGGER_DISK
602ec28a8cfSDan Murphy void ledtrig_disk_activity(bool write);
6032bfb646cSRichard Purdie #else
ledtrig_disk_activity(bool write)604d1ed7c55SLinus Walleij static inline void ledtrig_disk_activity(bool write) {}
6052bfb646cSRichard Purdie #endif
6062bfb646cSRichard Purdie 
6074b721174SEzequiel Garcia #ifdef CONFIG_LEDS_TRIGGER_MTD
608ec28a8cfSDan Murphy void ledtrig_mtd_activity(void);
6094b721174SEzequiel Garcia #else
ledtrig_mtd_activity(void)6104b721174SEzequiel Garcia static inline void ledtrig_mtd_activity(void) {}
6114b721174SEzequiel Garcia #endif
6124b721174SEzequiel Garcia 
61348a1d032SKim, Milo #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
614ec28a8cfSDan Murphy void ledtrig_flash_ctrl(bool on);
615ec28a8cfSDan Murphy void ledtrig_torch_ctrl(bool on);
61648a1d032SKim, Milo #else
ledtrig_flash_ctrl(bool on)61748a1d032SKim, Milo static inline void ledtrig_flash_ctrl(bool on) {}
ledtrig_torch_ctrl(bool on)61848a1d032SKim, Milo static inline void ledtrig_torch_ctrl(bool on) {}
61948a1d032SKim, Milo #endif
62048a1d032SKim, Milo 
621f46e9203SNate Case /*
622f46e9203SNate Case  * Generic LED platform data for describing LED names and default triggers.
623f46e9203SNate Case  */
624f46e9203SNate Case struct led_info {
625f46e9203SNate Case 	const char	*name;
626326bb8a5STrent Piepho 	const char	*default_trigger;
627f46e9203SNate Case 	int		flags;
628f46e9203SNate Case };
629f46e9203SNate Case 
630f46e9203SNate Case struct led_platform_data {
631f46e9203SNate Case 	int		num_leds;
632f46e9203SNate Case 	struct led_info	*leds;
633f46e9203SNate Case };
634f46e9203SNate Case 
635bb4e9af0SJacek Anaszewski struct led_properties {
636bb4e9af0SJacek Anaszewski 	u32		color;
637bb4e9af0SJacek Anaszewski 	bool		color_present;
638bb4e9af0SJacek Anaszewski 	const char	*function;
639bb4e9af0SJacek Anaszewski 	u32		func_enum;
640bb4e9af0SJacek Anaszewski 	bool		func_enum_present;
641bb4e9af0SJacek Anaszewski 	const char	*label;
642bb4e9af0SJacek Anaszewski };
643bb4e9af0SJacek Anaszewski 
64468620e59SHeiner Kallweit typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
64568620e59SHeiner Kallweit 				unsigned long *delay_on,
64668620e59SHeiner Kallweit 				unsigned long *delay_off);
64768620e59SHeiner Kallweit 
64822e03f3bSRaphael Assenat /* For the leds-gpio driver */
64922e03f3bSRaphael Assenat struct gpio_led {
65022e03f3bSRaphael Assenat 	const char *name;
651326bb8a5STrent Piepho 	const char *default_trigger;
65222e03f3bSRaphael Assenat 	unsigned 	gpio;
653ed88bae6STrent Piepho 	unsigned	active_low : 1;
654ed88bae6STrent Piepho 	unsigned	retain_state_suspended : 1;
65580d6737bSEzequiel Garcia 	unsigned	panic_indicator : 1;
656ed88bae6STrent Piepho 	unsigned	default_state : 2;
657f5808ac1SAndrew Jeffery 	unsigned	retain_state_shutdown : 1;
658ed88bae6STrent Piepho 	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
6595c51277aSMika Westerberg 	struct gpio_desc *gpiod;
66022e03f3bSRaphael Assenat };
661791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_OFF		LEDS_DEFSTATE_OFF
662791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_ON		LEDS_DEFSTATE_ON
663791bc411SDenis Osterland-Heim #define LEDS_GPIO_DEFSTATE_KEEP		LEDS_DEFSTATE_KEEP
66422e03f3bSRaphael Assenat 
66522e03f3bSRaphael Assenat struct gpio_led_platform_data {
66622e03f3bSRaphael Assenat 	int 		num_leds;
6679517f925SUwe Kleine-König 	const struct gpio_led *leds;
6682146325dSBenjamin Herrenschmidt 
6692146325dSBenjamin Herrenschmidt #define GPIO_LED_NO_BLINK_LOW	0	/* No blink GPIO state low */
6702146325dSBenjamin Herrenschmidt #define GPIO_LED_NO_BLINK_HIGH	1	/* No blink GPIO state high */
6719517f925SUwe Kleine-König #define GPIO_LED_BLINK		2	/* Please, blink */
67268620e59SHeiner Kallweit 	gpio_blink_set_t	gpio_blink_set;
67322e03f3bSRaphael Assenat };
67422e03f3bSRaphael Assenat 
675fca23e47SAndrew F. Davis #ifdef CONFIG_NEW_LEDS
6764440673aSUwe Kleine-König struct platform_device *gpio_led_register_device(
6774440673aSUwe Kleine-König 		int id, const struct gpio_led_platform_data *pdata);
678fca23e47SAndrew F. Davis #else
gpio_led_register_device(int id,const struct gpio_led_platform_data * pdata)679fca23e47SAndrew F. Davis static inline struct platform_device *gpio_led_register_device(
680fca23e47SAndrew F. Davis 		int id, const struct gpio_led_platform_data *pdata)
681fca23e47SAndrew F. Davis {
682fca23e47SAndrew F. Davis 	return 0;
683fca23e47SAndrew F. Davis }
684fca23e47SAndrew F. Davis #endif
68522e03f3bSRaphael Assenat 
6868f88731dSBryan Wu enum cpu_led_event {
6878f88731dSBryan Wu 	CPU_LED_IDLE_START,	/* CPU enters idle */
6888f88731dSBryan Wu 	CPU_LED_IDLE_END,	/* CPU idle ends */
6898f88731dSBryan Wu 	CPU_LED_START,		/* Machine starts, especially resume */
6908f88731dSBryan Wu 	CPU_LED_STOP,		/* Machine stops, especially suspend */
6918f88731dSBryan Wu 	CPU_LED_HALTED,		/* Machine shutdown */
6928f88731dSBryan Wu };
6938f88731dSBryan Wu #ifdef CONFIG_LEDS_TRIGGER_CPU
694ec28a8cfSDan Murphy void ledtrig_cpu(enum cpu_led_event evt);
6958f88731dSBryan Wu #else
ledtrig_cpu(enum cpu_led_event evt)6968f88731dSBryan Wu static inline void ledtrig_cpu(enum cpu_led_event evt)
6978f88731dSBryan Wu {
6988f88731dSBryan Wu 	return;
6998f88731dSBryan Wu }
7008f88731dSBryan Wu #endif
7018f88731dSBryan Wu 
7020cb8eb30SHans de Goede #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
703ec28a8cfSDan Murphy void led_classdev_notify_brightness_hw_changed(
704af0bfab9SAbanoub Sameh 	struct led_classdev *led_cdev, unsigned int brightness);
7050cb8eb30SHans de Goede #else
led_classdev_notify_brightness_hw_changed(struct led_classdev * led_cdev,enum led_brightness brightness)7060cb8eb30SHans de Goede static inline void led_classdev_notify_brightness_hw_changed(
7070cb8eb30SHans de Goede 	struct led_classdev *led_cdev, enum led_brightness brightness) { }
7080cb8eb30SHans de Goede #endif
7090cb8eb30SHans de Goede 
7105fd752b6SBaolin Wang /**
7115fd752b6SBaolin Wang  * struct led_pattern - pattern interval settings
7125fd752b6SBaolin Wang  * @delta_t: pattern interval delay, in milliseconds
7135fd752b6SBaolin Wang  * @brightness: pattern interval brightness
7145fd752b6SBaolin Wang  */
7155fd752b6SBaolin Wang struct led_pattern {
7165fd752b6SBaolin Wang 	u32 delta_t;
7175fd752b6SBaolin Wang 	int brightness;
7185fd752b6SBaolin Wang };
7195fd752b6SBaolin Wang 
720faa2541fSTakashi Iwai enum led_audio {
721faa2541fSTakashi Iwai 	LED_AUDIO_MUTE,		/* master mute LED */
722faa2541fSTakashi Iwai 	LED_AUDIO_MICMUTE,	/* mic mute LED */
723faa2541fSTakashi Iwai 	NUM_AUDIO_LEDS
724faa2541fSTakashi Iwai };
725faa2541fSTakashi Iwai 
726faa2541fSTakashi Iwai #if IS_ENABLED(CONFIG_LEDS_TRIGGER_AUDIO)
727faa2541fSTakashi Iwai enum led_brightness ledtrig_audio_get(enum led_audio type);
728faa2541fSTakashi Iwai void ledtrig_audio_set(enum led_audio type, enum led_brightness state);
729faa2541fSTakashi Iwai #else
ledtrig_audio_get(enum led_audio type)730faa2541fSTakashi Iwai static inline enum led_brightness ledtrig_audio_get(enum led_audio type)
731faa2541fSTakashi Iwai {
732faa2541fSTakashi Iwai 	return LED_OFF;
733faa2541fSTakashi Iwai }
ledtrig_audio_set(enum led_audio type,enum led_brightness state)734faa2541fSTakashi Iwai static inline void ledtrig_audio_set(enum led_audio type,
735faa2541fSTakashi Iwai 				     enum led_brightness state)
736faa2541fSTakashi Iwai {
737faa2541fSTakashi Iwai }
738faa2541fSTakashi Iwai #endif
739faa2541fSTakashi Iwai 
740c72a1d60SRichard Purdie #endif		/* __LINUX_LEDS_H_INCLUDED */
741