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