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