xref: /freebsd/sys/dev/led/led.c (revision d3ce8327194c0bcf742f2e03b5b0dc8f8cfe7f6b)
1c46def32SPoul-Henning Kamp /*-
2c46def32SPoul-Henning Kamp  * ----------------------------------------------------------------------------
3c46def32SPoul-Henning Kamp  * "THE BEER-WARE LICENSE" (Revision 42):
4c46def32SPoul-Henning Kamp  * <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
5c46def32SPoul-Henning Kamp  * can do whatever you want with this stuff. If we meet some day, and you think
6c46def32SPoul-Henning Kamp  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
7c46def32SPoul-Henning Kamp  * ----------------------------------------------------------------------------
8c46def32SPoul-Henning Kamp  *
9c46def32SPoul-Henning Kamp  */
10c46def32SPoul-Henning Kamp 
11c46def32SPoul-Henning Kamp #include <sys/cdefs.h>
12c46def32SPoul-Henning Kamp __FBSDID("$FreeBSD$");
13c46def32SPoul-Henning Kamp 
14c46def32SPoul-Henning Kamp #include <sys/param.h>
15c46def32SPoul-Henning Kamp #include <sys/conf.h>
16c46def32SPoul-Henning Kamp #include <sys/kernel.h>
17c46def32SPoul-Henning Kamp #include <sys/systm.h>
1806d425f9SEd Schouten #include <sys/limits.h>
19c46def32SPoul-Henning Kamp #include <sys/malloc.h>
20c46def32SPoul-Henning Kamp #include <sys/ctype.h>
21c46def32SPoul-Henning Kamp #include <sys/sbuf.h>
22c46def32SPoul-Henning Kamp #include <sys/queue.h>
23c46def32SPoul-Henning Kamp #include <dev/led/led.h>
24c46def32SPoul-Henning Kamp #include <sys/uio.h>
25b0a5fd8eSPoul-Henning Kamp #include <sys/sx.h>
26c46def32SPoul-Henning Kamp 
27c46def32SPoul-Henning Kamp struct ledsc {
28c46def32SPoul-Henning Kamp 	LIST_ENTRY(ledsc)	list;
29c46def32SPoul-Henning Kamp 	void			*private;
30b0a5fd8eSPoul-Henning Kamp 	int			unit;
31c46def32SPoul-Henning Kamp 	led_t			*func;
3289c9c53dSPoul-Henning Kamp 	struct cdev *dev;
33c46def32SPoul-Henning Kamp 	struct sbuf		*spec;
34c46def32SPoul-Henning Kamp 	char			*str;
35c46def32SPoul-Henning Kamp 	char			*ptr;
36c46def32SPoul-Henning Kamp 	int			count;
37b0a5fd8eSPoul-Henning Kamp 	time_t			last_second;
38c46def32SPoul-Henning Kamp };
39c46def32SPoul-Henning Kamp 
40b0a5fd8eSPoul-Henning Kamp static struct unrhdr *led_unit;
41c46def32SPoul-Henning Kamp static struct mtx led_mtx;
42b0a5fd8eSPoul-Henning Kamp static struct sx led_sx;
43c46def32SPoul-Henning Kamp static LIST_HEAD(, ledsc) led_list = LIST_HEAD_INITIALIZER(&led_list);
44b0a5fd8eSPoul-Henning Kamp static struct callout led_ch;
45c46def32SPoul-Henning Kamp 
46c711aea6SPoul-Henning Kamp static MALLOC_DEFINE(M_LED, "LED", "LED driver");
47c46def32SPoul-Henning Kamp 
48c46def32SPoul-Henning Kamp static void
49c46def32SPoul-Henning Kamp led_timeout(void *p)
50c46def32SPoul-Henning Kamp {
51c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
52c46def32SPoul-Henning Kamp 
53c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
54c46def32SPoul-Henning Kamp 	LIST_FOREACH(sc, &led_list, list) {
55c46def32SPoul-Henning Kamp 		if (sc->ptr == NULL)
56c46def32SPoul-Henning Kamp 			continue;
57c46def32SPoul-Henning Kamp 		if (sc->count > 0) {
58c46def32SPoul-Henning Kamp 			sc->count--;
59c46def32SPoul-Henning Kamp 			continue;
60c46def32SPoul-Henning Kamp 		}
6171f3747eSPoul-Henning Kamp 		if (*sc->ptr == '.') {
6271f3747eSPoul-Henning Kamp 			sc->ptr = NULL;
6371f3747eSPoul-Henning Kamp 			continue;
64b0a5fd8eSPoul-Henning Kamp 		} else if (*sc->ptr == 'U' || *sc->ptr == 'u') {
65b0a5fd8eSPoul-Henning Kamp 			if (sc->last_second == time_second)
66b0a5fd8eSPoul-Henning Kamp 				continue;
67b0a5fd8eSPoul-Henning Kamp 			sc->last_second = time_second;
68b0a5fd8eSPoul-Henning Kamp 			sc->func(sc->private, *sc->ptr == 'U');
6971f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'a' && *sc->ptr <= 'j') {
708a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 0);
71b0a5fd8eSPoul-Henning Kamp 			sc->count = (*sc->ptr & 0xf) - 1;
7271f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'A' && *sc->ptr <= 'J') {
738a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 1);
74b0a5fd8eSPoul-Henning Kamp 			sc->count = (*sc->ptr & 0xf) - 1;
7571f3747eSPoul-Henning Kamp 		}
768a1a55ecSPoul-Henning Kamp 		sc->ptr++;
778a1a55ecSPoul-Henning Kamp 		if (*sc->ptr == '\0')
78c46def32SPoul-Henning Kamp 			sc->ptr = sc->str;
79c46def32SPoul-Henning Kamp 	}
80c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
81b0a5fd8eSPoul-Henning Kamp 	callout_reset(&led_ch, hz / 10, led_timeout, p);
82c46def32SPoul-Henning Kamp 	return;
83c46def32SPoul-Henning Kamp }
84c46def32SPoul-Henning Kamp 
85c46def32SPoul-Henning Kamp static int
86b0a5fd8eSPoul-Henning Kamp led_state(struct cdev *dev, struct sbuf *sb, int state)
87b0a5fd8eSPoul-Henning Kamp {
88b0a5fd8eSPoul-Henning Kamp 	struct sbuf *sb2 = NULL;
89b0a5fd8eSPoul-Henning Kamp 	struct ledsc *sc;
90b0a5fd8eSPoul-Henning Kamp 
91b0a5fd8eSPoul-Henning Kamp 	mtx_lock(&led_mtx);
92b0a5fd8eSPoul-Henning Kamp 	sc = dev->si_drv1;
93b0a5fd8eSPoul-Henning Kamp 	if (sc != NULL) {
94b0a5fd8eSPoul-Henning Kamp 		sb2 = sc->spec;
95b0a5fd8eSPoul-Henning Kamp 		sc->spec = sb;
96b0a5fd8eSPoul-Henning Kamp 		if (sb != NULL) {
97b0a5fd8eSPoul-Henning Kamp 			sc->str = sbuf_data(sb);
98b0a5fd8eSPoul-Henning Kamp 			sc->ptr = sc->str;
99b0a5fd8eSPoul-Henning Kamp 		} else {
100b0a5fd8eSPoul-Henning Kamp 			sc->str = NULL;
101b0a5fd8eSPoul-Henning Kamp 			sc->ptr = NULL;
102b0a5fd8eSPoul-Henning Kamp 			sc->func(sc->private, state);
103b0a5fd8eSPoul-Henning Kamp 		}
104b0a5fd8eSPoul-Henning Kamp 		sc->count = 0;
105b0a5fd8eSPoul-Henning Kamp 	}
106b0a5fd8eSPoul-Henning Kamp 	mtx_unlock(&led_mtx);
107b0a5fd8eSPoul-Henning Kamp 	if (sb2 != NULL)
108b0a5fd8eSPoul-Henning Kamp 		sbuf_delete(sb2);
109b0a5fd8eSPoul-Henning Kamp 	if (sc == NULL)
110b0a5fd8eSPoul-Henning Kamp 		return (ENXIO);
111b0a5fd8eSPoul-Henning Kamp 	return(0);
112b0a5fd8eSPoul-Henning Kamp }
113b0a5fd8eSPoul-Henning Kamp 
114b0a5fd8eSPoul-Henning Kamp static int
11589c9c53dSPoul-Henning Kamp led_write(struct cdev *dev, struct uio *uio, int ioflag)
116c46def32SPoul-Henning Kamp {
117c46def32SPoul-Henning Kamp 	int error;
1188a1a55ecSPoul-Henning Kamp 	char *s, *s2;
119b0a5fd8eSPoul-Henning Kamp 	struct sbuf *sb = NULL;
120c46def32SPoul-Henning Kamp 	int i;
121c46def32SPoul-Henning Kamp 
122b0a5fd8eSPoul-Henning Kamp 	if (dev->si_drv1 == NULL)
123b0a5fd8eSPoul-Henning Kamp 		return (ENXIO);
124c46def32SPoul-Henning Kamp 
125c46def32SPoul-Henning Kamp 	if (uio->uio_resid > 512)
126c46def32SPoul-Henning Kamp 		return (EINVAL);
1278a1a55ecSPoul-Henning Kamp 	s2 = s = malloc(uio->uio_resid + 1, M_DEVBUF, M_WAITOK);
128c46def32SPoul-Henning Kamp 	s[uio->uio_resid] = '\0';
129c46def32SPoul-Henning Kamp 	error = uiomove(s, uio->uio_resid, uio);
130c46def32SPoul-Henning Kamp 	if (error) {
1318a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
132c46def32SPoul-Henning Kamp 		return (error);
133c46def32SPoul-Henning Kamp 	}
134c46def32SPoul-Henning Kamp 
135c46def32SPoul-Henning Kamp 	/*
136c46def32SPoul-Henning Kamp 	 * Handle "on" and "off" immediately so people can flash really
137c46def32SPoul-Henning Kamp 	 * fast from userland if they want to
138c46def32SPoul-Henning Kamp 	 */
139c46def32SPoul-Henning Kamp 	if (*s == '0' || *s == '1') {
140b0a5fd8eSPoul-Henning Kamp 		error = led_state(dev, NULL, *s & 1);
1418a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
142b0a5fd8eSPoul-Henning Kamp 		return(error);
143c46def32SPoul-Henning Kamp 	}
144c46def32SPoul-Henning Kamp 
1452616144eSDag-Erling Smørgrav 	sb = sbuf_new_auto();
146c46def32SPoul-Henning Kamp 	if (sb == NULL) {
1478a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
148c46def32SPoul-Henning Kamp 		return (ENOMEM);
149c46def32SPoul-Henning Kamp 	}
150c46def32SPoul-Henning Kamp 
151c46def32SPoul-Henning Kamp 	switch(s[0]) {
152c46def32SPoul-Henning Kamp 		/*
153c46def32SPoul-Henning Kamp 		 * Flash, default is 100msec/100msec.
154c46def32SPoul-Henning Kamp 		 * 'f2' sets 200msec/200msec etc.
155c46def32SPoul-Henning Kamp 		 */
156c46def32SPoul-Henning Kamp 		case 'f':
157c46def32SPoul-Henning Kamp 			if (s[1] >= '1' && s[1] <= '9')
158c46def32SPoul-Henning Kamp 				i = s[1] - '1';
159c46def32SPoul-Henning Kamp 			else
160c46def32SPoul-Henning Kamp 				i = 0;
1619491306aSPoul-Henning Kamp 			sbuf_printf(sb, "%c%c", 'A' + i, 'a' + i);
162c46def32SPoul-Henning Kamp 			break;
163c46def32SPoul-Henning Kamp 		/*
164c46def32SPoul-Henning Kamp 		 * Digits, flashes out numbers.
165c46def32SPoul-Henning Kamp 		 * 'd12' becomes -__________-_-______________________________
166c46def32SPoul-Henning Kamp 		 */
167c46def32SPoul-Henning Kamp 		case 'd':
168c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
169c46def32SPoul-Henning Kamp 				if (!isdigit(*s))
170c46def32SPoul-Henning Kamp 					continue;
171c46def32SPoul-Henning Kamp 				i = *s - '0';
172c46def32SPoul-Henning Kamp 				if (i == 0)
173c46def32SPoul-Henning Kamp 					i = 10;
174c46def32SPoul-Henning Kamp 				for (; i > 1; i--)
1759491306aSPoul-Henning Kamp 					sbuf_cat(sb, "Aa");
1769491306aSPoul-Henning Kamp 				sbuf_cat(sb, "Aj");
177c46def32SPoul-Henning Kamp 			}
1789491306aSPoul-Henning Kamp 			sbuf_cat(sb, "jj");
179c46def32SPoul-Henning Kamp 			break;
180c46def32SPoul-Henning Kamp 		/*
181c46def32SPoul-Henning Kamp 		 * String, roll your own.
1829491306aSPoul-Henning Kamp 		 * 'a-j' gives "off" for n/10 sec.
1839491306aSPoul-Henning Kamp 		 * 'A-J' gives "on" for n/10 sec.
184c46def32SPoul-Henning Kamp 		 * no delay before repeat
185c46def32SPoul-Henning Kamp 		 * 'sAaAbBa' becomes _-_--__-
186c46def32SPoul-Henning Kamp 		 */
187c46def32SPoul-Henning Kamp 		case 's':
188c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
18971f3747eSPoul-Henning Kamp 				if ((*s >= 'a' && *s <= 'j') ||
19071f3747eSPoul-Henning Kamp 				    (*s >= 'A' && *s <= 'J') ||
191b0a5fd8eSPoul-Henning Kamp 				    *s == 'U' || *s <= 'u' ||
19271f3747eSPoul-Henning Kamp 					*s == '.')
193c46def32SPoul-Henning Kamp 					sbuf_bcat(sb, s, 1);
194c46def32SPoul-Henning Kamp 			}
195c46def32SPoul-Henning Kamp 			break;
196c46def32SPoul-Henning Kamp 		/*
197c46def32SPoul-Henning Kamp 		 * Morse.
198c46def32SPoul-Henning Kamp 		 * '.' becomes _-
199c46def32SPoul-Henning Kamp 		 * '-' becomes _---
200c46def32SPoul-Henning Kamp 		 * ' ' becomes __
201c46def32SPoul-Henning Kamp 		 * '\n' becomes ____
202c46def32SPoul-Henning Kamp 		 * 1sec pause between repeats
203c46def32SPoul-Henning Kamp 		 * '... --- ...' -> _-_-_-___---_---_---___-_-_-__________
204c46def32SPoul-Henning Kamp 		 */
205c46def32SPoul-Henning Kamp 		case 'm':
206c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
207c46def32SPoul-Henning Kamp 				if (*s == '.')
2089491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aA");
209c46def32SPoul-Henning Kamp 				else if (*s == '-')
2109491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aC");
211c46def32SPoul-Henning Kamp 				else if (*s == ' ')
2129491306aSPoul-Henning Kamp 					sbuf_cat(sb, "b");
2138d334233SPoul-Henning Kamp 				else if (*s == '\n')
2149491306aSPoul-Henning Kamp 					sbuf_cat(sb, "d");
215c46def32SPoul-Henning Kamp 			}
2169491306aSPoul-Henning Kamp 			sbuf_cat(sb, "j");
217c46def32SPoul-Henning Kamp 			break;
218c46def32SPoul-Henning Kamp 		default:
2198a1a55ecSPoul-Henning Kamp 			sbuf_delete(sb);
2208a1a55ecSPoul-Henning Kamp 			free(s2, M_DEVBUF);
2218a1a55ecSPoul-Henning Kamp 			return (EINVAL);
222c46def32SPoul-Henning Kamp 	}
223c46def32SPoul-Henning Kamp 	sbuf_finish(sb);
2248a1a55ecSPoul-Henning Kamp 	free(s2, M_DEVBUF);
225c46def32SPoul-Henning Kamp 	if (sbuf_overflowed(sb)) {
226c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
227c46def32SPoul-Henning Kamp 		return (ENOMEM);
228c46def32SPoul-Henning Kamp 	}
229c46def32SPoul-Henning Kamp 	if (sbuf_len(sb) == 0) {
230c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
231c46def32SPoul-Henning Kamp 		return (0);
232c46def32SPoul-Henning Kamp 	}
233c46def32SPoul-Henning Kamp 
234b0a5fd8eSPoul-Henning Kamp 	return (led_state(dev, sb, 0));
235c46def32SPoul-Henning Kamp }
236c46def32SPoul-Henning Kamp 
237c46def32SPoul-Henning Kamp static struct cdevsw led_cdevsw = {
238dc08ffecSPoul-Henning Kamp 	.d_version =	D_VERSION,
239c46def32SPoul-Henning Kamp 	.d_write =	led_write,
240c46def32SPoul-Henning Kamp 	.d_name =	"LED",
241c46def32SPoul-Henning Kamp };
242c46def32SPoul-Henning Kamp 
24389c9c53dSPoul-Henning Kamp struct cdev *
244c46def32SPoul-Henning Kamp led_create(led_t *func, void *priv, char const *name)
245c46def32SPoul-Henning Kamp {
246ea60845dSPoul-Henning Kamp 
247ea60845dSPoul-Henning Kamp 	return (led_create_state(func, priv, name, 0));
248ea60845dSPoul-Henning Kamp }
249ea60845dSPoul-Henning Kamp struct cdev *
250ea60845dSPoul-Henning Kamp led_create_state(led_t *func, void *priv, char const *name, int state)
251ea60845dSPoul-Henning Kamp {
252c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
253c46def32SPoul-Henning Kamp 
254c46def32SPoul-Henning Kamp 	sc = malloc(sizeof *sc, M_LED, M_WAITOK | M_ZERO);
255b0a5fd8eSPoul-Henning Kamp 
256b0a5fd8eSPoul-Henning Kamp 	sx_xlock(&led_sx);
257b0a5fd8eSPoul-Henning Kamp 	sc->unit = alloc_unr(led_unit);
258c46def32SPoul-Henning Kamp 	sc->private = priv;
259c46def32SPoul-Henning Kamp 	sc->func = func;
260d3ce8327SEd Schouten 	sc->dev = make_dev(&led_cdevsw, sc->unit,
261b0a5fd8eSPoul-Henning Kamp 	    UID_ROOT, GID_WHEEL, 0600, "led/%s", name);
262b0a5fd8eSPoul-Henning Kamp 	sx_xunlock(&led_sx);
263b0a5fd8eSPoul-Henning Kamp 
264c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
265b0a5fd8eSPoul-Henning Kamp 	sc->dev->si_drv1 = sc;
266b0a5fd8eSPoul-Henning Kamp 	if (LIST_EMPTY(&led_list))
267b0a5fd8eSPoul-Henning Kamp 		callout_reset(&led_ch, hz / 10, led_timeout, NULL);
268c46def32SPoul-Henning Kamp 	LIST_INSERT_HEAD(&led_list, sc, list);
269ea60845dSPoul-Henning Kamp 	sc->func(sc->private, state != 0);
270c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
271b0a5fd8eSPoul-Henning Kamp 
272c46def32SPoul-Henning Kamp 	return (sc->dev);
273c46def32SPoul-Henning Kamp }
274c46def32SPoul-Henning Kamp 
275c46def32SPoul-Henning Kamp void
27689c9c53dSPoul-Henning Kamp led_destroy(struct cdev *dev)
277c46def32SPoul-Henning Kamp {
278c46def32SPoul-Henning Kamp 	struct ledsc *sc;
279c46def32SPoul-Henning Kamp 
280c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
281b0a5fd8eSPoul-Henning Kamp 	sc = dev->si_drv1;
282b0a5fd8eSPoul-Henning Kamp 	dev->si_drv1 = NULL;
283b0a5fd8eSPoul-Henning Kamp 
284c46def32SPoul-Henning Kamp 	LIST_REMOVE(sc, list);
285b0a5fd8eSPoul-Henning Kamp 	if (LIST_EMPTY(&led_list))
286b0a5fd8eSPoul-Henning Kamp 		callout_stop(&led_ch);
287c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
288b0a5fd8eSPoul-Henning Kamp 
289b0a5fd8eSPoul-Henning Kamp 	sx_xlock(&led_sx);
290b0a5fd8eSPoul-Henning Kamp 	free_unr(led_unit, sc->unit);
291b0a5fd8eSPoul-Henning Kamp 	destroy_dev(dev);
2927e31c3b7SPoul-Henning Kamp 	if (sc->spec != NULL)
293c46def32SPoul-Henning Kamp 		sbuf_delete(sc->spec);
294c46def32SPoul-Henning Kamp 	free(sc, M_LED);
295b0a5fd8eSPoul-Henning Kamp 	sx_xunlock(&led_sx);
296c46def32SPoul-Henning Kamp }
297b0a5fd8eSPoul-Henning Kamp 
298b0a5fd8eSPoul-Henning Kamp static void
299b0a5fd8eSPoul-Henning Kamp led_drvinit(void *unused)
300b0a5fd8eSPoul-Henning Kamp {
301b0a5fd8eSPoul-Henning Kamp 
30206d425f9SEd Schouten 	led_unit = new_unrhdr(0, INT_MAX, NULL);
303b0a5fd8eSPoul-Henning Kamp 	mtx_init(&led_mtx, "LED mtx", NULL, MTX_DEF);
304b0a5fd8eSPoul-Henning Kamp 	sx_init(&led_sx, "LED sx");
305b0a5fd8eSPoul-Henning Kamp 	callout_init(&led_ch, CALLOUT_MPSAFE);
306b0a5fd8eSPoul-Henning Kamp }
307b0a5fd8eSPoul-Henning Kamp 
308b0a5fd8eSPoul-Henning Kamp SYSINIT(leddev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, led_drvinit, NULL);
309