2 * Copyright (c) 2016 Michal Meloun <mmel@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
38 #include <machine/bus.h>
40 #include <dev/fdt/fdt_common.h>
41 #include <dev/gpio/gpiobusvar.h>
45 MALLOC_DEFINE(M_AS3722_GPIO, "AS3722 gpio", "AS3722 GPIO");
47 /* AS3722_GPIOx_CONTROL MODE and IOSF definition. */
48 #define AS3722_IOSF_GPIO 0x00
49 #define AS3722_IOSF_INTERRUPT_OUT 0x01
50 #define AS3722_IOSF_VSUP_VBAT_LOW_UNDEBOUNCE_OUT 0x02
51 #define AS3722_IOSF_GPIO_IN_INTERRUPT 0x03
52 #define AS3722_IOSF_PWM_IN 0x04
53 #define AS3722_IOSF_VOLTAGE_IN_STANDBY 0x05
54 #define AS3722_IOSF_OC_PG_SD0 0x06
55 #define AS3722_IOSF_POWERGOOD_OUT 0x07
56 #define AS3722_IOSF_CLK32K_OUT 0x08
57 #define AS3722_IOSF_WATCHDOG_IN 0x09
58 #define AS3722_IOSF_SOFT_RESET_IN 0x0b
59 #define AS3722_IOSF_PWM_OUT 0x0c
60 #define AS3722_IOSF_VSUP_VBAT_LOW_DEBOUNCE_OUT 0x0d
61 #define AS3722_IOSF_OC_PG_SD6 0x0e
63 #define AS3722_MODE_INPUT 0
64 #define AS3722_MODE_PUSH_PULL 1
65 #define AS3722_MODE_OPEN_DRAIN 2
66 #define AS3722_MODE_TRISTATE 3
67 #define AS3722_MODE_INPUT_PULL_UP_LV 4
68 #define AS3722_MODE_INPUT_PULL_DOWN 5
69 #define AS3722_MODE_OPEN_DRAIN_LV 6
70 #define AS3722_MODE_PUSH_PULL_LV 7
74 #define GPIO_LOCK(_sc) sx_slock(&(_sc)->gpio_lock)
75 #define GPIO_UNLOCK(_sc) sx_unlock(&(_sc)->gpio_lock)
76 #define GPIO_ASSERT(_sc) sx_assert(&(_sc)->gpio_lock, SA_LOCKED)
78 #define AS3722_CFG_BIAS_DISABLE 0x0001
79 #define AS3722_CFG_BIAS_PULL_UP 0x0002
80 #define AS3722_CFG_BIAS_PULL_DOWN 0x0004
81 #define AS3722_CFG_BIAS_HIGH_IMPEDANCE 0x0008
82 #define AS3722_CFG_OPEN_DRAIN 0x0010
86 int config; /* AS3722_CFG_ */
87 } as3722_cfg_names[] = {
88 {"bias-disable", AS3722_CFG_BIAS_DISABLE},
89 {"bias-pull-up", AS3722_CFG_BIAS_PULL_UP},
90 {"bias-pull-down", AS3722_CFG_BIAS_PULL_DOWN},
91 {"bias-high-impedance", AS3722_CFG_BIAS_HIGH_IMPEDANCE},
92 {"drive-open-drain", AS3722_CFG_OPEN_DRAIN},
98 } as3722_fnc_table[] = {
99 {"gpio", AS3722_IOSF_GPIO},
100 {"interrupt-out", AS3722_IOSF_INTERRUPT_OUT},
101 {"vsup-vbat-low-undebounce-out", AS3722_IOSF_VSUP_VBAT_LOW_UNDEBOUNCE_OUT},
102 {"gpio-in-interrupt", AS3722_IOSF_GPIO_IN_INTERRUPT},
103 {"pwm-in", AS3722_IOSF_PWM_IN},
104 {"voltage-in-standby", AS3722_IOSF_VOLTAGE_IN_STANDBY},
105 {"oc-pg-sd0", AS3722_IOSF_OC_PG_SD0},
106 {"powergood-out", AS3722_IOSF_POWERGOOD_OUT},
107 {"clk32k-out", AS3722_IOSF_CLK32K_OUT},
108 {"watchdog-in", AS3722_IOSF_WATCHDOG_IN},
109 {"soft-reset-in", AS3722_IOSF_SOFT_RESET_IN},
110 {"pwm-out", AS3722_IOSF_PWM_OUT},
111 {"vsup-vbat-low-debounce-out", AS3722_IOSF_VSUP_VBAT_LOW_DEBOUNCE_OUT},
112 {"oc-pg-sd6", AS3722_IOSF_OC_PG_SD6},
115 struct as3722_pincfg {
120 struct as3722_gpio_pin {
122 uint8_t pin_ctrl_reg;
123 char pin_name[GPIOMAXNAME];
127 /* --------------------------------------------------------------------------
132 as3722_pinmux_get_function(struct as3722_softc *sc, char *name)
136 for (i = 0; i < nitems(as3722_fnc_table); i++) {
137 if (strcmp(as3722_fnc_table[i].name, name) == 0)
138 return (as3722_fnc_table[i].fnc_val);
144 as3722_pinmux_config_node(struct as3722_softc *sc, char *pin_name,
145 struct as3722_pincfg *cfg)
150 for (pin = 0; pin < sc->gpio_npins; pin++) {
151 if (strcmp(sc->gpio_pins[pin]->pin_name, pin_name) == 0)
154 if (pin >= sc->gpio_npins) {
155 device_printf(sc->dev, "Unknown pin: %s\n", pin_name);
159 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
160 sc->gpio_pins[pin]->pin_cfg_flags = cfg->flags;
161 if (cfg->function != NULL) {
162 fnc = as3722_pinmux_get_function(sc, cfg->function);
164 device_printf(sc->dev,
165 "Unknown function %s for pin %s\n", cfg->function,
166 sc->gpio_pins[pin]->pin_name);
170 case AS3722_IOSF_INTERRUPT_OUT:
171 case AS3722_IOSF_VSUP_VBAT_LOW_UNDEBOUNCE_OUT:
172 case AS3722_IOSF_OC_PG_SD0:
173 case AS3722_IOSF_POWERGOOD_OUT:
174 case AS3722_IOSF_CLK32K_OUT:
175 case AS3722_IOSF_PWM_OUT:
176 case AS3722_IOSF_OC_PG_SD6:
177 ctrl &= ~(AS3722_GPIO_MODE_MASK <<
178 AS3722_GPIO_MODE_SHIFT);
179 ctrl |= AS3722_MODE_PUSH_PULL << AS3722_GPIO_MODE_SHIFT;
180 /* XXX Handle flags (OC + pullup) */
182 case AS3722_IOSF_GPIO_IN_INTERRUPT:
183 case AS3722_IOSF_PWM_IN:
184 case AS3722_IOSF_VOLTAGE_IN_STANDBY:
185 case AS3722_IOSF_WATCHDOG_IN:
186 case AS3722_IOSF_SOFT_RESET_IN:
187 ctrl &= ~(AS3722_GPIO_MODE_MASK <<
188 AS3722_GPIO_MODE_SHIFT);
189 ctrl |= AS3722_MODE_INPUT << AS3722_GPIO_MODE_SHIFT;
190 /* XXX Handle flags (pulldown + pullup) */
195 ctrl &= ~(AS3722_GPIO_IOSF_MASK << AS3722_GPIO_IOSF_SHIFT);
196 ctrl |= fnc << AS3722_GPIO_IOSF_SHIFT;
199 if (ctrl != sc->gpio_pins[pin]->pin_ctrl_reg) {
200 rv = WR1(sc, AS3722_GPIO0_CONTROL + pin, ctrl);
201 sc->gpio_pins[pin]->pin_ctrl_reg = ctrl;
207 as3722_pinmux_read_node(struct as3722_softc *sc, phandle_t node,
208 struct as3722_pincfg *cfg, char **pins, int *lpins)
212 *lpins = OF_getprop_alloc(node, "pins", (void **)pins);
216 /* Read function (mux) settings. */
217 rv = OF_getprop_alloc(node, "function", (void **)&cfg->function);
219 cfg->function = NULL;
221 /* Read boolean properties. */
222 for (i = 0; i < nitems(as3722_cfg_names); i++) {
223 if (OF_hasprop(node, as3722_cfg_names[i].name))
224 cfg->flags |= as3722_cfg_names[i].config;
230 as3722_pinmux_process_node(struct as3722_softc *sc, phandle_t node)
232 struct as3722_pincfg cfg;
234 int i, len, lpins, rv;
236 rv = as3722_pinmux_read_node(sc, node, &cfg, &pins, &lpins);
243 i = strlen(pname) + 1;
244 rv = as3722_pinmux_config_node(sc, pname, &cfg);
246 device_printf(sc->dev,
247 "Cannot configure pin: %s: %d\n", pname, rv);
251 } while (len < lpins);
255 if (cfg.function != NULL)
256 OF_prop_free(cfg.function);
261 int as3722_pinmux_configure(device_t dev, phandle_t cfgxref)
263 struct as3722_softc *sc;
264 phandle_t node, cfgnode;
267 sc = device_get_softc(dev);
268 cfgnode = OF_node_from_xref(cfgxref);
270 for (node = OF_child(cfgnode); node != 0; node = OF_peer(node)) {
271 if (!ofw_bus_node_status_okay(node))
273 rv = as3722_pinmux_process_node(sc, node);
275 device_printf(dev, "Failed to process pinmux");
280 /* --------------------------------------------------------------------------
285 as3722_gpio_get_bus(device_t dev)
287 struct as3722_softc *sc;
289 sc = device_get_softc(dev);
290 return (sc->gpio_busdev);
294 as3722_gpio_pin_max(device_t dev, int *maxpin)
302 as3722_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
304 struct as3722_softc *sc;
306 sc = device_get_softc(dev);
307 if (pin >= sc->gpio_npins)
310 *caps = sc->gpio_pins[pin]->pin_caps;
316 as3722_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
318 struct as3722_softc *sc;
320 sc = device_get_softc(dev);
321 if (pin >= sc->gpio_npins)
324 memcpy(name, sc->gpio_pins[pin]->pin_name, GPIOMAXNAME);
330 as3722_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *out_flags)
332 struct as3722_softc *sc;
333 uint8_t tmp, mode, iosf;
337 sc = device_get_softc(dev);
338 if (pin >= sc->gpio_npins)
342 tmp = sc->gpio_pins[pin]->pin_ctrl_reg;
344 iosf = (tmp >> AS3722_GPIO_IOSF_SHIFT) & AS3722_GPIO_IOSF_MASK;
345 mode = (tmp >> AS3722_GPIO_MODE_SHIFT) & AS3722_GPIO_MODE_MASK;
346 inverted = (tmp & AS3722_GPIO_INVERT) != 0;
347 /* Is pin in GPIO mode ? */
348 if (iosf != AS3722_IOSF_GPIO)
353 case AS3722_MODE_INPUT:
354 flags = GPIO_PIN_INPUT;
356 case AS3722_MODE_PUSH_PULL:
357 case AS3722_MODE_PUSH_PULL_LV:
358 flags = GPIO_PIN_OUTPUT;
360 case AS3722_MODE_OPEN_DRAIN:
361 case AS3722_MODE_OPEN_DRAIN_LV:
362 flags = GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | GPIO_PIN_OPENDRAIN;
364 case AS3722_MODE_TRISTATE:
365 flags = GPIO_PIN_TRISTATE;
367 case AS3722_MODE_INPUT_PULL_UP_LV:
368 flags = GPIO_PIN_INPUT | GPIO_PIN_PULLUP;
371 case AS3722_MODE_INPUT_PULL_DOWN:
372 flags = GPIO_PIN_OUTPUT | GPIO_PIN_PULLDOWN;
376 flags |= GPIO_PIN_INVIN | GPIO_PIN_INVOUT;
382 as3722_gpio_get_mode(struct as3722_softc *sc, uint32_t pin, uint32_t gpio_flags)
386 flags = sc->gpio_pins[pin]->pin_cfg_flags;
389 if (flags & AS3722_CFG_BIAS_HIGH_IMPEDANCE ||
390 gpio_flags & GPIO_PIN_TRISTATE)
391 return (AS3722_MODE_TRISTATE);
393 /* Open drain modes. */
394 if (flags & AS3722_CFG_OPEN_DRAIN || gpio_flags & GPIO_PIN_OPENDRAIN) {
395 /* Only pull up have effect */
396 if (flags & AS3722_CFG_BIAS_PULL_UP ||
397 gpio_flags & GPIO_PIN_PULLUP)
398 return (AS3722_MODE_OPEN_DRAIN_LV);
399 return (AS3722_MODE_OPEN_DRAIN);
402 if (gpio_flags & GPIO_PIN_INPUT) {
403 /* Accept pull up or pull down. */
404 if (flags & AS3722_CFG_BIAS_PULL_UP ||
405 gpio_flags & GPIO_PIN_PULLUP)
406 return (AS3722_MODE_INPUT_PULL_UP_LV);
408 if (flags & AS3722_CFG_BIAS_PULL_DOWN ||
409 gpio_flags & GPIO_PIN_PULLDOWN)
410 return (AS3722_MODE_INPUT_PULL_DOWN);
411 return (AS3722_MODE_INPUT);
415 * Pull down is used as indicator of low voltage output.
417 if (flags & AS3722_CFG_BIAS_PULL_DOWN ||
418 gpio_flags & GPIO_PIN_PULLDOWN)
419 return (AS3722_MODE_PUSH_PULL_LV);
420 return (AS3722_MODE_PUSH_PULL);
424 as3722_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
426 struct as3722_softc *sc;
427 uint8_t ctrl, mode, iosf;
430 sc = device_get_softc(dev);
431 if (pin >= sc->gpio_npins)
435 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
436 iosf = (ctrl >> AS3722_GPIO_IOSF_SHIFT) & AS3722_GPIO_IOSF_MASK;
437 /* Is pin in GPIO mode ? */
438 if (iosf != AS3722_IOSF_GPIO) {
442 mode = as3722_gpio_get_mode(sc, pin, flags);
443 ctrl &= ~(AS3722_GPIO_MODE_MASK << AS3722_GPIO_MODE_SHIFT);
444 ctrl |= mode << AS3722_GPIO_MODE_SHIFT;
446 if (ctrl != sc->gpio_pins[pin]->pin_ctrl_reg) {
447 rv = WR1(sc, AS3722_GPIO0_CONTROL + pin, ctrl);
448 sc->gpio_pins[pin]->pin_ctrl_reg = ctrl;
455 as3722_gpio_pin_set(device_t dev, uint32_t pin, uint32_t val)
457 struct as3722_softc *sc;
461 sc = device_get_softc(dev);
462 if (pin >= sc->gpio_npins)
465 tmp = (val != 0) ? 1 : 0;
466 if (sc->gpio_pins[pin]->pin_ctrl_reg & AS3722_GPIO_INVERT)
470 rv = RM1(sc, AS3722_GPIO_SIGNAL_OUT, (1 << pin), (tmp << pin));
476 as3722_gpio_pin_get(device_t dev, uint32_t pin, uint32_t *val)
478 struct as3722_softc *sc;
479 uint8_t tmp, mode, ctrl;
482 sc = device_get_softc(dev);
483 if (pin >= sc->gpio_npins)
487 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
488 mode = (ctrl >> AS3722_GPIO_MODE_SHIFT) & AS3722_GPIO_MODE_MASK;
489 if ((mode == AS3722_MODE_PUSH_PULL) ||
490 (mode == AS3722_MODE_PUSH_PULL_LV))
491 rv = RD1(sc, AS3722_GPIO_SIGNAL_OUT, &tmp);
493 rv = RD1(sc, AS3722_GPIO_SIGNAL_IN, &tmp);
498 *val = tmp & (1 << pin) ? 1 : 0;
499 if (ctrl & AS3722_GPIO_INVERT)
505 as3722_gpio_pin_toggle(device_t dev, uint32_t pin)
507 struct as3722_softc *sc;
511 sc = device_get_softc(dev);
512 if (pin >= sc->gpio_npins)
516 rv = RD1(sc, AS3722_GPIO_SIGNAL_OUT, &tmp);
522 rv = RM1(sc, AS3722_GPIO_SIGNAL_OUT, (1 << pin), tmp);
528 as3722_gpio_map_gpios(device_t dev, phandle_t pdev, phandle_t gparent,
529 int gcells, pcell_t *gpios, uint32_t *pin, uint32_t *flags)
540 as3722_gpio_attach(struct as3722_softc *sc, phandle_t node)
542 struct as3722_gpio_pin *pin;
545 sx_init(&sc->gpio_lock, "AS3722 GPIO lock");
546 sc->gpio_npins = NGPIO;
547 sc->gpio_pins = malloc(sizeof(struct as3722_gpio_pin *) *
548 sc->gpio_npins, M_AS3722_GPIO, M_WAITOK | M_ZERO);
550 sc->gpio_busdev = gpiobus_attach_bus(sc->dev);
551 if (sc->gpio_busdev == NULL)
553 for (i = 0; i < sc->gpio_npins; i++) {
554 sc->gpio_pins[i] = malloc(sizeof(struct as3722_gpio_pin),
555 M_AS3722_GPIO, M_WAITOK | M_ZERO);
556 pin = sc->gpio_pins[i];
557 sprintf(pin->pin_name, "gpio%d", i);
558 pin->pin_caps = GPIO_PIN_INPUT | GPIO_PIN_OUTPUT |
559 GPIO_PIN_OPENDRAIN | GPIO_PIN_PUSHPULL | GPIO_PIN_TRISTATE |
560 GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN | GPIO_PIN_INVIN |
562 rv = RD1(sc, AS3722_GPIO0_CONTROL + i, &pin->pin_ctrl_reg);
564 device_printf(sc->dev,
565 "Cannot read configuration for pin %s\n",
566 sc->gpio_pins[i]->pin_name);