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