Merge tag 'pci-v6.16-fixes-3' of git://git.kernel.org/pub/scm/linux/kernel/git/pci/pci
[linux-2.6-block.git] / include / linux / leds.h
CommitLineData
d2912cb1 1/* SPDX-License-Identifier: GPL-2.0-only */
c72a1d60
RP
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>
c72a1d60
RP
7 */
8#ifndef __LINUX_LEDS_H_INCLUDED
9#define __LINUX_LEDS_H_INCLUDED
10
bb4e9af0 11#include <dt-bindings/leds/common.h>
20f56758 12#include <linux/device.h>
acd899e4 13#include <linux/mutex.h>
dc47206e 14#include <linux/rwsem.h>
04713306 15#include <linux/spinlock.h>
9067359f 16#include <linux/timer.h>
d35d0c9d 17#include <linux/types.h>
d23a22a7 18#include <linux/workqueue.h>
af410fc1 19
d35d0c9d 20struct attribute_group;
699a8c7c 21struct device_node;
d35d0c9d
AS
22struct fwnode_handle;
23struct gpio_desc;
24struct kernfs_node;
25struct led_pattern;
26struct platform_device;
27
c72a1d60
RP
28/*
29 * LED Core
30 */
31
c7e4ea68 32/* This is obsolete/useless. We now support variable maximum brightness. */
c72a1d60 33enum led_brightness {
fb5035db 34 LED_OFF = 0,
4e552c8c 35 LED_ON = 1,
fb5035db
BD
36 LED_HALF = 127,
37 LED_FULL = 255,
c72a1d60
RP
38};
39
791bc411
DOH
40enum led_default_state {
41 LEDS_DEFSTATE_OFF = 0,
42 LEDS_DEFSTATE_ON = 1,
43 LEDS_DEFSTATE_KEEP = 2,
44};
45
abc3100f
HG
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
b2b998c0
JA
61struct led_init_data {
62 /* device fwnode handle */
63 struct fwnode_handle *fwnode;
bb4e9af0
JA
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;
b2b998c0
JA
83};
84
156a5bb8
AS
85enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode);
86
93690cdf
MB
87struct led_hw_trigger_type {
88 int dummy;
89};
90
c72a1d60 91struct led_classdev {
fb5035db 92 const char *name;
af0bfab9
AS
93 unsigned int brightness;
94 unsigned int max_brightness;
c7d80059 95 unsigned int color;
fb5035db 96 int flags;
c72a1d60 97
859cb7f2 98 /* Lower 16 bits reflect status */
55edd1da
DL
99#define LED_SUSPENDED BIT(0)
100#define LED_UNREGISTERING BIT(1)
859cb7f2 101 /* Upper 16 bits reflect control information */
55edd1da
DL
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)
02d31765 109#define LED_INIT_DEFAULT_TRIGGER BIT(23)
6b0d3355 110#define LED_REJECT_NAME_CONFLICT BIT(24)
59561ccd 111#define LED_MULTI_COLOR BIT(25)
a9c6ce57
HG
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
fa15d8c6
HG
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
22720a87 125#define LED_SET_BLINK 8
c72a1d60 126
70b2563b
HK
127 /* Set LED brightness level
128 * Must not sleep. Use brightness_set_blocking for drivers
129 * that can sleep while setting brightness.
130 */
fb5035db
BD
131 void (*brightness_set)(struct led_classdev *led_cdev,
132 enum led_brightness brightness);
4d71a4a1
JA
133 /*
134 * Set LED brightness level immediately - it can block the caller for
135 * the time required for accessing a LED device register.
136 */
437a4240
JA
137 int (*brightness_set_blocking)(struct led_classdev *led_cdev,
138 enum led_brightness brightness);
29d76dfa
HMH
139 /* Get LED brightness level */
140 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
fb5035db 141
5ada28bf
JB
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.
7cfe749f
TM
147 * Deactivate blinking again when the brightness is set to LED_OFF
148 * via the brightness_set() callback.
22720a87
HG
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!
5ada28bf 153 */
4c79141d
MN
154 int (*blink_set)(struct led_classdev *led_cdev,
155 unsigned long *delay_on,
156 unsigned long *delay_off);
157
5fd752b6
BW
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
f8a7c6fe 162 struct device *dev;
d0d480cc
JH
163 const struct attribute_group **groups;
164
fb5035db 165 struct list_head node; /* LED Device list */
781a54e7 166 const char *default_trigger; /* Trigger to use */
c72a1d60 167
5ada28bf 168 unsigned long blink_delay_on, blink_delay_off;
9067359f 169 struct timer_list blink_timer;
5ada28bf 170 int blink_brightness;
eb1610b4 171 int new_blink_brightness;
7aea8389 172 void (*flash_resume)(struct led_classdev *led_cdev);
5ada28bf 173
32360bf6 174 struct workqueue_struct *wq; /* LED workqueue */
d23a22a7
FB
175 struct work_struct set_brightness_work;
176 int delayed_set_value;
22720a87
HG
177 unsigned long delayed_delay_on;
178 unsigned long delayed_delay_off;
d23a22a7 179
c3bc9956 180#ifdef CONFIG_LEDS_TRIGGERS
c3bc9956 181 /* Protects the trigger data below */
dc47206e 182 struct rw_semaphore trigger_lock;
c3bc9956 183
fb5035db
BD
184 struct led_trigger *trigger;
185 struct list_head trig_list;
186 void *trigger_data;
b0096182
SK
187 /* true if activated - deactivate routine uses it to do cleanup */
188 bool activated;
93690cdf
MB
189
190 /* LEDs that have private triggers have this set */
191 struct led_hw_trigger_type *trigger_type;
ed554d3f
CM
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);
052c38eb
AL
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);
c3bc9956 235#endif
acd899e4 236
0cb8eb30
HG
237#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
238 int brightness_hw_changed;
239 struct kernfs_node *brightness_hw_changed_kn;
240#endif
241
4ca7cd93 242 /* Ensures consistent access to the LED class device */
acd899e4 243 struct mutex led_access;
c72a1d60
RP
244};
245
b2b998c0
JA
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 *
7c322056
JA
253 * Register a new object of LED class, with name derived from init_data.
254 *
b2b998c0
JA
255 * Returns: 0 on success or negative error value on failure
256 */
ec28a8cf 257int led_classdev_register_ext(struct device *parent,
b2b998c0
JA
258 struct led_classdev *led_cdev,
259 struct led_init_data *init_data);
7c322056
JA
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
ec28a8cf 277int devm_led_classdev_register_ext(struct device *parent,
b2b998c0
JA
278 struct led_classdev *led_cdev,
279 struct led_init_data *init_data);
7c322056
JA
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}
ec28a8cf
DM
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);
c72a1d60 290
abc3100f
HG
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
699a8c7c
TV
297extern struct led_classdev *of_led_get(struct device_node *np, int index);
298extern void led_put(struct led_classdev *led_cdev);
e389240a
JJH
299struct led_classdev *__must_check devm_of_led_get(struct device *dev,
300 int index);
afb48153
JJH
301struct led_classdev *__must_check devm_of_led_get_optional(struct device *dev,
302 int index);
699a8c7c 303
5ada28bf
JB
304/**
305 * led_blink_set - set blinking with software fallback
306 * @led_cdev: the LED to start blinking
307 * @delay_on: the time it should be on (in ms)
308 * @delay_off: the time it should ble off (in ms)
309 *
310 * This function makes the LED blink, attempting to use the
311 * hardware acceleration if possible, but falling back to
312 * software blinking if there is no hardware blinking or if
313 * the LED refuses the passed values.
314 *
22720a87
HG
315 * This function may sleep!
316 *
5ada28bf
JB
317 * Note that if software blinking is active, simply calling
318 * led_cdev->brightness_set() will not stop the blinking,
8af70e20 319 * use led_set_brightness() instead.
5ada28bf 320 */
ec28a8cf
DM
321void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
322 unsigned long *delay_off);
22720a87
HG
323
324/**
325 * led_blink_set_nosleep - set blinking, guaranteed to not sleep
326 * @led_cdev: the LED to start blinking
327 * @delay_on: the time it should be on (in ms)
328 * @delay_off: the time it should ble off (in ms)
329 *
330 * This function makes the LED blink and is guaranteed to not sleep. Otherwise
331 * this is the same as led_blink_set(), see led_blink_set() for details.
332 */
333void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
334 unsigned long delay_off);
335
5bb629c5
FB
336/**
337 * led_blink_set_oneshot - do a oneshot software blink
338 * @led_cdev: the LED to start blinking
339 * @delay_on: the time it should be on (in ms)
340 * @delay_off: the time it should ble off (in ms)
341 * @invert: blink off, then on, leaving the led on
342 *
343 * This function makes the LED blink one time for delay_on +
344 * delay_off time, ignoring the request if another one-shot
345 * blink is already in progress.
346 *
347 * If invert is set, led blinks for delay_off first, then for
348 * delay_on and leave the led on after the on-off cycle.
22720a87
HG
349 *
350 * This function is guaranteed not to sleep.
5bb629c5 351 */
ec28a8cf
DM
352void led_blink_set_oneshot(struct led_classdev *led_cdev,
353 unsigned long *delay_on, unsigned long *delay_off,
354 int invert);
5ada28bf 355/**
19cd67e2 356 * led_set_brightness - set LED brightness
5ada28bf
JB
357 * @led_cdev: the LED to set
358 * @brightness: the brightness to set it to
359 *
360 * Set an LED's brightness, and, if necessary, cancel the
361 * software blink timer that implements blinking when the
1afcadfc 362 * hardware doesn't. This function is guaranteed not to sleep.
5ada28bf 363 */
af0bfab9 364void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness);
13ae79bb
JA
365
366/**
367 * led_set_brightness_sync - set LED brightness synchronously
368 * @led_cdev: the LED to set
9cc93be7 369 * @value: the brightness to set it to
13ae79bb
JA
370 *
371 * Set an LED's brightness immediately. This function will block
372 * the caller for the time required for accessing device registers,
373 * and it can sleep.
374 *
375 * Returns: 0 on success or negative error value on failure
376 */
af0bfab9 377int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value);
13ae79bb 378
5607ca92
HG
379/**
380 * led_mc_set_brightness - set mc LED color intensity values and brightness
381 * @led_cdev: the LED to set
382 * @intensity_value: array of per color intensity values to set
383 * @num_colors: amount of entries in intensity_value array
384 * @brightness: the brightness to set the LED to
385 *
386 * Set a multi-color LED's per color intensity values and brightness.
387 * If necessary, this cancels the software blink timer. This function is
388 * guaranteed not to sleep.
389 *
390 * Calling this function on a non multi-color led_classdev or with the wrong
391 * num_colors value is an error. In this case an error will be logged once
392 * and the call will do nothing.
393 */
394void led_mc_set_brightness(struct led_classdev *led_cdev,
395 unsigned int *intensity_value, unsigned int num_colors,
396 unsigned int brightness);
397
3ef7de53
JA
398/**
399 * led_update_brightness - update LED brightness
400 * @led_cdev: the LED to query
401 *
402 * Get an LED's current brightness and update led_cdev->brightness
403 * member with the obtained value.
404 *
405 * Returns: 0 on success or negative error value on failure
406 */
ec28a8cf 407int led_update_brightness(struct led_classdev *led_cdev);
5ada28bf 408
8e1f4561
KK
409/**
410 * led_get_default_pattern - return default pattern
411 *
412 * @led_cdev: the LED to get default pattern for
413 * @size: pointer for storing the number of elements in returned array,
414 * modified only if return != NULL
415 *
416 * Return: Allocated array of integers with default pattern from device tree
417 * or NULL. Caller is responsible for kfree().
418 */
ec28a8cf 419u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
8e1f4561 420
acd899e4
JA
421/**
422 * led_sysfs_disable - disable LED sysfs interface
423 * @led_cdev: the LED to set
424 *
425 * Disable the led_cdev's sysfs interface.
426 */
ec28a8cf 427void led_sysfs_disable(struct led_classdev *led_cdev);
acd899e4
JA
428
429/**
430 * led_sysfs_enable - enable LED sysfs interface
431 * @led_cdev: the LED to set
432 *
433 * Enable the led_cdev's sysfs interface.
434 */
ec28a8cf 435void led_sysfs_enable(struct led_classdev *led_cdev);
acd899e4 436
bb4e9af0
JA
437/**
438 * led_compose_name - compose LED class device name
439 * @dev: LED controller device object
9cc93be7 440 * @init_data: the LED class device initialization data
bb4e9af0
JA
441 * @led_classdev_name: composed LED class device name
442 *
443 * Create LED class device name basing on the provided init_data argument.
444 * The name can have <devicename:color:function> or <color:function>.
445 * form, depending on the init_data configuration.
446 *
447 * Returns: 0 on success or negative error value on failure
448 */
ec28a8cf
DM
449int led_compose_name(struct device *dev, struct led_init_data *init_data,
450 char *led_classdev_name);
bb4e9af0 451
5f2e9507
TW
452/**
453 * led_get_color_name - get string representation of color ID
454 * @color_id: The LED_COLOR_ID_* constant
455 *
456 * Get the string name of a LED_COLOR_ID_* constant.
457 *
458 * Returns: A string constant or NULL on an invalid ID.
459 */
460const char *led_get_color_name(u8 color_id);
461
acd899e4
JA
462/**
463 * led_sysfs_is_disabled - check if LED sysfs interface is disabled
464 * @led_cdev: the LED to query
465 *
466 * Returns: true if the led_cdev's sysfs interface is disabled.
467 */
468static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
469{
470 return led_cdev->flags & LED_SYSFS_DISABLE;
471}
472
c3bc9956
RP
473/*
474 * LED Triggers
475 */
39f7e08a
KM
476/* Registration functions for simple triggers */
477#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
478#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
479
c3bc9956
RP
480#ifdef CONFIG_LEDS_TRIGGERS
481
482#define TRIG_NAME_MAX 50
483
484struct led_trigger {
485 /* Trigger Properties */
fb5035db 486 const char *name;
2282e125 487 int (*activate)(struct led_classdev *led_cdev);
fb5035db 488 void (*deactivate)(struct led_classdev *led_cdev);
c3bc9956 489
822c91e7
HK
490 /* Brightness set by led_trigger_event */
491 enum led_brightness brightness;
492
93690cdf
MB
493 /* LED-private triggers have this set */
494 struct led_hw_trigger_type *trigger_type;
495
c3bc9956 496 /* LEDs under control by this trigger (for simple triggers) */
2a5a8fa8 497 spinlock_t leddev_list_lock;
fb5035db 498 struct list_head led_cdevs;
c3bc9956
RP
499
500 /* Link to next registered trigger */
fb5035db 501 struct list_head next_trig;
a7e7a315
UKK
502
503 const struct attribute_group **groups;
c3bc9956
RP
504};
505
a7e7a315
UKK
506/*
507 * Currently the attributes in struct led_trigger::groups are added directly to
508 * the LED device. As this might change in the future, the following
509 * macros abstract getting the LED device and its trigger_data from the dev
510 * parameter passed to the attribute accessor functions.
511 */
512#define led_trigger_get_led(dev) ((struct led_classdev *)dev_get_drvdata((dev)))
513#define led_trigger_get_drvdata(dev) (led_get_trigger_data(led_trigger_get_led(dev)))
514
c3bc9956 515/* Registration functions for complex triggers */
ec28a8cf
DM
516int led_trigger_register(struct led_trigger *trigger);
517void led_trigger_unregister(struct led_trigger *trigger);
518int devm_led_trigger_register(struct device *dev,
9534cc31 519 struct led_trigger *trigger);
c3bc9956 520
ec28a8cf 521void led_trigger_register_simple(const char *name,
c3bc9956 522 struct led_trigger **trigger);
ec28a8cf
DM
523void led_trigger_unregister_simple(struct led_trigger *trigger);
524void led_trigger_event(struct led_trigger *trigger, enum led_brightness event);
0921a57c
HG
525void led_mc_trigger_event(struct led_trigger *trig,
526 unsigned int *intensity_value, unsigned int num_colors,
527 enum led_brightness brightness);
e298d8a3
HG
528void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
529 unsigned long delay_off);
ec28a8cf 530void led_trigger_blink_oneshot(struct led_trigger *trigger,
e298d8a3
HG
531 unsigned long delay_on,
532 unsigned long delay_off,
ec28a8cf
DM
533 int invert);
534void led_trigger_set_default(struct led_classdev *led_cdev);
535int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
536void led_trigger_remove(struct led_classdev *led_cdev);
20f56758 537
9acc560d
UKK
538static inline void led_set_trigger_data(struct led_classdev *led_cdev,
539 void *trigger_data)
540{
541 led_cdev->trigger_data = trigger_data;
542}
543
20f56758
JA
544static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
545{
546 return led_cdev->trigger_data;
547}
548
822c91e7
HK
549static inline enum led_brightness
550led_trigger_get_brightness(const struct led_trigger *trigger)
551{
552 return trigger ? trigger->brightness : LED_OFF;
553}
554
a0b75076
UKK
555#define module_led_trigger(__led_trigger) \
556 module_driver(__led_trigger, led_trigger_register, \
557 led_trigger_unregister)
558
c3bc9956
RP
559#else
560
39f7e08a
KM
561/* Trigger has no members */
562struct led_trigger {};
c3bc9956 563
39f7e08a
KM
564/* Trigger inline empty functions */
565static inline void led_trigger_register_simple(const char *name,
566 struct led_trigger **trigger) {}
567static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
568static inline void led_trigger_event(struct led_trigger *trigger,
569 enum led_brightness event) {}
0921a57c
HG
570static inline void led_mc_trigger_event(struct led_trigger *trig,
571 unsigned int *intensity_value, unsigned int num_colors,
572 enum led_brightness brightness) {}
8890624a 573static inline void led_trigger_blink(struct led_trigger *trigger,
e298d8a3
HG
574 unsigned long delay_on,
575 unsigned long delay_off) {}
8890624a 576static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
e298d8a3
HG
577 unsigned long delay_on,
578 unsigned long delay_off,
8890624a 579 int invert) {}
20f56758 580static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
2282e125
UKK
581static inline int led_trigger_set(struct led_classdev *led_cdev,
582 struct led_trigger *trigger)
583{
584 return 0;
585}
586
20f56758 587static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
9acc560d 588static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
20f56758
JA
589static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
590{
591 return NULL;
592}
593
822c91e7
HK
594static inline enum led_brightness
595led_trigger_get_brightness(const struct led_trigger *trigger)
596{
597 return LED_OFF;
598}
599
39f7e08a 600#endif /* CONFIG_LEDS_TRIGGERS */
2bfb646c 601
947acaca
CM
602/* Trigger specific enum */
603enum led_trigger_netdev_modes {
604 TRIGGER_NETDEV_LINK = 0,
d5e01266
CM
605 TRIGGER_NETDEV_LINK_10,
606 TRIGGER_NETDEV_LINK_100,
607 TRIGGER_NETDEV_LINK_1000,
59b3e31e
DG
608 TRIGGER_NETDEV_LINK_2500,
609 TRIGGER_NETDEV_LINK_5000,
610 TRIGGER_NETDEV_LINK_10000,
f22f95b9
CM
611 TRIGGER_NETDEV_HALF_DUPLEX,
612 TRIGGER_NETDEV_FULL_DUPLEX,
947acaca
CM
613 TRIGGER_NETDEV_TX,
614 TRIGGER_NETDEV_RX,
6b08d07c
LM
615 TRIGGER_NETDEV_TX_ERR,
616 TRIGGER_NETDEV_RX_ERR,
947acaca
CM
617
618 /* Keep last */
619 __TRIGGER_NETDEV_MAX,
620};
621
2bfb646c 622/* Trigger specific functions */
eb25cb99 623#ifdef CONFIG_LEDS_TRIGGER_DISK
ec28a8cf 624void ledtrig_disk_activity(bool write);
2bfb646c 625#else
d1ed7c55 626static inline void ledtrig_disk_activity(bool write) {}
2bfb646c
RP
627#endif
628
4b721174 629#ifdef CONFIG_LEDS_TRIGGER_MTD
ec28a8cf 630void ledtrig_mtd_activity(void);
4b721174
EG
631#else
632static inline void ledtrig_mtd_activity(void) {}
633#endif
634
48a1d032 635#if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
ec28a8cf
DM
636void ledtrig_flash_ctrl(bool on);
637void ledtrig_torch_ctrl(bool on);
48a1d032
KM
638#else
639static inline void ledtrig_flash_ctrl(bool on) {}
640static inline void ledtrig_torch_ctrl(bool on) {}
641#endif
642
dc2139c0
TZ
643#if IS_REACHABLE(CONFIG_LEDS_TRIGGER_BACKLIGHT)
644void ledtrig_backlight_blank(bool blank);
645#else
646static inline void ledtrig_backlight_blank(bool blank) {}
647#endif
648
f46e9203
NC
649/*
650 * Generic LED platform data for describing LED names and default triggers.
651 */
652struct led_info {
653 const char *name;
326bb8a5 654 const char *default_trigger;
f46e9203
NC
655 int flags;
656};
657
658struct led_platform_data {
659 int num_leds;
660 struct led_info *leds;
661};
662
bb4e9af0
JA
663struct led_properties {
664 u32 color;
665 bool color_present;
666 const char *function;
667 u32 func_enum;
668 bool func_enum_present;
669 const char *label;
670};
671
68620e59
HK
672typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
673 unsigned long *delay_on,
674 unsigned long *delay_off);
675
22e03f3b
RA
676/* For the leds-gpio driver */
677struct gpio_led {
678 const char *name;
326bb8a5 679 const char *default_trigger;
22e03f3b 680 unsigned gpio;
ed88bae6
TP
681 unsigned active_low : 1;
682 unsigned retain_state_suspended : 1;
80d6737b 683 unsigned panic_indicator : 1;
ed88bae6 684 unsigned default_state : 2;
f5808ac1 685 unsigned retain_state_shutdown : 1;
ed88bae6 686 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
5c51277a 687 struct gpio_desc *gpiod;
22e03f3b 688};
791bc411
DOH
689#define LEDS_GPIO_DEFSTATE_OFF LEDS_DEFSTATE_OFF
690#define LEDS_GPIO_DEFSTATE_ON LEDS_DEFSTATE_ON
691#define LEDS_GPIO_DEFSTATE_KEEP LEDS_DEFSTATE_KEEP
22e03f3b
RA
692
693struct gpio_led_platform_data {
694 int num_leds;
9517f925 695 const struct gpio_led *leds;
2146325d
BH
696
697#define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
698#define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
9517f925 699#define GPIO_LED_BLINK 2 /* Please, blink */
68620e59 700 gpio_blink_set_t gpio_blink_set;
22e03f3b
RA
701};
702
08b7dab9 703#ifdef CONFIG_LEDS_GPIO_REGISTER
4440673a
UKK
704struct platform_device *gpio_led_register_device(
705 int id, const struct gpio_led_platform_data *pdata);
fca23e47
AD
706#else
707static inline struct platform_device *gpio_led_register_device(
708 int id, const struct gpio_led_platform_data *pdata)
709{
710 return 0;
711}
712#endif
22e03f3b 713
8f88731d
BW
714enum cpu_led_event {
715 CPU_LED_IDLE_START, /* CPU enters idle */
716 CPU_LED_IDLE_END, /* CPU idle ends */
717 CPU_LED_START, /* Machine starts, especially resume */
718 CPU_LED_STOP, /* Machine stops, especially suspend */
719 CPU_LED_HALTED, /* Machine shutdown */
720};
721#ifdef CONFIG_LEDS_TRIGGER_CPU
ec28a8cf 722void ledtrig_cpu(enum cpu_led_event evt);
8f88731d
BW
723#else
724static inline void ledtrig_cpu(enum cpu_led_event evt)
725{
726 return;
727}
728#endif
729
0cb8eb30 730#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
ec28a8cf 731void led_classdev_notify_brightness_hw_changed(
af0bfab9 732 struct led_classdev *led_cdev, unsigned int brightness);
0cb8eb30
HG
733#else
734static inline void led_classdev_notify_brightness_hw_changed(
735 struct led_classdev *led_cdev, enum led_brightness brightness) { }
736#endif
737
5fd752b6
BW
738/**
739 * struct led_pattern - pattern interval settings
740 * @delta_t: pattern interval delay, in milliseconds
741 * @brightness: pattern interval brightness
742 */
743struct led_pattern {
744 u32 delta_t;
745 int brightness;
746};
747
faa2541f
TI
748enum led_audio {
749 LED_AUDIO_MUTE, /* master mute LED */
750 LED_AUDIO_MICMUTE, /* mic mute LED */
751 NUM_AUDIO_LEDS
752};
753
c72a1d60 754#endif /* __LINUX_LEDS_H_INCLUDED */