1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Driver model for leds and led triggers
4 *
5 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
6 * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
7 */
8 #ifndef __LINUX_LEDS_H_INCLUDED
9 #define __LINUX_LEDS_H_INCLUDED
10
11 #include <dt-bindings/leds/common.h>
12 #include <linux/device.h>
13 #include <linux/mutex.h>
14 #include <linux/rwsem.h>
15 #include <linux/spinlock.h>
16 #include <linux/timer.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19
20 struct attribute_group;
21 struct device_node;
22 struct fwnode_handle;
23 struct gpio_desc;
24 struct kernfs_node;
25 struct led_pattern;
26 struct platform_device;
27
28 /*
29 * LED Core
30 */
31
32 /* This is obsolete/useless. We now support variable maximum brightness. */
33 enum led_brightness {
34 LED_OFF = 0,
35 LED_ON = 1,
36 LED_HALF = 127,
37 LED_FULL = 255,
38 };
39
40 enum led_default_state {
41 LEDS_DEFSTATE_OFF = 0,
42 LEDS_DEFSTATE_ON = 1,
43 LEDS_DEFSTATE_KEEP = 2,
44 };
45
46 /**
47 * struct led_lookup_data - represents a single LED lookup entry
48 *
49 * @list: internal list of all LED lookup entries
50 * @provider: name of led_classdev providing the LED
51 * @dev_id: name of the device associated with this LED
52 * @con_id: name of the LED from the device's point of view
53 */
54 struct led_lookup_data {
55 struct list_head list;
56 const char *provider;
57 const char *dev_id;
58 const char *con_id;
59 };
60
61 struct led_init_data {
62 /* device fwnode handle */
63 struct fwnode_handle *fwnode;
64 /*
65 * default <color:function> tuple, for backward compatibility
66 * with in-driver hard-coded LED names used as a fallback when
67 * DT "label" property is absent; it should be set to NULL
68 * in new LED class drivers.
69 */
70 const char *default_label;
71 /*
72 * string to be used for devicename section of LED class device
73 * either for label based LED name composition path or for fwnode
74 * based when devname_mandatory is true
75 */
76 const char *devicename;
77 /*
78 * indicates if LED name should always comprise devicename section;
79 * only LEDs exposed by drivers of hot-pluggable devices should
80 * set it to true
81 */
82 bool devname_mandatory;
83 };
84
85 enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode);
86
87 struct led_hw_trigger_type {
88 int dummy;
89 };
90
91 struct led_classdev {
92 const char *name;
93 unsigned int brightness;
94 unsigned int max_brightness;
95 unsigned int color;
96 int flags;
97
98 /* Lower 16 bits reflect status */
99 #define LED_SUSPENDED BIT(0)
100 #define LED_UNREGISTERING BIT(1)
101 /* Upper 16 bits reflect control information */
102 #define LED_CORE_SUSPENDRESUME BIT(16)
103 #define LED_SYSFS_DISABLE BIT(17)
104 #define LED_DEV_CAP_FLASH BIT(18)
105 #define LED_HW_PLUGGABLE BIT(19)
106 #define LED_PANIC_INDICATOR BIT(20)
107 #define LED_BRIGHT_HW_CHANGED BIT(21)
108 #define LED_RETAIN_AT_SHUTDOWN BIT(22)
109 #define LED_INIT_DEFAULT_TRIGGER BIT(23)
110 #define LED_REJECT_NAME_CONFLICT BIT(24)
111 #define LED_MULTI_COLOR BIT(25)
112
113 /* set_brightness_work / blink_timer flags, atomic, private. */
114 unsigned long work_flags;
115
116 #define LED_BLINK_SW 0
117 #define LED_BLINK_ONESHOT 1
118 #define LED_BLINK_ONESHOT_STOP 2
119 #define LED_BLINK_INVERT 3
120 #define LED_BLINK_BRIGHTNESS_CHANGE 4
121 #define LED_BLINK_DISABLE 5
122 /* Brightness off also disables hw-blinking so it is a separate action */
123 #define LED_SET_BRIGHTNESS_OFF 6
124 #define LED_SET_BRIGHTNESS 7
125 #define LED_SET_BLINK 8
126
127 /* Set LED brightness level
128 * Must not sleep. Use brightness_set_blocking for drivers
129 * that can sleep while setting brightness.
130 */
131 void (*brightness_set)(struct led_classdev *led_cdev,
132 enum led_brightness brightness);
133 /*
134 * Set LED brightness level immediately - it can block the caller for
135 * the time required for accessing a LED device register.
136 */
137 int (*brightness_set_blocking)(struct led_classdev *led_cdev,
138 enum led_brightness brightness);
139 /* Get LED brightness level */
140 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
141
142 /*
143 * Activate hardware accelerated blink, delays are in milliseconds
144 * and if both are zero then a sensible default should be chosen.
145 * The call should adjust the timings in that case and if it can't
146 * match the values specified exactly.
147 * Deactivate blinking again when the brightness is set to LED_OFF
148 * via the brightness_set() callback.
149 * For led_blink_set_nosleep() the LED core assumes that blink_set
150 * implementations, of drivers which do not use brightness_set_blocking,
151 * will not sleep. Therefor if brightness_set_blocking is not set
152 * this function must not sleep!
153 */
154 int (*blink_set)(struct led_classdev *led_cdev,
155 unsigned long *delay_on,
156 unsigned long *delay_off);
157
158 int (*pattern_set)(struct led_classdev *led_cdev,
159 struct led_pattern *pattern, u32 len, int repeat);
160 int (*pattern_clear)(struct led_classdev *led_cdev);
161
162 struct device *dev;
163 const struct attribute_group **groups;
164
165 struct list_head node; /* LED Device list */
166 const char *default_trigger; /* Trigger to use */
167
168 unsigned long blink_delay_on, blink_delay_off;
169 struct timer_list blink_timer;
170 int blink_brightness;
171 int new_blink_brightness;
172 void (*flash_resume)(struct led_classdev *led_cdev);
173
174 struct workqueue_struct *wq; /* LED workqueue */
175 struct work_struct set_brightness_work;
176 int delayed_set_value;
177 unsigned long delayed_delay_on;
178 unsigned long delayed_delay_off;
179
180 #ifdef CONFIG_LEDS_TRIGGERS
181 /* Protects the trigger data below */
182 struct rw_semaphore trigger_lock;
183
184 struct led_trigger *trigger;
185 struct list_head trig_list;
186 void *trigger_data;
187 /* true if activated - deactivate routine uses it to do cleanup */
188 bool activated;
189
190 /* LEDs that have private triggers have this set */
191 struct led_hw_trigger_type *trigger_type;
192
193 /* Unique trigger name supported by LED set in hw control mode */
194 const char *hw_control_trigger;
195 /*
196 * Check if the LED driver supports the requested mode provided by the
197 * defined supported trigger to setup the LED to hw control mode.
198 *
199 * Return 0 on success. Return -EOPNOTSUPP when the passed flags are not
200 * supported and software fallback needs to be used.
201 * Return a negative error number on any other case for check fail due
202 * to various reason like device not ready or timeouts.
203 */
204 int (*hw_control_is_supported)(struct led_classdev *led_cdev,
205 unsigned long flags);
206 /*
207 * Activate hardware control, LED driver will use the provided flags
208 * from the supported trigger and setup the LED to be driven by hardware
209 * following the requested mode from the trigger flags.
210 * Deactivate hardware blink control by setting brightness to LED_OFF via
211 * the brightness_set() callback.
212 *
213 * Return 0 on success, a negative error number on flags apply fail.
214 */
215 int (*hw_control_set)(struct led_classdev *led_cdev,
216 unsigned long flags);
217 /*
218 * Get from the LED driver the current mode that the LED is set in hw
219 * control mode and put them in flags.
220 * Trigger can use this to get the initial state of a LED already set in
221 * hardware blink control.
222 *
223 * Return 0 on success, a negative error number on failing parsing the
224 * initial mode. Error from this function is NOT FATAL as the device
225 * may be in a not supported initial state by the attached LED trigger.
226 */
227 int (*hw_control_get)(struct led_classdev *led_cdev,
228 unsigned long *flags);
229 /*
230 * Get the device this LED blinks in response to.
231 * e.g. for a PHY LED, it is the network device. If the LED is
232 * not yet associated to a device, return NULL.
233 */
234 struct device *(*hw_control_get_device)(struct led_classdev *led_cdev);
235 #endif
236
237 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
238 int brightness_hw_changed;
239 struct kernfs_node *brightness_hw_changed_kn;
240 #endif
241
242 /* Ensures consistent access to the LED class device */
243 struct mutex led_access;
244 };
245
246 /**
247 * led_classdev_register_ext - register a new object of LED class with
248 * init data
249 * @parent: LED controller device this LED is driven by
250 * @led_cdev: the led_classdev structure for this device
251 * @init_data: the LED class device initialization data
252 *
253 * Register a new object of LED class, with name derived from init_data.
254 *
255 * Returns: 0 on success or negative error value on failure
256 */
257 int led_classdev_register_ext(struct device *parent,
258 struct led_classdev *led_cdev,
259 struct led_init_data *init_data);
260
261 /**
262 * led_classdev_register - register a new object of LED class
263 * @parent: LED controller device this LED is driven by
264 * @led_cdev: the led_classdev structure for this device
265 *
266 * Register a new object of LED class, with name derived from the name property
267 * of passed led_cdev argument.
268 *
269 * Returns: 0 on success or negative error value on failure
270 */
led_classdev_register(struct device * parent,struct led_classdev * led_cdev)271 static 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
277 int devm_led_classdev_register_ext(struct device *parent,
278 struct led_classdev *led_cdev,
279 struct led_init_data *init_data);
devm_led_classdev_register(struct device * parent,struct led_classdev * led_cdev)280 static 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 }
285 void led_classdev_unregister(struct led_classdev *led_cdev);
286 void devm_led_classdev_unregister(struct device *parent,
287 struct led_classdev *led_cdev);
288 void led_classdev_suspend(struct led_classdev *led_cdev);
289 void led_classdev_resume(struct led_classdev *led_cdev);
290
291 void led_add_lookup(struct led_lookup_data *led_lookup);
292 void led_remove_lookup(struct led_lookup_data *led_lookup);
293
294 struct led_classdev *__must_check led_get(struct device *dev, char *con_id);
295 struct led_classdev *__must_check devm_led_get(struct device *dev, char *con_id);
296
297 extern struct led_classdev *of_led_get(struct device_node *np, int index);
298 extern void led_put(struct led_classdev *led_cdev);
299 struct led_classdev *__must_check devm_of_led_get(struct device *dev,
300 int index);
301 struct led_classdev *__must_check devm_of_led_get_optional(struct device *dev,
302 int index);
303
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 *
315 * This function may sleep!
316 *
317 * Note that if software blinking is active, simply calling
318 * led_cdev->brightness_set() will not stop the blinking,
319 * use led_set_brightness() instead.
320 */
321 void led_blink_set(struct led_classdev *led_cdev, unsigned long *delay_on,
322 unsigned long *delay_off);
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 */
333 void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
334 unsigned long delay_off);
335
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.
349 *
350 * This function is guaranteed not to sleep.
351 */
352 void led_blink_set_oneshot(struct led_classdev *led_cdev,
353 unsigned long *delay_on, unsigned long *delay_off,
354 int invert);
355 /**
356 * led_set_brightness - set LED brightness
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
362 * hardware doesn't. This function is guaranteed not to sleep.
363 */
364 void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness);
365
366 /**
367 * led_set_brightness_sync - set LED brightness synchronously
368 * @led_cdev: the LED to set
369 * @value: the brightness to set it to
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 */
377 int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value);
378
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 */
394 void led_mc_set_brightness(struct led_classdev *led_cdev,
395 unsigned int *intensity_value, unsigned int num_colors,
396 unsigned int brightness);
397
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 */
407 int led_update_brightness(struct led_classdev *led_cdev);
408
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 */
419 u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size);
420
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 */
427 void led_sysfs_disable(struct led_classdev *led_cdev);
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 */
435 void led_sysfs_enable(struct led_classdev *led_cdev);
436
437 /**
438 * led_compose_name - compose LED class device name
439 * @dev: LED controller device object
440 * @init_data: the LED class device initialization data
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 */
449 int led_compose_name(struct device *dev, struct led_init_data *init_data,
450 char *led_classdev_name);
451
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 */
460 const char *led_get_color_name(u8 color_id);
461
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 */
led_sysfs_is_disabled(struct led_classdev * led_cdev)468 static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
469 {
470 return led_cdev->flags & LED_SYSFS_DISABLE;
471 }
472
473 /*
474 * LED Triggers
475 */
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
480 #ifdef CONFIG_LEDS_TRIGGERS
481
482 #define TRIG_NAME_MAX 50
483
484 struct led_trigger {
485 /* Trigger Properties */
486 const char *name;
487 int (*activate)(struct led_classdev *led_cdev);
488 void (*deactivate)(struct led_classdev *led_cdev);
489
490 /* Brightness set by led_trigger_event */
491 enum led_brightness brightness;
492
493 /* LED-private triggers have this set */
494 struct led_hw_trigger_type *trigger_type;
495
496 /* LEDs under control by this trigger (for simple triggers) */
497 spinlock_t leddev_list_lock;
498 struct list_head led_cdevs;
499
500 /* Link to next registered trigger */
501 struct list_head next_trig;
502
503 const struct attribute_group **groups;
504 };
505
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
515 /* Registration functions for complex triggers */
516 int led_trigger_register(struct led_trigger *trigger);
517 void led_trigger_unregister(struct led_trigger *trigger);
518 int devm_led_trigger_register(struct device *dev,
519 struct led_trigger *trigger);
520
521 void led_trigger_register_simple(const char *name,
522 struct led_trigger **trigger);
523 void led_trigger_unregister_simple(struct led_trigger *trigger);
524 void led_trigger_event(struct led_trigger *trigger, enum led_brightness event);
525 void led_mc_trigger_event(struct led_trigger *trig,
526 unsigned int *intensity_value, unsigned int num_colors,
527 enum led_brightness brightness);
528 void led_trigger_blink(struct led_trigger *trigger, unsigned long delay_on,
529 unsigned long delay_off);
530 void led_trigger_blink_oneshot(struct led_trigger *trigger,
531 unsigned long delay_on,
532 unsigned long delay_off,
533 int invert);
534 void led_trigger_set_default(struct led_classdev *led_cdev);
535 int led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger);
536 void led_trigger_remove(struct led_classdev *led_cdev);
537
led_set_trigger_data(struct led_classdev * led_cdev,void * trigger_data)538 static 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
led_get_trigger_data(struct led_classdev * led_cdev)544 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
545 {
546 return led_cdev->trigger_data;
547 }
548
549 static inline enum led_brightness
led_trigger_get_brightness(const struct led_trigger * trigger)550 led_trigger_get_brightness(const struct led_trigger *trigger)
551 {
552 return trigger ? trigger->brightness : LED_OFF;
553 }
554
555 #define module_led_trigger(__led_trigger) \
556 module_driver(__led_trigger, led_trigger_register, \
557 led_trigger_unregister)
558
559 #else
560
561 /* Trigger has no members */
562 struct led_trigger {};
563
564 /* Trigger inline empty functions */
led_trigger_register_simple(const char * name,struct led_trigger ** trigger)565 static inline void led_trigger_register_simple(const char *name,
566 struct led_trigger **trigger) {}
led_trigger_unregister_simple(struct led_trigger * trigger)567 static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
led_trigger_event(struct led_trigger * trigger,enum led_brightness event)568 static inline void led_trigger_event(struct led_trigger *trigger,
569 enum led_brightness event) {}
led_mc_trigger_event(struct led_trigger * trig,unsigned int * intensity_value,unsigned int num_colors,enum led_brightness brightness)570 static inline void led_mc_trigger_event(struct led_trigger *trig,
571 unsigned int *intensity_value, unsigned int num_colors,
572 enum led_brightness brightness) {}
led_trigger_blink(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off)573 static inline void led_trigger_blink(struct led_trigger *trigger,
574 unsigned long delay_on,
575 unsigned long delay_off) {}
led_trigger_blink_oneshot(struct led_trigger * trigger,unsigned long delay_on,unsigned long delay_off,int invert)576 static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
577 unsigned long delay_on,
578 unsigned long delay_off,
579 int invert) {}
led_trigger_set_default(struct led_classdev * led_cdev)580 static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
led_trigger_set(struct led_classdev * led_cdev,struct led_trigger * trigger)581 static inline int led_trigger_set(struct led_classdev *led_cdev,
582 struct led_trigger *trigger)
583 {
584 return 0;
585 }
586
led_trigger_remove(struct led_classdev * led_cdev)587 static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
led_set_trigger_data(struct led_classdev * led_cdev)588 static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
led_get_trigger_data(struct led_classdev * led_cdev)589 static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
590 {
591 return NULL;
592 }
593
594 static inline enum led_brightness
led_trigger_get_brightness(const struct led_trigger * trigger)595 led_trigger_get_brightness(const struct led_trigger *trigger)
596 {
597 return LED_OFF;
598 }
599
600 #endif /* CONFIG_LEDS_TRIGGERS */
601
602 /* Trigger specific enum */
603 enum led_trigger_netdev_modes {
604 TRIGGER_NETDEV_LINK = 0,
605 TRIGGER_NETDEV_LINK_10,
606 TRIGGER_NETDEV_LINK_100,
607 TRIGGER_NETDEV_LINK_1000,
608 TRIGGER_NETDEV_LINK_2500,
609 TRIGGER_NETDEV_LINK_5000,
610 TRIGGER_NETDEV_LINK_10000,
611 TRIGGER_NETDEV_HALF_DUPLEX,
612 TRIGGER_NETDEV_FULL_DUPLEX,
613 TRIGGER_NETDEV_TX,
614 TRIGGER_NETDEV_RX,
615 TRIGGER_NETDEV_TX_ERR,
616 TRIGGER_NETDEV_RX_ERR,
617
618 /* Keep last */
619 __TRIGGER_NETDEV_MAX,
620 };
621
622 /* Trigger specific functions */
623 #ifdef CONFIG_LEDS_TRIGGER_DISK
624 void ledtrig_disk_activity(bool write);
625 #else
ledtrig_disk_activity(bool write)626 static inline void ledtrig_disk_activity(bool write) {}
627 #endif
628
629 #ifdef CONFIG_LEDS_TRIGGER_MTD
630 void ledtrig_mtd_activity(void);
631 #else
ledtrig_mtd_activity(void)632 static inline void ledtrig_mtd_activity(void) {}
633 #endif
634
635 #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
636 void ledtrig_flash_ctrl(bool on);
637 void ledtrig_torch_ctrl(bool on);
638 #else
ledtrig_flash_ctrl(bool on)639 static inline void ledtrig_flash_ctrl(bool on) {}
ledtrig_torch_ctrl(bool on)640 static inline void ledtrig_torch_ctrl(bool on) {}
641 #endif
642
643 /*
644 * Generic LED platform data for describing LED names and default triggers.
645 */
646 struct led_info {
647 const char *name;
648 const char *default_trigger;
649 int flags;
650 };
651
652 struct led_platform_data {
653 int num_leds;
654 struct led_info *leds;
655 };
656
657 struct led_properties {
658 u32 color;
659 bool color_present;
660 const char *function;
661 u32 func_enum;
662 bool func_enum_present;
663 const char *label;
664 };
665
666 typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
667 unsigned long *delay_on,
668 unsigned long *delay_off);
669
670 /* For the leds-gpio driver */
671 struct gpio_led {
672 const char *name;
673 const char *default_trigger;
674 unsigned gpio;
675 unsigned active_low : 1;
676 unsigned retain_state_suspended : 1;
677 unsigned panic_indicator : 1;
678 unsigned default_state : 2;
679 unsigned retain_state_shutdown : 1;
680 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
681 struct gpio_desc *gpiod;
682 };
683 #define LEDS_GPIO_DEFSTATE_OFF LEDS_DEFSTATE_OFF
684 #define LEDS_GPIO_DEFSTATE_ON LEDS_DEFSTATE_ON
685 #define LEDS_GPIO_DEFSTATE_KEEP LEDS_DEFSTATE_KEEP
686
687 struct gpio_led_platform_data {
688 int num_leds;
689 const struct gpio_led *leds;
690
691 #define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
692 #define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
693 #define GPIO_LED_BLINK 2 /* Please, blink */
694 gpio_blink_set_t gpio_blink_set;
695 };
696
697 #ifdef CONFIG_LEDS_GPIO_REGISTER
698 struct platform_device *gpio_led_register_device(
699 int id, const struct gpio_led_platform_data *pdata);
700 #else
gpio_led_register_device(int id,const struct gpio_led_platform_data * pdata)701 static inline struct platform_device *gpio_led_register_device(
702 int id, const struct gpio_led_platform_data *pdata)
703 {
704 return 0;
705 }
706 #endif
707
708 enum cpu_led_event {
709 CPU_LED_IDLE_START, /* CPU enters idle */
710 CPU_LED_IDLE_END, /* CPU idle ends */
711 CPU_LED_START, /* Machine starts, especially resume */
712 CPU_LED_STOP, /* Machine stops, especially suspend */
713 CPU_LED_HALTED, /* Machine shutdown */
714 };
715 #ifdef CONFIG_LEDS_TRIGGER_CPU
716 void ledtrig_cpu(enum cpu_led_event evt);
717 #else
ledtrig_cpu(enum cpu_led_event evt)718 static inline void ledtrig_cpu(enum cpu_led_event evt)
719 {
720 return;
721 }
722 #endif
723
724 #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
725 void led_classdev_notify_brightness_hw_changed(
726 struct led_classdev *led_cdev, unsigned int brightness);
727 #else
led_classdev_notify_brightness_hw_changed(struct led_classdev * led_cdev,enum led_brightness brightness)728 static inline void led_classdev_notify_brightness_hw_changed(
729 struct led_classdev *led_cdev, enum led_brightness brightness) { }
730 #endif
731
732 /**
733 * struct led_pattern - pattern interval settings
734 * @delta_t: pattern interval delay, in milliseconds
735 * @brightness: pattern interval brightness
736 */
737 struct led_pattern {
738 u32 delta_t;
739 int brightness;
740 };
741
742 enum led_audio {
743 LED_AUDIO_MUTE, /* master mute LED */
744 LED_AUDIO_MICMUTE, /* mic mute LED */
745 NUM_AUDIO_LEDS
746 };
747
748 #endif /* __LINUX_LEDS_H_INCLUDED */
749