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 | ||
af410fc1 | 15 | #include <linux/list.h> |
df96efd7 | 16 | #include <linux/spinlock.h> |
dc47206e | 17 | #include <linux/rwsem.h> |
af410fc1 | 18 | |
c72a1d60 | 19 | struct device; |
c72a1d60 RP |
20 | /* |
21 | * LED Core | |
22 | */ | |
23 | ||
24 | enum led_brightness { | |
fb5035db BD |
25 | LED_OFF = 0, |
26 | LED_HALF = 127, | |
27 | LED_FULL = 255, | |
c72a1d60 RP |
28 | }; |
29 | ||
30 | struct led_classdev { | |
fb5035db BD |
31 | const char *name; |
32 | int brightness; | |
1bd465e6 | 33 | int max_brightness; |
fb5035db | 34 | int flags; |
c72a1d60 | 35 | |
859cb7f2 | 36 | /* Lower 16 bits reflect status */ |
fb5035db | 37 | #define LED_SUSPENDED (1 << 0) |
859cb7f2 RP |
38 | /* Upper 16 bits reflect control information */ |
39 | #define LED_CORE_SUSPENDRESUME (1 << 16) | |
c72a1d60 | 40 | |
fb5035db | 41 | /* Set LED brightness level */ |
2e214e0f | 42 | /* Must not sleep, use a workqueue if needed */ |
fb5035db BD |
43 | void (*brightness_set)(struct led_classdev *led_cdev, |
44 | enum led_brightness brightness); | |
29d76dfa HMH |
45 | /* Get LED brightness level */ |
46 | enum led_brightness (*brightness_get)(struct led_classdev *led_cdev); | |
fb5035db | 47 | |
92722b1b MB |
48 | /* Activate hardware accelerated blink, delays are in |
49 | * miliseconds and if none is provided then a sensible default | |
50 | * should be chosen. */ | |
4c79141d MN |
51 | int (*blink_set)(struct led_classdev *led_cdev, |
52 | unsigned long *delay_on, | |
53 | unsigned long *delay_off); | |
54 | ||
f8a7c6fe | 55 | struct device *dev; |
fb5035db | 56 | struct list_head node; /* LED Device list */ |
781a54e7 | 57 | const char *default_trigger; /* Trigger to use */ |
c72a1d60 | 58 | |
c3bc9956 | 59 | #ifdef CONFIG_LEDS_TRIGGERS |
c3bc9956 | 60 | /* Protects the trigger data below */ |
dc47206e | 61 | struct rw_semaphore trigger_lock; |
c3bc9956 | 62 | |
fb5035db BD |
63 | struct led_trigger *trigger; |
64 | struct list_head trig_list; | |
65 | void *trigger_data; | |
c3bc9956 | 66 | #endif |
c72a1d60 RP |
67 | }; |
68 | ||
69 | extern int led_classdev_register(struct device *parent, | |
fb5035db | 70 | struct led_classdev *led_cdev); |
e2387d6c | 71 | extern void led_classdev_unregister(struct led_classdev *led_cdev); |
c72a1d60 RP |
72 | extern void led_classdev_suspend(struct led_classdev *led_cdev); |
73 | extern void led_classdev_resume(struct led_classdev *led_cdev); | |
74 | ||
c3bc9956 RP |
75 | /* |
76 | * LED Triggers | |
77 | */ | |
78 | #ifdef CONFIG_LEDS_TRIGGERS | |
79 | ||
80 | #define TRIG_NAME_MAX 50 | |
81 | ||
82 | struct led_trigger { | |
83 | /* Trigger Properties */ | |
fb5035db BD |
84 | const char *name; |
85 | void (*activate)(struct led_classdev *led_cdev); | |
86 | void (*deactivate)(struct led_classdev *led_cdev); | |
c3bc9956 RP |
87 | |
88 | /* LEDs under control by this trigger (for simple triggers) */ | |
fb5035db BD |
89 | rwlock_t leddev_list_lock; |
90 | struct list_head led_cdevs; | |
c3bc9956 RP |
91 | |
92 | /* Link to next registered trigger */ | |
fb5035db | 93 | struct list_head next_trig; |
c3bc9956 RP |
94 | }; |
95 | ||
96 | /* Registration functions for complex triggers */ | |
97 | extern int led_trigger_register(struct led_trigger *trigger); | |
98 | extern void led_trigger_unregister(struct led_trigger *trigger); | |
99 | ||
100 | /* Registration functions for simple triggers */ | |
101 | #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x; | |
102 | #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x; | |
103 | extern void led_trigger_register_simple(const char *name, | |
104 | struct led_trigger **trigger); | |
105 | extern void led_trigger_unregister_simple(struct led_trigger *trigger); | |
106 | extern void led_trigger_event(struct led_trigger *trigger, | |
107 | enum led_brightness event); | |
108 | ||
109 | #else | |
110 | ||
111 | /* Triggers aren't active - null macros */ | |
112 | #define DEFINE_LED_TRIGGER(x) | |
113 | #define DEFINE_LED_TRIGGER_GLOBAL(x) | |
114 | #define led_trigger_register_simple(x, y) do {} while(0) | |
115 | #define led_trigger_unregister_simple(x) do {} while(0) | |
116 | #define led_trigger_event(x, y) do {} while(0) | |
117 | ||
118 | #endif | |
2bfb646c RP |
119 | |
120 | /* Trigger specific functions */ | |
121 | #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK | |
122 | extern void ledtrig_ide_activity(void); | |
123 | #else | |
124 | #define ledtrig_ide_activity() do {} while(0) | |
125 | #endif | |
126 | ||
f46e9203 NC |
127 | /* |
128 | * Generic LED platform data for describing LED names and default triggers. | |
129 | */ | |
130 | struct led_info { | |
131 | const char *name; | |
326bb8a5 | 132 | const char *default_trigger; |
f46e9203 NC |
133 | int flags; |
134 | }; | |
135 | ||
136 | struct led_platform_data { | |
137 | int num_leds; | |
138 | struct led_info *leds; | |
139 | }; | |
140 | ||
22e03f3b RA |
141 | /* For the leds-gpio driver */ |
142 | struct gpio_led { | |
143 | const char *name; | |
326bb8a5 | 144 | const char *default_trigger; |
22e03f3b | 145 | unsigned gpio; |
ed88bae6 TP |
146 | unsigned active_low : 1; |
147 | unsigned retain_state_suspended : 1; | |
148 | unsigned default_state : 2; | |
149 | /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */ | |
22e03f3b | 150 | }; |
ed88bae6 TP |
151 | #define LEDS_GPIO_DEFSTATE_OFF 0 |
152 | #define LEDS_GPIO_DEFSTATE_ON 1 | |
153 | #define LEDS_GPIO_DEFSTATE_KEEP 2 | |
22e03f3b RA |
154 | |
155 | struct gpio_led_platform_data { | |
156 | int num_leds; | |
157 | struct gpio_led *leds; | |
ca3259b3 HVR |
158 | int (*gpio_blink_set)(unsigned gpio, |
159 | unsigned long *delay_on, | |
160 | unsigned long *delay_off); | |
22e03f3b RA |
161 | }; |
162 | ||
163 | ||
c72a1d60 | 164 | #endif /* __LINUX_LEDS_H_INCLUDED */ |