xref: /freebsd/sys/dev/led/led.c (revision 89c9c53da05197f657dfe8e0bdda6941a2e9a0d4)
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>
24c46def32SPoul-Henning Kamp 
25c46def32SPoul-Henning Kamp struct ledsc {
26c46def32SPoul-Henning Kamp 	LIST_ENTRY(ledsc)	list;
27c46def32SPoul-Henning Kamp 	void			*private;
28c46def32SPoul-Henning Kamp 	led_t			*func;
2989c9c53dSPoul-Henning Kamp 	struct cdev *dev;
30c46def32SPoul-Henning Kamp 	struct sbuf		*spec;
31c46def32SPoul-Henning Kamp 	char			*str;
32c46def32SPoul-Henning Kamp 	char			*ptr;
33c46def32SPoul-Henning Kamp 	int			count;
34c46def32SPoul-Henning Kamp };
35c46def32SPoul-Henning Kamp 
36c46def32SPoul-Henning Kamp static unsigned next_minor;
37c46def32SPoul-Henning Kamp static struct mtx led_mtx;
38c46def32SPoul-Henning Kamp static LIST_HEAD(, ledsc) led_list = LIST_HEAD_INITIALIZER(&led_list);
39c46def32SPoul-Henning Kamp 
40c46def32SPoul-Henning Kamp MALLOC_DEFINE(M_LED, "LED", "LED driver");
41c46def32SPoul-Henning Kamp 
42c46def32SPoul-Henning Kamp static void
43c46def32SPoul-Henning Kamp led_timeout(void *p)
44c46def32SPoul-Henning Kamp {
45c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
46c46def32SPoul-Henning Kamp 
47c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
48c46def32SPoul-Henning Kamp 	LIST_FOREACH(sc, &led_list, list) {
49c46def32SPoul-Henning Kamp 		if (sc->ptr == NULL)
50c46def32SPoul-Henning Kamp 			continue;
51c46def32SPoul-Henning Kamp 		if (sc->count > 0) {
52c46def32SPoul-Henning Kamp 			sc->count--;
53c46def32SPoul-Henning Kamp 			continue;
54c46def32SPoul-Henning Kamp 		}
5571f3747eSPoul-Henning Kamp 		if (*sc->ptr == '.') {
5671f3747eSPoul-Henning Kamp 			sc->ptr = NULL;
5771f3747eSPoul-Henning Kamp 			continue;
5871f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'a' && *sc->ptr <= 'j') {
598a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 0);
6071f3747eSPoul-Henning Kamp 		} else if (*sc->ptr >= 'A' && *sc->ptr <= 'J') {
618a1a55ecSPoul-Henning Kamp 			sc->func(sc->private, 1);
6271f3747eSPoul-Henning Kamp 		}
638a1a55ecSPoul-Henning Kamp 		sc->count = *sc->ptr & 0xf;
64675d58e8SPoul-Henning Kamp 		sc->count--;
658a1a55ecSPoul-Henning Kamp 		sc->ptr++;
668a1a55ecSPoul-Henning Kamp 		if (*sc->ptr == '\0')
67c46def32SPoul-Henning Kamp 			sc->ptr = sc->str;
68c46def32SPoul-Henning Kamp 	}
69c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
70c46def32SPoul-Henning Kamp 	timeout(led_timeout, p, hz / 10);
71c46def32SPoul-Henning Kamp 	return;
72c46def32SPoul-Henning Kamp }
73c46def32SPoul-Henning Kamp 
74c46def32SPoul-Henning Kamp static int
7589c9c53dSPoul-Henning Kamp led_write(struct cdev *dev, struct uio *uio, int ioflag)
76c46def32SPoul-Henning Kamp {
77c46def32SPoul-Henning Kamp 	int error;
788a1a55ecSPoul-Henning Kamp 	char *s, *s2;
79c46def32SPoul-Henning Kamp 	struct ledsc *sc;
80c46def32SPoul-Henning Kamp 	struct sbuf *sb;
81c46def32SPoul-Henning Kamp 	struct sbuf *sb2;
82c46def32SPoul-Henning Kamp 	int i;
83c46def32SPoul-Henning Kamp 
84c46def32SPoul-Henning Kamp 	sc = dev->si_drv1;
85c46def32SPoul-Henning Kamp 
86c46def32SPoul-Henning Kamp 	if (uio->uio_resid > 512)
87c46def32SPoul-Henning Kamp 		return (EINVAL);
888a1a55ecSPoul-Henning Kamp 	s2 = s = malloc(uio->uio_resid + 1, M_DEVBUF, M_WAITOK);
89c46def32SPoul-Henning Kamp 	if (s == NULL)
90c46def32SPoul-Henning Kamp 		return (ENOMEM);
91c46def32SPoul-Henning Kamp 	s[uio->uio_resid] = '\0';
92c46def32SPoul-Henning Kamp 	error = uiomove(s, uio->uio_resid, uio);
93c46def32SPoul-Henning Kamp 	if (error) {
948a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
95c46def32SPoul-Henning Kamp 		return (error);
96c46def32SPoul-Henning Kamp 	}
97c46def32SPoul-Henning Kamp 
98c46def32SPoul-Henning Kamp 	/*
99c46def32SPoul-Henning Kamp 	 * Handle "on" and "off" immediately so people can flash really
100c46def32SPoul-Henning Kamp 	 * fast from userland if they want to
101c46def32SPoul-Henning Kamp 	 */
102c46def32SPoul-Henning Kamp 	if (*s == '0' || *s == '1') {
103c46def32SPoul-Henning Kamp 		mtx_lock(&led_mtx);
104c46def32SPoul-Henning Kamp 		sb2 = sc->spec;
105c46def32SPoul-Henning Kamp 		sc->spec = NULL;
106c46def32SPoul-Henning Kamp 		sc->str = NULL;
107c46def32SPoul-Henning Kamp 		sc->ptr = NULL;
108c46def32SPoul-Henning Kamp 		sc->count = 0;
109c46def32SPoul-Henning Kamp 		sc->func(sc->private, *s & 1);
110c46def32SPoul-Henning Kamp 		mtx_unlock(&led_mtx);
111c46def32SPoul-Henning Kamp 		if (sb2 != NULL)
112c46def32SPoul-Henning Kamp 			sbuf_delete(sb2);
1138a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
114c46def32SPoul-Henning Kamp 		return(0);
115c46def32SPoul-Henning Kamp 	}
116c46def32SPoul-Henning Kamp 
117c46def32SPoul-Henning Kamp 	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
118c46def32SPoul-Henning Kamp 	if (sb == NULL) {
1198a1a55ecSPoul-Henning Kamp 		free(s2, M_DEVBUF);
120c46def32SPoul-Henning Kamp 		return (ENOMEM);
121c46def32SPoul-Henning Kamp 	}
122c46def32SPoul-Henning Kamp 
123c46def32SPoul-Henning Kamp 	switch(s[0]) {
124c46def32SPoul-Henning Kamp 		/*
125c46def32SPoul-Henning Kamp 		 * Flash, default is 100msec/100msec.
126c46def32SPoul-Henning Kamp 		 * 'f2' sets 200msec/200msec etc.
127c46def32SPoul-Henning Kamp 		 */
128c46def32SPoul-Henning Kamp 		case 'f':
129c46def32SPoul-Henning Kamp 			if (s[1] >= '1' && s[1] <= '9')
130c46def32SPoul-Henning Kamp 				i = s[1] - '1';
131c46def32SPoul-Henning Kamp 			else
132c46def32SPoul-Henning Kamp 				i = 0;
1339491306aSPoul-Henning Kamp 			sbuf_printf(sb, "%c%c", 'A' + i, 'a' + i);
134c46def32SPoul-Henning Kamp 			break;
135c46def32SPoul-Henning Kamp 		/*
136c46def32SPoul-Henning Kamp 		 * Digits, flashes out numbers.
137c46def32SPoul-Henning Kamp 		 * 'd12' becomes -__________-_-______________________________
138c46def32SPoul-Henning Kamp 		 */
139c46def32SPoul-Henning Kamp 		case 'd':
140c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
141c46def32SPoul-Henning Kamp 				if (!isdigit(*s))
142c46def32SPoul-Henning Kamp 					continue;
143c46def32SPoul-Henning Kamp 				i = *s - '0';
144c46def32SPoul-Henning Kamp 				if (i == 0)
145c46def32SPoul-Henning Kamp 					i = 10;
146c46def32SPoul-Henning Kamp 				for (; i > 1; i--)
1479491306aSPoul-Henning Kamp 					sbuf_cat(sb, "Aa");
1489491306aSPoul-Henning Kamp 				sbuf_cat(sb, "Aj");
149c46def32SPoul-Henning Kamp 			}
1509491306aSPoul-Henning Kamp 			sbuf_cat(sb, "jj");
151c46def32SPoul-Henning Kamp 			break;
152c46def32SPoul-Henning Kamp 		/*
153c46def32SPoul-Henning Kamp 		 * String, roll your own.
1549491306aSPoul-Henning Kamp 		 * 'a-j' gives "off" for n/10 sec.
1559491306aSPoul-Henning Kamp 		 * 'A-J' gives "on" for n/10 sec.
156c46def32SPoul-Henning Kamp 		 * no delay before repeat
157c46def32SPoul-Henning Kamp 		 * 'sAaAbBa' becomes _-_--__-
158c46def32SPoul-Henning Kamp 		 */
159c46def32SPoul-Henning Kamp 		case 's':
160c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
16171f3747eSPoul-Henning Kamp 				if ((*s >= 'a' && *s <= 'j') ||
16271f3747eSPoul-Henning Kamp 				    (*s >= 'A' && *s <= 'J') ||
16371f3747eSPoul-Henning Kamp 					*s == '.')
164c46def32SPoul-Henning Kamp 					sbuf_bcat(sb, s, 1);
165c46def32SPoul-Henning Kamp 			}
166c46def32SPoul-Henning Kamp 			break;
167c46def32SPoul-Henning Kamp 		/*
168c46def32SPoul-Henning Kamp 		 * Morse.
169c46def32SPoul-Henning Kamp 		 * '.' becomes _-
170c46def32SPoul-Henning Kamp 		 * '-' becomes _---
171c46def32SPoul-Henning Kamp 		 * ' ' becomes __
172c46def32SPoul-Henning Kamp 		 * '\n' becomes ____
173c46def32SPoul-Henning Kamp 		 * 1sec pause between repeats
174c46def32SPoul-Henning Kamp 		 * '... --- ...' -> _-_-_-___---_---_---___-_-_-__________
175c46def32SPoul-Henning Kamp 		 */
176c46def32SPoul-Henning Kamp 		case 'm':
177c46def32SPoul-Henning Kamp 			for(s++; *s; s++) {
178c46def32SPoul-Henning Kamp 				if (*s == '.')
1799491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aA");
180c46def32SPoul-Henning Kamp 				else if (*s == '-')
1819491306aSPoul-Henning Kamp 					sbuf_cat(sb, "aC");
182c46def32SPoul-Henning Kamp 				else if (*s == ' ')
1839491306aSPoul-Henning Kamp 					sbuf_cat(sb, "b");
1848d334233SPoul-Henning Kamp 				else if (*s == '\n')
1859491306aSPoul-Henning Kamp 					sbuf_cat(sb, "d");
186c46def32SPoul-Henning Kamp 			}
1879491306aSPoul-Henning Kamp 			sbuf_cat(sb, "j");
188c46def32SPoul-Henning Kamp 			break;
189c46def32SPoul-Henning Kamp 		default:
1908a1a55ecSPoul-Henning Kamp 			sbuf_delete(sb);
1918a1a55ecSPoul-Henning Kamp 			free(s2, M_DEVBUF);
1928a1a55ecSPoul-Henning Kamp 			return (EINVAL);
193c46def32SPoul-Henning Kamp 	}
194c46def32SPoul-Henning Kamp 	sbuf_finish(sb);
1958a1a55ecSPoul-Henning Kamp 	free(s2, M_DEVBUF);
196c46def32SPoul-Henning Kamp 	if (sbuf_overflowed(sb)) {
197c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
198c46def32SPoul-Henning Kamp 		return (ENOMEM);
199c46def32SPoul-Henning Kamp 	}
200c46def32SPoul-Henning Kamp 	if (sbuf_len(sb) == 0) {
201c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
202c46def32SPoul-Henning Kamp 		return (0);
203c46def32SPoul-Henning Kamp 	}
204c46def32SPoul-Henning Kamp 
205c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
206c46def32SPoul-Henning Kamp 	sb2 = sc->spec;
207c46def32SPoul-Henning Kamp 	sc->spec = sb;
208c46def32SPoul-Henning Kamp 	sc->str = sbuf_data(sb);
209c46def32SPoul-Henning Kamp 	sc->ptr = sc->str;
210c46def32SPoul-Henning Kamp 	sc->count = 0;
211c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
212c46def32SPoul-Henning Kamp 	if (sb2 != NULL)
213c46def32SPoul-Henning Kamp 		sbuf_delete(sb2);
214c46def32SPoul-Henning Kamp 	return(0);
215c46def32SPoul-Henning Kamp }
216c46def32SPoul-Henning Kamp 
217c46def32SPoul-Henning Kamp static struct cdevsw led_cdevsw = {
218dc08ffecSPoul-Henning Kamp 	.d_version =	D_VERSION,
219dc08ffecSPoul-Henning Kamp 	.d_flags =	D_NEEDGIANT,
220c46def32SPoul-Henning Kamp 	.d_write =	led_write,
221c46def32SPoul-Henning Kamp 	.d_name =	"LED",
222c46def32SPoul-Henning Kamp };
223c46def32SPoul-Henning Kamp 
22489c9c53dSPoul-Henning Kamp struct cdev *
225c46def32SPoul-Henning Kamp led_create(led_t *func, void *priv, char const *name)
226c46def32SPoul-Henning Kamp {
227c46def32SPoul-Henning Kamp 	struct ledsc	*sc;
228c46def32SPoul-Henning Kamp 	struct sbuf *sb;
229c46def32SPoul-Henning Kamp 
230c46def32SPoul-Henning Kamp 	if (next_minor == 0) {
231b01a6206SDon Lewis 		mtx_init(&led_mtx, "LED mtx", NULL, MTX_DEF);
232c46def32SPoul-Henning Kamp 		timeout(led_timeout, NULL, hz / 10);
233c46def32SPoul-Henning Kamp 	}
234c46def32SPoul-Henning Kamp 
235c46def32SPoul-Henning Kamp 	sb = sbuf_new(NULL, NULL, SPECNAMELEN, SBUF_FIXEDLEN);
236c46def32SPoul-Henning Kamp 	if (sb == NULL)
237c46def32SPoul-Henning Kamp 		return (NODEV);
238c46def32SPoul-Henning Kamp 	sbuf_cpy(sb, "led/");
239c46def32SPoul-Henning Kamp 	sbuf_cat(sb, name);
240c46def32SPoul-Henning Kamp 	sbuf_finish(sb);
241c46def32SPoul-Henning Kamp 	if (sbuf_overflowed(sb)) {
242c46def32SPoul-Henning Kamp 		sbuf_delete(sb);
243c46def32SPoul-Henning Kamp 		return (NODEV);
244c46def32SPoul-Henning Kamp 	}
245c46def32SPoul-Henning Kamp 
246c46def32SPoul-Henning Kamp 	sc = malloc(sizeof *sc, M_LED, M_WAITOK | M_ZERO);
247c46def32SPoul-Henning Kamp 	sc->private = priv;
248c46def32SPoul-Henning Kamp 	sc->func = func;
249c46def32SPoul-Henning Kamp 	sc->dev = make_dev(&led_cdevsw, unit2minor(next_minor),
250c46def32SPoul-Henning Kamp 	    UID_ROOT, GID_WHEEL, 0600, sbuf_data(sb));
251c46def32SPoul-Henning Kamp 	sc->dev->si_drv1 = sc;
252c46def32SPoul-Henning Kamp 	next_minor++;
253c46def32SPoul-Henning Kamp 	sbuf_delete(sb);
254c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
255c46def32SPoul-Henning Kamp 	LIST_INSERT_HEAD(&led_list, sc, list);
25671f3747eSPoul-Henning Kamp 	sc->func(sc->private, 0);
257c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
258c46def32SPoul-Henning Kamp 	return (sc->dev);
259c46def32SPoul-Henning Kamp }
260c46def32SPoul-Henning Kamp 
261c46def32SPoul-Henning Kamp void
26289c9c53dSPoul-Henning Kamp led_destroy(struct cdev *dev)
263c46def32SPoul-Henning Kamp {
264c46def32SPoul-Henning Kamp 	struct ledsc *sc;
265c46def32SPoul-Henning Kamp 
266c46def32SPoul-Henning Kamp 	sc = dev->si_drv1;
267c46def32SPoul-Henning Kamp 	mtx_lock(&led_mtx);
268c46def32SPoul-Henning Kamp 	LIST_REMOVE(sc, list);
269c46def32SPoul-Henning Kamp 	mtx_unlock(&led_mtx);
2707e31c3b7SPoul-Henning Kamp 	if (sc->spec != NULL)
271c46def32SPoul-Henning Kamp 		sbuf_delete(sc->spec);
272c46def32SPoul-Henning Kamp 	destroy_dev(dev);
273c46def32SPoul-Henning Kamp 	free(sc, M_LED);
274c46def32SPoul-Henning Kamp }
275