sys/arm/at91/at91_pinctrl.c

   1 /*-
   2  * Copyright (c) 2014 Warner Losh.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include <sys/param.h>
  30 #include <sys/bus.h>
  31 #include <sys/kernel.h>
  32 #include <sys/module.h>
  33 #include <sys/resource.h>
  34 #include <sys/systm.h>
  35 #include <sys/rman.h>
  36
  37 #include <machine/bus.h>
  38
  39 #include <arm/at91/at91var.h>
  40 #include <arm/at91/at91_piovar.h>
  41
  42 #include <dev/fdt/fdt_pinctrl.h>
  43 #include <dev/ofw/openfirm.h>
  44 #include <dev/ofw/ofw_bus.h>
  45 #include <dev/ofw/ofw_bus_subr.h>
  46
  47 #define BUS_PASS_PINMUX (BUS_PASS_INTERRUPT + 1)
  48
  49 struct pinctrl_range {
  50         uint64_t bus;
  51         uint64_t host;
  52         uint64_t size;
  53 };
  54
  55 struct pinctrl_softc {
  56         device_t dev;
  57         phandle_t node;
  58
  59         struct pinctrl_range *ranges;
  60         int nranges;
  61
  62         pcell_t acells, scells;
  63         int done_pinmux;
  64 };
  65
  66 struct pinctrl_devinfo {
  67         struct ofw_bus_devinfo  obdinfo;
  68         struct resource_list    rl;
  69 };
  70
  71 static int
  72 at91_pinctrl_probe(device_t dev)
  73 {
  74
  75         if (!ofw_bus_is_compatible(dev, "atmel,at91rm9200-pinctrl"))
  76                 return (ENXIO);
  77         device_set_desc(dev, "pincontrol bus");
  78         return (0);
  79 }
  80
  81 /* XXX Make this a subclass of simplebus */
  82
  83 static struct pinctrl_devinfo *
  84 at91_pinctrl_setup_dinfo(device_t dev, phandle_t node)
  85 {
  86         struct pinctrl_softc *sc;
  87         struct pinctrl_devinfo *ndi;
  88         uint32_t *reg, *intr, icells;
  89         uint64_t phys, size;
  90         phandle_t iparent;
  91         int i, j, k;
  92         int nintr;
  93         int nreg;
  94
  95         sc = device_get_softc(dev);
  96
  97         ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
  98         if (ofw_bus_gen_setup_devinfo(&ndi->obdinfo, node) != 0) {
  99                 free(ndi, M_DEVBUF);
 100                 return (NULL);
 101         }
 102
 103         resource_list_init(&ndi->rl);
 104         nreg = OF_getencprop_alloc(node, "reg", sizeof(*reg), (void **)&reg);
 105         if (nreg == -1)
 106                 nreg = 0;
 107         if (nreg % (sc->acells + sc->scells) != 0) {
 108 //              if (bootverbose)
 109                         device_printf(dev, "Malformed reg property on <%s>\n",
 110                             ndi->obdinfo.obd_name);
 111                 nreg = 0;
 112         }
 113
 114         for (i = 0, k = 0; i < nreg; i += sc->acells + sc->scells, k++) {
 115                 phys = size = 0;
 116                 for (j = 0; j < sc->acells; j++) {
 117                         phys <<= 32;
 118                         phys |= reg[i + j];
 119                 }
 120                 for (j = 0; j < sc->scells; j++) {
 121                         size <<= 32;
 122                         size |= reg[i + sc->acells + j];
 123                 }
 124
 125                 resource_list_add(&ndi->rl, SYS_RES_MEMORY, k,
 126                     phys, phys + size - 1, size);
 127         }
 128         OF_prop_free(reg);
 129
 130         nintr = OF_getencprop_alloc(node, "interrupts",  sizeof(*intr),
 131             (void **)&intr);
 132         if (nintr > 0) {
 133                 if (OF_searchencprop(node, "interrupt-parent", &iparent,
 134                     sizeof(iparent)) == -1) {
 135                         device_printf(dev, "No interrupt-parent found, "
 136                             "assuming direct parent\n");
 137                         iparent = OF_parent(node);
 138                 }
 139                 if (OF_searchencprop(OF_node_from_xref(iparent),
 140                     "#interrupt-cells", &icells, sizeof(icells)) == -1) {
 141                         device_printf(dev, "Missing #interrupt-cells property,"
 142                             " assuming <1>\n");
 143                         icells = 1;
 144                 }
 145                 if (icells < 1 || icells > nintr) {
 146                         device_printf(dev, "Invalid #interrupt-cells property "
 147                             "value <%d>, assuming <1>\n", icells);
 148                         icells = 1;
 149                 }
 150                 for (i = 0, k = 0; i < nintr; i += icells, k++) {
 151                         intr[i] = ofw_bus_map_intr(dev, iparent, icells,
 152                             &intr[i]);
 153                         resource_list_add(&ndi->rl, SYS_RES_IRQ, k, intr[i],
 154                             intr[i], 1);
 155                 }
 156                 OF_prop_free(intr);
 157         }
 158
 159         return (ndi);
 160 }
 161
 162 static int
 163 at91_pinctrl_fill_ranges(phandle_t node, struct pinctrl_softc *sc)
 164 {
 165         int host_address_cells;
 166         cell_t *base_ranges;
 167         ssize_t nbase_ranges;
 168         int err;
 169         int i, j, k;
 170
 171         err = OF_searchencprop(OF_parent(node), "#address-cells",
 172             &host_address_cells, sizeof(host_address_cells));
 173         if (err <= 0)
 174                 return (-1);
 175
 176         nbase_ranges = OF_getproplen(node, "ranges");
 177         if (nbase_ranges < 0)
 178                 return (-1);
 179         sc->nranges = nbase_ranges / sizeof(cell_t) /
 180             (sc->acells + host_address_cells + sc->scells);
 181         if (sc->nranges == 0)
 182                 return (0);
 183
 184         sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
 185             M_DEVBUF, M_WAITOK);
 186         base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
 187         OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
 188
 189         for (i = 0, j = 0; i < sc->nranges; i++) {
 190                 sc->ranges[i].bus = 0;
 191                 for (k = 0; k < sc->acells; k++) {
 192                         sc->ranges[i].bus <<= 32;
 193                         sc->ranges[i].bus |= base_ranges[j++];
 194                 }
 195                 sc->ranges[i].host = 0;
 196                 for (k = 0; k < host_address_cells; k++) {
 197                         sc->ranges[i].host <<= 32;
 198                         sc->ranges[i].host |= base_ranges[j++];
 199                 }
 200                 sc->ranges[i].size = 0;
 201                 for (k = 0; k < sc->scells; k++) {
 202                         sc->ranges[i].size <<= 32;
 203                         sc->ranges[i].size |= base_ranges[j++];
 204                 }
 205         }
 206
 207         free(base_ranges, M_DEVBUF);
 208         return (sc->nranges);
 209 }
 210
 211 static int
 212 at91_pinctrl_attach(device_t dev)
 213 {
 214         struct pinctrl_softc *sc;
 215         struct pinctrl_devinfo *di;
 216         phandle_t       node;
 217         device_t        cdev;
 218
 219         sc = device_get_softc(dev);
 220         node = ofw_bus_get_node(dev);
 221
 222         sc->dev = dev;
 223         sc->node = node;
 224
 225         /*
 226          * Some important numbers
 227          */
 228         sc->acells = 2;
 229         OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells));
 230         sc->scells = 1;
 231         OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells));
 232
 233         if (at91_pinctrl_fill_ranges(node, sc) < 0) {
 234                 device_printf(dev, "could not get ranges\n");
 235                 return (ENXIO);
 236         }
 237
 238         for (node = OF_child(node); node > 0; node = OF_peer(node)) {
 239                 if ((di = at91_pinctrl_setup_dinfo(dev, node)) == NULL)
 240                         continue;
 241                 cdev = device_add_child(dev, NULL, -1);
 242                 if (cdev == NULL) {
 243                         device_printf(dev, "<%s>: device_add_child failed\n",
 244                             di->obdinfo.obd_name);
 245                         resource_list_free(&di->rl);
 246                         ofw_bus_gen_destroy_devinfo(&di->obdinfo);
 247                         free(di, M_DEVBUF);
 248                         continue;
 249                 }
 250                 device_set_ivars(cdev, di);
 251         }
 252
 253         fdt_pinctrl_register(dev, "atmel,pins");
 254
 255         return (bus_generic_attach(dev));
 256 }
 257
 258 static const struct ofw_bus_devinfo *
 259 pinctrl_get_devinfo(device_t bus __unused, device_t child)
 260 {
 261         struct pinctrl_devinfo *ndi;
 262
 263         ndi = device_get_ivars(child);
 264         return (&ndi->obdinfo);
 265 }
 266
 267 static struct resource *
 268 pinctrl_alloc_resource(device_t bus, device_t child, int type, int *rid,
 269     u_long start, u_long end, u_long count, u_int flags)
 270 {
 271         struct pinctrl_softc *sc;
 272         struct pinctrl_devinfo *di;
 273         struct resource_list_entry *rle;
 274         int j;
 275
 276         sc = device_get_softc(bus);
 277
 278         /*
 279          * Request for the default allocation with a given rid: use resource
 280          * list stored in the local device info.
 281          */
 282         if (RMAN_IS_DEFAULT_RANGE(start, end)) {
 283                 if ((di = device_get_ivars(child)) == NULL)
 284                         return (NULL);
 285
 286                 if (type == SYS_RES_IOPORT)
 287                         type = SYS_RES_MEMORY;
 288
 289                 rle = resource_list_find(&di->rl, type, *rid);
 290                 if (rle == NULL) {
 291 //                      if (bootverbose)
 292                                 device_printf(bus, "no default resources for "
 293                                     "rid = %d, type = %d\n", *rid, type);
 294                         return (NULL);
 295                 }
 296                 start = rle->start;
 297                 end = rle->end;
 298                 count = rle->count;
 299         }
 300
 301         if (type == SYS_RES_MEMORY) {
 302                 /* Remap through ranges property */
 303                 for (j = 0; j < sc->nranges; j++) {
 304                         if (start >= sc->ranges[j].bus && end <
 305                             sc->ranges[j].bus + sc->ranges[j].size) {
 306                                 start -= sc->ranges[j].bus;
 307                                 start += sc->ranges[j].host;
 308                                 end -= sc->ranges[j].bus;
 309                                 end += sc->ranges[j].host;
 310                                 break;
 311                         }
 312                 }
 313                 if (j == sc->nranges && sc->nranges != 0) {
 314 //                      if (bootverbose)
 315                                 device_printf(bus, "Could not map resource "
 316                                     "%#lx-%#lx\n", start, end);
 317
 318                         return (NULL);
 319                 }
 320         }
 321
 322         return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
 323             count, flags));
 324 }
 325
 326 static int
 327 pinctrl_print_res(struct pinctrl_devinfo *di)
 328 {
 329         int rv;
 330
 331         rv = 0;
 332         rv += resource_list_print_type(&di->rl, "mem", SYS_RES_MEMORY, "%#jx");
 333         rv += resource_list_print_type(&di->rl, "irq", SYS_RES_IRQ, "%jd");
 334         return (rv);
 335 }
 336
 337 static void
 338 pinctrl_probe_nomatch(device_t bus, device_t child)
 339 {
 340         const char *name, *type, *compat;
 341
 342 //      if (!bootverbose)
 343                 return;
 344
 345         name = ofw_bus_get_name(child);
 346         type = ofw_bus_get_type(child);
 347         compat = ofw_bus_get_compat(child);
 348
 349         device_printf(bus, "<%s>", name != NULL ? name : "unknown");
 350         pinctrl_print_res(device_get_ivars(child));
 351         if (!ofw_bus_status_okay(child))
 352                 printf(" disabled");
 353         if (type)
 354                 printf(" type %s", type);
 355         if (compat)
 356                 printf(" compat %s", compat);
 357         printf(" (no driver attached)\n");
 358 }
 359
 360 static int
 361 pinctrl_print_child(device_t bus, device_t child)
 362 {
 363         int rv;
 364
 365         rv = bus_print_child_header(bus, child);
 366         rv += pinctrl_print_res(device_get_ivars(child));
 367         if (!ofw_bus_status_okay(child))
 368                 rv += printf(" disabled");
 369         rv += bus_print_child_footer(bus, child);
 370         return (rv);
 371 }
 372
 373 const char *periphs[] = {"gpio", "periph A", "periph B", "periph C", "periph D", "periph E" };
 374
 375 struct pincfg {
 376         uint32_t unit;
 377         uint32_t pin;
 378         uint32_t periph;
 379         uint32_t flags;
 380 };
 381
 382 static int
 383 pinctrl_configure_pins(device_t bus, phandle_t cfgxref)
 384 {
 385         struct pinctrl_softc *sc;
 386         struct pincfg *cfg, *cfgdata;
 387         char name[32];
 388         phandle_t node;
 389         ssize_t npins;
 390         int i;
 391
 392         sc = device_get_softc(bus);
 393         node = OF_node_from_xref(cfgxref);
 394         memset(name, 0, sizeof(name));
 395         OF_getprop(node, "name", name, sizeof(name));
 396         npins = OF_getencprop_alloc(node, "atmel,pins", sizeof(*cfgdata),
 397             (void **)&cfgdata);
 398         if (npins < 0) {
 399                 printf("We're doing it wrong %s\n", name);
 400                 return (ENXIO);
 401         }
 402         if (npins == 0)
 403                 return (0);
 404         for (i = 0, cfg = cfgdata; i < npins; i++, cfg++) {
 405                 uint32_t pio;
 406                 pio = (0xfffffff & sc->ranges[0].bus) + 0x200 * cfg->unit;
 407                 printf("P%c%d %s %#x\n", cfg->unit + 'A', cfg->pin,
 408                     periphs[cfg->periph], cfg->flags);
 409                 switch (cfg->periph) {
 410                 case 0:
 411                         at91_pio_use_gpio(pio, 1u << cfg->pin);
 412                         at91_pio_gpio_pullup(pio, 1u << cfg->pin,
 413                             !!(cfg->flags & 1));
 414                         at91_pio_gpio_high_z(pio, 1u << cfg->pin,
 415                             !!(cfg->flags & 2));
 416                         at91_pio_gpio_set_deglitch(pio,
 417                             1u << cfg->pin, !!(cfg->flags & 4));
 418 //                      at91_pio_gpio_pulldown(pio, 1u << cfg->pin,
 419 //                          !!(cfg->flags & 8));
 420 //                      at91_pio_gpio_dis_schmidt(pio,
 421 //                          1u << cfg->pin, !!(cfg->flags & 16));
 422                         break;
 423                 case 1:
 424                         at91_pio_use_periph_a(pio, 1u << cfg->pin, cfg->flags);
 425                         break;
 426                 case 2:
 427                         at91_pio_use_periph_b(pio, 1u << cfg->pin, cfg->flags);
 428                         break;
 429                 }
 430         }
 431         OF_prop_free(cfgdata);
 432         return (0);
 433 }
 434
 435 static void
 436 pinctrl_new_pass(device_t bus)
 437 {
 438         struct pinctrl_softc *sc;
 439
 440         sc = device_get_softc(bus);
 441
 442         bus_generic_new_pass(bus);
 443
 444         if (sc->done_pinmux || bus_current_pass < BUS_PASS_PINMUX)
 445                 return;
 446         sc->done_pinmux++;
 447
 448         fdt_pinctrl_configure_tree(bus);
 449 }
 450
 451 static device_method_t at91_pinctrl_methods[] = {
 452         DEVMETHOD(device_probe, at91_pinctrl_probe),
 453         DEVMETHOD(device_attach, at91_pinctrl_attach),
 454
 455         DEVMETHOD(bus_print_child,      pinctrl_print_child),
 456         DEVMETHOD(bus_probe_nomatch,    pinctrl_probe_nomatch),
 457         DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
 458         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
 459         DEVMETHOD(bus_alloc_resource,   pinctrl_alloc_resource),
 460         DEVMETHOD(bus_release_resource, bus_generic_release_resource),
 461         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
 462         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
 463         DEVMETHOD(bus_adjust_resource,  bus_generic_adjust_resource),
 464         DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
 465         DEVMETHOD(bus_new_pass,         pinctrl_new_pass),
 466
 467         /* ofw_bus interface */
 468         DEVMETHOD(ofw_bus_get_devinfo,  pinctrl_get_devinfo),
 469         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
 470         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
 471         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
 472         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 473         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 474
 475         /* fdt_pintrl interface */
 476         DEVMETHOD(fdt_pinctrl_configure,pinctrl_configure_pins),
 477         DEVMETHOD_END
 478 };
 479
 480 static driver_t at91_pinctrl_driver = {
 481         "at91_pinctrl",
 482         at91_pinctrl_methods,
 483         sizeof(struct pinctrl_softc),
 484 };
 485
 486 static devclass_t at91_pinctrl_devclass;
 487
 488 EARLY_DRIVER_MODULE(at91_pinctrl, simplebus, at91_pinctrl_driver,
 489     at91_pinctrl_devclass, NULL, NULL, BUS_PASS_BUS);
 490
 491 /*
 492  * dummy driver to force pass BUS_PASS_PINMUX to happen.
 493  */
 494 static int
 495 at91_pingroup_probe(device_t dev)
 496 {
 497         return ENXIO;
 498 }
 499
 500 static device_method_t at91_pingroup_methods[] = {
 501         DEVMETHOD(device_probe, at91_pingroup_probe),
 502
 503         DEVMETHOD_END
 504 };
 505
 506
 507 static driver_t at91_pingroup_driver = {
 508         "at91_pingroup",
 509         at91_pingroup_methods,
 510         0,
 511 };
 512
 513 static devclass_t at91_pingroup_devclass;
 514
 515 EARLY_DRIVER_MODULE(at91_pingroup, at91_pinctrl, at91_pingroup_driver,
 516     at91_pingroup_devclass, NULL, NULL, BUS_PASS_PINMUX);