1281057Sjhibbits/*- 2281057Sjhibbits * Copyright (c) 2015 Justin Hibbits 3281057Sjhibbits * Copyright (c) 2013 Thomas Skibo 4281057Sjhibbits * All rights reserved. 5281057Sjhibbits * 6281057Sjhibbits * Redistribution and use in source and binary forms, with or without 7281057Sjhibbits * modification, are permitted provided that the following conditions 8281057Sjhibbits * are met: 9281057Sjhibbits * 1. Redistributions of source code must retain the above copyright 10281057Sjhibbits * notice, this list of conditions and the following disclaimer. 11281057Sjhibbits * 2. Redistributions in binary form must reproduce the above copyright 12281057Sjhibbits * notice, this list of conditions and the following disclaimer in the 13281057Sjhibbits * documentation and/or other materials provided with the distribution. 14281057Sjhibbits * 15281057Sjhibbits * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16281057Sjhibbits * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17281057Sjhibbits * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18281057Sjhibbits * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19281057Sjhibbits * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20281057Sjhibbits * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21281057Sjhibbits * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22281057Sjhibbits * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23281057Sjhibbits * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24281057Sjhibbits * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25281057Sjhibbits * SUCH DAMAGE. 26281057Sjhibbits * 27281057Sjhibbits * $FreeBSD$ 28281057Sjhibbits */ 29281057Sjhibbits 30281057Sjhibbits#include <sys/cdefs.h> 31281057Sjhibbits__FBSDID("$FreeBSD$"); 32281057Sjhibbits 33281057Sjhibbits#include <sys/param.h> 34281057Sjhibbits#include <sys/systm.h> 35281057Sjhibbits#include <sys/conf.h> 36281057Sjhibbits#include <sys/bus.h> 37281057Sjhibbits#include <sys/kernel.h> 38281057Sjhibbits#include <sys/module.h> 39281057Sjhibbits#include <sys/lock.h> 40281057Sjhibbits#include <sys/mutex.h> 41281057Sjhibbits#include <sys/resource.h> 42281057Sjhibbits#include <sys/rman.h> 43281057Sjhibbits#include <sys/gpio.h> 44281057Sjhibbits 45281057Sjhibbits#include <machine/bus.h> 46281057Sjhibbits#include <machine/resource.h> 47281057Sjhibbits#include <machine/stdarg.h> 48281057Sjhibbits 49281057Sjhibbits#include <dev/fdt/fdt_common.h> 50281057Sjhibbits#include <dev/gpio/gpiobusvar.h> 51281057Sjhibbits#include <dev/ofw/ofw_bus.h> 52281057Sjhibbits#include <dev/ofw/ofw_bus_subr.h> 53281057Sjhibbits 54281057Sjhibbits#include "gpio_if.h" 55281057Sjhibbits 56281057Sjhibbits#define MAXPIN (7) 57281057Sjhibbits 58281057Sjhibbits#define VALID_PIN(u) ((u) >= 0 && (u) <= MAXPIN) 59281057Sjhibbits 60281057Sjhibbits#define GPIO_LOCK(sc) mtx_lock(&(sc)->sc_mtx) 61281057Sjhibbits#define GPIO_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx) 62281057Sjhibbits#define GPIO_LOCK_INIT(sc) \ 63281057Sjhibbits mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->dev), \ 64281057Sjhibbits "gpio", MTX_DEF) 65281057Sjhibbits#define GPIO_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx); 66281057Sjhibbits 67281057Sjhibbitsstruct mpc85xx_gpio_softc { 68281057Sjhibbits device_t dev; 69281057Sjhibbits device_t busdev; 70281057Sjhibbits struct mtx sc_mtx; 71281057Sjhibbits struct resource *out_res; /* Memory resource */ 72281057Sjhibbits struct resource *in_res; 73281057Sjhibbits}; 74281057Sjhibbits 75281057Sjhibbitsstatic device_t 76281057Sjhibbitsmpc85xx_gpio_get_bus(device_t dev) 77281057Sjhibbits{ 78281057Sjhibbits struct mpc85xx_gpio_softc *sc; 79281057Sjhibbits 80281057Sjhibbits sc = device_get_softc(dev); 81281057Sjhibbits 82281057Sjhibbits return (sc->busdev); 83281057Sjhibbits} 84281057Sjhibbits 85281057Sjhibbitsstatic int 86281057Sjhibbitsmpc85xx_gpio_pin_max(device_t dev, int *maxpin) 87281057Sjhibbits{ 88281057Sjhibbits 89281057Sjhibbits *maxpin = MAXPIN; 90281057Sjhibbits return (0); 91281057Sjhibbits} 92281057Sjhibbits 93281057Sjhibbits/* Get a specific pin's capabilities. */ 94281057Sjhibbitsstatic int 95281057Sjhibbitsmpc85xx_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps) 96281057Sjhibbits{ 97281057Sjhibbits 98281057Sjhibbits if (!VALID_PIN(pin)) 99281057Sjhibbits return (EINVAL); 100281057Sjhibbits 101281057Sjhibbits *caps = (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT); 102281057Sjhibbits 103281057Sjhibbits return (0); 104281057Sjhibbits} 105281057Sjhibbits 106281057Sjhibbits/* Get a specific pin's name. */ 107281057Sjhibbitsstatic int 108281057Sjhibbitsmpc85xx_gpio_pin_getname(device_t dev, uint32_t pin, char *name) 109281057Sjhibbits{ 110281057Sjhibbits 111281057Sjhibbits if (!VALID_PIN(pin)) 112281057Sjhibbits return (EINVAL); 113281057Sjhibbits 114281057Sjhibbits snprintf(name, GPIOMAXNAME, "GPIO%d", pin); 115281057Sjhibbits name[GPIOMAXNAME-1] = '\0'; 116281057Sjhibbits 117281057Sjhibbits return (0); 118281057Sjhibbits} 119281057Sjhibbits 120281057Sjhibbits/* Set a specific output pin's value. */ 121281057Sjhibbitsstatic int 122281057Sjhibbitsmpc85xx_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value) 123281057Sjhibbits{ 124281057Sjhibbits struct mpc85xx_gpio_softc *sc = device_get_softc(dev); 125281057Sjhibbits uint32_t outvals; 126281057Sjhibbits uint8_t pinbit; 127281057Sjhibbits 128281057Sjhibbits if (!VALID_PIN(pin) || value > 1) 129281057Sjhibbits return (EINVAL); 130281057Sjhibbits 131281057Sjhibbits GPIO_LOCK(sc); 132281057Sjhibbits pinbit = 31 - pin; 133281057Sjhibbits 134281057Sjhibbits outvals = bus_read_4(sc->out_res, 0); 135281057Sjhibbits outvals &= ~(1 << pinbit); 136281057Sjhibbits outvals |= (value << pinbit); 137281057Sjhibbits bus_write_4(sc->out_res, 0, outvals); 138281057Sjhibbits 139281057Sjhibbits GPIO_UNLOCK(sc); 140281057Sjhibbits 141281057Sjhibbits return (0); 142281057Sjhibbits} 143281057Sjhibbits 144281057Sjhibbits/* Get a specific pin's input value. */ 145281057Sjhibbitsstatic int 146281057Sjhibbitsmpc85xx_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *value) 147281057Sjhibbits{ 148281057Sjhibbits struct mpc85xx_gpio_softc *sc = device_get_softc(dev); 149281057Sjhibbits 150281057Sjhibbits if (!VALID_PIN(pin)) 151281057Sjhibbits return (EINVAL); 152281057Sjhibbits 153281057Sjhibbits *value = (bus_read_4(sc->in_res, 0) >> (31 - pin)) & 1; 154281057Sjhibbits 155281057Sjhibbits return (0); 156281057Sjhibbits} 157281057Sjhibbits 158281057Sjhibbits/* Toggle a pin's output value. */ 159281057Sjhibbitsstatic int 160281057Sjhibbitsmpc85xx_gpio_pin_toggle(device_t dev, uint32_t pin) 161281057Sjhibbits{ 162281057Sjhibbits struct mpc85xx_gpio_softc *sc = device_get_softc(dev); 163281057Sjhibbits uint32_t val; 164281057Sjhibbits 165281057Sjhibbits if (!VALID_PIN(pin)) 166281057Sjhibbits return (EINVAL); 167281057Sjhibbits 168281057Sjhibbits GPIO_LOCK(sc); 169281057Sjhibbits 170281057Sjhibbits val = bus_read_4(sc->out_res, 0); 171281057Sjhibbits val ^= (1 << (31 - pin)); 172281057Sjhibbits bus_write_4(sc->out_res, 0, val); 173281057Sjhibbits 174281057Sjhibbits GPIO_UNLOCK(sc); 175281057Sjhibbits 176281057Sjhibbits return (0); 177281057Sjhibbits} 178281057Sjhibbits 179281057Sjhibbitsstatic int 180281057Sjhibbitsmpc85xx_gpio_probe(device_t dev) 181281057Sjhibbits{ 182281057Sjhibbits uint16_t vers; 183281057Sjhibbits uint32_t svr; 184281057Sjhibbits 185281057Sjhibbits if (!ofw_bus_status_okay(dev)) 186281057Sjhibbits return (ENXIO); 187281057Sjhibbits 188281057Sjhibbits if (!ofw_bus_is_compatible(dev, "gpio")) 189281057Sjhibbits return (ENXIO); 190281057Sjhibbits 191281057Sjhibbits vers = mfpvr() >> 16; 192281057Sjhibbits switch (vers) { 193281057Sjhibbits case FSL_E500v1: 194281057Sjhibbits case FSL_E500v2: 195281057Sjhibbits case FSL_E500mc: 196281057Sjhibbits break; 197281057Sjhibbits default: 198281057Sjhibbits return (ENXIO); 199281057Sjhibbits } 200281057Sjhibbits 201281057Sjhibbits svr = mfspr(SPR_SVR); 202281057Sjhibbits switch (SVR_VER(svr)) { 203281057Sjhibbits case SVR_MPC8533: 204281057Sjhibbits case SVR_MPC8533E: 205281057Sjhibbits break; 206281057Sjhibbits default: 207281057Sjhibbits return (ENXIO); 208281057Sjhibbits } 209281057Sjhibbits 210281057Sjhibbits device_set_desc(dev, "MPC85xx GPIO driver"); 211281057Sjhibbits return (0); 212281057Sjhibbits} 213281057Sjhibbits 214281057Sjhibbitsstatic int mpc85xx_gpio_detach(device_t dev); 215281057Sjhibbits 216281057Sjhibbitsstatic int 217281057Sjhibbitsmpc85xx_gpio_attach(device_t dev) 218281057Sjhibbits{ 219281057Sjhibbits struct mpc85xx_gpio_softc *sc = device_get_softc(dev); 220281057Sjhibbits int rid; 221281057Sjhibbits 222281057Sjhibbits sc->dev = dev; 223281057Sjhibbits 224281057Sjhibbits GPIO_LOCK_INIT(sc); 225281057Sjhibbits 226281057Sjhibbits /* Allocate memory. */ 227281057Sjhibbits rid = 0; 228281057Sjhibbits sc->out_res = bus_alloc_resource_any(dev, 229281057Sjhibbits SYS_RES_MEMORY, &rid, RF_ACTIVE); 230281057Sjhibbits if (sc->out_res == NULL) { 231281057Sjhibbits device_printf(dev, "Can't allocate memory for device output port"); 232281057Sjhibbits mpc85xx_gpio_detach(dev); 233281057Sjhibbits return (ENOMEM); 234281057Sjhibbits } 235281057Sjhibbits 236281057Sjhibbits rid = 1; 237281057Sjhibbits sc->in_res = bus_alloc_resource_any(dev, 238281057Sjhibbits SYS_RES_MEMORY, &rid, RF_ACTIVE); 239281057Sjhibbits if (sc->in_res == NULL) { 240281057Sjhibbits device_printf(dev, "Can't allocate memory for device input port"); 241281057Sjhibbits mpc85xx_gpio_detach(dev); 242281057Sjhibbits return (ENOMEM); 243281057Sjhibbits } 244281057Sjhibbits 245281057Sjhibbits sc->busdev = gpiobus_attach_bus(dev); 246281057Sjhibbits if (sc->busdev == NULL) { 247281057Sjhibbits mpc85xx_gpio_detach(dev); 248281057Sjhibbits return (ENOMEM); 249281057Sjhibbits } 250281057Sjhibbits 251281057Sjhibbits OF_device_register_xref(OF_xref_from_node(ofw_bus_get_node(dev)), dev); 252281057Sjhibbits 253281057Sjhibbits return (0); 254281057Sjhibbits} 255281057Sjhibbits 256281057Sjhibbitsstatic int 257281057Sjhibbitsmpc85xx_gpio_detach(device_t dev) 258281057Sjhibbits{ 259281057Sjhibbits struct mpc85xx_gpio_softc *sc = device_get_softc(dev); 260281057Sjhibbits 261281057Sjhibbits gpiobus_detach_bus(dev); 262281057Sjhibbits 263281057Sjhibbits if (sc->out_res != NULL) { 264281057Sjhibbits /* Release output port resource. */ 265281057Sjhibbits bus_release_resource(dev, SYS_RES_MEMORY, 266281057Sjhibbits rman_get_rid(sc->out_res), sc->out_res); 267281057Sjhibbits } 268281057Sjhibbits 269281057Sjhibbits if (sc->in_res != NULL) { 270281057Sjhibbits /* Release input port resource. */ 271281057Sjhibbits bus_release_resource(dev, SYS_RES_MEMORY, 272281057Sjhibbits rman_get_rid(sc->in_res), sc->in_res); 273281057Sjhibbits } 274281057Sjhibbits 275281057Sjhibbits GPIO_LOCK_DESTROY(sc); 276281057Sjhibbits 277281057Sjhibbits return (0); 278281057Sjhibbits} 279281057Sjhibbits 280281057Sjhibbitsstatic device_method_t mpc85xx_gpio_methods[] = { 281281057Sjhibbits /* device_if */ 282281057Sjhibbits DEVMETHOD(device_probe, mpc85xx_gpio_probe), 283281057Sjhibbits DEVMETHOD(device_attach, mpc85xx_gpio_attach), 284281057Sjhibbits DEVMETHOD(device_detach, mpc85xx_gpio_detach), 285281057Sjhibbits 286281057Sjhibbits /* GPIO protocol */ 287281057Sjhibbits DEVMETHOD(gpio_get_bus, mpc85xx_gpio_get_bus), 288281057Sjhibbits DEVMETHOD(gpio_pin_max, mpc85xx_gpio_pin_max), 289281057Sjhibbits DEVMETHOD(gpio_pin_getname, mpc85xx_gpio_pin_getname), 290281057Sjhibbits DEVMETHOD(gpio_pin_getcaps, mpc85xx_gpio_pin_getcaps), 291281057Sjhibbits DEVMETHOD(gpio_pin_get, mpc85xx_gpio_pin_get), 292281057Sjhibbits DEVMETHOD(gpio_pin_set, mpc85xx_gpio_pin_set), 293281057Sjhibbits DEVMETHOD(gpio_pin_toggle, mpc85xx_gpio_pin_toggle), 294281057Sjhibbits 295281057Sjhibbits DEVMETHOD_END 296281057Sjhibbits}; 297281057Sjhibbits 298281057Sjhibbitsstatic driver_t mpc85xx_gpio_driver = { 299281057Sjhibbits "gpio", 300281057Sjhibbits mpc85xx_gpio_methods, 301281057Sjhibbits sizeof(struct mpc85xx_gpio_softc), 302281057Sjhibbits}; 303281057Sjhibbitsstatic devclass_t mpc85xx_gpio_devclass; 304281057Sjhibbits 305281057SjhibbitsEARLY_DRIVER_MODULE(mpc85xx_gpio, simplebus, mpc85xx_gpio_driver, 306281057Sjhibbits mpc85xx_gpio_devclass, NULL, NULL, 307281057Sjhibbits BUS_PASS_RESOURCE + BUS_PASS_ORDER_MIDDLE); 308