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