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>
54 #include <sys/refcount.h>
57 #include <sys/selinfo.h>
58 #include <sys/signalvar.h>
60 #include <sys/sysctl.h>
61 #include <sys/systm.h>
64 #include <sys/cpuset.h>
68 #include <machine/cpu.h>
69 #include <machine/stdarg.h>
76 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
78 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
82 * Used to attach drivers to devclasses.
84 typedef struct driverlink *driverlink_t;
87 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
90 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
91 TAILQ_ENTRY(driverlink) passlink;
95 * Forward declarations
97 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
98 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
99 typedef TAILQ_HEAD(device_list, _device) device_list_t;
102 TAILQ_ENTRY(devclass) link;
103 devclass_t parent; /* parent in devclass hierarchy */
104 driver_list_t drivers; /* bus devclasses store drivers for bus */
106 device_t *devices; /* array of devices indexed by unit */
107 int maxunit; /* size of devices array */
109 #define DC_HAS_CHILDREN 1
111 struct sysctl_ctx_list sysctl_ctx;
112 struct sysctl_oid *sysctl_tree;
116 * @brief Implementation of _device.
118 * The structure is named "_device" instead of "device" to avoid type confusion
119 * caused by other subsystems defining a (struct device).
123 * A device is a kernel object. The first field must be the
124 * current ops table for the object.
131 TAILQ_ENTRY(_device) link; /**< list of devices in parent */
132 TAILQ_ENTRY(_device) devlink; /**< global device list membership */
133 device_t parent; /**< parent of this device */
134 device_list_t children; /**< list of child devices */
137 * Details of this device.
139 driver_t *driver; /**< current driver */
140 devclass_t devclass; /**< current device class */
141 int unit; /**< current unit number */
142 char* nameunit; /**< name+unit e.g. foodev0 */
143 char* desc; /**< driver specific description */
144 u_int busy; /**< count of calls to device_busy() */
145 device_state_t state; /**< current device state */
146 uint32_t devflags; /**< api level flags for device_get_flags() */
147 u_int flags; /**< internal device flags */
148 u_int order; /**< order from device_add_child_ordered() */
149 void *ivars; /**< instance variables */
150 void *softc; /**< current driver's variables */
152 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
153 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
156 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
157 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
159 EVENTHANDLER_LIST_DEFINE(device_attach);
160 EVENTHANDLER_LIST_DEFINE(device_detach);
161 EVENTHANDLER_LIST_DEFINE(dev_lookup);
163 static void devctl2_init(void);
164 static bool device_frozen;
166 #define DRIVERNAME(d) ((d)? d->name : "no driver")
167 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
171 static int bus_debug = 1;
172 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
174 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
175 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
178 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
179 * prevent syslog from deleting initial spaces
181 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
183 static void print_device_short(device_t dev, int indent);
184 static void print_device(device_t dev, int indent);
185 void print_device_tree_short(device_t dev, int indent);
186 void print_device_tree(device_t dev, int indent);
187 static void print_driver_short(driver_t *driver, int indent);
188 static void print_driver(driver_t *driver, int indent);
189 static void print_driver_list(driver_list_t drivers, int indent);
190 static void print_devclass_short(devclass_t dc, int indent);
191 static void print_devclass(devclass_t dc, int indent);
192 void print_devclass_list_short(void);
193 void print_devclass_list(void);
196 /* Make the compiler ignore the function calls */
197 #define PDEBUG(a) /* nop */
198 #define DEVICENAME(d) /* nop */
200 #define print_device_short(d,i) /* nop */
201 #define print_device(d,i) /* nop */
202 #define print_device_tree_short(d,i) /* nop */
203 #define print_device_tree(d,i) /* nop */
204 #define print_driver_short(d,i) /* nop */
205 #define print_driver(d,i) /* nop */
206 #define print_driver_list(d,i) /* nop */
207 #define print_devclass_short(d,i) /* nop */
208 #define print_devclass(d,i) /* nop */
209 #define print_devclass_list_short() /* nop */
210 #define print_devclass_list() /* nop */
218 DEVCLASS_SYSCTL_PARENT,
222 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
224 devclass_t dc = (devclass_t)arg1;
228 case DEVCLASS_SYSCTL_PARENT:
229 value = dc->parent ? dc->parent->name : "";
234 return (SYSCTL_OUT_STR(req, value));
238 devclass_sysctl_init(devclass_t dc)
240 if (dc->sysctl_tree != NULL)
242 sysctl_ctx_init(&dc->sysctl_ctx);
243 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
244 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
245 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
246 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
248 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
249 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
255 DEVICE_SYSCTL_DRIVER,
256 DEVICE_SYSCTL_LOCATION,
257 DEVICE_SYSCTL_PNPINFO,
258 DEVICE_SYSCTL_PARENT,
262 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
265 device_t dev = (device_t)arg1;
268 sbuf_new_for_sysctl(&sb, NULL, 1024, req);
269 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
272 case DEVICE_SYSCTL_DESC:
273 sbuf_cat(&sb, dev->desc ? dev->desc : "");
275 case DEVICE_SYSCTL_DRIVER:
276 sbuf_cat(&sb, dev->driver ? dev->driver->name : "");
278 case DEVICE_SYSCTL_LOCATION:
279 bus_child_location(dev, &sb);
281 case DEVICE_SYSCTL_PNPINFO:
282 bus_child_pnpinfo(dev, &sb);
284 case DEVICE_SYSCTL_PARENT:
285 sbuf_cat(&sb, dev->parent ? dev->parent->nameunit : "");
291 error = sbuf_finish(&sb);
299 device_sysctl_init(device_t dev)
301 devclass_t dc = dev->devclass;
304 if (dev->sysctl_tree != NULL)
306 devclass_sysctl_init(dc);
307 sysctl_ctx_init(&dev->sysctl_ctx);
308 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
309 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
310 dev->nameunit + strlen(dc->name),
311 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
312 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
313 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
314 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
315 "device description");
316 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
319 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
320 "device driver name");
321 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
322 OID_AUTO, "%location",
323 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
324 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
325 "device location relative to parent");
326 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
327 OID_AUTO, "%pnpinfo",
328 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
329 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
330 "device identification");
331 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
333 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
334 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
336 if (bus_get_domain(dev, &domain) == 0)
337 SYSCTL_ADD_INT(&dev->sysctl_ctx,
338 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
339 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, domain, "NUMA domain");
343 device_sysctl_update(device_t dev)
345 devclass_t dc = dev->devclass;
347 if (dev->sysctl_tree == NULL)
349 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
353 device_sysctl_fini(device_t dev)
355 if (dev->sysctl_tree == NULL)
357 sysctl_ctx_free(&dev->sysctl_ctx);
358 dev->sysctl_tree = NULL;
362 * /dev/devctl implementation
366 * This design allows only one reader for /dev/devctl. This is not desirable
367 * in the long run, but will get a lot of hair out of this implementation.
368 * Maybe we should make this device a clonable device.
370 * Also note: we specifically do not attach a device to the device_t tree
371 * to avoid potential chicken and egg problems. One could argue that all
372 * of this belongs to the root node.
375 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
376 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
377 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
378 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
379 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
381 static d_open_t devopen;
382 static d_close_t devclose;
383 static d_read_t devread;
384 static d_ioctl_t devioctl;
385 static d_poll_t devpoll;
386 static d_kqfilter_t devkqfilter;
388 static struct cdevsw dev_cdevsw = {
389 .d_version = D_VERSION,
395 .d_kqfilter = devkqfilter,
399 #define DEVCTL_BUFFER (1024 - sizeof(void *))
400 struct dev_event_info {
401 STAILQ_ENTRY(dev_event_info) dei_link;
402 char dei_data[DEVCTL_BUFFER];
405 STAILQ_HEAD(devq, dev_event_info);
407 static struct dev_softc {
420 static void filt_devctl_detach(struct knote *kn);
421 static int filt_devctl_read(struct knote *kn, long hint);
423 struct filterops devctl_rfiltops = {
425 .f_detach = filt_devctl_detach,
426 .f_event = filt_devctl_read,
429 static struct cdev *devctl_dev;
437 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
438 UID_ROOT, GID_WHEEL, 0600, "devctl");
439 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
440 cv_init(&devsoftc.cv, "dev cv");
441 STAILQ_INIT(&devsoftc.devq);
442 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
443 if (devctl_queue_length > 0) {
445 * Allocate a zone for the messages. Preallocate 2% of these for
446 * a reserve. Allow only devctl_queue_length slabs to cap memory
447 * usage. The reserve usually allows coverage of surges of
448 * events during memory shortages. Normally we won't have to
449 * re-use events from the queue, but will in extreme shortages.
451 z = devsoftc.zone = uma_zcreate("DEVCTL",
452 sizeof(struct dev_event_info), NULL, NULL, NULL, NULL,
454 reserve = max(devctl_queue_length / 50, 100); /* 2% reserve */
455 uma_zone_set_max(z, devctl_queue_length);
456 uma_zone_set_maxcache(z, 0);
457 uma_zone_reserve(z, reserve);
458 uma_prealloc(z, reserve);
464 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
466 mtx_lock(&devsoftc.mtx);
467 if (devsoftc.inuse) {
468 mtx_unlock(&devsoftc.mtx);
473 mtx_unlock(&devsoftc.mtx);
478 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
480 mtx_lock(&devsoftc.mtx);
482 devsoftc.nonblock = 0;
484 cv_broadcast(&devsoftc.cv);
485 funsetown(&devsoftc.sigio);
486 mtx_unlock(&devsoftc.mtx);
491 * The read channel for this device is used to report changes to
492 * userland in realtime. We are required to free the data as well as
493 * the n1 object because we allocate them separately. Also note that
494 * we return one record at a time. If you try to read this device a
495 * character at a time, you will lose the rest of the data. Listening
496 * programs are expected to cope.
499 devread(struct cdev *dev, struct uio *uio, int ioflag)
501 struct dev_event_info *n1;
504 mtx_lock(&devsoftc.mtx);
505 while (STAILQ_EMPTY(&devsoftc.devq)) {
506 if (devsoftc.nonblock) {
507 mtx_unlock(&devsoftc.mtx);
510 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
513 * Need to translate ERESTART to EINTR here? -- jake
515 mtx_unlock(&devsoftc.mtx);
519 n1 = STAILQ_FIRST(&devsoftc.devq);
520 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
522 mtx_unlock(&devsoftc.mtx);
523 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
524 uma_zfree(devsoftc.zone, n1);
529 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
534 devsoftc.nonblock = 1;
536 devsoftc.nonblock = 0;
545 return fsetown(*(int *)data, &devsoftc.sigio);
547 *(int *)data = fgetown(&devsoftc.sigio);
550 /* (un)Support for other fcntl() calls. */
561 devpoll(struct cdev *dev, int events, struct thread *td)
565 mtx_lock(&devsoftc.mtx);
566 if (events & (POLLIN | POLLRDNORM)) {
567 if (!STAILQ_EMPTY(&devsoftc.devq))
568 revents = events & (POLLIN | POLLRDNORM);
570 selrecord(td, &devsoftc.sel);
572 mtx_unlock(&devsoftc.mtx);
578 devkqfilter(struct cdev *dev, struct knote *kn)
582 if (kn->kn_filter == EVFILT_READ) {
583 kn->kn_fop = &devctl_rfiltops;
584 knlist_add(&devsoftc.sel.si_note, kn, 0);
592 filt_devctl_detach(struct knote *kn)
594 knlist_remove(&devsoftc.sel.si_note, kn, 0);
598 filt_devctl_read(struct knote *kn, long hint)
600 kn->kn_data = devsoftc.queued;
601 return (kn->kn_data != 0);
605 * @brief Return whether the userland process is running
608 devctl_process_running(void)
610 return (devsoftc.inuse == 1);
613 static struct dev_event_info *
614 devctl_alloc_dei(void)
616 struct dev_event_info *dei = NULL;
618 mtx_lock(&devsoftc.mtx);
619 if (devctl_queue_length == 0)
621 dei = uma_zalloc(devsoftc.zone, M_NOWAIT);
623 dei = uma_zalloc(devsoftc.zone, M_NOWAIT | M_USE_RESERVE);
626 * Guard against no items in the queue. Normally, this won't
627 * happen, but if lots of events happen all at once and there's
628 * a chance we're out of allocated space but none have yet been
629 * queued when we get here, leaving nothing to steal. This can
630 * also happen with error injection. Fail safe by returning
631 * NULL in that case..
633 if (devsoftc.queued == 0)
635 dei = STAILQ_FIRST(&devsoftc.devq);
636 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
640 *dei->dei_data = '\0';
642 mtx_unlock(&devsoftc.mtx);
646 static struct dev_event_info *
647 devctl_alloc_dei_sb(struct sbuf *sb)
649 struct dev_event_info *dei;
651 dei = devctl_alloc_dei();
653 sbuf_new(sb, dei->dei_data, sizeof(dei->dei_data), SBUF_FIXEDLEN);
658 devctl_free_dei(struct dev_event_info *dei)
660 uma_zfree(devsoftc.zone, dei);
664 devctl_queue(struct dev_event_info *dei)
666 mtx_lock(&devsoftc.mtx);
667 STAILQ_INSERT_TAIL(&devsoftc.devq, dei, dei_link);
669 cv_broadcast(&devsoftc.cv);
670 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
671 mtx_unlock(&devsoftc.mtx);
672 selwakeup(&devsoftc.sel);
673 if (devsoftc.async && devsoftc.sigio != NULL)
674 pgsigio(&devsoftc.sigio, SIGIO, 0);
678 * @brief Send a 'notification' to userland, using standard ways
681 devctl_notify(const char *system, const char *subsystem, const char *type,
684 struct dev_event_info *dei;
687 if (system == NULL || subsystem == NULL || type == NULL)
689 dei = devctl_alloc_dei_sb(&sb);
692 sbuf_cpy(&sb, "!system=");
693 sbuf_cat(&sb, system);
694 sbuf_cat(&sb, " subsystem=");
695 sbuf_cat(&sb, subsystem);
696 sbuf_cat(&sb, " type=");
702 sbuf_putc(&sb, '\n');
703 if (sbuf_finish(&sb) != 0)
704 devctl_free_dei(dei); /* overflow -> drop it */
710 * Common routine that tries to make sending messages as easy as possible.
711 * We allocate memory for the data, copy strings into that, but do not
712 * free it unless there's an error. The dequeue part of the driver should
713 * free the data. We don't send data when the device is disabled. We do
714 * send data, even when we have no listeners, because we wish to avoid
715 * races relating to startup and restart of listening applications.
717 * devaddq is designed to string together the type of event, with the
718 * object of that event, plus the plug and play info and location info
719 * for that event. This is likely most useful for devices, but less
720 * useful for other consumers of this interface. Those should use
721 * the devctl_notify() interface instead.
724 * ${type}${what} at $(location dev) $(pnp-info dev) on $(parent dev)
727 devaddq(const char *type, const char *what, device_t dev)
729 struct dev_event_info *dei;
733 dei = devctl_alloc_dei_sb(&sb);
738 sbuf_cat(&sb, " at ");
740 /* Add in the location */
741 bus_child_location(dev, &sb);
745 bus_child_pnpinfo(dev, &sb);
747 /* Get the parent of this device, or / if high enough in the tree. */
748 if (device_get_parent(dev) == NULL)
749 parstr = "."; /* Or '/' ? */
751 parstr = device_get_nameunit(device_get_parent(dev));
752 sbuf_cat(&sb, " on ");
753 sbuf_cat(&sb, parstr);
754 sbuf_putc(&sb, '\n');
755 if (sbuf_finish(&sb) != 0)
760 devctl_free_dei(dei);
764 * A device was added to the tree. We are called just after it successfully
765 * attaches (that is, probe and attach success for this device). No call
766 * is made if a device is merely parented into the tree. See devnomatch
767 * if probe fails. If attach fails, no notification is sent (but maybe
768 * we should have a different message for this).
771 devadded(device_t dev)
773 devaddq("+", device_get_nameunit(dev), dev);
777 * A device was removed from the tree. We are called just before this
781 devremoved(device_t dev)
783 devaddq("-", device_get_nameunit(dev), dev);
787 * Called when there's no match for this device. This is only called
788 * the first time that no match happens, so we don't keep getting this
789 * message. Should that prove to be undesirable, we can change it.
790 * This is called when all drivers that can attach to a given bus
791 * decline to accept this device. Other errors may not be detected.
794 devnomatch(device_t dev)
796 devaddq("?", "", dev);
800 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
804 q = devctl_queue_length;
805 error = sysctl_handle_int(oidp, &q, 0, req);
806 if (error || !req->newptr)
812 * When set as a tunable, we've not yet initialized the mutex.
813 * It is safe to just assign to devctl_queue_length and return
814 * as we're racing no one. We'll use whatever value set in
817 if (!mtx_initialized(&devsoftc.mtx)) {
818 devctl_queue_length = q;
823 * XXX It's hard to grow or shrink the UMA zone. Only allow
824 * disabling the queue size for the moment until underlying
825 * UMA issues can be sorted out.
829 if (q == devctl_queue_length)
831 mtx_lock(&devsoftc.mtx);
832 devctl_queue_length = 0;
833 uma_zdestroy(devsoftc.zone);
835 mtx_unlock(&devsoftc.mtx);
840 * @brief safely quotes strings that might have double quotes in them.
842 * The devctl protocol relies on quoted strings having matching quotes.
843 * This routine quotes any internal quotes so the resulting string
844 * is safe to pass to snprintf to construct, for example pnp info strings.
846 * @param sb sbuf to place the characters into
847 * @param src Original buffer.
850 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
852 while (*src != '\0') {
853 if (*src == '"' || *src == '\\')
855 sbuf_putc(sb, *src++);
859 /* End of /dev/devctl code */
861 static struct device_list bus_data_devices;
862 static int bus_data_generation = 1;
864 static kobj_method_t null_methods[] = {
868 DEFINE_CLASS(null, null_methods, 0);
888 mtx_lock(bus_topo_mtx());
892 bus_topo_unlock(void)
895 mtx_unlock(bus_topo_mtx());
899 * Bus pass implementation
902 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
903 int bus_current_pass = BUS_PASS_ROOT;
907 * @brief Register the pass level of a new driver attachment
909 * Register a new driver attachment's pass level. If no driver
910 * attachment with the same pass level has been added, then @p new
911 * will be added to the global passes list.
913 * @param new the new driver attachment
916 driver_register_pass(struct driverlink *new)
918 struct driverlink *dl;
920 /* We only consider pass numbers during boot. */
921 if (bus_current_pass == BUS_PASS_DEFAULT)
925 * Walk the passes list. If we already know about this pass
926 * then there is nothing to do. If we don't, then insert this
927 * driver link into the list.
929 TAILQ_FOREACH(dl, &passes, passlink) {
930 if (dl->pass < new->pass)
932 if (dl->pass == new->pass)
934 TAILQ_INSERT_BEFORE(dl, new, passlink);
937 TAILQ_INSERT_TAIL(&passes, new, passlink);
941 * @brief Raise the current bus pass
943 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
944 * method on the root bus to kick off a new device tree scan for each
945 * new pass level that has at least one driver.
948 bus_set_pass(int pass)
950 struct driverlink *dl;
952 if (bus_current_pass > pass)
953 panic("Attempt to lower bus pass level");
955 TAILQ_FOREACH(dl, &passes, passlink) {
956 /* Skip pass values below the current pass level. */
957 if (dl->pass <= bus_current_pass)
961 * Bail once we hit a driver with a pass level that is
968 * Raise the pass level to the next level and rescan
971 bus_current_pass = dl->pass;
972 BUS_NEW_PASS(root_bus);
976 * If there isn't a driver registered for the requested pass,
977 * then bus_current_pass might still be less than 'pass'. Set
978 * it to 'pass' in that case.
980 if (bus_current_pass < pass)
981 bus_current_pass = pass;
982 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
986 * Devclass implementation
989 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
993 * @brief Find or create a device class
995 * If a device class with the name @p classname exists, return it,
996 * otherwise if @p create is non-zero create and return a new device
999 * If @p parentname is non-NULL, the parent of the devclass is set to
1000 * the devclass of that name.
1002 * @param classname the devclass name to find or create
1003 * @param parentname the parent devclass name or @c NULL
1004 * @param create non-zero to create a devclass
1007 devclass_find_internal(const char *classname, const char *parentname,
1012 PDEBUG(("looking for %s", classname));
1016 TAILQ_FOREACH(dc, &devclasses, link) {
1017 if (!strcmp(dc->name, classname))
1021 if (create && !dc) {
1022 PDEBUG(("creating %s", classname));
1023 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1024 M_BUS, M_NOWAIT | M_ZERO);
1028 dc->name = (char*) (dc + 1);
1029 strcpy(dc->name, classname);
1030 TAILQ_INIT(&dc->drivers);
1031 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1033 bus_data_generation_update();
1037 * If a parent class is specified, then set that as our parent so
1038 * that this devclass will support drivers for the parent class as
1039 * well. If the parent class has the same name don't do this though
1040 * as it creates a cycle that can trigger an infinite loop in
1041 * device_probe_child() if a device exists for which there is no
1044 if (parentname && dc && !dc->parent &&
1045 strcmp(classname, parentname) != 0) {
1046 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1047 dc->parent->flags |= DC_HAS_CHILDREN;
1054 * @brief Create a device class
1056 * If a device class with the name @p classname exists, return it,
1057 * otherwise create and return a new device class.
1059 * @param classname the devclass name to find or create
1062 devclass_create(const char *classname)
1064 return (devclass_find_internal(classname, NULL, TRUE));
1068 * @brief Find a device class
1070 * If a device class with the name @p classname exists, return it,
1071 * otherwise return @c NULL.
1073 * @param classname the devclass name to find
1076 devclass_find(const char *classname)
1078 return (devclass_find_internal(classname, NULL, FALSE));
1082 * @brief Register that a device driver has been added to a devclass
1084 * Register that a device driver has been added to a devclass. This
1085 * is called by devclass_add_driver to accomplish the recursive
1086 * notification of all the children classes of dc, as well as dc.
1087 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1090 * We do a full search here of the devclass list at each iteration
1091 * level to save storing children-lists in the devclass structure. If
1092 * we ever move beyond a few dozen devices doing this, we may need to
1095 * @param dc the devclass to edit
1096 * @param driver the driver that was just added
1099 devclass_driver_added(devclass_t dc, driver_t *driver)
1105 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1107 for (i = 0; i < dc->maxunit; i++)
1108 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1109 BUS_DRIVER_ADDED(dc->devices[i], driver);
1112 * Walk through the children classes. Since we only keep a
1113 * single parent pointer around, we walk the entire list of
1114 * devclasses looking for children. We set the
1115 * DC_HAS_CHILDREN flag when a child devclass is created on
1116 * the parent, so we only walk the list for those devclasses
1117 * that have children.
1119 if (!(dc->flags & DC_HAS_CHILDREN))
1122 TAILQ_FOREACH(dc, &devclasses, link) {
1123 if (dc->parent == parent)
1124 devclass_driver_added(dc, driver);
1129 * @brief Add a device driver to a device class
1131 * Add a device driver to a devclass. This is normally called
1132 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1133 * all devices in the devclass will be called to allow them to attempt
1134 * to re-probe any unmatched children.
1136 * @param dc the devclass to edit
1137 * @param driver the driver to register
1140 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1143 const char *parentname;
1145 PDEBUG(("%s", DRIVERNAME(driver)));
1147 /* Don't allow invalid pass values. */
1148 if (pass <= BUS_PASS_ROOT)
1151 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1156 * Compile the driver's methods. Also increase the reference count
1157 * so that the class doesn't get freed when the last instance
1158 * goes. This means we can safely use static methods and avoids a
1159 * double-free in devclass_delete_driver.
1161 kobj_class_compile((kobj_class_t) driver);
1164 * If the driver has any base classes, make the
1165 * devclass inherit from the devclass of the driver's
1166 * first base class. This will allow the system to
1167 * search for drivers in both devclasses for children
1168 * of a device using this driver.
1170 if (driver->baseclasses)
1171 parentname = driver->baseclasses[0]->name;
1174 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1176 dl->driver = driver;
1177 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1178 driver->refs++; /* XXX: kobj_mtx */
1180 driver_register_pass(dl);
1182 if (device_frozen) {
1183 dl->flags |= DL_DEFERRED_PROBE;
1185 devclass_driver_added(dc, driver);
1187 bus_data_generation_update();
1192 * @brief Register that a device driver has been deleted from a devclass
1194 * Register that a device driver has been removed from a devclass.
1195 * This is called by devclass_delete_driver to accomplish the
1196 * recursive notification of all the children classes of busclass, as
1197 * well as busclass. Each layer will attempt to detach the driver
1198 * from any devices that are children of the bus's devclass. The function
1199 * will return an error if a device fails to detach.
1201 * We do a full search here of the devclass list at each iteration
1202 * level to save storing children-lists in the devclass structure. If
1203 * we ever move beyond a few dozen devices doing this, we may need to
1206 * @param busclass the devclass of the parent bus
1207 * @param dc the devclass of the driver being deleted
1208 * @param driver the driver being deleted
1211 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1218 * Disassociate from any devices. We iterate through all the
1219 * devices in the devclass of the driver and detach any which are
1220 * using the driver and which have a parent in the devclass which
1221 * we are deleting from.
1223 * Note that since a driver can be in multiple devclasses, we
1224 * should not detach devices which are not children of devices in
1225 * the affected devclass.
1227 * If we're frozen, we don't generate NOMATCH events. Mark to
1230 for (i = 0; i < dc->maxunit; i++) {
1231 if (dc->devices[i]) {
1232 dev = dc->devices[i];
1233 if (dev->driver == driver && dev->parent &&
1234 dev->parent->devclass == busclass) {
1235 if ((error = device_detach(dev)) != 0)
1237 if (device_frozen) {
1238 dev->flags &= ~DF_DONENOMATCH;
1239 dev->flags |= DF_NEEDNOMATCH;
1241 BUS_PROBE_NOMATCH(dev->parent, dev);
1243 dev->flags |= DF_DONENOMATCH;
1250 * Walk through the children classes. Since we only keep a
1251 * single parent pointer around, we walk the entire list of
1252 * devclasses looking for children. We set the
1253 * DC_HAS_CHILDREN flag when a child devclass is created on
1254 * the parent, so we only walk the list for those devclasses
1255 * that have children.
1257 if (!(busclass->flags & DC_HAS_CHILDREN))
1260 TAILQ_FOREACH(busclass, &devclasses, link) {
1261 if (busclass->parent == parent) {
1262 error = devclass_driver_deleted(busclass, dc, driver);
1271 * @brief Delete a device driver from a device class
1273 * Delete a device driver from a devclass. This is normally called
1274 * automatically by DRIVER_MODULE().
1276 * If the driver is currently attached to any devices,
1277 * devclass_delete_driver() will first attempt to detach from each
1278 * device. If one of the detach calls fails, the driver will not be
1281 * @param dc the devclass to edit
1282 * @param driver the driver to unregister
1285 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1287 devclass_t dc = devclass_find(driver->name);
1291 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1297 * Find the link structure in the bus' list of drivers.
1299 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1300 if (dl->driver == driver)
1305 PDEBUG(("%s not found in %s list", driver->name,
1310 error = devclass_driver_deleted(busclass, dc, driver);
1314 TAILQ_REMOVE(&busclass->drivers, dl, link);
1319 if (driver->refs == 0)
1320 kobj_class_free((kobj_class_t) driver);
1322 bus_data_generation_update();
1327 * @brief Quiesces a set of device drivers from a device class
1329 * Quiesce a device driver from a devclass. This is normally called
1330 * automatically by DRIVER_MODULE().
1332 * If the driver is currently attached to any devices,
1333 * devclass_quiesece_driver() will first attempt to quiesce each
1336 * @param dc the devclass to edit
1337 * @param driver the driver to unregister
1340 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1342 devclass_t dc = devclass_find(driver->name);
1348 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1354 * Find the link structure in the bus' list of drivers.
1356 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1357 if (dl->driver == driver)
1362 PDEBUG(("%s not found in %s list", driver->name,
1368 * Quiesce all devices. We iterate through all the devices in
1369 * the devclass of the driver and quiesce any which are using
1370 * the driver and which have a parent in the devclass which we
1373 * Note that since a driver can be in multiple devclasses, we
1374 * should not quiesce devices which are not children of
1375 * devices in the affected devclass.
1377 for (i = 0; i < dc->maxunit; i++) {
1378 if (dc->devices[i]) {
1379 dev = dc->devices[i];
1380 if (dev->driver == driver && dev->parent &&
1381 dev->parent->devclass == busclass) {
1382 if ((error = device_quiesce(dev)) != 0)
1395 devclass_find_driver_internal(devclass_t dc, const char *classname)
1399 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1401 TAILQ_FOREACH(dl, &dc->drivers, link) {
1402 if (!strcmp(dl->driver->name, classname))
1406 PDEBUG(("not found"));
1411 * @brief Return the name of the devclass
1414 devclass_get_name(devclass_t dc)
1420 * @brief Find a device given a unit number
1422 * @param dc the devclass to search
1423 * @param unit the unit number to search for
1425 * @returns the device with the given unit number or @c
1426 * NULL if there is no such device
1429 devclass_get_device(devclass_t dc, int unit)
1431 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1433 return (dc->devices[unit]);
1437 * @brief Find the softc field of a device given a unit number
1439 * @param dc the devclass to search
1440 * @param unit the unit number to search for
1442 * @returns the softc field of the device with the given
1443 * unit number or @c NULL if there is no such
1447 devclass_get_softc(devclass_t dc, int unit)
1451 dev = devclass_get_device(dc, unit);
1455 return (device_get_softc(dev));
1459 * @brief Get a list of devices in the devclass
1461 * An array containing a list of all the devices in the given devclass
1462 * is allocated and returned in @p *devlistp. The number of devices
1463 * in the array is returned in @p *devcountp. The caller should free
1464 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1466 * @param dc the devclass to examine
1467 * @param devlistp points at location for array pointer return
1469 * @param devcountp points at location for array size return value
1472 * @retval ENOMEM the array allocation failed
1475 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1480 count = devclass_get_count(dc);
1481 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1486 for (i = 0; i < dc->maxunit; i++) {
1487 if (dc->devices[i]) {
1488 list[count] = dc->devices[i];
1500 * @brief Get a list of drivers in the devclass
1502 * An array containing a list of pointers to all the drivers in the
1503 * given devclass is allocated and returned in @p *listp. The number
1504 * of drivers in the array is returned in @p *countp. The caller should
1505 * free the array using @c free(p, M_TEMP).
1507 * @param dc the devclass to examine
1508 * @param listp gives location for array pointer return value
1509 * @param countp gives location for number of array elements
1513 * @retval ENOMEM the array allocation failed
1516 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1523 TAILQ_FOREACH(dl, &dc->drivers, link)
1525 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1530 TAILQ_FOREACH(dl, &dc->drivers, link) {
1531 list[count] = dl->driver;
1541 * @brief Get the number of devices in a devclass
1543 * @param dc the devclass to examine
1546 devclass_get_count(devclass_t dc)
1551 for (i = 0; i < dc->maxunit; i++)
1558 * @brief Get the maximum unit number used in a devclass
1560 * Note that this is one greater than the highest currently-allocated
1561 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1562 * that not even the devclass has been allocated yet.
1564 * @param dc the devclass to examine
1567 devclass_get_maxunit(devclass_t dc)
1571 return (dc->maxunit);
1575 * @brief Find a free unit number in a devclass
1577 * This function searches for the first unused unit number greater
1578 * that or equal to @p unit.
1580 * @param dc the devclass to examine
1581 * @param unit the first unit number to check
1584 devclass_find_free_unit(devclass_t dc, int unit)
1588 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1594 * @brief Set the parent of a devclass
1596 * The parent class is normally initialised automatically by
1599 * @param dc the devclass to edit
1600 * @param pdc the new parent devclass
1603 devclass_set_parent(devclass_t dc, devclass_t pdc)
1609 * @brief Get the parent of a devclass
1611 * @param dc the devclass to examine
1614 devclass_get_parent(devclass_t dc)
1616 return (dc->parent);
1619 struct sysctl_ctx_list *
1620 devclass_get_sysctl_ctx(devclass_t dc)
1622 return (&dc->sysctl_ctx);
1626 devclass_get_sysctl_tree(devclass_t dc)
1628 return (dc->sysctl_tree);
1633 * @brief Allocate a unit number
1635 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1636 * will do). The allocated unit number is returned in @p *unitp.
1638 * @param dc the devclass to allocate from
1639 * @param unitp points at the location for the allocated unit
1643 * @retval EEXIST the requested unit number is already allocated
1644 * @retval ENOMEM memory allocation failure
1647 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1652 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1654 /* Ask the parent bus if it wants to wire this device. */
1656 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1659 /* If we were given a wired unit number, check for existing device */
1662 if (unit >= 0 && unit < dc->maxunit &&
1663 dc->devices[unit] != NULL) {
1665 printf("%s: %s%d already exists; skipping it\n",
1666 dc->name, dc->name, *unitp);
1670 /* Unwired device, find the next available slot for it */
1672 for (unit = 0;; unit++) {
1673 /* If this device slot is already in use, skip it. */
1674 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1677 /* If there is an "at" hint for a unit then skip it. */
1678 if (resource_string_value(dc->name, unit, "at", &s) ==
1687 * We've selected a unit beyond the length of the table, so let's
1688 * extend the table to make room for all units up to and including
1691 if (unit >= dc->maxunit) {
1692 device_t *newlist, *oldlist;
1695 oldlist = dc->devices;
1696 newsize = roundup((unit + 1),
1697 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1698 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1701 if (oldlist != NULL)
1702 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1703 bzero(newlist + dc->maxunit,
1704 sizeof(device_t) * (newsize - dc->maxunit));
1705 dc->devices = newlist;
1706 dc->maxunit = newsize;
1707 if (oldlist != NULL)
1708 free(oldlist, M_BUS);
1710 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1718 * @brief Add a device to a devclass
1720 * A unit number is allocated for the device (using the device's
1721 * preferred unit number if any) and the device is registered in the
1722 * devclass. This allows the device to be looked up by its unit
1723 * number, e.g. by decoding a dev_t minor number.
1725 * @param dc the devclass to add to
1726 * @param dev the device to add
1729 * @retval EEXIST the requested unit number is already allocated
1730 * @retval ENOMEM memory allocation failure
1733 devclass_add_device(devclass_t dc, device_t dev)
1737 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1739 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1742 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1746 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1747 free(dev->nameunit, M_BUS);
1748 dev->nameunit = NULL;
1751 dc->devices[dev->unit] = dev;
1753 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1760 * @brief Delete a device from a devclass
1762 * The device is removed from the devclass's device list and its unit
1765 * @param dc the devclass to delete from
1766 * @param dev the device to delete
1771 devclass_delete_device(devclass_t dc, device_t dev)
1776 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1778 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1779 panic("devclass_delete_device: inconsistent device class");
1780 dc->devices[dev->unit] = NULL;
1781 if (dev->flags & DF_WILDCARD)
1783 dev->devclass = NULL;
1784 free(dev->nameunit, M_BUS);
1785 dev->nameunit = NULL;
1792 * @brief Make a new device and add it as a child of @p parent
1794 * @param parent the parent of the new device
1795 * @param name the devclass name of the new device or @c NULL
1796 * to leave the devclass unspecified
1797 * @parem unit the unit number of the new device of @c -1 to
1798 * leave the unit number unspecified
1800 * @returns the new device
1803 make_device(device_t parent, const char *name, int unit)
1808 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1811 dc = devclass_find_internal(name, NULL, TRUE);
1813 printf("make_device: can't find device class %s\n",
1821 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1825 dev->parent = parent;
1826 TAILQ_INIT(&dev->children);
1827 kobj_init((kobj_t) dev, &null_class);
1829 dev->devclass = NULL;
1831 dev->nameunit = NULL;
1835 dev->flags = DF_ENABLED;
1838 dev->flags |= DF_WILDCARD;
1840 dev->flags |= DF_FIXEDCLASS;
1841 if (devclass_add_device(dc, dev)) {
1842 kobj_delete((kobj_t) dev, M_BUS);
1846 if (parent != NULL && device_has_quiet_children(parent))
1847 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1851 dev->state = DS_NOTPRESENT;
1853 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1854 bus_data_generation_update();
1861 * @brief Print a description of a device.
1864 device_print_child(device_t dev, device_t child)
1868 if (device_is_alive(child))
1869 retval += BUS_PRINT_CHILD(dev, child);
1871 retval += device_printf(child, " not found\n");
1877 * @brief Create a new device
1879 * This creates a new device and adds it as a child of an existing
1880 * parent device. The new device will be added after the last existing
1881 * child with order zero.
1883 * @param dev the device which will be the parent of the
1885 * @param name devclass name for new device or @c NULL if not
1887 * @param unit unit number for new device or @c -1 if not
1890 * @returns the new device
1893 device_add_child(device_t dev, const char *name, int unit)
1895 return (device_add_child_ordered(dev, 0, name, unit));
1899 * @brief Create a new device
1901 * This creates a new device and adds it as a child of an existing
1902 * parent device. The new device will be added after the last existing
1903 * child with the same order.
1905 * @param dev the device which will be the parent of the
1907 * @param order a value which is used to partially sort the
1908 * children of @p dev - devices created using
1909 * lower values of @p order appear first in @p
1910 * dev's list of children
1911 * @param name devclass name for new device or @c NULL if not
1913 * @param unit unit number for new device or @c -1 if not
1916 * @returns the new device
1919 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1924 PDEBUG(("%s at %s with order %u as unit %d",
1925 name, DEVICENAME(dev), order, unit));
1926 KASSERT(name != NULL || unit == -1,
1927 ("child device with wildcard name and specific unit number"));
1929 child = make_device(dev, name, unit);
1932 child->order = order;
1934 TAILQ_FOREACH(place, &dev->children, link) {
1935 if (place->order > order)
1941 * The device 'place' is the first device whose order is
1942 * greater than the new child.
1944 TAILQ_INSERT_BEFORE(place, child, link);
1947 * The new child's order is greater or equal to the order of
1948 * any existing device. Add the child to the tail of the list.
1950 TAILQ_INSERT_TAIL(&dev->children, child, link);
1953 bus_data_generation_update();
1958 * @brief Delete a device
1960 * This function deletes a device along with all of its children. If
1961 * the device currently has a driver attached to it, the device is
1962 * detached first using device_detach().
1964 * @param dev the parent device
1965 * @param child the device to delete
1968 * @retval non-zero a unit error code describing the error
1971 device_delete_child(device_t dev, device_t child)
1974 device_t grandchild;
1976 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1978 /* detach parent before deleting children, if any */
1979 if ((error = device_detach(child)) != 0)
1982 /* remove children second */
1983 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1984 error = device_delete_child(child, grandchild);
1989 if (child->devclass)
1990 devclass_delete_device(child->devclass, child);
1992 BUS_CHILD_DELETED(dev, child);
1993 TAILQ_REMOVE(&dev->children, child, link);
1994 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1995 kobj_delete((kobj_t) child, M_BUS);
1997 bus_data_generation_update();
2002 * @brief Delete all children devices of the given device, if any.
2004 * This function deletes all children devices of the given device, if
2005 * any, using the device_delete_child() function for each device it
2006 * finds. If a child device cannot be deleted, this function will
2007 * return an error code.
2009 * @param dev the parent device
2012 * @retval non-zero a device would not detach
2015 device_delete_children(device_t dev)
2020 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2024 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2025 error = device_delete_child(dev, child);
2027 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2035 * @brief Find a device given a unit number
2037 * This is similar to devclass_get_devices() but only searches for
2038 * devices which have @p dev as a parent.
2040 * @param dev the parent device to search
2041 * @param unit the unit number to search for. If the unit is -1,
2042 * return the first child of @p dev which has name
2043 * @p classname (that is, the one with the lowest unit.)
2045 * @returns the device with the given unit number or @c
2046 * NULL if there is no such device
2049 device_find_child(device_t dev, const char *classname, int unit)
2054 dc = devclass_find(classname);
2059 child = devclass_get_device(dc, unit);
2060 if (child && child->parent == dev)
2063 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2064 child = devclass_get_device(dc, unit);
2065 if (child && child->parent == dev)
2076 first_matching_driver(devclass_t dc, device_t dev)
2079 return (devclass_find_driver_internal(dc, dev->devclass->name));
2080 return (TAILQ_FIRST(&dc->drivers));
2087 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2089 if (dev->devclass) {
2091 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2092 if (!strcmp(dev->devclass->name, dl->driver->name))
2096 return (TAILQ_NEXT(last, link));
2103 device_probe_child(device_t dev, device_t child)
2106 driverlink_t best = NULL;
2108 int result, pri = 0;
2109 /* We should preserve the devclass (or lack of) set by the bus. */
2110 int hasclass = (child->devclass != NULL);
2116 panic("device_probe_child: parent device has no devclass");
2119 * If the state is already probed, then return.
2121 if (child->state == DS_ALIVE)
2124 for (; dc; dc = dc->parent) {
2125 for (dl = first_matching_driver(dc, child);
2127 dl = next_matching_driver(dc, child, dl)) {
2128 /* If this driver's pass is too high, then ignore it. */
2129 if (dl->pass > bus_current_pass)
2132 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2133 result = device_set_driver(child, dl->driver);
2134 if (result == ENOMEM)
2136 else if (result != 0)
2139 if (device_set_devclass(child,
2140 dl->driver->name) != 0) {
2141 char const * devname =
2142 device_get_name(child);
2143 if (devname == NULL)
2144 devname = "(unknown)";
2145 printf("driver bug: Unable to set "
2146 "devclass (class: %s "
2150 (void)device_set_driver(child, NULL);
2155 /* Fetch any flags for the device before probing. */
2156 resource_int_value(dl->driver->name, child->unit,
2157 "flags", &child->devflags);
2159 result = DEVICE_PROBE(child);
2162 * If the driver returns SUCCESS, there can be
2163 * no higher match for this device.
2171 /* Reset flags and devclass before the next probe. */
2172 child->devflags = 0;
2174 (void)device_set_devclass(child, NULL);
2177 * Reset DF_QUIET in case this driver doesn't
2178 * end up as the best driver.
2180 device_verbose(child);
2183 * Probes that return BUS_PROBE_NOWILDCARD or lower
2184 * only match on devices whose driver was explicitly
2187 if (result <= BUS_PROBE_NOWILDCARD &&
2188 !(child->flags & DF_FIXEDCLASS)) {
2193 * The driver returned an error so it
2194 * certainly doesn't match.
2197 (void)device_set_driver(child, NULL);
2202 * A priority lower than SUCCESS, remember the
2203 * best matching driver. Initialise the value
2204 * of pri for the first match.
2206 if (best == NULL || result > pri) {
2213 * If we have an unambiguous match in this devclass,
2214 * don't look in the parent.
2216 if (best && pri == 0)
2224 * If we found a driver, change state and initialise the devclass.
2227 /* Set the winning driver, devclass, and flags. */
2228 result = device_set_driver(child, best->driver);
2231 if (!child->devclass) {
2232 result = device_set_devclass(child, best->driver->name);
2234 (void)device_set_driver(child, NULL);
2238 resource_int_value(best->driver->name, child->unit,
2239 "flags", &child->devflags);
2242 * A bit bogus. Call the probe method again to make sure
2243 * that we have the right description.
2245 result = DEVICE_PROBE(child);
2248 (void)device_set_devclass(child, NULL);
2249 (void)device_set_driver(child, NULL);
2254 child->state = DS_ALIVE;
2255 bus_data_generation_update();
2260 * @brief Return the parent of a device
2263 device_get_parent(device_t dev)
2265 return (dev->parent);
2269 * @brief Get a list of children of a device
2271 * An array containing a list of all the children of the given device
2272 * is allocated and returned in @p *devlistp. The number of devices
2273 * in the array is returned in @p *devcountp. The caller should free
2274 * the array using @c free(p, M_TEMP).
2276 * @param dev the device to examine
2277 * @param devlistp points at location for array pointer return
2279 * @param devcountp points at location for array size return value
2282 * @retval ENOMEM the array allocation failed
2285 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2292 TAILQ_FOREACH(child, &dev->children, link) {
2301 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2306 TAILQ_FOREACH(child, &dev->children, link) {
2307 list[count] = child;
2318 * @brief Return the current driver for the device or @c NULL if there
2319 * is no driver currently attached
2322 device_get_driver(device_t dev)
2324 return (dev->driver);
2328 * @brief Return the current devclass for the device or @c NULL if
2332 device_get_devclass(device_t dev)
2334 return (dev->devclass);
2338 * @brief Return the name of the device's devclass or @c NULL if there
2342 device_get_name(device_t dev)
2344 if (dev != NULL && dev->devclass)
2345 return (devclass_get_name(dev->devclass));
2350 * @brief Return a string containing the device's devclass name
2351 * followed by an ascii representation of the device's unit number
2355 device_get_nameunit(device_t dev)
2357 return (dev->nameunit);
2361 * @brief Return the device's unit number.
2364 device_get_unit(device_t dev)
2370 * @brief Return the device's description string
2373 device_get_desc(device_t dev)
2379 * @brief Return the device's flags
2382 device_get_flags(device_t dev)
2384 return (dev->devflags);
2387 struct sysctl_ctx_list *
2388 device_get_sysctl_ctx(device_t dev)
2390 return (&dev->sysctl_ctx);
2394 device_get_sysctl_tree(device_t dev)
2396 return (dev->sysctl_tree);
2400 * @brief Print the name of the device followed by a colon and a space
2402 * @returns the number of characters printed
2405 device_print_prettyname(device_t dev)
2407 const char *name = device_get_name(dev);
2410 return (printf("unknown: "));
2411 return (printf("%s%d: ", name, device_get_unit(dev)));
2415 * @brief Print the name of the device followed by a colon, a space
2416 * and the result of calling vprintf() with the value of @p fmt and
2417 * the following arguments.
2419 * @returns the number of characters printed
2422 device_printf(device_t dev, const char * fmt, ...)
2432 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2433 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2435 name = device_get_name(dev);
2438 sbuf_cat(&sb, "unknown: ");
2440 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2443 sbuf_vprintf(&sb, fmt, ap);
2453 * @brief Print the name of the device followed by a colon, a space
2454 * and the result of calling log() with the value of @p fmt and
2455 * the following arguments.
2457 * @returns the number of characters printed
2460 device_log(device_t dev, int pri, const char * fmt, ...)
2470 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2472 name = device_get_name(dev);
2475 sbuf_cat(&sb, "unknown: ");
2477 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2480 sbuf_vprintf(&sb, fmt, ap);
2485 log(pri, "%.*s", (int) sbuf_len(&sb), sbuf_data(&sb));
2486 retval = sbuf_len(&sb);
2497 device_set_desc_internal(device_t dev, const char* desc, int copy)
2499 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2500 free(dev->desc, M_BUS);
2501 dev->flags &= ~DF_DESCMALLOCED;
2506 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2508 strcpy(dev->desc, desc);
2509 dev->flags |= DF_DESCMALLOCED;
2512 /* Avoid a -Wcast-qual warning */
2513 dev->desc = (char *)(uintptr_t) desc;
2516 bus_data_generation_update();
2520 * @brief Set the device's description
2522 * The value of @c desc should be a string constant that will not
2523 * change (at least until the description is changed in a subsequent
2524 * call to device_set_desc() or device_set_desc_copy()).
2527 device_set_desc(device_t dev, const char* desc)
2529 device_set_desc_internal(dev, desc, FALSE);
2533 * @brief Set the device's description
2535 * The string pointed to by @c desc is copied. Use this function if
2536 * the device description is generated, (e.g. with sprintf()).
2539 device_set_desc_copy(device_t dev, const char* desc)
2541 device_set_desc_internal(dev, desc, TRUE);
2545 * @brief Set the device's flags
2548 device_set_flags(device_t dev, uint32_t flags)
2550 dev->devflags = flags;
2554 * @brief Return the device's softc field
2556 * The softc is allocated and zeroed when a driver is attached, based
2557 * on the size field of the driver.
2560 device_get_softc(device_t dev)
2562 return (dev->softc);
2566 * @brief Set the device's softc field
2568 * Most drivers do not need to use this since the softc is allocated
2569 * automatically when the driver is attached.
2572 device_set_softc(device_t dev, void *softc)
2574 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2575 free(dev->softc, M_BUS_SC);
2578 dev->flags |= DF_EXTERNALSOFTC;
2580 dev->flags &= ~DF_EXTERNALSOFTC;
2584 * @brief Free claimed softc
2586 * Most drivers do not need to use this since the softc is freed
2587 * automatically when the driver is detached.
2590 device_free_softc(void *softc)
2592 free(softc, M_BUS_SC);
2596 * @brief Claim softc
2598 * This function can be used to let the driver free the automatically
2599 * allocated softc using "device_free_softc()". This function is
2600 * useful when the driver is refcounting the softc and the softc
2601 * cannot be freed when the "device_detach" method is called.
2604 device_claim_softc(device_t dev)
2607 dev->flags |= DF_EXTERNALSOFTC;
2609 dev->flags &= ~DF_EXTERNALSOFTC;
2613 * @brief Get the device's ivars field
2615 * The ivars field is used by the parent device to store per-device
2616 * state (e.g. the physical location of the device or a list of
2620 device_get_ivars(device_t dev)
2622 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2623 return (dev->ivars);
2627 * @brief Set the device's ivars field
2630 device_set_ivars(device_t dev, void * ivars)
2632 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2637 * @brief Return the device's state
2640 device_get_state(device_t dev)
2642 return (dev->state);
2646 * @brief Set the DF_ENABLED flag for the device
2649 device_enable(device_t dev)
2651 dev->flags |= DF_ENABLED;
2655 * @brief Clear the DF_ENABLED flag for the device
2658 device_disable(device_t dev)
2660 dev->flags &= ~DF_ENABLED;
2664 * @brief Increment the busy counter for the device
2667 device_busy(device_t dev)
2671 * Mark the device as busy, recursively up the tree if this busy count
2674 if (refcount_acquire(&dev->busy) == 0 && dev->parent != NULL)
2675 device_busy(dev->parent);
2679 * @brief Decrement the busy counter for the device
2682 device_unbusy(device_t dev)
2686 * Mark the device as unbsy, recursively if this is the last busy count.
2688 if (refcount_release(&dev->busy) && dev->parent != NULL)
2689 device_unbusy(dev->parent);
2693 * @brief Set the DF_QUIET flag for the device
2696 device_quiet(device_t dev)
2698 dev->flags |= DF_QUIET;
2702 * @brief Set the DF_QUIET_CHILDREN flag for the device
2705 device_quiet_children(device_t dev)
2707 dev->flags |= DF_QUIET_CHILDREN;
2711 * @brief Clear the DF_QUIET flag for the device
2714 device_verbose(device_t dev)
2716 dev->flags &= ~DF_QUIET;
2720 device_get_property(device_t dev, const char *prop, void *val, size_t sz)
2722 device_t bus = device_get_parent(dev);
2724 return (BUS_GET_PROPERTY(bus, dev, prop, val, sz));
2728 device_has_property(device_t dev, const char *prop)
2730 return (device_get_property(dev, prop, NULL, 0) >= 0);
2734 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2737 device_has_quiet_children(device_t dev)
2739 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2743 * @brief Return non-zero if the DF_QUIET flag is set on the device
2746 device_is_quiet(device_t dev)
2748 return ((dev->flags & DF_QUIET) != 0);
2752 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2755 device_is_enabled(device_t dev)
2757 return ((dev->flags & DF_ENABLED) != 0);
2761 * @brief Return non-zero if the device was successfully probed
2764 device_is_alive(device_t dev)
2766 return (dev->state >= DS_ALIVE);
2770 * @brief Return non-zero if the device currently has a driver
2774 device_is_attached(device_t dev)
2776 return (dev->state >= DS_ATTACHED);
2780 * @brief Return non-zero if the device is currently suspended.
2783 device_is_suspended(device_t dev)
2785 return ((dev->flags & DF_SUSPENDED) != 0);
2789 * @brief Set the devclass of a device
2790 * @see devclass_add_device().
2793 device_set_devclass(device_t dev, const char *classname)
2800 devclass_delete_device(dev->devclass, dev);
2804 if (dev->devclass) {
2805 printf("device_set_devclass: device class already set\n");
2809 dc = devclass_find_internal(classname, NULL, TRUE);
2813 error = devclass_add_device(dc, dev);
2815 bus_data_generation_update();
2820 * @brief Set the devclass of a device and mark the devclass fixed.
2821 * @see device_set_devclass()
2824 device_set_devclass_fixed(device_t dev, const char *classname)
2828 if (classname == NULL)
2831 error = device_set_devclass(dev, classname);
2834 dev->flags |= DF_FIXEDCLASS;
2839 * @brief Query the device to determine if it's of a fixed devclass
2840 * @see device_set_devclass_fixed()
2843 device_is_devclass_fixed(device_t dev)
2845 return ((dev->flags & DF_FIXEDCLASS) != 0);
2849 * @brief Set the driver of a device
2852 * @retval EBUSY the device already has a driver attached
2853 * @retval ENOMEM a memory allocation failure occurred
2856 device_set_driver(device_t dev, driver_t *driver)
2859 struct domainset *policy;
2861 if (dev->state >= DS_ATTACHED)
2864 if (dev->driver == driver)
2867 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2868 free(dev->softc, M_BUS_SC);
2871 device_set_desc(dev, NULL);
2872 kobj_delete((kobj_t) dev, NULL);
2873 dev->driver = driver;
2875 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2876 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2877 if (bus_get_domain(dev, &domain) == 0)
2878 policy = DOMAINSET_PREF(domain);
2880 policy = DOMAINSET_RR();
2881 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2882 policy, M_NOWAIT | M_ZERO);
2884 kobj_delete((kobj_t) dev, NULL);
2885 kobj_init((kobj_t) dev, &null_class);
2891 kobj_init((kobj_t) dev, &null_class);
2894 bus_data_generation_update();
2899 * @brief Probe a device, and return this status.
2901 * This function is the core of the device autoconfiguration
2902 * system. Its purpose is to select a suitable driver for a device and
2903 * then call that driver to initialise the hardware appropriately. The
2904 * driver is selected by calling the DEVICE_PROBE() method of a set of
2905 * candidate drivers and then choosing the driver which returned the
2906 * best value. This driver is then attached to the device using
2909 * The set of suitable drivers is taken from the list of drivers in
2910 * the parent device's devclass. If the device was originally created
2911 * with a specific class name (see device_add_child()), only drivers
2912 * with that name are probed, otherwise all drivers in the devclass
2913 * are probed. If no drivers return successful probe values in the
2914 * parent devclass, the search continues in the parent of that
2915 * devclass (see devclass_get_parent()) if any.
2917 * @param dev the device to initialise
2920 * @retval ENXIO no driver was found
2921 * @retval ENOMEM memory allocation failure
2922 * @retval non-zero some other unix error code
2923 * @retval -1 Device already attached
2926 device_probe(device_t dev)
2932 if (dev->state >= DS_ALIVE)
2935 if (!(dev->flags & DF_ENABLED)) {
2936 if (bootverbose && device_get_name(dev) != NULL) {
2937 device_print_prettyname(dev);
2938 printf("not probed (disabled)\n");
2942 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2943 if (bus_current_pass == BUS_PASS_DEFAULT &&
2944 !(dev->flags & DF_DONENOMATCH)) {
2945 BUS_PROBE_NOMATCH(dev->parent, dev);
2947 dev->flags |= DF_DONENOMATCH;
2955 * @brief Probe a device and attach a driver if possible
2957 * calls device_probe() and attaches if that was successful.
2960 device_probe_and_attach(device_t dev)
2966 error = device_probe(dev);
2969 else if (error != 0)
2972 CURVNET_SET_QUIET(vnet0);
2973 error = device_attach(dev);
2979 * @brief Attach a device driver to a device
2981 * This function is a wrapper around the DEVICE_ATTACH() driver
2982 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2983 * device's sysctl tree, optionally prints a description of the device
2984 * and queues a notification event for user-based device management
2987 * Normally this function is only called internally from
2988 * device_probe_and_attach().
2990 * @param dev the device to initialise
2993 * @retval ENXIO no driver was found
2994 * @retval ENOMEM memory allocation failure
2995 * @retval non-zero some other unix error code
2998 device_attach(device_t dev)
3000 uint64_t attachtime;
3001 uint16_t attachentropy;
3004 if (resource_disabled(dev->driver->name, dev->unit)) {
3005 device_disable(dev);
3007 device_printf(dev, "disabled via hints entry\n");
3011 device_sysctl_init(dev);
3012 if (!device_is_quiet(dev))
3013 device_print_child(dev->parent, dev);
3014 attachtime = get_cyclecount();
3015 dev->state = DS_ATTACHING;
3016 if ((error = DEVICE_ATTACH(dev)) != 0) {
3017 printf("device_attach: %s%d attach returned %d\n",
3018 dev->driver->name, dev->unit, error);
3019 if (!(dev->flags & DF_FIXEDCLASS))
3020 devclass_delete_device(dev->devclass, dev);
3021 (void)device_set_driver(dev, NULL);
3022 device_sysctl_fini(dev);
3023 KASSERT(dev->busy == 0, ("attach failed but busy"));
3024 dev->state = DS_NOTPRESENT;
3027 dev->flags |= DF_ATTACHED_ONCE;
3028 /* We only need the low bits of this time, but ranges from tens to thousands
3029 * have been seen, so keep 2 bytes' worth.
3031 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3032 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3033 device_sysctl_update(dev);
3034 dev->state = DS_ATTACHED;
3035 dev->flags &= ~DF_DONENOMATCH;
3036 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3042 * @brief Detach a driver from a device
3044 * This function is a wrapper around the DEVICE_DETACH() driver
3045 * method. If the call to DEVICE_DETACH() succeeds, it calls
3046 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3047 * notification event for user-based device management services and
3048 * cleans up the device's sysctl tree.
3050 * @param dev the device to un-initialise
3053 * @retval ENXIO no driver was found
3054 * @retval ENOMEM memory allocation failure
3055 * @retval non-zero some other unix error code
3058 device_detach(device_t dev)
3064 PDEBUG(("%s", DEVICENAME(dev)));
3067 if (dev->state == DS_ATTACHING) {
3068 device_printf(dev, "device in attaching state! Deferring detach.\n");
3071 if (dev->state != DS_ATTACHED)
3074 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3075 if ((error = DEVICE_DETACH(dev)) != 0) {
3076 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3077 EVHDEV_DETACH_FAILED);
3080 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3081 EVHDEV_DETACH_COMPLETE);
3084 if (!device_is_quiet(dev))
3085 device_printf(dev, "detached\n");
3087 BUS_CHILD_DETACHED(dev->parent, dev);
3089 if (!(dev->flags & DF_FIXEDCLASS))
3090 devclass_delete_device(dev->devclass, dev);
3092 device_verbose(dev);
3093 dev->state = DS_NOTPRESENT;
3094 (void)device_set_driver(dev, NULL);
3095 device_sysctl_fini(dev);
3101 * @brief Tells a driver to quiesce itself.
3103 * This function is a wrapper around the DEVICE_QUIESCE() driver
3104 * method. If the call to DEVICE_QUIESCE() succeeds.
3106 * @param dev the device to quiesce
3109 * @retval ENXIO no driver was found
3110 * @retval ENOMEM memory allocation failure
3111 * @retval non-zero some other unix error code
3114 device_quiesce(device_t dev)
3116 PDEBUG(("%s", DEVICENAME(dev)));
3119 if (dev->state != DS_ATTACHED)
3122 return (DEVICE_QUIESCE(dev));
3126 * @brief Notify a device of system shutdown
3128 * This function calls the DEVICE_SHUTDOWN() driver method if the
3129 * device currently has an attached driver.
3131 * @returns the value returned by DEVICE_SHUTDOWN()
3134 device_shutdown(device_t dev)
3136 if (dev->state < DS_ATTACHED)
3138 return (DEVICE_SHUTDOWN(dev));
3142 * @brief Set the unit number of a device
3144 * This function can be used to override the unit number used for a
3145 * device (e.g. to wire a device to a pre-configured unit number).
3148 device_set_unit(device_t dev, int unit)
3153 if (unit == dev->unit)
3155 dc = device_get_devclass(dev);
3156 if (unit < dc->maxunit && dc->devices[unit])
3158 err = devclass_delete_device(dc, dev);
3162 err = devclass_add_device(dc, dev);
3166 bus_data_generation_update();
3170 /*======================================*/
3172 * Some useful method implementations to make life easier for bus drivers.
3176 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3180 args->memattr = VM_MEMATTR_DEVICE;
3184 * @brief Initialise a resource list.
3186 * @param rl the resource list to initialise
3189 resource_list_init(struct resource_list *rl)
3195 * @brief Reclaim memory used by a resource list.
3197 * This function frees the memory for all resource entries on the list
3200 * @param rl the resource list to free
3203 resource_list_free(struct resource_list *rl)
3205 struct resource_list_entry *rle;
3207 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3209 panic("resource_list_free: resource entry is busy");
3210 STAILQ_REMOVE_HEAD(rl, link);
3216 * @brief Add a resource entry.
3218 * This function adds a resource entry using the given @p type, @p
3219 * start, @p end and @p count values. A rid value is chosen by
3220 * searching sequentially for the first unused rid starting at zero.
3222 * @param rl the resource list to edit
3223 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3224 * @param start the start address of the resource
3225 * @param end the end address of the resource
3226 * @param count XXX end-start+1
3229 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3230 rman_res_t end, rman_res_t count)
3235 while (resource_list_find(rl, type, rid) != NULL)
3237 resource_list_add(rl, type, rid, start, end, count);
3242 * @brief Add or modify a resource entry.
3244 * If an existing entry exists with the same type and rid, it will be
3245 * modified using the given values of @p start, @p end and @p
3246 * count. If no entry exists, a new one will be created using the
3247 * given values. The resource list entry that matches is then returned.
3249 * @param rl the resource list to edit
3250 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3251 * @param rid the resource identifier
3252 * @param start the start address of the resource
3253 * @param end the end address of the resource
3254 * @param count XXX end-start+1
3256 struct resource_list_entry *
3257 resource_list_add(struct resource_list *rl, int type, int rid,
3258 rman_res_t start, rman_res_t end, rman_res_t count)
3260 struct resource_list_entry *rle;
3262 rle = resource_list_find(rl, type, rid);
3264 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3267 panic("resource_list_add: can't record entry");
3268 STAILQ_INSERT_TAIL(rl, rle, link);
3276 panic("resource_list_add: resource entry is busy");
3285 * @brief Determine if a resource entry is busy.
3287 * Returns true if a resource entry is busy meaning that it has an
3288 * associated resource that is not an unallocated "reserved" resource.
3290 * @param rl the resource list to search
3291 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3292 * @param rid the resource identifier
3294 * @returns Non-zero if the entry is busy, zero otherwise.
3297 resource_list_busy(struct resource_list *rl, int type, int rid)
3299 struct resource_list_entry *rle;
3301 rle = resource_list_find(rl, type, rid);
3302 if (rle == NULL || rle->res == NULL)
3304 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3305 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3306 ("reserved resource is active"));
3313 * @brief Determine if a resource entry is reserved.
3315 * Returns true if a resource entry is reserved meaning that it has an
3316 * associated "reserved" resource. The resource can either be
3317 * allocated or unallocated.
3319 * @param rl the resource list to search
3320 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3321 * @param rid the resource identifier
3323 * @returns Non-zero if the entry is reserved, zero otherwise.
3326 resource_list_reserved(struct resource_list *rl, int type, int rid)
3328 struct resource_list_entry *rle;
3330 rle = resource_list_find(rl, type, rid);
3331 if (rle != NULL && rle->flags & RLE_RESERVED)
3337 * @brief Find a resource entry by type and rid.
3339 * @param rl the resource list to search
3340 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3341 * @param rid the resource identifier
3343 * @returns the resource entry pointer or NULL if there is no such
3346 struct resource_list_entry *
3347 resource_list_find(struct resource_list *rl, int type, int rid)
3349 struct resource_list_entry *rle;
3351 STAILQ_FOREACH(rle, rl, link) {
3352 if (rle->type == type && rle->rid == rid)
3359 * @brief Delete a resource entry.
3361 * @param rl the resource list to edit
3362 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3363 * @param rid the resource identifier
3366 resource_list_delete(struct resource_list *rl, int type, int rid)
3368 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3371 if (rle->res != NULL)
3372 panic("resource_list_delete: resource has not been released");
3373 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3379 * @brief Allocate a reserved resource
3381 * This can be used by buses to force the allocation of resources
3382 * that are always active in the system even if they are not allocated
3383 * by a driver (e.g. PCI BARs). This function is usually called when
3384 * adding a new child to the bus. The resource is allocated from the
3385 * parent bus when it is reserved. The resource list entry is marked
3386 * with RLE_RESERVED to note that it is a reserved resource.
3388 * Subsequent attempts to allocate the resource with
3389 * resource_list_alloc() will succeed the first time and will set
3390 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3391 * resource that has been allocated is released with
3392 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3393 * the actual resource remains allocated. The resource can be released to
3394 * the parent bus by calling resource_list_unreserve().
3396 * @param rl the resource list to allocate from
3397 * @param bus the parent device of @p child
3398 * @param child the device for which the resource is being reserved
3399 * @param type the type of resource to allocate
3400 * @param rid a pointer to the resource identifier
3401 * @param start hint at the start of the resource range - pass
3402 * @c 0 for any start address
3403 * @param end hint at the end of the resource range - pass
3404 * @c ~0 for any end address
3405 * @param count hint at the size of range required - pass @c 1
3407 * @param flags any extra flags to control the resource
3408 * allocation - see @c RF_XXX flags in
3409 * <sys/rman.h> for details
3411 * @returns the resource which was allocated or @c NULL if no
3412 * resource could be allocated
3415 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3416 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3418 struct resource_list_entry *rle = NULL;
3419 int passthrough = (device_get_parent(child) != bus);
3424 "resource_list_reserve() should only be called for direct children");
3425 if (flags & RF_ACTIVE)
3427 "resource_list_reserve() should only reserve inactive resources");
3429 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3432 rle = resource_list_find(rl, type, *rid);
3433 rle->flags |= RLE_RESERVED;
3439 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3441 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3442 * and passing the allocation up to the parent of @p bus. This assumes
3443 * that the first entry of @c device_get_ivars(child) is a struct
3444 * resource_list. This also handles 'passthrough' allocations where a
3445 * child is a remote descendant of bus by passing the allocation up to
3446 * the parent of bus.
3448 * Typically, a bus driver would store a list of child resources
3449 * somewhere in the child device's ivars (see device_get_ivars()) and
3450 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3451 * then call resource_list_alloc() to perform the allocation.
3453 * @param rl the resource list to allocate from
3454 * @param bus the parent device of @p child
3455 * @param child the device which is requesting an allocation
3456 * @param type the type of resource to allocate
3457 * @param rid a pointer to the resource identifier
3458 * @param start hint at the start of the resource range - pass
3459 * @c 0 for any start address
3460 * @param end hint at the end of the resource range - pass
3461 * @c ~0 for any end address
3462 * @param count hint at the size of range required - pass @c 1
3464 * @param flags any extra flags to control the resource
3465 * allocation - see @c RF_XXX flags in
3466 * <sys/rman.h> for details
3468 * @returns the resource which was allocated or @c NULL if no
3469 * resource could be allocated
3472 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3473 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3475 struct resource_list_entry *rle = NULL;
3476 int passthrough = (device_get_parent(child) != bus);
3477 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3480 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3481 type, rid, start, end, count, flags));
3484 rle = resource_list_find(rl, type, *rid);
3487 return (NULL); /* no resource of that type/rid */
3490 if (rle->flags & RLE_RESERVED) {
3491 if (rle->flags & RLE_ALLOCATED)
3493 if ((flags & RF_ACTIVE) &&
3494 bus_activate_resource(child, type, *rid,
3497 rle->flags |= RLE_ALLOCATED;
3501 "resource entry %#x type %d for child %s is busy\n", *rid,
3502 type, device_get_nameunit(child));
3508 count = ulmax(count, rle->count);
3509 end = ulmax(rle->end, start + count - 1);
3512 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3513 type, rid, start, end, count, flags);
3516 * Record the new range.
3519 rle->start = rman_get_start(rle->res);
3520 rle->end = rman_get_end(rle->res);
3528 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3530 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3531 * used with resource_list_alloc().
3533 * @param rl the resource list which was allocated from
3534 * @param bus the parent device of @p child
3535 * @param child the device which is requesting a release
3536 * @param type the type of resource to release
3537 * @param rid the resource identifier
3538 * @param res the resource to release
3541 * @retval non-zero a standard unix error code indicating what
3542 * error condition prevented the operation
3545 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3546 int type, int rid, struct resource *res)
3548 struct resource_list_entry *rle = NULL;
3549 int passthrough = (device_get_parent(child) != bus);
3553 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3557 rle = resource_list_find(rl, type, rid);
3560 panic("resource_list_release: can't find resource");
3562 panic("resource_list_release: resource entry is not busy");
3563 if (rle->flags & RLE_RESERVED) {
3564 if (rle->flags & RLE_ALLOCATED) {
3565 if (rman_get_flags(res) & RF_ACTIVE) {
3566 error = bus_deactivate_resource(child, type,
3571 rle->flags &= ~RLE_ALLOCATED;
3577 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3587 * @brief Release all active resources of a given type
3589 * Release all active resources of a specified type. This is intended
3590 * to be used to cleanup resources leaked by a driver after detach or
3593 * @param rl the resource list which was allocated from
3594 * @param bus the parent device of @p child
3595 * @param child the device whose active resources are being released
3596 * @param type the type of resources to release
3599 * @retval EBUSY at least one resource was active
3602 resource_list_release_active(struct resource_list *rl, device_t bus,
3603 device_t child, int type)
3605 struct resource_list_entry *rle;
3609 STAILQ_FOREACH(rle, rl, link) {
3610 if (rle->type != type)
3612 if (rle->res == NULL)
3614 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3618 error = resource_list_release(rl, bus, child, type,
3619 rman_get_rid(rle->res), rle->res);
3622 "Failed to release active resource: %d\n", error);
3628 * @brief Fully release a reserved resource
3630 * Fully releases a resource reserved via resource_list_reserve().
3632 * @param rl the resource list which was allocated from
3633 * @param bus the parent device of @p child
3634 * @param child the device whose reserved resource is being released
3635 * @param type the type of resource to release
3636 * @param rid the resource identifier
3637 * @param res the resource to release
3640 * @retval non-zero a standard unix error code indicating what
3641 * error condition prevented the operation
3644 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3647 struct resource_list_entry *rle = NULL;
3648 int passthrough = (device_get_parent(child) != bus);
3652 "resource_list_unreserve() should only be called for direct children");
3654 rle = resource_list_find(rl, type, rid);
3657 panic("resource_list_unreserve: can't find resource");
3658 if (!(rle->flags & RLE_RESERVED))
3660 if (rle->flags & RLE_ALLOCATED)
3662 rle->flags &= ~RLE_RESERVED;
3663 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3667 * @brief Print a description of resources in a resource list
3669 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3670 * The name is printed if at least one resource of the given type is available.
3671 * The format is used to print resource start and end.
3673 * @param rl the resource list to print
3674 * @param name the name of @p type, e.g. @c "memory"
3675 * @param type type type of resource entry to print
3676 * @param format printf(9) format string to print resource
3677 * start and end values
3679 * @returns the number of characters printed
3682 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3685 struct resource_list_entry *rle;
3686 int printed, retval;
3690 /* Yes, this is kinda cheating */
3691 STAILQ_FOREACH(rle, rl, link) {
3692 if (rle->type == type) {
3694 retval += printf(" %s ", name);
3696 retval += printf(",");
3698 retval += printf(format, rle->start);
3699 if (rle->count > 1) {
3700 retval += printf("-");
3701 retval += printf(format, rle->start +
3710 * @brief Releases all the resources in a list.
3712 * @param rl The resource list to purge.
3717 resource_list_purge(struct resource_list *rl)
3719 struct resource_list_entry *rle;
3721 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3723 bus_release_resource(rman_get_device(rle->res),
3724 rle->type, rle->rid, rle->res);
3725 STAILQ_REMOVE_HEAD(rl, link);
3731 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3733 return (device_add_child_ordered(dev, order, name, unit));
3737 * @brief Helper function for implementing DEVICE_PROBE()
3739 * This function can be used to help implement the DEVICE_PROBE() for
3740 * a bus (i.e. a device which has other devices attached to it). It
3741 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3745 bus_generic_probe(device_t dev)
3747 devclass_t dc = dev->devclass;
3750 TAILQ_FOREACH(dl, &dc->drivers, link) {
3752 * If this driver's pass is too high, then ignore it.
3753 * For most drivers in the default pass, this will
3754 * never be true. For early-pass drivers they will
3755 * only call the identify routines of eligible drivers
3756 * when this routine is called. Drivers for later
3757 * passes should have their identify routines called
3758 * on early-pass buses during BUS_NEW_PASS().
3760 if (dl->pass > bus_current_pass)
3762 DEVICE_IDENTIFY(dl->driver, dev);
3769 * @brief Helper function for implementing DEVICE_ATTACH()
3771 * This function can be used to help implement the DEVICE_ATTACH() for
3772 * a bus. It calls device_probe_and_attach() for each of the device's
3776 bus_generic_attach(device_t dev)
3780 TAILQ_FOREACH(child, &dev->children, link) {
3781 device_probe_and_attach(child);
3788 * @brief Helper function for delaying attaching children
3790 * Many buses can't run transactions on the bus which children need to probe and
3791 * attach until after interrupts and/or timers are running. This function
3792 * delays their attach until interrupts and timers are enabled.
3795 bus_delayed_attach_children(device_t dev)
3797 /* Probe and attach the bus children when interrupts are available */
3798 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3804 * @brief Helper function for implementing DEVICE_DETACH()
3806 * This function can be used to help implement the DEVICE_DETACH() for
3807 * a bus. It calls device_detach() for each of the device's
3811 bus_generic_detach(device_t dev)
3816 if (dev->state != DS_ATTACHED)
3820 * Detach children in the reverse order.
3821 * See bus_generic_suspend for details.
3823 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3824 if ((error = device_detach(child)) != 0)
3832 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3834 * This function can be used to help implement the DEVICE_SHUTDOWN()
3835 * for a bus. It calls device_shutdown() for each of the device's
3839 bus_generic_shutdown(device_t dev)
3844 * Shut down children in the reverse order.
3845 * See bus_generic_suspend for details.
3847 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3848 device_shutdown(child);
3855 * @brief Default function for suspending a child device.
3857 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3860 bus_generic_suspend_child(device_t dev, device_t child)
3864 error = DEVICE_SUSPEND(child);
3867 child->flags |= DF_SUSPENDED;
3873 * @brief Default function for resuming a child device.
3875 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3878 bus_generic_resume_child(device_t dev, device_t child)
3880 DEVICE_RESUME(child);
3881 child->flags &= ~DF_SUSPENDED;
3887 * @brief Helper function for implementing DEVICE_SUSPEND()
3889 * This function can be used to help implement the DEVICE_SUSPEND()
3890 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3891 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3892 * operation is aborted and any devices which were suspended are
3893 * resumed immediately by calling their DEVICE_RESUME() methods.
3896 bus_generic_suspend(device_t dev)
3902 * Suspend children in the reverse order.
3903 * For most buses all children are equal, so the order does not matter.
3904 * Other buses, such as acpi, carefully order their child devices to
3905 * express implicit dependencies between them. For such buses it is
3906 * safer to bring down devices in the reverse order.
3908 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3909 error = BUS_SUSPEND_CHILD(dev, child);
3911 child = TAILQ_NEXT(child, link);
3912 if (child != NULL) {
3913 TAILQ_FOREACH_FROM(child, &dev->children, link)
3914 BUS_RESUME_CHILD(dev, child);
3923 * @brief Helper function for implementing DEVICE_RESUME()
3925 * This function can be used to help implement the DEVICE_RESUME() for
3926 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3929 bus_generic_resume(device_t dev)
3933 TAILQ_FOREACH(child, &dev->children, link) {
3934 BUS_RESUME_CHILD(dev, child);
3935 /* if resume fails, there's nothing we can usefully do... */
3941 * @brief Helper function for implementing BUS_RESET_POST
3943 * Bus can use this function to implement common operations of
3944 * re-attaching or resuming the children after the bus itself was
3945 * reset, and after restoring bus-unique state of children.
3947 * @param dev The bus
3948 * #param flags DEVF_RESET_*
3951 bus_helper_reset_post(device_t dev, int flags)
3957 TAILQ_FOREACH(child, &dev->children,link) {
3958 BUS_RESET_POST(dev, child);
3959 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3960 device_probe_and_attach(child) :
3961 BUS_RESUME_CHILD(dev, child);
3962 if (error == 0 && error1 != 0)
3969 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3971 child = TAILQ_NEXT(child, link);
3974 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3975 BUS_RESET_POST(dev, child);
3976 if ((flags & DEVF_RESET_DETACH) != 0)
3977 device_probe_and_attach(child);
3979 BUS_RESUME_CHILD(dev, child);
3984 * @brief Helper function for implementing BUS_RESET_PREPARE
3986 * Bus can use this function to implement common operations of
3987 * detaching or suspending the children before the bus itself is
3988 * reset, and then save bus-unique state of children that must
3989 * persists around reset.
3991 * @param dev The bus
3992 * #param flags DEVF_RESET_*
3995 bus_helper_reset_prepare(device_t dev, int flags)
4000 if (dev->state != DS_ATTACHED)
4003 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
4004 if ((flags & DEVF_RESET_DETACH) != 0) {
4005 error = device_get_state(child) == DS_ATTACHED ?
4006 device_detach(child) : 0;
4008 error = BUS_SUSPEND_CHILD(dev, child);
4011 error = BUS_RESET_PREPARE(dev, child);
4013 if ((flags & DEVF_RESET_DETACH) != 0)
4014 device_probe_and_attach(child);
4016 BUS_RESUME_CHILD(dev, child);
4020 bus_helper_reset_prepare_rollback(dev, child, flags);
4028 * @brief Helper function for implementing BUS_PRINT_CHILD().
4030 * This function prints the first part of the ascii representation of
4031 * @p child, including its name, unit and description (if any - see
4032 * device_set_desc()).
4034 * @returns the number of characters printed
4037 bus_print_child_header(device_t dev, device_t child)
4041 if (device_get_desc(child)) {
4042 retval += device_printf(child, "<%s>", device_get_desc(child));
4044 retval += printf("%s", device_get_nameunit(child));
4051 * @brief Helper function for implementing BUS_PRINT_CHILD().
4053 * This function prints the last part of the ascii representation of
4054 * @p child, which consists of the string @c " on " followed by the
4055 * name and unit of the @p dev.
4057 * @returns the number of characters printed
4060 bus_print_child_footer(device_t dev, device_t child)
4062 return (printf(" on %s\n", device_get_nameunit(dev)));
4066 * @brief Helper function for implementing BUS_PRINT_CHILD().
4068 * This function prints out the VM domain for the given device.
4070 * @returns the number of characters printed
4073 bus_print_child_domain(device_t dev, device_t child)
4077 /* No domain? Don't print anything */
4078 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4081 return (printf(" numa-domain %d", domain));
4085 * @brief Helper function for implementing BUS_PRINT_CHILD().
4087 * This function simply calls bus_print_child_header() followed by
4088 * bus_print_child_footer().
4090 * @returns the number of characters printed
4093 bus_generic_print_child(device_t dev, device_t child)
4097 retval += bus_print_child_header(dev, child);
4098 retval += bus_print_child_domain(dev, child);
4099 retval += bus_print_child_footer(dev, child);
4105 * @brief Stub function for implementing BUS_READ_IVAR().
4110 bus_generic_read_ivar(device_t dev, device_t child, int index,
4117 * @brief Stub function for implementing BUS_WRITE_IVAR().
4122 bus_generic_write_ivar(device_t dev, device_t child, int index,
4129 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4133 struct resource_list *
4134 bus_generic_get_resource_list(device_t dev, device_t child)
4140 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4142 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4143 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4144 * and then calls device_probe_and_attach() for each unattached child.
4147 bus_generic_driver_added(device_t dev, driver_t *driver)
4151 DEVICE_IDENTIFY(driver, dev);
4152 TAILQ_FOREACH(child, &dev->children, link) {
4153 if (child->state == DS_NOTPRESENT)
4154 device_probe_and_attach(child);
4159 * @brief Helper function for implementing BUS_NEW_PASS().
4161 * This implementing of BUS_NEW_PASS() first calls the identify
4162 * routines for any drivers that probe at the current pass. Then it
4163 * walks the list of devices for this bus. If a device is already
4164 * attached, then it calls BUS_NEW_PASS() on that device. If the
4165 * device is not already attached, it attempts to attach a driver to
4169 bus_generic_new_pass(device_t dev)
4176 TAILQ_FOREACH(dl, &dc->drivers, link) {
4177 if (dl->pass == bus_current_pass)
4178 DEVICE_IDENTIFY(dl->driver, dev);
4180 TAILQ_FOREACH(child, &dev->children, link) {
4181 if (child->state >= DS_ATTACHED)
4182 BUS_NEW_PASS(child);
4183 else if (child->state == DS_NOTPRESENT)
4184 device_probe_and_attach(child);
4189 * @brief Helper function for implementing BUS_SETUP_INTR().
4191 * This simple implementation of BUS_SETUP_INTR() simply calls the
4192 * BUS_SETUP_INTR() method of the parent of @p dev.
4195 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4196 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4199 /* Propagate up the bus hierarchy until someone handles it. */
4201 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4202 filter, intr, arg, cookiep));
4207 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4209 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4210 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4213 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4216 /* Propagate up the bus hierarchy until someone handles it. */
4218 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4223 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4225 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4226 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4229 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4231 /* Propagate up the bus hierarchy until someone handles it. */
4233 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4238 * @brief Helper function for implementing BUS_RESUME_INTR().
4240 * This simple implementation of BUS_RESUME_INTR() simply calls the
4241 * BUS_RESUME_INTR() method of the parent of @p dev.
4244 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4246 /* Propagate up the bus hierarchy until someone handles it. */
4248 return (BUS_RESUME_INTR(dev->parent, child, irq));
4253 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4255 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4256 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4259 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4260 struct resource *r, rman_res_t start, rman_res_t end)
4262 /* Propagate up the bus hierarchy until someone handles it. */
4264 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4270 * @brief Helper function for implementing BUS_TRANSLATE_RESOURCE().
4272 * This simple implementation of BUS_TRANSLATE_RESOURCE() simply calls the
4273 * BUS_TRANSLATE_RESOURCE() method of the parent of @p dev. If there is no
4274 * parent, no translation happens.
4277 bus_generic_translate_resource(device_t dev, int type, rman_res_t start,
4278 rman_res_t *newstart)
4281 return (BUS_TRANSLATE_RESOURCE(dev->parent, type, start,
4288 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4290 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4291 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4294 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4295 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4297 /* Propagate up the bus hierarchy until someone handles it. */
4299 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4300 start, end, count, flags));
4305 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4307 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4308 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4311 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4314 /* Propagate up the bus hierarchy until someone handles it. */
4316 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4322 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4324 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4325 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4328 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4331 /* Propagate up the bus hierarchy until someone handles it. */
4333 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4339 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4341 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4342 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4345 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4346 int rid, struct resource *r)
4348 /* Propagate up the bus hierarchy until someone handles it. */
4350 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4356 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4358 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4359 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4362 bus_generic_map_resource(device_t dev, device_t child, int type,
4363 struct resource *r, struct resource_map_request *args,
4364 struct resource_map *map)
4366 /* Propagate up the bus hierarchy until someone handles it. */
4368 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4374 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4376 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4377 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4380 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4381 struct resource *r, struct resource_map *map)
4383 /* Propagate up the bus hierarchy until someone handles it. */
4385 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4390 * @brief Helper function for implementing BUS_BIND_INTR().
4392 * This simple implementation of BUS_BIND_INTR() simply calls the
4393 * BUS_BIND_INTR() method of the parent of @p dev.
4396 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4399 /* Propagate up the bus hierarchy until someone handles it. */
4401 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4406 * @brief Helper function for implementing BUS_CONFIG_INTR().
4408 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4409 * BUS_CONFIG_INTR() method of the parent of @p dev.
4412 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4413 enum intr_polarity pol)
4415 /* Propagate up the bus hierarchy until someone handles it. */
4417 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4422 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4424 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4425 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4428 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4429 void *cookie, const char *descr)
4431 /* Propagate up the bus hierarchy until someone handles it. */
4433 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4439 * @brief Helper function for implementing BUS_GET_CPUS().
4441 * This simple implementation of BUS_GET_CPUS() simply calls the
4442 * BUS_GET_CPUS() method of the parent of @p dev.
4445 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4446 size_t setsize, cpuset_t *cpuset)
4448 /* Propagate up the bus hierarchy until someone handles it. */
4449 if (dev->parent != NULL)
4450 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4455 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4457 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4458 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4461 bus_generic_get_dma_tag(device_t dev, device_t child)
4463 /* Propagate up the bus hierarchy until someone handles it. */
4464 if (dev->parent != NULL)
4465 return (BUS_GET_DMA_TAG(dev->parent, child));
4470 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4472 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4473 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4476 bus_generic_get_bus_tag(device_t dev, device_t child)
4478 /* Propagate up the bus hierarchy until someone handles it. */
4479 if (dev->parent != NULL)
4480 return (BUS_GET_BUS_TAG(dev->parent, child));
4481 return ((bus_space_tag_t)0);
4485 * @brief Helper function for implementing BUS_GET_RESOURCE().
4487 * This implementation of BUS_GET_RESOURCE() uses the
4488 * resource_list_find() function to do most of the work. It calls
4489 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4493 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4494 rman_res_t *startp, rman_res_t *countp)
4496 struct resource_list * rl = NULL;
4497 struct resource_list_entry * rle = NULL;
4499 rl = BUS_GET_RESOURCE_LIST(dev, child);
4503 rle = resource_list_find(rl, type, rid);
4508 *startp = rle->start;
4510 *countp = rle->count;
4516 * @brief Helper function for implementing BUS_SET_RESOURCE().
4518 * This implementation of BUS_SET_RESOURCE() uses the
4519 * resource_list_add() function to do most of the work. It calls
4520 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4524 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4525 rman_res_t start, rman_res_t count)
4527 struct resource_list * rl = NULL;
4529 rl = BUS_GET_RESOURCE_LIST(dev, child);
4533 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4539 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4541 * This implementation of BUS_DELETE_RESOURCE() uses the
4542 * resource_list_delete() function to do most of the work. It calls
4543 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4547 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4549 struct resource_list * rl = NULL;
4551 rl = BUS_GET_RESOURCE_LIST(dev, child);
4555 resource_list_delete(rl, type, rid);
4561 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4563 * This implementation of BUS_RELEASE_RESOURCE() uses the
4564 * resource_list_release() function to do most of the work. It calls
4565 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4568 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4569 int rid, struct resource *r)
4571 struct resource_list * rl = NULL;
4573 if (device_get_parent(child) != dev)
4574 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4577 rl = BUS_GET_RESOURCE_LIST(dev, child);
4581 return (resource_list_release(rl, dev, child, type, rid, r));
4585 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4587 * This implementation of BUS_ALLOC_RESOURCE() uses the
4588 * resource_list_alloc() function to do most of the work. It calls
4589 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4592 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4593 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4595 struct resource_list * rl = NULL;
4597 if (device_get_parent(child) != dev)
4598 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4599 type, rid, start, end, count, flags));
4601 rl = BUS_GET_RESOURCE_LIST(dev, child);
4605 return (resource_list_alloc(rl, dev, child, type, rid,
4606 start, end, count, flags));
4610 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4612 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4613 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4616 bus_generic_child_present(device_t dev, device_t child)
4618 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4622 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4625 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4631 * @brief Helper function for implementing BUS_RESCAN().
4633 * This null implementation of BUS_RESCAN() always fails to indicate
4634 * the bus does not support rescanning.
4637 bus_null_rescan(device_t dev)
4643 * Some convenience functions to make it easier for drivers to use the
4644 * resource-management functions. All these really do is hide the
4645 * indirection through the parent's method table, making for slightly
4646 * less-wordy code. In the future, it might make sense for this code
4647 * to maintain some sort of a list of resources allocated by each device.
4651 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4652 struct resource **res)
4656 for (i = 0; rs[i].type != -1; i++)
4658 for (i = 0; rs[i].type != -1; i++) {
4659 res[i] = bus_alloc_resource_any(dev,
4660 rs[i].type, &rs[i].rid, rs[i].flags);
4661 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4662 bus_release_resources(dev, rs, res);
4670 bus_release_resources(device_t dev, const struct resource_spec *rs,
4671 struct resource **res)
4675 for (i = 0; rs[i].type != -1; i++)
4676 if (res[i] != NULL) {
4677 bus_release_resource(
4678 dev, rs[i].type, rs[i].rid, res[i]);
4684 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4686 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4690 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4691 rman_res_t end, rman_res_t count, u_int flags)
4693 struct resource *res;
4695 if (dev->parent == NULL)
4697 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4703 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4705 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4709 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4712 if (dev->parent == NULL)
4714 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4718 * @brief Wrapper function for BUS_TRANSLATE_RESOURCE().
4720 * This function simply calls the BUS_TRANSLATE_RESOURCE() method of the
4724 bus_translate_resource(device_t dev, int type, rman_res_t start,
4725 rman_res_t *newstart)
4727 if (dev->parent == NULL)
4729 return (BUS_TRANSLATE_RESOURCE(dev->parent, type, start, newstart));
4733 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4735 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4739 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4741 if (dev->parent == NULL)
4743 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4747 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4749 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4753 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4755 if (dev->parent == NULL)
4757 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4761 * @brief Wrapper function for BUS_MAP_RESOURCE().
4763 * This function simply calls the BUS_MAP_RESOURCE() method of the
4767 bus_map_resource(device_t dev, int type, struct resource *r,
4768 struct resource_map_request *args, struct resource_map *map)
4770 if (dev->parent == NULL)
4772 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4776 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4778 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4782 bus_unmap_resource(device_t dev, int type, struct resource *r,
4783 struct resource_map *map)
4785 if (dev->parent == NULL)
4787 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4791 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4793 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4797 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4801 if (dev->parent == NULL)
4803 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4808 * @brief Wrapper function for BUS_SETUP_INTR().
4810 * This function simply calls the BUS_SETUP_INTR() method of the
4814 bus_setup_intr(device_t dev, struct resource *r, int flags,
4815 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4819 if (dev->parent == NULL)
4821 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4825 if (handler != NULL && !(flags & INTR_MPSAFE))
4826 device_printf(dev, "[GIANT-LOCKED]\n");
4831 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4833 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4837 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4839 if (dev->parent == NULL)
4841 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4845 * @brief Wrapper function for BUS_SUSPEND_INTR().
4847 * This function simply calls the BUS_SUSPEND_INTR() method of the
4851 bus_suspend_intr(device_t dev, struct resource *r)
4853 if (dev->parent == NULL)
4855 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4859 * @brief Wrapper function for BUS_RESUME_INTR().
4861 * This function simply calls the BUS_RESUME_INTR() method of the
4865 bus_resume_intr(device_t dev, struct resource *r)
4867 if (dev->parent == NULL)
4869 return (BUS_RESUME_INTR(dev->parent, dev, r));
4873 * @brief Wrapper function for BUS_BIND_INTR().
4875 * This function simply calls the BUS_BIND_INTR() method of the
4879 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4881 if (dev->parent == NULL)
4883 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4887 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4889 * This function first formats the requested description into a
4890 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4891 * the parent of @p dev.
4894 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4895 const char *fmt, ...)
4898 char descr[MAXCOMLEN + 1];
4900 if (dev->parent == NULL)
4903 vsnprintf(descr, sizeof(descr), fmt, ap);
4905 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4909 * @brief Wrapper function for BUS_SET_RESOURCE().
4911 * This function simply calls the BUS_SET_RESOURCE() method of the
4915 bus_set_resource(device_t dev, int type, int rid,
4916 rman_res_t start, rman_res_t count)
4918 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4923 * @brief Wrapper function for BUS_GET_RESOURCE().
4925 * This function simply calls the BUS_GET_RESOURCE() method of the
4929 bus_get_resource(device_t dev, int type, int rid,
4930 rman_res_t *startp, rman_res_t *countp)
4932 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4937 * @brief Wrapper function for BUS_GET_RESOURCE().
4939 * This function simply calls the BUS_GET_RESOURCE() method of the
4940 * parent of @p dev and returns the start value.
4943 bus_get_resource_start(device_t dev, int type, int rid)
4949 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4957 * @brief Wrapper function for BUS_GET_RESOURCE().
4959 * This function simply calls the BUS_GET_RESOURCE() method of the
4960 * parent of @p dev and returns the count value.
4963 bus_get_resource_count(device_t dev, int type, int rid)
4969 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4977 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4979 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4983 bus_delete_resource(device_t dev, int type, int rid)
4985 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4989 * @brief Wrapper function for BUS_CHILD_PRESENT().
4991 * This function simply calls the BUS_CHILD_PRESENT() method of the
4995 bus_child_present(device_t child)
4997 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
5001 * @brief Wrapper function for BUS_CHILD_PNPINFO().
5003 * This function simply calls the BUS_CHILD_PNPINFO() method of the parent of @p
5007 bus_child_pnpinfo(device_t child, struct sbuf *sb)
5011 parent = device_get_parent(child);
5014 return (BUS_CHILD_PNPINFO(parent, child, sb));
5018 * @brief Generic implementation that does nothing for bus_child_pnpinfo
5020 * This function has the right signature and returns 0 since the sbuf is passed
5021 * to us to append to.
5024 bus_generic_child_pnpinfo(device_t dev, device_t child, struct sbuf *sb)
5030 * @brief Wrapper function for BUS_CHILD_LOCATION().
5032 * This function simply calls the BUS_CHILD_LOCATION() method of the parent of
5036 bus_child_location(device_t child, struct sbuf *sb)
5040 parent = device_get_parent(child);
5043 return (BUS_CHILD_LOCATION(parent, child, sb));
5047 * @brief Generic implementation that does nothing for bus_child_location
5049 * This function has the right signature and returns 0 since the sbuf is passed
5050 * to us to append to.
5053 bus_generic_child_location(device_t dev, device_t child, struct sbuf *sb)
5059 * @brief Wrapper function for BUS_GET_CPUS().
5061 * This function simply calls the BUS_GET_CPUS() method of the
5065 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5069 parent = device_get_parent(dev);
5072 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5076 * @brief Wrapper function for BUS_GET_DMA_TAG().
5078 * This function simply calls the BUS_GET_DMA_TAG() method of the
5082 bus_get_dma_tag(device_t dev)
5086 parent = device_get_parent(dev);
5089 return (BUS_GET_DMA_TAG(parent, dev));
5093 * @brief Wrapper function for BUS_GET_BUS_TAG().
5095 * This function simply calls the BUS_GET_BUS_TAG() method of the
5099 bus_get_bus_tag(device_t dev)
5103 parent = device_get_parent(dev);
5105 return ((bus_space_tag_t)0);
5106 return (BUS_GET_BUS_TAG(parent, dev));
5110 * @brief Wrapper function for BUS_GET_DOMAIN().
5112 * This function simply calls the BUS_GET_DOMAIN() method of the
5116 bus_get_domain(device_t dev, int *domain)
5118 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5121 /* Resume all devices and then notify userland that we're up again. */
5123 root_resume(device_t dev)
5127 error = bus_generic_resume(dev);
5129 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5130 devctl_notify("kernel", "power", "resume", NULL);
5136 root_print_child(device_t dev, device_t child)
5140 retval += bus_print_child_header(dev, child);
5141 retval += printf("\n");
5147 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5148 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5151 * If an interrupt mapping gets to here something bad has happened.
5153 panic("root_setup_intr");
5157 * If we get here, assume that the device is permanent and really is
5158 * present in the system. Removable bus drivers are expected to intercept
5159 * this call long before it gets here. We return -1 so that drivers that
5160 * really care can check vs -1 or some ERRNO returned higher in the food
5164 root_child_present(device_t dev, device_t child)
5170 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5175 /* Default to returning the set of all CPUs. */
5176 if (setsize != sizeof(cpuset_t))
5185 static kobj_method_t root_methods[] = {
5186 /* Device interface */
5187 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5188 KOBJMETHOD(device_suspend, bus_generic_suspend),
5189 KOBJMETHOD(device_resume, root_resume),
5192 KOBJMETHOD(bus_print_child, root_print_child),
5193 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5194 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5195 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5196 KOBJMETHOD(bus_child_present, root_child_present),
5197 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5202 static driver_t root_driver = {
5209 devclass_t root_devclass;
5212 root_bus_module_handler(module_t mod, int what, void* arg)
5216 TAILQ_INIT(&bus_data_devices);
5217 kobj_class_compile((kobj_class_t) &root_driver);
5218 root_bus = make_device(NULL, "root", 0);
5219 root_bus->desc = "System root bus";
5220 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5221 root_bus->driver = &root_driver;
5222 root_bus->state = DS_ATTACHED;
5223 root_devclass = devclass_find_internal("root", NULL, FALSE);
5228 device_shutdown(root_bus);
5231 return (EOPNOTSUPP);
5237 static moduledata_t root_bus_mod = {
5239 root_bus_module_handler,
5242 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5245 * @brief Automatically configure devices
5247 * This function begins the autoconfiguration process by calling
5248 * device_probe_and_attach() for each child of the @c root0 device.
5251 root_bus_configure(void)
5255 /* Eventually this will be split up, but this is sufficient for now. */
5256 bus_set_pass(BUS_PASS_DEFAULT);
5260 * @brief Module handler for registering device drivers
5262 * This module handler is used to automatically register device
5263 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5264 * devclass_add_driver() for the driver described by the
5265 * driver_module_data structure pointed to by @p arg
5268 driver_module_handler(module_t mod, int what, void *arg)
5270 struct driver_module_data *dmd;
5271 devclass_t bus_devclass;
5272 kobj_class_t driver;
5275 dmd = (struct driver_module_data *)arg;
5276 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5281 if (dmd->dmd_chainevh)
5282 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5284 pass = dmd->dmd_pass;
5285 driver = dmd->dmd_driver;
5286 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5287 DRIVERNAME(driver), dmd->dmd_busname, pass));
5288 error = devclass_add_driver(bus_devclass, driver, pass,
5293 PDEBUG(("Unloading module: driver %s from bus %s",
5294 DRIVERNAME(dmd->dmd_driver),
5296 error = devclass_delete_driver(bus_devclass,
5299 if (!error && dmd->dmd_chainevh)
5300 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5303 PDEBUG(("Quiesce module: driver %s from bus %s",
5304 DRIVERNAME(dmd->dmd_driver),
5306 error = devclass_quiesce_driver(bus_devclass,
5309 if (!error && dmd->dmd_chainevh)
5310 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5321 * @brief Enumerate all hinted devices for this bus.
5323 * Walks through the hints for this bus and calls the bus_hinted_child
5324 * routine for each one it fines. It searches first for the specific
5325 * bus that's being probed for hinted children (eg isa0), and then for
5326 * generic children (eg isa).
5328 * @param dev bus device to enumerate
5331 bus_enumerate_hinted_children(device_t bus)
5334 const char *dname, *busname;
5338 * enumerate all devices on the specific bus
5340 busname = device_get_nameunit(bus);
5342 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5343 BUS_HINTED_CHILD(bus, dname, dunit);
5346 * and all the generic ones.
5348 busname = device_get_name(bus);
5350 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5351 BUS_HINTED_CHILD(bus, dname, dunit);
5356 /* the _short versions avoid iteration by not calling anything that prints
5357 * more than oneliners. I love oneliners.
5361 print_device_short(device_t dev, int indent)
5366 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5367 dev->unit, dev->desc,
5368 (dev->parent? "":"no "),
5369 (TAILQ_EMPTY(&dev->children)? "no ":""),
5370 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5371 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5372 (dev->flags&DF_WILDCARD? "wildcard,":""),
5373 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5374 (dev->flags&DF_SUSPENDED? "suspended,":""),
5375 (dev->ivars? "":"no "),
5376 (dev->softc? "":"no "),
5381 print_device(device_t dev, int indent)
5386 print_device_short(dev, indent);
5388 indentprintf(("Parent:\n"));
5389 print_device_short(dev->parent, indent+1);
5390 indentprintf(("Driver:\n"));
5391 print_driver_short(dev->driver, indent+1);
5392 indentprintf(("Devclass:\n"));
5393 print_devclass_short(dev->devclass, indent+1);
5397 print_device_tree_short(device_t dev, int indent)
5398 /* print the device and all its children (indented) */
5405 print_device_short(dev, indent);
5407 TAILQ_FOREACH(child, &dev->children, link) {
5408 print_device_tree_short(child, indent+1);
5413 print_device_tree(device_t dev, int indent)
5414 /* print the device and all its children (indented) */
5421 print_device(dev, indent);
5423 TAILQ_FOREACH(child, &dev->children, link) {
5424 print_device_tree(child, indent+1);
5429 print_driver_short(driver_t *driver, int indent)
5434 indentprintf(("driver %s: softc size = %zd\n",
5435 driver->name, driver->size));
5439 print_driver(driver_t *driver, int indent)
5444 print_driver_short(driver, indent);
5448 print_driver_list(driver_list_t drivers, int indent)
5450 driverlink_t driver;
5452 TAILQ_FOREACH(driver, &drivers, link) {
5453 print_driver(driver->driver, indent);
5458 print_devclass_short(devclass_t dc, int indent)
5463 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5467 print_devclass(devclass_t dc, int indent)
5474 print_devclass_short(dc, indent);
5475 indentprintf(("Drivers:\n"));
5476 print_driver_list(dc->drivers, indent+1);
5478 indentprintf(("Devices:\n"));
5479 for (i = 0; i < dc->maxunit; i++)
5481 print_device(dc->devices[i], indent+1);
5485 print_devclass_list_short(void)
5489 printf("Short listing of devclasses, drivers & devices:\n");
5490 TAILQ_FOREACH(dc, &devclasses, link) {
5491 print_devclass_short(dc, 0);
5496 print_devclass_list(void)
5500 printf("Full listing of devclasses, drivers & devices:\n");
5501 TAILQ_FOREACH(dc, &devclasses, link) {
5502 print_devclass(dc, 0);
5509 * User-space access to the device tree.
5511 * We implement a small set of nodes:
5513 * hw.bus Single integer read method to obtain the
5514 * current generation count.
5515 * hw.bus.devices Reads the entire device tree in flat space.
5516 * hw.bus.rman Resource manager interface
5518 * We might like to add the ability to scan devclasses and/or drivers to
5519 * determine what else is currently loaded/available.
5523 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5525 struct u_businfo ubus;
5527 ubus.ub_version = BUS_USER_VERSION;
5528 ubus.ub_generation = bus_data_generation;
5530 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5532 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5533 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5534 "bus-related data");
5537 sysctl_devices(SYSCTL_HANDLER_ARGS)
5540 int *name = (int *)arg1;
5541 u_int namelen = arg2;
5544 struct u_device *udev;
5550 if (bus_data_generation_check(name[0]))
5556 * Scan the list of devices, looking for the requested index.
5558 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5566 * Populate the return item, careful not to overflow the buffer.
5568 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5571 udev->dv_handle = (uintptr_t)dev;
5572 udev->dv_parent = (uintptr_t)dev->parent;
5573 udev->dv_devflags = dev->devflags;
5574 udev->dv_flags = dev->flags;
5575 udev->dv_state = dev->state;
5576 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5577 if (dev->nameunit != NULL)
5578 sbuf_cat(&sb, dev->nameunit);
5579 sbuf_putc(&sb, '\0');
5580 if (dev->desc != NULL)
5581 sbuf_cat(&sb, dev->desc);
5582 sbuf_putc(&sb, '\0');
5583 if (dev->driver != NULL)
5584 sbuf_cat(&sb, dev->driver->name);
5585 sbuf_putc(&sb, '\0');
5586 bus_child_pnpinfo(dev, &sb);
5587 sbuf_putc(&sb, '\0');
5588 bus_child_location(dev, &sb);
5589 sbuf_putc(&sb, '\0');
5590 error = sbuf_finish(&sb);
5592 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5598 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5599 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5600 "system device tree");
5603 bus_data_generation_check(int generation)
5605 if (generation != bus_data_generation)
5608 /* XXX generate optimised lists here? */
5613 bus_data_generation_update(void)
5615 atomic_add_int(&bus_data_generation, 1);
5619 bus_free_resource(device_t dev, int type, struct resource *r)
5623 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5627 device_lookup_by_name(const char *name)
5631 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5632 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5639 * /dev/devctl2 implementation. The existing /dev/devctl device has
5640 * implicit semantics on open, so it could not be reused for this.
5641 * Another option would be to call this /dev/bus?
5644 find_device(struct devreq *req, device_t *devp)
5649 * First, ensure that the name is nul terminated.
5651 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5655 * Second, try to find an attached device whose name matches
5658 dev = device_lookup_by_name(req->dr_name);
5664 /* Finally, give device enumerators a chance. */
5666 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5674 driver_exists(device_t bus, const char *driver)
5678 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5679 if (devclass_find_driver_internal(dc, driver) != NULL)
5686 device_gen_nomatch(device_t dev)
5690 if (dev->flags & DF_NEEDNOMATCH &&
5691 dev->state == DS_NOTPRESENT) {
5692 BUS_PROBE_NOMATCH(dev->parent, dev);
5694 dev->flags |= DF_DONENOMATCH;
5696 dev->flags &= ~DF_NEEDNOMATCH;
5697 TAILQ_FOREACH(child, &dev->children, link) {
5698 device_gen_nomatch(child);
5703 device_do_deferred_actions(void)
5709 * Walk through the devclasses to find all the drivers we've tagged as
5710 * deferred during the freeze and call the driver added routines. They
5711 * have already been added to the lists in the background, so the driver
5712 * added routines that trigger a probe will have all the right bidders
5713 * for the probe auction.
5715 TAILQ_FOREACH(dc, &devclasses, link) {
5716 TAILQ_FOREACH(dl, &dc->drivers, link) {
5717 if (dl->flags & DL_DEFERRED_PROBE) {
5718 devclass_driver_added(dc, dl->driver);
5719 dl->flags &= ~DL_DEFERRED_PROBE;
5725 * We also defer no-match events during a freeze. Walk the tree and
5726 * generate all the pent-up events that are still relevant.
5728 device_gen_nomatch(root_bus);
5729 bus_data_generation_update();
5733 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5740 /* Locate the device to control. */
5742 req = (struct devreq *)data;
5750 case DEV_SET_DRIVER:
5751 case DEV_CLEAR_DRIVER:
5755 error = priv_check(td, PRIV_DRIVER);
5757 error = find_device(req, &dev);
5761 error = priv_check(td, PRIV_DRIVER);
5772 /* Perform the requested operation. */
5775 if (device_is_attached(dev))
5777 else if (!device_is_enabled(dev))
5780 error = device_probe_and_attach(dev);
5783 if (!device_is_attached(dev)) {
5787 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5788 error = device_quiesce(dev);
5792 error = device_detach(dev);
5795 if (device_is_enabled(dev)) {
5801 * If the device has been probed but not attached (e.g.
5802 * when it has been disabled by a loader hint), just
5803 * attach the device rather than doing a full probe.
5806 if (device_is_alive(dev)) {
5808 * If the device was disabled via a hint, clear
5811 if (resource_disabled(dev->driver->name, dev->unit))
5812 resource_unset_value(dev->driver->name,
5813 dev->unit, "disabled");
5814 error = device_attach(dev);
5816 error = device_probe_and_attach(dev);
5819 if (!device_is_enabled(dev)) {
5824 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5825 error = device_quiesce(dev);
5831 * Force DF_FIXEDCLASS on around detach to preserve
5832 * the existing name.
5835 dev->flags |= DF_FIXEDCLASS;
5836 error = device_detach(dev);
5837 if (!(old & DF_FIXEDCLASS))
5838 dev->flags &= ~DF_FIXEDCLASS;
5840 device_disable(dev);
5843 if (device_is_suspended(dev)) {
5847 if (device_get_parent(dev) == NULL) {
5851 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5854 if (!device_is_suspended(dev)) {
5858 if (device_get_parent(dev) == NULL) {
5862 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5864 case DEV_SET_DRIVER: {
5868 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5871 if (driver[0] == '\0') {
5875 if (dev->devclass != NULL &&
5876 strcmp(driver, dev->devclass->name) == 0)
5877 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5881 * Scan drivers for this device's bus looking for at
5882 * least one matching driver.
5884 if (dev->parent == NULL) {
5888 if (!driver_exists(dev->parent, driver)) {
5892 dc = devclass_create(driver);
5898 /* Detach device if necessary. */
5899 if (device_is_attached(dev)) {
5900 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5901 error = device_detach(dev);
5908 /* Clear any previously-fixed device class and unit. */
5909 if (dev->flags & DF_FIXEDCLASS)
5910 devclass_delete_device(dev->devclass, dev);
5911 dev->flags |= DF_WILDCARD;
5914 /* Force the new device class. */
5915 error = devclass_add_device(dc, dev);
5918 dev->flags |= DF_FIXEDCLASS;
5919 error = device_probe_and_attach(dev);
5922 case DEV_CLEAR_DRIVER:
5923 if (!(dev->flags & DF_FIXEDCLASS)) {
5927 if (device_is_attached(dev)) {
5928 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5929 error = device_detach(dev);
5936 dev->flags &= ~DF_FIXEDCLASS;
5937 dev->flags |= DF_WILDCARD;
5938 devclass_delete_device(dev->devclass, dev);
5939 error = device_probe_and_attach(dev);
5942 if (!device_is_attached(dev)) {
5946 error = BUS_RESCAN(dev);
5951 parent = device_get_parent(dev);
5952 if (parent == NULL) {
5956 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5957 if (bus_child_present(dev) != 0) {
5963 error = device_delete_child(parent, dev);
5970 device_frozen = true;
5976 device_do_deferred_actions();
5977 device_frozen = false;
5981 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5985 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5993 static struct cdevsw devctl2_cdevsw = {
5994 .d_version = D_VERSION,
5995 .d_ioctl = devctl2_ioctl,
5996 .d_name = "devctl2",
6002 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
6003 UID_ROOT, GID_WHEEL, 0600, "devctl2");
6007 * APIs to manage deprecation and obsolescence.
6009 static int obsolete_panic = 0;
6010 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
6011 "Panic when obsolete features are used (0 = never, 1 = if obsolete, "
6012 "2 = if deprecated)");
6015 gone_panic(int major, int running, const char *msg)
6017 switch (obsolete_panic)
6022 if (running < major)
6031 _gone_in(int major, const char *msg)
6033 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6034 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6035 printf("Obsolete code will be removed soon: %s\n", msg);
6037 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
6042 _gone_in_dev(device_t dev, int major, const char *msg)
6044 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6045 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6047 "Obsolete code will be removed soon: %s\n", msg);
6050 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6055 DB_SHOW_COMMAND(device, db_show_device)
6062 dev = (device_t)addr;
6064 db_printf("name: %s\n", device_get_nameunit(dev));
6065 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6066 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6067 db_printf(" addr: %p\n", dev);
6068 db_printf(" parent: %p\n", dev->parent);
6069 db_printf(" softc: %p\n", dev->softc);
6070 db_printf(" ivars: %p\n", dev->ivars);
6073 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6077 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6078 db_show_device((db_expr_t)dev, true, count, modif);