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