xref: /netbsd-src/sys/dev/gpio/gpio.c (revision 53b02e147d4ed531c0d2a5ca9b3e8026ba3e99b5)
1 /* $NetBSD: gpio.c,v 1.68 2021/09/21 14:38:51 christos Exp $ */
2 /*	$OpenBSD: gpio.c,v 1.6 2006/01/14 12:33:49 grange Exp $	*/
3 
4 /*
5  * Copyright (c) 2008, 2009, 2010, 2011 Marc Balmer <marc@msys.ch>
6  * Copyright (c) 2004, 2006 Alexander Yurchenko <grange@openbsd.org>
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 #include <sys/cdefs.h>
22 __KERNEL_RCSID(0, "$NetBSD: gpio.c,v 1.68 2021/09/21 14:38:51 christos Exp $");
23 
24 /*
25  * General Purpose Input/Output framework.
26  */
27 
28 #include <sys/param.h>
29 #include <sys/callout.h>
30 #include <sys/systm.h>
31 #include <sys/conf.h>
32 #include <sys/device.h>
33 #include <sys/fcntl.h>
34 #include <sys/ioctl.h>
35 #include <sys/gpio.h>
36 #include <sys/kernel.h>
37 #include <sys/vnode.h>
38 #include <sys/kmem.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/queue.h>
42 #include <sys/kauth.h>
43 #include <sys/module.h>
44 #include <dev/gpio/gpiovar.h>
45 
46 #include "ioconf.h"
47 #include "locators.h"
48 
49 #ifdef GPIO_DEBUG
50 #define DPRINTFN(n, x)	do { if (gpiodebug > (n)) printf x; } while (0)
51 int gpiodebug = 0;
52 #else
53 #define DPRINTFN(n, x)
54 #endif
55 #define DPRINTF(x)	DPRINTFN(0, x)
56 
57 struct gpio_softc {
58 	device_t		 sc_dev;
59 
60 	gpio_chipset_tag_t	 sc_gc;		/* GPIO controller */
61 	gpio_pin_t		*sc_pins;	/* pins array */
62 	int			 sc_npins;	/* number of pins */
63 
64 	kmutex_t		 sc_mtx;
65 	kcondvar_t		 sc_ioctl;	/* ioctl in progress */
66 	int			 sc_ioctl_busy;	/* ioctl is busy */
67 	kcondvar_t		 sc_attach;	/* attach/detach in progress */
68 	int			 sc_attach_busy;/* busy in attach/detach */
69 #ifdef COMPAT_50
70 	LIST_HEAD(, gpio_dev)	 sc_devs;	/* devices */
71 #endif
72 	LIST_HEAD(, gpio_name)	 sc_names;	/* named pins */
73 };
74 
75 static int	gpio_match(device_t, cfdata_t, void *);
76 int		gpio_submatch(device_t, cfdata_t, const int *, void *);
77 static void	gpio_attach(device_t, device_t, void *);
78 static int	gpio_rescan(device_t, const char *, const int *);
79 static void	gpio_childdetached(device_t, device_t);
80 static bool	gpio_resume(device_t, const pmf_qual_t *);
81 static int	gpio_detach(device_t, int);
82 static int	gpio_search(device_t, cfdata_t, const int *, void *);
83 static int	gpio_print(void *, const char *);
84 static int	gpio_pinbyname(struct gpio_softc *, char *);
85 static int	gpio_ioctl(struct gpio_softc *, u_long, void *, int,
86     struct lwp *);
87 
88 #ifdef COMPAT_50
89 /* Old API */
90 static int	gpio_ioctl_oapi(struct gpio_softc *, u_long, void *, int,
91     struct lwp *);
92 #endif
93 
94 CFATTACH_DECL3_NEW(gpio, sizeof(struct gpio_softc),
95     gpio_match, gpio_attach, gpio_detach, NULL, gpio_rescan,
96     gpio_childdetached, DVF_DETACH_SHUTDOWN);
97 
98 dev_type_open(gpioopen);
99 dev_type_close(gpioclose);
100 dev_type_ioctl(gpioioctl);
101 dev_type_ioctl(gpioioctl_locked);
102 
103 const struct cdevsw gpio_cdevsw = {
104 	.d_open = gpioopen,
105 	.d_close = gpioclose,
106 	.d_read = noread,
107 	.d_write = nowrite,
108 	.d_ioctl = gpioioctl,
109 	.d_stop = nostop,
110 	.d_tty = notty,
111 	.d_poll = nopoll,
112 	.d_mmap = nommap,
113 	.d_kqfilter = nokqfilter,
114 	.d_discard = nodiscard,
115 	.d_flag = D_OTHER | D_MPSAFE
116 };
117 
118 static int
119 gpio_match(device_t parent, cfdata_t cf, void *aux)
120 {
121 	return 1;
122 }
123 
124 int
125 gpio_submatch(device_t parent, cfdata_t cf, const int *ip, void *aux)
126 {
127 	struct gpio_attach_args *ga = aux;
128 
129 	if (ga->ga_offset == -1)
130 		return 0;
131 
132 	return strcmp(ga->ga_dvname, cf->cf_name) == 0;
133 }
134 
135 static bool
136 gpio_resume(device_t self, const pmf_qual_t *qual)
137 {
138 	struct gpio_softc *sc = device_private(self);
139 	int pin;
140 
141 	for (pin = 0; pin < sc->sc_npins; pin++) {
142 		gpiobus_pin_ctl(sc->sc_gc, pin, sc->sc_pins[pin].pin_flags);
143 		gpiobus_pin_write(sc->sc_gc, pin, sc->sc_pins[pin].pin_state);
144 	}
145 	return true;
146 }
147 
148 static void
149 gpio_childdetached(device_t self, device_t child)
150 {
151 #ifdef COMPAT_50
152 	struct gpio_dev *gdev;
153 	struct gpio_softc *sc;
154 	int error;
155 
156 	/*
157 	 * gpio_childetached is serialized because it can be entered in
158 	 * different ways concurrently, e.g. via the GPIODETACH ioctl and
159 	 * drvctl(8) or modunload(8).
160 	 */
161 	sc = device_private(self);
162 	error = 0;
163 	mutex_enter(&sc->sc_mtx);
164 	while (sc->sc_attach_busy) {
165 		error = cv_wait_sig(&sc->sc_attach, &sc->sc_mtx);
166 		if (error)
167 			break;
168 	}
169 	if (!error)
170 		sc->sc_attach_busy = 1;
171 	mutex_exit(&sc->sc_mtx);
172 	if (error)
173 		return;
174 
175 	LIST_FOREACH(gdev, &sc->sc_devs, sc_next)
176 		if (gdev->sc_dev == child) {
177 			LIST_REMOVE(gdev, sc_next);
178 			kmem_free(gdev, sizeof(struct gpio_dev));
179 			break;
180 		}
181 
182 	mutex_enter(&sc->sc_mtx);
183 	sc->sc_attach_busy = 0;
184 	cv_signal(&sc->sc_attach);
185 	mutex_exit(&sc->sc_mtx);
186 #endif
187 }
188 
189 static int
190 gpio_rescan(device_t self, const char *ifattr, const int *locators)
191 {
192 
193 	config_search(self, NULL,
194 	    CFARGS(.search = gpio_search));
195 
196 	return 0;
197 }
198 
199 static void
200 gpio_attach(device_t parent, device_t self, void *aux)
201 {
202 	struct gpio_softc *sc = device_private(self);
203 	struct gpiobus_attach_args *gba = aux;
204 	struct gpio_name *nm;
205 	int pin;
206 
207 	sc->sc_dev = self;
208 	sc->sc_gc = gba->gba_gc;
209 	sc->sc_pins = gba->gba_pins;
210 	sc->sc_npins = gba->gba_npins;
211 
212 	aprint_normal(": %d pins\n", sc->sc_npins);
213 	aprint_naive("\n");
214 
215 	/* Configure default pin names */
216 	for (pin = 0; pin < sc->sc_npins; pin++) {
217 		if (sc->sc_pins[pin].pin_defname[0] == '\0')
218 			continue;
219 		nm = kmem_alloc(sizeof(*nm), KM_SLEEP);
220 		strlcpy(nm->gp_name, sc->sc_pins[pin].pin_defname,
221 		    sizeof(nm->gp_name));
222 		nm->gp_pin = pin;
223 		LIST_INSERT_HEAD(&sc->sc_names, nm, gp_next);
224 	}
225 
226 	if (!pmf_device_register(self, NULL, gpio_resume))
227 		aprint_error_dev(self, "couldn't establish power handler\n");
228 	mutex_init(&sc->sc_mtx, MUTEX_DEFAULT, IPL_VM);
229 	cv_init(&sc->sc_ioctl, "gpioctl");
230 	cv_init(&sc->sc_attach, "gpioatch");
231 	/*
232 	 * Attach all devices that can be connected to the GPIO pins
233 	 * described in the kernel configuration file.
234 	 */
235 	gpio_rescan(self, "gpio", NULL);
236 }
237 
238 static int
239 gpio_detach(device_t self, int flags)
240 {
241 	struct gpio_softc *sc;
242 	int rc;
243 
244 	sc = device_private(self);
245 
246 	if ((rc = config_detach_children(self, flags)) != 0)
247 		return rc;
248 	mutex_destroy(&sc->sc_mtx);
249 	cv_destroy(&sc->sc_ioctl);
250 #if 0
251 	int maj, mn;
252 
253 	/* Locate the major number */
254 	for (maj = 0; maj < nchrdev; maj++)
255 		if (cdevsw[maj].d_open == gpioopen)
256 			break;
257 
258 	/* Nuke the vnodes for any open instances (calls close) */
259 	mn = device_unit(self);
260 	vdevgone(maj, mn, mn, VCHR);
261 #endif
262 	return 0;
263 }
264 
265 static int
266 gpio_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
267 {
268 	struct gpio_attach_args ga;
269 	size_t namlen;
270 
271 	ga.ga_gpio = device_private(parent);
272 	ga.ga_offset = cf->cf_loc[GPIOCF_OFFSET];
273 	ga.ga_mask = cf->cf_loc[GPIOCF_MASK];
274 	ga.ga_flags = cf->cf_loc[GPIOCF_FLAG];
275 	namlen = strlen(cf->cf_name) + 1;
276 	ga.ga_dvname = kmem_alloc(namlen, KM_SLEEP);
277 	strcpy(ga.ga_dvname, cf->cf_name);
278 
279 	if (config_probe(parent, cf, &ga))
280 		config_attach(parent, cf, &ga, gpio_print, CFARGS_NONE);
281 	kmem_free(ga.ga_dvname, namlen);
282 	return 0;
283 }
284 
285 int
286 gpio_print(void *aux, const char *pnp)
287 {
288 	struct gpio_attach_args *ga = aux;
289 	int i;
290 
291 	aprint_normal(" pins");
292 	for (i = 0; i < 32; i++)
293 		if (ga->ga_mask & (1 << i))
294 			aprint_normal(" %d", ga->ga_offset + i);
295 
296 	return UNCONF;
297 }
298 
299 int
300 gpiobus_print(void *aux, const char *pnp)
301 {
302 #if 0
303 	struct gpiobus_attach_args *gba = aux;
304 #endif
305 	if (pnp != NULL)
306 		aprint_normal("gpiobus at %s", pnp);
307 
308 	return UNCONF;
309 }
310 
311 void *
312 gpio_find_device(const char *name)
313 {
314 	device_t gpio_dev;
315 	gpio_dev = device_find_by_xname(name);
316 	if (gpio_dev == NULL)
317 		return NULL;
318 	return device_private(gpio_dev);
319 }
320 
321 const char *
322 gpio_get_name(void *gpio)
323 {
324 	struct gpio_softc *sc = gpio;
325 	return device_xname(sc->sc_dev);
326 }
327 
328 /* return 1 if all pins can be mapped, 0 if not */
329 int
330 gpio_pin_can_map(void *gpio, int offset, uint32_t mask)
331 {
332 	struct gpio_softc *sc = gpio;
333 	int npins, pin, i;
334 
335 	npins = gpio_npins(mask);
336 	if (npins > sc->sc_npins)
337 		return 0;
338 
339 	for (npins = 0, i = 0; i < 32; i++)
340 		if (mask & (1 << i)) {
341 			pin = offset + i;
342 			if (pin < 0 || pin >= sc->sc_npins)
343 				return 0;
344 			if (sc->sc_pins[pin].pin_mapped)
345 				return 0;
346 		}
347 
348 	return 1;
349 }
350 
351 int
352 gpio_pin_map(void *gpio, int offset, uint32_t mask, struct gpio_pinmap *map)
353 {
354 	struct gpio_softc *sc = gpio;
355 	int npins, pin, i;
356 
357 	npins = gpio_npins(mask);
358 	if (npins > sc->sc_npins)
359 		return 1;
360 
361 	for (npins = 0, i = 0; i < 32; i++)
362 		if (mask & (1 << i)) {
363 			pin = offset + i;
364 			if (pin < 0 || pin >= sc->sc_npins)
365 				return 1;
366 			if (sc->sc_pins[pin].pin_mapped)
367 				return 1;
368 			sc->sc_pins[pin].pin_mapped = 1;
369 			map->pm_map[npins++] = pin;
370 		}
371 	map->pm_size = npins;
372 
373 	return 0;
374 }
375 
376 void
377 gpio_pin_unmap(void *gpio, struct gpio_pinmap *map)
378 {
379 	struct gpio_softc *sc = gpio;
380 	int pin, i;
381 
382 	for (i = 0; i < map->pm_size; i++) {
383 		pin = map->pm_map[i];
384 		sc->sc_pins[pin].pin_mapped = 0;
385 	}
386 }
387 
388 int
389 gpio_pin_read(void *gpio, struct gpio_pinmap *map, int pin)
390 {
391 	struct gpio_softc *sc = gpio;
392 
393 	return gpiobus_pin_read(sc->sc_gc, map->pm_map[pin]);
394 }
395 
396 void
397 gpio_pin_write(void *gpio, struct gpio_pinmap *map, int pin, int value)
398 {
399 	struct gpio_softc *sc = gpio;
400 
401 	gpiobus_pin_write(sc->sc_gc, map->pm_map[pin], value);
402 	sc->sc_pins[map->pm_map[pin]].pin_state = value;
403 }
404 
405 int
406 gpio_pin_get_conf(void *gpio, struct gpio_pinmap *map, int pin)
407 {
408 	struct gpio_softc *sc = gpio;
409 	int rv;
410 
411 	mutex_enter(&sc->sc_mtx);
412 	rv = sc->sc_pins[map->pm_map[pin]].pin_flags;
413 	mutex_exit(&sc->sc_mtx);
414 
415 	return (rv);
416 }
417 
418 bool
419 gpio_pin_set_conf(void *gpio, struct gpio_pinmap *map, int pin, int flags)
420 {
421 	struct gpio_softc *sc = gpio;
422 	int checkflags = flags & GPIO_PIN_HWCAPS;
423 
424 	if ((sc->sc_pins[map->pm_map[pin]].pin_caps & checkflags) != checkflags)
425 		return (false);
426 
427 	gpio_pin_ctl(gpio, map, pin, flags);
428 
429 	return (true);
430 }
431 
432 void
433 gpio_pin_ctl(void *gpio, struct gpio_pinmap *map, int pin, int flags)
434 {
435 	struct gpio_softc *sc = gpio;
436 
437 	/* loosey-goosey version of gpio_pin_set_conf(). */
438 
439 	mutex_enter(&sc->sc_mtx);
440 	gpiobus_pin_ctl(sc->sc_gc, map->pm_map[pin], flags);
441 	sc->sc_pins[map->pm_map[pin]].pin_flags = flags;
442 	mutex_exit(&sc->sc_mtx);
443 }
444 
445 int
446 gpio_pin_caps(void *gpio, struct gpio_pinmap *map, int pin)
447 {
448 	struct gpio_softc *sc = gpio;
449 
450 	return sc->sc_pins[map->pm_map[pin]].pin_caps;
451 }
452 
453 int
454 gpio_pin_intrcaps(void *gpio, struct gpio_pinmap *map, int pin)
455 {
456 	struct gpio_softc *sc = gpio;
457 
458 	return sc->sc_pins[map->pm_map[pin]].pin_intrcaps;
459 }
460 
461 static int
462 gpio_irqmode_sanitize(int irqmode)
463 {
464 	int has_edge, has_level;
465 
466 	has_edge  = irqmode & GPIO_INTR_EDGE_MASK;
467 	has_level = irqmode & GPIO_INTR_LEVEL_MASK;
468 
469 	/* Must specify an interrupt mode. */
470 	if ((irqmode & GPIO_INTR_MODE_MASK) == 0)
471 		return (0);
472 
473 	/* Can't specify edge and level together */
474 	if (has_level && has_edge)
475 		return (0);
476 
477 	/* "Be liberal in what you accept..." */
478 	if (has_edge) {
479 		if (irqmode & GPIO_INTR_DOUBLE_EDGE) {
480 			/* if DOUBLE is set, just pass through DOUBLE */
481 			irqmode = (irqmode & ~GPIO_INTR_EDGE_MASK) |
482 			    GPIO_INTR_DOUBLE_EDGE;
483 		} else if ((irqmode ^
484 			    (GPIO_INTR_POS_EDGE | GPIO_INTR_NEG_EDGE)) == 0) {
485 			/* both POS and NEG set; treat as DOUBLE */
486 			irqmode = (irqmode & ~GPIO_INTR_EDGE_MASK) |
487 			    GPIO_INTR_DOUBLE_EDGE;
488 		}
489 	} else {
490 		/* Can't specify both levels together. */
491 		if (has_level == GPIO_INTR_LEVEL_MASK)
492 			return (0);
493 	}
494 
495 	return (irqmode);
496 }
497 
498 bool
499 gpio_pin_irqmode_issupported(void *gpio, struct gpio_pinmap *map,
500 			     int pin, int irqmode)
501 {
502 	struct gpio_softc *sc = gpio;
503 	int match;
504 
505 	irqmode = gpio_irqmode_sanitize(irqmode) & GPIO_INTR_MODE_MASK;
506 
507 	/* Make sure the pin can do what is being asked. */
508 	match = sc->sc_pins[map->pm_map[pin]].pin_intrcaps & irqmode;
509 
510 	return (irqmode && irqmode == match);
511 }
512 
513 void *
514 gpio_intr_establish(void *gpio, struct gpio_pinmap *map, int pin, int ipl,
515 		    int irqmode, int (*func)(void *), void *arg)
516 {
517 	struct gpio_softc *sc = gpio;
518 
519 	if (sc->sc_gc->gp_intr_establish == NULL)
520 		return (NULL);
521 
522 	irqmode = gpio_irqmode_sanitize(irqmode);
523 	if (irqmode == 0)
524 		return (NULL);
525 
526 	if (! gpio_pin_irqmode_issupported(gpio, map, pin, irqmode))
527 		return (NULL);
528 
529 	/* XXX Right now, everything has to be at IPL_VM. */
530 	if (ipl != IPL_VM)
531 		return (NULL);
532 
533 	return ((*sc->sc_gc->gp_intr_establish)(sc->sc_gc->gp_cookie,
534 	    sc->sc_pins[map->pm_map[pin]].pin_num, ipl, irqmode, func, arg));
535 }
536 
537 void
538 gpio_intr_disestablish(void *gpio, void *ih)
539 {
540 	struct gpio_softc *sc = gpio;
541 
542 	if (sc->sc_gc->gp_intr_disestablish != NULL && ih != NULL)
543 		(*sc->sc_gc->gp_intr_disestablish)(sc->sc_gc->gp_cookie, ih);
544 }
545 
546 bool
547 gpio_intr_str(void *gpio, struct gpio_pinmap *map, int pin, int irqmode,
548 	      char *intrstr, size_t intrstrlen)
549 {
550 	struct gpio_softc *sc = gpio;
551 	const char *mode;
552 	char hwstr[64];
553 
554 	if (sc->sc_gc->gp_intr_str == NULL)
555 		return (false);
556 
557 	irqmode = gpio_irqmode_sanitize(irqmode);
558 	if (irqmode == 0)
559 		return (false);
560 
561 	if (irqmode & GPIO_INTR_DOUBLE_EDGE)
562 		mode = "double edge";
563 	else if (irqmode & GPIO_INTR_POS_EDGE)
564 		mode = "positive edge";
565 	else if (irqmode & GPIO_INTR_NEG_EDGE)
566 		mode = "negative edge";
567 	else if (irqmode & GPIO_INTR_HIGH_LEVEL)
568 		mode = "high level";
569 	else if (irqmode & GPIO_INTR_LOW_LEVEL)
570 		mode = "low level";
571 	else
572 		return (false);
573 
574 	if (! (*sc->sc_gc->gp_intr_str)(sc->sc_gc->gp_cookie,
575 					sc->sc_pins[map->pm_map[pin]].pin_num,
576 					irqmode, hwstr, sizeof(hwstr)))
577 		return (false);
578 
579 	(void) snprintf(intrstr, intrstrlen, "%s (%s)", hwstr, mode);
580 
581 	return (true);
582 }
583 
584 int
585 gpio_npins(uint32_t mask)
586 {
587 	int npins, i;
588 
589 	for (npins = 0, i = 0; i < 32; i++)
590 		if (mask & (1 << i))
591 			npins++;
592 
593 	return npins;
594 }
595 
596 int
597 gpio_lock(void *data)
598 {
599 	struct gpio_softc *sc;
600 	int error;
601 
602 	error = 0;
603 	sc = data;
604 	mutex_enter(&sc->sc_mtx);
605 	while (sc->sc_ioctl_busy) {
606 		error = cv_wait_sig(&sc->sc_ioctl, &sc->sc_mtx);
607 		if (error)
608 			break;
609 	}
610 	if (!error)
611 		sc->sc_ioctl_busy = 1;
612 	mutex_exit(&sc->sc_mtx);
613 	return error;
614 }
615 
616 void
617 gpio_unlock(void *data)
618 {
619 	struct gpio_softc *sc;
620 
621 	sc = data;
622 	mutex_enter(&sc->sc_mtx);
623 	sc->sc_ioctl_busy = 0;
624 	cv_signal(&sc->sc_ioctl);
625 	mutex_exit(&sc->sc_mtx);
626 }
627 
628 int
629 gpioopen(dev_t dev, int flag, int mode, struct lwp *l)
630 {
631 	struct gpio_softc *sc;
632 
633 	sc = device_lookup_private(&gpio_cd, minor(dev));
634 	if (sc == NULL)
635 		return ENXIO;
636 
637 	return gpiobus_open(sc->sc_gc, sc->sc_dev);
638 }
639 
640 int
641 gpioclose(dev_t dev, int flag, int mode, struct lwp *l)
642 {
643 	struct gpio_softc *sc;
644 
645 	sc = device_lookup_private(&gpio_cd, minor(dev));
646 	return gpiobus_close(sc->sc_gc, sc->sc_dev);
647 }
648 
649 static int
650 gpio_pinbyname(struct gpio_softc *sc, char *gp_name)
651 {
652         struct gpio_name *nm;
653 
654         LIST_FOREACH(nm, &sc->sc_names, gp_next)
655                 if (!strcmp(nm->gp_name, gp_name))
656                         return nm->gp_pin;
657         return -1;
658 }
659 
660 int
661 gpioioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
662 {
663 	int error;
664 	struct gpio_softc *sc;
665 
666 	sc = device_lookup_private(&gpio_cd, minor(dev));
667 
668 	error = gpio_lock(sc);
669 	if (error)
670 		return error;
671 
672 	error = gpio_ioctl(sc, cmd, data, flag, l);
673 	gpio_unlock(sc);
674 	return error;
675 }
676 
677 static int
678 gpio_ioctl(struct gpio_softc *sc, u_long cmd, void *data, int flag,
679     struct lwp *l)
680 {
681 	gpio_chipset_tag_t gc;
682 	struct gpio_info *info;
683 	struct gpio_attach *attach;
684 	struct gpio_attach_args ga;
685 	struct gpio_req *req;
686 	struct gpio_name *nm;
687 	struct gpio_set *set;
688 #ifdef COMPAT_50
689 	struct gpio_dev *gdev;
690 #endif
691 	device_t dv;
692 	cfdata_t cf;
693 	int locs[GPIOCF_NLOCS];
694 	int error, pin, value, flags, npins;
695 
696 	gc = sc->sc_gc;
697 	ga.ga_flags = 0;
698 
699 	if (cmd != GPIOINFO && !device_is_active(sc->sc_dev)) {
700 		DPRINTF(("%s: device is not active\n",
701 		    device_xname(sc->sc_dev)));
702 		return EBUSY;
703 	}
704 
705 	switch (cmd) {
706 	case GPIOINFO:
707 		info = data;
708 		if (!kauth_authorize_device(l->l_cred,
709 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
710 			info->gpio_npins = sc->sc_npins;
711 		else {
712 			for (pin = npins = 0; pin < sc->sc_npins; pin++)
713 				if (sc->sc_pins[pin].pin_flags & GPIO_PIN_SET)
714 					++npins;
715 			info->gpio_npins = npins;
716 		}
717 		break;
718 	case GPIOREAD:
719 		req = data;
720 
721 		if (req->gp_name[0] != '\0')
722 			req->gp_pin = gpio_pinbyname(sc, req->gp_name);
723 		pin = req->gp_pin;
724 
725 		if (pin < 0 || pin >= sc->sc_npins)
726 			return EINVAL;
727 
728 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
729 		    kauth_authorize_device(l->l_cred,
730 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
731 			return EPERM;
732 
733 		/* return read value */
734 		req->gp_value = gpiobus_pin_read(gc, pin);
735 		LIST_FOREACH(nm, &sc->sc_names, gp_next)
736 			if (nm->gp_pin == pin) {
737 				strlcpy(req->gp_name, nm->gp_name, GPIOMAXNAME);
738 				break;
739 			}
740 		break;
741 	case GPIOWRITE:
742 		if ((flag & FWRITE) == 0)
743 			return EBADF;
744 
745 		req = data;
746 
747 		if (req->gp_name[0] != '\0')
748 			pin = gpio_pinbyname(sc, req->gp_name);
749 		else
750 			pin = req->gp_pin;
751 
752 		if (pin < 0 || pin >= sc->sc_npins)
753 			return EINVAL;
754 
755 		if (sc->sc_pins[pin].pin_mapped)
756 			return EBUSY;
757 
758 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
759 		    kauth_authorize_device(l->l_cred,
760 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
761 			return EPERM;
762 
763 		value = req->gp_value;
764 		if (value != GPIO_PIN_LOW && value != GPIO_PIN_HIGH)
765 			return EINVAL;
766 
767 		/* return old value */
768 		req->gp_value = gpiobus_pin_read(gc, pin);
769 		gpiobus_pin_write(gc, pin, value);
770 		/* update current value */
771 		sc->sc_pins[pin].pin_state = value;
772 		break;
773 	case GPIOTOGGLE:
774 		if ((flag & FWRITE) == 0)
775 			return EBADF;
776 
777 		req = data;
778 
779 		if (req->gp_name[0] != '\0')
780 			pin = gpio_pinbyname(sc, req->gp_name);
781 		else
782 			pin = req->gp_pin;
783 
784 		if (pin < 0 || pin >= sc->sc_npins)
785 			return EINVAL;
786 
787 		if (sc->sc_pins[pin].pin_mapped)
788 			return EBUSY;
789 
790 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
791 		    kauth_authorize_device(l->l_cred,
792 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
793 			return EPERM;
794 
795 		value = (sc->sc_pins[pin].pin_state == GPIO_PIN_LOW ?
796 		    GPIO_PIN_HIGH : GPIO_PIN_LOW);
797 		gpiobus_pin_write(gc, pin, value);
798 		/* return old value */
799 		req->gp_value = sc->sc_pins[pin].pin_state;
800 		/* update current value */
801 		sc->sc_pins[pin].pin_state = value;
802 		break;
803 	case GPIOATTACH:
804 		attach = data;
805 		ga.ga_flags = attach->ga_flags;
806 #ifdef COMPAT_50
807 		/* FALLTHROUGH */
808 	case GPIOATTACH50:
809 		/*
810 		 * The double assignment to 'attach' in case of GPIOATTACH
811 		 * and COMPAT_50 is on purpose. It ensures backward
812 		 * compatibility in case we are called through the old
813 		 * GPIOATTACH50 ioctl(2), which had not the ga_flags field
814 		 * in struct gpio_attach.
815 		 */
816 		attach = data;
817 #endif
818 		if (kauth_authorize_device(l->l_cred,
819 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
820 			return EPERM;
821 
822 		/* do not try to attach if the pins are already mapped */
823 		if (!gpio_pin_can_map(sc, attach->ga_offset, attach->ga_mask))
824 			return EBUSY;
825 
826 		error = 0;
827 		mutex_enter(&sc->sc_mtx);
828 		while (sc->sc_attach_busy) {
829 			error = cv_wait_sig(&sc->sc_attach, &sc->sc_mtx);
830 			if (error)
831 				break;
832 		}
833 		if (!error)
834 			sc->sc_attach_busy = 1;
835 		mutex_exit(&sc->sc_mtx);
836 		if (error)
837 			return EBUSY;
838 
839 		ga.ga_gpio = sc;
840 		/* Don't access attach->ga_flags here. */
841 		ga.ga_dvname = attach->ga_dvname;
842 		ga.ga_offset = attach->ga_offset;
843 		ga.ga_mask = attach->ga_mask;
844 		DPRINTF(("%s: attach %s with offset %d, mask "
845 		    "0x%02x, and flags 0x%02x\n", device_xname(sc->sc_dev),
846 		    ga.ga_dvname, ga.ga_offset, ga.ga_mask, ga.ga_flags));
847 
848 		locs[GPIOCF_OFFSET] = ga.ga_offset;
849 		locs[GPIOCF_MASK] = ga.ga_mask;
850 		locs[GPIOCF_FLAG] = ga.ga_flags;
851 
852 		cf = config_search(sc->sc_dev, &ga,
853 		    CFARGS(.locators = locs));
854 		if (cf != NULL) {
855 			dv = config_attach(sc->sc_dev, cf, &ga,
856 			    gpiobus_print,
857 			    CFARGS(.locators = locs));
858 #ifdef COMPAT_50
859 			if (dv != NULL) {
860 				gdev = kmem_alloc(sizeof(struct gpio_dev),
861 				    KM_SLEEP);
862 				gdev->sc_dev = dv;
863 				LIST_INSERT_HEAD(&sc->sc_devs, gdev, sc_next);
864 			} else
865 				error = EINVAL;
866 #else
867 			if (dv == NULL)
868 				error = EINVAL;
869 #endif
870 		} else
871 			error = EINVAL;
872 		mutex_enter(&sc->sc_mtx);
873 		sc->sc_attach_busy = 0;
874 		cv_signal(&sc->sc_attach);
875 		mutex_exit(&sc->sc_mtx);
876 		return error;
877 	case GPIOSET:
878 		if (kauth_authorize_device(l->l_cred,
879 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
880 			return EPERM;
881 
882 		set = data;
883 
884 		if (set->gp_name[0] != '\0')
885 			pin = gpio_pinbyname(sc, set->gp_name);
886 		else
887 			pin = set->gp_pin;
888 
889 		if (pin < 0 || pin >= sc->sc_npins)
890 			return EINVAL;
891 		flags = set->gp_flags;
892 
893 		/* check that the controller supports all requested flags */
894 		if ((flags & sc->sc_pins[pin].pin_caps) != flags)
895 			return ENODEV;
896 		flags = set->gp_flags;
897 
898 		set->gp_caps = sc->sc_pins[pin].pin_caps;
899 		/* return old value */
900 		set->gp_flags = sc->sc_pins[pin].pin_flags;
901 
902 		if (flags > 0) {
903 			flags |= GPIO_PIN_SET;
904 			gpiobus_pin_ctl(gc, pin, flags);
905 			/* update current value */
906 			sc->sc_pins[pin].pin_flags = flags;
907 		}
908 
909 		/* rename pin or new pin? */
910 		if (set->gp_name2[0] != '\0') {
911 			struct gpio_name *gnm;
912 
913 			gnm = NULL;
914 			LIST_FOREACH(nm, &sc->sc_names, gp_next) {
915 				if (!strcmp(nm->gp_name, set->gp_name2) &&
916 				    nm->gp_pin != pin)
917 					return EINVAL;	/* duplicate name */
918 				if (nm->gp_pin == pin)
919 					gnm = nm;
920 			}
921 			if (gnm != NULL)
922 				strlcpy(gnm->gp_name, set->gp_name2,
923 				    sizeof(gnm->gp_name));
924 			else  {
925 				nm = kmem_alloc(sizeof(struct gpio_name),
926 				    KM_SLEEP);
927 				strlcpy(nm->gp_name, set->gp_name2,
928 				    sizeof(nm->gp_name));
929 				nm->gp_pin = set->gp_pin;
930 				LIST_INSERT_HEAD(&sc->sc_names, nm, gp_next);
931 			}
932 		}
933 		break;
934 	case GPIOUNSET:
935 		if (kauth_authorize_device(l->l_cred,
936 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
937 			return EPERM;
938 
939 		set = data;
940 		if (set->gp_name[0] != '\0')
941 			pin = gpio_pinbyname(sc, set->gp_name);
942 		else
943 			pin = set->gp_pin;
944 
945 		if (pin < 0 || pin >= sc->sc_npins)
946 			return EINVAL;
947 		if (sc->sc_pins[pin].pin_mapped)
948 			return EBUSY;
949 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET))
950 			return EINVAL;
951 
952 		LIST_FOREACH(nm, &sc->sc_names, gp_next) {
953 			if (nm->gp_pin == pin) {
954 				LIST_REMOVE(nm, gp_next);
955 				kmem_free(nm, sizeof(struct gpio_name));
956 				break;
957 			}
958 		}
959 		sc->sc_pins[pin].pin_flags &= ~GPIO_PIN_SET;
960 		break;
961 	default:
962 #ifdef COMPAT_50
963 		/* Try the old API */
964 		DPRINTF(("%s: trying the old API\n", device_xname(sc->sc_dev)));
965 		return gpio_ioctl_oapi(sc, cmd, data, flag, l);
966 #else
967 		return ENOTTY;
968 #endif
969 	}
970 	return 0;
971 }
972 
973 #ifdef COMPAT_50
974 static int
975 gpio_ioctl_oapi(struct gpio_softc *sc, u_long cmd, void *data, int flag,
976     struct lwp *l)
977 {
978 	gpio_chipset_tag_t gc;
979 	struct gpio_pin_op *op;
980 	struct gpio_pin_ctl *ctl;
981 	struct gpio_attach *attach;
982 	struct gpio_dev *gdev;
983 
984 	int error, pin, value, flags;
985 
986 	gc = sc->sc_gc;
987 
988 	switch (cmd) {
989 	case GPIOPINREAD:
990 		op = data;
991 
992 		pin = op->gp_pin;
993 
994 		if (pin < 0 || pin >= sc->sc_npins)
995 			return EINVAL;
996 
997 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
998 		    kauth_authorize_device(l->l_cred,
999 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
1000 			return EPERM;
1001 
1002 		/* return read value */
1003 		op->gp_value = gpiobus_pin_read(gc, pin);
1004 		break;
1005 	case GPIOPINWRITE:
1006 		if ((flag & FWRITE) == 0)
1007 			return EBADF;
1008 
1009 		op = data;
1010 
1011 		pin = op->gp_pin;
1012 
1013 		if (pin < 0 || pin >= sc->sc_npins)
1014 			return EINVAL;
1015 
1016 		if (sc->sc_pins[pin].pin_mapped)
1017 			return EBUSY;
1018 
1019 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
1020 		    kauth_authorize_device(l->l_cred,
1021 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
1022 			return EPERM;
1023 
1024 		value = op->gp_value;
1025 		if (value != GPIO_PIN_LOW && value != GPIO_PIN_HIGH)
1026 			return EINVAL;
1027 
1028 		gpiobus_pin_write(gc, pin, value);
1029 		/* return old value */
1030 		op->gp_value = sc->sc_pins[pin].pin_state;
1031 		/* update current value */
1032 		sc->sc_pins[pin].pin_state = value;
1033 		break;
1034 	case GPIOPINTOGGLE:
1035 		if ((flag & FWRITE) == 0)
1036 			return EBADF;
1037 
1038 		op = data;
1039 
1040 		pin = op->gp_pin;
1041 
1042 		if (pin < 0 || pin >= sc->sc_npins)
1043 			return EINVAL;
1044 
1045 		if (sc->sc_pins[pin].pin_mapped)
1046 			return EBUSY;
1047 
1048 		if (!(sc->sc_pins[pin].pin_flags & GPIO_PIN_SET) &&
1049 		    kauth_authorize_device(l->l_cred,
1050 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
1051 			return EPERM;
1052 
1053 		value = (sc->sc_pins[pin].pin_state == GPIO_PIN_LOW ?
1054 		    GPIO_PIN_HIGH : GPIO_PIN_LOW);
1055 		gpiobus_pin_write(gc, pin, value);
1056 		/* return old value */
1057 		op->gp_value = sc->sc_pins[pin].pin_state;
1058 		/* update current value */
1059 		sc->sc_pins[pin].pin_state = value;
1060 		break;
1061 	case GPIOPINCTL:
1062 		ctl = data;
1063 
1064 		if (kauth_authorize_device(l->l_cred,
1065 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
1066 			return EPERM;
1067 
1068 		pin = ctl->gp_pin;
1069 
1070 		if (pin < 0 || pin >= sc->sc_npins)
1071 			return EINVAL;
1072 		if (sc->sc_pins[pin].pin_mapped)
1073 			return EBUSY;
1074 		flags = ctl->gp_flags;
1075 
1076 		/* check that the controller supports all requested flags */
1077 		if ((flags & sc->sc_pins[pin].pin_caps) != flags)
1078 			return ENODEV;
1079 
1080 		ctl->gp_caps = sc->sc_pins[pin].pin_caps;
1081 		/* return old value */
1082 		ctl->gp_flags = sc->sc_pins[pin].pin_flags;
1083 		if (flags > 0) {
1084 			gpiobus_pin_ctl(gc, pin, flags);
1085 			/* update current value */
1086 			sc->sc_pins[pin].pin_flags = flags;
1087 		}
1088 		break;
1089 	case GPIODETACH50:
1090 		/* FALLTHOUGH */
1091 	case GPIODETACH:
1092 		if (kauth_authorize_device(l->l_cred,
1093 		    KAUTH_DEVICE_GPIO_PINSET, NULL, NULL, NULL, NULL))
1094 			return EPERM;
1095 
1096 		error = 0;
1097 		mutex_enter(&sc->sc_mtx);
1098 		while (sc->sc_attach_busy) {
1099 			error = cv_wait_sig(&sc->sc_attach, &sc->sc_mtx);
1100 			if (error)
1101 				break;
1102 		}
1103 		if (!error)
1104 			sc->sc_attach_busy = 1;
1105 		mutex_exit(&sc->sc_mtx);
1106 		if (error)
1107 			return EBUSY;
1108 
1109 		attach = data;
1110 		LIST_FOREACH(gdev, &sc->sc_devs, sc_next) {
1111 			if (strcmp(device_xname(gdev->sc_dev),
1112 			    attach->ga_dvname) == 0) {
1113 				mutex_enter(&sc->sc_mtx);
1114 				sc->sc_attach_busy = 0;
1115 				cv_signal(&sc->sc_attach);
1116 				mutex_exit(&sc->sc_mtx);
1117 
1118 				if (config_detach(gdev->sc_dev, 0) == 0)
1119 					return 0;
1120 				break;
1121 			}
1122 		}
1123 		if (gdev == NULL) {
1124 			mutex_enter(&sc->sc_mtx);
1125 			sc->sc_attach_busy = 0;
1126 			cv_signal(&sc->sc_attach);
1127 			mutex_exit(&sc->sc_mtx);
1128 		}
1129 		return EINVAL;
1130 
1131 	default:
1132 		return ENOTTY;
1133 	}
1134 	return 0;
1135 }
1136 #endif	/* COMPAT_50 */
1137 
1138 MODULE(MODULE_CLASS_DRIVER, gpio, NULL);
1139 
1140 #ifdef _MODULE
1141 #include "ioconf.c"
1142 #endif
1143 
1144 static int
1145 gpio_modcmd(modcmd_t cmd, void *opaque)
1146 {
1147 #ifdef _MODULE
1148 	devmajor_t cmajor = NODEVMAJOR, bmajor = NODEVMAJOR;
1149 	int error;
1150 #endif
1151 	switch (cmd) {
1152 	case MODULE_CMD_INIT:
1153 #ifdef _MODULE
1154 		error = config_init_component(cfdriver_ioconf_gpio,
1155 		    cfattach_ioconf_gpio, cfdata_ioconf_gpio);
1156 		if (error) {
1157 			aprint_error("%s: unable to init component\n",
1158 			    gpio_cd.cd_name);
1159 			return error;
1160 		}
1161 		error = devsw_attach(gpio_cd.cd_name, NULL, &bmajor,
1162 		    &gpio_cdevsw, &cmajor);
1163 		if (error) {
1164 			aprint_error("%s: unable to register devsw\n",
1165 			    gpio_cd.cd_name);
1166 			return config_fini_component(cfdriver_ioconf_gpio,
1167 			    cfattach_ioconf_gpio, cfdata_ioconf_gpio);
1168 		}
1169 #endif
1170 		return 0;
1171 	case MODULE_CMD_FINI:
1172 #ifdef _MODULE
1173 		config_fini_component(cfdriver_ioconf_gpio,
1174 		    cfattach_ioconf_gpio, cfdata_ioconf_gpio);
1175 		devsw_detach(NULL, &gpio_cdevsw);
1176 #endif
1177 		return 0;
1178 	default:
1179 		return ENOTTY;
1180 	}
1181 }
1182