2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
77 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
81 * Used to attach drivers to devclasses.
83 typedef struct driverlink *driverlink_t;
86 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
89 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
90 TAILQ_ENTRY(driverlink) passlink;
94 * Forward declarations
96 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
97 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
98 typedef TAILQ_HEAD(device_list, _device) device_list_t;
101 TAILQ_ENTRY(devclass) link;
102 devclass_t parent; /* parent in devclass hierarchy */
103 driver_list_t drivers; /* bus devclasses store drivers for bus */
105 device_t *devices; /* array of devices indexed by unit */
106 int maxunit; /* size of devices array */
108 #define DC_HAS_CHILDREN 1
110 struct sysctl_ctx_list sysctl_ctx;
111 struct sysctl_oid *sysctl_tree;
115 * @brief Implementation of _device.
117 * The structure is named "_device" instead of "device" to avoid type confusion
118 * caused by other subsystems defining a (struct device).
122 * A device is a kernel object. The first field must be the
123 * current ops table for the object.
130 TAILQ_ENTRY(_device) link; /**< list of devices in parent */
131 TAILQ_ENTRY(_device) devlink; /**< global device list membership */
132 device_t parent; /**< parent of this device */
133 device_list_t children; /**< list of child devices */
136 * Details of this device.
138 driver_t *driver; /**< current driver */
139 devclass_t devclass; /**< current device class */
140 int unit; /**< current unit number */
141 char* nameunit; /**< name+unit e.g. foodev0 */
142 char* desc; /**< driver specific description */
143 int busy; /**< count of calls to device_busy() */
144 device_state_t state; /**< current device state */
145 uint32_t devflags; /**< api level flags for device_get_flags() */
146 u_int flags; /**< internal device flags */
147 u_int order; /**< order from device_add_child_ordered() */
148 void *ivars; /**< instance variables */
149 void *softc; /**< current driver's variables */
151 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
152 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
155 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
156 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
158 EVENTHANDLER_LIST_DEFINE(device_attach);
159 EVENTHANDLER_LIST_DEFINE(device_detach);
160 EVENTHANDLER_LIST_DEFINE(dev_lookup);
162 static void devctl2_init(void);
163 static bool device_frozen;
165 #define DRIVERNAME(d) ((d)? d->name : "no driver")
166 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
170 static int bus_debug = 1;
171 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
173 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
174 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
177 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
178 * prevent syslog from deleting initial spaces
180 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
182 static void print_device_short(device_t dev, int indent);
183 static void print_device(device_t dev, int indent);
184 void print_device_tree_short(device_t dev, int indent);
185 void print_device_tree(device_t dev, int indent);
186 static void print_driver_short(driver_t *driver, int indent);
187 static void print_driver(driver_t *driver, int indent);
188 static void print_driver_list(driver_list_t drivers, int indent);
189 static void print_devclass_short(devclass_t dc, int indent);
190 static void print_devclass(devclass_t dc, int indent);
191 void print_devclass_list_short(void);
192 void print_devclass_list(void);
195 /* Make the compiler ignore the function calls */
196 #define PDEBUG(a) /* nop */
197 #define DEVICENAME(d) /* nop */
199 #define print_device_short(d,i) /* nop */
200 #define print_device(d,i) /* nop */
201 #define print_device_tree_short(d,i) /* nop */
202 #define print_device_tree(d,i) /* nop */
203 #define print_driver_short(d,i) /* nop */
204 #define print_driver(d,i) /* nop */
205 #define print_driver_list(d,i) /* nop */
206 #define print_devclass_short(d,i) /* nop */
207 #define print_devclass(d,i) /* nop */
208 #define print_devclass_list_short() /* nop */
209 #define print_devclass_list() /* nop */
217 DEVCLASS_SYSCTL_PARENT,
221 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
223 devclass_t dc = (devclass_t)arg1;
227 case DEVCLASS_SYSCTL_PARENT:
228 value = dc->parent ? dc->parent->name : "";
233 return (SYSCTL_OUT_STR(req, value));
237 devclass_sysctl_init(devclass_t dc)
239 if (dc->sysctl_tree != NULL)
241 sysctl_ctx_init(&dc->sysctl_ctx);
242 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
243 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
244 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
245 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
247 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
248 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
254 DEVICE_SYSCTL_DRIVER,
255 DEVICE_SYSCTL_LOCATION,
256 DEVICE_SYSCTL_PNPINFO,
257 DEVICE_SYSCTL_PARENT,
261 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
264 device_t dev = (device_t)arg1;
267 sbuf_new_for_sysctl(&sb, NULL, 1024, req);
268 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
270 case DEVICE_SYSCTL_DESC:
271 sbuf_cat(&sb, dev->desc ? dev->desc : "");
273 case DEVICE_SYSCTL_DRIVER:
274 sbuf_cat(&sb, dev->driver ? dev->driver->name : "");
276 case DEVICE_SYSCTL_LOCATION:
277 bus_child_location(dev, &sb);
279 case DEVICE_SYSCTL_PNPINFO:
280 bus_child_pnpinfo(dev, &sb);
282 case DEVICE_SYSCTL_PARENT:
283 sbuf_cat(&sb, dev->parent ? dev->parent->nameunit : "");
289 error = sbuf_finish(&sb);
295 device_sysctl_init(device_t dev)
297 devclass_t dc = dev->devclass;
300 if (dev->sysctl_tree != NULL)
302 devclass_sysctl_init(dc);
303 sysctl_ctx_init(&dev->sysctl_ctx);
304 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
305 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
306 dev->nameunit + strlen(dc->name),
307 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
308 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
309 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
310 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
311 "device description");
312 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
314 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
315 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
316 "device driver name");
317 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 OID_AUTO, "%location",
319 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
320 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
321 "device location relative to parent");
322 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
323 OID_AUTO, "%pnpinfo",
324 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
325 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
326 "device identification");
327 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
329 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
330 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
332 if (bus_get_domain(dev, &domain) == 0)
333 SYSCTL_ADD_INT(&dev->sysctl_ctx,
334 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
335 CTLFLAG_RD, NULL, domain, "NUMA domain");
339 device_sysctl_update(device_t dev)
341 devclass_t dc = dev->devclass;
343 if (dev->sysctl_tree == NULL)
345 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
349 device_sysctl_fini(device_t dev)
351 if (dev->sysctl_tree == NULL)
353 sysctl_ctx_free(&dev->sysctl_ctx);
354 dev->sysctl_tree = NULL;
358 * /dev/devctl implementation
362 * This design allows only one reader for /dev/devctl. This is not desirable
363 * in the long run, but will get a lot of hair out of this implementation.
364 * Maybe we should make this device a clonable device.
366 * Also note: we specifically do not attach a device to the device_t tree
367 * to avoid potential chicken and egg problems. One could argue that all
368 * of this belongs to the root node.
371 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
372 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
373 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
374 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
375 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
377 static d_open_t devopen;
378 static d_close_t devclose;
379 static d_read_t devread;
380 static d_ioctl_t devioctl;
381 static d_poll_t devpoll;
382 static d_kqfilter_t devkqfilter;
384 static struct cdevsw dev_cdevsw = {
385 .d_version = D_VERSION,
391 .d_kqfilter = devkqfilter,
395 #define DEVCTL_BUFFER (1024 - sizeof(void *))
396 struct dev_event_info {
397 STAILQ_ENTRY(dev_event_info) dei_link;
398 char dei_data[DEVCTL_BUFFER];
401 STAILQ_HEAD(devq, dev_event_info);
403 static struct dev_softc {
416 static void filt_devctl_detach(struct knote *kn);
417 static int filt_devctl_read(struct knote *kn, long hint);
419 struct filterops devctl_rfiltops = {
421 .f_detach = filt_devctl_detach,
422 .f_event = filt_devctl_read,
425 static struct cdev *devctl_dev;
433 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
434 UID_ROOT, GID_WHEEL, 0600, "devctl");
435 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
436 cv_init(&devsoftc.cv, "dev cv");
437 STAILQ_INIT(&devsoftc.devq);
438 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
439 if (devctl_queue_length > 0) {
441 * Allocate a zone for the messages. Preallocate 2% of these for
442 * a reserve. Allow only devctl_queue_length slabs to cap memory
443 * usage. The reserve usually allows coverage of surges of
444 * events during memory shortages. Normally we won't have to
445 * re-use events from the queue, but will in extreme shortages.
447 z = devsoftc.zone = uma_zcreate("DEVCTL",
448 sizeof(struct dev_event_info), NULL, NULL, NULL, NULL,
450 reserve = max(devctl_queue_length / 50, 100); /* 2% reserve */
451 uma_zone_set_max(z, devctl_queue_length);
452 uma_zone_set_maxcache(z, 0);
453 uma_zone_reserve(z, reserve);
454 uma_prealloc(z, reserve);
460 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
462 mtx_lock(&devsoftc.mtx);
463 if (devsoftc.inuse) {
464 mtx_unlock(&devsoftc.mtx);
469 mtx_unlock(&devsoftc.mtx);
474 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
476 mtx_lock(&devsoftc.mtx);
478 devsoftc.nonblock = 0;
480 cv_broadcast(&devsoftc.cv);
481 funsetown(&devsoftc.sigio);
482 mtx_unlock(&devsoftc.mtx);
487 * The read channel for this device is used to report changes to
488 * userland in realtime. We are required to free the data as well as
489 * the n1 object because we allocate them separately. Also note that
490 * we return one record at a time. If you try to read this device a
491 * character at a time, you will lose the rest of the data. Listening
492 * programs are expected to cope.
495 devread(struct cdev *dev, struct uio *uio, int ioflag)
497 struct dev_event_info *n1;
500 mtx_lock(&devsoftc.mtx);
501 while (STAILQ_EMPTY(&devsoftc.devq)) {
502 if (devsoftc.nonblock) {
503 mtx_unlock(&devsoftc.mtx);
506 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
509 * Need to translate ERESTART to EINTR here? -- jake
511 mtx_unlock(&devsoftc.mtx);
515 n1 = STAILQ_FIRST(&devsoftc.devq);
516 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
518 mtx_unlock(&devsoftc.mtx);
519 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
520 uma_zfree(devsoftc.zone, n1);
525 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
530 devsoftc.nonblock = 1;
532 devsoftc.nonblock = 0;
541 return fsetown(*(int *)data, &devsoftc.sigio);
543 *(int *)data = fgetown(&devsoftc.sigio);
546 /* (un)Support for other fcntl() calls. */
557 devpoll(struct cdev *dev, int events, struct thread *td)
561 mtx_lock(&devsoftc.mtx);
562 if (events & (POLLIN | POLLRDNORM)) {
563 if (!STAILQ_EMPTY(&devsoftc.devq))
564 revents = events & (POLLIN | POLLRDNORM);
566 selrecord(td, &devsoftc.sel);
568 mtx_unlock(&devsoftc.mtx);
574 devkqfilter(struct cdev *dev, struct knote *kn)
578 if (kn->kn_filter == EVFILT_READ) {
579 kn->kn_fop = &devctl_rfiltops;
580 knlist_add(&devsoftc.sel.si_note, kn, 0);
588 filt_devctl_detach(struct knote *kn)
590 knlist_remove(&devsoftc.sel.si_note, kn, 0);
594 filt_devctl_read(struct knote *kn, long hint)
596 kn->kn_data = devsoftc.queued;
597 return (kn->kn_data != 0);
601 * @brief Return whether the userland process is running
604 devctl_process_running(void)
606 return (devsoftc.inuse == 1);
609 static struct dev_event_info *
610 devctl_alloc_dei(void)
612 struct dev_event_info *dei = NULL;
614 mtx_lock(&devsoftc.mtx);
615 if (devctl_queue_length == 0)
617 dei = uma_zalloc(devsoftc.zone, M_NOWAIT);
619 dei = uma_zalloc(devsoftc.zone, M_NOWAIT | M_USE_RESERVE);
622 * Guard against no items in the queue. Normally, this won't
623 * happen, but if lots of events happen all at once and there's
624 * a chance we're out of allocated space but none have yet been
625 * queued when we get here, leaving nothing to steal. This can
626 * also happen with error injection. Fail safe by returning
627 * NULL in that case..
629 if (devsoftc.queued == 0)
631 dei = STAILQ_FIRST(&devsoftc.devq);
632 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
636 *dei->dei_data = '\0';
638 mtx_unlock(&devsoftc.mtx);
642 static struct dev_event_info *
643 devctl_alloc_dei_sb(struct sbuf *sb)
645 struct dev_event_info *dei;
647 dei = devctl_alloc_dei();
649 sbuf_new(sb, dei->dei_data, sizeof(dei->dei_data), SBUF_FIXEDLEN);
654 devctl_free_dei(struct dev_event_info *dei)
656 uma_zfree(devsoftc.zone, dei);
660 devctl_queue(struct dev_event_info *dei)
662 mtx_lock(&devsoftc.mtx);
663 STAILQ_INSERT_TAIL(&devsoftc.devq, dei, dei_link);
665 cv_broadcast(&devsoftc.cv);
666 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
667 mtx_unlock(&devsoftc.mtx);
668 selwakeup(&devsoftc.sel);
669 if (devsoftc.async && devsoftc.sigio != NULL)
670 pgsigio(&devsoftc.sigio, SIGIO, 0);
674 * @brief Send a 'notification' to userland, using standard ways
677 devctl_notify(const char *system, const char *subsystem, const char *type,
680 struct dev_event_info *dei;
683 if (system == NULL || subsystem == NULL || type == NULL)
685 dei = devctl_alloc_dei_sb(&sb);
688 sbuf_cpy(&sb, "!system=");
689 sbuf_cat(&sb, system);
690 sbuf_cat(&sb, " subsystem=");
691 sbuf_cat(&sb, subsystem);
692 sbuf_cat(&sb, " type=");
698 sbuf_putc(&sb, '\n');
699 if (sbuf_finish(&sb) != 0)
700 devctl_free_dei(dei); /* overflow -> drop it */
706 * Common routine that tries to make sending messages as easy as possible.
707 * We allocate memory for the data, copy strings into that, but do not
708 * free it unless there's an error. The dequeue part of the driver should
709 * free the data. We don't send data when the device is disabled. We do
710 * send data, even when we have no listeners, because we wish to avoid
711 * races relating to startup and restart of listening applications.
713 * devaddq is designed to string together the type of event, with the
714 * object of that event, plus the plug and play info and location info
715 * for that event. This is likely most useful for devices, but less
716 * useful for other consumers of this interface. Those should use
717 * the devctl_notify() interface instead.
720 * ${type}${what} at $(location dev) $(pnp-info dev) on $(parent dev)
723 devaddq(const char *type, const char *what, device_t dev)
725 struct dev_event_info *dei;
729 dei = devctl_alloc_dei_sb(&sb);
734 sbuf_cat(&sb, " at ");
736 /* Add in the location */
737 bus_child_location(dev, &sb);
741 bus_child_pnpinfo(dev, &sb);
743 /* Get the parent of this device, or / if high enough in the tree. */
744 if (device_get_parent(dev) == NULL)
745 parstr = "."; /* Or '/' ? */
747 parstr = device_get_nameunit(device_get_parent(dev));
748 sbuf_cat(&sb, " on ");
749 sbuf_cat(&sb, parstr);
750 sbuf_putc(&sb, '\n');
751 if (sbuf_finish(&sb) != 0)
756 devctl_free_dei(dei);
760 * A device was added to the tree. We are called just after it successfully
761 * attaches (that is, probe and attach success for this device). No call
762 * is made if a device is merely parented into the tree. See devnomatch
763 * if probe fails. If attach fails, no notification is sent (but maybe
764 * we should have a different message for this).
767 devadded(device_t dev)
769 devaddq("+", device_get_nameunit(dev), dev);
773 * A device was removed from the tree. We are called just before this
777 devremoved(device_t dev)
779 devaddq("-", device_get_nameunit(dev), dev);
783 * Called when there's no match for this device. This is only called
784 * the first time that no match happens, so we don't keep getting this
785 * message. Should that prove to be undesirable, we can change it.
786 * This is called when all drivers that can attach to a given bus
787 * decline to accept this device. Other errors may not be detected.
790 devnomatch(device_t dev)
792 devaddq("?", "", dev);
796 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
800 q = devctl_queue_length;
801 error = sysctl_handle_int(oidp, &q, 0, req);
802 if (error || !req->newptr)
808 * When set as a tunable, we've not yet initialized the mutex.
809 * It is safe to just assign to devctl_queue_length and return
810 * as we're racing no one. We'll use whatever value set in
813 if (!mtx_initialized(&devsoftc.mtx)) {
814 devctl_queue_length = q;
819 * XXX It's hard to grow or shrink the UMA zone. Only allow
820 * disabling the queue size for the moment until underlying
821 * UMA issues can be sorted out.
825 if (q == devctl_queue_length)
827 mtx_lock(&devsoftc.mtx);
828 devctl_queue_length = 0;
829 uma_zdestroy(devsoftc.zone);
831 mtx_unlock(&devsoftc.mtx);
836 * @brief safely quotes strings that might have double quotes in them.
838 * The devctl protocol relies on quoted strings having matching quotes.
839 * This routine quotes any internal quotes so the resulting string
840 * is safe to pass to snprintf to construct, for example pnp info strings.
842 * @param sb sbuf to place the characters into
843 * @param src Original buffer.
846 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
848 while (*src != '\0') {
849 if (*src == '"' || *src == '\\')
851 sbuf_putc(sb, *src++);
855 /* End of /dev/devctl code */
857 static struct device_list bus_data_devices;
858 static int bus_data_generation = 1;
860 static kobj_method_t null_methods[] = {
864 DEFINE_CLASS(null, null_methods, 0);
867 * Bus pass implementation
870 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
871 int bus_current_pass = BUS_PASS_ROOT;
875 * @brief Register the pass level of a new driver attachment
877 * Register a new driver attachment's pass level. If no driver
878 * attachment with the same pass level has been added, then @p new
879 * will be added to the global passes list.
881 * @param new the new driver attachment
884 driver_register_pass(struct driverlink *new)
886 struct driverlink *dl;
888 /* We only consider pass numbers during boot. */
889 if (bus_current_pass == BUS_PASS_DEFAULT)
893 * Walk the passes list. If we already know about this pass
894 * then there is nothing to do. If we don't, then insert this
895 * driver link into the list.
897 TAILQ_FOREACH(dl, &passes, passlink) {
898 if (dl->pass < new->pass)
900 if (dl->pass == new->pass)
902 TAILQ_INSERT_BEFORE(dl, new, passlink);
905 TAILQ_INSERT_TAIL(&passes, new, passlink);
909 * @brief Raise the current bus pass
911 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
912 * method on the root bus to kick off a new device tree scan for each
913 * new pass level that has at least one driver.
916 bus_set_pass(int pass)
918 struct driverlink *dl;
920 if (bus_current_pass > pass)
921 panic("Attempt to lower bus pass level");
923 TAILQ_FOREACH(dl, &passes, passlink) {
924 /* Skip pass values below the current pass level. */
925 if (dl->pass <= bus_current_pass)
929 * Bail once we hit a driver with a pass level that is
936 * Raise the pass level to the next level and rescan
939 bus_current_pass = dl->pass;
940 BUS_NEW_PASS(root_bus);
944 * If there isn't a driver registered for the requested pass,
945 * then bus_current_pass might still be less than 'pass'. Set
946 * it to 'pass' in that case.
948 if (bus_current_pass < pass)
949 bus_current_pass = pass;
950 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
954 * Devclass implementation
957 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
961 * @brief Find or create a device class
963 * If a device class with the name @p classname exists, return it,
964 * otherwise if @p create is non-zero create and return a new device
967 * If @p parentname is non-NULL, the parent of the devclass is set to
968 * the devclass of that name.
970 * @param classname the devclass name to find or create
971 * @param parentname the parent devclass name or @c NULL
972 * @param create non-zero to create a devclass
975 devclass_find_internal(const char *classname, const char *parentname,
980 PDEBUG(("looking for %s", classname));
984 TAILQ_FOREACH(dc, &devclasses, link) {
985 if (!strcmp(dc->name, classname))
990 PDEBUG(("creating %s", classname));
991 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
992 M_BUS, M_NOWAIT | M_ZERO);
996 dc->name = (char*) (dc + 1);
997 strcpy(dc->name, classname);
998 TAILQ_INIT(&dc->drivers);
999 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1001 bus_data_generation_update();
1005 * If a parent class is specified, then set that as our parent so
1006 * that this devclass will support drivers for the parent class as
1007 * well. If the parent class has the same name don't do this though
1008 * as it creates a cycle that can trigger an infinite loop in
1009 * device_probe_child() if a device exists for which there is no
1012 if (parentname && dc && !dc->parent &&
1013 strcmp(classname, parentname) != 0) {
1014 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1015 dc->parent->flags |= DC_HAS_CHILDREN;
1022 * @brief Create a device class
1024 * If a device class with the name @p classname exists, return it,
1025 * otherwise create and return a new device class.
1027 * @param classname the devclass name to find or create
1030 devclass_create(const char *classname)
1032 return (devclass_find_internal(classname, NULL, TRUE));
1036 * @brief Find a device class
1038 * If a device class with the name @p classname exists, return it,
1039 * otherwise return @c NULL.
1041 * @param classname the devclass name to find
1044 devclass_find(const char *classname)
1046 return (devclass_find_internal(classname, NULL, FALSE));
1050 * @brief Register that a device driver has been added to a devclass
1052 * Register that a device driver has been added to a devclass. This
1053 * is called by devclass_add_driver to accomplish the recursive
1054 * notification of all the children classes of dc, as well as dc.
1055 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1058 * We do a full search here of the devclass list at each iteration
1059 * level to save storing children-lists in the devclass structure. If
1060 * we ever move beyond a few dozen devices doing this, we may need to
1063 * @param dc the devclass to edit
1064 * @param driver the driver that was just added
1067 devclass_driver_added(devclass_t dc, driver_t *driver)
1073 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1075 for (i = 0; i < dc->maxunit; i++)
1076 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1077 BUS_DRIVER_ADDED(dc->devices[i], driver);
1080 * Walk through the children classes. Since we only keep a
1081 * single parent pointer around, we walk the entire list of
1082 * devclasses looking for children. We set the
1083 * DC_HAS_CHILDREN flag when a child devclass is created on
1084 * the parent, so we only walk the list for those devclasses
1085 * that have children.
1087 if (!(dc->flags & DC_HAS_CHILDREN))
1090 TAILQ_FOREACH(dc, &devclasses, link) {
1091 if (dc->parent == parent)
1092 devclass_driver_added(dc, driver);
1097 * @brief Add a device driver to a device class
1099 * Add a device driver to a devclass. This is normally called
1100 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1101 * all devices in the devclass will be called to allow them to attempt
1102 * to re-probe any unmatched children.
1104 * @param dc the devclass to edit
1105 * @param driver the driver to register
1108 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1111 const char *parentname;
1113 PDEBUG(("%s", DRIVERNAME(driver)));
1115 /* Don't allow invalid pass values. */
1116 if (pass <= BUS_PASS_ROOT)
1119 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1124 * Compile the driver's methods. Also increase the reference count
1125 * so that the class doesn't get freed when the last instance
1126 * goes. This means we can safely use static methods and avoids a
1127 * double-free in devclass_delete_driver.
1129 kobj_class_compile((kobj_class_t) driver);
1132 * If the driver has any base classes, make the
1133 * devclass inherit from the devclass of the driver's
1134 * first base class. This will allow the system to
1135 * search for drivers in both devclasses for children
1136 * of a device using this driver.
1138 if (driver->baseclasses)
1139 parentname = driver->baseclasses[0]->name;
1142 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1144 dl->driver = driver;
1145 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1146 driver->refs++; /* XXX: kobj_mtx */
1148 driver_register_pass(dl);
1150 if (device_frozen) {
1151 dl->flags |= DL_DEFERRED_PROBE;
1153 devclass_driver_added(dc, driver);
1155 bus_data_generation_update();
1160 * @brief Register that a device driver has been deleted from a devclass
1162 * Register that a device driver has been removed from a devclass.
1163 * This is called by devclass_delete_driver to accomplish the
1164 * recursive notification of all the children classes of busclass, as
1165 * well as busclass. Each layer will attempt to detach the driver
1166 * from any devices that are children of the bus's devclass. The function
1167 * will return an error if a device fails to detach.
1169 * We do a full search here of the devclass list at each iteration
1170 * level to save storing children-lists in the devclass structure. If
1171 * we ever move beyond a few dozen devices doing this, we may need to
1174 * @param busclass the devclass of the parent bus
1175 * @param dc the devclass of the driver being deleted
1176 * @param driver the driver being deleted
1179 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1186 * Disassociate from any devices. We iterate through all the
1187 * devices in the devclass of the driver and detach any which are
1188 * using the driver and which have a parent in the devclass which
1189 * we are deleting from.
1191 * Note that since a driver can be in multiple devclasses, we
1192 * should not detach devices which are not children of devices in
1193 * the affected devclass.
1195 * If we're frozen, we don't generate NOMATCH events. Mark to
1198 for (i = 0; i < dc->maxunit; i++) {
1199 if (dc->devices[i]) {
1200 dev = dc->devices[i];
1201 if (dev->driver == driver && dev->parent &&
1202 dev->parent->devclass == busclass) {
1203 if ((error = device_detach(dev)) != 0)
1205 if (device_frozen) {
1206 dev->flags &= ~DF_DONENOMATCH;
1207 dev->flags |= DF_NEEDNOMATCH;
1209 BUS_PROBE_NOMATCH(dev->parent, dev);
1211 dev->flags |= DF_DONENOMATCH;
1218 * Walk through the children classes. Since we only keep a
1219 * single parent pointer around, we walk the entire list of
1220 * devclasses looking for children. We set the
1221 * DC_HAS_CHILDREN flag when a child devclass is created on
1222 * the parent, so we only walk the list for those devclasses
1223 * that have children.
1225 if (!(busclass->flags & DC_HAS_CHILDREN))
1228 TAILQ_FOREACH(busclass, &devclasses, link) {
1229 if (busclass->parent == parent) {
1230 error = devclass_driver_deleted(busclass, dc, driver);
1239 * @brief Delete a device driver from a device class
1241 * Delete a device driver from a devclass. This is normally called
1242 * automatically by DRIVER_MODULE().
1244 * If the driver is currently attached to any devices,
1245 * devclass_delete_driver() will first attempt to detach from each
1246 * device. If one of the detach calls fails, the driver will not be
1249 * @param dc the devclass to edit
1250 * @param driver the driver to unregister
1253 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1255 devclass_t dc = devclass_find(driver->name);
1259 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1265 * Find the link structure in the bus' list of drivers.
1267 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1268 if (dl->driver == driver)
1273 PDEBUG(("%s not found in %s list", driver->name,
1278 error = devclass_driver_deleted(busclass, dc, driver);
1282 TAILQ_REMOVE(&busclass->drivers, dl, link);
1287 if (driver->refs == 0)
1288 kobj_class_free((kobj_class_t) driver);
1290 bus_data_generation_update();
1295 * @brief Quiesces a set of device drivers from a device class
1297 * Quiesce a device driver from a devclass. This is normally called
1298 * automatically by DRIVER_MODULE().
1300 * If the driver is currently attached to any devices,
1301 * devclass_quiesece_driver() will first attempt to quiesce each
1304 * @param dc the devclass to edit
1305 * @param driver the driver to unregister
1308 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1310 devclass_t dc = devclass_find(driver->name);
1316 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1322 * Find the link structure in the bus' list of drivers.
1324 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1325 if (dl->driver == driver)
1330 PDEBUG(("%s not found in %s list", driver->name,
1336 * Quiesce all devices. We iterate through all the devices in
1337 * the devclass of the driver and quiesce any which are using
1338 * the driver and which have a parent in the devclass which we
1341 * Note that since a driver can be in multiple devclasses, we
1342 * should not quiesce devices which are not children of
1343 * devices in the affected devclass.
1345 for (i = 0; i < dc->maxunit; i++) {
1346 if (dc->devices[i]) {
1347 dev = dc->devices[i];
1348 if (dev->driver == driver && dev->parent &&
1349 dev->parent->devclass == busclass) {
1350 if ((error = device_quiesce(dev)) != 0)
1363 devclass_find_driver_internal(devclass_t dc, const char *classname)
1367 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1369 TAILQ_FOREACH(dl, &dc->drivers, link) {
1370 if (!strcmp(dl->driver->name, classname))
1374 PDEBUG(("not found"));
1379 * @brief Return the name of the devclass
1382 devclass_get_name(devclass_t dc)
1388 * @brief Find a device given a unit number
1390 * @param dc the devclass to search
1391 * @param unit the unit number to search for
1393 * @returns the device with the given unit number or @c
1394 * NULL if there is no such device
1397 devclass_get_device(devclass_t dc, int unit)
1399 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1401 return (dc->devices[unit]);
1405 * @brief Find the softc field of a device given a unit number
1407 * @param dc the devclass to search
1408 * @param unit the unit number to search for
1410 * @returns the softc field of the device with the given
1411 * unit number or @c NULL if there is no such
1415 devclass_get_softc(devclass_t dc, int unit)
1419 dev = devclass_get_device(dc, unit);
1423 return (device_get_softc(dev));
1427 * @brief Get a list of devices in the devclass
1429 * An array containing a list of all the devices in the given devclass
1430 * is allocated and returned in @p *devlistp. The number of devices
1431 * in the array is returned in @p *devcountp. The caller should free
1432 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1434 * @param dc the devclass to examine
1435 * @param devlistp points at location for array pointer return
1437 * @param devcountp points at location for array size return value
1440 * @retval ENOMEM the array allocation failed
1443 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1448 count = devclass_get_count(dc);
1449 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1454 for (i = 0; i < dc->maxunit; i++) {
1455 if (dc->devices[i]) {
1456 list[count] = dc->devices[i];
1468 * @brief Get a list of drivers in the devclass
1470 * An array containing a list of pointers to all the drivers in the
1471 * given devclass is allocated and returned in @p *listp. The number
1472 * of drivers in the array is returned in @p *countp. The caller should
1473 * free the array using @c free(p, M_TEMP).
1475 * @param dc the devclass to examine
1476 * @param listp gives location for array pointer return value
1477 * @param countp gives location for number of array elements
1481 * @retval ENOMEM the array allocation failed
1484 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1491 TAILQ_FOREACH(dl, &dc->drivers, link)
1493 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1498 TAILQ_FOREACH(dl, &dc->drivers, link) {
1499 list[count] = dl->driver;
1509 * @brief Get the number of devices in a devclass
1511 * @param dc the devclass to examine
1514 devclass_get_count(devclass_t dc)
1519 for (i = 0; i < dc->maxunit; i++)
1526 * @brief Get the maximum unit number used in a devclass
1528 * Note that this is one greater than the highest currently-allocated
1529 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1530 * that not even the devclass has been allocated yet.
1532 * @param dc the devclass to examine
1535 devclass_get_maxunit(devclass_t dc)
1539 return (dc->maxunit);
1543 * @brief Find a free unit number in a devclass
1545 * This function searches for the first unused unit number greater
1546 * that or equal to @p unit.
1548 * @param dc the devclass to examine
1549 * @param unit the first unit number to check
1552 devclass_find_free_unit(devclass_t dc, int unit)
1556 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1562 * @brief Set the parent of a devclass
1564 * The parent class is normally initialised automatically by
1567 * @param dc the devclass to edit
1568 * @param pdc the new parent devclass
1571 devclass_set_parent(devclass_t dc, devclass_t pdc)
1577 * @brief Get the parent of a devclass
1579 * @param dc the devclass to examine
1582 devclass_get_parent(devclass_t dc)
1584 return (dc->parent);
1587 struct sysctl_ctx_list *
1588 devclass_get_sysctl_ctx(devclass_t dc)
1590 return (&dc->sysctl_ctx);
1594 devclass_get_sysctl_tree(devclass_t dc)
1596 return (dc->sysctl_tree);
1601 * @brief Allocate a unit number
1603 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1604 * will do). The allocated unit number is returned in @p *unitp.
1606 * @param dc the devclass to allocate from
1607 * @param unitp points at the location for the allocated unit
1611 * @retval EEXIST the requested unit number is already allocated
1612 * @retval ENOMEM memory allocation failure
1615 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1620 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1622 /* Ask the parent bus if it wants to wire this device. */
1624 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1627 /* If we were given a wired unit number, check for existing device */
1630 if (unit >= 0 && unit < dc->maxunit &&
1631 dc->devices[unit] != NULL) {
1633 printf("%s: %s%d already exists; skipping it\n",
1634 dc->name, dc->name, *unitp);
1638 /* Unwired device, find the next available slot for it */
1640 for (unit = 0;; unit++) {
1641 /* If this device slot is already in use, skip it. */
1642 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1645 /* If there is an "at" hint for a unit then skip it. */
1646 if (resource_string_value(dc->name, unit, "at", &s) ==
1655 * We've selected a unit beyond the length of the table, so let's
1656 * extend the table to make room for all units up to and including
1659 if (unit >= dc->maxunit) {
1660 device_t *newlist, *oldlist;
1663 oldlist = dc->devices;
1664 newsize = roundup((unit + 1),
1665 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1666 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1669 if (oldlist != NULL)
1670 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1671 bzero(newlist + dc->maxunit,
1672 sizeof(device_t) * (newsize - dc->maxunit));
1673 dc->devices = newlist;
1674 dc->maxunit = newsize;
1675 if (oldlist != NULL)
1676 free(oldlist, M_BUS);
1678 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1686 * @brief Add a device to a devclass
1688 * A unit number is allocated for the device (using the device's
1689 * preferred unit number if any) and the device is registered in the
1690 * devclass. This allows the device to be looked up by its unit
1691 * number, e.g. by decoding a dev_t minor number.
1693 * @param dc the devclass to add to
1694 * @param dev the device to add
1697 * @retval EEXIST the requested unit number is already allocated
1698 * @retval ENOMEM memory allocation failure
1701 devclass_add_device(devclass_t dc, device_t dev)
1705 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1707 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1710 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1714 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1715 free(dev->nameunit, M_BUS);
1716 dev->nameunit = NULL;
1719 dc->devices[dev->unit] = dev;
1721 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1728 * @brief Delete a device from a devclass
1730 * The device is removed from the devclass's device list and its unit
1733 * @param dc the devclass to delete from
1734 * @param dev the device to delete
1739 devclass_delete_device(devclass_t dc, device_t dev)
1744 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1746 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1747 panic("devclass_delete_device: inconsistent device class");
1748 dc->devices[dev->unit] = NULL;
1749 if (dev->flags & DF_WILDCARD)
1751 dev->devclass = NULL;
1752 free(dev->nameunit, M_BUS);
1753 dev->nameunit = NULL;
1760 * @brief Make a new device and add it as a child of @p parent
1762 * @param parent the parent of the new device
1763 * @param name the devclass name of the new device or @c NULL
1764 * to leave the devclass unspecified
1765 * @parem unit the unit number of the new device of @c -1 to
1766 * leave the unit number unspecified
1768 * @returns the new device
1771 make_device(device_t parent, const char *name, int unit)
1776 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1779 dc = devclass_find_internal(name, NULL, TRUE);
1781 printf("make_device: can't find device class %s\n",
1789 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1793 dev->parent = parent;
1794 TAILQ_INIT(&dev->children);
1795 kobj_init((kobj_t) dev, &null_class);
1797 dev->devclass = NULL;
1799 dev->nameunit = NULL;
1803 dev->flags = DF_ENABLED;
1806 dev->flags |= DF_WILDCARD;
1808 dev->flags |= DF_FIXEDCLASS;
1809 if (devclass_add_device(dc, dev)) {
1810 kobj_delete((kobj_t) dev, M_BUS);
1814 if (parent != NULL && device_has_quiet_children(parent))
1815 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1819 dev->state = DS_NOTPRESENT;
1821 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1822 bus_data_generation_update();
1829 * @brief Print a description of a device.
1832 device_print_child(device_t dev, device_t child)
1836 if (device_is_alive(child))
1837 retval += BUS_PRINT_CHILD(dev, child);
1839 retval += device_printf(child, " not found\n");
1845 * @brief Create a new device
1847 * This creates a new device and adds it as a child of an existing
1848 * parent device. The new device will be added after the last existing
1849 * child with order zero.
1851 * @param dev the device which will be the parent of the
1853 * @param name devclass name for new device or @c NULL if not
1855 * @param unit unit number for new device or @c -1 if not
1858 * @returns the new device
1861 device_add_child(device_t dev, const char *name, int unit)
1863 return (device_add_child_ordered(dev, 0, name, unit));
1867 * @brief Create a new device
1869 * This creates a new device and adds it as a child of an existing
1870 * parent device. The new device will be added after the last existing
1871 * child with the same order.
1873 * @param dev the device which will be the parent of the
1875 * @param order a value which is used to partially sort the
1876 * children of @p dev - devices created using
1877 * lower values of @p order appear first in @p
1878 * dev's list of children
1879 * @param name devclass name for new device or @c NULL if not
1881 * @param unit unit number for new device or @c -1 if not
1884 * @returns the new device
1887 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1892 PDEBUG(("%s at %s with order %u as unit %d",
1893 name, DEVICENAME(dev), order, unit));
1894 KASSERT(name != NULL || unit == -1,
1895 ("child device with wildcard name and specific unit number"));
1897 child = make_device(dev, name, unit);
1900 child->order = order;
1902 TAILQ_FOREACH(place, &dev->children, link) {
1903 if (place->order > order)
1909 * The device 'place' is the first device whose order is
1910 * greater than the new child.
1912 TAILQ_INSERT_BEFORE(place, child, link);
1915 * The new child's order is greater or equal to the order of
1916 * any existing device. Add the child to the tail of the list.
1918 TAILQ_INSERT_TAIL(&dev->children, child, link);
1921 bus_data_generation_update();
1926 * @brief Delete a device
1928 * This function deletes a device along with all of its children. If
1929 * the device currently has a driver attached to it, the device is
1930 * detached first using device_detach().
1932 * @param dev the parent device
1933 * @param child the device to delete
1936 * @retval non-zero a unit error code describing the error
1939 device_delete_child(device_t dev, device_t child)
1942 device_t grandchild;
1944 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1946 /* detach parent before deleting children, if any */
1947 if ((error = device_detach(child)) != 0)
1950 /* remove children second */
1951 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1952 error = device_delete_child(child, grandchild);
1957 if (child->devclass)
1958 devclass_delete_device(child->devclass, child);
1960 BUS_CHILD_DELETED(dev, child);
1961 TAILQ_REMOVE(&dev->children, child, link);
1962 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1963 kobj_delete((kobj_t) child, M_BUS);
1965 bus_data_generation_update();
1970 * @brief Delete all children devices of the given device, if any.
1972 * This function deletes all children devices of the given device, if
1973 * any, using the device_delete_child() function for each device it
1974 * finds. If a child device cannot be deleted, this function will
1975 * return an error code.
1977 * @param dev the parent device
1980 * @retval non-zero a device would not detach
1983 device_delete_children(device_t dev)
1988 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1992 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1993 error = device_delete_child(dev, child);
1995 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2003 * @brief Find a device given a unit number
2005 * This is similar to devclass_get_devices() but only searches for
2006 * devices which have @p dev as a parent.
2008 * @param dev the parent device to search
2009 * @param unit the unit number to search for. If the unit is -1,
2010 * return the first child of @p dev which has name
2011 * @p classname (that is, the one with the lowest unit.)
2013 * @returns the device with the given unit number or @c
2014 * NULL if there is no such device
2017 device_find_child(device_t dev, const char *classname, int unit)
2022 dc = devclass_find(classname);
2027 child = devclass_get_device(dc, unit);
2028 if (child && child->parent == dev)
2031 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2032 child = devclass_get_device(dc, unit);
2033 if (child && child->parent == dev)
2044 first_matching_driver(devclass_t dc, device_t dev)
2047 return (devclass_find_driver_internal(dc, dev->devclass->name));
2048 return (TAILQ_FIRST(&dc->drivers));
2055 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2057 if (dev->devclass) {
2059 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2060 if (!strcmp(dev->devclass->name, dl->driver->name))
2064 return (TAILQ_NEXT(last, link));
2071 device_probe_child(device_t dev, device_t child)
2074 driverlink_t best = NULL;
2076 int result, pri = 0;
2077 /* We should preserve the devclass (or lack of) set by the bus. */
2078 int hasclass = (child->devclass != NULL);
2084 panic("device_probe_child: parent device has no devclass");
2087 * If the state is already probed, then return.
2089 if (child->state == DS_ALIVE)
2092 for (; dc; dc = dc->parent) {
2093 for (dl = first_matching_driver(dc, child);
2095 dl = next_matching_driver(dc, child, dl)) {
2096 /* If this driver's pass is too high, then ignore it. */
2097 if (dl->pass > bus_current_pass)
2100 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2101 result = device_set_driver(child, dl->driver);
2102 if (result == ENOMEM)
2104 else if (result != 0)
2107 if (device_set_devclass(child,
2108 dl->driver->name) != 0) {
2109 char const * devname =
2110 device_get_name(child);
2111 if (devname == NULL)
2112 devname = "(unknown)";
2113 printf("driver bug: Unable to set "
2114 "devclass (class: %s "
2118 (void)device_set_driver(child, NULL);
2123 /* Fetch any flags for the device before probing. */
2124 resource_int_value(dl->driver->name, child->unit,
2125 "flags", &child->devflags);
2127 result = DEVICE_PROBE(child);
2130 * If the driver returns SUCCESS, there can be
2131 * no higher match for this device.
2139 /* Reset flags and devclass before the next probe. */
2140 child->devflags = 0;
2142 (void)device_set_devclass(child, NULL);
2145 * Reset DF_QUIET in case this driver doesn't
2146 * end up as the best driver.
2148 device_verbose(child);
2151 * Probes that return BUS_PROBE_NOWILDCARD or lower
2152 * only match on devices whose driver was explicitly
2155 if (result <= BUS_PROBE_NOWILDCARD &&
2156 !(child->flags & DF_FIXEDCLASS)) {
2161 * The driver returned an error so it
2162 * certainly doesn't match.
2165 (void)device_set_driver(child, NULL);
2170 * A priority lower than SUCCESS, remember the
2171 * best matching driver. Initialise the value
2172 * of pri for the first match.
2174 if (best == NULL || result > pri) {
2181 * If we have an unambiguous match in this devclass,
2182 * don't look in the parent.
2184 if (best && pri == 0)
2192 * If we found a driver, change state and initialise the devclass.
2195 /* Set the winning driver, devclass, and flags. */
2196 result = device_set_driver(child, best->driver);
2199 if (!child->devclass) {
2200 result = device_set_devclass(child, best->driver->name);
2202 (void)device_set_driver(child, NULL);
2206 resource_int_value(best->driver->name, child->unit,
2207 "flags", &child->devflags);
2210 * A bit bogus. Call the probe method again to make sure
2211 * that we have the right description.
2213 result = DEVICE_PROBE(child);
2216 (void)device_set_devclass(child, NULL);
2217 (void)device_set_driver(child, NULL);
2222 child->state = DS_ALIVE;
2223 bus_data_generation_update();
2228 * @brief Return the parent of a device
2231 device_get_parent(device_t dev)
2233 return (dev->parent);
2237 * @brief Get a list of children of a device
2239 * An array containing a list of all the children of the given device
2240 * is allocated and returned in @p *devlistp. The number of devices
2241 * in the array is returned in @p *devcountp. The caller should free
2242 * the array using @c free(p, M_TEMP).
2244 * @param dev the device to examine
2245 * @param devlistp points at location for array pointer return
2247 * @param devcountp points at location for array size return value
2250 * @retval ENOMEM the array allocation failed
2253 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2260 TAILQ_FOREACH(child, &dev->children, link) {
2269 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2274 TAILQ_FOREACH(child, &dev->children, link) {
2275 list[count] = child;
2286 * @brief Return the current driver for the device or @c NULL if there
2287 * is no driver currently attached
2290 device_get_driver(device_t dev)
2292 return (dev->driver);
2296 * @brief Return the current devclass for the device or @c NULL if
2300 device_get_devclass(device_t dev)
2302 return (dev->devclass);
2306 * @brief Return the name of the device's devclass or @c NULL if there
2310 device_get_name(device_t dev)
2312 if (dev != NULL && dev->devclass)
2313 return (devclass_get_name(dev->devclass));
2318 * @brief Return a string containing the device's devclass name
2319 * followed by an ascii representation of the device's unit number
2323 device_get_nameunit(device_t dev)
2325 return (dev->nameunit);
2329 * @brief Return the device's unit number.
2332 device_get_unit(device_t dev)
2338 * @brief Return the device's description string
2341 device_get_desc(device_t dev)
2347 * @brief Return the device's flags
2350 device_get_flags(device_t dev)
2352 return (dev->devflags);
2355 struct sysctl_ctx_list *
2356 device_get_sysctl_ctx(device_t dev)
2358 return (&dev->sysctl_ctx);
2362 device_get_sysctl_tree(device_t dev)
2364 return (dev->sysctl_tree);
2368 * @brief Print the name of the device followed by a colon and a space
2370 * @returns the number of characters printed
2373 device_print_prettyname(device_t dev)
2375 const char *name = device_get_name(dev);
2378 return (printf("unknown: "));
2379 return (printf("%s%d: ", name, device_get_unit(dev)));
2383 * @brief Print the name of the device followed by a colon, a space
2384 * and the result of calling vprintf() with the value of @p fmt and
2385 * the following arguments.
2387 * @returns the number of characters printed
2390 device_printf(device_t dev, const char * fmt, ...)
2400 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2401 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2403 name = device_get_name(dev);
2406 sbuf_cat(&sb, "unknown: ");
2408 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2411 sbuf_vprintf(&sb, fmt, ap);
2421 * @brief Print the name of the device followed by a colon, a space
2422 * and the result of calling log() with the value of @p fmt and
2423 * the following arguments.
2425 * @returns the number of characters printed
2428 device_log(device_t dev, int pri, const char * fmt, ...)
2438 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2440 name = device_get_name(dev);
2443 sbuf_cat(&sb, "unknown: ");
2445 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2448 sbuf_vprintf(&sb, fmt, ap);
2453 log(pri, "%.*s", (int) sbuf_len(&sb), sbuf_data(&sb));
2454 retval = sbuf_len(&sb);
2465 device_set_desc_internal(device_t dev, const char* desc, int copy)
2467 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2468 free(dev->desc, M_BUS);
2469 dev->flags &= ~DF_DESCMALLOCED;
2474 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2476 strcpy(dev->desc, desc);
2477 dev->flags |= DF_DESCMALLOCED;
2480 /* Avoid a -Wcast-qual warning */
2481 dev->desc = (char *)(uintptr_t) desc;
2484 bus_data_generation_update();
2488 * @brief Set the device's description
2490 * The value of @c desc should be a string constant that will not
2491 * change (at least until the description is changed in a subsequent
2492 * call to device_set_desc() or device_set_desc_copy()).
2495 device_set_desc(device_t dev, const char* desc)
2497 device_set_desc_internal(dev, desc, FALSE);
2501 * @brief Set the device's description
2503 * The string pointed to by @c desc is copied. Use this function if
2504 * the device description is generated, (e.g. with sprintf()).
2507 device_set_desc_copy(device_t dev, const char* desc)
2509 device_set_desc_internal(dev, desc, TRUE);
2513 * @brief Set the device's flags
2516 device_set_flags(device_t dev, uint32_t flags)
2518 dev->devflags = flags;
2522 * @brief Return the device's softc field
2524 * The softc is allocated and zeroed when a driver is attached, based
2525 * on the size field of the driver.
2528 device_get_softc(device_t dev)
2530 return (dev->softc);
2534 * @brief Set the device's softc field
2536 * Most drivers do not need to use this since the softc is allocated
2537 * automatically when the driver is attached.
2540 device_set_softc(device_t dev, void *softc)
2542 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2543 free(dev->softc, M_BUS_SC);
2546 dev->flags |= DF_EXTERNALSOFTC;
2548 dev->flags &= ~DF_EXTERNALSOFTC;
2552 * @brief Free claimed softc
2554 * Most drivers do not need to use this since the softc is freed
2555 * automatically when the driver is detached.
2558 device_free_softc(void *softc)
2560 free(softc, M_BUS_SC);
2564 * @brief Claim softc
2566 * This function can be used to let the driver free the automatically
2567 * allocated softc using "device_free_softc()". This function is
2568 * useful when the driver is refcounting the softc and the softc
2569 * cannot be freed when the "device_detach" method is called.
2572 device_claim_softc(device_t dev)
2575 dev->flags |= DF_EXTERNALSOFTC;
2577 dev->flags &= ~DF_EXTERNALSOFTC;
2581 * @brief Get the device's ivars field
2583 * The ivars field is used by the parent device to store per-device
2584 * state (e.g. the physical location of the device or a list of
2588 device_get_ivars(device_t dev)
2590 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2591 return (dev->ivars);
2595 * @brief Set the device's ivars field
2598 device_set_ivars(device_t dev, void * ivars)
2600 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2605 * @brief Return the device's state
2608 device_get_state(device_t dev)
2610 return (dev->state);
2614 * @brief Set the DF_ENABLED flag for the device
2617 device_enable(device_t dev)
2619 dev->flags |= DF_ENABLED;
2623 * @brief Clear the DF_ENABLED flag for the device
2626 device_disable(device_t dev)
2628 dev->flags &= ~DF_ENABLED;
2632 * @brief Increment the busy counter for the device
2635 device_busy(device_t dev)
2637 if (dev->state < DS_ATTACHING)
2638 panic("device_busy: called for unattached device");
2639 if (dev->busy == 0 && dev->parent)
2640 device_busy(dev->parent);
2642 if (dev->state == DS_ATTACHED)
2643 dev->state = DS_BUSY;
2647 * @brief Decrement the busy counter for the device
2650 device_unbusy(device_t dev)
2652 if (dev->busy != 0 && dev->state != DS_BUSY &&
2653 dev->state != DS_ATTACHING)
2654 panic("device_unbusy: called for non-busy device %s",
2655 device_get_nameunit(dev));
2657 if (dev->busy == 0) {
2659 device_unbusy(dev->parent);
2660 if (dev->state == DS_BUSY)
2661 dev->state = DS_ATTACHED;
2666 * @brief Set the DF_QUIET flag for the device
2669 device_quiet(device_t dev)
2671 dev->flags |= DF_QUIET;
2675 * @brief Set the DF_QUIET_CHILDREN flag for the device
2678 device_quiet_children(device_t dev)
2680 dev->flags |= DF_QUIET_CHILDREN;
2684 * @brief Clear the DF_QUIET flag for the device
2687 device_verbose(device_t dev)
2689 dev->flags &= ~DF_QUIET;
2693 device_get_property(device_t dev, const char *prop, void *val, size_t sz)
2695 device_t bus = device_get_parent(dev);
2697 return (BUS_GET_PROPERTY(bus, dev, prop, val, sz));
2701 device_has_property(device_t dev, const char *prop)
2703 return (device_get_property(dev, prop, NULL, 0) >= 0);
2707 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2710 device_has_quiet_children(device_t dev)
2712 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2716 * @brief Return non-zero if the DF_QUIET flag is set on the device
2719 device_is_quiet(device_t dev)
2721 return ((dev->flags & DF_QUIET) != 0);
2725 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2728 device_is_enabled(device_t dev)
2730 return ((dev->flags & DF_ENABLED) != 0);
2734 * @brief Return non-zero if the device was successfully probed
2737 device_is_alive(device_t dev)
2739 return (dev->state >= DS_ALIVE);
2743 * @brief Return non-zero if the device currently has a driver
2747 device_is_attached(device_t dev)
2749 return (dev->state >= DS_ATTACHED);
2753 * @brief Return non-zero if the device is currently suspended.
2756 device_is_suspended(device_t dev)
2758 return ((dev->flags & DF_SUSPENDED) != 0);
2762 * @brief Set the devclass of a device
2763 * @see devclass_add_device().
2766 device_set_devclass(device_t dev, const char *classname)
2773 devclass_delete_device(dev->devclass, dev);
2777 if (dev->devclass) {
2778 printf("device_set_devclass: device class already set\n");
2782 dc = devclass_find_internal(classname, NULL, TRUE);
2786 error = devclass_add_device(dc, dev);
2788 bus_data_generation_update();
2793 * @brief Set the devclass of a device and mark the devclass fixed.
2794 * @see device_set_devclass()
2797 device_set_devclass_fixed(device_t dev, const char *classname)
2801 if (classname == NULL)
2804 error = device_set_devclass(dev, classname);
2807 dev->flags |= DF_FIXEDCLASS;
2812 * @brief Query the device to determine if it's of a fixed devclass
2813 * @see device_set_devclass_fixed()
2816 device_is_devclass_fixed(device_t dev)
2818 return ((dev->flags & DF_FIXEDCLASS) != 0);
2822 * @brief Set the driver of a device
2825 * @retval EBUSY the device already has a driver attached
2826 * @retval ENOMEM a memory allocation failure occurred
2829 device_set_driver(device_t dev, driver_t *driver)
2832 struct domainset *policy;
2834 if (dev->state >= DS_ATTACHED)
2837 if (dev->driver == driver)
2840 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2841 free(dev->softc, M_BUS_SC);
2844 device_set_desc(dev, NULL);
2845 kobj_delete((kobj_t) dev, NULL);
2846 dev->driver = driver;
2848 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2849 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2850 if (bus_get_domain(dev, &domain) == 0)
2851 policy = DOMAINSET_PREF(domain);
2853 policy = DOMAINSET_RR();
2854 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2855 policy, M_NOWAIT | M_ZERO);
2857 kobj_delete((kobj_t) dev, NULL);
2858 kobj_init((kobj_t) dev, &null_class);
2864 kobj_init((kobj_t) dev, &null_class);
2867 bus_data_generation_update();
2872 * @brief Probe a device, and return this status.
2874 * This function is the core of the device autoconfiguration
2875 * system. Its purpose is to select a suitable driver for a device and
2876 * then call that driver to initialise the hardware appropriately. The
2877 * driver is selected by calling the DEVICE_PROBE() method of a set of
2878 * candidate drivers and then choosing the driver which returned the
2879 * best value. This driver is then attached to the device using
2882 * The set of suitable drivers is taken from the list of drivers in
2883 * the parent device's devclass. If the device was originally created
2884 * with a specific class name (see device_add_child()), only drivers
2885 * with that name are probed, otherwise all drivers in the devclass
2886 * are probed. If no drivers return successful probe values in the
2887 * parent devclass, the search continues in the parent of that
2888 * devclass (see devclass_get_parent()) if any.
2890 * @param dev the device to initialise
2893 * @retval ENXIO no driver was found
2894 * @retval ENOMEM memory allocation failure
2895 * @retval non-zero some other unix error code
2896 * @retval -1 Device already attached
2899 device_probe(device_t dev)
2905 if (dev->state >= DS_ALIVE)
2908 if (!(dev->flags & DF_ENABLED)) {
2909 if (bootverbose && device_get_name(dev) != NULL) {
2910 device_print_prettyname(dev);
2911 printf("not probed (disabled)\n");
2915 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2916 if (bus_current_pass == BUS_PASS_DEFAULT &&
2917 !(dev->flags & DF_DONENOMATCH)) {
2918 BUS_PROBE_NOMATCH(dev->parent, dev);
2920 dev->flags |= DF_DONENOMATCH;
2928 * @brief Probe a device and attach a driver if possible
2930 * calls device_probe() and attaches if that was successful.
2933 device_probe_and_attach(device_t dev)
2939 error = device_probe(dev);
2942 else if (error != 0)
2945 CURVNET_SET_QUIET(vnet0);
2946 error = device_attach(dev);
2952 * @brief Attach a device driver to a device
2954 * This function is a wrapper around the DEVICE_ATTACH() driver
2955 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2956 * device's sysctl tree, optionally prints a description of the device
2957 * and queues a notification event for user-based device management
2960 * Normally this function is only called internally from
2961 * device_probe_and_attach().
2963 * @param dev the device to initialise
2966 * @retval ENXIO no driver was found
2967 * @retval ENOMEM memory allocation failure
2968 * @retval non-zero some other unix error code
2971 device_attach(device_t dev)
2973 uint64_t attachtime;
2974 uint16_t attachentropy;
2977 if (resource_disabled(dev->driver->name, dev->unit)) {
2978 device_disable(dev);
2980 device_printf(dev, "disabled via hints entry\n");
2984 device_sysctl_init(dev);
2985 if (!device_is_quiet(dev))
2986 device_print_child(dev->parent, dev);
2987 attachtime = get_cyclecount();
2988 dev->state = DS_ATTACHING;
2989 if ((error = DEVICE_ATTACH(dev)) != 0) {
2990 printf("device_attach: %s%d attach returned %d\n",
2991 dev->driver->name, dev->unit, error);
2992 if (!(dev->flags & DF_FIXEDCLASS))
2993 devclass_delete_device(dev->devclass, dev);
2994 (void)device_set_driver(dev, NULL);
2995 device_sysctl_fini(dev);
2996 KASSERT(dev->busy == 0, ("attach failed but busy"));
2997 dev->state = DS_NOTPRESENT;
3000 dev->flags |= DF_ATTACHED_ONCE;
3001 /* We only need the low bits of this time, but ranges from tens to thousands
3002 * have been seen, so keep 2 bytes' worth.
3004 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3005 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3006 device_sysctl_update(dev);
3008 dev->state = DS_BUSY;
3010 dev->state = DS_ATTACHED;
3011 dev->flags &= ~DF_DONENOMATCH;
3012 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3018 * @brief Detach a driver from a device
3020 * This function is a wrapper around the DEVICE_DETACH() driver
3021 * method. If the call to DEVICE_DETACH() succeeds, it calls
3022 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3023 * notification event for user-based device management services and
3024 * cleans up the device's sysctl tree.
3026 * @param dev the device to un-initialise
3029 * @retval ENXIO no driver was found
3030 * @retval ENOMEM memory allocation failure
3031 * @retval non-zero some other unix error code
3034 device_detach(device_t dev)
3040 PDEBUG(("%s", DEVICENAME(dev)));
3041 if (dev->state == DS_BUSY)
3043 if (dev->state == DS_ATTACHING) {
3044 device_printf(dev, "device in attaching state! Deferring detach.\n");
3047 if (dev->state != DS_ATTACHED)
3050 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3051 if ((error = DEVICE_DETACH(dev)) != 0) {
3052 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3053 EVHDEV_DETACH_FAILED);
3056 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3057 EVHDEV_DETACH_COMPLETE);
3060 if (!device_is_quiet(dev))
3061 device_printf(dev, "detached\n");
3063 BUS_CHILD_DETACHED(dev->parent, dev);
3065 if (!(dev->flags & DF_FIXEDCLASS))
3066 devclass_delete_device(dev->devclass, dev);
3068 device_verbose(dev);
3069 dev->state = DS_NOTPRESENT;
3070 (void)device_set_driver(dev, NULL);
3071 device_sysctl_fini(dev);
3077 * @brief Tells a driver to quiesce itself.
3079 * This function is a wrapper around the DEVICE_QUIESCE() driver
3080 * method. If the call to DEVICE_QUIESCE() succeeds.
3082 * @param dev the device to quiesce
3085 * @retval ENXIO no driver was found
3086 * @retval ENOMEM memory allocation failure
3087 * @retval non-zero some other unix error code
3090 device_quiesce(device_t dev)
3092 PDEBUG(("%s", DEVICENAME(dev)));
3093 if (dev->state == DS_BUSY)
3095 if (dev->state != DS_ATTACHED)
3098 return (DEVICE_QUIESCE(dev));
3102 * @brief Notify a device of system shutdown
3104 * This function calls the DEVICE_SHUTDOWN() driver method if the
3105 * device currently has an attached driver.
3107 * @returns the value returned by DEVICE_SHUTDOWN()
3110 device_shutdown(device_t dev)
3112 if (dev->state < DS_ATTACHED)
3114 return (DEVICE_SHUTDOWN(dev));
3118 * @brief Set the unit number of a device
3120 * This function can be used to override the unit number used for a
3121 * device (e.g. to wire a device to a pre-configured unit number).
3124 device_set_unit(device_t dev, int unit)
3129 if (unit == dev->unit)
3131 dc = device_get_devclass(dev);
3132 if (unit < dc->maxunit && dc->devices[unit])
3134 err = devclass_delete_device(dc, dev);
3138 err = devclass_add_device(dc, dev);
3142 bus_data_generation_update();
3146 /*======================================*/
3148 * Some useful method implementations to make life easier for bus drivers.
3152 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3156 args->memattr = VM_MEMATTR_DEVICE;
3160 * @brief Initialise a resource list.
3162 * @param rl the resource list to initialise
3165 resource_list_init(struct resource_list *rl)
3171 * @brief Reclaim memory used by a resource list.
3173 * This function frees the memory for all resource entries on the list
3176 * @param rl the resource list to free
3179 resource_list_free(struct resource_list *rl)
3181 struct resource_list_entry *rle;
3183 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3185 panic("resource_list_free: resource entry is busy");
3186 STAILQ_REMOVE_HEAD(rl, link);
3192 * @brief Add a resource entry.
3194 * This function adds a resource entry using the given @p type, @p
3195 * start, @p end and @p count values. A rid value is chosen by
3196 * searching sequentially for the first unused rid starting at zero.
3198 * @param rl the resource list to edit
3199 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3200 * @param start the start address of the resource
3201 * @param end the end address of the resource
3202 * @param count XXX end-start+1
3205 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3206 rman_res_t end, rman_res_t count)
3211 while (resource_list_find(rl, type, rid) != NULL)
3213 resource_list_add(rl, type, rid, start, end, count);
3218 * @brief Add or modify a resource entry.
3220 * If an existing entry exists with the same type and rid, it will be
3221 * modified using the given values of @p start, @p end and @p
3222 * count. If no entry exists, a new one will be created using the
3223 * given values. The resource list entry that matches is then returned.
3225 * @param rl the resource list to edit
3226 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3227 * @param rid the resource identifier
3228 * @param start the start address of the resource
3229 * @param end the end address of the resource
3230 * @param count XXX end-start+1
3232 struct resource_list_entry *
3233 resource_list_add(struct resource_list *rl, int type, int rid,
3234 rman_res_t start, rman_res_t end, rman_res_t count)
3236 struct resource_list_entry *rle;
3238 rle = resource_list_find(rl, type, rid);
3240 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3243 panic("resource_list_add: can't record entry");
3244 STAILQ_INSERT_TAIL(rl, rle, link);
3252 panic("resource_list_add: resource entry is busy");
3261 * @brief Determine if a resource entry is busy.
3263 * Returns true if a resource entry is busy meaning that it has an
3264 * associated resource that is not an unallocated "reserved" resource.
3266 * @param rl the resource list to search
3267 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3268 * @param rid the resource identifier
3270 * @returns Non-zero if the entry is busy, zero otherwise.
3273 resource_list_busy(struct resource_list *rl, int type, int rid)
3275 struct resource_list_entry *rle;
3277 rle = resource_list_find(rl, type, rid);
3278 if (rle == NULL || rle->res == NULL)
3280 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3281 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3282 ("reserved resource is active"));
3289 * @brief Determine if a resource entry is reserved.
3291 * Returns true if a resource entry is reserved meaning that it has an
3292 * associated "reserved" resource. The resource can either be
3293 * allocated or unallocated.
3295 * @param rl the resource list to search
3296 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3297 * @param rid the resource identifier
3299 * @returns Non-zero if the entry is reserved, zero otherwise.
3302 resource_list_reserved(struct resource_list *rl, int type, int rid)
3304 struct resource_list_entry *rle;
3306 rle = resource_list_find(rl, type, rid);
3307 if (rle != NULL && rle->flags & RLE_RESERVED)
3313 * @brief Find a resource entry by type and rid.
3315 * @param rl the resource list to search
3316 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3317 * @param rid the resource identifier
3319 * @returns the resource entry pointer or NULL if there is no such
3322 struct resource_list_entry *
3323 resource_list_find(struct resource_list *rl, int type, int rid)
3325 struct resource_list_entry *rle;
3327 STAILQ_FOREACH(rle, rl, link) {
3328 if (rle->type == type && rle->rid == rid)
3335 * @brief Delete a resource entry.
3337 * @param rl the resource list to edit
3338 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3339 * @param rid the resource identifier
3342 resource_list_delete(struct resource_list *rl, int type, int rid)
3344 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3347 if (rle->res != NULL)
3348 panic("resource_list_delete: resource has not been released");
3349 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3355 * @brief Allocate a reserved resource
3357 * This can be used by buses to force the allocation of resources
3358 * that are always active in the system even if they are not allocated
3359 * by a driver (e.g. PCI BARs). This function is usually called when
3360 * adding a new child to the bus. The resource is allocated from the
3361 * parent bus when it is reserved. The resource list entry is marked
3362 * with RLE_RESERVED to note that it is a reserved resource.
3364 * Subsequent attempts to allocate the resource with
3365 * resource_list_alloc() will succeed the first time and will set
3366 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3367 * resource that has been allocated is released with
3368 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3369 * the actual resource remains allocated. The resource can be released to
3370 * the parent bus by calling resource_list_unreserve().
3372 * @param rl the resource list to allocate from
3373 * @param bus the parent device of @p child
3374 * @param child the device for which the resource is being reserved
3375 * @param type the type of resource to allocate
3376 * @param rid a pointer to the resource identifier
3377 * @param start hint at the start of the resource range - pass
3378 * @c 0 for any start address
3379 * @param end hint at the end of the resource range - pass
3380 * @c ~0 for any end address
3381 * @param count hint at the size of range required - pass @c 1
3383 * @param flags any extra flags to control the resource
3384 * allocation - see @c RF_XXX flags in
3385 * <sys/rman.h> for details
3387 * @returns the resource which was allocated or @c NULL if no
3388 * resource could be allocated
3391 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3392 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3394 struct resource_list_entry *rle = NULL;
3395 int passthrough = (device_get_parent(child) != bus);
3400 "resource_list_reserve() should only be called for direct children");
3401 if (flags & RF_ACTIVE)
3403 "resource_list_reserve() should only reserve inactive resources");
3405 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3408 rle = resource_list_find(rl, type, *rid);
3409 rle->flags |= RLE_RESERVED;
3415 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3417 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3418 * and passing the allocation up to the parent of @p bus. This assumes
3419 * that the first entry of @c device_get_ivars(child) is a struct
3420 * resource_list. This also handles 'passthrough' allocations where a
3421 * child is a remote descendant of bus by passing the allocation up to
3422 * the parent of bus.
3424 * Typically, a bus driver would store a list of child resources
3425 * somewhere in the child device's ivars (see device_get_ivars()) and
3426 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3427 * then call resource_list_alloc() to perform the allocation.
3429 * @param rl the resource list to allocate from
3430 * @param bus the parent device of @p child
3431 * @param child the device which is requesting an allocation
3432 * @param type the type of resource to allocate
3433 * @param rid a pointer to the resource identifier
3434 * @param start hint at the start of the resource range - pass
3435 * @c 0 for any start address
3436 * @param end hint at the end of the resource range - pass
3437 * @c ~0 for any end address
3438 * @param count hint at the size of range required - pass @c 1
3440 * @param flags any extra flags to control the resource
3441 * allocation - see @c RF_XXX flags in
3442 * <sys/rman.h> for details
3444 * @returns the resource which was allocated or @c NULL if no
3445 * resource could be allocated
3448 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3449 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3451 struct resource_list_entry *rle = NULL;
3452 int passthrough = (device_get_parent(child) != bus);
3453 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3456 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3457 type, rid, start, end, count, flags));
3460 rle = resource_list_find(rl, type, *rid);
3463 return (NULL); /* no resource of that type/rid */
3466 if (rle->flags & RLE_RESERVED) {
3467 if (rle->flags & RLE_ALLOCATED)
3469 if ((flags & RF_ACTIVE) &&
3470 bus_activate_resource(child, type, *rid,
3473 rle->flags |= RLE_ALLOCATED;
3477 "resource entry %#x type %d for child %s is busy\n", *rid,
3478 type, device_get_nameunit(child));
3484 count = ulmax(count, rle->count);
3485 end = ulmax(rle->end, start + count - 1);
3488 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3489 type, rid, start, end, count, flags);
3492 * Record the new range.
3495 rle->start = rman_get_start(rle->res);
3496 rle->end = rman_get_end(rle->res);
3504 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3506 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3507 * used with resource_list_alloc().
3509 * @param rl the resource list which was allocated from
3510 * @param bus the parent device of @p child
3511 * @param child the device which is requesting a release
3512 * @param type the type of resource to release
3513 * @param rid the resource identifier
3514 * @param res the resource to release
3517 * @retval non-zero a standard unix error code indicating what
3518 * error condition prevented the operation
3521 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3522 int type, int rid, struct resource *res)
3524 struct resource_list_entry *rle = NULL;
3525 int passthrough = (device_get_parent(child) != bus);
3529 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3533 rle = resource_list_find(rl, type, rid);
3536 panic("resource_list_release: can't find resource");
3538 panic("resource_list_release: resource entry is not busy");
3539 if (rle->flags & RLE_RESERVED) {
3540 if (rle->flags & RLE_ALLOCATED) {
3541 if (rman_get_flags(res) & RF_ACTIVE) {
3542 error = bus_deactivate_resource(child, type,
3547 rle->flags &= ~RLE_ALLOCATED;
3553 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3563 * @brief Release all active resources of a given type
3565 * Release all active resources of a specified type. This is intended
3566 * to be used to cleanup resources leaked by a driver after detach or
3569 * @param rl the resource list which was allocated from
3570 * @param bus the parent device of @p child
3571 * @param child the device whose active resources are being released
3572 * @param type the type of resources to release
3575 * @retval EBUSY at least one resource was active
3578 resource_list_release_active(struct resource_list *rl, device_t bus,
3579 device_t child, int type)
3581 struct resource_list_entry *rle;
3585 STAILQ_FOREACH(rle, rl, link) {
3586 if (rle->type != type)
3588 if (rle->res == NULL)
3590 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3594 error = resource_list_release(rl, bus, child, type,
3595 rman_get_rid(rle->res), rle->res);
3598 "Failed to release active resource: %d\n", error);
3604 * @brief Fully release a reserved resource
3606 * Fully releases a resource reserved via resource_list_reserve().
3608 * @param rl the resource list which was allocated from
3609 * @param bus the parent device of @p child
3610 * @param child the device whose reserved resource is being released
3611 * @param type the type of resource to release
3612 * @param rid the resource identifier
3613 * @param res the resource to release
3616 * @retval non-zero a standard unix error code indicating what
3617 * error condition prevented the operation
3620 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3623 struct resource_list_entry *rle = NULL;
3624 int passthrough = (device_get_parent(child) != bus);
3628 "resource_list_unreserve() should only be called for direct children");
3630 rle = resource_list_find(rl, type, rid);
3633 panic("resource_list_unreserve: can't find resource");
3634 if (!(rle->flags & RLE_RESERVED))
3636 if (rle->flags & RLE_ALLOCATED)
3638 rle->flags &= ~RLE_RESERVED;
3639 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3643 * @brief Print a description of resources in a resource list
3645 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3646 * The name is printed if at least one resource of the given type is available.
3647 * The format is used to print resource start and end.
3649 * @param rl the resource list to print
3650 * @param name the name of @p type, e.g. @c "memory"
3651 * @param type type type of resource entry to print
3652 * @param format printf(9) format string to print resource
3653 * start and end values
3655 * @returns the number of characters printed
3658 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3661 struct resource_list_entry *rle;
3662 int printed, retval;
3666 /* Yes, this is kinda cheating */
3667 STAILQ_FOREACH(rle, rl, link) {
3668 if (rle->type == type) {
3670 retval += printf(" %s ", name);
3672 retval += printf(",");
3674 retval += printf(format, rle->start);
3675 if (rle->count > 1) {
3676 retval += printf("-");
3677 retval += printf(format, rle->start +
3686 * @brief Releases all the resources in a list.
3688 * @param rl The resource list to purge.
3693 resource_list_purge(struct resource_list *rl)
3695 struct resource_list_entry *rle;
3697 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3699 bus_release_resource(rman_get_device(rle->res),
3700 rle->type, rle->rid, rle->res);
3701 STAILQ_REMOVE_HEAD(rl, link);
3707 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3709 return (device_add_child_ordered(dev, order, name, unit));
3713 * @brief Helper function for implementing DEVICE_PROBE()
3715 * This function can be used to help implement the DEVICE_PROBE() for
3716 * a bus (i.e. a device which has other devices attached to it). It
3717 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3721 bus_generic_probe(device_t dev)
3723 devclass_t dc = dev->devclass;
3726 TAILQ_FOREACH(dl, &dc->drivers, link) {
3728 * If this driver's pass is too high, then ignore it.
3729 * For most drivers in the default pass, this will
3730 * never be true. For early-pass drivers they will
3731 * only call the identify routines of eligible drivers
3732 * when this routine is called. Drivers for later
3733 * passes should have their identify routines called
3734 * on early-pass buses during BUS_NEW_PASS().
3736 if (dl->pass > bus_current_pass)
3738 DEVICE_IDENTIFY(dl->driver, dev);
3745 * @brief Helper function for implementing DEVICE_ATTACH()
3747 * This function can be used to help implement the DEVICE_ATTACH() for
3748 * a bus. It calls device_probe_and_attach() for each of the device's
3752 bus_generic_attach(device_t dev)
3756 TAILQ_FOREACH(child, &dev->children, link) {
3757 device_probe_and_attach(child);
3764 * @brief Helper function for delaying attaching children
3766 * Many buses can't run transactions on the bus which children need to probe and
3767 * attach until after interrupts and/or timers are running. This function
3768 * delays their attach until interrupts and timers are enabled.
3771 bus_delayed_attach_children(device_t dev)
3773 /* Probe and attach the bus children when interrupts are available */
3774 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3780 * @brief Helper function for implementing DEVICE_DETACH()
3782 * This function can be used to help implement the DEVICE_DETACH() for
3783 * a bus. It calls device_detach() for each of the device's
3787 bus_generic_detach(device_t dev)
3792 if (dev->state != DS_ATTACHED)
3796 * Detach children in the reverse order.
3797 * See bus_generic_suspend for details.
3799 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3800 if ((error = device_detach(child)) != 0)
3808 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3810 * This function can be used to help implement the DEVICE_SHUTDOWN()
3811 * for a bus. It calls device_shutdown() for each of the device's
3815 bus_generic_shutdown(device_t dev)
3820 * Shut down children in the reverse order.
3821 * See bus_generic_suspend for details.
3823 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3824 device_shutdown(child);
3831 * @brief Default function for suspending a child device.
3833 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3836 bus_generic_suspend_child(device_t dev, device_t child)
3840 error = DEVICE_SUSPEND(child);
3843 child->flags |= DF_SUSPENDED;
3849 * @brief Default function for resuming a child device.
3851 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3854 bus_generic_resume_child(device_t dev, device_t child)
3856 DEVICE_RESUME(child);
3857 child->flags &= ~DF_SUSPENDED;
3863 * @brief Helper function for implementing DEVICE_SUSPEND()
3865 * This function can be used to help implement the DEVICE_SUSPEND()
3866 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3867 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3868 * operation is aborted and any devices which were suspended are
3869 * resumed immediately by calling their DEVICE_RESUME() methods.
3872 bus_generic_suspend(device_t dev)
3878 * Suspend children in the reverse order.
3879 * For most buses all children are equal, so the order does not matter.
3880 * Other buses, such as acpi, carefully order their child devices to
3881 * express implicit dependencies between them. For such buses it is
3882 * safer to bring down devices in the reverse order.
3884 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3885 error = BUS_SUSPEND_CHILD(dev, child);
3887 child = TAILQ_NEXT(child, link);
3888 if (child != NULL) {
3889 TAILQ_FOREACH_FROM(child, &dev->children, link)
3890 BUS_RESUME_CHILD(dev, child);
3899 * @brief Helper function for implementing DEVICE_RESUME()
3901 * This function can be used to help implement the DEVICE_RESUME() for
3902 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3905 bus_generic_resume(device_t dev)
3909 TAILQ_FOREACH(child, &dev->children, link) {
3910 BUS_RESUME_CHILD(dev, child);
3911 /* if resume fails, there's nothing we can usefully do... */
3917 * @brief Helper function for implementing BUS_RESET_POST
3919 * Bus can use this function to implement common operations of
3920 * re-attaching or resuming the children after the bus itself was
3921 * reset, and after restoring bus-unique state of children.
3923 * @param dev The bus
3924 * #param flags DEVF_RESET_*
3927 bus_helper_reset_post(device_t dev, int flags)
3933 TAILQ_FOREACH(child, &dev->children,link) {
3934 BUS_RESET_POST(dev, child);
3935 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3936 device_probe_and_attach(child) :
3937 BUS_RESUME_CHILD(dev, child);
3938 if (error == 0 && error1 != 0)
3945 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3947 child = TAILQ_NEXT(child, link);
3950 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3951 BUS_RESET_POST(dev, child);
3952 if ((flags & DEVF_RESET_DETACH) != 0)
3953 device_probe_and_attach(child);
3955 BUS_RESUME_CHILD(dev, child);
3960 * @brief Helper function for implementing BUS_RESET_PREPARE
3962 * Bus can use this function to implement common operations of
3963 * detaching or suspending the children before the bus itself is
3964 * reset, and then save bus-unique state of children that must
3965 * persists around reset.
3967 * @param dev The bus
3968 * #param flags DEVF_RESET_*
3971 bus_helper_reset_prepare(device_t dev, int flags)
3976 if (dev->state != DS_ATTACHED)
3979 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3980 if ((flags & DEVF_RESET_DETACH) != 0) {
3981 error = device_get_state(child) == DS_ATTACHED ?
3982 device_detach(child) : 0;
3984 error = BUS_SUSPEND_CHILD(dev, child);
3987 error = BUS_RESET_PREPARE(dev, child);
3989 if ((flags & DEVF_RESET_DETACH) != 0)
3990 device_probe_and_attach(child);
3992 BUS_RESUME_CHILD(dev, child);
3996 bus_helper_reset_prepare_rollback(dev, child, flags);
4004 * @brief Helper function for implementing BUS_PRINT_CHILD().
4006 * This function prints the first part of the ascii representation of
4007 * @p child, including its name, unit and description (if any - see
4008 * device_set_desc()).
4010 * @returns the number of characters printed
4013 bus_print_child_header(device_t dev, device_t child)
4017 if (device_get_desc(child)) {
4018 retval += device_printf(child, "<%s>", device_get_desc(child));
4020 retval += printf("%s", device_get_nameunit(child));
4027 * @brief Helper function for implementing BUS_PRINT_CHILD().
4029 * This function prints the last part of the ascii representation of
4030 * @p child, which consists of the string @c " on " followed by the
4031 * name and unit of the @p dev.
4033 * @returns the number of characters printed
4036 bus_print_child_footer(device_t dev, device_t child)
4038 return (printf(" on %s\n", device_get_nameunit(dev)));
4042 * @brief Helper function for implementing BUS_PRINT_CHILD().
4044 * This function prints out the VM domain for the given device.
4046 * @returns the number of characters printed
4049 bus_print_child_domain(device_t dev, device_t child)
4053 /* No domain? Don't print anything */
4054 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4057 return (printf(" numa-domain %d", domain));
4061 * @brief Helper function for implementing BUS_PRINT_CHILD().
4063 * This function simply calls bus_print_child_header() followed by
4064 * bus_print_child_footer().
4066 * @returns the number of characters printed
4069 bus_generic_print_child(device_t dev, device_t child)
4073 retval += bus_print_child_header(dev, child);
4074 retval += bus_print_child_domain(dev, child);
4075 retval += bus_print_child_footer(dev, child);
4081 * @brief Stub function for implementing BUS_READ_IVAR().
4086 bus_generic_read_ivar(device_t dev, device_t child, int index,
4093 * @brief Stub function for implementing BUS_WRITE_IVAR().
4098 bus_generic_write_ivar(device_t dev, device_t child, int index,
4105 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4109 struct resource_list *
4110 bus_generic_get_resource_list(device_t dev, device_t child)
4116 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4118 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4119 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4120 * and then calls device_probe_and_attach() for each unattached child.
4123 bus_generic_driver_added(device_t dev, driver_t *driver)
4127 DEVICE_IDENTIFY(driver, dev);
4128 TAILQ_FOREACH(child, &dev->children, link) {
4129 if (child->state == DS_NOTPRESENT)
4130 device_probe_and_attach(child);
4135 * @brief Helper function for implementing BUS_NEW_PASS().
4137 * This implementing of BUS_NEW_PASS() first calls the identify
4138 * routines for any drivers that probe at the current pass. Then it
4139 * walks the list of devices for this bus. If a device is already
4140 * attached, then it calls BUS_NEW_PASS() on that device. If the
4141 * device is not already attached, it attempts to attach a driver to
4145 bus_generic_new_pass(device_t dev)
4152 TAILQ_FOREACH(dl, &dc->drivers, link) {
4153 if (dl->pass == bus_current_pass)
4154 DEVICE_IDENTIFY(dl->driver, dev);
4156 TAILQ_FOREACH(child, &dev->children, link) {
4157 if (child->state >= DS_ATTACHED)
4158 BUS_NEW_PASS(child);
4159 else if (child->state == DS_NOTPRESENT)
4160 device_probe_and_attach(child);
4165 * @brief Helper function for implementing BUS_SETUP_INTR().
4167 * This simple implementation of BUS_SETUP_INTR() simply calls the
4168 * BUS_SETUP_INTR() method of the parent of @p dev.
4171 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4172 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4175 /* Propagate up the bus hierarchy until someone handles it. */
4177 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4178 filter, intr, arg, cookiep));
4183 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4185 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4186 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4189 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4192 /* Propagate up the bus hierarchy until someone handles it. */
4194 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4199 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4201 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4202 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4205 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4207 /* Propagate up the bus hierarchy until someone handles it. */
4209 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4214 * @brief Helper function for implementing BUS_RESUME_INTR().
4216 * This simple implementation of BUS_RESUME_INTR() simply calls the
4217 * BUS_RESUME_INTR() method of the parent of @p dev.
4220 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4222 /* Propagate up the bus hierarchy until someone handles it. */
4224 return (BUS_RESUME_INTR(dev->parent, child, irq));
4229 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4231 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4232 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4235 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4236 struct resource *r, rman_res_t start, rman_res_t end)
4238 /* Propagate up the bus hierarchy until someone handles it. */
4240 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4246 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4248 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4249 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4252 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4253 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4255 /* Propagate up the bus hierarchy until someone handles it. */
4257 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4258 start, end, count, flags));
4263 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4265 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4266 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4269 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4272 /* Propagate up the bus hierarchy until someone handles it. */
4274 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4280 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4282 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4283 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4286 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4289 /* Propagate up the bus hierarchy until someone handles it. */
4291 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4297 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4299 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4300 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4303 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4304 int rid, struct resource *r)
4306 /* Propagate up the bus hierarchy until someone handles it. */
4308 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4314 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4316 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4317 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4320 bus_generic_map_resource(device_t dev, device_t child, int type,
4321 struct resource *r, struct resource_map_request *args,
4322 struct resource_map *map)
4324 /* Propagate up the bus hierarchy until someone handles it. */
4326 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4332 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4334 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4335 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4338 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4339 struct resource *r, struct resource_map *map)
4341 /* Propagate up the bus hierarchy until someone handles it. */
4343 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4348 * @brief Helper function for implementing BUS_BIND_INTR().
4350 * This simple implementation of BUS_BIND_INTR() simply calls the
4351 * BUS_BIND_INTR() method of the parent of @p dev.
4354 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4357 /* Propagate up the bus hierarchy until someone handles it. */
4359 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4364 * @brief Helper function for implementing BUS_CONFIG_INTR().
4366 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4367 * BUS_CONFIG_INTR() method of the parent of @p dev.
4370 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4371 enum intr_polarity pol)
4373 /* Propagate up the bus hierarchy until someone handles it. */
4375 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4380 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4382 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4383 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4386 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4387 void *cookie, const char *descr)
4389 /* Propagate up the bus hierarchy until someone handles it. */
4391 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4397 * @brief Helper function for implementing BUS_GET_CPUS().
4399 * This simple implementation of BUS_GET_CPUS() simply calls the
4400 * BUS_GET_CPUS() method of the parent of @p dev.
4403 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4404 size_t setsize, cpuset_t *cpuset)
4406 /* Propagate up the bus hierarchy until someone handles it. */
4407 if (dev->parent != NULL)
4408 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4413 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4415 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4416 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4419 bus_generic_get_dma_tag(device_t dev, device_t child)
4421 /* Propagate up the bus hierarchy until someone handles it. */
4422 if (dev->parent != NULL)
4423 return (BUS_GET_DMA_TAG(dev->parent, child));
4428 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4430 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4431 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4434 bus_generic_get_bus_tag(device_t dev, device_t child)
4436 /* Propagate up the bus hierarchy until someone handles it. */
4437 if (dev->parent != NULL)
4438 return (BUS_GET_BUS_TAG(dev->parent, child));
4439 return ((bus_space_tag_t)0);
4443 * @brief Helper function for implementing BUS_GET_RESOURCE().
4445 * This implementation of BUS_GET_RESOURCE() uses the
4446 * resource_list_find() function to do most of the work. It calls
4447 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4451 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4452 rman_res_t *startp, rman_res_t *countp)
4454 struct resource_list * rl = NULL;
4455 struct resource_list_entry * rle = NULL;
4457 rl = BUS_GET_RESOURCE_LIST(dev, child);
4461 rle = resource_list_find(rl, type, rid);
4466 *startp = rle->start;
4468 *countp = rle->count;
4474 * @brief Helper function for implementing BUS_SET_RESOURCE().
4476 * This implementation of BUS_SET_RESOURCE() uses the
4477 * resource_list_add() function to do most of the work. It calls
4478 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4482 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4483 rman_res_t start, rman_res_t count)
4485 struct resource_list * rl = NULL;
4487 rl = BUS_GET_RESOURCE_LIST(dev, child);
4491 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4497 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4499 * This implementation of BUS_DELETE_RESOURCE() uses the
4500 * resource_list_delete() function to do most of the work. It calls
4501 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4505 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4507 struct resource_list * rl = NULL;
4509 rl = BUS_GET_RESOURCE_LIST(dev, child);
4513 resource_list_delete(rl, type, rid);
4519 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4521 * This implementation of BUS_RELEASE_RESOURCE() uses the
4522 * resource_list_release() function to do most of the work. It calls
4523 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4526 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4527 int rid, struct resource *r)
4529 struct resource_list * rl = NULL;
4531 if (device_get_parent(child) != dev)
4532 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4535 rl = BUS_GET_RESOURCE_LIST(dev, child);
4539 return (resource_list_release(rl, dev, child, type, rid, r));
4543 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4545 * This implementation of BUS_ALLOC_RESOURCE() uses the
4546 * resource_list_alloc() function to do most of the work. It calls
4547 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4550 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4551 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4553 struct resource_list * rl = NULL;
4555 if (device_get_parent(child) != dev)
4556 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4557 type, rid, start, end, count, flags));
4559 rl = BUS_GET_RESOURCE_LIST(dev, child);
4563 return (resource_list_alloc(rl, dev, child, type, rid,
4564 start, end, count, flags));
4568 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4570 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4571 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4574 bus_generic_child_present(device_t dev, device_t child)
4576 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4580 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4583 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4589 * @brief Helper function for implementing BUS_RESCAN().
4591 * This null implementation of BUS_RESCAN() always fails to indicate
4592 * the bus does not support rescanning.
4595 bus_null_rescan(device_t dev)
4601 * Some convenience functions to make it easier for drivers to use the
4602 * resource-management functions. All these really do is hide the
4603 * indirection through the parent's method table, making for slightly
4604 * less-wordy code. In the future, it might make sense for this code
4605 * to maintain some sort of a list of resources allocated by each device.
4609 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4610 struct resource **res)
4614 for (i = 0; rs[i].type != -1; i++)
4616 for (i = 0; rs[i].type != -1; i++) {
4617 res[i] = bus_alloc_resource_any(dev,
4618 rs[i].type, &rs[i].rid, rs[i].flags);
4619 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4620 bus_release_resources(dev, rs, res);
4628 bus_release_resources(device_t dev, const struct resource_spec *rs,
4629 struct resource **res)
4633 for (i = 0; rs[i].type != -1; i++)
4634 if (res[i] != NULL) {
4635 bus_release_resource(
4636 dev, rs[i].type, rs[i].rid, res[i]);
4642 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4644 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4648 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4649 rman_res_t end, rman_res_t count, u_int flags)
4651 struct resource *res;
4653 if (dev->parent == NULL)
4655 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4661 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4663 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4667 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4670 if (dev->parent == NULL)
4672 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4676 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4678 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4682 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4684 if (dev->parent == NULL)
4686 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4690 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4692 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4696 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4698 if (dev->parent == NULL)
4700 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4704 * @brief Wrapper function for BUS_MAP_RESOURCE().
4706 * This function simply calls the BUS_MAP_RESOURCE() method of the
4710 bus_map_resource(device_t dev, int type, struct resource *r,
4711 struct resource_map_request *args, struct resource_map *map)
4713 if (dev->parent == NULL)
4715 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4719 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4721 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4725 bus_unmap_resource(device_t dev, int type, struct resource *r,
4726 struct resource_map *map)
4728 if (dev->parent == NULL)
4730 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4734 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4736 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4740 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4744 if (dev->parent == NULL)
4746 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4751 * @brief Wrapper function for BUS_SETUP_INTR().
4753 * This function simply calls the BUS_SETUP_INTR() method of the
4757 bus_setup_intr(device_t dev, struct resource *r, int flags,
4758 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4762 if (dev->parent == NULL)
4764 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4768 if (handler != NULL && !(flags & INTR_MPSAFE))
4769 device_printf(dev, "[GIANT-LOCKED]\n");
4774 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4776 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4780 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4782 if (dev->parent == NULL)
4784 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4788 * @brief Wrapper function for BUS_SUSPEND_INTR().
4790 * This function simply calls the BUS_SUSPEND_INTR() method of the
4794 bus_suspend_intr(device_t dev, struct resource *r)
4796 if (dev->parent == NULL)
4798 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4802 * @brief Wrapper function for BUS_RESUME_INTR().
4804 * This function simply calls the BUS_RESUME_INTR() method of the
4808 bus_resume_intr(device_t dev, struct resource *r)
4810 if (dev->parent == NULL)
4812 return (BUS_RESUME_INTR(dev->parent, dev, r));
4816 * @brief Wrapper function for BUS_BIND_INTR().
4818 * This function simply calls the BUS_BIND_INTR() method of the
4822 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4824 if (dev->parent == NULL)
4826 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4830 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4832 * This function first formats the requested description into a
4833 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4834 * the parent of @p dev.
4837 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4838 const char *fmt, ...)
4841 char descr[MAXCOMLEN + 1];
4843 if (dev->parent == NULL)
4846 vsnprintf(descr, sizeof(descr), fmt, ap);
4848 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4852 * @brief Wrapper function for BUS_SET_RESOURCE().
4854 * This function simply calls the BUS_SET_RESOURCE() method of the
4858 bus_set_resource(device_t dev, int type, int rid,
4859 rman_res_t start, rman_res_t count)
4861 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4866 * @brief Wrapper function for BUS_GET_RESOURCE().
4868 * This function simply calls the BUS_GET_RESOURCE() method of the
4872 bus_get_resource(device_t dev, int type, int rid,
4873 rman_res_t *startp, rman_res_t *countp)
4875 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4880 * @brief Wrapper function for BUS_GET_RESOURCE().
4882 * This function simply calls the BUS_GET_RESOURCE() method of the
4883 * parent of @p dev and returns the start value.
4886 bus_get_resource_start(device_t dev, int type, int rid)
4892 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4900 * @brief Wrapper function for BUS_GET_RESOURCE().
4902 * This function simply calls the BUS_GET_RESOURCE() method of the
4903 * parent of @p dev and returns the count value.
4906 bus_get_resource_count(device_t dev, int type, int rid)
4912 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4920 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4922 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4926 bus_delete_resource(device_t dev, int type, int rid)
4928 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4932 * @brief Wrapper function for BUS_CHILD_PRESENT().
4934 * This function simply calls the BUS_CHILD_PRESENT() method of the
4938 bus_child_present(device_t child)
4940 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4944 * @brief Wrapper function for BUS_CHILD_PNPINFO().
4946 * This function simply calls the BUS_CHILD_PNPINFO() method of the parent of @p
4950 bus_child_pnpinfo(device_t child, struct sbuf *sb)
4954 parent = device_get_parent(child);
4957 return (BUS_CHILD_PNPINFO(parent, child, sb));
4961 * @brief Generic implementation that does nothing for bus_child_pnpinfo
4963 * This function has the right signature and returns 0 since the sbuf is passed
4964 * to us to append to.
4967 bus_generic_child_pnpinfo(device_t dev, device_t child, struct sbuf *sb)
4973 * @brief Wrapper function for BUS_CHILD_LOCATION().
4975 * This function simply calls the BUS_CHILD_LOCATION() method of the parent of
4979 bus_child_location(device_t child, struct sbuf *sb)
4983 parent = device_get_parent(child);
4986 return (BUS_CHILD_LOCATION(parent, child, sb));
4990 * @brief Generic implementation that does nothing for bus_child_location
4992 * This function has the right signature and returns 0 since the sbuf is passed
4993 * to us to append to.
4996 bus_generic_child_location(device_t dev, device_t child, struct sbuf *sb)
5002 * @brief Wrapper function for BUS_GET_CPUS().
5004 * This function simply calls the BUS_GET_CPUS() method of the
5008 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5012 parent = device_get_parent(dev);
5015 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5019 * @brief Wrapper function for BUS_GET_DMA_TAG().
5021 * This function simply calls the BUS_GET_DMA_TAG() method of the
5025 bus_get_dma_tag(device_t dev)
5029 parent = device_get_parent(dev);
5032 return (BUS_GET_DMA_TAG(parent, dev));
5036 * @brief Wrapper function for BUS_GET_BUS_TAG().
5038 * This function simply calls the BUS_GET_BUS_TAG() method of the
5042 bus_get_bus_tag(device_t dev)
5046 parent = device_get_parent(dev);
5048 return ((bus_space_tag_t)0);
5049 return (BUS_GET_BUS_TAG(parent, dev));
5053 * @brief Wrapper function for BUS_GET_DOMAIN().
5055 * This function simply calls the BUS_GET_DOMAIN() method of the
5059 bus_get_domain(device_t dev, int *domain)
5061 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5064 /* Resume all devices and then notify userland that we're up again. */
5066 root_resume(device_t dev)
5070 error = bus_generic_resume(dev);
5072 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5073 devctl_notify("kernel", "power", "resume", NULL);
5079 root_print_child(device_t dev, device_t child)
5083 retval += bus_print_child_header(dev, child);
5084 retval += printf("\n");
5090 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5091 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5094 * If an interrupt mapping gets to here something bad has happened.
5096 panic("root_setup_intr");
5100 * If we get here, assume that the device is permanent and really is
5101 * present in the system. Removable bus drivers are expected to intercept
5102 * this call long before it gets here. We return -1 so that drivers that
5103 * really care can check vs -1 or some ERRNO returned higher in the food
5107 root_child_present(device_t dev, device_t child)
5113 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5118 /* Default to returning the set of all CPUs. */
5119 if (setsize != sizeof(cpuset_t))
5128 static kobj_method_t root_methods[] = {
5129 /* Device interface */
5130 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5131 KOBJMETHOD(device_suspend, bus_generic_suspend),
5132 KOBJMETHOD(device_resume, root_resume),
5135 KOBJMETHOD(bus_print_child, root_print_child),
5136 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5137 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5138 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5139 KOBJMETHOD(bus_child_present, root_child_present),
5140 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5145 static driver_t root_driver = {
5152 devclass_t root_devclass;
5155 root_bus_module_handler(module_t mod, int what, void* arg)
5159 TAILQ_INIT(&bus_data_devices);
5160 kobj_class_compile((kobj_class_t) &root_driver);
5161 root_bus = make_device(NULL, "root", 0);
5162 root_bus->desc = "System root bus";
5163 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5164 root_bus->driver = &root_driver;
5165 root_bus->state = DS_ATTACHED;
5166 root_devclass = devclass_find_internal("root", NULL, FALSE);
5171 device_shutdown(root_bus);
5174 return (EOPNOTSUPP);
5180 static moduledata_t root_bus_mod = {
5182 root_bus_module_handler,
5185 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5188 * @brief Automatically configure devices
5190 * This function begins the autoconfiguration process by calling
5191 * device_probe_and_attach() for each child of the @c root0 device.
5194 root_bus_configure(void)
5198 /* Eventually this will be split up, but this is sufficient for now. */
5199 bus_set_pass(BUS_PASS_DEFAULT);
5203 * @brief Module handler for registering device drivers
5205 * This module handler is used to automatically register device
5206 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5207 * devclass_add_driver() for the driver described by the
5208 * driver_module_data structure pointed to by @p arg
5211 driver_module_handler(module_t mod, int what, void *arg)
5213 struct driver_module_data *dmd;
5214 devclass_t bus_devclass;
5215 kobj_class_t driver;
5218 dmd = (struct driver_module_data *)arg;
5219 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5224 if (dmd->dmd_chainevh)
5225 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5227 pass = dmd->dmd_pass;
5228 driver = dmd->dmd_driver;
5229 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5230 DRIVERNAME(driver), dmd->dmd_busname, pass));
5231 error = devclass_add_driver(bus_devclass, driver, pass,
5236 PDEBUG(("Unloading module: driver %s from bus %s",
5237 DRIVERNAME(dmd->dmd_driver),
5239 error = devclass_delete_driver(bus_devclass,
5242 if (!error && dmd->dmd_chainevh)
5243 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5246 PDEBUG(("Quiesce module: driver %s from bus %s",
5247 DRIVERNAME(dmd->dmd_driver),
5249 error = devclass_quiesce_driver(bus_devclass,
5252 if (!error && dmd->dmd_chainevh)
5253 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5264 * @brief Enumerate all hinted devices for this bus.
5266 * Walks through the hints for this bus and calls the bus_hinted_child
5267 * routine for each one it fines. It searches first for the specific
5268 * bus that's being probed for hinted children (eg isa0), and then for
5269 * generic children (eg isa).
5271 * @param dev bus device to enumerate
5274 bus_enumerate_hinted_children(device_t bus)
5277 const char *dname, *busname;
5281 * enumerate all devices on the specific bus
5283 busname = device_get_nameunit(bus);
5285 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5286 BUS_HINTED_CHILD(bus, dname, dunit);
5289 * and all the generic ones.
5291 busname = device_get_name(bus);
5293 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5294 BUS_HINTED_CHILD(bus, dname, dunit);
5299 /* the _short versions avoid iteration by not calling anything that prints
5300 * more than oneliners. I love oneliners.
5304 print_device_short(device_t dev, int indent)
5309 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5310 dev->unit, dev->desc,
5311 (dev->parent? "":"no "),
5312 (TAILQ_EMPTY(&dev->children)? "no ":""),
5313 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5314 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5315 (dev->flags&DF_WILDCARD? "wildcard,":""),
5316 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5317 (dev->flags&DF_SUSPENDED? "suspended,":""),
5318 (dev->ivars? "":"no "),
5319 (dev->softc? "":"no "),
5324 print_device(device_t dev, int indent)
5329 print_device_short(dev, indent);
5331 indentprintf(("Parent:\n"));
5332 print_device_short(dev->parent, indent+1);
5333 indentprintf(("Driver:\n"));
5334 print_driver_short(dev->driver, indent+1);
5335 indentprintf(("Devclass:\n"));
5336 print_devclass_short(dev->devclass, indent+1);
5340 print_device_tree_short(device_t dev, int indent)
5341 /* print the device and all its children (indented) */
5348 print_device_short(dev, indent);
5350 TAILQ_FOREACH(child, &dev->children, link) {
5351 print_device_tree_short(child, indent+1);
5356 print_device_tree(device_t dev, int indent)
5357 /* print the device and all its children (indented) */
5364 print_device(dev, indent);
5366 TAILQ_FOREACH(child, &dev->children, link) {
5367 print_device_tree(child, indent+1);
5372 print_driver_short(driver_t *driver, int indent)
5377 indentprintf(("driver %s: softc size = %zd\n",
5378 driver->name, driver->size));
5382 print_driver(driver_t *driver, int indent)
5387 print_driver_short(driver, indent);
5391 print_driver_list(driver_list_t drivers, int indent)
5393 driverlink_t driver;
5395 TAILQ_FOREACH(driver, &drivers, link) {
5396 print_driver(driver->driver, indent);
5401 print_devclass_short(devclass_t dc, int indent)
5406 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5410 print_devclass(devclass_t dc, int indent)
5417 print_devclass_short(dc, indent);
5418 indentprintf(("Drivers:\n"));
5419 print_driver_list(dc->drivers, indent+1);
5421 indentprintf(("Devices:\n"));
5422 for (i = 0; i < dc->maxunit; i++)
5424 print_device(dc->devices[i], indent+1);
5428 print_devclass_list_short(void)
5432 printf("Short listing of devclasses, drivers & devices:\n");
5433 TAILQ_FOREACH(dc, &devclasses, link) {
5434 print_devclass_short(dc, 0);
5439 print_devclass_list(void)
5443 printf("Full listing of devclasses, drivers & devices:\n");
5444 TAILQ_FOREACH(dc, &devclasses, link) {
5445 print_devclass(dc, 0);
5452 * User-space access to the device tree.
5454 * We implement a small set of nodes:
5456 * hw.bus Single integer read method to obtain the
5457 * current generation count.
5458 * hw.bus.devices Reads the entire device tree in flat space.
5459 * hw.bus.rman Resource manager interface
5461 * We might like to add the ability to scan devclasses and/or drivers to
5462 * determine what else is currently loaded/available.
5466 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5468 struct u_businfo ubus;
5470 ubus.ub_version = BUS_USER_VERSION;
5471 ubus.ub_generation = bus_data_generation;
5473 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5475 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5476 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5477 "bus-related data");
5480 sysctl_devices(SYSCTL_HANDLER_ARGS)
5483 int *name = (int *)arg1;
5484 u_int namelen = arg2;
5487 struct u_device *udev;
5493 if (bus_data_generation_check(name[0]))
5499 * Scan the list of devices, looking for the requested index.
5501 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5509 * Populate the return item, careful not to overflow the buffer.
5511 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5514 udev->dv_handle = (uintptr_t)dev;
5515 udev->dv_parent = (uintptr_t)dev->parent;
5516 udev->dv_devflags = dev->devflags;
5517 udev->dv_flags = dev->flags;
5518 udev->dv_state = dev->state;
5519 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5520 if (dev->nameunit != NULL)
5521 sbuf_cat(&sb, dev->nameunit);
5522 sbuf_putc(&sb, '\0');
5523 if (dev->desc != NULL)
5524 sbuf_cat(&sb, dev->desc);
5525 sbuf_putc(&sb, '\0');
5526 if (dev->driver != NULL)
5527 sbuf_cat(&sb, dev->driver->name);
5528 sbuf_putc(&sb, '\0');
5529 bus_child_pnpinfo(dev, &sb);
5530 sbuf_putc(&sb, '\0');
5531 bus_child_location(dev, &sb);
5532 sbuf_putc(&sb, '\0');
5533 error = sbuf_finish(&sb);
5535 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5541 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5542 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5543 "system device tree");
5546 bus_data_generation_check(int generation)
5548 if (generation != bus_data_generation)
5551 /* XXX generate optimised lists here? */
5556 bus_data_generation_update(void)
5558 atomic_add_int(&bus_data_generation, 1);
5562 bus_free_resource(device_t dev, int type, struct resource *r)
5566 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5570 device_lookup_by_name(const char *name)
5574 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5575 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5582 * /dev/devctl2 implementation. The existing /dev/devctl device has
5583 * implicit semantics on open, so it could not be reused for this.
5584 * Another option would be to call this /dev/bus?
5587 find_device(struct devreq *req, device_t *devp)
5592 * First, ensure that the name is nul terminated.
5594 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5598 * Second, try to find an attached device whose name matches
5601 dev = device_lookup_by_name(req->dr_name);
5607 /* Finally, give device enumerators a chance. */
5609 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5617 driver_exists(device_t bus, const char *driver)
5621 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5622 if (devclass_find_driver_internal(dc, driver) != NULL)
5629 device_gen_nomatch(device_t dev)
5633 if (dev->flags & DF_NEEDNOMATCH &&
5634 dev->state == DS_NOTPRESENT) {
5635 BUS_PROBE_NOMATCH(dev->parent, dev);
5637 dev->flags |= DF_DONENOMATCH;
5639 dev->flags &= ~DF_NEEDNOMATCH;
5640 TAILQ_FOREACH(child, &dev->children, link) {
5641 device_gen_nomatch(child);
5646 device_do_deferred_actions(void)
5652 * Walk through the devclasses to find all the drivers we've tagged as
5653 * deferred during the freeze and call the driver added routines. They
5654 * have already been added to the lists in the background, so the driver
5655 * added routines that trigger a probe will have all the right bidders
5656 * for the probe auction.
5658 TAILQ_FOREACH(dc, &devclasses, link) {
5659 TAILQ_FOREACH(dl, &dc->drivers, link) {
5660 if (dl->flags & DL_DEFERRED_PROBE) {
5661 devclass_driver_added(dc, dl->driver);
5662 dl->flags &= ~DL_DEFERRED_PROBE;
5668 * We also defer no-match events during a freeze. Walk the tree and
5669 * generate all the pent-up events that are still relevant.
5671 device_gen_nomatch(root_bus);
5672 bus_data_generation_update();
5676 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5683 /* Locate the device to control. */
5685 req = (struct devreq *)data;
5693 case DEV_SET_DRIVER:
5694 case DEV_CLEAR_DRIVER:
5698 error = priv_check(td, PRIV_DRIVER);
5700 error = find_device(req, &dev);
5704 error = priv_check(td, PRIV_DRIVER);
5715 /* Perform the requested operation. */
5718 if (device_is_attached(dev))
5720 else if (!device_is_enabled(dev))
5723 error = device_probe_and_attach(dev);
5726 if (!device_is_attached(dev)) {
5730 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5731 error = device_quiesce(dev);
5735 error = device_detach(dev);
5738 if (device_is_enabled(dev)) {
5744 * If the device has been probed but not attached (e.g.
5745 * when it has been disabled by a loader hint), just
5746 * attach the device rather than doing a full probe.
5749 if (device_is_alive(dev)) {
5751 * If the device was disabled via a hint, clear
5754 if (resource_disabled(dev->driver->name, dev->unit))
5755 resource_unset_value(dev->driver->name,
5756 dev->unit, "disabled");
5757 error = device_attach(dev);
5759 error = device_probe_and_attach(dev);
5762 if (!device_is_enabled(dev)) {
5767 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5768 error = device_quiesce(dev);
5774 * Force DF_FIXEDCLASS on around detach to preserve
5775 * the existing name.
5778 dev->flags |= DF_FIXEDCLASS;
5779 error = device_detach(dev);
5780 if (!(old & DF_FIXEDCLASS))
5781 dev->flags &= ~DF_FIXEDCLASS;
5783 device_disable(dev);
5786 if (device_is_suspended(dev)) {
5790 if (device_get_parent(dev) == NULL) {
5794 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5797 if (!device_is_suspended(dev)) {
5801 if (device_get_parent(dev) == NULL) {
5805 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5807 case DEV_SET_DRIVER: {
5811 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5814 if (driver[0] == '\0') {
5818 if (dev->devclass != NULL &&
5819 strcmp(driver, dev->devclass->name) == 0)
5820 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5824 * Scan drivers for this device's bus looking for at
5825 * least one matching driver.
5827 if (dev->parent == NULL) {
5831 if (!driver_exists(dev->parent, driver)) {
5835 dc = devclass_create(driver);
5841 /* Detach device if necessary. */
5842 if (device_is_attached(dev)) {
5843 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5844 error = device_detach(dev);
5851 /* Clear any previously-fixed device class and unit. */
5852 if (dev->flags & DF_FIXEDCLASS)
5853 devclass_delete_device(dev->devclass, dev);
5854 dev->flags |= DF_WILDCARD;
5857 /* Force the new device class. */
5858 error = devclass_add_device(dc, dev);
5861 dev->flags |= DF_FIXEDCLASS;
5862 error = device_probe_and_attach(dev);
5865 case DEV_CLEAR_DRIVER:
5866 if (!(dev->flags & DF_FIXEDCLASS)) {
5870 if (device_is_attached(dev)) {
5871 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5872 error = device_detach(dev);
5879 dev->flags &= ~DF_FIXEDCLASS;
5880 dev->flags |= DF_WILDCARD;
5881 devclass_delete_device(dev->devclass, dev);
5882 error = device_probe_and_attach(dev);
5885 if (!device_is_attached(dev)) {
5889 error = BUS_RESCAN(dev);
5894 parent = device_get_parent(dev);
5895 if (parent == NULL) {
5899 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5900 if (bus_child_present(dev) != 0) {
5906 error = device_delete_child(parent, dev);
5913 device_frozen = true;
5919 device_do_deferred_actions();
5920 device_frozen = false;
5924 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5928 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5936 static struct cdevsw devctl2_cdevsw = {
5937 .d_version = D_VERSION,
5938 .d_ioctl = devctl2_ioctl,
5939 .d_name = "devctl2",
5945 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5946 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5950 * APIs to manage deprecation and obsolescence.
5952 static int obsolete_panic = 0;
5953 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5954 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5955 "2 = if deprecated)");
5958 gone_panic(int major, int running, const char *msg)
5960 switch (obsolete_panic)
5965 if (running < major)
5974 _gone_in(int major, const char *msg)
5976 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5977 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5978 printf("Obsolete code will be removed soon: %s\n", msg);
5980 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5985 _gone_in_dev(device_t dev, int major, const char *msg)
5987 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5988 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5990 "Obsolete code will be removed soon: %s\n", msg);
5993 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5998 DB_SHOW_COMMAND(device, db_show_device)
6005 dev = (device_t)addr;
6007 db_printf("name: %s\n", device_get_nameunit(dev));
6008 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6009 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6010 db_printf(" addr: %p\n", dev);
6011 db_printf(" parent: %p\n", dev->parent);
6012 db_printf(" softc: %p\n", dev->softc);
6013 db_printf(" ivars: %p\n", dev->ivars);
6016 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6020 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6021 db_show_device((db_expr_t)dev, true, count, modif);