sys/platform/pc64/x86_64/nexus.c

   1 /*
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  * Copyright (c) 2008 The DragonFly Project.
   4  *
   5  * Permission to use, copy, modify, and distribute this software and
   6  * its documentation for any purpose and without fee is hereby
   7  * granted, provided that both the above copyright notice and this
   8  * permission notice appear in all copies, that both the above
   9  * copyright notice and this permission notice appear in all
  10  * supporting documentation, and that the name of M.I.T. not be used
  11  * in advertising or publicity pertaining to distribution of the
  12  * software without specific, written prior permission.  M.I.T. makes
  13  * no representations about the suitability of this software for any
  14  * purpose.  It is provided "as is" without express or implied
  15  * warranty.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  18  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  21  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  27  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $
  31  */
  32
  33 /*
  34  * This code implements a `root nexus' for Intel Architecture
  35  * machines.  The function of the root nexus is to serve as an
  36  * attachment point for both processors and buses, and to manage
  37  * resources which are common to all of them.  In particular,
  38  * this code implements the core resource managers for interrupt
  39  * requests, DMA requests (which rightfully should be a part of the
  40  * ISA code but it's easier to do it here for now), I/O port addresses,
  41  * and I/O memory address space.
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/bus.h>
  47 #include <sys/kernel.h>
  48 #include <sys/malloc.h>
  49 #include <sys/module.h>
  50 #include <sys/rman.h>
  51 #include <sys/interrupt.h>
  52 #include <sys/machintr.h>
  53
  54 #include <machine/vmparam.h>
  55 #include <vm/vm.h>
  56 #include <vm/pmap.h>
  57 #include <machine/pmap.h>
  58
  59 #include <machine/nexusvar.h>
  60 #include <machine/smp.h>
  61 #include <machine/intr_machdep.h>
  62 #include <machine_base/apic/lapic.h>
  63 #include <machine_base/apic/ioapic.h>
  64
  65 #include "pcib_if.h"
  66
  67 #define I386_BUS_SPACE_IO       0       /* space is i/o space */
  68 #define I386_BUS_SPACE_MEM      1       /* space is mem space */
  69
  70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  71 struct nexus_device {
  72         struct resource_list    nx_resources;
  73         int                     nx_pcibus;
  74 };
  75
  76 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  77
  78 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman;
  79
  80 static  int nexus_probe(device_t);
  81 static  int nexus_attach(device_t);
  82 static  int nexus_print_all_resources(device_t dev);
  83 static  int nexus_print_child(device_t, device_t);
  84 static device_t nexus_add_child(device_t bus, device_t parent, int order,
  85                                 const char *name, int unit);
  86 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  87     u_long, u_long, u_long, u_int, int);
  88 static  int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
  89 static  int nexus_write_ivar(device_t, device_t, int, uintptr_t);
  90 static  int nexus_activate_resource(device_t, device_t, int, int,
  91                                     struct resource *);
  92 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  93                                       struct resource *);
  94 static  int nexus_release_resource(device_t, device_t, int, int,
  95                                    struct resource *);
  96 static  int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
  97                               enum intr_polarity);
  98 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
  99                              void (*)(void *), void *,
 100                              void **, lwkt_serialize_t);
 101 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
 102                                 void *);
 103 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long,
 104                                int);
 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 static  int nexus_alloc_msi(device_t, device_t, int, int, int *, int);
 109 static  int nexus_release_msi(device_t, device_t, int, int *, int);
 110 static  int nexus_map_msi(device_t, device_t, int, uint64_t *, uint32_t *, int);
 111
 112 /*
 113  * The device_identify method will cause nexus to automatically associate
 114  * and attach to the root bus.
 115  */
 116 static device_method_t nexus_methods[] = {
 117         /* Device interface */
 118         DEVMETHOD(device_identify,      bus_generic_identify),
 119         DEVMETHOD(device_probe,         nexus_probe),
 120         DEVMETHOD(device_attach,        nexus_attach),
 121         DEVMETHOD(device_detach,        bus_generic_detach),
 122         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 123         DEVMETHOD(device_suspend,       bus_generic_suspend),
 124         DEVMETHOD(device_resume,        bus_generic_resume),
 125
 126         /* Bus interface */
 127         DEVMETHOD(bus_print_child,      nexus_print_child),
 128         DEVMETHOD(bus_add_child,        nexus_add_child),
 129         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
 130         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
 131         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 132         DEVMETHOD(bus_release_resource, nexus_release_resource),
 133         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
 134         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
 135         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 136         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 137         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 138         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 139         DEVMETHOD(bus_get_resource,     nexus_get_resource),
 140         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
 141
 142         DEVMETHOD(pcib_alloc_msi,       nexus_alloc_msi),
 143         DEVMETHOD(pcib_release_msi,     nexus_release_msi),
 144         DEVMETHOD(pcib_map_msi,         nexus_map_msi),
 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         if (!ndev)
 287                 return(0);
 288         resource_list_init(&ndev->nx_resources);
 289         ndev->nx_pcibus = -1;
 290
 291         child = device_add_child_ordered(parent, order, name, unit);
 292
 293         /* should we free this in nexus_child_detached? */
 294         device_set_ivars(child, ndev);
 295
 296         return(child);
 297 }
 298
 299 static int
 300 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
 301 {
 302         struct nexus_device *ndev = DEVTONX(child);
 303
 304         switch (which) {
 305         case NEXUS_IVAR_PCIBUS:
 306                 *result = ndev->nx_pcibus;
 307                 break;
 308         default:
 309                 return ENOENT;
 310         }
 311         return 0;
 312 }
 313
 314 static int
 315 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
 316 {
 317         struct nexus_device *ndev = DEVTONX(child);
 318
 319         switch (which) {
 320         case NEXUS_IVAR_PCIBUS:
 321                 ndev->nx_pcibus = value;
 322                 break;
 323         default:
 324                 return ENOENT;
 325         }
 326         return 0;
 327 }
 328
 329 /*
 330  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 331  * child of one of our descendants, not a direct child of nexus0.
 332  * (Exceptions include npx.)
 333  */
 334 static struct resource *
 335 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 336     u_long start, u_long end, u_long count, u_int flags, int cpuid)
 337 {
 338         struct nexus_device *ndev = DEVTONX(child);
 339         struct  resource *rv;
 340         struct resource_list_entry *rle;
 341         struct  rman *rm;
 342         int needactivate = flags & RF_ACTIVE;
 343
 344         /*
 345          * If this is an allocation of the "default" range for a given RID, and
 346          * we know what the resources for this device are (ie. they aren't maintained
 347          * by a child bus), then work out the start/end values.
 348          */
 349         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
 350                 if (ndev == NULL)
 351                         return(NULL);
 352                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 353                 if (rle == NULL)
 354                         return(NULL);
 355                 start = rle->start;
 356                 end = rle->end;
 357                 count = rle->count;
 358                 cpuid = rle->cpuid;
 359         }
 360
 361         flags &= ~RF_ACTIVE;
 362
 363         switch (type) {
 364         case SYS_RES_IRQ:
 365                 KASSERT(cpuid >= 0 && cpuid < ncpus,
 366                     ("nexus invalid cpuid %d:\n", cpuid));
 367                 rm = &irq_rman[cpuid];
 368                 break;
 369
 370         case SYS_RES_DRQ:
 371                 rm = &drq_rman;
 372                 break;
 373
 374         case SYS_RES_IOPORT:
 375                 rm = &port_rman;
 376                 break;
 377
 378         case SYS_RES_MEMORY:
 379                 rm = &mem_rman;
 380                 break;
 381
 382         default:
 383                 return 0;
 384         }
 385
 386         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 387         if (rv == 0)
 388                 return 0;
 389         rman_set_rid(rv, *rid);
 390
 391         if (type == SYS_RES_MEMORY) {
 392                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
 393         } else if (type == SYS_RES_IOPORT) {
 394                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
 395                 rman_set_bushandle(rv, rv->r_start);
 396         }
 397
 398         if (needactivate) {
 399                 if (bus_activate_resource(child, type, *rid, rv)) {
 400                         rman_release_resource(rv);
 401                         return 0;
 402                 }
 403         }
 404
 405         return rv;
 406 }
 407
 408 static int
 409 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 410                         struct resource *r)
 411 {
 412         /*
 413          * If this is a memory resource, map it into the kernel.
 414          */
 415         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
 416                 caddr_t vaddr = 0;
 417
 418                 if (rman_get_end(r) < 1024 * 1024) {
 419                         /*
 420                          * The first 1Mb is mapped at KERNBASE.
 421                          */
 422                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
 423                 } else {
 424                         u_int64_t paddr;
 425                         u_int64_t psize;
 426                         u_int32_t poffs;
 427
 428                         paddr = rman_get_start(r);
 429                         psize = rman_get_size(r);
 430
 431                         poffs = paddr - trunc_page(paddr);
 432                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
 433                 }
 434                 rman_set_virtual(r, vaddr);
 435                 /* IBM-PC: the type of bus_space_handle_t is u_int */
 436                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
 437         }
 438         return (rman_activate_resource(r));
 439 }
 440
 441 static int
 442 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 443                           struct resource *r)
 444 {
 445         /*
 446          * If this is a memory resource, unmap it.
 447          */
 448         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
 449             (rman_get_end(r) >= 1024 * 1024)) {
 450                 u_int32_t psize;
 451
 452                 psize = rman_get_size(r);
 453                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
 454         }
 455
 456         return (rman_deactivate_resource(r));
 457 }
 458
 459 static int
 460 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 461                        struct resource *r)
 462 {
 463         if (rman_get_flags(r) & RF_ACTIVE) {
 464                 int error = bus_deactivate_resource(child, type, rid, r);
 465                 if (error)
 466                         return error;
 467         }
 468         return (rman_release_resource(r));
 469 }
 470
 471 static int
 472 nexus_config_intr(device_t bus, device_t chile, int irq,
 473     enum intr_trigger trig, enum intr_polarity pola)
 474 {
 475         machintr_intr_config(irq, trig, pola);
 476         return 0;
 477 }
 478
 479 /*
 480  * Currently this uses the really grody interface from kern/kern_intr.c
 481  * (which really doesn't belong in kern/anything.c).  Eventually, all of
 482  * the code in kern_intr.c and machdep_intr.c should get moved here, since
 483  * this is going to be the official interface.
 484  */
 485 static int
 486 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
 487                  int flags, void (*ihand)(void *), void *arg,
 488                  void **cookiep, lwkt_serialize_t serializer)
 489 {
 490         int     error, icflags;
 491
 492         /* somebody tried to setup an irq that failed to allocate! */
 493         if (irq == NULL)
 494                 panic("nexus_setup_intr: NULL irq resource!");
 495
 496         *cookiep = 0;
 497         icflags = flags;
 498         if ((irq->r_flags & RF_SHAREABLE) == 0)
 499                 icflags |= INTR_EXCL;
 500
 501         /*
 502          * We depend here on rman_activate_resource() being idempotent.
 503          */
 504         error = rman_activate_resource(irq);
 505         if (error)
 506                 return (error);
 507
 508         /*
 509          * XXX cast the interrupt handler function to an inthand2_t.  The
 510          * difference is that an additional frame argument is passed which
 511          * we do not currently want to expose the BUS subsystem to.
 512          */
 513         *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
 514                                 device_get_nameunit(child), serializer,
 515                                 icflags, rman_get_cpuid(irq));
 516         if (*cookiep == NULL)
 517                 error = EINVAL;
 518         return (error);
 519 }
 520
 521 static int
 522 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 523 {
 524         if (ih) {
 525                 unregister_int(ih, rman_get_cpuid(r));
 526                 return (0);
 527         }
 528         return(-1);
 529 }
 530
 531 static int
 532 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 533     u_long start, u_long count, int cpuid)
 534 {
 535         struct nexus_device     *ndev = DEVTONX(child);
 536         struct resource_list    *rl = &ndev->nx_resources;
 537
 538         /* XXX this should return a success/failure indicator */
 539         resource_list_add(rl, type, rid, start, start + count - 1, count,
 540             cpuid);
 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
 572 static int
 573 nexus_alloc_msi(device_t dev, device_t child, int count, int maxcount,
 574     int *irqs, int cpuid)
 575 {
 576         if (!lapic_enable)
 577                 return ENODEV;
 578
 579         return MachIntrABI.msi_alloc(irqs, count, cpuid);
 580 }
 581
 582 static int
 583 nexus_release_msi(device_t dev, device_t child, int count, int *irqs, int cpuid)
 584 {
 585         KKASSERT(lapic_enable);
 586         MachIntrABI.msi_release(irqs, count, cpuid);
 587         return 0;
 588 }
 589
 590 static int
 591 nexus_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
 592     uint32_t *data, int cpuid)
 593 {
 594         KKASSERT(lapic_enable);
 595         MachIntrABI.msi_map(irq, addr, data, cpuid);
 596         return 0;
 597 }