Home | History | Annotate | Line # | Download | only in broadcom
bcm2835_gpio.c revision 1.18
      1 /*	$NetBSD: bcm2835_gpio.c,v 1.18 2021/01/27 03:10:19 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2013, 2014, 2017 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Jonathan A. Kollasch, Frank Kardel and Nick Hudson
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #include <sys/cdefs.h>
     33 __KERNEL_RCSID(0, "$NetBSD: bcm2835_gpio.c,v 1.18 2021/01/27 03:10:19 thorpej Exp $");
     34 
     35 /*
     36  * Driver for BCM2835 GPIO
     37  *
     38  * see: http://www.raspberrypi.org/wp-content/uploads/2012/02/BCM2835-ARM-Peripherals.pdf
     39  */
     40 
     41 #include <sys/param.h>
     42 #include <sys/device.h>
     43 #include <sys/systm.h>
     44 #include <sys/mutex.h>
     45 #include <sys/bus.h>
     46 #include <sys/intr.h>
     47 #include <sys/kernel.h>
     48 #include <sys/kmem.h>
     49 #include <sys/proc.h>
     50 #include <sys/gpio.h>
     51 
     52 #include <sys/bitops.h>
     53 
     54 #include <arm/broadcom/bcm2835reg.h>
     55 #include <arm/broadcom/bcm2835_gpioreg.h>
     56 
     57 #include <dev/gpio/gpiovar.h>
     58 #include <dev/fdt/fdtvar.h>
     59 
     60 /* #define BCM2835_GPIO_DEBUG */
     61 #ifdef BCM2835_GPIO_DEBUG
     62 int bcm2835gpiodebug = 3;
     63 #define DPRINTF(l, x)	do { if (l <= bcm2835gpiodebug) { printf x; } } while (0)
     64 #else
     65 #define DPRINTF(l, x)
     66 #endif
     67 
     68 #define BCM2835_GPIO_MAXPINS 54
     69 #define BCM2838_GPIO_MAXPINS 58
     70 #define	BCMGPIO_MAXPINS	BCM2838_GPIO_MAXPINS
     71 
     72 struct bcmgpio_eint {
     73 	 int			(*eint_func)(void *);
     74 	 void			*eint_arg;
     75 	 int			eint_flags;
     76 	 int			eint_bank;
     77 	 int			eint_num;
     78 };
     79 
     80 #define	BCMGPIO_INTR_POS_EDGE	0x01
     81 #define	BCMGPIO_INTR_NEG_EDGE	0x02
     82 #define	BCMGPIO_INTR_HIGH_LEVEL	0x04
     83 #define	BCMGPIO_INTR_LOW_LEVEL	0x08
     84 #define	BCMGPIO_INTR_MPSAFE	0x10
     85 
     86 struct bcmgpio_softc;
     87 struct bcmgpio_bank {
     88 	struct bcmgpio_softc	*sc_bcm;
     89 	void			*sc_ih;
     90 	struct bcmgpio_eint	sc_eint[32];
     91 	int			sc_bankno;
     92 };
     93 #define	BCMGPIO_NBANKS	2
     94 
     95 struct bcmgpio_softc {
     96 	device_t		sc_dev;
     97 	bus_space_tag_t		sc_iot;
     98 	bus_space_handle_t	sc_ioh;
     99 	struct gpio_chipset_tag	sc_gpio_gc;
    100 
    101 	kmutex_t		sc_lock;
    102 	gpio_pin_t		sc_gpio_pins[BCMGPIO_MAXPINS];
    103 
    104 	/* For interrupt support. */
    105 	struct bcmgpio_bank	sc_banks[BCMGPIO_NBANKS];
    106 
    107 	bool			sc_is2835;	/* for pullup on 2711 */
    108 	u_int			sc_maxpins;
    109 };
    110 
    111 struct bcmgpio_pin {
    112 	int			pin_no;
    113 	u_int			pin_flags;
    114 	bool			pin_actlo;
    115 };
    116 
    117 
    118 static int	bcmgpio_match(device_t, cfdata_t, void *);
    119 static void	bcmgpio_attach(device_t, device_t, void *);
    120 
    121 static int	bcm2835gpio_gpio_pin_read(void *, int);
    122 static void	bcm2835gpio_gpio_pin_write(void *, int, int);
    123 static void	bcm2835gpio_gpio_pin_ctl(void *, int, int);
    124 
    125 static void *	bcmgpio_gpio_intr_establish(void *, int, int, int,
    126 					    int (*)(void *), void *);
    127 static void	bcmgpio_gpio_intr_disestablish(void *, void *);
    128 static bool	bcmgpio_gpio_intrstr(void *, int, int, char *, size_t);
    129 
    130 static int	bcmgpio_intr(void *);
    131 
    132 u_int		bcm283x_pin_getfunc(const struct bcmgpio_softc * const, u_int);
    133 void		bcm283x_pin_setfunc(const struct bcmgpio_softc * const, u_int,
    134 		    u_int);
    135 void		bcm283x_pin_setpull(const struct bcmgpio_softc * const, u_int,
    136 		    u_int);
    137 
    138 static int 	bcm283x_pinctrl_set_config(device_t, const void *, size_t);
    139 
    140 static void *	bcmgpio_fdt_acquire(device_t, const void *, size_t, int);
    141 static void	bcmgpio_fdt_release(device_t, void *);
    142 static int	bcmgpio_fdt_read(device_t, void *, bool);
    143 static void	bcmgpio_fdt_write(device_t, void *, int, bool);
    144 
    145 static struct fdtbus_gpio_controller_func bcmgpio_funcs = {
    146 	.acquire = bcmgpio_fdt_acquire,
    147 	.release = bcmgpio_fdt_release,
    148 	.read = bcmgpio_fdt_read,
    149 	.write = bcmgpio_fdt_write
    150 };
    151 
    152 static void *	bcmgpio_fdt_intr_establish(device_t, u_int *, int, int,
    153 		    int (*func)(void *), void *, const char *);
    154 static void	bcmgpio_fdt_intr_disestablish(device_t, void *);
    155 static bool	bcmgpio_fdt_intrstr(device_t, u_int *, char *, size_t);
    156 
    157 static struct fdtbus_interrupt_controller_func bcmgpio_fdt_intrfuncs = {
    158 	.establish = bcmgpio_fdt_intr_establish,
    159 	.disestablish = bcmgpio_fdt_intr_disestablish,
    160 	.intrstr = bcmgpio_fdt_intrstr,
    161 };
    162 
    163 CFATTACH_DECL_NEW(bcmgpio, sizeof(struct bcmgpio_softc),
    164     bcmgpio_match, bcmgpio_attach, NULL, NULL);
    165 
    166 
    167 static struct fdtbus_pinctrl_controller_func bcm283x_pinctrl_funcs = {
    168 	.set_config = bcm283x_pinctrl_set_config,
    169 };
    170 
    171 static int
    172 bcm283x_pinctrl_set_config(device_t dev, const void *data, size_t len)
    173 {
    174 	struct bcmgpio_softc * const sc = device_private(dev);
    175 
    176 	if (len != 4)
    177 		return -1;
    178 
    179 	const int phandle = fdtbus_get_phandle_from_native(be32dec(data));
    180 
    181 	/*
    182 	 * Required: brcm,pins
    183 	 * Optional: brcm,function, brcm,pull
    184 	 */
    185 
    186 	int pins_len;
    187 	const u_int *pins = fdtbus_get_prop(phandle, "brcm,pins", &pins_len);
    188 
    189 	if (pins == NULL)
    190 		return -1;
    191 
    192 	int pull_len = 0;
    193 	const u_int *pull = fdtbus_get_prop(phandle, "brcm,pull", &pull_len);
    194 
    195 	int func_len = 0;
    196 	const u_int *func = fdtbus_get_prop(phandle, "brcm,function", &func_len);
    197 
    198 	if (!pull && !func) {
    199 		aprint_error_dev(dev, "one of brcm,pull or brcm,funcion must "
    200 		    "be specified");
    201 		return -1;
    202 	}
    203 
    204 	const int npins = pins_len / 4;
    205 	const int npull = pull_len / 4;
    206 	const int nfunc = func_len / 4;
    207 
    208 	if (npull > 1 && npull != npins) {
    209 		aprint_error_dev(dev, "brcm,pull must have 1 or %d entries",
    210 		    npins);
    211 		return -1;
    212 	}
    213 	if (nfunc > 1 && nfunc != npins) {
    214 		aprint_error_dev(dev, "brcm,function must have 1 or %d entries",
    215 		    npins);
    216 		return -1;
    217 	}
    218 
    219 	mutex_enter(&sc->sc_lock);
    220 
    221 	for (int i = 0; i < npins; i++) {
    222 		const u_int pin = be32toh(pins[i]);
    223 
    224 		if (pin >= sc->sc_maxpins)
    225 			continue;
    226 		if (pull) {
    227 			const int value = be32toh(pull[npull == 1 ? 0 : i]);
    228 			bcm283x_pin_setpull(sc, pin, value);
    229 		}
    230 		if (func) {
    231 			const int value = be32toh(func[nfunc == 1 ? 0 : i]);
    232 			bcm283x_pin_setfunc(sc, pin, value);
    233 		}
    234 	}
    235 
    236 	mutex_exit(&sc->sc_lock);
    237 
    238 	return 0;
    239 }
    240 
    241 static const struct device_compatible_entry compat_data[] = {
    242 	{ .compat = "brcm,bcm2835-gpio" },
    243 	{ .compat = "brcm,bcm2838-gpio" },
    244 	{ .compat = "brcm,bcm2711-gpio" },
    245 	DEVICE_COMPAT_EOL
    246 };
    247 
    248 static int
    249 bcmgpio_match(device_t parent, cfdata_t cf, void *aux)
    250 {
    251 	struct fdt_attach_args * const faa = aux;
    252 
    253 	return of_compatible_match(faa->faa_phandle, compat_data);
    254 }
    255 
    256 static void
    257 bcmgpio_attach(device_t parent, device_t self, void *aux)
    258 {
    259 	struct bcmgpio_softc * const sc = device_private(self);
    260 	struct fdt_attach_args * const faa = aux;
    261 	struct gpiobus_attach_args gba;
    262 	bus_addr_t addr;
    263 	bus_size_t size;
    264 	u_int func;
    265 	int error;
    266 	int pin;
    267 	int bank;
    268 	uint32_t reg;
    269 
    270 	const int phandle = faa->faa_phandle;
    271 	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
    272 		aprint_error(": couldn't get registers\n");
    273 		return;
    274 	}
    275 
    276 	sc->sc_dev = self;
    277 
    278 	sc->sc_iot = faa->faa_bst;
    279 	error = bus_space_map(sc->sc_iot, addr, size, 0, &sc->sc_ioh);
    280 	if (error) {
    281 		aprint_error_dev(self, ": couldn't map registers\n");
    282 		return;
    283 	}
    284 
    285 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_VM);
    286 
    287 	/* BCM2835, BCM2836, BCM2837 return 'gpio' in this unused register */
    288 	reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh, BCM2838_GPIO_GPPUPPDN(3));
    289 	sc->sc_is2835 = reg == 0x6770696f;
    290 	sc->sc_maxpins = sc->sc_is2835 ? BCM2835_GPIO_MAXPINS
    291 	                               : BCM2838_GPIO_MAXPINS;
    292 
    293 	aprint_naive("\n");
    294 	aprint_normal(": GPIO controller %s\n", sc->sc_is2835 ? "2835" : "2838");
    295 
    296 	for (pin = 0; pin < sc->sc_maxpins; pin++) {
    297 		sc->sc_gpio_pins[pin].pin_num = pin;
    298 		/*
    299 		 * find out pins still available for GPIO
    300 		 */
    301 		func = bcm283x_pin_getfunc(sc, pin);
    302 
    303 		if (func == BCM2835_GPIO_IN ||
    304 		    func == BCM2835_GPIO_OUT) {
    305 			/* XXX TRISTATE?  Really? */
    306 			sc->sc_gpio_pins[pin].pin_caps = GPIO_PIN_INPUT |
    307 				GPIO_PIN_OUTPUT |
    308 				GPIO_PIN_PUSHPULL | GPIO_PIN_TRISTATE |
    309 				GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN |
    310 				GPIO_PIN_ALT0 | GPIO_PIN_ALT1 |
    311 				GPIO_PIN_ALT2 | GPIO_PIN_ALT3 |
    312 				GPIO_PIN_ALT4 | GPIO_PIN_ALT5;
    313 			sc->sc_gpio_pins[pin].pin_intrcaps =
    314 				GPIO_INTR_POS_EDGE |
    315 				GPIO_INTR_NEG_EDGE |
    316 				GPIO_INTR_DOUBLE_EDGE |
    317 				GPIO_INTR_HIGH_LEVEL |
    318 				GPIO_INTR_LOW_LEVEL |
    319 				GPIO_INTR_MPSAFE;
    320 			/* read initial state */
    321 			sc->sc_gpio_pins[pin].pin_state =
    322 				bcm2835gpio_gpio_pin_read(sc, pin);
    323 			aprint_debug_dev(sc->sc_dev, "attach pin %d\n", pin);
    324 		} else {
    325 			sc->sc_gpio_pins[pin].pin_caps = 0;
    326 			sc->sc_gpio_pins[pin].pin_state = 0;
    327 			aprint_debug_dev(sc->sc_dev, "skip pin %d - func = %x\n", pin, func);
    328 		}
    329 	}
    330 
    331 	/* Initialize interrupts. */
    332 	for (bank = 0; bank < BCMGPIO_NBANKS; bank++) {
    333 		char intrstr[128];
    334 
    335 		if (!fdtbus_intr_str(phandle, bank, intrstr, sizeof(intrstr))) {
    336 			aprint_error_dev(self, "failed to decode interrupt\n");
    337 			continue;
    338 		}
    339 
    340 		sc->sc_banks[bank].sc_bankno = bank;
    341 		sc->sc_banks[bank].sc_bcm = sc;
    342 		sc->sc_banks[bank].sc_ih =
    343 		    fdtbus_intr_establish(phandle, bank, IPL_VM,
    344 		    			  FDT_INTR_MPSAFE,
    345 					  bcmgpio_intr, &sc->sc_banks[bank]);
    346 		if (sc->sc_banks[bank].sc_ih) {
    347 			aprint_normal_dev(self,
    348 			    "pins %d..%d interrupting on %s\n",
    349 			    bank * 32,
    350 			    MIN((bank * 32) + 31, sc->sc_maxpins),
    351 			    intrstr);
    352 		} else {
    353 			aprint_error_dev(self,
    354 			    "failed to establish interrupt for pins %d..%d\n",
    355 			    bank * 32,
    356 			    MIN((bank * 32) + 31, sc->sc_maxpins));
    357 		}
    358 	}
    359 
    360 	fdtbus_register_gpio_controller(self, faa->faa_phandle, &bcmgpio_funcs);
    361 
    362 	for (int child = OF_child(phandle); child; child = OF_peer(child)) {
    363 		if (!of_hasprop(child, "brcm,pins"))
    364 			continue;
    365 		fdtbus_register_pinctrl_config(self, child,
    366 		    &bcm283x_pinctrl_funcs);
    367 	}
    368 
    369 	fdtbus_register_interrupt_controller(self, phandle,
    370 	    &bcmgpio_fdt_intrfuncs);
    371 
    372 	/* create controller tag */
    373 	sc->sc_gpio_gc.gp_cookie = sc;
    374 	sc->sc_gpio_gc.gp_pin_read = bcm2835gpio_gpio_pin_read;
    375 	sc->sc_gpio_gc.gp_pin_write = bcm2835gpio_gpio_pin_write;
    376 	sc->sc_gpio_gc.gp_pin_ctl = bcm2835gpio_gpio_pin_ctl;
    377 	sc->sc_gpio_gc.gp_intr_establish = bcmgpio_gpio_intr_establish;
    378 	sc->sc_gpio_gc.gp_intr_disestablish = bcmgpio_gpio_intr_disestablish;
    379 	sc->sc_gpio_gc.gp_intr_str = bcmgpio_gpio_intrstr;
    380 
    381 	gba.gba_gc = &sc->sc_gpio_gc;
    382 	gba.gba_pins = &sc->sc_gpio_pins[0];
    383 	gba.gba_npins = sc->sc_maxpins;
    384 	(void) config_found_ia(self, "gpiobus", &gba, gpiobus_print);
    385 }
    386 
    387 /* GPIO interrupt support functions */
    388 
    389 static int
    390 bcmgpio_intr(void *arg)
    391 {
    392 	struct bcmgpio_bank * const b = arg;
    393 	struct bcmgpio_softc * const sc = b->sc_bcm;
    394 	struct bcmgpio_eint *eint;
    395 	uint32_t status, pending, bit;
    396 	uint32_t clear_level;
    397 	int (*func)(void *);
    398 	int rv = 0;
    399 
    400 	for (;;) {
    401 		status = pending = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    402 		    BCM2835_GPIO_GPEDS(b->sc_bankno));
    403 		if (status == 0)
    404 			break;
    405 
    406 		/*
    407 		 * This will clear the indicator for any pending
    408 		 * edge-triggered pins, but level-triggered pins
    409 		 * will still be indicated until the pin is
    410 		 * de-asserted.  We'll have to clear level-triggered
    411 		 * indicators below.
    412 		 */
    413 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    414 		    BCM2835_GPIO_GPEDS(b->sc_bankno), status);
    415 		clear_level = 0;
    416 
    417 		while ((bit = ffs32(pending)) != 0) {
    418 			pending &= ~__BIT(bit - 1);
    419 			eint = &b->sc_eint[bit - 1];
    420 			if ((func = eint->eint_func) == NULL)
    421 				continue;
    422 			if (eint->eint_flags & (BCMGPIO_INTR_HIGH_LEVEL |
    423 						BCMGPIO_INTR_LOW_LEVEL))
    424 				clear_level |= __BIT(bit - 1);
    425 			const bool mpsafe =
    426 			    (eint->eint_flags & BCMGPIO_INTR_MPSAFE) != 0;
    427 			if (!mpsafe)
    428 				KERNEL_LOCK(1, curlwp);
    429 			rv |= (*func)(eint->eint_arg);
    430 			if (!mpsafe)
    431 				KERNEL_UNLOCK_ONE(curlwp);
    432 		}
    433 
    434 		/*
    435 		 * Now that all of the handlers have been called,
    436 		 * we can clear the indicators for any level-triggered
    437 		 * pins.
    438 		 */
    439 		if (clear_level)
    440 			bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    441 			    BCM2835_GPIO_GPEDS(b->sc_bankno), clear_level);
    442 	}
    443 
    444 	return (rv);
    445 }
    446 
    447 static void *
    448 bmcgpio_intr_enable(struct bcmgpio_softc *sc, int (*func)(void *), void *arg,
    449 		    int bank, int pin, int flags)
    450 {
    451 	struct bcmgpio_eint *eint;
    452 	uint32_t mask, enabled_ren, enabled_fen, enabled_hen, enabled_len;
    453 	int has_edge = flags & (BCMGPIO_INTR_POS_EDGE|BCMGPIO_INTR_NEG_EDGE);
    454 	int has_level = flags &
    455 	    (BCMGPIO_INTR_HIGH_LEVEL|BCMGPIO_INTR_LOW_LEVEL);
    456 
    457 	if (bank < 0 || bank >= BCMGPIO_NBANKS)
    458 		return NULL;
    459 	if (pin < 0 || pin >= 32)
    460 		return (NULL);
    461 
    462 	/* Must specify a mode. */
    463 	if (!has_edge && !has_level)
    464 		return (NULL);
    465 
    466 	/* Can't have HIGH and LOW together. */
    467 	if (has_level == (BCMGPIO_INTR_HIGH_LEVEL|BCMGPIO_INTR_LOW_LEVEL))
    468 		return (NULL);
    469 
    470 	/* Can't have EDGE and LEVEL together. */
    471 	if (has_edge && has_level)
    472 		return (NULL);
    473 
    474 	eint = &sc->sc_banks[bank].sc_eint[pin];
    475 
    476 	mask = __BIT(pin);
    477 
    478 	mutex_enter(&sc->sc_lock);
    479 
    480 	if (eint->eint_func != NULL) {
    481 		mutex_exit(&sc->sc_lock);
    482 		return (NULL);	/* in use */
    483 	}
    484 
    485 	eint->eint_func = func;
    486 	eint->eint_arg = arg;
    487 	eint->eint_flags = flags;
    488 	eint->eint_bank = bank;
    489 	eint->eint_num = pin;
    490 
    491 	enabled_ren = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    492 				       BCM2835_GPIO_GPREN(bank));
    493 	enabled_fen = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    494 				       BCM2835_GPIO_GPFEN(bank));
    495 	enabled_hen = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    496 				       BCM2835_GPIO_GPHEN(bank));
    497 	enabled_len = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    498 				       BCM2835_GPIO_GPLEN(bank));
    499 
    500 	enabled_ren &= ~mask;
    501 	enabled_fen &= ~mask;
    502 	enabled_hen &= ~mask;
    503 	enabled_len &= ~mask;
    504 
    505 	if (flags & BCMGPIO_INTR_POS_EDGE)
    506 		enabled_ren |= mask;
    507 	if (flags & BCMGPIO_INTR_NEG_EDGE)
    508 		enabled_fen |= mask;
    509 	if (flags & BCMGPIO_INTR_HIGH_LEVEL)
    510 		enabled_hen |= mask;
    511 	if (flags & BCMGPIO_INTR_LOW_LEVEL)
    512 		enabled_len |= mask;
    513 
    514 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    515 			  BCM2835_GPIO_GPREN(bank), enabled_ren);
    516 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    517 			  BCM2835_GPIO_GPFEN(bank), enabled_fen);
    518 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    519 			  BCM2835_GPIO_GPHEN(bank), enabled_hen);
    520 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    521 			  BCM2835_GPIO_GPLEN(bank), enabled_len);
    522 
    523 	mutex_exit(&sc->sc_lock);
    524 	return (eint);
    525 }
    526 
    527 static void
    528 bcmgpio_intr_disable(struct bcmgpio_softc *sc, struct bcmgpio_eint *eint)
    529 {
    530 	uint32_t mask, enabled_ren, enabled_fen, enabled_hen, enabled_len;
    531 	int bank = eint->eint_bank;
    532 
    533 	mask = __BIT(eint->eint_num);
    534 
    535 	KASSERT(eint->eint_func != NULL);
    536 
    537 	mutex_enter(&sc->sc_lock);
    538 
    539 	enabled_ren = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    540 				       BCM2835_GPIO_GPREN(bank));
    541 	enabled_fen = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    542 				       BCM2835_GPIO_GPFEN(bank));
    543 	enabled_hen = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    544 				       BCM2835_GPIO_GPHEN(bank));
    545 	enabled_len = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    546 				       BCM2835_GPIO_GPLEN(bank));
    547 
    548 	enabled_ren &= ~mask;
    549 	enabled_fen &= ~mask;
    550 	enabled_hen &= ~mask;
    551 	enabled_len &= ~mask;
    552 
    553 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    554 			  BCM2835_GPIO_GPREN(bank), enabled_ren);
    555 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    556 			  BCM2835_GPIO_GPFEN(bank), enabled_fen);
    557 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    558 			  BCM2835_GPIO_GPHEN(bank), enabled_hen);
    559 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    560 			  BCM2835_GPIO_GPLEN(bank), enabled_len);
    561 
    562 	eint->eint_func = NULL;
    563 	eint->eint_arg = NULL;
    564 	eint->eint_flags = 0;
    565 
    566 	mutex_exit(&sc->sc_lock);
    567 }
    568 
    569 static void *
    570 bcmgpio_fdt_intr_establish(device_t dev, u_int *specifier, int ipl, int flags,
    571     int (*func)(void *), void *arg, const char *xname)
    572 {
    573 	struct bcmgpio_softc * const sc = device_private(dev);
    574 	int eint_flags = (flags & FDT_INTR_MPSAFE) ? BCMGPIO_INTR_MPSAFE : 0;
    575 
    576 	if (ipl != IPL_VM) {
    577 		aprint_error_dev(dev, "%s: wrong IPL %d (expected %d)\n",
    578 		    __func__, ipl, IPL_VM);
    579 		return (NULL);
    580 	}
    581 
    582 	/* 1st cell is the GPIO number */
    583 	/* 2nd cell is flags */
    584 	const u_int bank = be32toh(specifier[0]) / 32;
    585 	const u_int pin = be32toh(specifier[0]) % 32;
    586 	const u_int type = be32toh(specifier[1]) & 0xf;
    587 
    588 	switch (type) {
    589 	case FDT_INTR_TYPE_POS_EDGE:
    590 		eint_flags |= BCMGPIO_INTR_POS_EDGE;
    591 		break;
    592 	case FDT_INTR_TYPE_NEG_EDGE:
    593 		eint_flags |= BCMGPIO_INTR_NEG_EDGE;
    594 		break;
    595 	case FDT_INTR_TYPE_DOUBLE_EDGE:
    596 		eint_flags |= BCMGPIO_INTR_POS_EDGE | BCMGPIO_INTR_NEG_EDGE;
    597 		break;
    598 	case FDT_INTR_TYPE_HIGH_LEVEL:
    599 		eint_flags |= BCMGPIO_INTR_HIGH_LEVEL;
    600 		break;
    601 	case FDT_INTR_TYPE_LOW_LEVEL:
    602 		eint_flags |= BCMGPIO_INTR_LOW_LEVEL;
    603 		break;
    604 	default:
    605 		aprint_error_dev(dev, "%s: unsupported irq type 0x%x\n",
    606 		    __func__, type);
    607 		return (NULL);
    608 	}
    609 
    610 	return (bmcgpio_intr_enable(sc, func, arg, bank, pin, eint_flags));
    611 }
    612 
    613 static void
    614 bcmgpio_fdt_intr_disestablish(device_t dev, void *ih)
    615 {
    616 	struct bcmgpio_softc * const sc = device_private(dev);
    617 	struct bcmgpio_eint * const eint = ih;
    618 
    619 	bcmgpio_intr_disable(sc, eint);
    620 }
    621 
    622 static void *
    623 bcmgpio_gpio_intr_establish(void *vsc, int pin, int ipl, int irqmode,
    624 			    int (*func)(void *), void *arg)
    625 {
    626 	struct bcmgpio_softc * const sc = vsc;
    627 	int eint_flags = (irqmode & GPIO_INTR_MPSAFE) ? BCMGPIO_INTR_MPSAFE : 0;
    628 	int bank = pin / 32;
    629 	int type = irqmode & GPIO_INTR_MODE_MASK;
    630 
    631 	pin %= 32;
    632 
    633 	if (ipl != IPL_VM) {
    634 		aprint_error_dev(sc->sc_dev, "%s: wrong IPL %d (expected %d)\n",
    635 		    __func__, ipl, IPL_VM);
    636 		return (NULL);
    637 	}
    638 
    639 	switch (type) {
    640 	case GPIO_INTR_POS_EDGE:
    641 		eint_flags |= BCMGPIO_INTR_POS_EDGE;
    642 		break;
    643 	case GPIO_INTR_NEG_EDGE:
    644 		eint_flags |= BCMGPIO_INTR_NEG_EDGE;
    645 		break;
    646 	case GPIO_INTR_DOUBLE_EDGE:
    647 		eint_flags |= BCMGPIO_INTR_POS_EDGE | BCMGPIO_INTR_NEG_EDGE;
    648 		break;
    649 	case GPIO_INTR_HIGH_LEVEL:
    650 		eint_flags |= BCMGPIO_INTR_HIGH_LEVEL;
    651 		break;
    652 	case GPIO_INTR_LOW_LEVEL:
    653 		eint_flags |= BCMGPIO_INTR_LOW_LEVEL;
    654 		break;
    655 	default:
    656 		aprint_error_dev(sc->sc_dev, "%s: unsupported irq type 0x%x\n",
    657 		    __func__, type);
    658 		return (NULL);
    659 	}
    660 
    661 	return (bmcgpio_intr_enable(sc, func, arg, bank, pin, eint_flags));
    662 }
    663 
    664 static void
    665 bcmgpio_gpio_intr_disestablish(void *vsc, void *ih)
    666 {
    667 	struct bcmgpio_softc * const sc = vsc;
    668 	struct bcmgpio_eint * const eint = ih;
    669 
    670 	bcmgpio_intr_disable(sc, eint);
    671 }
    672 
    673 static bool
    674 bcmgpio_gpio_intrstr(void *vsc, int pin, int irqmode, char *buf, size_t buflen)
    675 {
    676 	struct bcmgpio_softc * const sc = vsc;
    677 
    678 	if (pin < 0 || pin >= sc->sc_maxpins)
    679 		return (false);
    680 
    681 	snprintf(buf, buflen, "GPIO %d", pin);
    682 
    683 	return (true);
    684 }
    685 
    686 static bool
    687 bcmgpio_fdt_intrstr(device_t dev, u_int *specifier, char *buf, size_t buflen)
    688 {
    689 
    690 	/* 1st cell is the GPIO number */
    691 	/* 2nd cell is flags */
    692 	if (!specifier)
    693 		return (false);
    694 	const u_int bank = be32toh(specifier[0]) / 32;
    695 	const u_int pin = be32toh(specifier[0]) % 32;
    696 	const u_int type = be32toh(specifier[1]) & 0xf;
    697 	char const* typestr;
    698 
    699 	if (bank >= BCMGPIO_NBANKS)
    700 		return (false);
    701 	switch (type) {
    702 	case FDT_INTR_TYPE_DOUBLE_EDGE:
    703 		typestr = "double edge";
    704 		break;
    705 	case FDT_INTR_TYPE_POS_EDGE:
    706 		typestr = "positive edge";
    707 		break;
    708 	case FDT_INTR_TYPE_NEG_EDGE:
    709 		typestr = "negative edge";
    710 		break;
    711 	case FDT_INTR_TYPE_HIGH_LEVEL:
    712 		typestr = "high level";
    713 		break;
    714 	case FDT_INTR_TYPE_LOW_LEVEL:
    715 		typestr = "low level";
    716 		break;
    717 	default:
    718 		aprint_error_dev(dev, "%s: unsupported irq type 0x%x\n",
    719 		    __func__, type);
    720 
    721 		return (false);
    722 	}
    723 
    724 	snprintf(buf, buflen, "GPIO %u (%s)", (bank * 32) + pin, typestr);
    725 
    726 	return (true);
    727 }
    728 
    729 /* GPIO support functions */
    730 static int
    731 bcm2835gpio_gpio_pin_read(void *arg, int pin)
    732 {
    733 	struct bcmgpio_softc *sc = arg;
    734 	uint32_t val;
    735 	int res;
    736 
    737 	val = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    738 		BCM2835_GPIO_GPLEV(pin / BCM2835_GPIO_GPLEV_PINS_PER_REGISTER));
    739 
    740 	res = val & (1 << (pin % BCM2835_GPIO_GPLEV_PINS_PER_REGISTER)) ?
    741 		GPIO_PIN_HIGH : GPIO_PIN_LOW;
    742 
    743 	DPRINTF(2, ("%s: gpio_read pin %d->%d\n", device_xname(sc->sc_dev),
    744 	    pin, (res == GPIO_PIN_HIGH)));
    745 
    746 	return res;
    747 }
    748 
    749 static void
    750 bcm2835gpio_gpio_pin_write(void *arg, int pin, int value)
    751 {
    752 	struct bcmgpio_softc *sc = arg;
    753 	bus_size_t reg;
    754 
    755 	if (value == GPIO_PIN_HIGH) {
    756 		reg = BCM2835_GPIO_GPSET(pin / BCM2835_GPIO_GPSET_PINS_PER_REGISTER);
    757 	} else {
    758 		reg = BCM2835_GPIO_GPCLR(pin / BCM2835_GPIO_GPCLR_PINS_PER_REGISTER);
    759 	}
    760 
    761 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, reg,
    762 	    1 << (pin % BCM2835_GPIO_GPSET_PINS_PER_REGISTER));
    763 
    764 	DPRINTF(2, ("%s: gpio_write pin %d<-%d\n", device_xname(sc->sc_dev),
    765 	    pin, (value == GPIO_PIN_HIGH)));
    766 }
    767 
    768 
    769 void
    770 bcm283x_pin_setfunc(const struct bcmgpio_softc * const sc, u_int pin,
    771     u_int func)
    772 {
    773 	const u_int mask = (1 << BCM2835_GPIO_GPFSEL_BITS_PER_PIN) - 1;
    774 	const u_int regid = (pin / BCM2835_GPIO_GPFSEL_PINS_PER_REGISTER);
    775 	const u_int shift = (pin % BCM2835_GPIO_GPFSEL_PINS_PER_REGISTER) *
    776 	    BCM2835_GPIO_GPFSEL_BITS_PER_PIN;
    777 	uint32_t v;
    778 
    779 	KASSERT(mutex_owned(&sc->sc_lock));
    780 	KASSERT(func <= mask);
    781 
    782 	v = bus_space_read_4(sc->sc_iot, sc->sc_ioh, BCM2835_GPIO_GPFSEL(regid));
    783 
    784 	if (((v >> shift) & mask) == func) {
    785 		return;
    786 	}
    787 
    788 	DPRINTF(2, ("%s: gpio_write pin %d<-%d\n", device_xname(sc->sc_dev),
    789 	    pin, func));
    790 
    791 	v &= ~(mask << shift);
    792 	v |=  (func << shift);
    793 
    794 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, BCM2835_GPIO_GPFSEL(regid), v);
    795 }
    796 
    797 u_int
    798 bcm283x_pin_getfunc(const struct bcmgpio_softc * const sc, u_int pin)
    799 {
    800 	const u_int mask = (1 << BCM2835_GPIO_GPFSEL_BITS_PER_PIN) - 1;
    801 	const u_int regid = (pin / BCM2835_GPIO_GPFSEL_PINS_PER_REGISTER);
    802 	const u_int shift = (pin % BCM2835_GPIO_GPFSEL_PINS_PER_REGISTER) *
    803 	    BCM2835_GPIO_GPFSEL_BITS_PER_PIN;
    804 	uint32_t v;
    805 
    806 	v = bus_space_read_4(sc->sc_iot, sc->sc_ioh, BCM2835_GPIO_GPFSEL(regid));
    807 
    808 	return ((v >> shift) & mask);
    809 }
    810 
    811 void
    812 bcm283x_pin_setpull(const struct bcmgpio_softc * const sc, u_int pin, u_int pud)
    813 {
    814 
    815 	KASSERT(mutex_owned(&sc->sc_lock));
    816 
    817 	u_int mask, regid;
    818 	uint32_t reg;
    819 
    820 	if (sc->sc_is2835) {
    821 		mask = 1 << (pin % BCM2835_GPIO_GPPUD_PINS_PER_REGISTER);
    822 		regid = (pin / BCM2835_GPIO_GPPUD_PINS_PER_REGISTER);
    823 
    824 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    825 		    BCM2835_GPIO_GPPUD, pud);
    826 		delay(1);
    827 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    828 		    BCM2835_GPIO_GPPUDCLK(regid), mask);
    829 		delay(1);
    830 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    831 		    BCM2835_GPIO_GPPUD, 0);
    832 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    833 		    BCM2835_GPIO_GPPUDCLK(regid), 0);
    834 	} else {
    835 		mask = BCM2838_GPIO_GPPUD_MASK(pin);
    836 		regid = BCM2838_GPIO_GPPUD_REGID(pin);
    837 
    838 		switch (pud) {
    839 		case BCM2835_GPIO_GPPUD_PULLUP:
    840 			pud = BCM2838_GPIO_GPPUD_PULLUP;
    841 			break;
    842 		case BCM2835_GPIO_GPPUD_PULLDOWN:
    843 			pud = BCM2838_GPIO_GPPUD_PULLDOWN;
    844 			break;
    845 		default:
    846 			pud = BCM2838_GPIO_GPPUD_PULLOFF;
    847 			break;
    848 		}
    849 
    850 		reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    851 		    BCM2838_GPIO_GPPUPPDN(regid));
    852 		reg &= ~mask;
    853 		reg |= __SHIFTIN(pud, mask);
    854 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    855 		    BCM2838_GPIO_GPPUPPDN(regid), reg);
    856 	}
    857 }
    858 
    859 
    860 static void
    861 bcm2835gpio_gpio_pin_ctl(void *arg, int pin, int flags)
    862 {
    863 	struct bcmgpio_softc *sc = arg;
    864 	uint32_t cmd;
    865 	uint32_t altmask = GPIO_PIN_ALT0 | GPIO_PIN_ALT1 |
    866 	                   GPIO_PIN_ALT2 | GPIO_PIN_ALT3 |
    867 	                   GPIO_PIN_ALT4 | GPIO_PIN_ALT5;
    868 
    869 	DPRINTF(2, ("%s: gpio_ctl pin %d flags 0x%x\n", device_xname(sc->sc_dev), pin, flags));
    870 
    871 	mutex_enter(&sc->sc_lock);
    872 	if (flags & (GPIO_PIN_OUTPUT|GPIO_PIN_INPUT)) {
    873 		if ((flags & GPIO_PIN_INPUT) != 0) {
    874 			/* for safety INPUT will overide output */
    875 			bcm283x_pin_setfunc(sc, pin, BCM2835_GPIO_IN);
    876 		} else {
    877 			bcm283x_pin_setfunc(sc, pin, BCM2835_GPIO_OUT);
    878 		}
    879 	} else if ((flags & altmask) != 0) {
    880 		u_int func;
    881 
    882 		switch (flags & altmask) {
    883 		case GPIO_PIN_ALT0:
    884 			func = BCM2835_GPIO_ALT0;
    885 			break;
    886 		case GPIO_PIN_ALT1:
    887 			func = BCM2835_GPIO_ALT1;
    888 			break;
    889 		case GPIO_PIN_ALT2:
    890 			func = BCM2835_GPIO_ALT2;
    891 			break;
    892 		case GPIO_PIN_ALT3:
    893 			func = BCM2835_GPIO_ALT3;
    894 			break;
    895 		case GPIO_PIN_ALT4:
    896 			func = BCM2835_GPIO_ALT4;
    897 			break;
    898 		case GPIO_PIN_ALT5:
    899 			func = BCM2835_GPIO_ALT5;
    900 			break;
    901 		default:
    902 			/* ignored below */
    903 			func = BCM2835_GPIO_IN;
    904 			break;
    905 		}
    906 		if (func != BCM2835_GPIO_IN)
    907 			bcm283x_pin_setfunc(sc, pin, func);
    908 	}
    909 
    910 	if (flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) {
    911 		cmd = (flags & GPIO_PIN_PULLUP) ?
    912 			BCM2835_GPIO_GPPUD_PULLUP : BCM2835_GPIO_GPPUD_PULLDOWN;
    913 	} else {
    914 		cmd = BCM2835_GPIO_GPPUD_PULLOFF;
    915 	}
    916 
    917 	bcm283x_pin_setpull(sc, pin, cmd);
    918 	mutex_exit(&sc->sc_lock);
    919 }
    920 
    921 static void *
    922 bcmgpio_fdt_acquire(device_t dev, const void *data, size_t len, int flags)
    923 {
    924 	struct bcmgpio_softc *sc = device_private(dev);
    925 	struct bcmgpio_pin *gpin;
    926 	const u_int *gpio = data;
    927 
    928 	if (len != 12)
    929 		return NULL;
    930 
    931 	const u_int pin = be32toh(gpio[1]);
    932 	const bool actlo = be32toh(gpio[2]) & 1;
    933 
    934 	if (pin >= sc->sc_maxpins)
    935 		return NULL;
    936 
    937 	gpin = kmem_alloc(sizeof(*gpin), KM_SLEEP);
    938 	gpin->pin_no = pin;
    939 	gpin->pin_flags = flags;
    940 	gpin->pin_actlo = actlo;
    941 
    942 	bcm2835gpio_gpio_pin_ctl(sc, gpin->pin_no, gpin->pin_flags);
    943 
    944 	return gpin;
    945 }
    946 
    947 static void
    948 bcmgpio_fdt_release(device_t dev, void *priv)
    949 {
    950 	struct bcmgpio_softc *sc = device_private(dev);
    951 	struct bcmgpio_pin *gpin = priv;
    952 
    953 	bcm2835gpio_gpio_pin_ctl(sc, gpin->pin_no, GPIO_PIN_INPUT);
    954 	kmem_free(gpin, sizeof(*gpin));
    955 }
    956 
    957 static int
    958 bcmgpio_fdt_read(device_t dev, void *priv, bool raw)
    959 {
    960 	struct bcmgpio_softc *sc = device_private(dev);
    961 	struct bcmgpio_pin *gpin = priv;
    962 	int val;
    963 
    964 	val = bcm2835gpio_gpio_pin_read(sc, gpin->pin_no);
    965 
    966 	if (!raw && gpin->pin_actlo)
    967 		val = !val;
    968 
    969 	return val;
    970 }
    971 
    972 static void
    973 bcmgpio_fdt_write(device_t dev, void *priv, int val, bool raw)
    974 {
    975 	struct bcmgpio_softc *sc = device_private(dev);
    976 	struct bcmgpio_pin *gpin = priv;
    977 
    978 	if (!raw && gpin->pin_actlo)
    979 		val = !val;
    980 
    981 	bcm2835gpio_gpio_pin_write(sc, gpin->pin_no, val);
    982 }
    983