sys/kern/subr_bus.c

   1 /*
   2  * Copyright (c) 1997,1998 Doug Rabson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/kern/subr_bus.c,v 1.54.2.9 2002/10/10 15:13:32 jhb Exp $
  27  */
  28
  29 #include "opt_bus.h"
  30
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/malloc.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/kobj.h>
  37 #include <sys/bus_private.h>
  38 #include <sys/sysctl.h>
  39 #include <sys/systm.h>
  40 #include <sys/bus.h>
  41 #include <sys/rman.h>
  42 #include <sys/device.h>
  43 #include <sys/lock.h>
  44 #include <sys/conf.h>
  45 #include <sys/uio.h>
  46 #include <sys/filio.h>
  47 #include <sys/event.h>
  48 #include <sys/signalvar.h>
  49 #include <sys/machintr.h>
  50
  51 #include <machine/stdarg.h>     /* for device_printf() */
  52
  53 #include <sys/thread2.h>
  54 #include <sys/mplock2.h>
  55
  56 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
  57
  58 MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
  59
  60 #ifdef BUS_DEBUG
  61 #define PDEBUG(a)       (kprintf("%s:%d: ", __func__, __LINE__), kprintf a, kprintf("\n"))
  62 #define DEVICENAME(d)   ((d)? device_get_name(d): "no device")
  63 #define DRIVERNAME(d)   ((d)? d->name : "no driver")
  64 #define DEVCLANAME(d)   ((d)? d->name : "no devclass")
  65
  66 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to
  67  * prevent syslog from deleting initial spaces
  68  */
  69 #define indentprintf(p) do { int iJ; kprintf("."); for (iJ=0; iJ<indent; iJ++) kprintf("  "); kprintf p ; } while(0)
  70
  71 static void     print_device_short(device_t dev, int indent);
  72 static void     print_device(device_t dev, int indent);
  73 void            print_device_tree_short(device_t dev, int indent);
  74 void            print_device_tree(device_t dev, int indent);
  75 static void     print_driver_short(driver_t *driver, int indent);
  76 static void     print_driver(driver_t *driver, int indent);
  77 static void     print_driver_list(driver_list_t drivers, int indent);
  78 static void     print_devclass_short(devclass_t dc, int indent);
  79 static void     print_devclass(devclass_t dc, int indent);
  80 void            print_devclass_list_short(void);
  81 void            print_devclass_list(void);
  82
  83 #else
  84 /* Make the compiler ignore the function calls */
  85 #define PDEBUG(a)                       /* nop */
  86 #define DEVICENAME(d)                   /* nop */
  87 #define DRIVERNAME(d)                   /* nop */
  88 #define DEVCLANAME(d)                   /* nop */
  89
  90 #define print_device_short(d,i)         /* nop */
  91 #define print_device(d,i)               /* nop */
  92 #define print_device_tree_short(d,i)    /* nop */
  93 #define print_device_tree(d,i)          /* nop */
  94 #define print_driver_short(d,i)         /* nop */
  95 #define print_driver(d,i)               /* nop */
  96 #define print_driver_list(d,i)          /* nop */
  97 #define print_devclass_short(d,i)       /* nop */
  98 #define print_devclass(d,i)             /* nop */
  99 #define print_devclass_list_short()     /* nop */
 100 #define print_devclass_list()           /* nop */
 101 #endif
 102
 103 static void     device_attach_async(device_t dev);
 104 static void     device_attach_thread(void *arg);
 105 static int      device_doattach(device_t dev);
 106
 107 static int do_async_attach = 0;
 108 static int numasyncthreads;
 109 TUNABLE_INT("kern.do_async_attach", &do_async_attach);
 110
 111 /*
 112  * /dev/devctl implementation
 113  */
 114
 115 /*
 116  * This design allows only one reader for /dev/devctl.  This is not desirable
 117  * in the long run, but will get a lot of hair out of this implementation.
 118  * Maybe we should make this device a clonable device.
 119  *
 120  * Also note: we specifically do not attach a device to the device_t tree
 121  * to avoid potential chicken and egg problems.  One could argue that all
 122  * of this belongs to the root node.  One could also further argue that the
 123  * sysctl interface that we have not might more properly be an ioctl
 124  * interface, but at this stage of the game, I'm not inclined to rock that
 125  * boat.
 126  *
 127  * I'm also not sure that the SIGIO support is done correctly or not, as
 128  * I copied it from a driver that had SIGIO support that likely hasn't been
 129  * tested since 3.4 or 2.2.8!
 130  */
 131
 132 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
 133 static int devctl_disable = 0;
 134 TUNABLE_INT("hw.bus.devctl_disable", &devctl_disable);
 135 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
 136     sysctl_devctl_disable, "I", "devctl disable");
 137
 138 static d_open_t         devopen;
 139 static d_close_t        devclose;
 140 static d_read_t         devread;
 141 static d_ioctl_t        devioctl;
 142 static d_kqfilter_t     devkqfilter;
 143
 144 static struct dev_ops devctl_ops = {
 145         { "devctl", 0, 0 },
 146         .d_open =       devopen,
 147         .d_close =      devclose,
 148         .d_read =       devread,
 149         .d_ioctl =      devioctl,
 150         .d_kqfilter =   devkqfilter
 151 };
 152
 153 struct dev_event_info
 154 {
 155         char *dei_data;
 156         TAILQ_ENTRY(dev_event_info) dei_link;
 157 };
 158
 159 TAILQ_HEAD(devq, dev_event_info);
 160
 161 static struct dev_softc
 162 {
 163         int     inuse;
 164         int     nonblock;
 165         struct lock lock;
 166         struct kqinfo kq;
 167         struct devq devq;
 168         struct proc *async_proc;
 169 } devsoftc;
 170
 171 static void
 172 devinit(void)
 173 {
 174         make_dev(&devctl_ops, 0, UID_ROOT, GID_WHEEL, 0600, "devctl");
 175         lockinit(&devsoftc.lock, "dev mtx", 0, 0);
 176         TAILQ_INIT(&devsoftc.devq);
 177 }
 178
 179 static int
 180 devopen(struct dev_open_args *ap)
 181 {
 182         if (devsoftc.inuse)
 183                 return (EBUSY);
 184         /* move to init */
 185         devsoftc.inuse = 1;
 186         devsoftc.nonblock = 0;
 187         devsoftc.async_proc = NULL;
 188         return (0);
 189 }
 190
 191 static int
 192 devclose(struct dev_close_args *ap)
 193 {
 194         devsoftc.inuse = 0;
 195         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 196         wakeup(&devsoftc);
 197         lockmgr(&devsoftc.lock, LK_RELEASE);
 198
 199         return (0);
 200 }
 201
 202 /*
 203  * The read channel for this device is used to report changes to
 204  * userland in realtime.  We are required to free the data as well as
 205  * the n1 object because we allocate them separately.  Also note that
 206  * we return one record at a time.  If you try to read this device a
 207  * character at a time, you will lose the rest of the data.  Listening
 208  * programs are expected to cope.
 209  */
 210 static int
 211 devread(struct dev_read_args *ap)
 212 {
 213         struct uio *uio = ap->a_uio;
 214         struct dev_event_info *n1;
 215         int rv;
 216
 217         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 218         while (TAILQ_EMPTY(&devsoftc.devq)) {
 219                 if (devsoftc.nonblock) {
 220                         lockmgr(&devsoftc.lock, LK_RELEASE);
 221                         return (EAGAIN);
 222                 }
 223                 tsleep_interlock(&devsoftc, PCATCH);
 224                 lockmgr(&devsoftc.lock, LK_RELEASE);
 225                 rv = tsleep(&devsoftc, PCATCH | PINTERLOCKED, "devctl", 0);
 226                 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 227                 if (rv) {
 228                         /*
 229                          * Need to translate ERESTART to EINTR here? -- jake
 230                          */
 231                         lockmgr(&devsoftc.lock, LK_RELEASE);
 232                         return (rv);
 233                 }
 234         }
 235         n1 = TAILQ_FIRST(&devsoftc.devq);
 236         TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
 237         lockmgr(&devsoftc.lock, LK_RELEASE);
 238         rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
 239         kfree(n1->dei_data, M_BUS);
 240         kfree(n1, M_BUS);
 241         return (rv);
 242 }
 243
 244 static  int
 245 devioctl(struct dev_ioctl_args *ap)
 246 {
 247         switch (ap->a_cmd) {
 248
 249         case FIONBIO:
 250                 if (*(int*)ap->a_data)
 251                         devsoftc.nonblock = 1;
 252                 else
 253                         devsoftc.nonblock = 0;
 254                 return (0);
 255         case FIOASYNC:
 256                 if (*(int*)ap->a_data)
 257                         devsoftc.async_proc = curproc;
 258                 else
 259                         devsoftc.async_proc = NULL;
 260                 return (0);
 261
 262                 /* (un)Support for other fcntl() calls. */
 263         case FIOCLEX:
 264         case FIONCLEX:
 265         case FIONREAD:
 266         case FIOSETOWN:
 267         case FIOGETOWN:
 268         default:
 269                 break;
 270         }
 271         return (ENOTTY);
 272 }
 273
 274 static void dev_filter_detach(struct knote *);
 275 static int dev_filter_read(struct knote *, long);
 276
 277 static struct filterops dev_filtops =
 278         { FILTEROP_ISFD, NULL, dev_filter_detach, dev_filter_read };
 279
 280 static int
 281 devkqfilter(struct dev_kqfilter_args *ap)
 282 {
 283         struct knote *kn = ap->a_kn;
 284         struct klist *klist;
 285
 286         ap->a_result = 0;
 287         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 288
 289         switch (kn->kn_filter) {
 290         case EVFILT_READ:
 291                 kn->kn_fop = &dev_filtops;
 292                 break;
 293         default:
 294                 ap->a_result = EOPNOTSUPP;
 295                 lockmgr(&devsoftc.lock, LK_RELEASE);
 296                 return (0);
 297         }
 298
 299         klist = &devsoftc.kq.ki_note;
 300         knote_insert(klist, kn);
 301
 302         lockmgr(&devsoftc.lock, LK_RELEASE);
 303
 304         return (0);
 305 }
 306
 307 static void
 308 dev_filter_detach(struct knote *kn)
 309 {
 310         struct klist *klist;
 311
 312         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 313         klist = &devsoftc.kq.ki_note;
 314         knote_remove(klist, kn);
 315         lockmgr(&devsoftc.lock, LK_RELEASE);
 316 }
 317
 318 static int
 319 dev_filter_read(struct knote *kn, long hint)
 320 {
 321         int ready = 0;
 322
 323         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 324         if (!TAILQ_EMPTY(&devsoftc.devq))
 325                 ready = 1;
 326         lockmgr(&devsoftc.lock, LK_RELEASE);
 327
 328         return (ready);
 329 }
 330
 331
 332 /**
 333  * @brief Return whether the userland process is running
 334  */
 335 boolean_t
 336 devctl_process_running(void)
 337 {
 338         return (devsoftc.inuse == 1);
 339 }
 340
 341 /**
 342  * @brief Queue data to be read from the devctl device
 343  *
 344  * Generic interface to queue data to the devctl device.  It is
 345  * assumed that @p data is properly formatted.  It is further assumed
 346  * that @p data is allocated using the M_BUS malloc type.
 347  */
 348 void
 349 devctl_queue_data(char *data)
 350 {
 351         struct dev_event_info *n1 = NULL;
 352         struct proc *p;
 353
 354         n1 = kmalloc(sizeof(*n1), M_BUS, M_NOWAIT);
 355         if (n1 == NULL)
 356                 return;
 357         n1->dei_data = data;
 358         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 359         TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
 360         wakeup(&devsoftc);
 361         lockmgr(&devsoftc.lock, LK_RELEASE);
 362         KNOTE(&devsoftc.kq.ki_note, 0);
 363         p = devsoftc.async_proc;
 364         if (p != NULL)
 365                 ksignal(p, SIGIO);
 366 }
 367
 368 /**
 369  * @brief Send a 'notification' to userland, using standard ways
 370  */
 371 void
 372 devctl_notify(const char *system, const char *subsystem, const char *type,
 373     const char *data)
 374 {
 375         int len = 0;
 376         char *msg;
 377
 378         if (system == NULL)
 379                 return;         /* BOGUS!  Must specify system. */
 380         if (subsystem == NULL)
 381                 return;         /* BOGUS!  Must specify subsystem. */
 382         if (type == NULL)
 383                 return;         /* BOGUS!  Must specify type. */
 384         len += strlen(" system=") + strlen(system);
 385         len += strlen(" subsystem=") + strlen(subsystem);
 386         len += strlen(" type=") + strlen(type);
 387         /* add in the data message plus newline. */
 388         if (data != NULL)
 389                 len += strlen(data);
 390         len += 3;       /* '!', '\n', and NUL */
 391         msg = kmalloc(len, M_BUS, M_NOWAIT);
 392         if (msg == NULL)
 393                 return;         /* Drop it on the floor */
 394         if (data != NULL)
 395                 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
 396                     system, subsystem, type, data);
 397         else
 398                 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
 399                     system, subsystem, type);
 400         devctl_queue_data(msg);
 401 }
 402
 403 /*
 404  * Common routine that tries to make sending messages as easy as possible.
 405  * We allocate memory for the data, copy strings into that, but do not
 406  * free it unless there's an error.  The dequeue part of the driver should
 407  * free the data.  We don't send data when the device is disabled.  We do
 408  * send data, even when we have no listeners, because we wish to avoid
 409  * races relating to startup and restart of listening applications.
 410  *
 411  * devaddq is designed to string together the type of event, with the
 412  * object of that event, plus the plug and play info and location info
 413  * for that event.  This is likely most useful for devices, but less
 414  * useful for other consumers of this interface.  Those should use
 415  * the devctl_queue_data() interface instead.
 416  */
 417 static void
 418 devaddq(const char *type, const char *what, device_t dev)
 419 {
 420         char *data = NULL;
 421         char *loc = NULL;
 422         char *pnp = NULL;
 423         const char *parstr;
 424
 425         if (devctl_disable)
 426                 return;
 427         data = kmalloc(1024, M_BUS, M_NOWAIT);
 428         if (data == NULL)
 429                 goto bad;
 430
 431         /* get the bus specific location of this device */
 432         loc = kmalloc(1024, M_BUS, M_NOWAIT);
 433         if (loc == NULL)
 434                 goto bad;
 435         *loc = '\0';
 436         bus_child_location_str(dev, loc, 1024);
 437
 438         /* Get the bus specific pnp info of this device */
 439         pnp = kmalloc(1024, M_BUS, M_NOWAIT);
 440         if (pnp == NULL)
 441                 goto bad;
 442         *pnp = '\0';
 443         bus_child_pnpinfo_str(dev, pnp, 1024);
 444
 445         /* Get the parent of this device, or / if high enough in the tree. */
 446         if (device_get_parent(dev) == NULL)
 447                 parstr = ".";   /* Or '/' ? */
 448         else
 449                 parstr = device_get_nameunit(device_get_parent(dev));
 450         /* String it all together. */
 451         ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
 452           parstr);
 453         kfree(loc, M_BUS);
 454         kfree(pnp, M_BUS);
 455         devctl_queue_data(data);
 456         return;
 457 bad:
 458         kfree(pnp, M_BUS);
 459         kfree(loc, M_BUS);
 460         kfree(data, M_BUS);
 461         return;
 462 }
 463
 464 /*
 465  * A device was added to the tree.  We are called just after it successfully
 466  * attaches (that is, probe and attach success for this device).  No call
 467  * is made if a device is merely parented into the tree.  See devnomatch
 468  * if probe fails.  If attach fails, no notification is sent (but maybe
 469  * we should have a different message for this).
 470  */
 471 static void
 472 devadded(device_t dev)
 473 {
 474         char *pnp = NULL;
 475         char *tmp = NULL;
 476
 477         pnp = kmalloc(1024, M_BUS, M_NOWAIT);
 478         if (pnp == NULL)
 479                 goto fail;
 480         tmp = kmalloc(1024, M_BUS, M_NOWAIT);
 481         if (tmp == NULL)
 482                 goto fail;
 483         *pnp = '\0';
 484         bus_child_pnpinfo_str(dev, pnp, 1024);
 485         ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
 486         devaddq("+", tmp, dev);
 487 fail:
 488         if (pnp != NULL)
 489                 kfree(pnp, M_BUS);
 490         if (tmp != NULL)
 491                 kfree(tmp, M_BUS);
 492         return;
 493 }
 494
 495 /*
 496  * A device was removed from the tree.  We are called just before this
 497  * happens.
 498  */
 499 static void
 500 devremoved(device_t dev)
 501 {
 502         char *pnp = NULL;
 503         char *tmp = NULL;
 504
 505         pnp = kmalloc(1024, M_BUS, M_NOWAIT);
 506         if (pnp == NULL)
 507                 goto fail;
 508         tmp = kmalloc(1024, M_BUS, M_NOWAIT);
 509         if (tmp == NULL)
 510                 goto fail;
 511         *pnp = '\0';
 512         bus_child_pnpinfo_str(dev, pnp, 1024);
 513         ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
 514         devaddq("-", tmp, dev);
 515 fail:
 516         if (pnp != NULL)
 517                 kfree(pnp, M_BUS);
 518         if (tmp != NULL)
 519                 kfree(tmp, M_BUS);
 520         return;
 521 }
 522
 523 /*
 524  * Called when there's no match for this device.  This is only called
 525  * the first time that no match happens, so we don't keep getitng this
 526  * message.  Should that prove to be undesirable, we can change it.
 527  * This is called when all drivers that can attach to a given bus
 528  * decline to accept this device.  Other errrors may not be detected.
 529  */
 530 static void
 531 devnomatch(device_t dev)
 532 {
 533         devaddq("?", "", dev);
 534 }
 535
 536 static int
 537 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
 538 {
 539         struct dev_event_info *n1;
 540         int dis, error;
 541
 542         dis = devctl_disable;
 543         error = sysctl_handle_int(oidp, &dis, 0, req);
 544         if (error || !req->newptr)
 545                 return (error);
 546         lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
 547         devctl_disable = dis;
 548         if (dis) {
 549                 while (!TAILQ_EMPTY(&devsoftc.devq)) {
 550                         n1 = TAILQ_FIRST(&devsoftc.devq);
 551                         TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
 552                         kfree(n1->dei_data, M_BUS);
 553                         kfree(n1, M_BUS);
 554                 }
 555         }
 556         lockmgr(&devsoftc.lock, LK_RELEASE);
 557         return (0);
 558 }
 559
 560 /* End of /dev/devctl code */
 561
 562 TAILQ_HEAD(,device)     bus_data_devices;
 563 static int bus_data_generation = 1;
 564
 565 kobj_method_t null_methods[] = {
 566         { 0, 0 }
 567 };
 568
 569 DEFINE_CLASS(null, null_methods, 0);
 570
 571 /*
 572  * Devclass implementation
 573  */
 574
 575 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
 576
 577 static devclass_t
 578 devclass_find_internal(const char *classname, const char *parentname,
 579                        int create)
 580 {
 581         devclass_t dc;
 582
 583         PDEBUG(("looking for %s", classname));
 584         if (classname == NULL)
 585                 return(NULL);
 586
 587         TAILQ_FOREACH(dc, &devclasses, link)
 588                 if (!strcmp(dc->name, classname))
 589                         break;
 590
 591         if (create && !dc) {
 592                 PDEBUG(("creating %s", classname));
 593                 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
 594                             M_BUS, M_INTWAIT | M_ZERO);
 595                 dc->parent = NULL;
 596                 dc->name = (char*) (dc + 1);
 597                 strcpy(dc->name, classname);
 598                 dc->devices = NULL;
 599                 dc->maxunit = 0;
 600                 TAILQ_INIT(&dc->drivers);
 601                 TAILQ_INSERT_TAIL(&devclasses, dc, link);
 602
 603                 bus_data_generation_update();
 604
 605         }
 606
 607         /*
 608          * If a parent class is specified, then set that as our parent so
 609          * that this devclass will support drivers for the parent class as
 610          * well.  If the parent class has the same name don't do this though
 611          * as it creates a cycle that can trigger an infinite loop in
 612          * device_probe_child() if a device exists for which there is no
 613          * suitable driver.
 614          */
 615         if (parentname && dc && !dc->parent &&
 616             strcmp(classname, parentname) != 0)
 617                 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
 618
 619         return(dc);
 620 }
 621
 622 devclass_t
 623 devclass_create(const char *classname)
 624 {
 625         return(devclass_find_internal(classname, NULL, TRUE));
 626 }
 627
 628 devclass_t
 629 devclass_find(const char *classname)
 630 {
 631         return(devclass_find_internal(classname, NULL, FALSE));
 632 }
 633
 634 device_t
 635 devclass_find_unit(const char *classname, int unit)
 636 {
 637         devclass_t dc;
 638
 639         if ((dc = devclass_find(classname)) != NULL)
 640             return(devclass_get_device(dc, unit));
 641         return (NULL);
 642 }
 643
 644 int
 645 devclass_add_driver(devclass_t dc, driver_t *driver)
 646 {
 647         driverlink_t dl;
 648         device_t dev;
 649         int i;
 650
 651         PDEBUG(("%s", DRIVERNAME(driver)));
 652
 653         dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
 654
 655         /*
 656          * Compile the driver's methods. Also increase the reference count
 657          * so that the class doesn't get freed when the last instance
 658          * goes. This means we can safely use static methods and avoids a
 659          * double-free in devclass_delete_driver.
 660          */
 661         kobj_class_instantiate(driver);
 662
 663         /*
 664          * Make sure the devclass which the driver is implementing exists.
 665          */
 666         devclass_find_internal(driver->name, NULL, TRUE);
 667
 668         dl->driver = driver;
 669         TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
 670
 671         /*
 672          * Call BUS_DRIVER_ADDED for any existing busses in this class,
 673          * but only if the bus has already been attached (otherwise we
 674          * might probe too early).
 675          *
 676          * This is what will cause a newly loaded module to be associated
 677          * with hardware.  bus_generic_driver_added() is typically what ends
 678          * up being called.
 679          */
 680         for (i = 0; i < dc->maxunit; i++) {
 681                 if ((dev = dc->devices[i]) != NULL) {
 682                         if (dev->state >= DS_ATTACHED)
 683                                 BUS_DRIVER_ADDED(dev, driver);
 684                 }
 685         }
 686
 687         bus_data_generation_update();
 688         return(0);
 689 }
 690
 691 int
 692 devclass_delete_driver(devclass_t busclass, driver_t *driver)
 693 {
 694         devclass_t dc = devclass_find(driver->name);
 695         driverlink_t dl;
 696         device_t dev;
 697         int i;
 698         int error;
 699
 700         PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
 701
 702         if (!dc)
 703                 return(0);
 704
 705         /*
 706          * Find the link structure in the bus' list of drivers.
 707          */
 708         TAILQ_FOREACH(dl, &busclass->drivers, link)
 709                 if (dl->driver == driver)
 710                         break;
 711
 712         if (!dl) {
 713                 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
 714                 return(ENOENT);
 715         }
 716
 717         /*
 718          * Disassociate from any devices.  We iterate through all the
 719          * devices in the devclass of the driver and detach any which are
 720          * using the driver and which have a parent in the devclass which
 721          * we are deleting from.
 722          *
 723          * Note that since a driver can be in multiple devclasses, we
 724          * should not detach devices which are not children of devices in
 725          * the affected devclass.
 726          */
 727         for (i = 0; i < dc->maxunit; i++)
 728                 if (dc->devices[i]) {
 729                         dev = dc->devices[i];
 730                         if (dev->driver == driver && dev->parent &&
 731                             dev->parent->devclass == busclass) {
 732                                 if ((error = device_detach(dev)) != 0)
 733                                         return(error);
 734                                 device_set_driver(dev, NULL);
 735                         }
 736                 }
 737
 738         TAILQ_REMOVE(&busclass->drivers, dl, link);
 739         kfree(dl, M_BUS);
 740
 741         kobj_class_uninstantiate(driver);
 742
 743         bus_data_generation_update();
 744         return(0);
 745 }
 746
 747 static driverlink_t
 748 devclass_find_driver_internal(devclass_t dc, const char *classname)
 749 {
 750         driverlink_t dl;
 751
 752         PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
 753
 754         TAILQ_FOREACH(dl, &dc->drivers, link)
 755                 if (!strcmp(dl->driver->name, classname))
 756                         return(dl);
 757
 758         PDEBUG(("not found"));
 759         return(NULL);
 760 }
 761
 762 kobj_class_t
 763 devclass_find_driver(devclass_t dc, const char *classname)
 764 {
 765         driverlink_t dl;
 766
 767         dl = devclass_find_driver_internal(dc, classname);
 768         if (dl)
 769                 return(dl->driver);
 770         else
 771                 return(NULL);
 772 }
 773
 774 const char *
 775 devclass_get_name(devclass_t dc)
 776 {
 777         return(dc->name);
 778 }
 779
 780 device_t
 781 devclass_get_device(devclass_t dc, int unit)
 782 {
 783         if (dc == NULL || unit < 0 || unit >= dc->maxunit)
 784                 return(NULL);
 785         return(dc->devices[unit]);
 786 }
 787
 788 void *
 789 devclass_get_softc(devclass_t dc, int unit)
 790 {
 791         device_t dev;
 792
 793         dev = devclass_get_device(dc, unit);
 794         if (!dev)
 795                 return(NULL);
 796
 797         return(device_get_softc(dev));
 798 }
 799
 800 int
 801 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
 802 {
 803         int i;
 804         int count;
 805         device_t *list;
 806
 807         count = 0;
 808         for (i = 0; i < dc->maxunit; i++)
 809                 if (dc->devices[i])
 810                         count++;
 811
 812         list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
 813
 814         count = 0;
 815         for (i = 0; i < dc->maxunit; i++)
 816                 if (dc->devices[i]) {
 817                         list[count] = dc->devices[i];
 818                         count++;
 819                 }
 820
 821         *devlistp = list;
 822         *devcountp = count;
 823
 824         return(0);
 825 }
 826
 827 /**
 828  * @brief Get a list of drivers in the devclass
 829  *
 830  * An array containing a list of pointers to all the drivers in the
 831  * given devclass is allocated and returned in @p *listp.  The number
 832  * of drivers in the array is returned in @p *countp. The caller should
 833  * free the array using @c free(p, M_TEMP).
 834  *
 835  * @param dc            the devclass to examine
 836  * @param listp         gives location for array pointer return value
 837  * @param countp        gives location for number of array elements
 838  *                      return value
 839  *
 840  * @retval 0            success
 841  * @retval ENOMEM       the array allocation failed
 842  */
 843 int
 844 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
 845 {
 846         driverlink_t dl;
 847         driver_t **list;
 848         int count;
 849
 850         count = 0;
 851         TAILQ_FOREACH(dl, &dc->drivers, link)
 852                 count++;
 853         list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
 854         if (list == NULL)
 855                 return (ENOMEM);
 856
 857         count = 0;
 858         TAILQ_FOREACH(dl, &dc->drivers, link) {
 859                 list[count] = dl->driver;
 860                 count++;
 861         }
 862         *listp = list;
 863         *countp = count;
 864
 865         return (0);
 866 }
 867
 868 /**
 869  * @brief Get the number of devices in a devclass
 870  *
 871  * @param dc            the devclass to examine
 872  */
 873 int
 874 devclass_get_count(devclass_t dc)
 875 {
 876         int count, i;
 877
 878         count = 0;
 879         for (i = 0; i < dc->maxunit; i++)
 880                 if (dc->devices[i])
 881                         count++;
 882         return (count);
 883 }
 884
 885 int
 886 devclass_get_maxunit(devclass_t dc)
 887 {
 888         return(dc->maxunit);
 889 }
 890
 891 void
 892 devclass_set_parent(devclass_t dc, devclass_t pdc)
 893 {
 894         dc->parent = pdc;
 895 }
 896
 897 devclass_t
 898 devclass_get_parent(devclass_t dc)
 899 {
 900         return(dc->parent);
 901 }
 902
 903 static int
 904 devclass_alloc_unit(devclass_t dc, int *unitp)
 905 {
 906         int unit = *unitp;
 907
 908         PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
 909
 910         /* If we have been given a wired unit number, check for existing device */
 911         if (unit != -1) {
 912                 if (unit >= 0 && unit < dc->maxunit &&
 913                     dc->devices[unit] != NULL) {
 914                         if (bootverbose)
 915                                 kprintf("%s-: %s%d exists, using next available unit number\n",
 916                                        dc->name, dc->name, unit);
 917                         /* find the next available slot */
 918                         while (++unit < dc->maxunit && dc->devices[unit] != NULL)
 919                                 ;
 920                 }
 921         } else {
 922                 /* Unwired device, find the next available slot for it */
 923                 unit = 0;
 924                 while (unit < dc->maxunit && dc->devices[unit] != NULL)
 925                         unit++;
 926         }
 927
 928         /*
 929          * We've selected a unit beyond the length of the table, so let's
 930          * extend the table to make room for all units up to and including
 931          * this one.
 932          */
 933         if (unit >= dc->maxunit) {
 934                 device_t *newlist;
 935                 int newsize;
 936
 937                 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
 938                 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
 939                                  M_INTWAIT | M_ZERO);
 940                 if (newlist == NULL)
 941                         return(ENOMEM);
 942                 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
 943                 if (dc->devices)
 944                         kfree(dc->devices, M_BUS);
 945                 dc->devices = newlist;
 946                 dc->maxunit = newsize;
 947         }
 948         PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
 949
 950         *unitp = unit;
 951         return(0);
 952 }
 953
 954 static int
 955 devclass_add_device(devclass_t dc, device_t dev)
 956 {
 957         int buflen, error;
 958
 959         PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
 960
 961         buflen = strlen(dc->name) + 5;
 962         dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
 963         if (!dev->nameunit)
 964                 return(ENOMEM);
 965
 966         if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
 967                 kfree(dev->nameunit, M_BUS);
 968                 dev->nameunit = NULL;
 969                 return(error);
 970         }
 971         dc->devices[dev->unit] = dev;
 972         dev->devclass = dc;
 973         ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
 974
 975         return(0);
 976 }
 977
 978 static int
 979 devclass_delete_device(devclass_t dc, device_t dev)
 980 {
 981         if (!dc || !dev)
 982                 return(0);
 983
 984         PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
 985
 986         if (dev->devclass != dc || dc->devices[dev->unit] != dev)
 987                 panic("devclass_delete_device: inconsistent device class");
 988         dc->devices[dev->unit] = NULL;
 989         if (dev->flags & DF_WILDCARD)
 990                 dev->unit = -1;
 991         dev->devclass = NULL;
 992         kfree(dev->nameunit, M_BUS);
 993         dev->nameunit = NULL;
 994
 995         return(0);
 996 }
 997
 998 static device_t
 999 make_device(device_t parent, const char *name, int unit)
1000 {
1001         device_t dev;
1002         devclass_t dc;
1003
1004         PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1005
1006         if (name != NULL) {
1007                 dc = devclass_find_internal(name, NULL, TRUE);
1008                 if (!dc) {
1009                         kprintf("make_device: can't find device class %s\n", name);
1010                         return(NULL);
1011                 }
1012         } else
1013                 dc = NULL;
1014
1015         dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
1016         if (!dev)
1017                 return(0);
1018
1019         dev->parent = parent;
1020         TAILQ_INIT(&dev->children);
1021         kobj_init((kobj_t) dev, &null_class);
1022         dev->driver = NULL;
1023         dev->devclass = NULL;
1024         dev->unit = unit;
1025         dev->nameunit = NULL;
1026         dev->desc = NULL;
1027         dev->busy = 0;
1028         dev->devflags = 0;
1029         dev->flags = DF_ENABLED;
1030         dev->order = 0;
1031         if (unit == -1)
1032                 dev->flags |= DF_WILDCARD;
1033         if (name) {
1034                 dev->flags |= DF_FIXEDCLASS;
1035                 if (devclass_add_device(dc, dev) != 0) {
1036                         kobj_delete((kobj_t)dev, M_BUS);
1037                         return(NULL);
1038                 }
1039         }
1040         dev->ivars = NULL;
1041         dev->softc = NULL;
1042
1043         dev->state = DS_NOTPRESENT;
1044
1045         TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1046         bus_data_generation_update();
1047
1048         return(dev);
1049 }
1050
1051 static int
1052 device_print_child(device_t dev, device_t child)
1053 {
1054         int retval = 0;
1055
1056         if (device_is_alive(child))
1057                 retval += BUS_PRINT_CHILD(dev, child);
1058         else
1059                 retval += device_printf(child, " not found\n");
1060
1061         return(retval);
1062 }
1063
1064 device_t
1065 device_add_child(device_t dev, const char *name, int unit)
1066 {
1067         return device_add_child_ordered(dev, 0, name, unit);
1068 }
1069
1070 device_t
1071 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1072 {
1073         device_t child;
1074         device_t place;
1075
1076         PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1077                 order, unit));
1078
1079         child = make_device(dev, name, unit);
1080         if (child == NULL)
1081                 return child;
1082         child->order = order;
1083
1084         TAILQ_FOREACH(place, &dev->children, link)
1085                 if (place->order > order)
1086                         break;
1087
1088         if (place) {
1089                 /*
1090                  * The device 'place' is the first device whose order is
1091                  * greater than the new child.
1092                  */
1093                 TAILQ_INSERT_BEFORE(place, child, link);
1094         } else {
1095                 /*
1096                  * The new child's order is greater or equal to the order of
1097                  * any existing device. Add the child to the tail of the list.
1098                  */
1099                 TAILQ_INSERT_TAIL(&dev->children, child, link);
1100         }
1101
1102         bus_data_generation_update();
1103         return(child);
1104 }
1105
1106 int
1107 device_delete_child(device_t dev, device_t child)
1108 {
1109         int error;
1110         device_t grandchild;
1111
1112         PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1113
1114         /* remove children first */
1115         while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1116                 error = device_delete_child(child, grandchild);
1117                 if (error)
1118                         return(error);
1119         }
1120
1121         if ((error = device_detach(child)) != 0)
1122                 return(error);
1123         if (child->devclass)
1124                 devclass_delete_device(child->devclass, child);
1125         TAILQ_REMOVE(&dev->children, child, link);
1126         TAILQ_REMOVE(&bus_data_devices, child, devlink);
1127         device_set_desc(child, NULL);
1128         kobj_delete((kobj_t)child, M_BUS);
1129
1130         bus_data_generation_update();
1131         return(0);
1132 }
1133
1134 /**
1135  * @brief Delete all children devices of the given device, if any.
1136  *
1137  * This function deletes all children devices of the given device, if
1138  * any, using the device_delete_child() function for each device it
1139  * finds. If a child device cannot be deleted, this function will
1140  * return an error code.
1141  *
1142  * @param dev           the parent device
1143  *
1144  * @retval 0            success
1145  * @retval non-zero     a device would not detach
1146  */
1147 int
1148 device_delete_children(device_t dev)
1149 {
1150         device_t child;
1151         int error;
1152
1153         PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1154
1155         error = 0;
1156
1157         while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1158                 error = device_delete_child(dev, child);
1159                 if (error) {
1160                         PDEBUG(("Failed deleting %s", DEVICENAME(child)));
1161                         break;
1162                 }
1163         }
1164         return (error);
1165 }
1166
1167 /**
1168  * @brief Find a device given a unit number
1169  *
1170  * This is similar to devclass_get_devices() but only searches for
1171  * devices which have @p dev as a parent.
1172  *
1173  * @param dev           the parent device to search
1174  * @param unit          the unit number to search for.  If the unit is -1,
1175  *                      return the first child of @p dev which has name
1176  *                      @p classname (that is, the one with the lowest unit.)
1177  *
1178  * @returns             the device with the given unit number or @c
1179  *                      NULL if there is no such device
1180  */
1181 device_t
1182 device_find_child(device_t dev, const char *classname, int unit)
1183 {
1184         devclass_t dc;
1185         device_t child;
1186
1187         dc = devclass_find(classname);
1188         if (!dc)
1189                 return(NULL);
1190
1191         if (unit != -1) {
1192                 child = devclass_get_device(dc, unit);
1193                 if (child && child->parent == dev)
1194                         return (child);
1195         } else {
1196                 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1197                         child = devclass_get_device(dc, unit);
1198                         if (child && child->parent == dev)
1199                                 return (child);
1200                 }
1201         }
1202         return(NULL);
1203 }
1204
1205 static driverlink_t
1206 first_matching_driver(devclass_t dc, device_t dev)
1207 {
1208         if (dev->devclass)
1209                 return(devclass_find_driver_internal(dc, dev->devclass->name));
1210         else
1211                 return(TAILQ_FIRST(&dc->drivers));
1212 }
1213
1214 static driverlink_t
1215 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1216 {
1217         if (dev->devclass) {
1218                 driverlink_t dl;
1219                 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1220                         if (!strcmp(dev->devclass->name, dl->driver->name))
1221                                 return(dl);
1222                 return(NULL);
1223         } else
1224                 return(TAILQ_NEXT(last, link));
1225 }
1226
1227 int
1228 device_probe_child(device_t dev, device_t child)
1229 {
1230         devclass_t dc;
1231         driverlink_t best = NULL;
1232         driverlink_t dl;
1233         int result, pri = 0;
1234         int hasclass = (child->devclass != NULL);
1235
1236         dc = dev->devclass;
1237         if (!dc)
1238                 panic("device_probe_child: parent device has no devclass");
1239
1240         if (child->state == DS_ALIVE)
1241                 return(0);
1242
1243         for (; dc; dc = dc->parent) {
1244                 for (dl = first_matching_driver(dc, child); dl;
1245                      dl = next_matching_driver(dc, child, dl)) {
1246                         PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1247                         device_set_driver(child, dl->driver);
1248                         if (!hasclass)
1249                                 device_set_devclass(child, dl->driver->name);
1250                         result = DEVICE_PROBE(child);
1251                         if (!hasclass)
1252                                 device_set_devclass(child, 0);
1253
1254                         /*
1255                          * If the driver returns SUCCESS, there can be
1256                          * no higher match for this device.
1257                          */
1258                         if (result == 0) {
1259                                 best = dl;
1260                                 pri = 0;
1261                                 break;
1262                         }
1263
1264                         /*
1265                          * The driver returned an error so it
1266                          * certainly doesn't match.
1267                          */
1268                         if (result > 0) {
1269                                 device_set_driver(child, 0);
1270                                 continue;
1271                         }
1272
1273                         /*
1274                          * A priority lower than SUCCESS, remember the
1275                          * best matching driver. Initialise the value
1276                          * of pri for the first match.
1277                          */
1278                         if (best == NULL || result > pri) {
1279                                 best = dl;
1280                                 pri = result;
1281                                 continue;
1282                         }
1283                 }
1284                 /*
1285                  * If we have unambiguous match in this devclass,
1286                  * don't look in the parent.
1287                  */
1288                 if (best && pri == 0)
1289                         break;
1290         }
1291
1292         /*
1293          * If we found a driver, change state and initialise the devclass.
1294          */
1295         if (best) {
1296                 if (!child->devclass)
1297                         device_set_devclass(child, best->driver->name);
1298                 device_set_driver(child, best->driver);
1299                 if (pri < 0) {
1300                         /*
1301                          * A bit bogus. Call the probe method again to make
1302                          * sure that we have the right description.
1303                          */
1304                         DEVICE_PROBE(child);
1305                 }
1306
1307                 bus_data_generation_update();
1308                 child->state = DS_ALIVE;
1309                 return(0);
1310         }
1311
1312         return(ENXIO);
1313 }
1314
1315 device_t
1316 device_get_parent(device_t dev)
1317 {
1318         return dev->parent;
1319 }
1320
1321 int
1322 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1323 {
1324         int count;
1325         device_t child;
1326         device_t *list;
1327
1328         count = 0;
1329         TAILQ_FOREACH(child, &dev->children, link)
1330                 count++;
1331
1332         list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1333
1334         count = 0;
1335         TAILQ_FOREACH(child, &dev->children, link) {
1336                 list[count] = child;
1337                 count++;
1338         }
1339
1340         *devlistp = list;
1341         *devcountp = count;
1342
1343         return(0);
1344 }
1345
1346 driver_t *
1347 device_get_driver(device_t dev)
1348 {
1349         return(dev->driver);
1350 }
1351
1352 devclass_t
1353 device_get_devclass(device_t dev)
1354 {
1355         return(dev->devclass);
1356 }
1357
1358 const char *
1359 device_get_name(device_t dev)
1360 {
1361         if (dev->devclass)
1362                 return devclass_get_name(dev->devclass);
1363         return(NULL);
1364 }
1365
1366 const char *
1367 device_get_nameunit(device_t dev)
1368 {
1369         return(dev->nameunit);
1370 }
1371
1372 int
1373 device_get_unit(device_t dev)
1374 {
1375         return(dev->unit);
1376 }
1377
1378 const char *
1379 device_get_desc(device_t dev)
1380 {
1381         return(dev->desc);
1382 }
1383
1384 uint32_t
1385 device_get_flags(device_t dev)
1386 {
1387         return(dev->devflags);
1388 }
1389
1390 int
1391 device_print_prettyname(device_t dev)
1392 {
1393         const char *name = device_get_name(dev);
1394
1395         if (name == NULL)
1396                 return kprintf("unknown: ");
1397         else
1398                 return kprintf("%s%d: ", name, device_get_unit(dev));
1399 }
1400
1401 int
1402 device_printf(device_t dev, const char * fmt, ...)
1403 {
1404         __va_list ap;
1405         int retval;
1406
1407         retval = device_print_prettyname(dev);
1408         __va_start(ap, fmt);
1409         retval += kvprintf(fmt, ap);
1410         __va_end(ap);
1411         return retval;
1412 }
1413
1414 static void
1415 device_set_desc_internal(device_t dev, const char* desc, int copy)
1416 {
1417         if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1418                 kfree(dev->desc, M_BUS);
1419                 dev->flags &= ~DF_DESCMALLOCED;
1420                 dev->desc = NULL;
1421         }
1422
1423         if (copy && desc) {
1424                 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1425                 if (dev->desc) {
1426                         strcpy(dev->desc, desc);
1427                         dev->flags |= DF_DESCMALLOCED;
1428                 }
1429         } else {
1430                 /* Avoid a -Wcast-qual warning */
1431                 dev->desc = (char *)(uintptr_t) desc;
1432         }
1433
1434         bus_data_generation_update();
1435 }
1436
1437 void
1438 device_set_desc(device_t dev, const char* desc)
1439 {
1440         device_set_desc_internal(dev, desc, FALSE);
1441 }
1442
1443 void
1444 device_set_desc_copy(device_t dev, const char* desc)
1445 {
1446         device_set_desc_internal(dev, desc, TRUE);
1447 }
1448
1449 void
1450 device_set_flags(device_t dev, uint32_t flags)
1451 {
1452         dev->devflags = flags;
1453 }
1454
1455 void *
1456 device_get_softc(device_t dev)
1457 {
1458         return dev->softc;
1459 }
1460
1461 void
1462 device_set_softc(device_t dev, void *softc)
1463 {
1464         if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1465                 kfree(dev->softc, M_BUS);
1466         dev->softc = softc;
1467         if (dev->softc)
1468                 dev->flags |= DF_EXTERNALSOFTC;
1469         else
1470                 dev->flags &= ~DF_EXTERNALSOFTC;
1471 }
1472
1473 void
1474 device_set_async_attach(device_t dev, int enable)
1475 {
1476         if (enable)
1477                 dev->flags |= DF_ASYNCPROBE;
1478         else
1479                 dev->flags &= ~DF_ASYNCPROBE;
1480 }
1481
1482 void *
1483 device_get_ivars(device_t dev)
1484 {
1485         return dev->ivars;
1486 }
1487
1488 void
1489 device_set_ivars(device_t dev, void * ivars)
1490 {
1491         if (!dev)
1492                 return;
1493
1494         dev->ivars = ivars;
1495 }
1496
1497 device_state_t
1498 device_get_state(device_t dev)
1499 {
1500         return(dev->state);
1501 }
1502
1503 void
1504 device_enable(device_t dev)
1505 {
1506         dev->flags |= DF_ENABLED;
1507 }
1508
1509 void
1510 device_disable(device_t dev)
1511 {
1512         dev->flags &= ~DF_ENABLED;
1513 }
1514
1515 /*
1516  * YYY cannot block
1517  */
1518 void
1519 device_busy(device_t dev)
1520 {
1521         if (dev->state < DS_ATTACHED)
1522                 panic("device_busy: called for unattached device");
1523         if (dev->busy == 0 && dev->parent)
1524                 device_busy(dev->parent);
1525         dev->busy++;
1526         dev->state = DS_BUSY;
1527 }
1528
1529 /*
1530  * YYY cannot block
1531  */
1532 void
1533 device_unbusy(device_t dev)
1534 {
1535         if (dev->state != DS_BUSY)
1536                 panic("device_unbusy: called for non-busy device");
1537         dev->busy--;
1538         if (dev->busy == 0) {
1539                 if (dev->parent)
1540                         device_unbusy(dev->parent);
1541                 dev->state = DS_ATTACHED;
1542         }
1543 }
1544
1545 void
1546 device_quiet(device_t dev)
1547 {
1548         dev->flags |= DF_QUIET;
1549 }
1550
1551 void
1552 device_verbose(device_t dev)
1553 {
1554         dev->flags &= ~DF_QUIET;
1555 }
1556
1557 int
1558 device_is_quiet(device_t dev)
1559 {
1560         return((dev->flags & DF_QUIET) != 0);
1561 }
1562
1563 int
1564 device_is_enabled(device_t dev)
1565 {
1566         return((dev->flags & DF_ENABLED) != 0);
1567 }
1568
1569 int
1570 device_is_alive(device_t dev)
1571 {
1572         return(dev->state >= DS_ALIVE);
1573 }
1574
1575 int
1576 device_is_attached(device_t dev)
1577 {
1578         return(dev->state >= DS_ATTACHED);
1579 }
1580
1581 int
1582 device_set_devclass(device_t dev, const char *classname)
1583 {
1584         devclass_t dc;
1585         int error;
1586
1587         if (!classname) {
1588                 if (dev->devclass)
1589                         devclass_delete_device(dev->devclass, dev);
1590                 return(0);
1591         }
1592
1593         if (dev->devclass) {
1594                 kprintf("device_set_devclass: device class already set\n");
1595                 return(EINVAL);
1596         }
1597
1598         dc = devclass_find_internal(classname, NULL, TRUE);
1599         if (!dc)
1600                 return(ENOMEM);
1601
1602         error = devclass_add_device(dc, dev);
1603
1604         bus_data_generation_update();
1605         return(error);
1606 }
1607
1608 int
1609 device_set_driver(device_t dev, driver_t *driver)
1610 {
1611         if (dev->state >= DS_ATTACHED)
1612                 return(EBUSY);
1613
1614         if (dev->driver == driver)
1615                 return(0);
1616
1617         if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1618                 kfree(dev->softc, M_BUS);
1619                 dev->softc = NULL;
1620         }
1621         kobj_delete((kobj_t) dev, 0);
1622         dev->driver = driver;
1623         if (driver) {
1624                 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1625                 if (!(dev->flags & DF_EXTERNALSOFTC))
1626                         dev->softc = kmalloc(driver->size, M_BUS,
1627                                             M_INTWAIT | M_ZERO);
1628         } else {
1629                 kobj_init((kobj_t) dev, &null_class);
1630         }
1631
1632         bus_data_generation_update();
1633         return(0);
1634 }
1635
1636 int
1637 device_probe_and_attach(device_t dev)
1638 {
1639         device_t bus = dev->parent;
1640         int error = 0;
1641
1642         if (dev->state >= DS_ALIVE)
1643                 return(0);
1644
1645         if ((dev->flags & DF_ENABLED) == 0) {
1646                 if (bootverbose) {
1647                         device_print_prettyname(dev);
1648                         kprintf("not probed (disabled)\n");
1649                 }
1650                 return(0);
1651         }
1652
1653         error = device_probe_child(bus, dev);
1654         if (error) {
1655                 if (!(dev->flags & DF_DONENOMATCH)) {
1656                         BUS_PROBE_NOMATCH(bus, dev);
1657                         devnomatch(dev);
1658                         dev->flags |= DF_DONENOMATCH;
1659                 }
1660                 return(error);
1661         }
1662
1663         /*
1664          * Output the exact device chain prior to the attach in case the
1665          * system locks up during attach, and generate the full info after
1666          * the attach so correct irq and other information is displayed.
1667          */
1668         if (bootverbose && !device_is_quiet(dev)) {
1669                 device_t tmp;
1670
1671                 kprintf("%s", device_get_nameunit(dev));
1672                 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1673                         kprintf(".%s", device_get_nameunit(tmp));
1674                 kprintf("\n");
1675         }
1676         if (!device_is_quiet(dev))
1677                 device_print_child(bus, dev);
1678         if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1679                 kprintf("%s: probing asynchronously\n",
1680                         device_get_nameunit(dev));
1681                 dev->state = DS_INPROGRESS;
1682                 device_attach_async(dev);
1683                 error = 0;
1684         } else {
1685                 error = device_doattach(dev);
1686         }
1687         return(error);
1688 }
1689
1690 /*
1691  * Device is known to be alive, do the attach asynchronously.
1692  * However, serialize the attaches with the mp lock.
1693  */
1694 static void
1695 device_attach_async(device_t dev)
1696 {
1697         thread_t td;
1698
1699         atomic_add_int(&numasyncthreads, 1);
1700         lwkt_create(device_attach_thread, dev, &td, NULL,
1701                     0, 0, "%s", (dev->desc ? dev->desc : "devattach"));
1702 }
1703
1704 static void
1705 device_attach_thread(void *arg)
1706 {
1707         device_t dev = arg;
1708
1709         get_mplock();   /* XXX replace with devattach_token later */
1710         (void)device_doattach(dev);
1711         atomic_subtract_int(&numasyncthreads, 1);
1712         wakeup(&numasyncthreads);
1713         rel_mplock();   /* XXX replace with devattach_token later */
1714 }
1715
1716 /*
1717  * Device is known to be alive, do the attach (synchronous or asynchronous)
1718  */
1719 static int
1720 device_doattach(device_t dev)
1721 {
1722         device_t bus = dev->parent;
1723         int hasclass = (dev->devclass != NULL);
1724         int error;
1725
1726         error = DEVICE_ATTACH(dev);
1727         if (error == 0) {
1728                 dev->state = DS_ATTACHED;
1729                 if (bootverbose && !device_is_quiet(dev))
1730                         device_print_child(bus, dev);
1731                 devadded(dev);
1732         } else {
1733                 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1734                        dev->driver->name, dev->unit, error);
1735                 /* Unset the class that was set in device_probe_child */
1736                 if (!hasclass)
1737                         device_set_devclass(dev, 0);
1738                 device_set_driver(dev, NULL);
1739                 dev->state = DS_NOTPRESENT;
1740         }
1741         return(error);
1742 }
1743
1744 int
1745 device_detach(device_t dev)
1746 {
1747         int error;
1748
1749         PDEBUG(("%s", DEVICENAME(dev)));
1750         if (dev->state == DS_BUSY)
1751                 return(EBUSY);
1752         if (dev->state != DS_ATTACHED)
1753                 return(0);
1754
1755         if ((error = DEVICE_DETACH(dev)) != 0)
1756                 return(error);
1757         devremoved(dev);
1758         device_printf(dev, "detached\n");
1759         if (dev->parent)
1760                 BUS_CHILD_DETACHED(dev->parent, dev);
1761
1762         if (!(dev->flags & DF_FIXEDCLASS))
1763                 devclass_delete_device(dev->devclass, dev);
1764
1765         dev->state = DS_NOTPRESENT;
1766         device_set_driver(dev, NULL);
1767
1768         return(0);
1769 }
1770
1771 int
1772 device_shutdown(device_t dev)
1773 {
1774         if (dev->state < DS_ATTACHED)
1775                 return 0;
1776         PDEBUG(("%s", DEVICENAME(dev)));
1777         return DEVICE_SHUTDOWN(dev);
1778 }
1779
1780 int
1781 device_set_unit(device_t dev, int unit)
1782 {
1783         devclass_t dc;
1784         int err;
1785
1786         dc = device_get_devclass(dev);
1787         if (unit < dc->maxunit && dc->devices[unit])
1788                 return(EBUSY);
1789         err = devclass_delete_device(dc, dev);
1790         if (err)
1791                 return(err);
1792         dev->unit = unit;
1793         err = devclass_add_device(dc, dev);
1794         if (err)
1795                 return(err);
1796
1797         bus_data_generation_update();
1798         return(0);
1799 }
1800
1801 /*======================================*/
1802 /*
1803  * Access functions for device resources.
1804  */
1805
1806 /* Supplied by config(8) in ioconf.c */
1807 extern struct config_device config_devtab[];
1808 extern int devtab_count;
1809
1810 /* Runtime version */
1811 struct config_device *devtab = config_devtab;
1812
1813 static int
1814 resource_new_name(const char *name, int unit)
1815 {
1816         struct config_device *new;
1817
1818         new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1819                      M_INTWAIT | M_ZERO);
1820         if (devtab && devtab_count > 0)
1821                 bcopy(devtab, new, devtab_count * sizeof(*new));
1822         new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1823         if (new[devtab_count].name == NULL) {
1824                 kfree(new, M_TEMP);
1825                 return(-1);
1826         }
1827         strcpy(new[devtab_count].name, name);
1828         new[devtab_count].unit = unit;
1829         new[devtab_count].resource_count = 0;
1830         new[devtab_count].resources = NULL;
1831         if (devtab && devtab != config_devtab)
1832                 kfree(devtab, M_TEMP);
1833         devtab = new;
1834         return devtab_count++;
1835 }
1836
1837 static int
1838 resource_new_resname(int j, const char *resname, resource_type type)
1839 {
1840         struct config_resource *new;
1841         int i;
1842
1843         i = devtab[j].resource_count;
1844         new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1845         if (devtab[j].resources && i > 0)
1846                 bcopy(devtab[j].resources, new, i * sizeof(*new));
1847         new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1848         if (new[i].name == NULL) {
1849                 kfree(new, M_TEMP);
1850                 return(-1);
1851         }
1852         strcpy(new[i].name, resname);
1853         new[i].type = type;
1854         if (devtab[j].resources)
1855                 kfree(devtab[j].resources, M_TEMP);
1856         devtab[j].resources = new;
1857         devtab[j].resource_count = i + 1;
1858         return(i);
1859 }
1860
1861 static int
1862 resource_match_string(int i, const char *resname, const char *value)
1863 {
1864         int j;
1865         struct config_resource *res;
1866
1867         for (j = 0, res = devtab[i].resources;
1868              j < devtab[i].resource_count; j++, res++)
1869                 if (!strcmp(res->name, resname)
1870                     && res->type == RES_STRING
1871                     && !strcmp(res->u.stringval, value))
1872                         return(j);
1873         return(-1);
1874 }
1875
1876 static int
1877 resource_find(const char *name, int unit, const char *resname,
1878               struct config_resource **result)
1879 {
1880         int i, j;
1881         struct config_resource *res;
1882
1883         /*
1884          * First check specific instances, then generic.
1885          */
1886         for (i = 0; i < devtab_count; i++) {
1887                 if (devtab[i].unit < 0)
1888                         continue;
1889                 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1890                         res = devtab[i].resources;
1891                         for (j = 0; j < devtab[i].resource_count; j++, res++)
1892                                 if (!strcmp(res->name, resname)) {
1893                                         *result = res;
1894                                         return(0);
1895                                 }
1896                 }
1897         }
1898         for (i = 0; i < devtab_count; i++) {
1899                 if (devtab[i].unit >= 0)
1900                         continue;
1901                 /* XXX should this `&& devtab[i].unit == unit' be here? */
1902                 /* XXX if so, then the generic match does nothing */
1903                 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1904                         res = devtab[i].resources;
1905                         for (j = 0; j < devtab[i].resource_count; j++, res++)
1906                                 if (!strcmp(res->name, resname)) {
1907                                         *result = res;
1908                                         return(0);
1909                                 }
1910                 }
1911         }
1912         return(ENOENT);
1913 }
1914
1915 static int
1916 resource_kenv(const char *name, int unit, const char *resname, long *result)
1917 {
1918         const char *env;
1919         char buf[64];
1920
1921         ksnprintf(buf, sizeof(buf), "%s%d.%s", name, unit, resname);
1922         if ((env = kgetenv(buf)) != NULL) {
1923                 *result = strtol(env, NULL, 0);
1924                 return(0);
1925         }
1926         return (ENOENT);
1927 }
1928
1929 int
1930 resource_int_value(const char *name, int unit, const char *resname, int *result)
1931 {
1932         struct config_resource *res;
1933         long kvalue = 0;
1934         int error;
1935
1936         if (resource_kenv(name, unit, resname, &kvalue) == 0) {
1937                 *result = (int)kvalue;
1938                 return 0;
1939         }
1940         if ((error = resource_find(name, unit, resname, &res)) != 0)
1941                 return(error);
1942         if (res->type != RES_INT)
1943                 return(EFTYPE);
1944         *result = res->u.intval;
1945         return(0);
1946 }
1947
1948 int
1949 resource_long_value(const char *name, int unit, const char *resname,
1950                     long *result)
1951 {
1952         struct config_resource *res;
1953         long kvalue;
1954         int error;
1955
1956         if (resource_kenv(name, unit, resname, &kvalue) == 0) {
1957                 *result = kvalue;
1958                 return 0;
1959         }
1960         if ((error = resource_find(name, unit, resname, &res)) != 0)
1961                 return(error);
1962         if (res->type != RES_LONG)
1963                 return(EFTYPE);
1964         *result = res->u.longval;
1965         return(0);
1966 }
1967
1968 int
1969 resource_string_value(const char *name, int unit, const char *resname,
1970     const char **result)
1971 {
1972         int error;
1973         struct config_resource *res;
1974
1975         if ((error = resource_find(name, unit, resname, &res)) != 0)
1976                 return(error);
1977         if (res->type != RES_STRING)
1978                 return(EFTYPE);
1979         *result = res->u.stringval;
1980         return(0);
1981 }
1982
1983 int
1984 resource_query_string(int i, const char *resname, const char *value)
1985 {
1986         if (i < 0)
1987                 i = 0;
1988         else
1989                 i = i + 1;
1990         for (; i < devtab_count; i++)
1991                 if (resource_match_string(i, resname, value) >= 0)
1992                         return(i);
1993         return(-1);
1994 }
1995
1996 int
1997 resource_locate(int i, const char *resname)
1998 {
1999         if (i < 0)
2000                 i = 0;
2001         else
2002                 i = i + 1;
2003         for (; i < devtab_count; i++)
2004                 if (!strcmp(devtab[i].name, resname))
2005                         return(i);
2006         return(-1);
2007 }
2008
2009 int
2010 resource_count(void)
2011 {
2012         return(devtab_count);
2013 }
2014
2015 char *
2016 resource_query_name(int i)
2017 {
2018         return(devtab[i].name);
2019 }
2020
2021 int
2022 resource_query_unit(int i)
2023 {
2024         return(devtab[i].unit);
2025 }
2026
2027 static int
2028 resource_create(const char *name, int unit, const char *resname,
2029                 resource_type type, struct config_resource **result)
2030 {
2031         int i, j;
2032         struct config_resource *res = NULL;
2033
2034         for (i = 0; i < devtab_count; i++)
2035                 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
2036                         res = devtab[i].resources;
2037                         break;
2038                 }
2039         if (res == NULL) {
2040                 i = resource_new_name(name, unit);
2041                 if (i < 0)
2042                         return(ENOMEM);
2043                 res = devtab[i].resources;
2044         }
2045         for (j = 0; j < devtab[i].resource_count; j++, res++)
2046                 if (!strcmp(res->name, resname)) {
2047                         *result = res;
2048                         return(0);
2049                 }
2050         j = resource_new_resname(i, resname, type);
2051         if (j < 0)
2052                 return(ENOMEM);
2053         res = &devtab[i].resources[j];
2054         *result = res;
2055         return(0);
2056 }
2057
2058 int
2059 resource_set_int(const char *name, int unit, const char *resname, int value)
2060 {
2061         int error;
2062         struct config_resource *res;
2063
2064         error = resource_create(name, unit, resname, RES_INT, &res);
2065         if (error)
2066                 return(error);
2067         if (res->type != RES_INT)
2068                 return(EFTYPE);
2069         res->u.intval = value;
2070         return(0);
2071 }
2072
2073 int
2074 resource_set_long(const char *name, int unit, const char *resname, long value)
2075 {
2076         int error;
2077         struct config_resource *res;
2078
2079         error = resource_create(name, unit, resname, RES_LONG, &res);
2080         if (error)
2081                 return(error);
2082         if (res->type != RES_LONG)
2083                 return(EFTYPE);
2084         res->u.longval = value;
2085         return(0);
2086 }
2087
2088 int
2089 resource_set_string(const char *name, int unit, const char *resname,
2090                     const char *value)
2091 {
2092         int error;
2093         struct config_resource *res;
2094
2095         error = resource_create(name, unit, resname, RES_STRING, &res);
2096         if (error)
2097                 return(error);
2098         if (res->type != RES_STRING)
2099                 return(EFTYPE);
2100         if (res->u.stringval)
2101                 kfree(res->u.stringval, M_TEMP);
2102         res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2103         if (res->u.stringval == NULL)
2104                 return(ENOMEM);
2105         strcpy(res->u.stringval, value);
2106         return(0);
2107 }
2108
2109 static void
2110 resource_cfgload(void *dummy __unused)
2111 {
2112         struct config_resource *res, *cfgres;
2113         int i, j;
2114         int error;
2115         char *name, *resname;
2116         int unit;
2117         resource_type type;
2118         char *stringval;
2119         int config_devtab_count;
2120
2121         config_devtab_count = devtab_count;
2122         devtab = NULL;
2123         devtab_count = 0;
2124
2125         for (i = 0; i < config_devtab_count; i++) {
2126                 name = config_devtab[i].name;
2127                 unit = config_devtab[i].unit;
2128
2129                 for (j = 0; j < config_devtab[i].resource_count; j++) {
2130                         cfgres = config_devtab[i].resources;
2131                         resname = cfgres[j].name;
2132                         type = cfgres[j].type;
2133                         error = resource_create(name, unit, resname, type,
2134                                                 &res);
2135                         if (error) {
2136                                 kprintf("create resource %s%d: error %d\n",
2137                                         name, unit, error);
2138                                 continue;
2139                         }
2140                         if (res->type != type) {
2141                                 kprintf("type mismatch %s%d: %d != %d\n",
2142                                         name, unit, res->type, type);
2143                                 continue;
2144                         }
2145                         switch (type) {
2146                         case RES_INT:
2147                                 res->u.intval = cfgres[j].u.intval;
2148                                 break;
2149                         case RES_LONG:
2150                                 res->u.longval = cfgres[j].u.longval;
2151                                 break;
2152                         case RES_STRING:
2153                                 if (res->u.stringval)
2154                                         kfree(res->u.stringval, M_TEMP);
2155                                 stringval = cfgres[j].u.stringval;
2156                                 res->u.stringval = kmalloc(strlen(stringval) + 1,
2157                                                           M_TEMP, M_INTWAIT);
2158                                 if (res->u.stringval == NULL)
2159                                         break;
2160                                 strcpy(res->u.stringval, stringval);
2161                                 break;
2162                         default:
2163                                 panic("unknown resource type %d", type);
2164                         }
2165                 }
2166         }
2167 }
2168 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2169
2170
2171 /*======================================*/
2172 /*
2173  * Some useful method implementations to make life easier for bus drivers.
2174  */
2175
2176 void
2177 resource_list_init(struct resource_list *rl)
2178 {
2179         SLIST_INIT(rl);
2180 }
2181
2182 void
2183 resource_list_free(struct resource_list *rl)
2184 {
2185         struct resource_list_entry *rle;
2186
2187         while ((rle = SLIST_FIRST(rl)) != NULL) {
2188                 if (rle->res)
2189                         panic("resource_list_free: resource entry is busy");
2190                 SLIST_REMOVE_HEAD(rl, link);
2191                 kfree(rle, M_BUS);
2192         }
2193 }
2194
2195 void
2196 resource_list_add(struct resource_list *rl, int type, int rid,
2197     u_long start, u_long end, u_long count, int cpuid)
2198 {
2199         struct resource_list_entry *rle;
2200
2201         rle = resource_list_find(rl, type, rid);
2202         if (rle == NULL) {
2203                 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2204                              M_INTWAIT);
2205                 SLIST_INSERT_HEAD(rl, rle, link);
2206                 rle->type = type;
2207                 rle->rid = rid;
2208                 rle->res = NULL;
2209                 rle->cpuid = -1;
2210         }
2211
2212         if (rle->res)
2213                 panic("resource_list_add: resource entry is busy");
2214
2215         rle->start = start;
2216         rle->end = end;
2217         rle->count = count;
2218
2219         if (cpuid != -1) {
2220                 if (rle->cpuid != -1 && rle->cpuid != cpuid) {
2221                         panic("resource_list_add: moving from cpu%d -> cpu%d",
2222                             rle->cpuid, cpuid);
2223                 }
2224                 rle->cpuid = cpuid;
2225         }
2226 }
2227
2228 struct resource_list_entry*
2229 resource_list_find(struct resource_list *rl,
2230                    int type, int rid)
2231 {
2232         struct resource_list_entry *rle;
2233
2234         SLIST_FOREACH(rle, rl, link)
2235                 if (rle->type == type && rle->rid == rid)
2236                         return(rle);
2237         return(NULL);
2238 }
2239
2240 void
2241 resource_list_delete(struct resource_list *rl,
2242                      int type, int rid)
2243 {
2244         struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2245
2246         if (rle) {
2247                 if (rle->res != NULL)
2248                         panic("resource_list_delete: resource has not been released");
2249                 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2250                 kfree(rle, M_BUS);
2251         }
2252 }
2253
2254 struct resource *
2255 resource_list_alloc(struct resource_list *rl,
2256                     device_t bus, device_t child,
2257                     int type, int *rid,
2258                     u_long start, u_long end,
2259                     u_long count, u_int flags, int cpuid)
2260 {
2261         struct resource_list_entry *rle = NULL;
2262         int passthrough = (device_get_parent(child) != bus);
2263         int isdefault = (start == 0UL && end == ~0UL);
2264
2265         if (passthrough) {
2266                 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2267                                           type, rid,
2268                                           start, end, count, flags, cpuid));
2269         }
2270
2271         rle = resource_list_find(rl, type, *rid);
2272
2273         if (!rle)
2274                 return(0);              /* no resource of that type/rid */
2275
2276         if (rle->res)
2277                 panic("resource_list_alloc: resource entry is busy");
2278
2279         if (isdefault) {
2280                 start = rle->start;
2281                 count = max(count, rle->count);
2282                 end = max(rle->end, start + count - 1);
2283         }
2284         cpuid = rle->cpuid;
2285
2286         rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2287                                       type, rid, start, end, count,
2288                                       flags, cpuid);
2289
2290         /*
2291          * Record the new range.
2292          */
2293         if (rle->res) {
2294                 rle->start = rman_get_start(rle->res);
2295                 rle->end = rman_get_end(rle->res);
2296                 rle->count = count;
2297         }
2298
2299         return(rle->res);
2300 }
2301
2302 int
2303 resource_list_release(struct resource_list *rl,
2304                       device_t bus, device_t child,
2305                       int type, int rid, struct resource *res)
2306 {
2307         struct resource_list_entry *rle = NULL;
2308         int passthrough = (device_get_parent(child) != bus);
2309         int error;
2310
2311         if (passthrough) {
2312                 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2313                                             type, rid, res));
2314         }
2315
2316         rle = resource_list_find(rl, type, rid);
2317
2318         if (!rle)
2319                 panic("resource_list_release: can't find resource");
2320         if (!rle->res)
2321                 panic("resource_list_release: resource entry is not busy");
2322
2323         error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2324                                      type, rid, res);
2325         if (error)
2326                 return(error);
2327
2328         rle->res = NULL;
2329         return(0);
2330 }
2331
2332 int
2333 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2334                          const char *format)
2335 {
2336         struct resource_list_entry *rle;
2337         int printed, retval;
2338
2339         printed = 0;
2340         retval = 0;
2341         /* Yes, this is kinda cheating */
2342         SLIST_FOREACH(rle, rl, link) {
2343                 if (rle->type == type) {
2344                         if (printed == 0)
2345                                 retval += kprintf(" %s ", name);
2346                         else
2347                                 retval += kprintf(",");
2348                         printed++;
2349                         retval += kprintf(format, rle->start);
2350                         if (rle->count > 1) {
2351                                 retval += kprintf("-");
2352                                 retval += kprintf(format, rle->start +
2353                                                  rle->count - 1);
2354                         }
2355                 }
2356         }
2357         return(retval);
2358 }
2359
2360 /*
2361  * Generic driver/device identify functions.  These will install a device
2362  * rendezvous point under the parent using the same name as the driver
2363  * name, which will at a later time be probed and attached.
2364  *
2365  * These functions are used when the parent does not 'scan' its bus for
2366  * matching devices, or for the particular devices using these functions,
2367  * or when the device is a pseudo or synthesized device (such as can be
2368  * found under firewire and ppbus).
2369  */
2370 int
2371 bus_generic_identify(driver_t *driver, device_t parent)
2372 {
2373         if (parent->state == DS_ATTACHED)
2374                 return (0);
2375         BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2376         return (0);
2377 }
2378
2379 int
2380 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2381 {
2382         if (parent->state == DS_ATTACHED)
2383                 return (0);
2384         BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2385         return (0);
2386 }
2387
2388 /*
2389  * Call DEVICE_IDENTIFY for each driver.
2390  */
2391 int
2392 bus_generic_probe(device_t dev)
2393 {
2394         devclass_t dc = dev->devclass;
2395         driverlink_t dl;
2396
2397         TAILQ_FOREACH(dl, &dc->drivers, link) {
2398                 DEVICE_IDENTIFY(dl->driver, dev);
2399         }
2400
2401         return(0);
2402 }
2403
2404 /*
2405  * This is an aweful hack due to the isa bus and autoconf code not
2406  * probing the ISA devices until after everything else has configured.
2407  * The ISA bus did a dummy attach long ago so we have to set it back
2408  * to an earlier state so the probe thinks its the initial probe and
2409  * not a bus rescan.
2410  *
2411  * XXX remove by properly defering the ISA bus scan.
2412  */
2413 int
2414 bus_generic_probe_hack(device_t dev)
2415 {
2416         if (dev->state == DS_ATTACHED) {
2417                 dev->state = DS_ALIVE;
2418                 bus_generic_probe(dev);
2419                 dev->state = DS_ATTACHED;
2420         }
2421         return (0);
2422 }
2423
2424 int
2425 bus_generic_attach(device_t dev)
2426 {
2427         device_t child;
2428
2429         TAILQ_FOREACH(child, &dev->children, link) {
2430                 device_probe_and_attach(child);
2431         }
2432
2433         return(0);
2434 }
2435
2436 int
2437 bus_generic_detach(device_t dev)
2438 {
2439         device_t child;
2440         int error;
2441
2442         if (dev->state != DS_ATTACHED)
2443                 return(EBUSY);
2444
2445         TAILQ_FOREACH(child, &dev->children, link)
2446                 if ((error = device_detach(child)) != 0)
2447                         return(error);
2448
2449         return 0;
2450 }
2451
2452 int
2453 bus_generic_shutdown(device_t dev)
2454 {
2455         device_t child;
2456
2457         TAILQ_FOREACH(child, &dev->children, link)
2458                 device_shutdown(child);
2459
2460         return(0);
2461 }
2462
2463 int
2464 bus_generic_suspend(device_t dev)
2465 {
2466         int error;
2467         device_t child, child2;
2468
2469         TAILQ_FOREACH(child, &dev->children, link) {
2470                 error = DEVICE_SUSPEND(child);
2471                 if (error) {
2472                         for (child2 = TAILQ_FIRST(&dev->children);
2473                              child2 && child2 != child;
2474                              child2 = TAILQ_NEXT(child2, link))
2475                                 DEVICE_RESUME(child2);
2476                         return(error);
2477                 }
2478         }
2479         return(0);
2480 }
2481
2482 int
2483 bus_generic_resume(device_t dev)
2484 {
2485         device_t child;
2486
2487         TAILQ_FOREACH(child, &dev->children, link)
2488                 DEVICE_RESUME(child);
2489                 /* if resume fails, there's nothing we can usefully do... */
2490
2491         return(0);
2492 }
2493
2494 int
2495 bus_print_child_header(device_t dev, device_t child)
2496 {
2497         int retval = 0;
2498
2499         if (device_get_desc(child))
2500                 retval += device_printf(child, "<%s>", device_get_desc(child));
2501         else
2502                 retval += kprintf("%s", device_get_nameunit(child));
2503         if (bootverbose) {
2504                 if (child->state != DS_ATTACHED)
2505                         kprintf(" [tentative]");
2506                 else
2507                         kprintf(" [attached!]");
2508         }
2509         return(retval);
2510 }
2511
2512 int
2513 bus_print_child_footer(device_t dev, device_t child)
2514 {
2515         return(kprintf(" on %s\n", device_get_nameunit(dev)));
2516 }
2517
2518 device_t
2519 bus_generic_add_child(device_t dev, device_t child, int order,
2520                       const char *name, int unit)
2521 {
2522         if (dev->parent)
2523                 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2524         else
2525                 dev = device_add_child_ordered(child, order, name, unit);
2526         return(dev);
2527
2528 }
2529
2530 int
2531 bus_generic_print_child(device_t dev, device_t child)
2532 {
2533         int retval = 0;
2534
2535         retval += bus_print_child_header(dev, child);
2536         retval += bus_print_child_footer(dev, child);
2537
2538         return(retval);
2539 }
2540
2541 int
2542 bus_generic_read_ivar(device_t dev, device_t child, int index,
2543                       uintptr_t * result)
2544 {
2545         int error;
2546
2547         if (dev->parent)
2548                 error = BUS_READ_IVAR(dev->parent, child, index, result);
2549         else
2550                 error = ENOENT;
2551         return (error);
2552 }
2553
2554 int
2555 bus_generic_write_ivar(device_t dev, device_t child, int index,
2556                        uintptr_t value)
2557 {
2558         int error;
2559
2560         if (dev->parent)
2561                 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2562         else
2563                 error = ENOENT;
2564         return (error);
2565 }
2566
2567 /*
2568  * Resource list are used for iterations, do not recurse.
2569  */
2570 struct resource_list *
2571 bus_generic_get_resource_list(device_t dev, device_t child)
2572 {
2573         return (NULL);
2574 }
2575
2576 void
2577 bus_generic_driver_added(device_t dev, driver_t *driver)
2578 {
2579         device_t child;
2580
2581         DEVICE_IDENTIFY(driver, dev);
2582         TAILQ_FOREACH(child, &dev->children, link) {
2583                 if (child->state == DS_NOTPRESENT)
2584                         device_probe_and_attach(child);
2585         }
2586 }
2587
2588 int
2589 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2590     int flags, driver_intr_t *intr, void *arg, void **cookiep,
2591     lwkt_serialize_t serializer, const char *desc)
2592 {
2593         /* Propagate up the bus hierarchy until someone handles it. */
2594         if (dev->parent) {
2595                 return BUS_SETUP_INTR(dev->parent, child, irq, flags,
2596                     intr, arg, cookiep, serializer, desc);
2597         } else {
2598                 return EINVAL;
2599         }
2600 }
2601
2602 int
2603 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2604                           void *cookie)
2605 {
2606         /* Propagate up the bus hierarchy until someone handles it. */
2607         if (dev->parent)
2608                 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2609         else
2610                 return(EINVAL);
2611 }
2612
2613 int
2614 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2615 {
2616         if (dev->parent)
2617                 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2618         else
2619                 return(0);
2620 }
2621
2622 void
2623 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2624 {
2625         if (dev->parent)
2626                 BUS_ENABLE_INTR(dev->parent, child, cookie);
2627 }
2628
2629 int
2630 bus_generic_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
2631     enum intr_polarity pol)
2632 {
2633         /* Propagate up the bus hierarchy until someone handles it. */
2634         if (dev->parent)
2635                 return(BUS_CONFIG_INTR(dev->parent, child, irq, trig, pol));
2636         else
2637                 return(EINVAL);
2638 }
2639
2640 struct resource *
2641 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2642     u_long start, u_long end, u_long count, u_int flags, int cpuid)
2643 {
2644         /* Propagate up the bus hierarchy until someone handles it. */
2645         if (dev->parent)
2646                 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2647                                            start, end, count, flags, cpuid));
2648         else
2649                 return(NULL);
2650 }
2651
2652 int
2653 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2654                              struct resource *r)
2655 {
2656         /* Propagate up the bus hierarchy until someone handles it. */
2657         if (dev->parent)
2658                 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2659         else
2660                 return(EINVAL);
2661 }
2662
2663 int
2664 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2665                               struct resource *r)
2666 {
2667         /* Propagate up the bus hierarchy until someone handles it. */
2668         if (dev->parent)
2669                 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2670         else
2671                 return(EINVAL);
2672 }
2673
2674 int
2675 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2676                                 int rid, struct resource *r)
2677 {
2678         /* Propagate up the bus hierarchy until someone handles it. */
2679         if (dev->parent)
2680                 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2681                                                r));
2682         else
2683                 return(EINVAL);
2684 }
2685
2686 int
2687 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2688                          u_long *startp, u_long *countp)
2689 {
2690         int error;
2691
2692         error = ENOENT;
2693         if (dev->parent) {
2694                 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2695                                          startp, countp);
2696         }
2697         return (error);
2698 }
2699
2700 int
2701 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2702                         u_long start, u_long count, int cpuid)
2703 {
2704         int error;
2705
2706         error = EINVAL;
2707         if (dev->parent) {
2708                 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2709                                          start, count, cpuid);
2710         }
2711         return (error);
2712 }
2713
2714 void
2715 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2716 {
2717         if (dev->parent)
2718                 BUS_DELETE_RESOURCE(dev, child, type, rid);
2719 }
2720
2721 /**
2722  * @brief Helper function for implementing BUS_GET_DMA_TAG().
2723  *
2724  * This simple implementation of BUS_GET_DMA_TAG() simply calls the
2725  * BUS_GET_DMA_TAG() method of the parent of @p dev.
2726  */
2727 bus_dma_tag_t
2728 bus_generic_get_dma_tag(device_t dev, device_t child)
2729 {
2730
2731         /* Propagate up the bus hierarchy until someone handles it. */
2732         if (dev->parent != NULL)
2733                 return (BUS_GET_DMA_TAG(dev->parent, child));
2734         return (NULL);
2735 }
2736
2737 int
2738 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2739     u_long *startp, u_long *countp)
2740 {
2741         struct resource_list *rl = NULL;
2742         struct resource_list_entry *rle = NULL;
2743
2744         rl = BUS_GET_RESOURCE_LIST(dev, child);
2745         if (!rl)
2746                 return(EINVAL);
2747
2748         rle = resource_list_find(rl, type, rid);
2749         if (!rle)
2750                 return(ENOENT);
2751
2752         if (startp)
2753                 *startp = rle->start;
2754         if (countp)
2755                 *countp = rle->count;
2756
2757         return(0);
2758 }
2759
2760 int
2761 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2762     u_long start, u_long count, int cpuid)
2763 {
2764         struct resource_list *rl = NULL;
2765
2766         rl = BUS_GET_RESOURCE_LIST(dev, child);
2767         if (!rl)
2768                 return(EINVAL);
2769
2770         resource_list_add(rl, type, rid, start, (start + count - 1), count,
2771             cpuid);
2772
2773         return(0);
2774 }
2775
2776 void
2777 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2778 {
2779         struct resource_list *rl = NULL;
2780
2781         rl = BUS_GET_RESOURCE_LIST(dev, child);
2782         if (!rl)
2783                 return;
2784
2785         resource_list_delete(rl, type, rid);
2786 }
2787
2788 int
2789 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2790     int rid, struct resource *r)
2791 {
2792         struct resource_list *rl = NULL;
2793
2794         rl = BUS_GET_RESOURCE_LIST(dev, child);
2795         if (!rl)
2796                 return(EINVAL);
2797
2798         return(resource_list_release(rl, dev, child, type, rid, r));
2799 }
2800
2801 struct resource *
2802 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2803     int *rid, u_long start, u_long end, u_long count, u_int flags, int cpuid)
2804 {
2805         struct resource_list *rl = NULL;
2806
2807         rl = BUS_GET_RESOURCE_LIST(dev, child);
2808         if (!rl)
2809                 return(NULL);
2810
2811         return(resource_list_alloc(rl, dev, child, type, rid,
2812             start, end, count, flags, cpuid));
2813 }
2814
2815 int
2816 bus_generic_child_present(device_t bus, device_t child)
2817 {
2818         return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2819 }
2820
2821
2822 /*
2823  * Some convenience functions to make it easier for drivers to use the
2824  * resource-management functions.  All these really do is hide the
2825  * indirection through the parent's method table, making for slightly
2826  * less-wordy code.  In the future, it might make sense for this code
2827  * to maintain some sort of a list of resources allocated by each device.
2828  */
2829 int
2830 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2831     struct resource **res)
2832 {
2833         int i;
2834
2835         for (i = 0; rs[i].type != -1; i++)
2836                 res[i] = NULL;
2837         for (i = 0; rs[i].type != -1; i++) {
2838                 res[i] = bus_alloc_resource_any(dev,
2839                     rs[i].type, &rs[i].rid, rs[i].flags);
2840                 if (res[i] == NULL) {
2841                         bus_release_resources(dev, rs, res);
2842                         return (ENXIO);
2843                 }
2844         }
2845         return (0);
2846 }
2847
2848 void
2849 bus_release_resources(device_t dev, const struct resource_spec *rs,
2850     struct resource **res)
2851 {
2852         int i;
2853
2854         for (i = 0; rs[i].type != -1; i++)
2855                 if (res[i] != NULL) {
2856                         bus_release_resource(
2857                             dev, rs[i].type, rs[i].rid, res[i]);
2858                         res[i] = NULL;
2859                 }
2860 }
2861
2862 struct resource *
2863 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2864                    u_long count, u_int flags)
2865 {
2866         if (dev->parent == NULL)
2867                 return(0);
2868         return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2869                                   count, flags, -1));
2870 }
2871
2872 struct resource *
2873 bus_alloc_legacy_irq_resource(device_t dev, int *rid, u_long irq, u_int flags)
2874 {
2875         if (dev->parent == NULL)
2876                 return(0);
2877         return BUS_ALLOC_RESOURCE(dev->parent, dev, SYS_RES_IRQ, rid,
2878             irq, irq, 1, flags, machintr_legacy_intr_cpuid(irq));
2879 }
2880
2881 int
2882 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2883 {
2884         if (dev->parent == NULL)
2885                 return(EINVAL);
2886         return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2887 }
2888
2889 int
2890 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2891 {
2892         if (dev->parent == NULL)
2893                 return(EINVAL);
2894         return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2895 }
2896
2897 int
2898 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2899 {
2900         if (dev->parent == NULL)
2901                 return(EINVAL);
2902         return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2903 }
2904
2905 int
2906 bus_setup_intr_descr(device_t dev, struct resource *r, int flags,
2907     driver_intr_t handler, void *arg, void **cookiep,
2908     lwkt_serialize_t serializer, const char *desc)
2909 {
2910         if (dev->parent == NULL)
2911                 return EINVAL;
2912         return BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2913             cookiep, serializer, desc);
2914 }
2915
2916 int
2917 bus_setup_intr(device_t dev, struct resource *r, int flags,
2918     driver_intr_t handler, void *arg, void **cookiep,
2919     lwkt_serialize_t serializer)
2920 {
2921         return bus_setup_intr_descr(dev, r, flags, handler, arg, cookiep,
2922             serializer, NULL);
2923 }
2924
2925 int
2926 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2927 {
2928         if (dev->parent == NULL)
2929                 return(EINVAL);
2930         return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2931 }
2932
2933 void
2934 bus_enable_intr(device_t dev, void *cookie)
2935 {
2936         if (dev->parent)
2937                 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2938 }
2939
2940 int
2941 bus_disable_intr(device_t dev, void *cookie)
2942 {
2943         if (dev->parent)
2944                 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2945         else
2946                 return(0);
2947 }
2948
2949 int
2950 bus_set_resource(device_t dev, int type, int rid,
2951                  u_long start, u_long count, int cpuid)
2952 {
2953         return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2954                                 start, count, cpuid));
2955 }
2956
2957 int
2958 bus_get_resource(device_t dev, int type, int rid,
2959                  u_long *startp, u_long *countp)
2960 {
2961         return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2962                                 startp, countp));
2963 }
2964
2965 u_long
2966 bus_get_resource_start(device_t dev, int type, int rid)
2967 {
2968         u_long start, count;
2969         int error;
2970
2971         error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2972                                  &start, &count);
2973         if (error)
2974                 return(0);
2975         return(start);
2976 }
2977
2978 u_long
2979 bus_get_resource_count(device_t dev, int type, int rid)
2980 {
2981         u_long start, count;
2982         int error;
2983
2984         error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2985                                  &start, &count);
2986         if (error)
2987                 return(0);
2988         return(count);
2989 }
2990
2991 void
2992 bus_delete_resource(device_t dev, int type, int rid)
2993 {
2994         BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2995 }
2996
2997 int
2998 bus_child_present(device_t child)
2999 {
3000         return (BUS_CHILD_PRESENT(device_get_parent(child), child));
3001 }
3002
3003 int
3004 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
3005 {
3006         device_t parent;
3007
3008         parent = device_get_parent(child);
3009         if (parent == NULL) {
3010                 *buf = '\0';
3011                 return (0);
3012         }
3013         return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
3014 }
3015
3016 int
3017 bus_child_location_str(device_t child, char *buf, size_t buflen)
3018 {
3019         device_t parent;
3020
3021         parent = device_get_parent(child);
3022         if (parent == NULL) {
3023                 *buf = '\0';
3024                 return (0);
3025         }
3026         return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
3027 }
3028
3029 /**
3030  * @brief Wrapper function for BUS_GET_DMA_TAG().
3031  *
3032  * This function simply calls the BUS_GET_DMA_TAG() method of the
3033  * parent of @p dev.
3034  */
3035 bus_dma_tag_t
3036 bus_get_dma_tag(device_t dev)
3037 {
3038         device_t parent;
3039
3040         parent = device_get_parent(dev);
3041         if (parent == NULL)
3042                 return (NULL);
3043         return (BUS_GET_DMA_TAG(parent, dev));
3044 }
3045
3046 static int
3047 root_print_child(device_t dev, device_t child)
3048 {
3049         return(0);
3050 }
3051
3052 static int
3053 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
3054                 void **cookiep, lwkt_serialize_t serializer, const char *desc)
3055 {
3056         /*
3057          * If an interrupt mapping gets to here something bad has happened.
3058          */
3059         panic("root_setup_intr");
3060 }
3061
3062 /*
3063  * If we get here, assume that the device is permanant and really is
3064  * present in the system.  Removable bus drivers are expected to intercept
3065  * this call long before it gets here.  We return -1 so that drivers that
3066  * really care can check vs -1 or some ERRNO returned higher in the food
3067  * chain.
3068  */
3069 static int
3070 root_child_present(device_t dev, device_t child)
3071 {
3072         return(-1);
3073 }
3074
3075 /*
3076  * XXX NOTE! other defaults may be set in bus_if.m
3077  */
3078 static kobj_method_t root_methods[] = {
3079         /* Device interface */
3080         KOBJMETHOD(device_shutdown,     bus_generic_shutdown),
3081         KOBJMETHOD(device_suspend,      bus_generic_suspend),
3082         KOBJMETHOD(device_resume,       bus_generic_resume),
3083
3084         /* Bus interface */
3085         KOBJMETHOD(bus_add_child,       bus_generic_add_child),
3086         KOBJMETHOD(bus_print_child,     root_print_child),
3087         KOBJMETHOD(bus_read_ivar,       bus_generic_read_ivar),
3088         KOBJMETHOD(bus_write_ivar,      bus_generic_write_ivar),
3089         KOBJMETHOD(bus_setup_intr,      root_setup_intr),
3090         KOBJMETHOD(bus_child_present,   root_child_present),
3091
3092         KOBJMETHOD_END
3093 };
3094
3095 static driver_t root_driver = {
3096         "root",
3097         root_methods,
3098         1,                      /* no softc */
3099 };
3100
3101 device_t        root_bus;
3102 devclass_t      root_devclass;
3103
3104 static int
3105 root_bus_module_handler(module_t mod, int what, void* arg)
3106 {
3107         switch (what) {
3108         case MOD_LOAD:
3109                 TAILQ_INIT(&bus_data_devices);
3110                 root_bus = make_device(NULL, "root", 0);
3111                 root_bus->desc = "System root bus";
3112                 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
3113                 root_bus->driver = &root_driver;
3114                 root_bus->state = DS_ALIVE;
3115                 root_devclass = devclass_find_internal("root", NULL, FALSE);
3116                 devinit();
3117                 return(0);
3118
3119         case MOD_SHUTDOWN:
3120                 device_shutdown(root_bus);
3121                 return(0);
3122         default:
3123                 return(0);
3124         }
3125 }
3126
3127 static moduledata_t root_bus_mod = {
3128         "rootbus",
3129         root_bus_module_handler,
3130         0
3131 };
3132 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
3133
3134 void
3135 root_bus_configure(void)
3136 {
3137         int warncount;
3138         device_t dev;
3139
3140         PDEBUG(("."));
3141
3142         /*
3143          * handle device_identify based device attachments to the root_bus
3144          * (typically nexus).
3145          */
3146         bus_generic_probe(root_bus);
3147
3148         /*
3149          * Probe and attach the devices under root_bus.
3150          */
3151         TAILQ_FOREACH(dev, &root_bus->children, link) {
3152                 device_probe_and_attach(dev);
3153         }
3154
3155         /*
3156          * Wait for all asynchronous attaches to complete.  If we don't
3157          * our legacy ISA bus scan could steal device unit numbers or
3158          * even I/O ports.
3159          */
3160         warncount = 10;
3161         if (numasyncthreads)
3162                 kprintf("Waiting for async drivers to attach\n");
3163         while (numasyncthreads > 0) {
3164                 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3165                         --warncount;
3166                 if (warncount == 0) {
3167                         kprintf("Warning: Still waiting for %d "
3168                                 "drivers to attach\n", numasyncthreads);
3169                 } else if (warncount == -30) {
3170                         kprintf("Giving up on %d drivers\n", numasyncthreads);
3171                         break;
3172                 }
3173         }
3174         root_bus->state = DS_ATTACHED;
3175 }
3176
3177 int
3178 driver_module_handler(module_t mod, int what, void *arg)
3179 {
3180         int error;
3181         struct driver_module_data *dmd;
3182         devclass_t bus_devclass;
3183         kobj_class_t driver;
3184         const char *parentname;
3185
3186         dmd = (struct driver_module_data *)arg;
3187         bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3188         error = 0;
3189
3190         switch (what) {
3191         case MOD_LOAD:
3192                 if (dmd->dmd_chainevh)
3193                         error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3194
3195                 driver = dmd->dmd_driver;
3196                 PDEBUG(("Loading module: driver %s on bus %s",
3197                         DRIVERNAME(driver), dmd->dmd_busname));
3198
3199                 /*
3200                  * If the driver has any base classes, make the
3201                  * devclass inherit from the devclass of the driver's
3202                  * first base class. This will allow the system to
3203                  * search for drivers in both devclasses for children
3204                  * of a device using this driver.
3205                  */
3206                 if (driver->baseclasses)
3207                         parentname = driver->baseclasses[0]->name;
3208                 else
3209                         parentname = NULL;
3210                 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3211                                                             parentname, TRUE);
3212
3213                 error = devclass_add_driver(bus_devclass, driver);
3214                 if (error)
3215                         break;
3216                 break;
3217
3218         case MOD_UNLOAD:
3219                 PDEBUG(("Unloading module: driver %s from bus %s",
3220                         DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3221                 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3222
3223                 if (!error && dmd->dmd_chainevh)
3224                         error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3225                 break;
3226         }
3227
3228         return (error);
3229 }
3230
3231 #ifdef BUS_DEBUG
3232
3233 /*
3234  * The _short versions avoid iteration by not calling anything that prints
3235  * more than oneliners. I love oneliners.
3236  */
3237
3238 static void
3239 print_device_short(device_t dev, int indent)
3240 {
3241         if (!dev)
3242                 return;
3243
3244         indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3245                       dev->unit, dev->desc,
3246                       (dev->parent? "":"no "),
3247                       (TAILQ_EMPTY(&dev->children)? "no ":""),
3248                       (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3249                       (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3250                       (dev->flags&DF_WILDCARD? "wildcard,":""),
3251                       (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3252                       (dev->ivars? "":"no "),
3253                       (dev->softc? "":"no "),
3254                       dev->busy));
3255 }
3256
3257 static void
3258 print_device(device_t dev, int indent)
3259 {
3260         if (!dev)
3261                 return;
3262
3263         print_device_short(dev, indent);
3264
3265         indentprintf(("Parent:\n"));
3266         print_device_short(dev->parent, indent+1);
3267         indentprintf(("Driver:\n"));
3268         print_driver_short(dev->driver, indent+1);
3269         indentprintf(("Devclass:\n"));
3270         print_devclass_short(dev->devclass, indent+1);
3271 }
3272
3273 /*
3274  * Print the device and all its children (indented).
3275  */
3276 void
3277 print_device_tree_short(device_t dev, int indent)
3278 {
3279         device_t child;
3280
3281         if (!dev)
3282                 return;
3283
3284         print_device_short(dev, indent);
3285
3286         TAILQ_FOREACH(child, &dev->children, link)
3287                 print_device_tree_short(child, indent+1);
3288 }
3289
3290 /*
3291  * Print the device and all its children (indented).
3292  */
3293 void
3294 print_device_tree(device_t dev, int indent)
3295 {
3296         device_t child;
3297
3298         if (!dev)
3299                 return;
3300
3301         print_device(dev, indent);
3302
3303         TAILQ_FOREACH(child, &dev->children, link)
3304                 print_device_tree(child, indent+1);
3305 }
3306
3307 static void
3308 print_driver_short(driver_t *driver, int indent)
3309 {
3310         if (!driver)
3311                 return;
3312
3313         indentprintf(("driver %s: softc size = %zu\n",
3314                       driver->name, driver->size));
3315 }
3316
3317 static void
3318 print_driver(driver_t *driver, int indent)
3319 {
3320         if (!driver)
3321                 return;
3322
3323         print_driver_short(driver, indent);
3324 }
3325
3326
3327 static void
3328 print_driver_list(driver_list_t drivers, int indent)
3329 {
3330         driverlink_t driver;
3331
3332         TAILQ_FOREACH(driver, &drivers, link)
3333                 print_driver(driver->driver, indent);
3334 }
3335
3336 static void
3337 print_devclass_short(devclass_t dc, int indent)
3338 {
3339         if (!dc)
3340                 return;
3341
3342         indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3343 }
3344
3345 static void
3346 print_devclass(devclass_t dc, int indent)
3347 {
3348         int i;
3349
3350         if (!dc)
3351                 return;
3352
3353         print_devclass_short(dc, indent);
3354         indentprintf(("Drivers:\n"));
3355         print_driver_list(dc->drivers, indent+1);
3356
3357         indentprintf(("Devices:\n"));
3358         for (i = 0; i < dc->maxunit; i++)
3359                 if (dc->devices[i])
3360                         print_device(dc->devices[i], indent+1);
3361 }
3362
3363 void
3364 print_devclass_list_short(void)
3365 {
3366         devclass_t dc;
3367
3368         kprintf("Short listing of devclasses, drivers & devices:\n");
3369         TAILQ_FOREACH(dc, &devclasses, link) {
3370                 print_devclass_short(dc, 0);
3371         }
3372 }
3373
3374 void
3375 print_devclass_list(void)
3376 {
3377         devclass_t dc;
3378
3379         kprintf("Full listing of devclasses, drivers & devices:\n");
3380         TAILQ_FOREACH(dc, &devclasses, link) {
3381                 print_devclass(dc, 0);
3382         }
3383 }
3384
3385 #endif
3386
3387 /*
3388  * Check to see if a device is disabled via a disabled hint.
3389  */
3390 int
3391 resource_disabled(const char *name, int unit)
3392 {
3393         int error, value;
3394
3395         error = resource_int_value(name, unit, "disabled", &value);
3396         if (error)
3397                return(0);
3398         return(value);
3399 }
3400
3401 /*
3402  * User-space access to the device tree.
3403  *
3404  * We implement a small set of nodes:
3405  *
3406  * hw.bus                       Single integer read method to obtain the
3407  *                              current generation count.
3408  * hw.bus.devices               Reads the entire device tree in flat space.
3409  * hw.bus.rman                  Resource manager interface
3410  *
3411  * We might like to add the ability to scan devclasses and/or drivers to
3412  * determine what else is currently loaded/available.
3413  */
3414
3415 static int
3416 sysctl_bus(SYSCTL_HANDLER_ARGS)
3417 {
3418         struct u_businfo        ubus;
3419
3420         ubus.ub_version = BUS_USER_VERSION;
3421         ubus.ub_generation = bus_data_generation;
3422
3423         return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3424 }
3425 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3426     "bus-related data");
3427
3428 static int
3429 sysctl_devices(SYSCTL_HANDLER_ARGS)
3430 {
3431         int                     *name = (int *)arg1;
3432         u_int                   namelen = arg2;
3433         int                     index;
3434         struct device           *dev;
3435         struct u_device         udev;   /* XXX this is a bit big */
3436         int                     error;
3437
3438         if (namelen != 2)
3439                 return (EINVAL);
3440
3441         if (bus_data_generation_check(name[0]))
3442                 return (EINVAL);
3443
3444         index = name[1];
3445
3446         /*
3447          * Scan the list of devices, looking for the requested index.
3448          */
3449         TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3450                 if (index-- == 0)
3451                         break;
3452         }
3453         if (dev == NULL)
3454                 return (ENOENT);
3455
3456         /*
3457          * Populate the return array.
3458          */
3459         bzero(&udev, sizeof(udev));
3460         udev.dv_handle = (uintptr_t)dev;
3461         udev.dv_parent = (uintptr_t)dev->parent;
3462         if (dev->nameunit != NULL)
3463                 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3464         if (dev->desc != NULL)
3465                 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3466         if (dev->driver != NULL && dev->driver->name != NULL)
3467                 strlcpy(udev.dv_drivername, dev->driver->name,
3468                     sizeof(udev.dv_drivername));
3469         bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3470         bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3471         udev.dv_devflags = dev->devflags;
3472         udev.dv_flags = dev->flags;
3473         udev.dv_state = dev->state;
3474         error = SYSCTL_OUT(req, &udev, sizeof(udev));
3475         return (error);
3476 }
3477
3478 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3479     "system device tree");
3480
3481 int
3482 bus_data_generation_check(int generation)
3483 {
3484         if (generation != bus_data_generation)
3485                 return (1);
3486
3487         /* XXX generate optimised lists here? */
3488         return (0);
3489 }
3490
3491 void
3492 bus_data_generation_update(void)
3493 {
3494         bus_data_generation++;
3495 }
3496
3497 const char *
3498 intr_str_polarity(enum intr_polarity pola)
3499 {
3500         switch (pola) {
3501         case INTR_POLARITY_LOW:
3502                 return "low";
3503
3504         case INTR_POLARITY_HIGH:
3505                 return "high";
3506
3507         case INTR_POLARITY_CONFORM:
3508                 return "conform";
3509         }
3510         return "unknown";
3511 }
3512
3513 const char *
3514 intr_str_trigger(enum intr_trigger trig)
3515 {
3516         switch (trig) {
3517         case INTR_TRIGGER_EDGE:
3518                 return "edge";
3519
3520         case INTR_TRIGGER_LEVEL:
3521                 return "level";
3522
3523         case INTR_TRIGGER_CONFORM:
3524                 return "conform";
3525         }
3526         return "unknown";
3527 }
3528
3529 int
3530 device_getenv_int(device_t dev, const char *knob, int def)
3531 {
3532         char env[128];
3533
3534         ksnprintf(env, sizeof(env), "hw.%s.%s", device_get_nameunit(dev), knob);
3535         kgetenv_int(env, &def);
3536         return def;
3537 }