1e9283513SSascha Wildner /*-
2e9283513SSascha Wildner * ----------------------------------------------------------------------------
3e9283513SSascha Wildner * "THE BEER-WARE LICENSE" (Revision 42):
4e9283513SSascha Wildner * <phk@FreeBSD.org> wrote this file. As long as you retain this notice you
5e9283513SSascha Wildner * can do whatever you want with this stuff. If we meet some day, and you think
6e9283513SSascha Wildner * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
7e9283513SSascha Wildner * ----------------------------------------------------------------------------
8e9283513SSascha Wildner *
9e9283513SSascha Wildner * $FreeBSD: head/sys/dev/led/led.c 247008 2013-02-19 19:25:50Z mav $
10e9283513SSascha Wildner */
11e9283513SSascha Wildner
12e9283513SSascha Wildner #include <sys/param.h>
13e9283513SSascha Wildner #include <sys/conf.h>
14e9283513SSascha Wildner #include <sys/kernel.h>
15e9283513SSascha Wildner #include <sys/systm.h>
16e9283513SSascha Wildner #include <sys/limits.h>
17e9283513SSascha Wildner #include <sys/malloc.h>
18e9283513SSascha Wildner #include <sys/ctype.h>
19e9283513SSascha Wildner #include <sys/sbuf.h>
20e9283513SSascha Wildner #include <sys/queue.h>
21e9283513SSascha Wildner #include <dev/misc/led/led.h>
22e9283513SSascha Wildner #include <sys/uio.h>
23e9283513SSascha Wildner #include <sys/device.h>
24f2c400e8SImre Vadász #include <sys/module.h>
25e9283513SSascha Wildner
26e9283513SSascha Wildner struct ledsc {
27e9283513SSascha Wildner LIST_ENTRY(ledsc) list;
28e9283513SSascha Wildner char *name;
29e9283513SSascha Wildner void *private;
30e9283513SSascha Wildner int unit;
31e9283513SSascha Wildner led_t *func;
32e9283513SSascha Wildner struct cdev *dev;
33e9283513SSascha Wildner struct sbuf *spec;
34e9283513SSascha Wildner char *str;
35e9283513SSascha Wildner char *ptr;
36e9283513SSascha Wildner int count;
37e9283513SSascha Wildner time_t last_second;
38e9283513SSascha Wildner };
39e9283513SSascha Wildner
40e9283513SSascha Wildner static struct unrhdr *led_unit;
41e9283513SSascha Wildner static struct lock led_lock;
42e9283513SSascha Wildner static struct lock led_lock2;
43e9283513SSascha Wildner static LIST_HEAD(, ledsc) led_list = LIST_HEAD_INITIALIZER(led_list);
44e9283513SSascha Wildner static struct callout led_ch;
45e9283513SSascha Wildner static int blinkers = 0;
46e9283513SSascha Wildner
47e9283513SSascha Wildner static MALLOC_DEFINE(M_LED, "LED", "LED driver");
48e9283513SSascha Wildner
49e9283513SSascha Wildner static void
led_timeout(void * p)50e9283513SSascha Wildner led_timeout(void *p)
51e9283513SSascha Wildner {
52e9283513SSascha Wildner struct ledsc *sc;
53e9283513SSascha Wildner
54e9283513SSascha Wildner lockmgr(&led_lock, LK_EXCLUSIVE);
55e9283513SSascha Wildner LIST_FOREACH(sc, &led_list, list) {
56e9283513SSascha Wildner if (sc->ptr == NULL)
57e9283513SSascha Wildner continue;
58e9283513SSascha Wildner if (sc->count > 0) {
59e9283513SSascha Wildner sc->count--;
60e9283513SSascha Wildner continue;
61e9283513SSascha Wildner }
62e9283513SSascha Wildner if (*sc->ptr == '.') {
63e9283513SSascha Wildner sc->ptr = NULL;
64e9283513SSascha Wildner blinkers--;
65e9283513SSascha Wildner continue;
66e9283513SSascha Wildner } else if (*sc->ptr == 'U' || *sc->ptr == 'u') {
67e9283513SSascha Wildner if (sc->last_second == time_second)
68e9283513SSascha Wildner continue;
69e9283513SSascha Wildner sc->last_second = time_second;
70e9283513SSascha Wildner sc->func(sc->private, *sc->ptr == 'U');
71e9283513SSascha Wildner } else if (*sc->ptr >= 'a' && *sc->ptr <= 'j') {
72e9283513SSascha Wildner sc->func(sc->private, 0);
73e9283513SSascha Wildner sc->count = (*sc->ptr & 0xf) - 1;
74e9283513SSascha Wildner } else if (*sc->ptr >= 'A' && *sc->ptr <= 'J') {
75e9283513SSascha Wildner sc->func(sc->private, 1);
76e9283513SSascha Wildner sc->count = (*sc->ptr & 0xf) - 1;
77e9283513SSascha Wildner }
78e9283513SSascha Wildner sc->ptr++;
79e9283513SSascha Wildner if (*sc->ptr == '\0')
80e9283513SSascha Wildner sc->ptr = sc->str;
81e9283513SSascha Wildner }
82e9283513SSascha Wildner if (blinkers > 0)
83e9283513SSascha Wildner callout_reset(&led_ch, hz / 10, led_timeout, p);
84e9283513SSascha Wildner lockmgr(&led_lock, LK_RELEASE);
85e9283513SSascha Wildner }
86e9283513SSascha Wildner
87e9283513SSascha Wildner static int
led_state(struct ledsc * sc,struct sbuf ** sb,int state)88e9283513SSascha Wildner led_state(struct ledsc *sc, struct sbuf **sb, int state)
89e9283513SSascha Wildner {
90e9283513SSascha Wildner struct sbuf *sb2 = NULL;
91e9283513SSascha Wildner
92e9283513SSascha Wildner sb2 = sc->spec;
93e9283513SSascha Wildner sc->spec = *sb;
94e9283513SSascha Wildner if (*sb != NULL) {
95e9283513SSascha Wildner sc->str = sbuf_data(*sb);
96e9283513SSascha Wildner if (sc->ptr == NULL) {
97e9283513SSascha Wildner blinkers++;
98e9283513SSascha Wildner callout_reset(&led_ch, hz / 10, led_timeout, NULL);
99e9283513SSascha Wildner }
100e9283513SSascha Wildner sc->ptr = sc->str;
101e9283513SSascha Wildner } else {
102e9283513SSascha Wildner sc->str = NULL;
103e9283513SSascha Wildner if (sc->ptr != NULL)
104e9283513SSascha Wildner blinkers--;
105e9283513SSascha Wildner sc->ptr = NULL;
106e9283513SSascha Wildner sc->func(sc->private, state);
107e9283513SSascha Wildner }
108e9283513SSascha Wildner sc->count = 0;
109e9283513SSascha Wildner *sb = sb2;
110e9283513SSascha Wildner return(0);
111e9283513SSascha Wildner }
112e9283513SSascha Wildner
113e9283513SSascha Wildner static int
led_parse(const char * s,struct sbuf ** sb,int * state)114e9283513SSascha Wildner led_parse(const char *s, struct sbuf **sb, int *state)
115e9283513SSascha Wildner {
116e9283513SSascha Wildner int i, error;
117e9283513SSascha Wildner
118e9283513SSascha Wildner /*
119e9283513SSascha Wildner * Handle "on" and "off" immediately so people can flash really
120e9283513SSascha Wildner * fast from userland if they want to
121e9283513SSascha Wildner */
122e9283513SSascha Wildner if (*s == '0' || *s == '1') {
123e9283513SSascha Wildner *state = *s & 1;
124e9283513SSascha Wildner return (0);
125e9283513SSascha Wildner }
126e9283513SSascha Wildner
127e9283513SSascha Wildner *state = 0;
128e9283513SSascha Wildner *sb = sbuf_new_auto();
129e9283513SSascha Wildner if (*sb == NULL)
130e9283513SSascha Wildner return (ENOMEM);
131e9283513SSascha Wildner switch(s[0]) {
132e9283513SSascha Wildner /*
133e9283513SSascha Wildner * Flash, default is 100msec/100msec.
134e9283513SSascha Wildner * 'f2' sets 200msec/200msec etc.
135e9283513SSascha Wildner */
136e9283513SSascha Wildner case 'f':
137e9283513SSascha Wildner if (s[1] >= '1' && s[1] <= '9')
138e9283513SSascha Wildner i = s[1] - '1';
139e9283513SSascha Wildner else
140e9283513SSascha Wildner i = 0;
141e9283513SSascha Wildner sbuf_printf(*sb, "%c%c", 'A' + i, 'a' + i);
142e9283513SSascha Wildner break;
143e9283513SSascha Wildner /*
144e9283513SSascha Wildner * Digits, flashes out numbers.
145e9283513SSascha Wildner * 'd12' becomes -__________-_-______________________________
146e9283513SSascha Wildner */
147e9283513SSascha Wildner case 'd':
148e9283513SSascha Wildner for(s++; *s; s++) {
149e9283513SSascha Wildner if (!isdigit(*s))
150e9283513SSascha Wildner continue;
151e9283513SSascha Wildner i = *s - '0';
152e9283513SSascha Wildner if (i == 0)
153e9283513SSascha Wildner i = 10;
154e9283513SSascha Wildner for (; i > 1; i--)
155e9283513SSascha Wildner sbuf_cat(*sb, "Aa");
156e9283513SSascha Wildner sbuf_cat(*sb, "Aj");
157e9283513SSascha Wildner }
158e9283513SSascha Wildner sbuf_cat(*sb, "jj");
159e9283513SSascha Wildner break;
160e9283513SSascha Wildner /*
161e9283513SSascha Wildner * String, roll your own.
162e9283513SSascha Wildner * 'a-j' gives "off" for n/10 sec.
163e9283513SSascha Wildner * 'A-J' gives "on" for n/10 sec.
164e9283513SSascha Wildner * no delay before repeat
165e9283513SSascha Wildner * 'sAaAbBa' becomes _-_--__-
166e9283513SSascha Wildner */
167e9283513SSascha Wildner case 's':
168e9283513SSascha Wildner for(s++; *s; s++) {
169e9283513SSascha Wildner if ((*s >= 'a' && *s <= 'j') ||
170e9283513SSascha Wildner (*s >= 'A' && *s <= 'J') ||
171e9283513SSascha Wildner *s == 'U' || *s <= 'u' ||
172e9283513SSascha Wildner *s == '.')
173e9283513SSascha Wildner sbuf_bcat(*sb, s, 1);
174e9283513SSascha Wildner }
175e9283513SSascha Wildner break;
176e9283513SSascha Wildner /*
177e9283513SSascha Wildner * Morse.
178e9283513SSascha Wildner * '.' becomes _-
179e9283513SSascha Wildner * '-' becomes _---
180e9283513SSascha Wildner * ' ' becomes __
181e9283513SSascha Wildner * '\n' becomes ____
182e9283513SSascha Wildner * 1sec pause between repeats
183e9283513SSascha Wildner * '... --- ...' -> _-_-_-___---_---_---___-_-_-__________
184e9283513SSascha Wildner */
185e9283513SSascha Wildner case 'm':
186e9283513SSascha Wildner for(s++; *s; s++) {
187e9283513SSascha Wildner if (*s == '.')
188e9283513SSascha Wildner sbuf_cat(*sb, "aA");
189e9283513SSascha Wildner else if (*s == '-')
190e9283513SSascha Wildner sbuf_cat(*sb, "aC");
191e9283513SSascha Wildner else if (*s == ' ')
192e9283513SSascha Wildner sbuf_cat(*sb, "b");
193e9283513SSascha Wildner else if (*s == '\n')
194e9283513SSascha Wildner sbuf_cat(*sb, "d");
195e9283513SSascha Wildner }
196e9283513SSascha Wildner sbuf_cat(*sb, "j");
197e9283513SSascha Wildner break;
198e9283513SSascha Wildner default:
199e9283513SSascha Wildner sbuf_delete(*sb);
200e9283513SSascha Wildner return (EINVAL);
201e9283513SSascha Wildner }
202e9283513SSascha Wildner error = sbuf_finish(*sb);
203e9283513SSascha Wildner if (error != 0 || sbuf_len(*sb) == 0) {
204e9283513SSascha Wildner *sb = NULL;
205e9283513SSascha Wildner return (error);
206e9283513SSascha Wildner }
207e9283513SSascha Wildner return (0);
208e9283513SSascha Wildner }
209e9283513SSascha Wildner
210e9283513SSascha Wildner static int
led_open(struct dev_open_args * ap)211e9283513SSascha Wildner led_open(struct dev_open_args *ap)
212e9283513SSascha Wildner {
213e9283513SSascha Wildner return (0);
214e9283513SSascha Wildner }
215e9283513SSascha Wildner
216e9283513SSascha Wildner static int
led_close(struct dev_close_args * ap)217e9283513SSascha Wildner led_close(struct dev_close_args *ap)
218e9283513SSascha Wildner {
219e9283513SSascha Wildner return (0);
220e9283513SSascha Wildner }
221e9283513SSascha Wildner
222e9283513SSascha Wildner static int
led_write(struct dev_write_args * ap)223e9283513SSascha Wildner led_write(struct dev_write_args *ap)
224e9283513SSascha Wildner {
225e9283513SSascha Wildner struct uio *uio = ap->a_uio;
226e9283513SSascha Wildner cdev_t dev = ap->a_head.a_dev;
227e9283513SSascha Wildner struct ledsc *sc;
228e9283513SSascha Wildner char *s;
229e9283513SSascha Wildner struct sbuf *sb = NULL;
230e9283513SSascha Wildner int error, state = 0;
231e9283513SSascha Wildner
232e9283513SSascha Wildner if (uio->uio_resid > 512)
233e9283513SSascha Wildner return (EINVAL);
234e9283513SSascha Wildner s = kmalloc(uio->uio_resid + 1, M_DEVBUF, M_WAITOK);
235e9283513SSascha Wildner s[uio->uio_resid] = '\0';
236e9283513SSascha Wildner error = uiomove(s, uio->uio_resid, uio);
237e9283513SSascha Wildner if (error) {
238e9283513SSascha Wildner kfree(s, M_DEVBUF);
239e9283513SSascha Wildner return (error);
240e9283513SSascha Wildner }
241e9283513SSascha Wildner error = led_parse(s, &sb, &state);
242e9283513SSascha Wildner kfree(s, M_DEVBUF);
243e9283513SSascha Wildner if (error)
244e9283513SSascha Wildner return (error);
245e9283513SSascha Wildner lockmgr(&led_lock, LK_EXCLUSIVE);
246e9283513SSascha Wildner sc = dev->si_drv1;
247e9283513SSascha Wildner if (sc != NULL)
248e9283513SSascha Wildner error = led_state(sc, &sb, state);
249e9283513SSascha Wildner lockmgr(&led_lock, LK_RELEASE);
250e9283513SSascha Wildner if (sb != NULL)
251e9283513SSascha Wildner sbuf_delete(sb);
252e9283513SSascha Wildner return (error);
253e9283513SSascha Wildner }
254e9283513SSascha Wildner
255e9283513SSascha Wildner int
led_set(char const * name,char const * cmd)256e9283513SSascha Wildner led_set(char const *name, char const *cmd)
257e9283513SSascha Wildner {
258e9283513SSascha Wildner struct ledsc *sc;
259e9283513SSascha Wildner struct sbuf *sb = NULL;
260e9283513SSascha Wildner int error, state = 0;
261e9283513SSascha Wildner
262e9283513SSascha Wildner error = led_parse(cmd, &sb, &state);
263e9283513SSascha Wildner if (error)
264e9283513SSascha Wildner return (error);
265e9283513SSascha Wildner lockmgr(&led_lock, LK_EXCLUSIVE);
266e9283513SSascha Wildner LIST_FOREACH(sc, &led_list, list) {
267e9283513SSascha Wildner if (strcmp(sc->name, name) == 0)
268e9283513SSascha Wildner break;
269e9283513SSascha Wildner }
270e9283513SSascha Wildner if (sc != NULL)
271e9283513SSascha Wildner error = led_state(sc, &sb, state);
272e9283513SSascha Wildner else
273e9283513SSascha Wildner error = ENOENT;
274e9283513SSascha Wildner lockmgr(&led_lock, LK_RELEASE);
275e9283513SSascha Wildner if (sb != NULL)
276e9283513SSascha Wildner sbuf_delete(sb);
277e9283513SSascha Wildner return (0);
278e9283513SSascha Wildner }
279e9283513SSascha Wildner
280e9283513SSascha Wildner static struct dev_ops led_ops = {
281481d12aaSMatthew Dillon { "LED", 0, D_MPSAFE },
282e9283513SSascha Wildner .d_open = led_open,
283e9283513SSascha Wildner .d_close = led_close,
284e9283513SSascha Wildner .d_write = led_write,
285e9283513SSascha Wildner };
286e9283513SSascha Wildner
287e9283513SSascha Wildner struct cdev *
led_create(led_t * func,void * priv,char const * name)288e9283513SSascha Wildner led_create(led_t *func, void *priv, char const *name)
289e9283513SSascha Wildner {
290e9283513SSascha Wildner
291e9283513SSascha Wildner return (led_create_state(func, priv, name, 0));
292e9283513SSascha Wildner }
293e9283513SSascha Wildner struct cdev *
led_create_state(led_t * func,void * priv,char const * name,int state)294e9283513SSascha Wildner led_create_state(led_t *func, void *priv, char const *name, int state)
295e9283513SSascha Wildner {
296e9283513SSascha Wildner struct ledsc *sc;
297e9283513SSascha Wildner
298e9283513SSascha Wildner sc = kmalloc(sizeof *sc, M_LED, M_WAITOK | M_ZERO);
299e9283513SSascha Wildner
300e9283513SSascha Wildner lockmgr(&led_lock2, LK_EXCLUSIVE);
301e9283513SSascha Wildner sc->name = kstrdup(name, M_LED);
302e9283513SSascha Wildner sc->unit = alloc_unr(led_unit);
303e9283513SSascha Wildner sc->private = priv;
304e9283513SSascha Wildner sc->func = func;
305e9283513SSascha Wildner sc->dev = make_dev(&led_ops, sc->unit,
306e9283513SSascha Wildner UID_ROOT, GID_WHEEL, 0600, "led/%s", name);
307e9283513SSascha Wildner lockmgr(&led_lock2, LK_RELEASE);
308e9283513SSascha Wildner
309e9283513SSascha Wildner lockmgr(&led_lock, LK_EXCLUSIVE);
310e9283513SSascha Wildner sc->dev->si_drv1 = sc;
311e9283513SSascha Wildner LIST_INSERT_HEAD(&led_list, sc, list);
312e9283513SSascha Wildner sc->func(sc->private, state != 0);
313e9283513SSascha Wildner lockmgr(&led_lock, LK_RELEASE);
314e9283513SSascha Wildner
315e9283513SSascha Wildner return (sc->dev);
316e9283513SSascha Wildner }
317e9283513SSascha Wildner
318e9283513SSascha Wildner void
led_destroy(struct cdev * dev)319e9283513SSascha Wildner led_destroy(struct cdev *dev)
320e9283513SSascha Wildner {
321e9283513SSascha Wildner struct ledsc *sc;
322e9283513SSascha Wildner
323e9283513SSascha Wildner lockmgr(&led_lock, LK_EXCLUSIVE);
324e9283513SSascha Wildner sc = dev->si_drv1;
325e9283513SSascha Wildner dev->si_drv1 = NULL;
326e9283513SSascha Wildner if (sc->ptr != NULL)
327e9283513SSascha Wildner blinkers--;
328e9283513SSascha Wildner LIST_REMOVE(sc, list);
329e9283513SSascha Wildner if (LIST_EMPTY(&led_list))
330e9283513SSascha Wildner callout_stop(&led_ch);
331e9283513SSascha Wildner lockmgr(&led_lock, LK_RELEASE);
332e9283513SSascha Wildner
333e9283513SSascha Wildner lockmgr(&led_lock2, LK_EXCLUSIVE);
334e9283513SSascha Wildner free_unr(led_unit, sc->unit);
335e9283513SSascha Wildner destroy_dev(dev);
336e9283513SSascha Wildner if (sc->spec != NULL)
337e9283513SSascha Wildner sbuf_delete(sc->spec);
338e9283513SSascha Wildner kfree(sc->name, M_LED);
339e9283513SSascha Wildner kfree(sc, M_LED);
340e9283513SSascha Wildner lockmgr(&led_lock2, LK_RELEASE);
341e9283513SSascha Wildner }
342e9283513SSascha Wildner
343f2c400e8SImre Vadász static int
led_drvinit(void)344f2c400e8SImre Vadász led_drvinit(void)
345e9283513SSascha Wildner {
346e9283513SSascha Wildner
347e9283513SSascha Wildner led_unit = new_unrhdr(0, INT_MAX, NULL);
348e9283513SSascha Wildner lockinit(&led_lock, "LED lock", 0, LK_CANRECURSE);
349e9283513SSascha Wildner lockinit(&led_lock2, "LED lock2", 0, LK_CANRECURSE);
350e9283513SSascha Wildner callout_init_mp(&led_ch);
351f2c400e8SImre Vadász return 0;
352e9283513SSascha Wildner }
353e9283513SSascha Wildner
354f2c400e8SImre Vadász static int
led_drvexit(void)355f2c400e8SImre Vadász led_drvexit(void)
356f2c400e8SImre Vadász {
357f2c400e8SImre Vadász int error = 0;
358f2c400e8SImre Vadász
359f2c400e8SImre Vadász lockmgr(&led_lock, LK_EXCLUSIVE);
360f2c400e8SImre Vadász /* A minimal sanity check, before unloading. */
361f2c400e8SImre Vadász if (!LIST_EMPTY(&led_list))
362f2c400e8SImre Vadász error = EINVAL;
363f2c400e8SImre Vadász lockmgr(&led_lock, LK_RELEASE);
364f2c400e8SImre Vadász if (error == 0) {
365*eb67213aSMatthew Dillon callout_cancel(&led_ch);
366f2c400e8SImre Vadász delete_unrhdr(led_unit);
367f2c400e8SImre Vadász lockuninit(&led_lock);
368f2c400e8SImre Vadász lockuninit(&led_lock2);
369f2c400e8SImre Vadász }
370f2c400e8SImre Vadász return error;
371f2c400e8SImre Vadász }
372f2c400e8SImre Vadász
373f2c400e8SImre Vadász static int
led_modevent(module_t mod,int type,void * unused)374f2c400e8SImre Vadász led_modevent(module_t mod, int type, void *unused)
375f2c400e8SImre Vadász {
376f2c400e8SImre Vadász int error;
377f2c400e8SImre Vadász
378f2c400e8SImre Vadász switch (type) {
379f2c400e8SImre Vadász case MOD_LOAD:
380f2c400e8SImre Vadász error = led_drvinit();
381f2c400e8SImre Vadász break;
382f2c400e8SImre Vadász case MOD_UNLOAD:
383f2c400e8SImre Vadász error = led_drvexit();
384f2c400e8SImre Vadász break;
385f2c400e8SImre Vadász default:
386f2c400e8SImre Vadász error = EINVAL;
387f2c400e8SImre Vadász break;
388f2c400e8SImre Vadász }
389f2c400e8SImre Vadász return error;
390f2c400e8SImre Vadász }
391f2c400e8SImre Vadász
392f2c400e8SImre Vadász static moduledata_t led_mod = {
393f2c400e8SImre Vadász "led",
394f2c400e8SImre Vadász led_modevent,
395f2c400e8SImre Vadász 0
396f2c400e8SImre Vadász };
397f2c400e8SImre Vadász DECLARE_MODULE(led, led_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
398f2c400e8SImre Vadász MODULE_VERSION(led, 1);
399