1
2
3
4
5
6
7
8#ifndef __LINUX_LEDS_H_INCLUDED
9#define __LINUX_LEDS_H_INCLUDED
10
11#include <linux/device.h>
12#include <linux/kernfs.h>
13#include <linux/list.h>
14#include <linux/mutex.h>
15#include <linux/rwsem.h>
16#include <linux/spinlock.h>
17#include <linux/timer.h>
18#include <linux/workqueue.h>
19
20struct device;
21struct led_pattern;
22
23
24
25
26enum led_brightness {
27 LED_OFF = 0,
28 LED_ON = 1,
29 LED_HALF = 127,
30 LED_FULL = 255,
31};
32
33struct led_classdev {
34 const char *name;
35 enum led_brightness brightness;
36 enum led_brightness max_brightness;
37 int flags;
38
39
40#define LED_SUSPENDED BIT(0)
41#define LED_UNREGISTERING BIT(1)
42
43#define LED_CORE_SUSPENDRESUME BIT(16)
44#define LED_SYSFS_DISABLE BIT(17)
45#define LED_DEV_CAP_FLASH BIT(18)
46#define LED_HW_PLUGGABLE BIT(19)
47#define LED_PANIC_INDICATOR BIT(20)
48#define LED_BRIGHT_HW_CHANGED BIT(21)
49#define LED_RETAIN_AT_SHUTDOWN BIT(22)
50#define LED_INIT_DEFAULT_TRIGGER BIT(23)
51
52
53 unsigned long work_flags;
54
55#define LED_BLINK_SW 0
56#define LED_BLINK_ONESHOT 1
57#define LED_BLINK_ONESHOT_STOP 2
58#define LED_BLINK_INVERT 3
59#define LED_BLINK_BRIGHTNESS_CHANGE 4
60#define LED_BLINK_DISABLE 5
61
62
63
64
65
66 void (*brightness_set)(struct led_classdev *led_cdev,
67 enum led_brightness brightness);
68
69
70
71
72 int (*brightness_set_blocking)(struct led_classdev *led_cdev,
73 enum led_brightness brightness);
74
75 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
76
77
78
79
80
81
82
83
84
85 int (*blink_set)(struct led_classdev *led_cdev,
86 unsigned long *delay_on,
87 unsigned long *delay_off);
88
89 int (*pattern_set)(struct led_classdev *led_cdev,
90 struct led_pattern *pattern, u32 len, int repeat);
91 int (*pattern_clear)(struct led_classdev *led_cdev);
92
93 struct device *dev;
94 const struct attribute_group **groups;
95
96 struct list_head node;
97 const char *default_trigger;
98
99 unsigned long blink_delay_on, blink_delay_off;
100 struct timer_list blink_timer;
101 int blink_brightness;
102 int new_blink_brightness;
103 void (*flash_resume)(struct led_classdev *led_cdev);
104
105 struct work_struct set_brightness_work;
106 int delayed_set_value;
107
108#ifdef CONFIG_LEDS_TRIGGERS
109
110 struct rw_semaphore trigger_lock;
111
112 struct led_trigger *trigger;
113 struct list_head trig_list;
114 void *trigger_data;
115
116 bool activated;
117#endif
118
119#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
120 int brightness_hw_changed;
121 struct kernfs_node *brightness_hw_changed_kn;
122#endif
123
124
125 struct mutex led_access;
126};
127
128extern int of_led_classdev_register(struct device *parent,
129 struct device_node *np,
130 struct led_classdev *led_cdev);
131#define led_classdev_register(parent, led_cdev) \
132 of_led_classdev_register(parent, NULL, led_cdev)
133extern int devm_of_led_classdev_register(struct device *parent,
134 struct device_node *np,
135 struct led_classdev *led_cdev);
136#define devm_led_classdev_register(parent, led_cdev) \
137 devm_of_led_classdev_register(parent, NULL, led_cdev)
138extern void led_classdev_unregister(struct led_classdev *led_cdev);
139extern void devm_led_classdev_unregister(struct device *parent,
140 struct led_classdev *led_cdev);
141extern void led_classdev_suspend(struct led_classdev *led_cdev);
142extern void led_classdev_resume(struct led_classdev *led_cdev);
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159extern void led_blink_set(struct led_classdev *led_cdev,
160 unsigned long *delay_on,
161 unsigned long *delay_off);
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
177 unsigned long *delay_on,
178 unsigned long *delay_off,
179 int invert);
180
181
182
183
184
185
186
187
188
189extern void led_set_brightness(struct led_classdev *led_cdev,
190 enum led_brightness brightness);
191
192
193
194
195
196
197
198
199
200
201
202
203extern int led_set_brightness_sync(struct led_classdev *led_cdev,
204 enum led_brightness value);
205
206
207
208
209
210
211
212
213
214
215extern int led_update_brightness(struct led_classdev *led_cdev);
216
217
218
219
220
221
222
223
224
225
226
227extern u32 *led_get_default_pattern(struct led_classdev *led_cdev,
228 unsigned int *size);
229
230
231
232
233
234
235
236extern void led_sysfs_disable(struct led_classdev *led_cdev);
237
238
239
240
241
242
243
244extern void led_sysfs_enable(struct led_classdev *led_cdev);
245
246
247
248
249
250
251
252static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
253{
254 return led_cdev->flags & LED_SYSFS_DISABLE;
255}
256
257
258
259
260
261#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
262#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
263
264#ifdef CONFIG_LEDS_TRIGGERS
265
266#define TRIG_NAME_MAX 50
267
268struct led_trigger {
269
270 const char *name;
271 int (*activate)(struct led_classdev *led_cdev);
272 void (*deactivate)(struct led_classdev *led_cdev);
273
274
275 rwlock_t leddev_list_lock;
276 struct list_head led_cdevs;
277
278
279 struct list_head next_trig;
280
281 const struct attribute_group **groups;
282};
283
284
285
286
287
288
289
290#define led_trigger_get_led(dev) ((struct led_classdev *)dev_get_drvdata((dev)))
291#define led_trigger_get_drvdata(dev) (led_get_trigger_data(led_trigger_get_led(dev)))
292
293ssize_t led_trigger_store(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count);
295ssize_t led_trigger_show(struct device *dev, struct device_attribute *attr,
296 char *buf);
297
298
299extern int led_trigger_register(struct led_trigger *trigger);
300extern void led_trigger_unregister(struct led_trigger *trigger);
301extern int devm_led_trigger_register(struct device *dev,
302 struct led_trigger *trigger);
303
304extern void led_trigger_register_simple(const char *name,
305 struct led_trigger **trigger);
306extern void led_trigger_unregister_simple(struct led_trigger *trigger);
307extern void led_trigger_event(struct led_trigger *trigger,
308 enum led_brightness event);
309extern void led_trigger_blink(struct led_trigger *trigger,
310 unsigned long *delay_on,
311 unsigned long *delay_off);
312extern void led_trigger_blink_oneshot(struct led_trigger *trigger,
313 unsigned long *delay_on,
314 unsigned long *delay_off,
315 int invert);
316extern void led_trigger_set_default(struct led_classdev *led_cdev);
317extern int led_trigger_set(struct led_classdev *led_cdev,
318 struct led_trigger *trigger);
319extern void led_trigger_remove(struct led_classdev *led_cdev);
320
321static inline void led_set_trigger_data(struct led_classdev *led_cdev,
322 void *trigger_data)
323{
324 led_cdev->trigger_data = trigger_data;
325}
326
327static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
328{
329 return led_cdev->trigger_data;
330}
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347extern void led_trigger_rename_static(const char *name,
348 struct led_trigger *trig);
349
350#define module_led_trigger(__led_trigger) \
351 module_driver(__led_trigger, led_trigger_register, \
352 led_trigger_unregister)
353
354#else
355
356
357struct led_trigger {};
358
359
360static inline void led_trigger_register_simple(const char *name,
361 struct led_trigger **trigger) {}
362static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
363static inline void led_trigger_event(struct led_trigger *trigger,
364 enum led_brightness event) {}
365static inline void led_trigger_blink(struct led_trigger *trigger,
366 unsigned long *delay_on,
367 unsigned long *delay_off) {}
368static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
369 unsigned long *delay_on,
370 unsigned long *delay_off,
371 int invert) {}
372static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
373static inline int led_trigger_set(struct led_classdev *led_cdev,
374 struct led_trigger *trigger)
375{
376 return 0;
377}
378
379static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
380static inline void led_set_trigger_data(struct led_classdev *led_cdev) {}
381static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
382{
383 return NULL;
384}
385
386#endif
387
388
389#ifdef CONFIG_LEDS_TRIGGER_DISK
390extern void ledtrig_disk_activity(bool write);
391#else
392static inline void ledtrig_disk_activity(bool write) {}
393#endif
394
395#ifdef CONFIG_LEDS_TRIGGER_MTD
396extern void ledtrig_mtd_activity(void);
397#else
398static inline void ledtrig_mtd_activity(void) {}
399#endif
400
401#if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
402extern void ledtrig_flash_ctrl(bool on);
403extern void ledtrig_torch_ctrl(bool on);
404#else
405static inline void ledtrig_flash_ctrl(bool on) {}
406static inline void ledtrig_torch_ctrl(bool on) {}
407#endif
408
409
410
411
412struct led_info {
413 const char *name;
414 const char *default_trigger;
415 int flags;
416};
417
418struct led_platform_data {
419 int num_leds;
420 struct led_info *leds;
421};
422
423struct gpio_desc;
424typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
425 unsigned long *delay_on,
426 unsigned long *delay_off);
427
428
429struct gpio_led {
430 const char *name;
431 const char *default_trigger;
432 unsigned gpio;
433 unsigned active_low : 1;
434 unsigned retain_state_suspended : 1;
435 unsigned panic_indicator : 1;
436 unsigned default_state : 2;
437 unsigned retain_state_shutdown : 1;
438
439 struct gpio_desc *gpiod;
440};
441#define LEDS_GPIO_DEFSTATE_OFF 0
442#define LEDS_GPIO_DEFSTATE_ON 1
443#define LEDS_GPIO_DEFSTATE_KEEP 2
444
445struct gpio_led_platform_data {
446 int num_leds;
447 const struct gpio_led *leds;
448
449#define GPIO_LED_NO_BLINK_LOW 0
450#define GPIO_LED_NO_BLINK_HIGH 1
451#define GPIO_LED_BLINK 2
452 gpio_blink_set_t gpio_blink_set;
453};
454
455#ifdef CONFIG_NEW_LEDS
456struct platform_device *gpio_led_register_device(
457 int id, const struct gpio_led_platform_data *pdata);
458#else
459static inline struct platform_device *gpio_led_register_device(
460 int id, const struct gpio_led_platform_data *pdata)
461{
462 return 0;
463}
464#endif
465
466enum cpu_led_event {
467 CPU_LED_IDLE_START,
468 CPU_LED_IDLE_END,
469 CPU_LED_START,
470 CPU_LED_STOP,
471 CPU_LED_HALTED,
472};
473#ifdef CONFIG_LEDS_TRIGGER_CPU
474extern void ledtrig_cpu(enum cpu_led_event evt);
475#else
476static inline void ledtrig_cpu(enum cpu_led_event evt)
477{
478 return;
479}
480#endif
481
482#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
483extern void led_classdev_notify_brightness_hw_changed(
484 struct led_classdev *led_cdev, enum led_brightness brightness);
485#else
486static inline void led_classdev_notify_brightness_hw_changed(
487 struct led_classdev *led_cdev, enum led_brightness brightness) { }
488#endif
489
490
491
492
493
494
495struct led_pattern {
496 u32 delta_t;
497 int brightness;
498};
499
500enum led_audio {
501 LED_AUDIO_MUTE,
502 LED_AUDIO_MICMUTE,
503 NUM_AUDIO_LEDS
504};
505
506#if IS_ENABLED(CONFIG_LEDS_TRIGGER_AUDIO)
507enum led_brightness ledtrig_audio_get(enum led_audio type);
508void ledtrig_audio_set(enum led_audio type, enum led_brightness state);
509#else
510static inline enum led_brightness ledtrig_audio_get(enum led_audio type)
511{
512 return LED_OFF;
513}
514static inline void ledtrig_audio_set(enum led_audio type,
515 enum led_brightness state)
516{
517}
518#endif
519
520#endif
521