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