Commit | Line | Data |
---|---|---|
c72a1d60 RP |
1 | /* |
2 | * Driver model for leds and led triggers | |
3 | * | |
4 | * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu> | |
5 | * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com> | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License version 2 as | |
9 | * published by the Free Software Foundation. | |
10 | * | |
11 | */ | |
12 | #ifndef __LINUX_LEDS_H_INCLUDED | |
13 | #define __LINUX_LEDS_H_INCLUDED | |
14 | ||
20f56758 | 15 | #include <linux/device.h> |
af410fc1 | 16 | #include <linux/list.h> |
acd899e4 | 17 | #include <linux/mutex.h> |
dc47206e | 18 | #include <linux/rwsem.h> |
04713306 | 19 | #include <linux/spinlock.h> |
9067359f | 20 | #include <linux/timer.h> |
d23a22a7 | 21 | #include <linux/workqueue.h> |
af410fc1 | 22 | |
c72a1d60 | 23 | struct device; |
c72a1d60 RP |
24 | /* |
25 | * LED Core | |
26 | */ | |
27 | ||
28 | enum led_brightness { | |
fb5035db BD |
29 | LED_OFF = 0, |
30 | LED_HALF = 127, | |
31 | LED_FULL = 255, | |
c72a1d60 RP |
32 | }; |
33 | ||
34 | struct led_classdev { | |
fb5035db | 35 | const char *name; |
d8082827 JA |
36 | enum led_brightness brightness; |
37 | enum led_brightness max_brightness; | |
fb5035db | 38 | int flags; |
c72a1d60 | 39 | |
859cb7f2 | 40 | /* Lower 16 bits reflect status */ |
fb5035db | 41 | #define LED_SUSPENDED (1 << 0) |
859cb7f2 RP |
42 | /* Upper 16 bits reflect control information */ |
43 | #define LED_CORE_SUSPENDRESUME (1 << 16) | |
5bb629c5 FB |
44 | #define LED_BLINK_ONESHOT (1 << 17) |
45 | #define LED_BLINK_ONESHOT_STOP (1 << 18) | |
46 | #define LED_BLINK_INVERT (1 << 19) | |
f1e80c07 JA |
47 | #define LED_BLINK_BRIGHTNESS_CHANGE (1 << 20) |
48 | #define LED_BLINK_DISABLE (1 << 21) | |
49 | #define LED_SYSFS_DISABLE (1 << 22) | |
50 | #define SET_BRIGHTNESS_ASYNC (1 << 23) | |
51 | #define SET_BRIGHTNESS_SYNC (1 << 24) | |
52 | #define LED_DEV_CAP_FLASH (1 << 25) | |
c72a1d60 | 53 | |
fb5035db | 54 | /* Set LED brightness level */ |
2e214e0f | 55 | /* Must not sleep, use a workqueue if needed */ |
fb5035db BD |
56 | void (*brightness_set)(struct led_classdev *led_cdev, |
57 | enum led_brightness brightness); | |
4d71a4a1 JA |
58 | /* |
59 | * Set LED brightness level immediately - it can block the caller for | |
60 | * the time required for accessing a LED device register. | |
61 | */ | |
437a4240 JA |
62 | int (*brightness_set_blocking)(struct led_classdev *led_cdev, |
63 | enum led_brightness brightness); | |
29d76dfa HMH |
64 | /* Get LED brightness level */ |
65 | enum led_brightness (*brightness_get)(struct led_classdev *led_cdev); | |
fb5035db | 66 | |
5ada28bf JB |
67 | /* |
68 | * Activate hardware accelerated blink, delays are in milliseconds | |
69 | * and if both are zero then a sensible default should be chosen. | |
70 | * The call should adjust the timings in that case and if it can't | |
71 | * match the values specified exactly. | |
72 | * Deactivate blinking again when the brightness is set to a fixed | |
73 | * value via the brightness_set() callback. | |
74 | */ | |
4c79141d MN |
75 | int (*blink_set)(struct led_classdev *led_cdev, |
76 | unsigned long *delay_on, | |
77 | unsigned long *delay_off); | |
78 | ||
f8a7c6fe | 79 | struct device *dev; |
d0d480cc JH |
80 | const struct attribute_group **groups; |
81 | ||
fb5035db | 82 | struct list_head node; /* LED Device list */ |
781a54e7 | 83 | const char *default_trigger; /* Trigger to use */ |
c72a1d60 | 84 | |
5ada28bf | 85 | unsigned long blink_delay_on, blink_delay_off; |
9067359f | 86 | struct timer_list blink_timer; |
5ada28bf | 87 | int blink_brightness; |
7aea8389 | 88 | void (*flash_resume)(struct led_classdev *led_cdev); |
5ada28bf | 89 | |
d23a22a7 FB |
90 | struct work_struct set_brightness_work; |
91 | int delayed_set_value; | |
92 | ||
c3bc9956 | 93 | #ifdef CONFIG_LEDS_TRIGGERS |
c3bc9956 | 94 | /* Protects the trigger data below */ |
dc47206e | 95 | struct rw_semaphore trigger_lock; |
c3bc9956 | 96 | |
fb5035db BD |
97 | struct led_trigger *trigger; |
98 | struct list_head trig_list; | |
99 | void *trigger_data; | |
b0096182 SK |
100 | /* true if activated - deactivate routine uses it to do cleanup */ |
101 | bool activated; | |
c3bc9956 | 102 | #endif |
acd899e4 JA |
103 | |
104 | /* Ensures consistent access to the LED Flash Class device */ | |
105 | struct mutex led_access; | |
c72a1d60 RP |
106 | }; |
107 | ||
108 | extern int led_classdev_register(struct device *parent, | |
fb5035db | 109 | struct led_classdev *led_cdev); |
ca1bb4ee BA |
110 | extern int devm_led_classdev_register(struct device *parent, |
111 | struct led_classdev *led_cdev); | |
e2387d6c | 112 | extern void led_classdev_unregister(struct led_classdev *led_cdev); |
ca1bb4ee BA |
113 | extern void devm_led_classdev_unregister(struct device *parent, |
114 | struct led_classdev *led_cdev); | |
c72a1d60 RP |
115 | extern void led_classdev_suspend(struct led_classdev *led_cdev); |
116 | extern void led_classdev_resume(struct led_classdev *led_cdev); | |
117 | ||
5ada28bf JB |
118 | /** |
119 | * led_blink_set - set blinking with software fallback | |
120 | * @led_cdev: the LED to start blinking | |
121 | * @delay_on: the time it should be on (in ms) | |
122 | * @delay_off: the time it should ble off (in ms) | |
123 | * | |
124 | * This function makes the LED blink, attempting to use the | |
125 | * hardware acceleration if possible, but falling back to | |
126 | * software blinking if there is no hardware blinking or if | |
127 | * the LED refuses the passed values. | |
128 | * | |
129 | * Note that if software blinking is active, simply calling | |
130 | * led_cdev->brightness_set() will not stop the blinking, | |
131 | * use led_classdev_brightness_set() instead. | |
132 | */ | |
133 | extern void led_blink_set(struct led_classdev *led_cdev, | |
134 | unsigned long *delay_on, | |
135 | unsigned long *delay_off); | |
5bb629c5 FB |
136 | /** |
137 | * led_blink_set_oneshot - do a oneshot software blink | |
138 | * @led_cdev: the LED to start blinking | |
139 | * @delay_on: the time it should be on (in ms) | |
140 | * @delay_off: the time it should ble off (in ms) | |
141 | * @invert: blink off, then on, leaving the led on | |
142 | * | |
143 | * This function makes the LED blink one time for delay_on + | |
144 | * delay_off time, ignoring the request if another one-shot | |
145 | * blink is already in progress. | |
146 | * | |
147 | * If invert is set, led blinks for delay_off first, then for | |
148 | * delay_on and leave the led on after the on-off cycle. | |
149 | */ | |
150 | extern void led_blink_set_oneshot(struct led_classdev *led_cdev, | |
151 | unsigned long *delay_on, | |
152 | unsigned long *delay_off, | |
153 | int invert); | |
5ada28bf | 154 | /** |
19cd67e2 | 155 | * led_set_brightness - set LED brightness |
5ada28bf JB |
156 | * @led_cdev: the LED to set |
157 | * @brightness: the brightness to set it to | |
158 | * | |
159 | * Set an LED's brightness, and, if necessary, cancel the | |
160 | * software blink timer that implements blinking when the | |
161 | * hardware doesn't. | |
162 | */ | |
19cd67e2 | 163 | extern void led_set_brightness(struct led_classdev *led_cdev, |
5ada28bf | 164 | enum led_brightness brightness); |
3ef7de53 JA |
165 | /** |
166 | * led_update_brightness - update LED brightness | |
167 | * @led_cdev: the LED to query | |
168 | * | |
169 | * Get an LED's current brightness and update led_cdev->brightness | |
170 | * member with the obtained value. | |
171 | * | |
172 | * Returns: 0 on success or negative error value on failure | |
173 | */ | |
174 | extern int led_update_brightness(struct led_classdev *led_cdev); | |
5ada28bf | 175 | |
acd899e4 JA |
176 | /** |
177 | * led_sysfs_disable - disable LED sysfs interface | |
178 | * @led_cdev: the LED to set | |
179 | * | |
180 | * Disable the led_cdev's sysfs interface. | |
181 | */ | |
182 | extern void led_sysfs_disable(struct led_classdev *led_cdev); | |
183 | ||
184 | /** | |
185 | * led_sysfs_enable - enable LED sysfs interface | |
186 | * @led_cdev: the LED to set | |
187 | * | |
188 | * Enable the led_cdev's sysfs interface. | |
189 | */ | |
190 | extern void led_sysfs_enable(struct led_classdev *led_cdev); | |
191 | ||
192 | /** | |
193 | * led_sysfs_is_disabled - check if LED sysfs interface is disabled | |
194 | * @led_cdev: the LED to query | |
195 | * | |
196 | * Returns: true if the led_cdev's sysfs interface is disabled. | |
197 | */ | |
198 | static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev) | |
199 | { | |
200 | return led_cdev->flags & LED_SYSFS_DISABLE; | |
201 | } | |
202 | ||
c3bc9956 RP |
203 | /* |
204 | * LED Triggers | |
205 | */ | |
39f7e08a KM |
206 | /* Registration functions for simple triggers */ |
207 | #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x; | |
208 | #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x; | |
209 | ||
c3bc9956 RP |
210 | #ifdef CONFIG_LEDS_TRIGGERS |
211 | ||
212 | #define TRIG_NAME_MAX 50 | |
213 | ||
214 | struct led_trigger { | |
215 | /* Trigger Properties */ | |
fb5035db BD |
216 | const char *name; |
217 | void (*activate)(struct led_classdev *led_cdev); | |
218 | void (*deactivate)(struct led_classdev *led_cdev); | |
c3bc9956 RP |
219 | |
220 | /* LEDs under control by this trigger (for simple triggers) */ | |
fb5035db BD |
221 | rwlock_t leddev_list_lock; |
222 | struct list_head led_cdevs; | |
c3bc9956 RP |
223 | |
224 | /* Link to next registered trigger */ | |
fb5035db | 225 | struct list_head next_trig; |
c3bc9956 RP |
226 | }; |
227 | ||
20f56758 JA |
228 | ssize_t led_trigger_store(struct device *dev, struct device_attribute *attr, |
229 | const char *buf, size_t count); | |
230 | ssize_t led_trigger_show(struct device *dev, struct device_attribute *attr, | |
231 | char *buf); | |
232 | ||
c3bc9956 RP |
233 | /* Registration functions for complex triggers */ |
234 | extern int led_trigger_register(struct led_trigger *trigger); | |
235 | extern void led_trigger_unregister(struct led_trigger *trigger); | |
236 | ||
c3bc9956 RP |
237 | extern void led_trigger_register_simple(const char *name, |
238 | struct led_trigger **trigger); | |
239 | extern void led_trigger_unregister_simple(struct led_trigger *trigger); | |
240 | extern void led_trigger_event(struct led_trigger *trigger, | |
241 | enum led_brightness event); | |
0b9536c9 VK |
242 | extern void led_trigger_blink(struct led_trigger *trigger, |
243 | unsigned long *delay_on, | |
244 | unsigned long *delay_off); | |
5bb629c5 FB |
245 | extern void led_trigger_blink_oneshot(struct led_trigger *trigger, |
246 | unsigned long *delay_on, | |
247 | unsigned long *delay_off, | |
248 | int invert); | |
20f56758 JA |
249 | extern void led_trigger_set_default(struct led_classdev *led_cdev); |
250 | extern void led_trigger_set(struct led_classdev *led_cdev, | |
251 | struct led_trigger *trigger); | |
252 | extern void led_trigger_remove(struct led_classdev *led_cdev); | |
253 | ||
254 | static inline void *led_get_trigger_data(struct led_classdev *led_cdev) | |
255 | { | |
256 | return led_cdev->trigger_data; | |
257 | } | |
258 | ||
057407c7 JH |
259 | /** |
260 | * led_trigger_rename_static - rename a trigger | |
261 | * @name: the new trigger name | |
262 | * @trig: the LED trigger to rename | |
263 | * | |
264 | * Change a LED trigger name by copying the string passed in | |
265 | * name into current trigger name, which MUST be large | |
266 | * enough for the new string. | |
267 | * | |
268 | * Note that name must NOT point to the same string used | |
269 | * during LED registration, as that could lead to races. | |
270 | * | |
271 | * This is meant to be used on triggers with statically | |
272 | * allocated name. | |
273 | */ | |
274 | extern void led_trigger_rename_static(const char *name, | |
275 | struct led_trigger *trig); | |
c3bc9956 RP |
276 | |
277 | #else | |
278 | ||
39f7e08a KM |
279 | /* Trigger has no members */ |
280 | struct led_trigger {}; | |
c3bc9956 | 281 | |
39f7e08a KM |
282 | /* Trigger inline empty functions */ |
283 | static inline void led_trigger_register_simple(const char *name, | |
284 | struct led_trigger **trigger) {} | |
285 | static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {} | |
286 | static inline void led_trigger_event(struct led_trigger *trigger, | |
287 | enum led_brightness event) {} | |
8890624a MG |
288 | static inline void led_trigger_blink(struct led_trigger *trigger, |
289 | unsigned long *delay_on, | |
290 | unsigned long *delay_off) {} | |
291 | static inline void led_trigger_blink_oneshot(struct led_trigger *trigger, | |
292 | unsigned long *delay_on, | |
293 | unsigned long *delay_off, | |
294 | int invert) {} | |
20f56758 JA |
295 | static inline void led_trigger_set_default(struct led_classdev *led_cdev) {} |
296 | static inline void led_trigger_set(struct led_classdev *led_cdev, | |
297 | struct led_trigger *trigger) {} | |
298 | static inline void led_trigger_remove(struct led_classdev *led_cdev) {} | |
299 | static inline void *led_get_trigger_data(struct led_classdev *led_cdev) | |
300 | { | |
301 | return NULL; | |
302 | } | |
303 | ||
39f7e08a | 304 | #endif /* CONFIG_LEDS_TRIGGERS */ |
2bfb646c RP |
305 | |
306 | /* Trigger specific functions */ | |
307 | #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK | |
308 | extern void ledtrig_ide_activity(void); | |
309 | #else | |
39f7e08a | 310 | static inline void ledtrig_ide_activity(void) {} |
2bfb646c RP |
311 | #endif |
312 | ||
48a1d032 KM |
313 | #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE) |
314 | extern void ledtrig_flash_ctrl(bool on); | |
315 | extern void ledtrig_torch_ctrl(bool on); | |
316 | #else | |
317 | static inline void ledtrig_flash_ctrl(bool on) {} | |
318 | static inline void ledtrig_torch_ctrl(bool on) {} | |
319 | #endif | |
320 | ||
f46e9203 NC |
321 | /* |
322 | * Generic LED platform data for describing LED names and default triggers. | |
323 | */ | |
324 | struct led_info { | |
325 | const char *name; | |
326bb8a5 | 326 | const char *default_trigger; |
f46e9203 NC |
327 | int flags; |
328 | }; | |
329 | ||
330 | struct led_platform_data { | |
331 | int num_leds; | |
332 | struct led_info *leds; | |
333 | }; | |
334 | ||
22e03f3b RA |
335 | /* For the leds-gpio driver */ |
336 | struct gpio_led { | |
337 | const char *name; | |
326bb8a5 | 338 | const char *default_trigger; |
22e03f3b | 339 | unsigned gpio; |
ed88bae6 TP |
340 | unsigned active_low : 1; |
341 | unsigned retain_state_suspended : 1; | |
342 | unsigned default_state : 2; | |
343 | /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */ | |
5c51277a | 344 | struct gpio_desc *gpiod; |
22e03f3b | 345 | }; |
2146325d BH |
346 | #define LEDS_GPIO_DEFSTATE_OFF 0 |
347 | #define LEDS_GPIO_DEFSTATE_ON 1 | |
348 | #define LEDS_GPIO_DEFSTATE_KEEP 2 | |
22e03f3b RA |
349 | |
350 | struct gpio_led_platform_data { | |
351 | int num_leds; | |
9517f925 | 352 | const struct gpio_led *leds; |
2146325d BH |
353 | |
354 | #define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */ | |
355 | #define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */ | |
9517f925 | 356 | #define GPIO_LED_BLINK 2 /* Please, blink */ |
c673a2b4 | 357 | int (*gpio_blink_set)(struct gpio_desc *desc, int state, |
ca3259b3 HVR |
358 | unsigned long *delay_on, |
359 | unsigned long *delay_off); | |
22e03f3b RA |
360 | }; |
361 | ||
4440673a UKK |
362 | struct platform_device *gpio_led_register_device( |
363 | int id, const struct gpio_led_platform_data *pdata); | |
22e03f3b | 364 | |
8f88731d BW |
365 | enum cpu_led_event { |
366 | CPU_LED_IDLE_START, /* CPU enters idle */ | |
367 | CPU_LED_IDLE_END, /* CPU idle ends */ | |
368 | CPU_LED_START, /* Machine starts, especially resume */ | |
369 | CPU_LED_STOP, /* Machine stops, especially suspend */ | |
370 | CPU_LED_HALTED, /* Machine shutdown */ | |
371 | }; | |
372 | #ifdef CONFIG_LEDS_TRIGGER_CPU | |
373 | extern void ledtrig_cpu(enum cpu_led_event evt); | |
374 | #else | |
375 | static inline void ledtrig_cpu(enum cpu_led_event evt) | |
376 | { | |
377 | return; | |
378 | } | |
379 | #endif | |
380 | ||
c72a1d60 | 381 | #endif /* __LINUX_LEDS_H_INCLUDED */ |