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