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