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