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];
128 /* --------------------------------------------------------------------------
133 as3722_pinmux_get_function(struct as3722_softc *sc, char *name)
137 for (i = 0; i < nitems(as3722_fnc_table); i++) {
138 if (strcmp(as3722_fnc_table[i].name, name) == 0)
139 return (as3722_fnc_table[i].fnc_val);
147 as3722_pinmux_config_node(struct as3722_softc *sc, char *pin_name,
148 struct as3722_pincfg *cfg)
153 for (pin = 0; pin < sc->gpio_npins; pin++) {
154 if (strcmp(sc->gpio_pins[pin]->pin_name, pin_name) == 0)
157 if (pin >= sc->gpio_npins) {
158 device_printf(sc->dev, "Unknown pin: %s\n", pin_name);
162 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
163 sc->gpio_pins[pin]->pin_cfg_flags = cfg->flags;
164 if (cfg->function != NULL) {
165 fnc = as3722_pinmux_get_function(sc, cfg->function);
167 device_printf(sc->dev,
168 "Unknown function %s for pin %s\n", cfg->function,
169 sc->gpio_pins[pin]->pin_name);
173 case AS3722_IOSF_INTERRUPT_OUT:
174 case AS3722_IOSF_VSUP_VBAT_LOW_UNDEBOUNCE_OUT:
175 case AS3722_IOSF_OC_PG_SD0:
176 case AS3722_IOSF_POWERGOOD_OUT:
177 case AS3722_IOSF_CLK32K_OUT:
178 case AS3722_IOSF_PWM_OUT:
179 case AS3722_IOSF_OC_PG_SD6:
180 ctrl &= ~(AS3722_GPIO_MODE_MASK <<
181 AS3722_GPIO_MODE_SHIFT);
182 ctrl |= AS3722_MODE_PUSH_PULL << AS3722_GPIO_MODE_SHIFT;
183 /* XXX Handle flags (OC + pullup) */
185 case AS3722_IOSF_GPIO_IN_INTERRUPT:
186 case AS3722_IOSF_PWM_IN:
187 case AS3722_IOSF_VOLTAGE_IN_STANDBY:
188 case AS3722_IOSF_WATCHDOG_IN:
189 case AS3722_IOSF_SOFT_RESET_IN:
190 ctrl &= ~(AS3722_GPIO_MODE_MASK <<
191 AS3722_GPIO_MODE_SHIFT);
192 ctrl |= AS3722_MODE_INPUT << AS3722_GPIO_MODE_SHIFT;
193 /* XXX Handle flags (pulldown + pullup) */
198 ctrl &= ~(AS3722_GPIO_IOSF_MASK << AS3722_GPIO_IOSF_SHIFT);
199 ctrl |= fnc << AS3722_GPIO_IOSF_SHIFT;
202 if (ctrl != sc->gpio_pins[pin]->pin_ctrl_reg) {
203 rv = WR1(sc, AS3722_GPIO0_CONTROL + pin, ctrl);
204 sc->gpio_pins[pin]->pin_ctrl_reg = ctrl;
210 as3722_pinmux_read_node(struct as3722_softc *sc, phandle_t node,
211 struct as3722_pincfg *cfg, char **pins, int *lpins)
215 *lpins = OF_getprop_alloc(node, "pins", (void **)pins);
219 /* Read function (mux) settings. */
220 rv = OF_getprop_alloc(node, "function", (void **)&cfg->function);
222 cfg->function = NULL;
224 /* Read boolean properties. */
225 for (i = 0; i < nitems(as3722_cfg_names); i++) {
226 if (OF_hasprop(node, as3722_cfg_names[i].name))
227 cfg->flags |= as3722_cfg_names[i].config;
233 as3722_pinmux_process_node(struct as3722_softc *sc, phandle_t node)
235 struct as3722_pincfg cfg;
237 int i, len, lpins, rv;
239 rv = as3722_pinmux_read_node(sc, node, &cfg, &pins, &lpins);
246 i = strlen(pname) + 1;
247 rv = as3722_pinmux_config_node(sc, pname, &cfg);
249 device_printf(sc->dev,
250 "Cannot configure pin: %s: %d\n", pname, rv);
254 } while (len < lpins);
258 if (cfg.function != NULL)
259 OF_prop_free(cfg.function);
264 int as3722_pinmux_configure(device_t dev, phandle_t cfgxref)
266 struct as3722_softc *sc;
267 phandle_t node, cfgnode;
270 sc = device_get_softc(dev);
271 cfgnode = OF_node_from_xref(cfgxref);
273 for (node = OF_child(cfgnode); node != 0; node = OF_peer(node)) {
274 if (!ofw_bus_node_status_okay(node))
276 rv = as3722_pinmux_process_node(sc, node);
278 device_printf(dev, "Failed to process pinmux");
284 /* --------------------------------------------------------------------------
289 as3722_gpio_get_bus(device_t dev)
291 struct as3722_softc *sc;
293 sc = device_get_softc(dev);
294 return (sc->gpio_busdev);
298 as3722_gpio_pin_max(device_t dev, int *maxpin)
306 as3722_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
308 struct as3722_softc *sc;
310 sc = device_get_softc(dev);
311 if (pin >= sc->gpio_npins)
314 *caps = sc->gpio_pins[pin]->pin_caps;
320 as3722_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
322 struct as3722_softc *sc;
324 sc = device_get_softc(dev);
325 if (pin >= sc->gpio_npins)
328 memcpy(name, sc->gpio_pins[pin]->pin_name, GPIOMAXNAME);
334 as3722_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *out_flags)
336 struct as3722_softc *sc;
337 uint8_t tmp, mode, iosf;
341 sc = device_get_softc(dev);
342 if (pin >= sc->gpio_npins)
346 tmp = sc->gpio_pins[pin]->pin_ctrl_reg;
348 iosf = (tmp >> AS3722_GPIO_IOSF_SHIFT) & AS3722_GPIO_IOSF_MASK;
349 mode = (tmp >> AS3722_GPIO_MODE_SHIFT) & AS3722_GPIO_MODE_MASK;
350 inverted = (tmp & AS3722_GPIO_INVERT) != 0;
351 /* Is pin in GPIO mode ? */
352 if (iosf != AS3722_IOSF_GPIO)
357 case AS3722_MODE_INPUT:
358 flags = GPIO_PIN_INPUT;
360 case AS3722_MODE_PUSH_PULL:
361 case AS3722_MODE_PUSH_PULL_LV:
362 flags = GPIO_PIN_OUTPUT;
364 case AS3722_MODE_OPEN_DRAIN:
365 case AS3722_MODE_OPEN_DRAIN_LV:
366 flags = GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | GPIO_PIN_OPENDRAIN;
368 case AS3722_MODE_TRISTATE:
369 flags = GPIO_PIN_TRISTATE;
371 case AS3722_MODE_INPUT_PULL_UP_LV:
372 flags = GPIO_PIN_INPUT | GPIO_PIN_PULLUP;
375 case AS3722_MODE_INPUT_PULL_DOWN:
376 flags = GPIO_PIN_OUTPUT | GPIO_PIN_PULLDOWN;
380 flags |= GPIO_PIN_INVIN | GPIO_PIN_INVOUT;
386 as3722_gpio_get_mode(struct as3722_softc *sc, uint32_t pin, uint32_t gpio_flags)
391 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
392 flags = sc->gpio_pins[pin]->pin_cfg_flags;
395 if (flags & AS3722_CFG_BIAS_HIGH_IMPEDANCE ||
396 gpio_flags & GPIO_PIN_TRISTATE)
397 return (AS3722_MODE_TRISTATE);
399 /* Open drain modes. */
400 if (flags & AS3722_CFG_OPEN_DRAIN || gpio_flags & GPIO_PIN_OPENDRAIN) {
401 /* Only pull up have effect */
402 if (flags & AS3722_CFG_BIAS_PULL_UP ||
403 gpio_flags & GPIO_PIN_PULLUP)
404 return (AS3722_MODE_OPEN_DRAIN_LV);
405 return (AS3722_MODE_OPEN_DRAIN);
408 if (gpio_flags & GPIO_PIN_INPUT) {
409 /* Accept pull up or pull down. */
410 if (flags & AS3722_CFG_BIAS_PULL_UP ||
411 gpio_flags & GPIO_PIN_PULLUP)
412 return (AS3722_MODE_INPUT_PULL_UP_LV);
414 if (flags & AS3722_CFG_BIAS_PULL_DOWN ||
415 gpio_flags & GPIO_PIN_PULLDOWN)
416 return (AS3722_MODE_INPUT_PULL_DOWN);
417 return (AS3722_MODE_INPUT);
421 * Pull down is used as indicator of low voltage output.
423 if (flags & AS3722_CFG_BIAS_PULL_DOWN ||
424 gpio_flags & GPIO_PIN_PULLDOWN)
425 return (AS3722_MODE_PUSH_PULL_LV);
426 return (AS3722_MODE_PUSH_PULL);
430 as3722_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
432 struct as3722_softc *sc;
433 uint8_t ctrl, mode, iosf;
436 sc = device_get_softc(dev);
437 if (pin >= sc->gpio_npins)
441 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
442 iosf = (ctrl >> AS3722_GPIO_IOSF_SHIFT) & AS3722_GPIO_IOSF_MASK;
443 /* Is pin in GPIO mode ? */
444 if (iosf != AS3722_IOSF_GPIO) {
448 mode = as3722_gpio_get_mode(sc, pin, flags);
449 ctrl &= ~(AS3722_GPIO_MODE_MASK << AS3722_GPIO_MODE_SHIFT);
450 ctrl |= AS3722_MODE_PUSH_PULL << AS3722_GPIO_MODE_SHIFT;
452 if (ctrl != sc->gpio_pins[pin]->pin_ctrl_reg) {
453 rv = WR1(sc, AS3722_GPIO0_CONTROL + pin, ctrl);
454 sc->gpio_pins[pin]->pin_ctrl_reg = ctrl;
461 as3722_gpio_pin_set(device_t dev, uint32_t pin, uint32_t val)
463 struct as3722_softc *sc;
467 sc = device_get_softc(dev);
468 if (pin >= sc->gpio_npins)
471 tmp = (val != 0) ? 1 : 0;
472 if (sc->gpio_pins[pin]->pin_ctrl_reg & AS3722_GPIO_INVERT)
476 rv = RM1(sc, AS3722_GPIO_SIGNAL_OUT, (1 << pin), (tmp << pin));
482 as3722_gpio_pin_get(device_t dev, uint32_t pin, uint32_t *val)
484 struct as3722_softc *sc;
485 uint8_t tmp, mode, ctrl;
488 sc = device_get_softc(dev);
489 if (pin >= sc->gpio_npins)
493 ctrl = sc->gpio_pins[pin]->pin_ctrl_reg;
494 mode = (ctrl >> AS3722_GPIO_MODE_SHIFT) & AS3722_GPIO_MODE_MASK;
495 if ((mode == AS3722_MODE_PUSH_PULL) ||
496 (mode == AS3722_MODE_PUSH_PULL_LV))
497 rv = RD1(sc, AS3722_GPIO_SIGNAL_OUT, &tmp);
499 rv = RD1(sc, AS3722_GPIO_SIGNAL_IN, &tmp);
504 *val = tmp & (1 << pin) ? 1 : 0;
505 if (ctrl & AS3722_GPIO_INVERT)
511 as3722_gpio_pin_toggle(device_t dev, uint32_t pin)
513 struct as3722_softc *sc;
517 sc = device_get_softc(dev);
518 if (pin >= sc->gpio_npins)
522 rv = RD1(sc, AS3722_GPIO_SIGNAL_OUT, &tmp);
528 rv = RM1(sc, AS3722_GPIO_SIGNAL_OUT, (1 << pin), tmp);
534 as3722_gpio_map_gpios(device_t dev, phandle_t pdev, phandle_t gparent,
535 int gcells, pcell_t *gpios, uint32_t *pin, uint32_t *flags)
546 as3722_gpio_attach(struct as3722_softc *sc, phandle_t node)
548 struct as3722_gpio_pin *pin;
551 sx_init(&sc->gpio_lock, "AS3722 GPIO lock");
552 sc->gpio_npins = NGPIO;
553 sc->gpio_pins = malloc(sizeof(struct as3722_gpio_pin *) *
554 sc->gpio_npins, M_AS3722_GPIO, M_WAITOK | M_ZERO);
557 sc->gpio_busdev = gpiobus_attach_bus(sc->dev);
558 if (sc->gpio_busdev == NULL)
560 for (i = 0; i < sc->gpio_npins; i++) {
561 sc->gpio_pins[i] = malloc(sizeof(struct as3722_gpio_pin),
562 M_AS3722_GPIO, M_WAITOK | M_ZERO);
563 pin = sc->gpio_pins[i];
564 sprintf(pin->pin_name, "gpio%d", i);
565 pin->pin_caps = GPIO_PIN_INPUT | GPIO_PIN_OUTPUT |
566 GPIO_PIN_OPENDRAIN | GPIO_PIN_PUSHPULL | GPIO_PIN_TRISTATE |
567 GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN | GPIO_PIN_INVIN |
569 rv = RD1(sc, AS3722_GPIO0_CONTROL + i, &pin->pin_ctrl_reg);
571 device_printf(sc->dev,
572 "Cannot read configuration for pin %s\n",
573 sc->gpio_pins[i]->pin_name);