sys/platform/pc32/i386/nexus.c

   1 /*
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $
  30  * $DragonFly: src/sys/platform/pc32/i386/nexus.c,v 1.24 2006/09/05 00:55:45 dillon Exp $
  31  */
  32
  33 /*
  34  * This code implements a `root nexus' for Intel Architecture
  35  * machines.  The function of the root nexus is to serve as an
  36  * attachment point for both processors and buses, and to manage
  37  * resources which are common to all of them.  In particular,
  38  * this code implements the core resource managers for interrupt
  39  * requests, DMA requests (which rightfully should be a part of the
  40  * ISA code but it's easier to do it here for now), I/O port addresses,
  41  * and I/O memory address space.
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/bus.h>
  47 #include <sys/kernel.h>
  48 #include <sys/malloc.h>
  49 #include <sys/module.h>
  50 #include <machine/bus.h>
  51 #include <sys/rman.h>
  52
  53 #include <machine/vmparam.h>
  54 #include <vm/vm.h>
  55 #include <vm/pmap.h>
  56 #include <machine/pmap.h>
  57
  58 #include <machine/nexusvar.h>
  59 #include <machine/resource.h>
  60 #include <machine/smp.h>
  61 #include <arch/apic/mpapic.h>
  62
  63 #include <bus/isa/isavar.h>
  64 #include <bus/isa/i386/isa.h>
  65 #include <i386/isa/intr_machdep.h>
  66
  67 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  68 struct nexus_device {
  69         struct resource_list    nx_resources;
  70         int                     nx_pcibus;
  71 };
  72
  73 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  74
  75 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
  76
  77 static  int nexus_probe(device_t);
  78 static  int nexus_attach(device_t);
  79 static  int nexus_print_all_resources(device_t dev);
  80 static  int nexus_print_child(device_t, device_t);
  81 static device_t nexus_add_child(device_t bus, device_t parent, int order,
  82                                 const char *name, int unit);
  83 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  84                                               u_long, u_long, u_long, u_int);
  85 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
  86 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
  87 static  int nexus_activate_resource(device_t, device_t, int, int,
  88                                     struct resource *);
  89 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  90                                       struct resource *);
  91 static  int nexus_release_resource(device_t, device_t, int, int,
  92                                    struct resource *);
  93 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
  94                              void (*)(void *), void *,
  95                              void **, lwkt_serialize_t);
  96 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
  97                                 void *);
  98 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
  99 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
 100 static void nexus_delete_resource(device_t, device_t, int, int);
 101
 102 /*
 103  * The device_identify method will cause nexus to automatically associate
 104  * and attach to the root bus.
 105  */
 106 static device_method_t nexus_methods[] = {
 107         /* Device interface */
 108         DEVMETHOD(device_identify,      bus_generic_identify),
 109         DEVMETHOD(device_probe,         nexus_probe),
 110         DEVMETHOD(device_attach,        nexus_attach),
 111         DEVMETHOD(device_detach,        bus_generic_detach),
 112         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 113         DEVMETHOD(device_suspend,       bus_generic_suspend),
 114         DEVMETHOD(device_resume,        bus_generic_resume),
 115
 116         /* Bus interface */
 117         DEVMETHOD(bus_print_child,      nexus_print_child),
 118         DEVMETHOD(bus_add_child,        nexus_add_child),
 119         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
 120         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
 121         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 122         DEVMETHOD(bus_release_resource, nexus_release_resource),
 123         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
 124         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
 125         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 126         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 127         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 128         DEVMETHOD(bus_get_resource,     nexus_get_resource),
 129         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
 130
 131         { 0, 0 }
 132 };
 133
 134 static driver_t nexus_driver = {
 135         "nexus",
 136         nexus_methods,
 137         1,                      /* no softc */
 138 };
 139 static devclass_t nexus_devclass;
 140
 141 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
 142
 143 static int
 144 nexus_probe(device_t dev)
 145 {
 146         device_quiet(dev);      /* suppress attach message for neatness */
 147
 148         /*
 149          * IRQ's are on the mainboard on old systems, but on the ISA part
 150          * of PCI->ISA bridges.  There would be multiple sets of IRQs on
 151          * multi-ISA-bus systems.  PCI interrupts are routed to the ISA
 152          * component, so in a way, PCI can be a partial child of an ISA bus(!).
 153          * APIC interrupts are global though.
 154          * In the non-APIC case, disallow the use of IRQ 2.
 155          */
 156         irq_rman.rm_start = 0;
 157         irq_rman.rm_type = RMAN_ARRAY;
 158         irq_rman.rm_descr = "Interrupt request lines";
 159 #ifdef APIC_IO
 160         irq_rman.rm_end = APIC_INTMAPSIZE - 1;
 161         if (rman_init(&irq_rman)
 162             || rman_manage_region(&irq_rman,
 163                                   irq_rman.rm_start, irq_rman.rm_end))
 164                 panic("nexus_probe irq_rman");
 165 #else
 166         irq_rman.rm_end = 15;
 167         if (rman_init(&irq_rman)
 168             || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
 169             || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
 170                 panic("nexus_probe irq_rman");
 171 #endif
 172
 173         /*
 174          * ISA DMA on PCI systems is implemented in the ISA part of each
 175          * PCI->ISA bridge and the channels can be duplicated if there are
 176          * multiple bridges.  (eg: laptops with docking stations)
 177          */
 178         drq_rman.rm_start = 0;
 179         drq_rman.rm_end = 7;
 180         drq_rman.rm_type = RMAN_ARRAY;
 181         drq_rman.rm_descr = "DMA request lines";
 182         /* XXX drq 0 not available on some machines */
 183         if (rman_init(&drq_rman)
 184             || rman_manage_region(&drq_rman,
 185                                   drq_rman.rm_start, drq_rman.rm_end))
 186                 panic("nexus_probe drq_rman");
 187
 188         /*
 189          * However, IO ports and Memory truely are global at this level,
 190          * as are APIC interrupts (however many IO APICS there turn out
 191          * to be on large systems..)
 192          */
 193         port_rman.rm_start = 0;
 194         port_rman.rm_end = 0xffff;
 195         port_rman.rm_type = RMAN_ARRAY;
 196         port_rman.rm_descr = "I/O ports";
 197         if (rman_init(&port_rman)
 198             || rman_manage_region(&port_rman, 0, 0xffff))
 199                 panic("nexus_probe port_rman");
 200
 201         mem_rman.rm_start = 0;
 202         mem_rman.rm_end = ~0u;
 203         mem_rman.rm_type = RMAN_ARRAY;
 204         mem_rman.rm_descr = "I/O memory addresses";
 205         if (rman_init(&mem_rman)
 206             || rman_manage_region(&mem_rman, 0, ~0))
 207                 panic("nexus_probe mem_rman");
 208
 209         return bus_generic_probe(dev);
 210 }
 211
 212 static int
 213 nexus_attach(device_t dev)
 214 {
 215         device_t        child;
 216
 217         /*
 218          * First, let our child driver's identify any child devices that
 219          * they can find.  Once that is done attach any devices that we
 220          * found.
 221          */
 222 #if 0 /* FUTURE */
 223         bus_generic_probe(dev);
 224 #endif
 225         bus_generic_attach(dev);
 226
 227         /*
 228          * And if we didn't see EISA or ISA on a pci bridge, create some
 229          * connection points now so they show up "on motherboard".
 230          */
 231         if (!devclass_get_device(devclass_find("eisa"), 0)) {
 232                 child = BUS_ADD_CHILD(dev, dev, 0, "eisa", 0);
 233                 if (child == NULL)
 234                         panic("nexus_attach eisa");
 235                 device_probe_and_attach(child);
 236         }
 237         if (!devclass_get_device(devclass_find("isa"), 0)) {
 238                 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
 239                 if (child == NULL)
 240                         panic("nexus_attach isa");
 241                 device_probe_and_attach(child);
 242         }
 243
 244         return 0;
 245 }
 246
 247 static int
 248 nexus_print_all_resources(device_t dev)
 249 {
 250         struct  nexus_device *ndev = DEVTONX(dev);
 251         struct resource_list *rl = &ndev->nx_resources;
 252         int retval = 0;
 253
 254         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
 255                 retval += printf(" at");
 256
 257         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
 258         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
 259         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
 260
 261         return retval;
 262 }
 263
 264 static int
 265 nexus_print_child(device_t bus, device_t child)
 266 {
 267         struct  nexus_device *ndev = DEVTONX(child);
 268         int retval = 0;
 269
 270         retval += bus_print_child_header(bus, child);
 271         retval += nexus_print_all_resources(child);
 272         if (ndev->nx_pcibus != -1)
 273                 retval += printf(" pcibus %d", ndev->nx_pcibus);
 274         retval += printf(" on motherboard\n");
 275
 276         return (retval);
 277 }
 278
 279 static device_t
 280 nexus_add_child(device_t bus, device_t parent, int order,
 281                 const char *name, int unit)
 282 {
 283         device_t                child;
 284         struct nexus_device     *ndev;
 285
 286         ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
 287         if (!ndev)
 288                 return(0);
 289         resource_list_init(&ndev->nx_resources);
 290         ndev->nx_pcibus = -1;
 291
 292         child = device_add_child_ordered(parent, order, name, unit);
 293
 294         /* should we free this in nexus_child_detached? */
 295         device_set_ivars(child, ndev);
 296
 297         return(child);
 298 }
 299
 300 static int
 301 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
 302 {
 303         struct nexus_device *ndev = DEVTONX(child);
 304
 305         switch (which) {
 306         case NEXUS_IVAR_PCIBUS:
 307                 *result = ndev->nx_pcibus;
 308                 break;
 309         default:
 310                 return ENOENT;
 311         }
 312         return 0;
 313 }
 314
 315 static int
 316 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
 317 {
 318         struct nexus_device *ndev = DEVTONX(child);
 319
 320         switch (which) {
 321         case NEXUS_IVAR_PCIBUS:
 322                 ndev->nx_pcibus = value;
 323                 break;
 324         default:
 325                 return ENOENT;
 326         }
 327         return 0;
 328 }
 329
 330 /*
 331  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 332  * child of one of our descendants, not a direct child of nexus0.
 333  * (Exceptions include npx.)
 334  */
 335 static struct resource *
 336 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 337                      u_long start, u_long end, u_long count, u_int flags)
 338 {
 339         struct nexus_device *ndev = DEVTONX(child);
 340         struct  resource *rv;
 341         struct resource_list_entry *rle;
 342         struct  rman *rm;
 343         int needactivate = flags & RF_ACTIVE;
 344
 345         /*
 346          * If this is an allocation of the "default" range for a given RID, and
 347          * we know what the resources for this device are (ie. they aren't maintained
 348          * by a child bus), then work out the start/end values.
 349          */
 350         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
 351                 if (ndev == NULL)
 352                         return(NULL);
 353                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 354                 if (rle == NULL)
 355                         return(NULL);
 356                 start = rle->start;
 357                 end = rle->end;
 358                 count = rle->count;
 359         }
 360
 361         flags &= ~RF_ACTIVE;
 362
 363         switch (type) {
 364         case SYS_RES_IRQ:
 365                 rm = &irq_rman;
 366                 break;
 367
 368         case SYS_RES_DRQ:
 369                 rm = &drq_rman;
 370                 break;
 371
 372         case SYS_RES_IOPORT:
 373                 rm = &port_rman;
 374                 break;
 375
 376         case SYS_RES_MEMORY:
 377                 rm = &mem_rman;
 378                 break;
 379
 380         default:
 381                 return 0;
 382         }
 383
 384         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 385         if (rv == 0)
 386                 return 0;
 387
 388         if (type == SYS_RES_MEMORY) {
 389                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
 390         } else if (type == SYS_RES_IOPORT) {
 391                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
 392                 rman_set_bushandle(rv, rv->r_start);
 393         }
 394
 395         if (needactivate) {
 396                 if (bus_activate_resource(child, type, *rid, rv)) {
 397                         rman_release_resource(rv);
 398                         return 0;
 399                 }
 400         }
 401
 402         return rv;
 403 }
 404
 405 static int
 406 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 407                         struct resource *r)
 408 {
 409         /*
 410          * If this is a memory resource, map it into the kernel.
 411          */
 412         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
 413                 caddr_t vaddr = 0;
 414
 415                 if (rman_get_end(r) < 1024 * 1024) {
 416                         /*
 417                          * The first 1Mb is mapped at KERNBASE.
 418                          */
 419                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
 420                 } else {
 421                         u_int32_t paddr;
 422                         u_int32_t psize;
 423                         u_int32_t poffs;
 424
 425                         paddr = rman_get_start(r);
 426                         psize = rman_get_size(r);
 427
 428                         poffs = paddr - trunc_page(paddr);
 429                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
 430                 }
 431                 rman_set_virtual(r, vaddr);
 432                 /* IBM-PC: the type of bus_space_handle_t is u_int */
 433                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
 434         }
 435         return (rman_activate_resource(r));
 436 }
 437
 438 static int
 439 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 440                           struct resource *r)
 441 {
 442         /*
 443          * If this is a memory resource, unmap it.
 444          */
 445         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
 446             (rman_get_end(r) >= 1024 * 1024)) {
 447                 u_int32_t psize;
 448
 449                 psize = rman_get_size(r);
 450                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
 451         }
 452
 453         return (rman_deactivate_resource(r));
 454 }
 455
 456 static int
 457 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 458                        struct resource *r)
 459 {
 460         if (rman_get_flags(r) & RF_ACTIVE) {
 461                 int error = bus_deactivate_resource(child, type, rid, r);
 462                 if (error)
 463                         return error;
 464         }
 465         return (rman_release_resource(r));
 466 }
 467
 468 /*
 469  * Currently this uses the really grody interface from kern/kern_intr.c
 470  * (which really doesn't belong in kern/anything.c).  Eventually, all of
 471  * the code in kern_intr.c and machdep_intr.c should get moved here, since
 472  * this is going to be the official interface.
 473  */
 474 static int
 475 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
 476                  int flags, void (*ihand)(void *), void *arg,
 477                  void **cookiep, lwkt_serialize_t serializer)
 478 {
 479         driver_t        *driver;
 480         int     error, icflags;
 481
 482         /* somebody tried to setup an irq that failed to allocate! */
 483         if (irq == NULL)
 484                 panic("nexus_setup_intr: NULL irq resource!");
 485
 486         *cookiep = 0;
 487         icflags = flags;
 488         if ((irq->r_flags & RF_SHAREABLE) == 0)
 489                 icflags |= INTR_EXCL;
 490
 491         driver = device_get_driver(child);
 492
 493         /*
 494          * We depend here on rman_activate_resource() being idempotent.
 495          */
 496         error = rman_activate_resource(irq);
 497         if (error)
 498                 return (error);
 499
 500         /*
 501          * XXX cast the interrupt handler function to an inthand2_t.  The
 502          * difference is that an additional frame argument is passed which
 503          * we do not currently want to expose the BUS subsystem to.
 504          */
 505         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
 506                                 device_get_nameunit(child), serializer,
 507                                 icflags);
 508         if (*cookiep == NULL)
 509                 error = EINVAL;
 510         return (error);
 511 }
 512
 513 static int
 514 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 515 {
 516         if (ih) {
 517                 unregister_int(ih);
 518                 return (0);
 519         }
 520         return(-1);
 521 }
 522
 523 static int
 524 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
 525 {
 526         struct nexus_device     *ndev = DEVTONX(child);
 527         struct resource_list    *rl = &ndev->nx_resources;
 528
 529         /* XXX this should return a success/failure indicator */
 530         resource_list_add(rl, type, rid, start, start + count - 1, count);
 531         return(0);
 532 }
 533
 534 static int
 535 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
 536 {
 537         struct nexus_device     *ndev = DEVTONX(child);
 538         struct resource_list    *rl = &ndev->nx_resources;
 539         struct resource_list_entry *rle;
 540
 541         rle = resource_list_find(rl, type, rid);
 542         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
 543                       type, rid, startp, countp, rle);
 544         if (!rle)
 545                 return(ENOENT);
 546         if (startp)
 547                 *startp = rle->start;
 548         if (countp)
 549                 *countp = rle->count;
 550         return(0);
 551 }
 552
 553 static void
 554 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
 555 {
 556         struct nexus_device     *ndev = DEVTONX(child);
 557         struct resource_list    *rl = &ndev->nx_resources;
 558
 559         resource_list_delete(rl, type, rid);
 560 }
 561
 562 /*
 563  * Placeholder which claims PnP 'devices' which describe system
 564  * resources.
 565  */
 566 static struct isa_pnp_id sysresource_ids[] = {
 567         { 0x010cd041 /* PNP0c01 */, "System Memory" },
 568         { 0x020cd041 /* PNP0c02 */, "System Resource" },
 569         { 0 }
 570 };
 571
 572 static int
 573 sysresource_probe(device_t dev)
 574 {
 575         int     result;
 576
 577         if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) >= 0) {
 578                 device_quiet(dev);
 579         }
 580         return (result);
 581 }
 582
 583 static int
 584 sysresource_attach(device_t dev)
 585 {
 586         return (0);
 587 }
 588
 589 static device_method_t sysresource_methods[] = {
 590         /* Device interface */
 591         DEVMETHOD(device_probe,         sysresource_probe),
 592         DEVMETHOD(device_attach,        sysresource_attach),
 593         DEVMETHOD(device_detach,        bus_generic_detach),
 594         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 595         DEVMETHOD(device_suspend,       bus_generic_suspend),
 596         DEVMETHOD(device_resume,        bus_generic_resume),
 597         { 0, 0 }
 598 };
 599
 600 static driver_t sysresource_driver = {
 601         "sysresource",
 602         sysresource_methods,
 603         1,              /* no softc */
 604 };
 605
 606 static devclass_t sysresource_devclass;
 607
 608 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);