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