xref: /freebsd/sys/dev/led/led.c (revision b0a5fd8e7a144a1159bee1b0132e231b91e36e07)
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>
18c46def32SPoul-Henning Kamp #include <sys/malloc.h>
19c46def32SPoul-Henning Kamp #include <sys/ctype.h>
20c46def32SPoul-Henning Kamp #include <sys/sbuf.h>
21c46def32SPoul-Henning Kamp #include <sys/queue.h>
22c46def32SPoul-Henning Kamp #include <dev/led/led.h>
23c46def32SPoul-Henning Kamp #include <sys/uio.h>
24b0a5fd8eSPoul-Henning Kamp #include <sys/sx.h>
25c46def32SPoul-Henning Kamp 
26c46def32SPoul-Henning Kamp struct ledsc {
27c46def32SPoul-Henning Kamp 	LIST_ENTRY(ledsc)	list;
28c46def32SPoul-Henning Kamp 	void			*private;
29b0a5fd8eSPoul-Henning Kamp 	int			unit;
30c46def32SPoul-Henning Kamp 	led_t			*func;
3189c9c53dSPoul-Henning Kamp 	struct cdev *dev;
32c46def32SPoul-Henning Kamp 	struct sbuf		*spec;
33c46def32SPoul-Henning Kamp 	char			*str;
34c46def32SPoul-Henning Kamp 	char			*ptr;
35c46def32SPoul-Henning Kamp 	int			count;
36b0a5fd8eSPoul-Henning Kamp 	time_t			last_second;
37c46def32SPoul-Henning Kamp };
38c46def32SPoul-Henning Kamp 
39b0a5fd8eSPoul-Henning Kamp static struct unrhdr *led_unit;
40c46def32SPoul-Henning Kamp static struct mtx led_mtx;
41b0a5fd8eSPoul-Henning Kamp static struct sx led_sx;
42c46def32SPoul-Henning Kamp static LIST_HEAD(, ledsc) led_list = LIST_HEAD_INITIALIZER(&led_list);
43b0a5fd8eSPoul-Henning Kamp static struct callout led_ch;
44c46def32SPoul-Henning Kamp 
45c46def32SPoul-Henning Kamp MALLOC_DEFINE(M_LED, "LED", "LED driver");
46c46def32SPoul-Henning Kamp 
47c46def32SPoul-Henning Kamp static void
48c46def32SPoul-Henning Kamp led_timeout(void *p)
49c46def32SPoul-Henning Kamp {
50c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
51c46def32SPoul-Henning Kamp 
52c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
53c46def32SPoul-Henning Kamp 	LIST_FOREACH(sc, &led_list, list) {
54c46def32SPoul-Henning Kamp 		if (sc->ptr == NULL)
55c46def32SPoul-Henning Kamp 			continue;
56c46def32SPoul-Henning Kamp 		if (sc->count > 0) {
57c46def32SPoul-Henning Kamp 			sc->count--;
58c46def32SPoul-Henning Kamp 			continue;
59c46def32SPoul-Henning Kamp 		}
6071f3747eSPoul-Henning Kamp 		if (*sc->ptr == '.') {
6171f3747eSPoul-Henning Kamp 			sc->ptr = NULL;
6271f3747eSPoul-Henning Kamp 			continue;
63b0a5fd8eSPoul-Henning Kamp 		} else if (*sc->ptr == 'U' || *sc->ptr == 'u') {
64b0a5fd8eSPoul-Henning Kamp 			if (sc->last_second == time_second)
65b0a5fd8eSPoul-Henning Kamp 				continue;
66b0a5fd8eSPoul-Henning Kamp 			sc->last_second = time_second;
67b0a5fd8eSPoul-Henning Kamp 			sc->func(sc->private, *sc->ptr == 'U');
6871f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'a' && *sc->ptr <= 'j') {
698a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 0);
70b0a5fd8eSPoul-Henning Kamp 			sc->count = (*sc->ptr & 0xf) - 1;
7171f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'A' && *sc->ptr <= 'J') {
728a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 1);
73b0a5fd8eSPoul-Henning Kamp 			sc->count = (*sc->ptr & 0xf) - 1;
7471f3747eSPoul-Henning Kamp 		}
758a1a55ecSPoul-Henning Kamp 		sc->ptr++;
768a1a55ecSPoul-Henning Kamp 		if (*sc->ptr == '\0')
77c46def32SPoul-Henning Kamp 			sc->ptr = sc->str;
78c46def32SPoul-Henning Kamp 	}
79c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
80b0a5fd8eSPoul-Henning Kamp 	callout_reset(&led_ch, hz / 10, led_timeout, p);
81c46def32SPoul-Henning Kamp 	return;
82c46def32SPoul-Henning Kamp }
83c46def32SPoul-Henning Kamp 
84c46def32SPoul-Henning Kamp static int
85b0a5fd8eSPoul-Henning Kamp led_state(struct cdev *dev, struct sbuf *sb, int state)
86b0a5fd8eSPoul-Henning Kamp {
87b0a5fd8eSPoul-Henning Kamp 	struct sbuf *sb2 = NULL;
88b0a5fd8eSPoul-Henning Kamp 	struct ledsc *sc;
89b0a5fd8eSPoul-Henning Kamp 
90b0a5fd8eSPoul-Henning Kamp 	mtx_lock(&led_mtx);
91b0a5fd8eSPoul-Henning Kamp 	sc = dev->si_drv1;
92b0a5fd8eSPoul-Henning Kamp 	if (sc != NULL) {
93b0a5fd8eSPoul-Henning Kamp 		sb2 = sc->spec;
94b0a5fd8eSPoul-Henning Kamp 		sc->spec = sb;
95b0a5fd8eSPoul-Henning Kamp 		if (sb != NULL) {
96b0a5fd8eSPoul-Henning Kamp 			sc->str = sbuf_data(sb);
97b0a5fd8eSPoul-Henning Kamp 			sc->ptr = sc->str;
98b0a5fd8eSPoul-Henning Kamp 		} else {
99b0a5fd8eSPoul-Henning Kamp 			sc->str = NULL;
100b0a5fd8eSPoul-Henning Kamp 			sc->ptr = NULL;
101b0a5fd8eSPoul-Henning Kamp 			sc->func(sc->private, state);
102b0a5fd8eSPoul-Henning Kamp 		}
103b0a5fd8eSPoul-Henning Kamp 		sc->count = 0;
104b0a5fd8eSPoul-Henning Kamp 	}
105b0a5fd8eSPoul-Henning Kamp 	mtx_unlock(&led_mtx);
106b0a5fd8eSPoul-Henning Kamp 	if (sb2 != NULL)
107b0a5fd8eSPoul-Henning Kamp 		sbuf_delete(sb2);
108b0a5fd8eSPoul-Henning Kamp 	if (sc == NULL)
109b0a5fd8eSPoul-Henning Kamp 		return (ENXIO);
110b0a5fd8eSPoul-Henning Kamp 	return(0);
111b0a5fd8eSPoul-Henning Kamp }
112b0a5fd8eSPoul-Henning Kamp 
113b0a5fd8eSPoul-Henning Kamp static int
11489c9c53dSPoul-Henning Kamp led_write(struct cdev *dev, struct uio *uio, int ioflag)
115c46def32SPoul-Henning Kamp {
116c46def32SPoul-Henning Kamp 	int error;
1178a1a55ecSPoul-Henning Kamp 	char *s, *s2;
118b0a5fd8eSPoul-Henning Kamp 	struct sbuf *sb = NULL;
119c46def32SPoul-Henning Kamp 	int i;
120c46def32SPoul-Henning Kamp 
121b0a5fd8eSPoul-Henning Kamp 	if (dev->si_drv1 == NULL)
122b0a5fd8eSPoul-Henning Kamp 		return (ENXIO);
123c46def32SPoul-Henning Kamp 
124c46def32SPoul-Henning Kamp 	if (uio->uio_resid > 512)
125c46def32SPoul-Henning Kamp 		return (EINVAL);
1268a1a55ecSPoul-Henning Kamp 	s2 = s = malloc(uio->uio_resid + 1, M_DEVBUF, M_WAITOK);
127c46def32SPoul-Henning Kamp 	s[uio->uio_resid] = '\0';
128c46def32SPoul-Henning Kamp 	error = uiomove(s, uio->uio_resid, uio);
129c46def32SPoul-Henning Kamp 	if (error) {
1308a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
131c46def32SPoul-Henning Kamp 		return (error);
132c46def32SPoul-Henning Kamp 	}
133c46def32SPoul-Henning Kamp 
134c46def32SPoul-Henning Kamp 	/*
135c46def32SPoul-Henning Kamp 	 * Handle "on" and "off" immediately so people can flash really
136c46def32SPoul-Henning Kamp 	 * fast from userland if they want to
137c46def32SPoul-Henning Kamp 	 */
138c46def32SPoul-Henning Kamp 	if (*s == '0' || *s == '1') {
139b0a5fd8eSPoul-Henning Kamp 		error = led_state(dev, NULL, *s & 1);
1408a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
141b0a5fd8eSPoul-Henning Kamp 		return(error);
142c46def32SPoul-Henning Kamp 	}
143c46def32SPoul-Henning Kamp 
144c46def32SPoul-Henning Kamp 	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
145c46def32SPoul-Henning Kamp 	if (sb == NULL) {
1468a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
147c46def32SPoul-Henning Kamp 		return (ENOMEM);
148c46def32SPoul-Henning Kamp 	}
149c46def32SPoul-Henning Kamp 
150c46def32SPoul-Henning Kamp 	switch(s[0]) {
151c46def32SPoul-Henning Kamp 		/*
152c46def32SPoul-Henning Kamp 		 * Flash, default is 100msec/100msec.
153c46def32SPoul-Henning Kamp 		 * 'f2' sets 200msec/200msec etc.
154c46def32SPoul-Henning Kamp 		 */
155c46def32SPoul-Henning Kamp 		case 'f':
156c46def32SPoul-Henning Kamp 			if (s[1] >= '1' && s[1] <= '9')
157c46def32SPoul-Henning Kamp 				i = s[1] - '1';
158c46def32SPoul-Henning Kamp 			else
159c46def32SPoul-Henning Kamp 				i = 0;
1609491306aSPoul-Henning Kamp 			sbuf_printf(sb, "%c%c", 'A' + i, 'a' + i);
161c46def32SPoul-Henning Kamp 			break;
162c46def32SPoul-Henning Kamp 		/*
163c46def32SPoul-Henning Kamp 		 * Digits, flashes out numbers.
164c46def32SPoul-Henning Kamp 		 * 'd12' becomes -__________-_-______________________________
165c46def32SPoul-Henning Kamp 		 */
166c46def32SPoul-Henning Kamp 		case 'd':
167c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
168c46def32SPoul-Henning Kamp 				if (!isdigit(*s))
169c46def32SPoul-Henning Kamp 					continue;
170c46def32SPoul-Henning Kamp 				i = *s - '0';
171c46def32SPoul-Henning Kamp 				if (i == 0)
172c46def32SPoul-Henning Kamp 					i = 10;
173c46def32SPoul-Henning Kamp 				for (; i > 1; i--)
1749491306aSPoul-Henning Kamp 					sbuf_cat(sb, "Aa");
1759491306aSPoul-Henning Kamp 				sbuf_cat(sb, "Aj");
176c46def32SPoul-Henning Kamp 			}
1779491306aSPoul-Henning Kamp 			sbuf_cat(sb, "jj");
178c46def32SPoul-Henning Kamp 			break;
179c46def32SPoul-Henning Kamp 		/*
180c46def32SPoul-Henning Kamp 		 * String, roll your own.
1819491306aSPoul-Henning Kamp 		 * 'a-j' gives "off" for n/10 sec.
1829491306aSPoul-Henning Kamp 		 * 'A-J' gives "on" for n/10 sec.
183c46def32SPoul-Henning Kamp 		 * no delay before repeat
184c46def32SPoul-Henning Kamp 		 * 'sAaAbBa' becomes _-_--__-
185c46def32SPoul-Henning Kamp 		 */
186c46def32SPoul-Henning Kamp 		case 's':
187c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
18871f3747eSPoul-Henning Kamp 				if ((*s >= 'a' && *s <= 'j') ||
18971f3747eSPoul-Henning Kamp 				    (*s >= 'A' && *s <= 'J') ||
190b0a5fd8eSPoul-Henning Kamp 				    *s == 'U' || *s <= 'u' ||
19171f3747eSPoul-Henning Kamp 					*s == '.')
192c46def32SPoul-Henning Kamp 					sbuf_bcat(sb, s, 1);
193c46def32SPoul-Henning Kamp 			}
194c46def32SPoul-Henning Kamp 			break;
195c46def32SPoul-Henning Kamp 		/*
196c46def32SPoul-Henning Kamp 		 * Morse.
197c46def32SPoul-Henning Kamp 		 * '.' becomes _-
198c46def32SPoul-Henning Kamp 		 * '-' becomes _---
199c46def32SPoul-Henning Kamp 		 * ' ' becomes __
200c46def32SPoul-Henning Kamp 		 * '\n' becomes ____
201c46def32SPoul-Henning Kamp 		 * 1sec pause between repeats
202c46def32SPoul-Henning Kamp 		 * '... --- ...' -> _-_-_-___---_---_---___-_-_-__________
203c46def32SPoul-Henning Kamp 		 */
204c46def32SPoul-Henning Kamp 		case 'm':
205c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
206c46def32SPoul-Henning Kamp 				if (*s == '.')
2079491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aA");
208c46def32SPoul-Henning Kamp 				else if (*s == '-')
2099491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aC");
210c46def32SPoul-Henning Kamp 				else if (*s == ' ')
2119491306aSPoul-Henning Kamp 					sbuf_cat(sb, "b");
2128d334233SPoul-Henning Kamp 				else if (*s == '\n')
2139491306aSPoul-Henning Kamp 					sbuf_cat(sb, "d");
214c46def32SPoul-Henning Kamp 			}
2159491306aSPoul-Henning Kamp 			sbuf_cat(sb, "j");
216c46def32SPoul-Henning Kamp 			break;
217c46def32SPoul-Henning Kamp 		default:
2188a1a55ecSPoul-Henning Kamp 			sbuf_delete(sb);
2198a1a55ecSPoul-Henning Kamp 			free(s2, M_DEVBUF);
2208a1a55ecSPoul-Henning Kamp 			return (EINVAL);
221c46def32SPoul-Henning Kamp 	}
222c46def32SPoul-Henning Kamp 	sbuf_finish(sb);
2238a1a55ecSPoul-Henning Kamp 	free(s2, M_DEVBUF);
224c46def32SPoul-Henning Kamp 	if (sbuf_overflowed(sb)) {
225c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
226c46def32SPoul-Henning Kamp 		return (ENOMEM);
227c46def32SPoul-Henning Kamp 	}
228c46def32SPoul-Henning Kamp 	if (sbuf_len(sb) == 0) {
229c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
230c46def32SPoul-Henning Kamp 		return (0);
231c46def32SPoul-Henning Kamp 	}
232c46def32SPoul-Henning Kamp 
233b0a5fd8eSPoul-Henning Kamp 	return (led_state(dev, sb, 0));
234c46def32SPoul-Henning Kamp }
235c46def32SPoul-Henning Kamp 
236c46def32SPoul-Henning Kamp static struct cdevsw led_cdevsw = {
237dc08ffecSPoul-Henning Kamp 	.d_version =	D_VERSION,
238c46def32SPoul-Henning Kamp 	.d_write =	led_write,
239c46def32SPoul-Henning Kamp 	.d_name =	"LED",
240c46def32SPoul-Henning Kamp };
241c46def32SPoul-Henning Kamp 
24289c9c53dSPoul-Henning Kamp struct cdev *
243c46def32SPoul-Henning Kamp led_create(led_t *func, void *priv, char const *name)
244c46def32SPoul-Henning Kamp {
245c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
246c46def32SPoul-Henning Kamp 
247c46def32SPoul-Henning Kamp 	sc = malloc(sizeof *sc, M_LED, M_WAITOK | M_ZERO);
248b0a5fd8eSPoul-Henning Kamp 
249b0a5fd8eSPoul-Henning Kamp 	sx_xlock(&led_sx);
250b0a5fd8eSPoul-Henning Kamp 	sc->unit = alloc_unr(led_unit);
251c46def32SPoul-Henning Kamp 	sc->private = priv;
252c46def32SPoul-Henning Kamp 	sc->func = func;
253b0a5fd8eSPoul-Henning Kamp 	sc->dev = make_dev(&led_cdevsw, unit2minor(sc->unit),
254b0a5fd8eSPoul-Henning Kamp 	    UID_ROOT, GID_WHEEL, 0600, "led/%s", name);
255b0a5fd8eSPoul-Henning Kamp 	sx_xunlock(&led_sx);
256b0a5fd8eSPoul-Henning Kamp 
257c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
258b0a5fd8eSPoul-Henning Kamp 	sc->dev->si_drv1 = sc;
259b0a5fd8eSPoul-Henning Kamp 	if (LIST_EMPTY(&led_list))
260b0a5fd8eSPoul-Henning Kamp 		callout_reset(&led_ch, hz / 10, led_timeout, NULL);
261c46def32SPoul-Henning Kamp 	LIST_INSERT_HEAD(&led_list, sc, list);
26271f3747eSPoul-Henning Kamp 	sc->func(sc->private, 0);
263c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
264b0a5fd8eSPoul-Henning Kamp 
265c46def32SPoul-Henning Kamp 	return (sc->dev);
266c46def32SPoul-Henning Kamp }
267c46def32SPoul-Henning Kamp 
268c46def32SPoul-Henning Kamp void
26989c9c53dSPoul-Henning Kamp led_destroy(struct cdev *dev)
270c46def32SPoul-Henning Kamp {
271c46def32SPoul-Henning Kamp 	struct ledsc *sc;
272c46def32SPoul-Henning Kamp 
273c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
274b0a5fd8eSPoul-Henning Kamp 	sc = dev->si_drv1;
275b0a5fd8eSPoul-Henning Kamp 	dev->si_drv1 = NULL;
276b0a5fd8eSPoul-Henning Kamp 
277c46def32SPoul-Henning Kamp 	LIST_REMOVE(sc, list);
278b0a5fd8eSPoul-Henning Kamp 	if (LIST_EMPTY(&led_list))
279b0a5fd8eSPoul-Henning Kamp 		callout_stop(&led_ch);
280c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
281b0a5fd8eSPoul-Henning Kamp 
282b0a5fd8eSPoul-Henning Kamp 	sx_xlock(&led_sx);
283b0a5fd8eSPoul-Henning Kamp 	free_unr(led_unit, sc->unit);
284b0a5fd8eSPoul-Henning Kamp 	destroy_dev(dev);
2857e31c3b7SPoul-Henning Kamp 	if (sc->spec != NULL)
286c46def32SPoul-Henning Kamp 		sbuf_delete(sc->spec);
287c46def32SPoul-Henning Kamp 	free(sc, M_LED);
288b0a5fd8eSPoul-Henning Kamp 	sx_xunlock(&led_sx);
289c46def32SPoul-Henning Kamp }
290b0a5fd8eSPoul-Henning Kamp 
291b0a5fd8eSPoul-Henning Kamp static void
292b0a5fd8eSPoul-Henning Kamp led_drvinit(void *unused)
293b0a5fd8eSPoul-Henning Kamp {
294b0a5fd8eSPoul-Henning Kamp 
295b0a5fd8eSPoul-Henning Kamp 	led_unit = new_unrhdr(0, minor2unit(MAXMINOR));
296b0a5fd8eSPoul-Henning Kamp 	mtx_init(&led_mtx, "LED mtx", NULL, MTX_DEF);
297b0a5fd8eSPoul-Henning Kamp 	sx_init(&led_sx, "LED sx");
298b0a5fd8eSPoul-Henning Kamp 	callout_init(&led_ch, CALLOUT_MPSAFE);
299b0a5fd8eSPoul-Henning Kamp }
300b0a5fd8eSPoul-Henning Kamp 
301b0a5fd8eSPoul-Henning Kamp SYSINIT(leddev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, led_drvinit, NULL);
302