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  */
  31
  32 /*
  33  * This code implements a `root nexus' for Intel Architecture
  34  * machines.  The function of the root nexus is to serve as an
  35  * attachment point for both processors and buses, and to manage
  36  * resources which are common to all of them.  In particular,
  37  * this code implements the core resource managers for interrupt
  38  * requests, DMA requests (which rightfully should be a part of the
  39  * ISA code but it's easier to do it here for now), I/O port addresses,
  40  * and I/O memory address space.
  41  */
  42
  43 #include <sys/param.h>
  44 #include <sys/systm.h>
  45 #include <sys/bus.h>
  46 #include <sys/kernel.h>
  47 #include <sys/malloc.h>
  48 #include <sys/module.h>
  49 #include <sys/rman.h>
  50 #include <sys/interrupt.h>
  51 #include <sys/machintr.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/smp.h>
  60 #include <machine/intr_machdep.h>
  61 #include <machine_base/apic/ioapic.h>
  62
  63 #include <bus/pci/pcivar.h>
  64 #include <bus/pci/pcireg.h>
  65 #include <bus/pci/pcibus.h>
  66 #include <bus/pci/pci_cfgreg.h>
  67 #include <bus/pci/pcib_private.h>
  68
  69 #include "pcib_if.h"
  70
  71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  72 struct nexus_device {
  73         struct resource_list    nx_resources;
  74         int                     nx_pcibus;
  75 };
  76
  77 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  78
  79 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman;
  80
  81 static  int nexus_probe(device_t);
  82 static  int nexus_attach(device_t);
  83 static  int nexus_print_all_resources(device_t dev);
  84 static  int nexus_print_child(device_t, device_t);
  85 static device_t nexus_add_child(device_t bus, device_t parent, int order,
  86                                 const char *name, int unit);
  87 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  88     u_long, u_long, u_long, u_int, int);
  89 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
  90 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
  91 static  int nexus_activate_resource(device_t, device_t, int, int,
  92                                     struct resource *);
  93 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  94                                       struct resource *);
  95 static  int nexus_release_resource(device_t, device_t, int, int,
  96                                    struct resource *);
  97 static  int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
  98                               enum intr_polarity);
  99 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
 100                              void (*)(void *), void *,
 101                              void **, lwkt_serialize_t);
 102 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
 103                                 void *);
 104 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long,
 105                                int);
 106 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
 107 static void nexus_delete_resource(device_t, device_t, int, int);
 108
 109 /*
 110  * The device_identify method will cause nexus to automatically associate
 111  * and attach to the root bus.
 112  */
 113 static device_method_t nexus_methods[] = {
 114         /* Device interface */
 115         DEVMETHOD(device_identify,      bus_generic_identify),
 116         DEVMETHOD(device_probe,         nexus_probe),
 117         DEVMETHOD(device_attach,        nexus_attach),
 118         DEVMETHOD(device_detach,        bus_generic_detach),
 119         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 120         DEVMETHOD(device_suspend,       bus_generic_suspend),
 121         DEVMETHOD(device_resume,        bus_generic_resume),
 122
 123         /* Bus interface */
 124         DEVMETHOD(bus_print_child,      nexus_print_child),
 125         DEVMETHOD(bus_add_child,        nexus_add_child),
 126         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
 127         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
 128         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 129         DEVMETHOD(bus_release_resource, nexus_release_resource),
 130         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
 131         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
 132         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 133         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 134         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 135         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 136         DEVMETHOD(bus_get_resource,     nexus_get_resource),
 137         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
 138
 139         { 0, 0 }
 140 };
 141
 142 static driver_t nexus_driver = {
 143         "nexus",
 144         nexus_methods,
 145         1,                      /* no softc */
 146 };
 147 static devclass_t nexus_devclass;
 148
 149 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL);
 150
 151 static int
 152 nexus_probe(device_t dev)
 153 {
 154         int cpuid;
 155
 156         device_quiet(dev);      /* suppress attach message for neatness */
 157
 158         for (cpuid = 0; cpuid < ncpus; ++cpuid) {
 159                 struct rman *rm = &irq_rman[cpuid];
 160
 161                 /*
 162                  * IRQ's are on the mainboard on old systems, but on
 163                  * the ISA part of PCI->ISA bridges.  There would be
 164                  * multiple sets of IRQs on multi-ISA-bus systems.
 165                  * PCI interrupts are routed to the ISA component,
 166                  * so in a way, PCI can be a partial child of an ISA
 167                  * bus(!).  APIC interrupts are global though.  In the
 168                  * non-APIC case, disallow the use of IRQ 2.
 169                  */
 170                 rm->rm_start = 0;
 171                 rm->rm_type = RMAN_ARRAY;
 172                 rm->rm_descr = "Interrupt request lines";
 173
 174                 /*
 175                  * XXX should use MachIntrABI.rman_setup
 176                  */
 177                 if (ioapic_enable) {
 178                         rm->rm_end = IDT_HWI_VECTORS - 1;
 179                         if (rman_init(rm, cpuid))
 180                                 panic("nexus_probe rman_init");
 181                         MachIntrABI.rman_setup(rm);
 182                 } else {
 183                         rm->rm_end = 15;
 184                         if (rman_init(rm, cpuid) ||
 185                             rman_manage_region(rm, rm->rm_start, 1) ||
 186                             rman_manage_region(rm, 3, rm->rm_end))
 187                                 panic("nexus_probe irq_rman");
 188                 }
 189         }
 190
 191         /*
 192          * ISA DMA on PCI systems is implemented in the ISA part of each
 193          * PCI->ISA bridge and the channels can be duplicated if there are
 194          * multiple bridges.  (eg: laptops with docking stations)
 195          */
 196         drq_rman.rm_start = 0;
 197         drq_rman.rm_end = 7;
 198         drq_rman.rm_type = RMAN_ARRAY;
 199         drq_rman.rm_descr = "DMA request lines";
 200         /* XXX drq 0 not available on some machines */
 201         if (rman_init(&drq_rman, -1)
 202             || rman_manage_region(&drq_rman,
 203                                   drq_rman.rm_start, drq_rman.rm_end))
 204                 panic("nexus_probe drq_rman");
 205
 206         /*
 207          * However, IO ports and Memory truely are global at this level,
 208          * as are APIC interrupts (however many IO APICS there turn out
 209          * to be on large systems..)
 210          */
 211         port_rman.rm_start = 0;
 212         port_rman.rm_end = 0xffff;
 213         port_rman.rm_type = RMAN_ARRAY;
 214         port_rman.rm_descr = "I/O ports";
 215         if (rman_init(&port_rman, -1)
 216             || rman_manage_region(&port_rman, 0, 0xffff))
 217                 panic("nexus_probe port_rman");
 218
 219         mem_rman.rm_start = 0;
 220         mem_rman.rm_end = ~0u;
 221         mem_rman.rm_type = RMAN_ARRAY;
 222         mem_rman.rm_descr = "I/O memory addresses";
 223         if (rman_init(&mem_rman, -1)
 224             || rman_manage_region(&mem_rman, 0, ~0))
 225                 panic("nexus_probe mem_rman");
 226
 227         return bus_generic_probe(dev);
 228 }
 229
 230 static int
 231 nexus_attach(device_t dev)
 232 {
 233         device_t        child;
 234
 235         /*
 236          * First, let our child driver's identify any child devices that
 237          * they can find.  Once that is done attach any devices that we
 238          * found.
 239          */
 240 #if 0 /* FUTURE */
 241         bus_generic_probe(dev);
 242 #endif
 243         bus_generic_attach(dev);
 244
 245         /*
 246          * And if we didn't see ISA on a pci bridge, create a
 247          * connection point now so it shows up "on motherboard".
 248          */
 249         if (!devclass_get_device(devclass_find("isa"), 0)) {
 250                 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
 251                 if (child == NULL)
 252                         panic("nexus_attach isa");
 253                 device_probe_and_attach(child);
 254         }
 255
 256         return 0;
 257 }
 258
 259 static int
 260 nexus_print_all_resources(device_t dev)
 261 {
 262         struct  nexus_device *ndev = DEVTONX(dev);
 263         struct resource_list *rl = &ndev->nx_resources;
 264         int retval = 0;
 265
 266         if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
 267                 retval += kprintf(" at");
 268
 269         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
 270         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
 271         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
 272
 273         return retval;
 274 }
 275
 276 static int
 277 nexus_print_child(device_t bus, device_t child)
 278 {
 279         struct  nexus_device *ndev = DEVTONX(child);
 280         int retval = 0;
 281
 282         retval += bus_print_child_header(bus, child);
 283         retval += nexus_print_all_resources(child);
 284         if (ndev->nx_pcibus != -1)
 285                 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
 286         retval += kprintf(" on motherboard\n");
 287
 288         return (retval);
 289 }
 290
 291 static device_t
 292 nexus_add_child(device_t bus, device_t parent, int order,
 293                 const char *name, int unit)
 294 {
 295         device_t                child;
 296         struct nexus_device     *ndev;
 297
 298         ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
 299         if (!ndev)
 300                 return(0);
 301         resource_list_init(&ndev->nx_resources);
 302         ndev->nx_pcibus = -1;
 303
 304         child = device_add_child_ordered(parent, order, name, unit);
 305
 306         /* should we free this in nexus_child_detached? */
 307         device_set_ivars(child, ndev);
 308
 309         return(child);
 310 }
 311
 312 static int
 313 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
 314 {
 315         struct nexus_device *ndev = DEVTONX(child);
 316
 317         switch (which) {
 318         case NEXUS_IVAR_PCIBUS:
 319                 *result = ndev->nx_pcibus;
 320                 break;
 321         default:
 322                 return ENOENT;
 323         }
 324         return 0;
 325 }
 326
 327 static int
 328 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
 329 {
 330         struct nexus_device *ndev = DEVTONX(child);
 331
 332         switch (which) {
 333         case NEXUS_IVAR_PCIBUS:
 334                 ndev->nx_pcibus = value;
 335                 break;
 336         default:
 337                 return ENOENT;
 338         }
 339         return 0;
 340 }
 341
 342 /*
 343  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 344  * child of one of our descendants, not a direct child of nexus0.
 345  * (Exceptions include npx.)
 346  */
 347 static struct resource *
 348 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 349     u_long start, u_long end, u_long count, u_int flags, int cpuid)
 350 {
 351         struct nexus_device *ndev = DEVTONX(child);
 352         struct  resource *rv;
 353         struct resource_list_entry *rle;
 354         struct  rman *rm;
 355         int needactivate = flags & RF_ACTIVE;
 356
 357         /*
 358          * If this is an allocation of the "default" range for a given RID, and
 359          * we know what the resources for this device are (ie. they aren't maintained
 360          * by a child bus), then work out the start/end values.
 361          */
 362         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
 363                 if (ndev == NULL)
 364                         return(NULL);
 365                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 366                 if (rle == NULL)
 367                         return(NULL);
 368                 start = rle->start;
 369                 end = rle->end;
 370                 count = rle->count;
 371                 cpuid = rle->cpuid;
 372         }
 373
 374         flags &= ~RF_ACTIVE;
 375
 376         switch (type) {
 377         case SYS_RES_IRQ:
 378                 if (cpuid < 0 || cpuid >= ncpus) {
 379                         kprintf("NEXUS cpuid %d:\n", cpuid);
 380                         print_backtrace(-1);
 381                         cpuid = 0; /* XXX */
 382                 }
 383                 rm = &irq_rman[cpuid];
 384                 break;
 385
 386         case SYS_RES_DRQ:
 387                 rm = &drq_rman;
 388                 break;
 389
 390         case SYS_RES_IOPORT:
 391                 rm = &port_rman;
 392                 break;
 393
 394         case SYS_RES_MEMORY:
 395                 rm = &mem_rman;
 396                 break;
 397
 398         default:
 399                 return 0;
 400         }
 401
 402         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 403         if (rv == 0)
 404                 return 0;
 405
 406         if (type == SYS_RES_MEMORY) {
 407                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
 408         } else if (type == SYS_RES_IOPORT) {
 409                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
 410                 rman_set_bushandle(rv, rv->r_start);
 411         }
 412
 413         if (needactivate) {
 414                 if (bus_activate_resource(child, type, *rid, rv)) {
 415                         rman_release_resource(rv);
 416                         return 0;
 417                 }
 418         }
 419
 420         return rv;
 421 }
 422
 423 static int
 424 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 425                         struct resource *r)
 426 {
 427         /*
 428          * If this is a memory resource, map it into the kernel.
 429          */
 430         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
 431                 caddr_t vaddr = 0;
 432
 433                 if (rman_get_end(r) < 1024 * 1024) {
 434                         /*
 435                          * The first 1Mb is mapped at KERNBASE.
 436                          */
 437                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
 438                 } else {
 439                         u_int32_t paddr;
 440                         u_int32_t psize;
 441                         u_int32_t poffs;
 442
 443                         paddr = rman_get_start(r);
 444                         psize = rman_get_size(r);
 445
 446                         poffs = paddr - trunc_page(paddr);
 447                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
 448                 }
 449                 rman_set_virtual(r, vaddr);
 450                 /* IBM-PC: the type of bus_space_handle_t is u_int */
 451                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
 452         }
 453         return (rman_activate_resource(r));
 454 }
 455
 456 static int
 457 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 458                           struct resource *r)
 459 {
 460         /*
 461          * If this is a memory resource, unmap it.
 462          */
 463         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
 464             (rman_get_end(r) >= 1024 * 1024)) {
 465                 u_int32_t psize;
 466
 467                 psize = rman_get_size(r);
 468                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
 469         }
 470
 471         return (rman_deactivate_resource(r));
 472 }
 473
 474 static int
 475 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 476                        struct resource *r)
 477 {
 478         if (rman_get_flags(r) & RF_ACTIVE) {
 479                 int error = bus_deactivate_resource(child, type, rid, r);
 480                 if (error)
 481                         return error;
 482         }
 483         return (rman_release_resource(r));
 484 }
 485
 486 static int
 487 nexus_config_intr(device_t bus, device_t chile, int irq,
 488     enum intr_trigger trig, enum intr_polarity pola)
 489 {
 490         machintr_intr_config(irq, trig, pola);
 491         return 0;
 492 }
 493
 494 /*
 495  * Currently this uses the really grody interface from kern/kern_intr.c
 496  * (which really doesn't belong in kern/anything.c).  Eventually, all of
 497  * the code in kern_intr.c and machdep_intr.c should get moved here, since
 498  * this is going to be the official interface.
 499  */
 500 static int
 501 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
 502                  int flags, void (*ihand)(void *), void *arg,
 503                  void **cookiep, lwkt_serialize_t serializer)
 504 {
 505         int     error, icflags;
 506
 507         /* somebody tried to setup an irq that failed to allocate! */
 508         if (irq == NULL)
 509                 panic("nexus_setup_intr: NULL irq resource!");
 510
 511         *cookiep = 0;
 512         icflags = flags;
 513         if ((irq->r_flags & RF_SHAREABLE) == 0)
 514                 icflags |= INTR_EXCL;
 515
 516         /*
 517          * We depend here on rman_activate_resource() being idempotent.
 518          */
 519         error = rman_activate_resource(irq);
 520         if (error)
 521                 return (error);
 522
 523         /*
 524          * XXX cast the interrupt handler function to an inthand2_t.  The
 525          * difference is that an additional frame argument is passed which
 526          * we do not currently want to expose the BUS subsystem to.
 527          */
 528         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
 529                                 device_get_nameunit(child), serializer,
 530                                 icflags, rman_get_cpuid(irq));
 531         if (*cookiep == NULL)
 532                 error = EINVAL;
 533         return (error);
 534 }
 535
 536 static int
 537 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 538 {
 539         if (ih) {
 540                 unregister_int(ih, rman_get_cpuid(r));
 541                 return (0);
 542         }
 543         return(-1);
 544 }
 545
 546 static int
 547 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 548     u_long start, u_long count, int cpuid)
 549 {
 550         struct nexus_device     *ndev = DEVTONX(child);
 551         struct resource_list    *rl = &ndev->nx_resources;
 552
 553         /* XXX this should return a success/failure indicator */
 554         resource_list_add(rl, type, rid, start, start + count - 1, count,
 555             cpuid);
 556         return(0);
 557 }
 558
 559 static int
 560 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
 561 {
 562         struct nexus_device     *ndev = DEVTONX(child);
 563         struct resource_list    *rl = &ndev->nx_resources;
 564         struct resource_list_entry *rle;
 565
 566         rle = resource_list_find(rl, type, rid);
 567         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
 568                       type, rid, startp, countp, rle);
 569         if (!rle)
 570                 return(ENOENT);
 571         if (startp)
 572                 *startp = rle->start;
 573         if (countp)
 574                 *countp = rle->count;
 575         return(0);
 576 }
 577
 578 static void
 579 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
 580 {
 581         struct nexus_device     *ndev = DEVTONX(child);
 582         struct resource_list    *rl = &ndev->nx_resources;
 583
 584         resource_list_delete(rl, type, rid);
 585 }
 586