sys/i386/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  */
  31
  32 /*
  33  * This code implements a `root nexus' for Intel Architecture
  34  * machines.  The function of the root nexus is to serve as an
  35  * attachment point for both processors and buses, and to manage
  36  * resources which are common to all of them.  In particular,
  37  * this code implements the core resource managers for interrupt
  38  * requests, DMA requests (which rightfully should be a part of the
  39  * ISA code but it's easier to do it here for now), I/O port addresses,
  40  * and I/O memory address space.
  41  */
  42
  43 #include "mca.h"
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/bus.h>
  48 #include <sys/kernel.h>
  49 #include <sys/malloc.h>
  50 #include <sys/module.h>
  51 #include <machine/bus.h>
  52 #include <sys/rman.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/resource.h>
  60 #ifdef APIC_IO
  61 #include <machine/smp.h>
  62 #include <machine/mpapic.h>
  63 #endif
  64
  65 #ifdef PC98
  66 #include <pc98/pc98/pc98.h>
  67 #else
  68 #include <i386/isa/isa.h>
  69 #endif
  70 #include <i386/isa/intr_machdep.h>
  71
  72 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  73 struct nexus_device {
  74         struct resource_list    nx_resources;
  75 };
  76
  77 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  78
  79 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
  80
  81 static  int nexus_probe(device_t);
  82 static  int nexus_attach(device_t);
  83 static  int nexus_print_all_resources(device_t dev);
  84 static  int nexus_print_child(device_t, device_t);
  85 static device_t nexus_add_child(device_t bus, int order, const char *name,
  86                                 int unit);
  87 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  88                                               u_long, u_long, u_long, u_int);
  89 static  int nexus_activate_resource(device_t, device_t, int, int,
  90                                     struct resource *);
  91 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  92                                       struct resource *);
  93 static  int nexus_release_resource(device_t, device_t, int, int,
  94                                    struct resource *);
  95 static  int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
  96                              void (*)(void *), void *, void **);
  97 static  int nexus_teardown_intr(device_t, device_t, struct resource *,
  98                                 void *);
  99 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
 100 static  int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
 101 static void nexus_delete_resource(device_t, device_t, int, int);
 102
 103 static device_method_t nexus_methods[] = {
 104         /* Device interface */
 105         DEVMETHOD(device_probe,         nexus_probe),
 106         DEVMETHOD(device_attach,        nexus_attach),
 107         DEVMETHOD(device_detach,        bus_generic_detach),
 108         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 109         DEVMETHOD(device_suspend,       bus_generic_suspend),
 110         DEVMETHOD(device_resume,        bus_generic_resume),
 111
 112         /* Bus interface */
 113         DEVMETHOD(bus_print_child,      nexus_print_child),
 114         DEVMETHOD(bus_add_child,        nexus_add_child),
 115         DEVMETHOD(bus_read_ivar,        bus_generic_read_ivar),
 116         DEVMETHOD(bus_write_ivar,       bus_generic_write_ivar),
 117         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 118         DEVMETHOD(bus_release_resource, nexus_release_resource),
 119         DEVMETHOD(bus_activate_resource, nexus_activate_resource),
 120         DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
 121         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 122         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 123         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 124         DEVMETHOD(bus_get_resource,     nexus_get_resource),
 125         DEVMETHOD(bus_delete_resource,  nexus_delete_resource),
 126
 127         { 0, 0 }
 128 };
 129
 130 static driver_t nexus_driver = {
 131         "nexus",
 132         nexus_methods,
 133         1,                      /* no softc */
 134 };
 135 static devclass_t nexus_devclass;
 136
 137 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
 138
 139 static int
 140 nexus_probe(device_t dev)
 141 {
 142
 143         device_quiet(dev);      /* suppress attach message for neatness */
 144
 145         /*
 146          * IRQ's are on the mainboard on old systems, but on the ISA part
 147          * of PCI->ISA bridges.  There would be multiple sets of IRQs on
 148          * multi-ISA-bus systems.  PCI interrupts are routed to the ISA
 149          * component, so in a way, PCI can be a partial child of an ISA bus(!).
 150          * APIC interrupts are global though.
 151          * In the non-APIC case, disallow the use of IRQ 2.
 152          */
 153         irq_rman.rm_start = 0;
 154         irq_rman.rm_type = RMAN_ARRAY;
 155         irq_rman.rm_descr = "Interrupt request lines";
 156 #ifdef APIC_IO
 157         irq_rman.rm_end = APIC_INTMAPSIZE - 1;
 158         if (rman_init(&irq_rman)
 159             || rman_manage_region(&irq_rman,
 160                                   irq_rman.rm_start, irq_rman.rm_end))
 161                 panic("nexus_probe irq_rman");
 162 #else
 163         irq_rman.rm_end = 15;
 164 #ifdef PC98
 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         if (rman_init(&irq_rman)
 171             || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
 172             || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
 173                 panic("nexus_probe irq_rman");
 174 #endif /* PC98 */
 175 #endif
 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 #ifdef PC98
 184         drq_rman.rm_end = 3;
 185 #else
 186         drq_rman.rm_end = 7;
 187 #endif
 188         drq_rman.rm_type = RMAN_ARRAY;
 189         drq_rman.rm_descr = "DMA request lines";
 190         /* XXX drq 0 not available on some machines */
 191         if (rman_init(&drq_rman)
 192             || rman_manage_region(&drq_rman,
 193                                   drq_rman.rm_start, drq_rman.rm_end))
 194                 panic("nexus_probe drq_rman");
 195
 196         /*
 197          * However, IO ports and Memory truely are global at this level,
 198          * as are APIC interrupts (however many IO APICS there turn out
 199          * to be on large systems..)
 200          */
 201         port_rman.rm_start = 0;
 202         port_rman.rm_end = 0xffff;
 203         port_rman.rm_type = RMAN_ARRAY;
 204         port_rman.rm_descr = "I/O ports";
 205         if (rman_init(&port_rman)
 206             || rman_manage_region(&port_rman, 0, 0xffff))
 207                 panic("nexus_probe port_rman");
 208
 209         mem_rman.rm_start = 0;
 210         mem_rman.rm_end = ~0u;
 211         mem_rman.rm_type = RMAN_ARRAY;
 212         mem_rman.rm_descr = "I/O memory addresses";
 213         if (rman_init(&mem_rman)
 214             || rman_manage_region(&mem_rman, 0, ~0))
 215                 panic("nexus_probe mem_rman");
 216
 217         return bus_generic_probe(dev);
 218 }
 219
 220 static int
 221 nexus_attach(device_t dev)
 222 {
 223         device_t        child;
 224
 225         /*
 226          * First, deal with the children we know about already
 227          */
 228         bus_generic_attach(dev);
 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, 0, "eisa", 0);
 235                 if (child == NULL)
 236                         panic("nexus_attach eisa");
 237                 device_probe_and_attach(child);
 238         }
 239 #if NMCA > 0
 240         if (!devclass_get_device(devclass_find("mca"), 0)) {
 241                 child = BUS_ADD_CHILD(dev, 0, "mca", 0);
 242                 if (child == NULL)
 243                         panic("nexus_probe mca");
 244                 device_probe_and_attach(child);
 245         }
 246 #endif
 247         if (!devclass_get_device(devclass_find("isa"), 0)) {
 248                 child = BUS_ADD_CHILD(dev, 0, "isa", 0);
 249                 if (child == NULL)
 250                         panic("nexus_attach isa");
 251                 device_probe_and_attach(child);
 252         }
 253
 254         return 0;
 255 }
 256
 257 static int
 258 nexus_print_all_resources(device_t dev)
 259 {
 260         struct  nexus_device *ndev = DEVTONX(dev);
 261         struct resource_list *rl = &ndev->nx_resources;
 262         int retval = 0;
 263
 264         if (SLIST_FIRST(rl))
 265                 retval += printf(" at");
 266
 267         retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
 268         retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
 269         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
 270
 271         return retval;
 272 }
 273
 274 static int
 275 nexus_print_child(device_t bus, device_t child)
 276 {
 277         int retval = 0;
 278
 279         retval += bus_print_child_header(bus, child);
 280         retval += nexus_print_all_resources(child);
 281         retval += printf(" on motherboard\n");
 282
 283         return (retval);
 284 }
 285
 286 static device_t
 287 nexus_add_child(device_t bus, int order, const char *name, int unit)
 288 {
 289         device_t                child;
 290         struct nexus_device     *ndev;
 291
 292         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 293         if (!ndev)
 294                 return(0);
 295         resource_list_init(&ndev->nx_resources);
 296
 297         child = device_add_child_ordered(bus, order, name, unit);
 298
 299         /* should we free this in nexus_child_detached? */
 300         device_set_ivars(child, ndev);
 301
 302         return(child);
 303 }
 304
 305 /*
 306  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 307  * child of one of our descendants, not a direct child of nexus0.
 308  * (Exceptions include npx.)
 309  */
 310 static struct resource *
 311 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 312                      u_long start, u_long end, u_long count, u_int flags)
 313 {
 314         struct nexus_device *ndev = DEVTONX(child);
 315         struct  resource *rv;
 316         struct resource_list_entry *rle;
 317         struct  rman *rm;
 318         int needactivate = flags & RF_ACTIVE;
 319
 320         /*
 321          * If this is an allocation of the "default" range for a given RID, and
 322          * we know what the resources for this device are (ie. they aren't maintained
 323          * by a child bus), then work out the start/end values.
 324          */
 325         if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
 326                 if (ndev == NULL)
 327                         return(NULL);
 328                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 329                 if (rle == NULL)
 330                         return(NULL);
 331                 start = rle->start;
 332                 end = rle->end;
 333                 count = rle->count;
 334         }
 335
 336         flags &= ~RF_ACTIVE;
 337
 338         switch (type) {
 339         case SYS_RES_IRQ:
 340                 rm = &irq_rman;
 341                 break;
 342
 343         case SYS_RES_DRQ:
 344                 rm = &drq_rman;
 345                 break;
 346
 347         case SYS_RES_IOPORT:
 348                 rm = &port_rman;
 349                 break;
 350
 351         case SYS_RES_MEMORY:
 352                 rm = &mem_rman;
 353                 break;
 354
 355         default:
 356                 return 0;
 357         }
 358
 359         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 360         if (rv == 0)
 361                 return 0;
 362
 363         if (type == SYS_RES_MEMORY) {
 364                 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
 365         } else if (type == SYS_RES_IOPORT) {
 366                 rman_set_bustag(rv, I386_BUS_SPACE_IO);
 367 #ifndef PC98
 368                 rman_set_bushandle(rv, rv->r_start);
 369 #endif
 370         }
 371
 372 #ifdef PC98
 373         if ((type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) &&
 374             i386_bus_space_handle_alloc(rv->r_bustag, rv->r_start, count,
 375                                         &rv->r_bushandle) != 0) {
 376                 rman_release_resource(rv);
 377                 return 0;
 378         }
 379 #endif
 380
 381         if (needactivate) {
 382                 if (bus_activate_resource(child, type, *rid, rv)) {
 383 #ifdef PC98
 384                         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 385                                 i386_bus_space_handle_free(rv->r_bustag,
 386                                   rv->r_bushandle, rv->r_bushandle->bsh_sz);
 387                         }
 388 #endif
 389                         rman_release_resource(rv);
 390                         return 0;
 391                 }
 392         }
 393
 394         return rv;
 395 }
 396
 397 static int
 398 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 399                         struct resource *r)
 400 {
 401         /*
 402          * If this is a memory resource, map it into the kernel.
 403          */
 404         if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
 405                 caddr_t vaddr = 0;
 406
 407                 if (r->r_end < 1024 * 1024) {
 408                         /*
 409                          * The first 1Mb is mapped at KERNBASE.
 410                          */
 411                         vaddr = (caddr_t)(uintptr_t)(KERNBASE + r->r_start);
 412                 } else {
 413                         u_int32_t paddr;
 414                         u_int32_t psize;
 415                         u_int32_t poffs;
 416
 417                         paddr = r->r_start;
 418                         psize = r->r_end - r->r_start;
 419
 420                         poffs = paddr - trunc_page(paddr);
 421                         vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
 422                 }
 423                 rman_set_virtual(r, vaddr);
 424 #ifdef PC98
 425                 /* PC-98: the type of bus_space_handle_t is the structure. */
 426                 r->r_bushandle->bsh_base = (bus_addr_t) vaddr;
 427 #else
 428                 /* IBM-PC: the type of bus_space_handle_t is u_int */
 429                 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
 430 #endif
 431         }
 432         return (rman_activate_resource(r));
 433 }
 434
 435 static int
 436 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 437                           struct resource *r)
 438 {
 439         /*
 440          * If this is a memory resource, unmap it.
 441          */
 442         if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) && (r->r_end >= 1024 * 1024)) {
 443                 u_int32_t psize;
 444
 445                 psize = r->r_end - r->r_start;
 446                 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
 447         }
 448
 449         return (rman_deactivate_resource(r));
 450 }
 451
 452 static int
 453 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 454                        struct resource *r)
 455 {
 456         if (r->r_flags & RF_ACTIVE) {
 457                 int error = bus_deactivate_resource(child, type, rid, r);
 458                 if (error)
 459                         return error;
 460         }
 461 #ifdef PC98
 462         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 463                 i386_bus_space_handle_free(r->r_bustag, r->r_bushandle,
 464                                            r->r_bushandle->bsh_sz);
 465         }
 466 #endif
 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, void **cookiep)
 479 {
 480         intrmask_t      *mask;
 481         driver_t        *driver;
 482         int     error, icflags;
 483
 484         /* somebody tried to setup an irq that failed to allocate! */
 485         if (irq == NULL)
 486                 panic("nexus_setup_intr: NULL irq resource!");
 487
 488         *cookiep = 0;
 489         if (irq->r_flags & RF_SHAREABLE)
 490                 icflags = 0;
 491         else
 492                 icflags = INTR_EXCL;
 493
 494         driver = device_get_driver(child);
 495         switch (flags & ~INTR_TYPE_FAST) {
 496         case INTR_TYPE_TTY:
 497                 mask = &tty_imask;
 498                 break;
 499         case INTR_TYPE_BIO:
 500                 mask = &bio_imask;
 501                 break;
 502         case INTR_TYPE_NET:
 503                 mask = &net_imask;
 504                 break;
 505         case INTR_TYPE_CAM:
 506                 mask = &cam_imask;
 507                 break;
 508         case INTR_TYPE_MISC:
 509                 mask = 0;
 510                 break;
 511         default:
 512                 panic("still using grody create_intr interface");
 513         }
 514         if (flags & INTR_TYPE_FAST)
 515                 icflags |= INTR_FAST;
 516
 517         /*
 518          * We depend here on rman_activate_resource() being idempotent.
 519          */
 520         error = rman_activate_resource(irq);
 521         if (error)
 522                 return (error);
 523
 524         *cookiep = inthand_add(device_get_nameunit(child), irq->r_start,
 525             ihand, arg, mask, icflags);
 526         if (*cookiep == NULL)
 527                 error = EINVAL; /* XXX ??? */
 528
 529         return (error);
 530 }
 531
 532 static int
 533 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 534 {
 535         return (inthand_remove(ih));
 536 }
 537
 538 static int
 539 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
 540 {
 541         struct nexus_device     *ndev = DEVTONX(child);
 542         struct resource_list    *rl = &ndev->nx_resources;
 543
 544         /* XXX this should return a success/failure indicator */
 545         resource_list_add(rl, type, rid, start, start + count - 1, count);
 546         return(0);
 547 }
 548
 549 static int
 550 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
 551 {
 552         struct nexus_device     *ndev = DEVTONX(child);
 553         struct resource_list    *rl = &ndev->nx_resources;
 554         struct resource_list_entry *rle;
 555
 556         rle = resource_list_find(rl, type, rid);
 557         device_printf(child, "type %d  rid %d  startp %p  countp %p - got %p\n",
 558                       type, rid, startp, countp, rle);
 559         if (!rle)
 560                 return(ENOENT);
 561         if (startp)
 562                 *startp = rle->start;
 563         if (countp)
 564                 *countp = rle->count;
 565         return(0);
 566 }
 567
 568 static void
 569 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
 570 {
 571         struct nexus_device     *ndev = DEVTONX(child);
 572         struct resource_list    *rl = &ndev->nx_resources;
 573
 574         resource_list_delete(rl, type, rid);
 575 }