2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
77 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
81 * Used to attach drivers to devclasses.
83 typedef struct driverlink *driverlink_t;
86 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
89 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
90 TAILQ_ENTRY(driverlink) passlink;
94 * Forward declarations
96 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
97 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
98 typedef TAILQ_HEAD(device_list, device) device_list_t;
101 TAILQ_ENTRY(devclass) link;
102 devclass_t parent; /* parent in devclass hierarchy */
103 driver_list_t drivers; /* bus devclasses store drivers for bus */
105 device_t *devices; /* array of devices indexed by unit */
106 int maxunit; /* size of devices array */
108 #define DC_HAS_CHILDREN 1
110 struct sysctl_ctx_list sysctl_ctx;
111 struct sysctl_oid *sysctl_tree;
115 * @brief Implementation of device.
119 * A device is a kernel object. The first field must be the
120 * current ops table for the object.
127 TAILQ_ENTRY(device) link; /**< list of devices in parent */
128 TAILQ_ENTRY(device) devlink; /**< global device list membership */
129 device_t parent; /**< parent of this device */
130 device_list_t children; /**< list of child devices */
133 * Details of this device.
135 driver_t *driver; /**< current driver */
136 devclass_t devclass; /**< current device class */
137 int unit; /**< current unit number */
138 char* nameunit; /**< name+unit e.g. foodev0 */
139 char* desc; /**< driver specific description */
140 int busy; /**< count of calls to device_busy() */
141 device_state_t state; /**< current device state */
142 uint32_t devflags; /**< api level flags for device_get_flags() */
143 u_int flags; /**< internal device flags */
144 u_int order; /**< order from device_add_child_ordered() */
145 void *ivars; /**< instance variables */
146 void *softc; /**< current driver's variables */
148 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
149 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
152 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
153 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
155 EVENTHANDLER_LIST_DEFINE(device_attach);
156 EVENTHANDLER_LIST_DEFINE(device_detach);
157 EVENTHANDLER_LIST_DEFINE(dev_lookup);
159 static int bus_child_location_sb(device_t child, struct sbuf *sb);
160 static int bus_child_pnpinfo_sb(device_t child, struct sbuf *sb);
161 static void devctl2_init(void);
162 static bool device_frozen;
164 #define DRIVERNAME(d) ((d)? d->name : "no driver")
165 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
169 static int bus_debug = 1;
170 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
172 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
173 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
176 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
177 * prevent syslog from deleting initial spaces
179 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
181 static void print_device_short(device_t dev, int indent);
182 static void print_device(device_t dev, int indent);
183 void print_device_tree_short(device_t dev, int indent);
184 void print_device_tree(device_t dev, int indent);
185 static void print_driver_short(driver_t *driver, int indent);
186 static void print_driver(driver_t *driver, int indent);
187 static void print_driver_list(driver_list_t drivers, int indent);
188 static void print_devclass_short(devclass_t dc, int indent);
189 static void print_devclass(devclass_t dc, int indent);
190 void print_devclass_list_short(void);
191 void print_devclass_list(void);
194 /* Make the compiler ignore the function calls */
195 #define PDEBUG(a) /* nop */
196 #define DEVICENAME(d) /* nop */
198 #define print_device_short(d,i) /* nop */
199 #define print_device(d,i) /* nop */
200 #define print_device_tree_short(d,i) /* nop */
201 #define print_device_tree(d,i) /* nop */
202 #define print_driver_short(d,i) /* nop */
203 #define print_driver(d,i) /* nop */
204 #define print_driver_list(d,i) /* nop */
205 #define print_devclass_short(d,i) /* nop */
206 #define print_devclass(d,i) /* nop */
207 #define print_devclass_list_short() /* nop */
208 #define print_devclass_list() /* nop */
216 DEVCLASS_SYSCTL_PARENT,
220 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
222 devclass_t dc = (devclass_t)arg1;
226 case DEVCLASS_SYSCTL_PARENT:
227 value = dc->parent ? dc->parent->name : "";
232 return (SYSCTL_OUT_STR(req, value));
236 devclass_sysctl_init(devclass_t dc)
238 if (dc->sysctl_tree != NULL)
240 sysctl_ctx_init(&dc->sysctl_ctx);
241 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
242 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
243 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
244 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
246 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
247 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
253 DEVICE_SYSCTL_DRIVER,
254 DEVICE_SYSCTL_LOCATION,
255 DEVICE_SYSCTL_PNPINFO,
256 DEVICE_SYSCTL_PARENT,
260 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
263 device_t dev = (device_t)arg1;
266 sbuf_new_for_sysctl(&sb, NULL, 1024, req);
267 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
269 case DEVICE_SYSCTL_DESC:
270 sbuf_cat(&sb, dev->desc ? dev->desc : "");
272 case DEVICE_SYSCTL_DRIVER:
273 sbuf_cat(&sb, dev->driver ? dev->driver->name : "");
275 case DEVICE_SYSCTL_LOCATION:
276 bus_child_location_sb(dev, &sb);
278 case DEVICE_SYSCTL_PNPINFO:
279 bus_child_pnpinfo_sb(dev, &sb);
281 case DEVICE_SYSCTL_PARENT:
282 sbuf_cat(&sb, dev->parent ? dev->parent->nameunit : "");
288 error = sbuf_finish(&sb);
294 device_sysctl_init(device_t dev)
296 devclass_t dc = dev->devclass;
299 if (dev->sysctl_tree != NULL)
301 devclass_sysctl_init(dc);
302 sysctl_ctx_init(&dev->sysctl_ctx);
303 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
304 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
305 dev->nameunit + strlen(dc->name),
306 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
307 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
308 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
309 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
310 "device description");
311 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
313 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
314 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
315 "device driver name");
316 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
317 OID_AUTO, "%location",
318 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
319 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
320 "device location relative to parent");
321 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
322 OID_AUTO, "%pnpinfo",
323 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
324 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
325 "device identification");
326 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
328 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
329 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
331 if (bus_get_domain(dev, &domain) == 0)
332 SYSCTL_ADD_INT(&dev->sysctl_ctx,
333 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
334 CTLFLAG_RD, NULL, domain, "NUMA domain");
338 device_sysctl_update(device_t dev)
340 devclass_t dc = dev->devclass;
342 if (dev->sysctl_tree == NULL)
344 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
348 device_sysctl_fini(device_t dev)
350 if (dev->sysctl_tree == NULL)
352 sysctl_ctx_free(&dev->sysctl_ctx);
353 dev->sysctl_tree = NULL;
357 * /dev/devctl implementation
361 * This design allows only one reader for /dev/devctl. This is not desirable
362 * in the long run, but will get a lot of hair out of this implementation.
363 * Maybe we should make this device a clonable device.
365 * Also note: we specifically do not attach a device to the device_t tree
366 * to avoid potential chicken and egg problems. One could argue that all
367 * of this belongs to the root node.
370 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
371 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
372 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
373 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
374 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
376 static d_open_t devopen;
377 static d_close_t devclose;
378 static d_read_t devread;
379 static d_ioctl_t devioctl;
380 static d_poll_t devpoll;
381 static d_kqfilter_t devkqfilter;
383 static struct cdevsw dev_cdevsw = {
384 .d_version = D_VERSION,
390 .d_kqfilter = devkqfilter,
394 #define DEVCTL_BUFFER (1024 - sizeof(void *))
395 struct dev_event_info {
396 STAILQ_ENTRY(dev_event_info) dei_link;
397 char dei_data[DEVCTL_BUFFER];
400 STAILQ_HEAD(devq, dev_event_info);
402 static struct dev_softc {
415 static void filt_devctl_detach(struct knote *kn);
416 static int filt_devctl_read(struct knote *kn, long hint);
418 struct filterops devctl_rfiltops = {
420 .f_detach = filt_devctl_detach,
421 .f_event = filt_devctl_read,
424 static struct cdev *devctl_dev;
432 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
433 UID_ROOT, GID_WHEEL, 0600, "devctl");
434 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
435 cv_init(&devsoftc.cv, "dev cv");
436 STAILQ_INIT(&devsoftc.devq);
437 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
438 if (devctl_queue_length > 0) {
440 * Allocate a zone for the messages. Preallocate 2% of these for
441 * a reserve. Allow only devctl_queue_length slabs to cap memory
442 * usage. The reserve usually allows coverage of surges of
443 * events during memory shortages. Normally we won't have to
444 * re-use events from the queue, but will in extreme shortages.
446 z = devsoftc.zone = uma_zcreate("DEVCTL",
447 sizeof(struct dev_event_info), NULL, NULL, NULL, NULL,
449 reserve = max(devctl_queue_length / 50, 100); /* 2% reserve */
450 uma_zone_set_max(z, devctl_queue_length);
451 uma_zone_set_maxcache(z, 0);
452 uma_zone_reserve(z, reserve);
453 uma_prealloc(z, reserve);
459 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
461 mtx_lock(&devsoftc.mtx);
462 if (devsoftc.inuse) {
463 mtx_unlock(&devsoftc.mtx);
468 mtx_unlock(&devsoftc.mtx);
473 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
475 mtx_lock(&devsoftc.mtx);
477 devsoftc.nonblock = 0;
479 cv_broadcast(&devsoftc.cv);
480 funsetown(&devsoftc.sigio);
481 mtx_unlock(&devsoftc.mtx);
486 * The read channel for this device is used to report changes to
487 * userland in realtime. We are required to free the data as well as
488 * the n1 object because we allocate them separately. Also note that
489 * we return one record at a time. If you try to read this device a
490 * character at a time, you will lose the rest of the data. Listening
491 * programs are expected to cope.
494 devread(struct cdev *dev, struct uio *uio, int ioflag)
496 struct dev_event_info *n1;
499 mtx_lock(&devsoftc.mtx);
500 while (STAILQ_EMPTY(&devsoftc.devq)) {
501 if (devsoftc.nonblock) {
502 mtx_unlock(&devsoftc.mtx);
505 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
508 * Need to translate ERESTART to EINTR here? -- jake
510 mtx_unlock(&devsoftc.mtx);
514 n1 = STAILQ_FIRST(&devsoftc.devq);
515 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
517 mtx_unlock(&devsoftc.mtx);
518 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
519 uma_zfree(devsoftc.zone, n1);
524 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
529 devsoftc.nonblock = 1;
531 devsoftc.nonblock = 0;
540 return fsetown(*(int *)data, &devsoftc.sigio);
542 *(int *)data = fgetown(&devsoftc.sigio);
545 /* (un)Support for other fcntl() calls. */
556 devpoll(struct cdev *dev, int events, struct thread *td)
560 mtx_lock(&devsoftc.mtx);
561 if (events & (POLLIN | POLLRDNORM)) {
562 if (!STAILQ_EMPTY(&devsoftc.devq))
563 revents = events & (POLLIN | POLLRDNORM);
565 selrecord(td, &devsoftc.sel);
567 mtx_unlock(&devsoftc.mtx);
573 devkqfilter(struct cdev *dev, struct knote *kn)
577 if (kn->kn_filter == EVFILT_READ) {
578 kn->kn_fop = &devctl_rfiltops;
579 knlist_add(&devsoftc.sel.si_note, kn, 0);
587 filt_devctl_detach(struct knote *kn)
589 knlist_remove(&devsoftc.sel.si_note, kn, 0);
593 filt_devctl_read(struct knote *kn, long hint)
595 kn->kn_data = devsoftc.queued;
596 return (kn->kn_data != 0);
600 * @brief Return whether the userland process is running
603 devctl_process_running(void)
605 return (devsoftc.inuse == 1);
608 static struct dev_event_info *
609 devctl_alloc_dei(void)
611 struct dev_event_info *dei = NULL;
613 mtx_lock(&devsoftc.mtx);
614 if (devctl_queue_length == 0)
616 dei = uma_zalloc(devsoftc.zone, M_NOWAIT);
618 dei = uma_zalloc(devsoftc.zone, M_NOWAIT | M_USE_RESERVE);
621 * Guard against no items in the queue. Normally, this won't
622 * happen, but if lots of events happen all at once and there's
623 * a chance we're out of allocated space but none have yet been
624 * queued when we get here, leaving nothing to steal. This can
625 * also happen with error injection. Fail safe by returning
626 * NULL in that case..
628 if (devsoftc.queued == 0)
630 dei = STAILQ_FIRST(&devsoftc.devq);
631 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
635 *dei->dei_data = '\0';
637 mtx_unlock(&devsoftc.mtx);
641 static struct dev_event_info *
642 devctl_alloc_dei_sb(struct sbuf *sb)
644 struct dev_event_info *dei;
646 dei = devctl_alloc_dei();
648 sbuf_new(sb, dei->dei_data, sizeof(dei->dei_data), SBUF_FIXEDLEN);
653 devctl_free_dei(struct dev_event_info *dei)
655 uma_zfree(devsoftc.zone, dei);
659 devctl_queue(struct dev_event_info *dei)
661 mtx_lock(&devsoftc.mtx);
662 STAILQ_INSERT_TAIL(&devsoftc.devq, dei, dei_link);
664 cv_broadcast(&devsoftc.cv);
665 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
666 mtx_unlock(&devsoftc.mtx);
667 selwakeup(&devsoftc.sel);
668 if (devsoftc.async && devsoftc.sigio != NULL)
669 pgsigio(&devsoftc.sigio, SIGIO, 0);
673 * @brief Send a 'notification' to userland, using standard ways
676 devctl_notify(const char *system, const char *subsystem, const char *type,
679 struct dev_event_info *dei;
682 if (system == NULL || subsystem == NULL || type == NULL)
684 dei = devctl_alloc_dei_sb(&sb);
687 sbuf_cpy(&sb, "!system=");
688 sbuf_cat(&sb, system);
689 sbuf_cat(&sb, " subsystem=");
690 sbuf_cat(&sb, subsystem);
691 sbuf_cat(&sb, " type=");
697 sbuf_putc(&sb, '\n');
698 if (sbuf_finish(&sb) != 0)
699 devctl_free_dei(dei); /* overflow -> drop it */
705 * Common routine that tries to make sending messages as easy as possible.
706 * We allocate memory for the data, copy strings into that, but do not
707 * free it unless there's an error. The dequeue part of the driver should
708 * free the data. We don't send data when the device is disabled. We do
709 * send data, even when we have no listeners, because we wish to avoid
710 * races relating to startup and restart of listening applications.
712 * devaddq is designed to string together the type of event, with the
713 * object of that event, plus the plug and play info and location info
714 * for that event. This is likely most useful for devices, but less
715 * useful for other consumers of this interface. Those should use
716 * the devctl_notify() interface instead.
719 * ${type}${what} at $(location dev) $(pnp-info dev) on $(parent dev)
722 devaddq(const char *type, const char *what, device_t dev)
724 struct dev_event_info *dei;
728 dei = devctl_alloc_dei_sb(&sb);
733 sbuf_cat(&sb, " at ");
735 /* Add in the location */
736 bus_child_location_sb(dev, &sb);
740 bus_child_pnpinfo_sb(dev, &sb);
742 /* Get the parent of this device, or / if high enough in the tree. */
743 if (device_get_parent(dev) == NULL)
744 parstr = "."; /* Or '/' ? */
746 parstr = device_get_nameunit(device_get_parent(dev));
747 sbuf_cat(&sb, " on ");
748 sbuf_cat(&sb, parstr);
749 sbuf_putc(&sb, '\n');
750 if (sbuf_finish(&sb) != 0)
755 devctl_free_dei(dei);
759 * A device was added to the tree. We are called just after it successfully
760 * attaches (that is, probe and attach success for this device). No call
761 * is made if a device is merely parented into the tree. See devnomatch
762 * if probe fails. If attach fails, no notification is sent (but maybe
763 * we should have a different message for this).
766 devadded(device_t dev)
768 devaddq("+", device_get_nameunit(dev), dev);
772 * A device was removed from the tree. We are called just before this
776 devremoved(device_t dev)
778 devaddq("-", device_get_nameunit(dev), dev);
782 * Called when there's no match for this device. This is only called
783 * the first time that no match happens, so we don't keep getting this
784 * message. Should that prove to be undesirable, we can change it.
785 * This is called when all drivers that can attach to a given bus
786 * decline to accept this device. Other errors may not be detected.
789 devnomatch(device_t dev)
791 devaddq("?", "", dev);
795 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
799 q = devctl_queue_length;
800 error = sysctl_handle_int(oidp, &q, 0, req);
801 if (error || !req->newptr)
807 * When set as a tunable, we've not yet initialized the mutex.
808 * It is safe to just assign to devctl_queue_length and return
809 * as we're racing no one. We'll use whatever value set in
812 if (!mtx_initialized(&devsoftc.mtx)) {
813 devctl_queue_length = q;
818 * XXX It's hard to grow or shrink the UMA zone. Only allow
819 * disabling the queue size for the moment until underlying
820 * UMA issues can be sorted out.
824 if (q == devctl_queue_length)
826 mtx_lock(&devsoftc.mtx);
827 devctl_queue_length = 0;
828 uma_zdestroy(devsoftc.zone);
830 mtx_unlock(&devsoftc.mtx);
835 * @brief safely quotes strings that might have double quotes in them.
837 * The devctl protocol relies on quoted strings having matching quotes.
838 * This routine quotes any internal quotes so the resulting string
839 * is safe to pass to snprintf to construct, for example pnp info strings.
841 * @param sb sbuf to place the characters into
842 * @param src Original buffer.
845 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
847 while (*src != '\0') {
848 if (*src == '"' || *src == '\\')
850 sbuf_putc(sb, *src++);
854 /* End of /dev/devctl code */
856 static TAILQ_HEAD(,device) bus_data_devices;
857 static int bus_data_generation = 1;
859 static kobj_method_t null_methods[] = {
863 DEFINE_CLASS(null, null_methods, 0);
866 * Bus pass implementation
869 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
870 int bus_current_pass = BUS_PASS_ROOT;
874 * @brief Register the pass level of a new driver attachment
876 * Register a new driver attachment's pass level. If no driver
877 * attachment with the same pass level has been added, then @p new
878 * will be added to the global passes list.
880 * @param new the new driver attachment
883 driver_register_pass(struct driverlink *new)
885 struct driverlink *dl;
887 /* We only consider pass numbers during boot. */
888 if (bus_current_pass == BUS_PASS_DEFAULT)
892 * Walk the passes list. If we already know about this pass
893 * then there is nothing to do. If we don't, then insert this
894 * driver link into the list.
896 TAILQ_FOREACH(dl, &passes, passlink) {
897 if (dl->pass < new->pass)
899 if (dl->pass == new->pass)
901 TAILQ_INSERT_BEFORE(dl, new, passlink);
904 TAILQ_INSERT_TAIL(&passes, new, passlink);
908 * @brief Raise the current bus pass
910 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
911 * method on the root bus to kick off a new device tree scan for each
912 * new pass level that has at least one driver.
915 bus_set_pass(int pass)
917 struct driverlink *dl;
919 if (bus_current_pass > pass)
920 panic("Attempt to lower bus pass level");
922 TAILQ_FOREACH(dl, &passes, passlink) {
923 /* Skip pass values below the current pass level. */
924 if (dl->pass <= bus_current_pass)
928 * Bail once we hit a driver with a pass level that is
935 * Raise the pass level to the next level and rescan
938 bus_current_pass = dl->pass;
939 BUS_NEW_PASS(root_bus);
943 * If there isn't a driver registered for the requested pass,
944 * then bus_current_pass might still be less than 'pass'. Set
945 * it to 'pass' in that case.
947 if (bus_current_pass < pass)
948 bus_current_pass = pass;
949 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
953 * Devclass implementation
956 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
960 * @brief Find or create a device class
962 * If a device class with the name @p classname exists, return it,
963 * otherwise if @p create is non-zero create and return a new device
966 * If @p parentname is non-NULL, the parent of the devclass is set to
967 * the devclass of that name.
969 * @param classname the devclass name to find or create
970 * @param parentname the parent devclass name or @c NULL
971 * @param create non-zero to create a devclass
974 devclass_find_internal(const char *classname, const char *parentname,
979 PDEBUG(("looking for %s", classname));
983 TAILQ_FOREACH(dc, &devclasses, link) {
984 if (!strcmp(dc->name, classname))
989 PDEBUG(("creating %s", classname));
990 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
991 M_BUS, M_NOWAIT | M_ZERO);
995 dc->name = (char*) (dc + 1);
996 strcpy(dc->name, classname);
997 TAILQ_INIT(&dc->drivers);
998 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1000 bus_data_generation_update();
1004 * If a parent class is specified, then set that as our parent so
1005 * that this devclass will support drivers for the parent class as
1006 * well. If the parent class has the same name don't do this though
1007 * as it creates a cycle that can trigger an infinite loop in
1008 * device_probe_child() if a device exists for which there is no
1011 if (parentname && dc && !dc->parent &&
1012 strcmp(classname, parentname) != 0) {
1013 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1014 dc->parent->flags |= DC_HAS_CHILDREN;
1021 * @brief Create a device class
1023 * If a device class with the name @p classname exists, return it,
1024 * otherwise create and return a new device class.
1026 * @param classname the devclass name to find or create
1029 devclass_create(const char *classname)
1031 return (devclass_find_internal(classname, NULL, TRUE));
1035 * @brief Find a device class
1037 * If a device class with the name @p classname exists, return it,
1038 * otherwise return @c NULL.
1040 * @param classname the devclass name to find
1043 devclass_find(const char *classname)
1045 return (devclass_find_internal(classname, NULL, FALSE));
1049 * @brief Register that a device driver has been added to a devclass
1051 * Register that a device driver has been added to a devclass. This
1052 * is called by devclass_add_driver to accomplish the recursive
1053 * notification of all the children classes of dc, as well as dc.
1054 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1057 * We do a full search here of the devclass list at each iteration
1058 * level to save storing children-lists in the devclass structure. If
1059 * we ever move beyond a few dozen devices doing this, we may need to
1062 * @param dc the devclass to edit
1063 * @param driver the driver that was just added
1066 devclass_driver_added(devclass_t dc, driver_t *driver)
1072 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1074 for (i = 0; i < dc->maxunit; i++)
1075 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1076 BUS_DRIVER_ADDED(dc->devices[i], driver);
1079 * Walk through the children classes. Since we only keep a
1080 * single parent pointer around, we walk the entire list of
1081 * devclasses looking for children. We set the
1082 * DC_HAS_CHILDREN flag when a child devclass is created on
1083 * the parent, so we only walk the list for those devclasses
1084 * that have children.
1086 if (!(dc->flags & DC_HAS_CHILDREN))
1089 TAILQ_FOREACH(dc, &devclasses, link) {
1090 if (dc->parent == parent)
1091 devclass_driver_added(dc, driver);
1096 * @brief Add a device driver to a device class
1098 * Add a device driver to a devclass. This is normally called
1099 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1100 * all devices in the devclass will be called to allow them to attempt
1101 * to re-probe any unmatched children.
1103 * @param dc the devclass to edit
1104 * @param driver the driver to register
1107 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1110 const char *parentname;
1112 PDEBUG(("%s", DRIVERNAME(driver)));
1114 /* Don't allow invalid pass values. */
1115 if (pass <= BUS_PASS_ROOT)
1118 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1123 * Compile the driver's methods. Also increase the reference count
1124 * so that the class doesn't get freed when the last instance
1125 * goes. This means we can safely use static methods and avoids a
1126 * double-free in devclass_delete_driver.
1128 kobj_class_compile((kobj_class_t) driver);
1131 * If the driver has any base classes, make the
1132 * devclass inherit from the devclass of the driver's
1133 * first base class. This will allow the system to
1134 * search for drivers in both devclasses for children
1135 * of a device using this driver.
1137 if (driver->baseclasses)
1138 parentname = driver->baseclasses[0]->name;
1141 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1143 dl->driver = driver;
1144 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1145 driver->refs++; /* XXX: kobj_mtx */
1147 driver_register_pass(dl);
1149 if (device_frozen) {
1150 dl->flags |= DL_DEFERRED_PROBE;
1152 devclass_driver_added(dc, driver);
1154 bus_data_generation_update();
1159 * @brief Register that a device driver has been deleted from a devclass
1161 * Register that a device driver has been removed from a devclass.
1162 * This is called by devclass_delete_driver to accomplish the
1163 * recursive notification of all the children classes of busclass, as
1164 * well as busclass. Each layer will attempt to detach the driver
1165 * from any devices that are children of the bus's devclass. The function
1166 * will return an error if a device fails to detach.
1168 * We do a full search here of the devclass list at each iteration
1169 * level to save storing children-lists in the devclass structure. If
1170 * we ever move beyond a few dozen devices doing this, we may need to
1173 * @param busclass the devclass of the parent bus
1174 * @param dc the devclass of the driver being deleted
1175 * @param driver the driver being deleted
1178 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1185 * Disassociate from any devices. We iterate through all the
1186 * devices in the devclass of the driver and detach any which are
1187 * using the driver and which have a parent in the devclass which
1188 * we are deleting from.
1190 * Note that since a driver can be in multiple devclasses, we
1191 * should not detach devices which are not children of devices in
1192 * the affected devclass.
1194 * If we're frozen, we don't generate NOMATCH events. Mark to
1197 for (i = 0; i < dc->maxunit; i++) {
1198 if (dc->devices[i]) {
1199 dev = dc->devices[i];
1200 if (dev->driver == driver && dev->parent &&
1201 dev->parent->devclass == busclass) {
1202 if ((error = device_detach(dev)) != 0)
1204 if (device_frozen) {
1205 dev->flags &= ~DF_DONENOMATCH;
1206 dev->flags |= DF_NEEDNOMATCH;
1208 BUS_PROBE_NOMATCH(dev->parent, dev);
1210 dev->flags |= DF_DONENOMATCH;
1217 * Walk through the children classes. Since we only keep a
1218 * single parent pointer around, we walk the entire list of
1219 * devclasses looking for children. We set the
1220 * DC_HAS_CHILDREN flag when a child devclass is created on
1221 * the parent, so we only walk the list for those devclasses
1222 * that have children.
1224 if (!(busclass->flags & DC_HAS_CHILDREN))
1227 TAILQ_FOREACH(busclass, &devclasses, link) {
1228 if (busclass->parent == parent) {
1229 error = devclass_driver_deleted(busclass, dc, driver);
1238 * @brief Delete a device driver from a device class
1240 * Delete a device driver from a devclass. This is normally called
1241 * automatically by DRIVER_MODULE().
1243 * If the driver is currently attached to any devices,
1244 * devclass_delete_driver() will first attempt to detach from each
1245 * device. If one of the detach calls fails, the driver will not be
1248 * @param dc the devclass to edit
1249 * @param driver the driver to unregister
1252 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1254 devclass_t dc = devclass_find(driver->name);
1258 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1264 * Find the link structure in the bus' list of drivers.
1266 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1267 if (dl->driver == driver)
1272 PDEBUG(("%s not found in %s list", driver->name,
1277 error = devclass_driver_deleted(busclass, dc, driver);
1281 TAILQ_REMOVE(&busclass->drivers, dl, link);
1286 if (driver->refs == 0)
1287 kobj_class_free((kobj_class_t) driver);
1289 bus_data_generation_update();
1294 * @brief Quiesces a set of device drivers from a device class
1296 * Quiesce a device driver from a devclass. This is normally called
1297 * automatically by DRIVER_MODULE().
1299 * If the driver is currently attached to any devices,
1300 * devclass_quiesece_driver() will first attempt to quiesce each
1303 * @param dc the devclass to edit
1304 * @param driver the driver to unregister
1307 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1309 devclass_t dc = devclass_find(driver->name);
1315 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1321 * Find the link structure in the bus' list of drivers.
1323 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1324 if (dl->driver == driver)
1329 PDEBUG(("%s not found in %s list", driver->name,
1335 * Quiesce all devices. We iterate through all the devices in
1336 * the devclass of the driver and quiesce any which are using
1337 * the driver and which have a parent in the devclass which we
1340 * Note that since a driver can be in multiple devclasses, we
1341 * should not quiesce devices which are not children of
1342 * devices in the affected devclass.
1344 for (i = 0; i < dc->maxunit; i++) {
1345 if (dc->devices[i]) {
1346 dev = dc->devices[i];
1347 if (dev->driver == driver && dev->parent &&
1348 dev->parent->devclass == busclass) {
1349 if ((error = device_quiesce(dev)) != 0)
1362 devclass_find_driver_internal(devclass_t dc, const char *classname)
1366 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1368 TAILQ_FOREACH(dl, &dc->drivers, link) {
1369 if (!strcmp(dl->driver->name, classname))
1373 PDEBUG(("not found"));
1378 * @brief Return the name of the devclass
1381 devclass_get_name(devclass_t dc)
1387 * @brief Find a device given a unit number
1389 * @param dc the devclass to search
1390 * @param unit the unit number to search for
1392 * @returns the device with the given unit number or @c
1393 * NULL if there is no such device
1396 devclass_get_device(devclass_t dc, int unit)
1398 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1400 return (dc->devices[unit]);
1404 * @brief Find the softc field of a device given a unit number
1406 * @param dc the devclass to search
1407 * @param unit the unit number to search for
1409 * @returns the softc field of the device with the given
1410 * unit number or @c NULL if there is no such
1414 devclass_get_softc(devclass_t dc, int unit)
1418 dev = devclass_get_device(dc, unit);
1422 return (device_get_softc(dev));
1426 * @brief Get a list of devices in the devclass
1428 * An array containing a list of all the devices in the given devclass
1429 * is allocated and returned in @p *devlistp. The number of devices
1430 * in the array is returned in @p *devcountp. The caller should free
1431 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1433 * @param dc the devclass to examine
1434 * @param devlistp points at location for array pointer return
1436 * @param devcountp points at location for array size return value
1439 * @retval ENOMEM the array allocation failed
1442 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1447 count = devclass_get_count(dc);
1448 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1453 for (i = 0; i < dc->maxunit; i++) {
1454 if (dc->devices[i]) {
1455 list[count] = dc->devices[i];
1467 * @brief Get a list of drivers in the devclass
1469 * An array containing a list of pointers to all the drivers in the
1470 * given devclass is allocated and returned in @p *listp. The number
1471 * of drivers in the array is returned in @p *countp. The caller should
1472 * free the array using @c free(p, M_TEMP).
1474 * @param dc the devclass to examine
1475 * @param listp gives location for array pointer return value
1476 * @param countp gives location for number of array elements
1480 * @retval ENOMEM the array allocation failed
1483 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1490 TAILQ_FOREACH(dl, &dc->drivers, link)
1492 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1497 TAILQ_FOREACH(dl, &dc->drivers, link) {
1498 list[count] = dl->driver;
1508 * @brief Get the number of devices in a devclass
1510 * @param dc the devclass to examine
1513 devclass_get_count(devclass_t dc)
1518 for (i = 0; i < dc->maxunit; i++)
1525 * @brief Get the maximum unit number used in a devclass
1527 * Note that this is one greater than the highest currently-allocated
1528 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1529 * that not even the devclass has been allocated yet.
1531 * @param dc the devclass to examine
1534 devclass_get_maxunit(devclass_t dc)
1538 return (dc->maxunit);
1542 * @brief Find a free unit number in a devclass
1544 * This function searches for the first unused unit number greater
1545 * that or equal to @p unit.
1547 * @param dc the devclass to examine
1548 * @param unit the first unit number to check
1551 devclass_find_free_unit(devclass_t dc, int unit)
1555 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1561 * @brief Set the parent of a devclass
1563 * The parent class is normally initialised automatically by
1566 * @param dc the devclass to edit
1567 * @param pdc the new parent devclass
1570 devclass_set_parent(devclass_t dc, devclass_t pdc)
1576 * @brief Get the parent of a devclass
1578 * @param dc the devclass to examine
1581 devclass_get_parent(devclass_t dc)
1583 return (dc->parent);
1586 struct sysctl_ctx_list *
1587 devclass_get_sysctl_ctx(devclass_t dc)
1589 return (&dc->sysctl_ctx);
1593 devclass_get_sysctl_tree(devclass_t dc)
1595 return (dc->sysctl_tree);
1600 * @brief Allocate a unit number
1602 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1603 * will do). The allocated unit number is returned in @p *unitp.
1605 * @param dc the devclass to allocate from
1606 * @param unitp points at the location for the allocated unit
1610 * @retval EEXIST the requested unit number is already allocated
1611 * @retval ENOMEM memory allocation failure
1614 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1619 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1621 /* Ask the parent bus if it wants to wire this device. */
1623 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1626 /* If we were given a wired unit number, check for existing device */
1629 if (unit >= 0 && unit < dc->maxunit &&
1630 dc->devices[unit] != NULL) {
1632 printf("%s: %s%d already exists; skipping it\n",
1633 dc->name, dc->name, *unitp);
1637 /* Unwired device, find the next available slot for it */
1639 for (unit = 0;; unit++) {
1640 /* If there is an "at" hint for a unit then skip it. */
1641 if (resource_string_value(dc->name, unit, "at", &s) ==
1645 /* If this device slot is already in use, skip it. */
1646 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1654 * We've selected a unit beyond the length of the table, so let's
1655 * extend the table to make room for all units up to and including
1658 if (unit >= dc->maxunit) {
1659 device_t *newlist, *oldlist;
1662 oldlist = dc->devices;
1663 newsize = roundup((unit + 1),
1664 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1665 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1668 if (oldlist != NULL)
1669 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1670 bzero(newlist + dc->maxunit,
1671 sizeof(device_t) * (newsize - dc->maxunit));
1672 dc->devices = newlist;
1673 dc->maxunit = newsize;
1674 if (oldlist != NULL)
1675 free(oldlist, M_BUS);
1677 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1685 * @brief Add a device to a devclass
1687 * A unit number is allocated for the device (using the device's
1688 * preferred unit number if any) and the device is registered in the
1689 * devclass. This allows the device to be looked up by its unit
1690 * number, e.g. by decoding a dev_t minor number.
1692 * @param dc the devclass to add to
1693 * @param dev the device to add
1696 * @retval EEXIST the requested unit number is already allocated
1697 * @retval ENOMEM memory allocation failure
1700 devclass_add_device(devclass_t dc, device_t dev)
1704 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1706 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1709 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1713 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1714 free(dev->nameunit, M_BUS);
1715 dev->nameunit = NULL;
1718 dc->devices[dev->unit] = dev;
1720 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1727 * @brief Delete a device from a devclass
1729 * The device is removed from the devclass's device list and its unit
1732 * @param dc the devclass to delete from
1733 * @param dev the device to delete
1738 devclass_delete_device(devclass_t dc, device_t dev)
1743 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1745 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1746 panic("devclass_delete_device: inconsistent device class");
1747 dc->devices[dev->unit] = NULL;
1748 if (dev->flags & DF_WILDCARD)
1750 dev->devclass = NULL;
1751 free(dev->nameunit, M_BUS);
1752 dev->nameunit = NULL;
1759 * @brief Make a new device and add it as a child of @p parent
1761 * @param parent the parent of the new device
1762 * @param name the devclass name of the new device or @c NULL
1763 * to leave the devclass unspecified
1764 * @parem unit the unit number of the new device of @c -1 to
1765 * leave the unit number unspecified
1767 * @returns the new device
1770 make_device(device_t parent, const char *name, int unit)
1775 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1778 dc = devclass_find_internal(name, NULL, TRUE);
1780 printf("make_device: can't find device class %s\n",
1788 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1792 dev->parent = parent;
1793 TAILQ_INIT(&dev->children);
1794 kobj_init((kobj_t) dev, &null_class);
1796 dev->devclass = NULL;
1798 dev->nameunit = NULL;
1802 dev->flags = DF_ENABLED;
1805 dev->flags |= DF_WILDCARD;
1807 dev->flags |= DF_FIXEDCLASS;
1808 if (devclass_add_device(dc, dev)) {
1809 kobj_delete((kobj_t) dev, M_BUS);
1813 if (parent != NULL && device_has_quiet_children(parent))
1814 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1818 dev->state = DS_NOTPRESENT;
1820 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1821 bus_data_generation_update();
1828 * @brief Print a description of a device.
1831 device_print_child(device_t dev, device_t child)
1835 if (device_is_alive(child))
1836 retval += BUS_PRINT_CHILD(dev, child);
1838 retval += device_printf(child, " not found\n");
1844 * @brief Create a new device
1846 * This creates a new device and adds it as a child of an existing
1847 * parent device. The new device will be added after the last existing
1848 * child with order zero.
1850 * @param dev the device which will be the parent of the
1852 * @param name devclass name for new device or @c NULL if not
1854 * @param unit unit number for new device or @c -1 if not
1857 * @returns the new device
1860 device_add_child(device_t dev, const char *name, int unit)
1862 return (device_add_child_ordered(dev, 0, name, unit));
1866 * @brief Create a new device
1868 * This creates a new device and adds it as a child of an existing
1869 * parent device. The new device will be added after the last existing
1870 * child with the same order.
1872 * @param dev the device which will be the parent of the
1874 * @param order a value which is used to partially sort the
1875 * children of @p dev - devices created using
1876 * lower values of @p order appear first in @p
1877 * dev's list of children
1878 * @param name devclass name for new device or @c NULL if not
1880 * @param unit unit number for new device or @c -1 if not
1883 * @returns the new device
1886 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1891 PDEBUG(("%s at %s with order %u as unit %d",
1892 name, DEVICENAME(dev), order, unit));
1893 KASSERT(name != NULL || unit == -1,
1894 ("child device with wildcard name and specific unit number"));
1896 child = make_device(dev, name, unit);
1899 child->order = order;
1901 TAILQ_FOREACH(place, &dev->children, link) {
1902 if (place->order > order)
1908 * The device 'place' is the first device whose order is
1909 * greater than the new child.
1911 TAILQ_INSERT_BEFORE(place, child, link);
1914 * The new child's order is greater or equal to the order of
1915 * any existing device. Add the child to the tail of the list.
1917 TAILQ_INSERT_TAIL(&dev->children, child, link);
1920 bus_data_generation_update();
1925 * @brief Delete a device
1927 * This function deletes a device along with all of its children. If
1928 * the device currently has a driver attached to it, the device is
1929 * detached first using device_detach().
1931 * @param dev the parent device
1932 * @param child the device to delete
1935 * @retval non-zero a unit error code describing the error
1938 device_delete_child(device_t dev, device_t child)
1941 device_t grandchild;
1943 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1945 /* detach parent before deleting children, if any */
1946 if ((error = device_detach(child)) != 0)
1949 /* remove children second */
1950 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1951 error = device_delete_child(child, grandchild);
1956 if (child->devclass)
1957 devclass_delete_device(child->devclass, child);
1959 BUS_CHILD_DELETED(dev, child);
1960 TAILQ_REMOVE(&dev->children, child, link);
1961 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1962 kobj_delete((kobj_t) child, M_BUS);
1964 bus_data_generation_update();
1969 * @brief Delete all children devices of the given device, if any.
1971 * This function deletes all children devices of the given device, if
1972 * any, using the device_delete_child() function for each device it
1973 * finds. If a child device cannot be deleted, this function will
1974 * return an error code.
1976 * @param dev the parent device
1979 * @retval non-zero a device would not detach
1982 device_delete_children(device_t dev)
1987 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1991 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1992 error = device_delete_child(dev, child);
1994 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2002 * @brief Find a device given a unit number
2004 * This is similar to devclass_get_devices() but only searches for
2005 * devices which have @p dev as a parent.
2007 * @param dev the parent device to search
2008 * @param unit the unit number to search for. If the unit is -1,
2009 * return the first child of @p dev which has name
2010 * @p classname (that is, the one with the lowest unit.)
2012 * @returns the device with the given unit number or @c
2013 * NULL if there is no such device
2016 device_find_child(device_t dev, const char *classname, int unit)
2021 dc = devclass_find(classname);
2026 child = devclass_get_device(dc, unit);
2027 if (child && child->parent == dev)
2030 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2031 child = devclass_get_device(dc, unit);
2032 if (child && child->parent == dev)
2043 first_matching_driver(devclass_t dc, device_t dev)
2046 return (devclass_find_driver_internal(dc, dev->devclass->name));
2047 return (TAILQ_FIRST(&dc->drivers));
2054 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2056 if (dev->devclass) {
2058 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2059 if (!strcmp(dev->devclass->name, dl->driver->name))
2063 return (TAILQ_NEXT(last, link));
2070 device_probe_child(device_t dev, device_t child)
2073 driverlink_t best = NULL;
2075 int result, pri = 0;
2076 int hasclass = (child->devclass != NULL);
2082 panic("device_probe_child: parent device has no devclass");
2085 * If the state is already probed, then return. However, don't
2086 * return if we can rebid this object.
2088 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2091 for (; dc; dc = dc->parent) {
2092 for (dl = first_matching_driver(dc, child);
2094 dl = next_matching_driver(dc, child, dl)) {
2095 /* If this driver's pass is too high, then ignore it. */
2096 if (dl->pass > bus_current_pass)
2099 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2100 result = device_set_driver(child, dl->driver);
2101 if (result == ENOMEM)
2103 else if (result != 0)
2106 if (device_set_devclass(child,
2107 dl->driver->name) != 0) {
2108 char const * devname =
2109 device_get_name(child);
2110 if (devname == NULL)
2111 devname = "(unknown)";
2112 printf("driver bug: Unable to set "
2113 "devclass (class: %s "
2117 (void)device_set_driver(child, NULL);
2122 /* Fetch any flags for the device before probing. */
2123 resource_int_value(dl->driver->name, child->unit,
2124 "flags", &child->devflags);
2126 result = DEVICE_PROBE(child);
2128 /* Reset flags and devclass before the next probe. */
2129 child->devflags = 0;
2131 (void)device_set_devclass(child, NULL);
2134 * If the driver returns SUCCESS, there can be
2135 * no higher match for this device.
2144 * Reset DF_QUIET in case this driver doesn't
2145 * end up as the best driver.
2147 device_verbose(child);
2150 * Probes that return BUS_PROBE_NOWILDCARD or lower
2151 * only match on devices whose driver was explicitly
2154 if (result <= BUS_PROBE_NOWILDCARD &&
2155 !(child->flags & DF_FIXEDCLASS)) {
2160 * The driver returned an error so it
2161 * certainly doesn't match.
2164 (void)device_set_driver(child, NULL);
2169 * A priority lower than SUCCESS, remember the
2170 * best matching driver. Initialise the value
2171 * of pri for the first match.
2173 if (best == NULL || result > pri) {
2180 * If we have an unambiguous match in this devclass,
2181 * don't look in the parent.
2183 if (best && pri == 0)
2188 * If we found a driver, change state and initialise the devclass.
2190 /* XXX What happens if we rebid and got no best? */
2193 * If this device was attached, and we were asked to
2194 * rescan, and it is a different driver, then we have
2195 * to detach the old driver and reattach this new one.
2196 * Note, we don't have to check for DF_REBID here
2197 * because if the state is > DS_ALIVE, we know it must
2200 * This assumes that all DF_REBID drivers can have
2201 * their probe routine called at any time and that
2202 * they are idempotent as well as completely benign in
2203 * normal operations.
2205 * We also have to make sure that the detach
2206 * succeeded, otherwise we fail the operation (or
2207 * maybe it should just fail silently? I'm torn).
2209 if (child->state > DS_ALIVE && best->driver != child->driver)
2210 if ((result = device_detach(dev)) != 0)
2213 /* Set the winning driver, devclass, and flags. */
2214 if (!child->devclass) {
2215 result = device_set_devclass(child, best->driver->name);
2219 result = device_set_driver(child, best->driver);
2222 resource_int_value(best->driver->name, child->unit,
2223 "flags", &child->devflags);
2227 * A bit bogus. Call the probe method again to make
2228 * sure that we have the right description.
2230 DEVICE_PROBE(child);
2232 child->flags |= DF_REBID;
2235 child->flags &= ~DF_REBID;
2236 child->state = DS_ALIVE;
2238 bus_data_generation_update();
2246 * @brief Return the parent of a device
2249 device_get_parent(device_t dev)
2251 return (dev->parent);
2255 * @brief Get a list of children of a device
2257 * An array containing a list of all the children of the given device
2258 * is allocated and returned in @p *devlistp. The number of devices
2259 * in the array is returned in @p *devcountp. The caller should free
2260 * the array using @c free(p, M_TEMP).
2262 * @param dev the device to examine
2263 * @param devlistp points at location for array pointer return
2265 * @param devcountp points at location for array size return value
2268 * @retval ENOMEM the array allocation failed
2271 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2278 TAILQ_FOREACH(child, &dev->children, link) {
2287 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2292 TAILQ_FOREACH(child, &dev->children, link) {
2293 list[count] = child;
2304 * @brief Return the current driver for the device or @c NULL if there
2305 * is no driver currently attached
2308 device_get_driver(device_t dev)
2310 return (dev->driver);
2314 * @brief Return the current devclass for the device or @c NULL if
2318 device_get_devclass(device_t dev)
2320 return (dev->devclass);
2324 * @brief Return the name of the device's devclass or @c NULL if there
2328 device_get_name(device_t dev)
2330 if (dev != NULL && dev->devclass)
2331 return (devclass_get_name(dev->devclass));
2336 * @brief Return a string containing the device's devclass name
2337 * followed by an ascii representation of the device's unit number
2341 device_get_nameunit(device_t dev)
2343 return (dev->nameunit);
2347 * @brief Return the device's unit number.
2350 device_get_unit(device_t dev)
2356 * @brief Return the device's description string
2359 device_get_desc(device_t dev)
2365 * @brief Return the device's flags
2368 device_get_flags(device_t dev)
2370 return (dev->devflags);
2373 struct sysctl_ctx_list *
2374 device_get_sysctl_ctx(device_t dev)
2376 return (&dev->sysctl_ctx);
2380 device_get_sysctl_tree(device_t dev)
2382 return (dev->sysctl_tree);
2386 * @brief Print the name of the device followed by a colon and a space
2388 * @returns the number of characters printed
2391 device_print_prettyname(device_t dev)
2393 const char *name = device_get_name(dev);
2396 return (printf("unknown: "));
2397 return (printf("%s%d: ", name, device_get_unit(dev)));
2401 * @brief Print the name of the device followed by a colon, a space
2402 * and the result of calling vprintf() with the value of @p fmt and
2403 * the following arguments.
2405 * @returns the number of characters printed
2408 device_printf(device_t dev, const char * fmt, ...)
2418 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2419 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2421 name = device_get_name(dev);
2424 sbuf_cat(&sb, "unknown: ");
2426 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2429 sbuf_vprintf(&sb, fmt, ap);
2439 * @brief Print the name of the device followed by a colon, a space
2440 * and the result of calling log() with the value of @p fmt and
2441 * the following arguments.
2443 * @returns the number of characters printed
2446 device_log(device_t dev, int pri, const char * fmt, ...)
2456 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2458 name = device_get_name(dev);
2461 sbuf_cat(&sb, "unknown: ");
2463 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2466 sbuf_vprintf(&sb, fmt, ap);
2471 log(pri, "%.*s", (int) sbuf_len(&sb), sbuf_data(&sb));
2472 retval = sbuf_len(&sb);
2483 device_set_desc_internal(device_t dev, const char* desc, int copy)
2485 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2486 free(dev->desc, M_BUS);
2487 dev->flags &= ~DF_DESCMALLOCED;
2492 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2494 strcpy(dev->desc, desc);
2495 dev->flags |= DF_DESCMALLOCED;
2498 /* Avoid a -Wcast-qual warning */
2499 dev->desc = (char *)(uintptr_t) desc;
2502 bus_data_generation_update();
2506 * @brief Set the device's description
2508 * The value of @c desc should be a string constant that will not
2509 * change (at least until the description is changed in a subsequent
2510 * call to device_set_desc() or device_set_desc_copy()).
2513 device_set_desc(device_t dev, const char* desc)
2515 device_set_desc_internal(dev, desc, FALSE);
2519 * @brief Set the device's description
2521 * The string pointed to by @c desc is copied. Use this function if
2522 * the device description is generated, (e.g. with sprintf()).
2525 device_set_desc_copy(device_t dev, const char* desc)
2527 device_set_desc_internal(dev, desc, TRUE);
2531 * @brief Set the device's flags
2534 device_set_flags(device_t dev, uint32_t flags)
2536 dev->devflags = flags;
2540 * @brief Return the device's softc field
2542 * The softc is allocated and zeroed when a driver is attached, based
2543 * on the size field of the driver.
2546 device_get_softc(device_t dev)
2548 return (dev->softc);
2552 * @brief Set the device's softc field
2554 * Most drivers do not need to use this since the softc is allocated
2555 * automatically when the driver is attached.
2558 device_set_softc(device_t dev, void *softc)
2560 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2561 free(dev->softc, M_BUS_SC);
2564 dev->flags |= DF_EXTERNALSOFTC;
2566 dev->flags &= ~DF_EXTERNALSOFTC;
2570 * @brief Free claimed softc
2572 * Most drivers do not need to use this since the softc is freed
2573 * automatically when the driver is detached.
2576 device_free_softc(void *softc)
2578 free(softc, M_BUS_SC);
2582 * @brief Claim softc
2584 * This function can be used to let the driver free the automatically
2585 * allocated softc using "device_free_softc()". This function is
2586 * useful when the driver is refcounting the softc and the softc
2587 * cannot be freed when the "device_detach" method is called.
2590 device_claim_softc(device_t dev)
2593 dev->flags |= DF_EXTERNALSOFTC;
2595 dev->flags &= ~DF_EXTERNALSOFTC;
2599 * @brief Get the device's ivars field
2601 * The ivars field is used by the parent device to store per-device
2602 * state (e.g. the physical location of the device or a list of
2606 device_get_ivars(device_t dev)
2608 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2609 return (dev->ivars);
2613 * @brief Set the device's ivars field
2616 device_set_ivars(device_t dev, void * ivars)
2618 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2623 * @brief Return the device's state
2626 device_get_state(device_t dev)
2628 return (dev->state);
2632 * @brief Set the DF_ENABLED flag for the device
2635 device_enable(device_t dev)
2637 dev->flags |= DF_ENABLED;
2641 * @brief Clear the DF_ENABLED flag for the device
2644 device_disable(device_t dev)
2646 dev->flags &= ~DF_ENABLED;
2650 * @brief Increment the busy counter for the device
2653 device_busy(device_t dev)
2655 if (dev->state < DS_ATTACHING)
2656 panic("device_busy: called for unattached device");
2657 if (dev->busy == 0 && dev->parent)
2658 device_busy(dev->parent);
2660 if (dev->state == DS_ATTACHED)
2661 dev->state = DS_BUSY;
2665 * @brief Decrement the busy counter for the device
2668 device_unbusy(device_t dev)
2670 if (dev->busy != 0 && dev->state != DS_BUSY &&
2671 dev->state != DS_ATTACHING)
2672 panic("device_unbusy: called for non-busy device %s",
2673 device_get_nameunit(dev));
2675 if (dev->busy == 0) {
2677 device_unbusy(dev->parent);
2678 if (dev->state == DS_BUSY)
2679 dev->state = DS_ATTACHED;
2684 * @brief Set the DF_QUIET flag for the device
2687 device_quiet(device_t dev)
2689 dev->flags |= DF_QUIET;
2693 * @brief Set the DF_QUIET_CHILDREN flag for the device
2696 device_quiet_children(device_t dev)
2698 dev->flags |= DF_QUIET_CHILDREN;
2702 * @brief Clear the DF_QUIET flag for the device
2705 device_verbose(device_t dev)
2707 dev->flags &= ~DF_QUIET;
2711 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2714 device_has_quiet_children(device_t dev)
2716 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2720 * @brief Return non-zero if the DF_QUIET flag is set on the device
2723 device_is_quiet(device_t dev)
2725 return ((dev->flags & DF_QUIET) != 0);
2729 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2732 device_is_enabled(device_t dev)
2734 return ((dev->flags & DF_ENABLED) != 0);
2738 * @brief Return non-zero if the device was successfully probed
2741 device_is_alive(device_t dev)
2743 return (dev->state >= DS_ALIVE);
2747 * @brief Return non-zero if the device currently has a driver
2751 device_is_attached(device_t dev)
2753 return (dev->state >= DS_ATTACHED);
2757 * @brief Return non-zero if the device is currently suspended.
2760 device_is_suspended(device_t dev)
2762 return ((dev->flags & DF_SUSPENDED) != 0);
2766 * @brief Set the devclass of a device
2767 * @see devclass_add_device().
2770 device_set_devclass(device_t dev, const char *classname)
2777 devclass_delete_device(dev->devclass, dev);
2781 if (dev->devclass) {
2782 printf("device_set_devclass: device class already set\n");
2786 dc = devclass_find_internal(classname, NULL, TRUE);
2790 error = devclass_add_device(dc, dev);
2792 bus_data_generation_update();
2797 * @brief Set the devclass of a device and mark the devclass fixed.
2798 * @see device_set_devclass()
2801 device_set_devclass_fixed(device_t dev, const char *classname)
2805 if (classname == NULL)
2808 error = device_set_devclass(dev, classname);
2811 dev->flags |= DF_FIXEDCLASS;
2816 * @brief Query the device to determine if it's of a fixed devclass
2817 * @see device_set_devclass_fixed()
2820 device_is_devclass_fixed(device_t dev)
2822 return ((dev->flags & DF_FIXEDCLASS) != 0);
2826 * @brief Set the driver of a device
2829 * @retval EBUSY the device already has a driver attached
2830 * @retval ENOMEM a memory allocation failure occurred
2833 device_set_driver(device_t dev, driver_t *driver)
2836 struct domainset *policy;
2838 if (dev->state >= DS_ATTACHED)
2841 if (dev->driver == driver)
2844 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2845 free(dev->softc, M_BUS_SC);
2848 device_set_desc(dev, NULL);
2849 kobj_delete((kobj_t) dev, NULL);
2850 dev->driver = driver;
2852 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2853 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2854 if (bus_get_domain(dev, &domain) == 0)
2855 policy = DOMAINSET_PREF(domain);
2857 policy = DOMAINSET_RR();
2858 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2859 policy, M_NOWAIT | M_ZERO);
2861 kobj_delete((kobj_t) dev, NULL);
2862 kobj_init((kobj_t) dev, &null_class);
2868 kobj_init((kobj_t) dev, &null_class);
2871 bus_data_generation_update();
2876 * @brief Probe a device, and return this status.
2878 * This function is the core of the device autoconfiguration
2879 * system. Its purpose is to select a suitable driver for a device and
2880 * then call that driver to initialise the hardware appropriately. The
2881 * driver is selected by calling the DEVICE_PROBE() method of a set of
2882 * candidate drivers and then choosing the driver which returned the
2883 * best value. This driver is then attached to the device using
2886 * The set of suitable drivers is taken from the list of drivers in
2887 * the parent device's devclass. If the device was originally created
2888 * with a specific class name (see device_add_child()), only drivers
2889 * with that name are probed, otherwise all drivers in the devclass
2890 * are probed. If no drivers return successful probe values in the
2891 * parent devclass, the search continues in the parent of that
2892 * devclass (see devclass_get_parent()) if any.
2894 * @param dev the device to initialise
2897 * @retval ENXIO no driver was found
2898 * @retval ENOMEM memory allocation failure
2899 * @retval non-zero some other unix error code
2900 * @retval -1 Device already attached
2903 device_probe(device_t dev)
2909 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2912 if (!(dev->flags & DF_ENABLED)) {
2913 if (bootverbose && device_get_name(dev) != NULL) {
2914 device_print_prettyname(dev);
2915 printf("not probed (disabled)\n");
2919 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2920 if (bus_current_pass == BUS_PASS_DEFAULT &&
2921 !(dev->flags & DF_DONENOMATCH)) {
2922 BUS_PROBE_NOMATCH(dev->parent, dev);
2924 dev->flags |= DF_DONENOMATCH;
2932 * @brief Probe a device and attach a driver if possible
2934 * calls device_probe() and attaches if that was successful.
2937 device_probe_and_attach(device_t dev)
2943 error = device_probe(dev);
2946 else if (error != 0)
2949 CURVNET_SET_QUIET(vnet0);
2950 error = device_attach(dev);
2956 * @brief Attach a device driver to a device
2958 * This function is a wrapper around the DEVICE_ATTACH() driver
2959 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2960 * device's sysctl tree, optionally prints a description of the device
2961 * and queues a notification event for user-based device management
2964 * Normally this function is only called internally from
2965 * device_probe_and_attach().
2967 * @param dev the device to initialise
2970 * @retval ENXIO no driver was found
2971 * @retval ENOMEM memory allocation failure
2972 * @retval non-zero some other unix error code
2975 device_attach(device_t dev)
2977 uint64_t attachtime;
2978 uint16_t attachentropy;
2981 if (resource_disabled(dev->driver->name, dev->unit)) {
2982 device_disable(dev);
2984 device_printf(dev, "disabled via hints entry\n");
2988 device_sysctl_init(dev);
2989 if (!device_is_quiet(dev))
2990 device_print_child(dev->parent, dev);
2991 attachtime = get_cyclecount();
2992 dev->state = DS_ATTACHING;
2993 if ((error = DEVICE_ATTACH(dev)) != 0) {
2994 printf("device_attach: %s%d attach returned %d\n",
2995 dev->driver->name, dev->unit, error);
2996 if (!(dev->flags & DF_FIXEDCLASS))
2997 devclass_delete_device(dev->devclass, dev);
2998 (void)device_set_driver(dev, NULL);
2999 device_sysctl_fini(dev);
3000 KASSERT(dev->busy == 0, ("attach failed but busy"));
3001 dev->state = DS_NOTPRESENT;
3004 dev->flags |= DF_ATTACHED_ONCE;
3005 /* We only need the low bits of this time, but ranges from tens to thousands
3006 * have been seen, so keep 2 bytes' worth.
3008 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3009 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3010 device_sysctl_update(dev);
3012 dev->state = DS_BUSY;
3014 dev->state = DS_ATTACHED;
3015 dev->flags &= ~DF_DONENOMATCH;
3016 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3022 * @brief Detach a driver from a device
3024 * This function is a wrapper around the DEVICE_DETACH() driver
3025 * method. If the call to DEVICE_DETACH() succeeds, it calls
3026 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3027 * notification event for user-based device management services and
3028 * cleans up the device's sysctl tree.
3030 * @param dev the device to un-initialise
3033 * @retval ENXIO no driver was found
3034 * @retval ENOMEM memory allocation failure
3035 * @retval non-zero some other unix error code
3038 device_detach(device_t dev)
3044 PDEBUG(("%s", DEVICENAME(dev)));
3045 if (dev->state == DS_BUSY)
3047 if (dev->state == DS_ATTACHING) {
3048 device_printf(dev, "device in attaching state! Deferring detach.\n");
3051 if (dev->state != DS_ATTACHED)
3054 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3055 if ((error = DEVICE_DETACH(dev)) != 0) {
3056 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3057 EVHDEV_DETACH_FAILED);
3060 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3061 EVHDEV_DETACH_COMPLETE);
3064 if (!device_is_quiet(dev))
3065 device_printf(dev, "detached\n");
3067 BUS_CHILD_DETACHED(dev->parent, dev);
3069 if (!(dev->flags & DF_FIXEDCLASS))
3070 devclass_delete_device(dev->devclass, dev);
3072 device_verbose(dev);
3073 dev->state = DS_NOTPRESENT;
3074 (void)device_set_driver(dev, NULL);
3075 device_sysctl_fini(dev);
3081 * @brief Tells a driver to quiesce itself.
3083 * This function is a wrapper around the DEVICE_QUIESCE() driver
3084 * method. If the call to DEVICE_QUIESCE() succeeds.
3086 * @param dev the device to quiesce
3089 * @retval ENXIO no driver was found
3090 * @retval ENOMEM memory allocation failure
3091 * @retval non-zero some other unix error code
3094 device_quiesce(device_t dev)
3096 PDEBUG(("%s", DEVICENAME(dev)));
3097 if (dev->state == DS_BUSY)
3099 if (dev->state != DS_ATTACHED)
3102 return (DEVICE_QUIESCE(dev));
3106 * @brief Notify a device of system shutdown
3108 * This function calls the DEVICE_SHUTDOWN() driver method if the
3109 * device currently has an attached driver.
3111 * @returns the value returned by DEVICE_SHUTDOWN()
3114 device_shutdown(device_t dev)
3116 if (dev->state < DS_ATTACHED)
3118 return (DEVICE_SHUTDOWN(dev));
3122 * @brief Set the unit number of a device
3124 * This function can be used to override the unit number used for a
3125 * device (e.g. to wire a device to a pre-configured unit number).
3128 device_set_unit(device_t dev, int unit)
3133 dc = device_get_devclass(dev);
3134 if (unit < dc->maxunit && dc->devices[unit])
3136 err = devclass_delete_device(dc, dev);
3140 err = devclass_add_device(dc, dev);
3144 bus_data_generation_update();
3148 /*======================================*/
3150 * Some useful method implementations to make life easier for bus drivers.
3154 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3158 args->memattr = VM_MEMATTR_UNCACHEABLE;
3162 * @brief Initialise a resource list.
3164 * @param rl the resource list to initialise
3167 resource_list_init(struct resource_list *rl)
3173 * @brief Reclaim memory used by a resource list.
3175 * This function frees the memory for all resource entries on the list
3178 * @param rl the resource list to free
3181 resource_list_free(struct resource_list *rl)
3183 struct resource_list_entry *rle;
3185 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3187 panic("resource_list_free: resource entry is busy");
3188 STAILQ_REMOVE_HEAD(rl, link);
3194 * @brief Add a resource entry.
3196 * This function adds a resource entry using the given @p type, @p
3197 * start, @p end and @p count values. A rid value is chosen by
3198 * searching sequentially for the first unused rid starting at zero.
3200 * @param rl the resource list to edit
3201 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3202 * @param start the start address of the resource
3203 * @param end the end address of the resource
3204 * @param count XXX end-start+1
3207 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3208 rman_res_t end, rman_res_t count)
3213 while (resource_list_find(rl, type, rid) != NULL)
3215 resource_list_add(rl, type, rid, start, end, count);
3220 * @brief Add or modify a resource entry.
3222 * If an existing entry exists with the same type and rid, it will be
3223 * modified using the given values of @p start, @p end and @p
3224 * count. If no entry exists, a new one will be created using the
3225 * given values. The resource list entry that matches is then returned.
3227 * @param rl the resource list to edit
3228 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3229 * @param rid the resource identifier
3230 * @param start the start address of the resource
3231 * @param end the end address of the resource
3232 * @param count XXX end-start+1
3234 struct resource_list_entry *
3235 resource_list_add(struct resource_list *rl, int type, int rid,
3236 rman_res_t start, rman_res_t end, rman_res_t count)
3238 struct resource_list_entry *rle;
3240 rle = resource_list_find(rl, type, rid);
3242 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3245 panic("resource_list_add: can't record entry");
3246 STAILQ_INSERT_TAIL(rl, rle, link);
3254 panic("resource_list_add: resource entry is busy");
3263 * @brief Determine if a resource entry is busy.
3265 * Returns true if a resource entry is busy meaning that it has an
3266 * associated resource that is not an unallocated "reserved" resource.
3268 * @param rl the resource list to search
3269 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3270 * @param rid the resource identifier
3272 * @returns Non-zero if the entry is busy, zero otherwise.
3275 resource_list_busy(struct resource_list *rl, int type, int rid)
3277 struct resource_list_entry *rle;
3279 rle = resource_list_find(rl, type, rid);
3280 if (rle == NULL || rle->res == NULL)
3282 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3283 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3284 ("reserved resource is active"));
3291 * @brief Determine if a resource entry is reserved.
3293 * Returns true if a resource entry is reserved meaning that it has an
3294 * associated "reserved" resource. The resource can either be
3295 * allocated or unallocated.
3297 * @param rl the resource list to search
3298 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3299 * @param rid the resource identifier
3301 * @returns Non-zero if the entry is reserved, zero otherwise.
3304 resource_list_reserved(struct resource_list *rl, int type, int rid)
3306 struct resource_list_entry *rle;
3308 rle = resource_list_find(rl, type, rid);
3309 if (rle != NULL && rle->flags & RLE_RESERVED)
3315 * @brief Find a resource entry by type and rid.
3317 * @param rl the resource list to search
3318 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3319 * @param rid the resource identifier
3321 * @returns the resource entry pointer or NULL if there is no such
3324 struct resource_list_entry *
3325 resource_list_find(struct resource_list *rl, int type, int rid)
3327 struct resource_list_entry *rle;
3329 STAILQ_FOREACH(rle, rl, link) {
3330 if (rle->type == type && rle->rid == rid)
3337 * @brief Delete a resource entry.
3339 * @param rl the resource list to edit
3340 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3341 * @param rid the resource identifier
3344 resource_list_delete(struct resource_list *rl, int type, int rid)
3346 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3349 if (rle->res != NULL)
3350 panic("resource_list_delete: resource has not been released");
3351 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3357 * @brief Allocate a reserved resource
3359 * This can be used by buses to force the allocation of resources
3360 * that are always active in the system even if they are not allocated
3361 * by a driver (e.g. PCI BARs). This function is usually called when
3362 * adding a new child to the bus. The resource is allocated from the
3363 * parent bus when it is reserved. The resource list entry is marked
3364 * with RLE_RESERVED to note that it is a reserved resource.
3366 * Subsequent attempts to allocate the resource with
3367 * resource_list_alloc() will succeed the first time and will set
3368 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3369 * resource that has been allocated is released with
3370 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3371 * the actual resource remains allocated. The resource can be released to
3372 * the parent bus by calling resource_list_unreserve().
3374 * @param rl the resource list to allocate from
3375 * @param bus the parent device of @p child
3376 * @param child the device for which the resource is being reserved
3377 * @param type the type of resource to allocate
3378 * @param rid a pointer to the resource identifier
3379 * @param start hint at the start of the resource range - pass
3380 * @c 0 for any start address
3381 * @param end hint at the end of the resource range - pass
3382 * @c ~0 for any end address
3383 * @param count hint at the size of range required - pass @c 1
3385 * @param flags any extra flags to control the resource
3386 * allocation - see @c RF_XXX flags in
3387 * <sys/rman.h> for details
3389 * @returns the resource which was allocated or @c NULL if no
3390 * resource could be allocated
3393 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3394 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3396 struct resource_list_entry *rle = NULL;
3397 int passthrough = (device_get_parent(child) != bus);
3402 "resource_list_reserve() should only be called for direct children");
3403 if (flags & RF_ACTIVE)
3405 "resource_list_reserve() should only reserve inactive resources");
3407 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3410 rle = resource_list_find(rl, type, *rid);
3411 rle->flags |= RLE_RESERVED;
3417 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3419 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3420 * and passing the allocation up to the parent of @p bus. This assumes
3421 * that the first entry of @c device_get_ivars(child) is a struct
3422 * resource_list. This also handles 'passthrough' allocations where a
3423 * child is a remote descendant of bus by passing the allocation up to
3424 * the parent of bus.
3426 * Typically, a bus driver would store a list of child resources
3427 * somewhere in the child device's ivars (see device_get_ivars()) and
3428 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3429 * then call resource_list_alloc() to perform the allocation.
3431 * @param rl the resource list to allocate from
3432 * @param bus the parent device of @p child
3433 * @param child the device which is requesting an allocation
3434 * @param type the type of resource to allocate
3435 * @param rid a pointer to the resource identifier
3436 * @param start hint at the start of the resource range - pass
3437 * @c 0 for any start address
3438 * @param end hint at the end of the resource range - pass
3439 * @c ~0 for any end address
3440 * @param count hint at the size of range required - pass @c 1
3442 * @param flags any extra flags to control the resource
3443 * allocation - see @c RF_XXX flags in
3444 * <sys/rman.h> for details
3446 * @returns the resource which was allocated or @c NULL if no
3447 * resource could be allocated
3450 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3451 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3453 struct resource_list_entry *rle = NULL;
3454 int passthrough = (device_get_parent(child) != bus);
3455 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3458 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3459 type, rid, start, end, count, flags));
3462 rle = resource_list_find(rl, type, *rid);
3465 return (NULL); /* no resource of that type/rid */
3468 if (rle->flags & RLE_RESERVED) {
3469 if (rle->flags & RLE_ALLOCATED)
3471 if ((flags & RF_ACTIVE) &&
3472 bus_activate_resource(child, type, *rid,
3475 rle->flags |= RLE_ALLOCATED;
3479 "resource entry %#x type %d for child %s is busy\n", *rid,
3480 type, device_get_nameunit(child));
3486 count = ulmax(count, rle->count);
3487 end = ulmax(rle->end, start + count - 1);
3490 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3491 type, rid, start, end, count, flags);
3494 * Record the new range.
3497 rle->start = rman_get_start(rle->res);
3498 rle->end = rman_get_end(rle->res);
3506 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3508 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3509 * used with resource_list_alloc().
3511 * @param rl the resource list which was allocated from
3512 * @param bus the parent device of @p child
3513 * @param child the device which is requesting a release
3514 * @param type the type of resource to release
3515 * @param rid the resource identifier
3516 * @param res the resource to release
3519 * @retval non-zero a standard unix error code indicating what
3520 * error condition prevented the operation
3523 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3524 int type, int rid, struct resource *res)
3526 struct resource_list_entry *rle = NULL;
3527 int passthrough = (device_get_parent(child) != bus);
3531 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3535 rle = resource_list_find(rl, type, rid);
3538 panic("resource_list_release: can't find resource");
3540 panic("resource_list_release: resource entry is not busy");
3541 if (rle->flags & RLE_RESERVED) {
3542 if (rle->flags & RLE_ALLOCATED) {
3543 if (rman_get_flags(res) & RF_ACTIVE) {
3544 error = bus_deactivate_resource(child, type,
3549 rle->flags &= ~RLE_ALLOCATED;
3555 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3565 * @brief Release all active resources of a given type
3567 * Release all active resources of a specified type. This is intended
3568 * to be used to cleanup resources leaked by a driver after detach or
3571 * @param rl the resource list which was allocated from
3572 * @param bus the parent device of @p child
3573 * @param child the device whose active resources are being released
3574 * @param type the type of resources to release
3577 * @retval EBUSY at least one resource was active
3580 resource_list_release_active(struct resource_list *rl, device_t bus,
3581 device_t child, int type)
3583 struct resource_list_entry *rle;
3587 STAILQ_FOREACH(rle, rl, link) {
3588 if (rle->type != type)
3590 if (rle->res == NULL)
3592 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3596 error = resource_list_release(rl, bus, child, type,
3597 rman_get_rid(rle->res), rle->res);
3600 "Failed to release active resource: %d\n", error);
3606 * @brief Fully release a reserved resource
3608 * Fully releases a resource reserved via resource_list_reserve().
3610 * @param rl the resource list which was allocated from
3611 * @param bus the parent device of @p child
3612 * @param child the device whose reserved resource is being released
3613 * @param type the type of resource to release
3614 * @param rid the resource identifier
3615 * @param res the resource to release
3618 * @retval non-zero a standard unix error code indicating what
3619 * error condition prevented the operation
3622 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3625 struct resource_list_entry *rle = NULL;
3626 int passthrough = (device_get_parent(child) != bus);
3630 "resource_list_unreserve() should only be called for direct children");
3632 rle = resource_list_find(rl, type, rid);
3635 panic("resource_list_unreserve: can't find resource");
3636 if (!(rle->flags & RLE_RESERVED))
3638 if (rle->flags & RLE_ALLOCATED)
3640 rle->flags &= ~RLE_RESERVED;
3641 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3645 * @brief Print a description of resources in a resource list
3647 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3648 * The name is printed if at least one resource of the given type is available.
3649 * The format is used to print resource start and end.
3651 * @param rl the resource list to print
3652 * @param name the name of @p type, e.g. @c "memory"
3653 * @param type type type of resource entry to print
3654 * @param format printf(9) format string to print resource
3655 * start and end values
3657 * @returns the number of characters printed
3660 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3663 struct resource_list_entry *rle;
3664 int printed, retval;
3668 /* Yes, this is kinda cheating */
3669 STAILQ_FOREACH(rle, rl, link) {
3670 if (rle->type == type) {
3672 retval += printf(" %s ", name);
3674 retval += printf(",");
3676 retval += printf(format, rle->start);
3677 if (rle->count > 1) {
3678 retval += printf("-");
3679 retval += printf(format, rle->start +
3688 * @brief Releases all the resources in a list.
3690 * @param rl The resource list to purge.
3695 resource_list_purge(struct resource_list *rl)
3697 struct resource_list_entry *rle;
3699 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3701 bus_release_resource(rman_get_device(rle->res),
3702 rle->type, rle->rid, rle->res);
3703 STAILQ_REMOVE_HEAD(rl, link);
3709 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3711 return (device_add_child_ordered(dev, order, name, unit));
3715 * @brief Helper function for implementing DEVICE_PROBE()
3717 * This function can be used to help implement the DEVICE_PROBE() for
3718 * a bus (i.e. a device which has other devices attached to it). It
3719 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3723 bus_generic_probe(device_t dev)
3725 devclass_t dc = dev->devclass;
3728 TAILQ_FOREACH(dl, &dc->drivers, link) {
3730 * If this driver's pass is too high, then ignore it.
3731 * For most drivers in the default pass, this will
3732 * never be true. For early-pass drivers they will
3733 * only call the identify routines of eligible drivers
3734 * when this routine is called. Drivers for later
3735 * passes should have their identify routines called
3736 * on early-pass buses during BUS_NEW_PASS().
3738 if (dl->pass > bus_current_pass)
3740 DEVICE_IDENTIFY(dl->driver, dev);
3747 * @brief Helper function for implementing DEVICE_ATTACH()
3749 * This function can be used to help implement the DEVICE_ATTACH() for
3750 * a bus. It calls device_probe_and_attach() for each of the device's
3754 bus_generic_attach(device_t dev)
3758 TAILQ_FOREACH(child, &dev->children, link) {
3759 device_probe_and_attach(child);
3766 * @brief Helper function for delaying attaching children
3768 * Many buses can't run transactions on the bus which children need to probe and
3769 * attach until after interrupts and/or timers are running. This function
3770 * delays their attach until interrupts and timers are enabled.
3773 bus_delayed_attach_children(device_t dev)
3775 /* Probe and attach the bus children when interrupts are available */
3776 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3782 * @brief Helper function for implementing DEVICE_DETACH()
3784 * This function can be used to help implement the DEVICE_DETACH() for
3785 * a bus. It calls device_detach() for each of the device's
3789 bus_generic_detach(device_t dev)
3794 if (dev->state != DS_ATTACHED)
3798 * Detach children in the reverse order.
3799 * See bus_generic_suspend for details.
3801 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3802 if ((error = device_detach(child)) != 0)
3810 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3812 * This function can be used to help implement the DEVICE_SHUTDOWN()
3813 * for a bus. It calls device_shutdown() for each of the device's
3817 bus_generic_shutdown(device_t dev)
3822 * Shut down children in the reverse order.
3823 * See bus_generic_suspend for details.
3825 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3826 device_shutdown(child);
3833 * @brief Default function for suspending a child device.
3835 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3838 bus_generic_suspend_child(device_t dev, device_t child)
3842 error = DEVICE_SUSPEND(child);
3845 child->flags |= DF_SUSPENDED;
3851 * @brief Default function for resuming a child device.
3853 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3856 bus_generic_resume_child(device_t dev, device_t child)
3858 DEVICE_RESUME(child);
3859 child->flags &= ~DF_SUSPENDED;
3865 * @brief Helper function for implementing DEVICE_SUSPEND()
3867 * This function can be used to help implement the DEVICE_SUSPEND()
3868 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3869 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3870 * operation is aborted and any devices which were suspended are
3871 * resumed immediately by calling their DEVICE_RESUME() methods.
3874 bus_generic_suspend(device_t dev)
3880 * Suspend children in the reverse order.
3881 * For most buses all children are equal, so the order does not matter.
3882 * Other buses, such as acpi, carefully order their child devices to
3883 * express implicit dependencies between them. For such buses it is
3884 * safer to bring down devices in the reverse order.
3886 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3887 error = BUS_SUSPEND_CHILD(dev, child);
3889 child = TAILQ_NEXT(child, link);
3890 if (child != NULL) {
3891 TAILQ_FOREACH_FROM(child, &dev->children, link)
3892 BUS_RESUME_CHILD(dev, child);
3901 * @brief Helper function for implementing DEVICE_RESUME()
3903 * This function can be used to help implement the DEVICE_RESUME() for
3904 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3907 bus_generic_resume(device_t dev)
3911 TAILQ_FOREACH(child, &dev->children, link) {
3912 BUS_RESUME_CHILD(dev, child);
3913 /* if resume fails, there's nothing we can usefully do... */
3919 * @brief Helper function for implementing BUS_RESET_POST
3921 * Bus can use this function to implement common operations of
3922 * re-attaching or resuming the children after the bus itself was
3923 * reset, and after restoring bus-unique state of children.
3925 * @param dev The bus
3926 * #param flags DEVF_RESET_*
3929 bus_helper_reset_post(device_t dev, int flags)
3935 TAILQ_FOREACH(child, &dev->children,link) {
3936 BUS_RESET_POST(dev, child);
3937 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3938 device_probe_and_attach(child) :
3939 BUS_RESUME_CHILD(dev, child);
3940 if (error == 0 && error1 != 0)
3947 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3949 child = TAILQ_NEXT(child, link);
3952 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3953 BUS_RESET_POST(dev, child);
3954 if ((flags & DEVF_RESET_DETACH) != 0)
3955 device_probe_and_attach(child);
3957 BUS_RESUME_CHILD(dev, child);
3962 * @brief Helper function for implementing BUS_RESET_PREPARE
3964 * Bus can use this function to implement common operations of
3965 * detaching or suspending the children before the bus itself is
3966 * reset, and then save bus-unique state of children that must
3967 * persists around reset.
3969 * @param dev The bus
3970 * #param flags DEVF_RESET_*
3973 bus_helper_reset_prepare(device_t dev, int flags)
3978 if (dev->state != DS_ATTACHED)
3981 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3982 if ((flags & DEVF_RESET_DETACH) != 0) {
3983 error = device_get_state(child) == DS_ATTACHED ?
3984 device_detach(child) : 0;
3986 error = BUS_SUSPEND_CHILD(dev, child);
3989 error = BUS_RESET_PREPARE(dev, child);
3991 if ((flags & DEVF_RESET_DETACH) != 0)
3992 device_probe_and_attach(child);
3994 BUS_RESUME_CHILD(dev, child);
3998 bus_helper_reset_prepare_rollback(dev, child, flags);
4006 * @brief Helper function for implementing BUS_PRINT_CHILD().
4008 * This function prints the first part of the ascii representation of
4009 * @p child, including its name, unit and description (if any - see
4010 * device_set_desc()).
4012 * @returns the number of characters printed
4015 bus_print_child_header(device_t dev, device_t child)
4019 if (device_get_desc(child)) {
4020 retval += device_printf(child, "<%s>", device_get_desc(child));
4022 retval += printf("%s", device_get_nameunit(child));
4029 * @brief Helper function for implementing BUS_PRINT_CHILD().
4031 * This function prints the last part of the ascii representation of
4032 * @p child, which consists of the string @c " on " followed by the
4033 * name and unit of the @p dev.
4035 * @returns the number of characters printed
4038 bus_print_child_footer(device_t dev, device_t child)
4040 return (printf(" on %s\n", device_get_nameunit(dev)));
4044 * @brief Helper function for implementing BUS_PRINT_CHILD().
4046 * This function prints out the VM domain for the given device.
4048 * @returns the number of characters printed
4051 bus_print_child_domain(device_t dev, device_t child)
4055 /* No domain? Don't print anything */
4056 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4059 return (printf(" numa-domain %d", domain));
4063 * @brief Helper function for implementing BUS_PRINT_CHILD().
4065 * This function simply calls bus_print_child_header() followed by
4066 * bus_print_child_footer().
4068 * @returns the number of characters printed
4071 bus_generic_print_child(device_t dev, device_t child)
4075 retval += bus_print_child_header(dev, child);
4076 retval += bus_print_child_domain(dev, child);
4077 retval += bus_print_child_footer(dev, child);
4083 * @brief Stub function for implementing BUS_READ_IVAR().
4088 bus_generic_read_ivar(device_t dev, device_t child, int index,
4095 * @brief Stub function for implementing BUS_WRITE_IVAR().
4100 bus_generic_write_ivar(device_t dev, device_t child, int index,
4107 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4111 struct resource_list *
4112 bus_generic_get_resource_list(device_t dev, device_t child)
4118 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4120 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4121 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4122 * and then calls device_probe_and_attach() for each unattached child.
4125 bus_generic_driver_added(device_t dev, driver_t *driver)
4129 DEVICE_IDENTIFY(driver, dev);
4130 TAILQ_FOREACH(child, &dev->children, link) {
4131 if (child->state == DS_NOTPRESENT ||
4132 (child->flags & DF_REBID))
4133 device_probe_and_attach(child);
4138 * @brief Helper function for implementing BUS_NEW_PASS().
4140 * This implementing of BUS_NEW_PASS() first calls the identify
4141 * routines for any drivers that probe at the current pass. Then it
4142 * walks the list of devices for this bus. If a device is already
4143 * attached, then it calls BUS_NEW_PASS() on that device. If the
4144 * device is not already attached, it attempts to attach a driver to
4148 bus_generic_new_pass(device_t dev)
4155 TAILQ_FOREACH(dl, &dc->drivers, link) {
4156 if (dl->pass == bus_current_pass)
4157 DEVICE_IDENTIFY(dl->driver, dev);
4159 TAILQ_FOREACH(child, &dev->children, link) {
4160 if (child->state >= DS_ATTACHED)
4161 BUS_NEW_PASS(child);
4162 else if (child->state == DS_NOTPRESENT)
4163 device_probe_and_attach(child);
4168 * @brief Helper function for implementing BUS_SETUP_INTR().
4170 * This simple implementation of BUS_SETUP_INTR() simply calls the
4171 * BUS_SETUP_INTR() method of the parent of @p dev.
4174 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4175 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4178 /* Propagate up the bus hierarchy until someone handles it. */
4180 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4181 filter, intr, arg, cookiep));
4186 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4188 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4189 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4192 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4195 /* Propagate up the bus hierarchy until someone handles it. */
4197 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4202 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4204 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4205 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4208 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4210 /* Propagate up the bus hierarchy until someone handles it. */
4212 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4217 * @brief Helper function for implementing BUS_RESUME_INTR().
4219 * This simple implementation of BUS_RESUME_INTR() simply calls the
4220 * BUS_RESUME_INTR() method of the parent of @p dev.
4223 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4225 /* Propagate up the bus hierarchy until someone handles it. */
4227 return (BUS_RESUME_INTR(dev->parent, child, irq));
4232 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4234 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4235 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4238 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4239 struct resource *r, rman_res_t start, rman_res_t end)
4241 /* Propagate up the bus hierarchy until someone handles it. */
4243 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4249 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4251 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4252 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4255 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4256 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4258 /* Propagate up the bus hierarchy until someone handles it. */
4260 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4261 start, end, count, flags));
4266 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4268 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4269 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4272 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4275 /* Propagate up the bus hierarchy until someone handles it. */
4277 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4283 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4285 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4286 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4289 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4292 /* Propagate up the bus hierarchy until someone handles it. */
4294 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4300 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4302 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4303 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4306 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4307 int rid, struct resource *r)
4309 /* Propagate up the bus hierarchy until someone handles it. */
4311 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4317 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4319 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4320 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4323 bus_generic_map_resource(device_t dev, device_t child, int type,
4324 struct resource *r, struct resource_map_request *args,
4325 struct resource_map *map)
4327 /* Propagate up the bus hierarchy until someone handles it. */
4329 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4335 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4337 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4338 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4341 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4342 struct resource *r, struct resource_map *map)
4344 /* Propagate up the bus hierarchy until someone handles it. */
4346 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4351 * @brief Helper function for implementing BUS_BIND_INTR().
4353 * This simple implementation of BUS_BIND_INTR() simply calls the
4354 * BUS_BIND_INTR() method of the parent of @p dev.
4357 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4360 /* Propagate up the bus hierarchy until someone handles it. */
4362 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4367 * @brief Helper function for implementing BUS_CONFIG_INTR().
4369 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4370 * BUS_CONFIG_INTR() method of the parent of @p dev.
4373 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4374 enum intr_polarity pol)
4376 /* Propagate up the bus hierarchy until someone handles it. */
4378 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4383 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4385 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4386 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4389 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4390 void *cookie, const char *descr)
4392 /* Propagate up the bus hierarchy until someone handles it. */
4394 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4400 * @brief Helper function for implementing BUS_GET_CPUS().
4402 * This simple implementation of BUS_GET_CPUS() simply calls the
4403 * BUS_GET_CPUS() method of the parent of @p dev.
4406 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4407 size_t setsize, cpuset_t *cpuset)
4409 /* Propagate up the bus hierarchy until someone handles it. */
4410 if (dev->parent != NULL)
4411 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4416 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4418 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4419 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4422 bus_generic_get_dma_tag(device_t dev, device_t child)
4424 /* Propagate up the bus hierarchy until someone handles it. */
4425 if (dev->parent != NULL)
4426 return (BUS_GET_DMA_TAG(dev->parent, child));
4431 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4433 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4434 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4437 bus_generic_get_bus_tag(device_t dev, device_t child)
4439 /* Propagate up the bus hierarchy until someone handles it. */
4440 if (dev->parent != NULL)
4441 return (BUS_GET_BUS_TAG(dev->parent, child));
4442 return ((bus_space_tag_t)0);
4446 * @brief Helper function for implementing BUS_GET_RESOURCE().
4448 * This implementation of BUS_GET_RESOURCE() uses the
4449 * resource_list_find() function to do most of the work. It calls
4450 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4454 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4455 rman_res_t *startp, rman_res_t *countp)
4457 struct resource_list * rl = NULL;
4458 struct resource_list_entry * rle = NULL;
4460 rl = BUS_GET_RESOURCE_LIST(dev, child);
4464 rle = resource_list_find(rl, type, rid);
4469 *startp = rle->start;
4471 *countp = rle->count;
4477 * @brief Helper function for implementing BUS_SET_RESOURCE().
4479 * This implementation of BUS_SET_RESOURCE() uses the
4480 * resource_list_add() function to do most of the work. It calls
4481 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4485 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4486 rman_res_t start, rman_res_t count)
4488 struct resource_list * rl = NULL;
4490 rl = BUS_GET_RESOURCE_LIST(dev, child);
4494 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4500 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4502 * This implementation of BUS_DELETE_RESOURCE() uses the
4503 * resource_list_delete() function to do most of the work. It calls
4504 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4508 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4510 struct resource_list * rl = NULL;
4512 rl = BUS_GET_RESOURCE_LIST(dev, child);
4516 resource_list_delete(rl, type, rid);
4522 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4524 * This implementation of BUS_RELEASE_RESOURCE() uses the
4525 * resource_list_release() function to do most of the work. It calls
4526 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4529 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4530 int rid, struct resource *r)
4532 struct resource_list * rl = NULL;
4534 if (device_get_parent(child) != dev)
4535 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4538 rl = BUS_GET_RESOURCE_LIST(dev, child);
4542 return (resource_list_release(rl, dev, child, type, rid, r));
4546 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4548 * This implementation of BUS_ALLOC_RESOURCE() uses the
4549 * resource_list_alloc() function to do most of the work. It calls
4550 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4553 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4554 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4556 struct resource_list * rl = NULL;
4558 if (device_get_parent(child) != dev)
4559 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4560 type, rid, start, end, count, flags));
4562 rl = BUS_GET_RESOURCE_LIST(dev, child);
4566 return (resource_list_alloc(rl, dev, child, type, rid,
4567 start, end, count, flags));
4571 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4573 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4574 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4577 bus_generic_child_present(device_t dev, device_t child)
4579 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4583 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4586 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4592 * @brief Helper function for implementing BUS_RESCAN().
4594 * This null implementation of BUS_RESCAN() always fails to indicate
4595 * the bus does not support rescanning.
4598 bus_null_rescan(device_t dev)
4604 * Some convenience functions to make it easier for drivers to use the
4605 * resource-management functions. All these really do is hide the
4606 * indirection through the parent's method table, making for slightly
4607 * less-wordy code. In the future, it might make sense for this code
4608 * to maintain some sort of a list of resources allocated by each device.
4612 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4613 struct resource **res)
4617 for (i = 0; rs[i].type != -1; i++)
4619 for (i = 0; rs[i].type != -1; i++) {
4620 res[i] = bus_alloc_resource_any(dev,
4621 rs[i].type, &rs[i].rid, rs[i].flags);
4622 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4623 bus_release_resources(dev, rs, res);
4631 bus_release_resources(device_t dev, const struct resource_spec *rs,
4632 struct resource **res)
4636 for (i = 0; rs[i].type != -1; i++)
4637 if (res[i] != NULL) {
4638 bus_release_resource(
4639 dev, rs[i].type, rs[i].rid, res[i]);
4645 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4647 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4651 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4652 rman_res_t end, rman_res_t count, u_int flags)
4654 struct resource *res;
4656 if (dev->parent == NULL)
4658 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4664 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4666 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4670 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4673 if (dev->parent == NULL)
4675 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4679 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4681 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4685 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4687 if (dev->parent == NULL)
4689 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4693 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4695 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4699 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4701 if (dev->parent == NULL)
4703 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4707 * @brief Wrapper function for BUS_MAP_RESOURCE().
4709 * This function simply calls the BUS_MAP_RESOURCE() method of the
4713 bus_map_resource(device_t dev, int type, struct resource *r,
4714 struct resource_map_request *args, struct resource_map *map)
4716 if (dev->parent == NULL)
4718 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4722 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4724 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4728 bus_unmap_resource(device_t dev, int type, struct resource *r,
4729 struct resource_map *map)
4731 if (dev->parent == NULL)
4733 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4737 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4739 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4743 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4747 if (dev->parent == NULL)
4749 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4754 * @brief Wrapper function for BUS_SETUP_INTR().
4756 * This function simply calls the BUS_SETUP_INTR() method of the
4760 bus_setup_intr(device_t dev, struct resource *r, int flags,
4761 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4765 if (dev->parent == NULL)
4767 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4771 if (handler != NULL && !(flags & INTR_MPSAFE))
4772 device_printf(dev, "[GIANT-LOCKED]\n");
4777 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4779 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4783 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4785 if (dev->parent == NULL)
4787 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4791 * @brief Wrapper function for BUS_SUSPEND_INTR().
4793 * This function simply calls the BUS_SUSPEND_INTR() method of the
4797 bus_suspend_intr(device_t dev, struct resource *r)
4799 if (dev->parent == NULL)
4801 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4805 * @brief Wrapper function for BUS_RESUME_INTR().
4807 * This function simply calls the BUS_RESUME_INTR() method of the
4811 bus_resume_intr(device_t dev, struct resource *r)
4813 if (dev->parent == NULL)
4815 return (BUS_RESUME_INTR(dev->parent, dev, r));
4819 * @brief Wrapper function for BUS_BIND_INTR().
4821 * This function simply calls the BUS_BIND_INTR() method of the
4825 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4827 if (dev->parent == NULL)
4829 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4833 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4835 * This function first formats the requested description into a
4836 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4837 * the parent of @p dev.
4840 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4841 const char *fmt, ...)
4844 char descr[MAXCOMLEN + 1];
4846 if (dev->parent == NULL)
4849 vsnprintf(descr, sizeof(descr), fmt, ap);
4851 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4855 * @brief Wrapper function for BUS_SET_RESOURCE().
4857 * This function simply calls the BUS_SET_RESOURCE() method of the
4861 bus_set_resource(device_t dev, int type, int rid,
4862 rman_res_t start, rman_res_t count)
4864 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4869 * @brief Wrapper function for BUS_GET_RESOURCE().
4871 * This function simply calls the BUS_GET_RESOURCE() method of the
4875 bus_get_resource(device_t dev, int type, int rid,
4876 rman_res_t *startp, rman_res_t *countp)
4878 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4883 * @brief Wrapper function for BUS_GET_RESOURCE().
4885 * This function simply calls the BUS_GET_RESOURCE() method of the
4886 * parent of @p dev and returns the start value.
4889 bus_get_resource_start(device_t dev, int type, int rid)
4895 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4903 * @brief Wrapper function for BUS_GET_RESOURCE().
4905 * This function simply calls the BUS_GET_RESOURCE() method of the
4906 * parent of @p dev and returns the count value.
4909 bus_get_resource_count(device_t dev, int type, int rid)
4915 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4923 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4925 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4929 bus_delete_resource(device_t dev, int type, int rid)
4931 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4935 * @brief Wrapper function for BUS_CHILD_PRESENT().
4937 * This function simply calls the BUS_CHILD_PRESENT() method of the
4941 bus_child_present(device_t child)
4943 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4947 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4949 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4953 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4957 parent = device_get_parent(child);
4958 if (parent == NULL) {
4962 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4966 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4968 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4972 bus_child_location_str(device_t child, char *buf, size_t buflen)
4976 parent = device_get_parent(child);
4977 if (parent == NULL) {
4981 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4985 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
4987 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
4988 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
4989 * accomplish this, however. It is an interim function until we can convert
4990 * this interface more fully.
4992 /* Note: we reach inside of sbuf because it's API isn't rich enough to do this */
4993 #define SPACE(s) ((s)->s_size - (s)->s_len)
4994 #define EOB(s) ((s)->s_buf + (s)->s_len)
4997 bus_child_pnpinfo_sb(device_t dev, struct sbuf *sb)
5002 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5003 MPASS(sb->s_size >= sb->s_len);
5004 if (sb->s_error != 0)
5008 sb->s_error = ENOMEM;
5012 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5013 bus_child_pnpinfo_str(dev, p, space);
5014 sb->s_len += strlen(p);
5019 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
5021 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
5022 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
5023 * accomplish this, however. It is an interim function until we can convert
5024 * this interface more fully.
5027 bus_child_location_sb(device_t dev, struct sbuf *sb)
5032 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5033 MPASS(sb->s_size >= sb->s_len);
5034 if (sb->s_error != 0)
5038 sb->s_error = ENOMEM;
5042 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5043 bus_child_location_str(dev, p, space);
5044 sb->s_len += strlen(p);
5051 * @brief Wrapper function for BUS_GET_CPUS().
5053 * This function simply calls the BUS_GET_CPUS() method of the
5057 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5061 parent = device_get_parent(dev);
5064 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5068 * @brief Wrapper function for BUS_GET_DMA_TAG().
5070 * This function simply calls the BUS_GET_DMA_TAG() method of the
5074 bus_get_dma_tag(device_t dev)
5078 parent = device_get_parent(dev);
5081 return (BUS_GET_DMA_TAG(parent, dev));
5085 * @brief Wrapper function for BUS_GET_BUS_TAG().
5087 * This function simply calls the BUS_GET_BUS_TAG() method of the
5091 bus_get_bus_tag(device_t dev)
5095 parent = device_get_parent(dev);
5097 return ((bus_space_tag_t)0);
5098 return (BUS_GET_BUS_TAG(parent, dev));
5102 * @brief Wrapper function for BUS_GET_DOMAIN().
5104 * This function simply calls the BUS_GET_DOMAIN() method of the
5108 bus_get_domain(device_t dev, int *domain)
5110 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5113 /* Resume all devices and then notify userland that we're up again. */
5115 root_resume(device_t dev)
5119 error = bus_generic_resume(dev);
5121 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5122 devctl_notify("kernel", "power", "resume", NULL);
5128 root_print_child(device_t dev, device_t child)
5132 retval += bus_print_child_header(dev, child);
5133 retval += printf("\n");
5139 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5140 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5143 * If an interrupt mapping gets to here something bad has happened.
5145 panic("root_setup_intr");
5149 * If we get here, assume that the device is permanent and really is
5150 * present in the system. Removable bus drivers are expected to intercept
5151 * this call long before it gets here. We return -1 so that drivers that
5152 * really care can check vs -1 or some ERRNO returned higher in the food
5156 root_child_present(device_t dev, device_t child)
5162 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5167 /* Default to returning the set of all CPUs. */
5168 if (setsize != sizeof(cpuset_t))
5177 static kobj_method_t root_methods[] = {
5178 /* Device interface */
5179 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5180 KOBJMETHOD(device_suspend, bus_generic_suspend),
5181 KOBJMETHOD(device_resume, root_resume),
5184 KOBJMETHOD(bus_print_child, root_print_child),
5185 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5186 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5187 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5188 KOBJMETHOD(bus_child_present, root_child_present),
5189 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5194 static driver_t root_driver = {
5201 devclass_t root_devclass;
5204 root_bus_module_handler(module_t mod, int what, void* arg)
5208 TAILQ_INIT(&bus_data_devices);
5209 kobj_class_compile((kobj_class_t) &root_driver);
5210 root_bus = make_device(NULL, "root", 0);
5211 root_bus->desc = "System root bus";
5212 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5213 root_bus->driver = &root_driver;
5214 root_bus->state = DS_ATTACHED;
5215 root_devclass = devclass_find_internal("root", NULL, FALSE);
5220 device_shutdown(root_bus);
5223 return (EOPNOTSUPP);
5229 static moduledata_t root_bus_mod = {
5231 root_bus_module_handler,
5234 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5237 * @brief Automatically configure devices
5239 * This function begins the autoconfiguration process by calling
5240 * device_probe_and_attach() for each child of the @c root0 device.
5243 root_bus_configure(void)
5247 /* Eventually this will be split up, but this is sufficient for now. */
5248 bus_set_pass(BUS_PASS_DEFAULT);
5252 * @brief Module handler for registering device drivers
5254 * This module handler is used to automatically register device
5255 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5256 * devclass_add_driver() for the driver described by the
5257 * driver_module_data structure pointed to by @p arg
5260 driver_module_handler(module_t mod, int what, void *arg)
5262 struct driver_module_data *dmd;
5263 devclass_t bus_devclass;
5264 kobj_class_t driver;
5267 dmd = (struct driver_module_data *)arg;
5268 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5273 if (dmd->dmd_chainevh)
5274 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5276 pass = dmd->dmd_pass;
5277 driver = dmd->dmd_driver;
5278 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5279 DRIVERNAME(driver), dmd->dmd_busname, pass));
5280 error = devclass_add_driver(bus_devclass, driver, pass,
5285 PDEBUG(("Unloading module: driver %s from bus %s",
5286 DRIVERNAME(dmd->dmd_driver),
5288 error = devclass_delete_driver(bus_devclass,
5291 if (!error && dmd->dmd_chainevh)
5292 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5295 PDEBUG(("Quiesce module: driver %s from bus %s",
5296 DRIVERNAME(dmd->dmd_driver),
5298 error = devclass_quiesce_driver(bus_devclass,
5301 if (!error && dmd->dmd_chainevh)
5302 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5313 * @brief Enumerate all hinted devices for this bus.
5315 * Walks through the hints for this bus and calls the bus_hinted_child
5316 * routine for each one it fines. It searches first for the specific
5317 * bus that's being probed for hinted children (eg isa0), and then for
5318 * generic children (eg isa).
5320 * @param dev bus device to enumerate
5323 bus_enumerate_hinted_children(device_t bus)
5326 const char *dname, *busname;
5330 * enumerate all devices on the specific bus
5332 busname = device_get_nameunit(bus);
5334 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5335 BUS_HINTED_CHILD(bus, dname, dunit);
5338 * and all the generic ones.
5340 busname = device_get_name(bus);
5342 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5343 BUS_HINTED_CHILD(bus, dname, dunit);
5348 /* the _short versions avoid iteration by not calling anything that prints
5349 * more than oneliners. I love oneliners.
5353 print_device_short(device_t dev, int indent)
5358 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5359 dev->unit, dev->desc,
5360 (dev->parent? "":"no "),
5361 (TAILQ_EMPTY(&dev->children)? "no ":""),
5362 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5363 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5364 (dev->flags&DF_WILDCARD? "wildcard,":""),
5365 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5366 (dev->flags&DF_REBID? "rebiddable,":""),
5367 (dev->flags&DF_SUSPENDED? "suspended,":""),
5368 (dev->ivars? "":"no "),
5369 (dev->softc? "":"no "),
5374 print_device(device_t dev, int indent)
5379 print_device_short(dev, indent);
5381 indentprintf(("Parent:\n"));
5382 print_device_short(dev->parent, indent+1);
5383 indentprintf(("Driver:\n"));
5384 print_driver_short(dev->driver, indent+1);
5385 indentprintf(("Devclass:\n"));
5386 print_devclass_short(dev->devclass, indent+1);
5390 print_device_tree_short(device_t dev, int indent)
5391 /* print the device and all its children (indented) */
5398 print_device_short(dev, indent);
5400 TAILQ_FOREACH(child, &dev->children, link) {
5401 print_device_tree_short(child, indent+1);
5406 print_device_tree(device_t dev, int indent)
5407 /* print the device and all its children (indented) */
5414 print_device(dev, indent);
5416 TAILQ_FOREACH(child, &dev->children, link) {
5417 print_device_tree(child, indent+1);
5422 print_driver_short(driver_t *driver, int indent)
5427 indentprintf(("driver %s: softc size = %zd\n",
5428 driver->name, driver->size));
5432 print_driver(driver_t *driver, int indent)
5437 print_driver_short(driver, indent);
5441 print_driver_list(driver_list_t drivers, int indent)
5443 driverlink_t driver;
5445 TAILQ_FOREACH(driver, &drivers, link) {
5446 print_driver(driver->driver, indent);
5451 print_devclass_short(devclass_t dc, int indent)
5456 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5460 print_devclass(devclass_t dc, int indent)
5467 print_devclass_short(dc, indent);
5468 indentprintf(("Drivers:\n"));
5469 print_driver_list(dc->drivers, indent+1);
5471 indentprintf(("Devices:\n"));
5472 for (i = 0; i < dc->maxunit; i++)
5474 print_device(dc->devices[i], indent+1);
5478 print_devclass_list_short(void)
5482 printf("Short listing of devclasses, drivers & devices:\n");
5483 TAILQ_FOREACH(dc, &devclasses, link) {
5484 print_devclass_short(dc, 0);
5489 print_devclass_list(void)
5493 printf("Full listing of devclasses, drivers & devices:\n");
5494 TAILQ_FOREACH(dc, &devclasses, link) {
5495 print_devclass(dc, 0);
5502 * User-space access to the device tree.
5504 * We implement a small set of nodes:
5506 * hw.bus Single integer read method to obtain the
5507 * current generation count.
5508 * hw.bus.devices Reads the entire device tree in flat space.
5509 * hw.bus.rman Resource manager interface
5511 * We might like to add the ability to scan devclasses and/or drivers to
5512 * determine what else is currently loaded/available.
5516 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5518 struct u_businfo ubus;
5520 ubus.ub_version = BUS_USER_VERSION;
5521 ubus.ub_generation = bus_data_generation;
5523 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5525 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5526 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5527 "bus-related data");
5530 sysctl_devices(SYSCTL_HANDLER_ARGS)
5533 int *name = (int *)arg1;
5534 u_int namelen = arg2;
5537 struct u_device *udev;
5543 if (bus_data_generation_check(name[0]))
5549 * Scan the list of devices, looking for the requested index.
5551 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5559 * Populate the return item, careful not to overflow the buffer.
5561 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5564 udev->dv_handle = (uintptr_t)dev;
5565 udev->dv_parent = (uintptr_t)dev->parent;
5566 udev->dv_devflags = dev->devflags;
5567 udev->dv_flags = dev->flags;
5568 udev->dv_state = dev->state;
5569 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5570 if (dev->nameunit != NULL)
5571 sbuf_cat(&sb, dev->nameunit);
5572 sbuf_putc(&sb, '\0');
5573 if (dev->desc != NULL)
5574 sbuf_cat(&sb, dev->desc);
5575 sbuf_putc(&sb, '\0');
5576 if (dev->driver != NULL)
5577 sbuf_cat(&sb, dev->driver->name);
5578 sbuf_putc(&sb, '\0');
5579 bus_child_pnpinfo_sb(dev, &sb);
5580 sbuf_putc(&sb, '\0');
5581 bus_child_location_sb(dev, &sb);
5582 sbuf_putc(&sb, '\0');
5583 error = sbuf_finish(&sb);
5585 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5591 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5592 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5593 "system device tree");
5596 bus_data_generation_check(int generation)
5598 if (generation != bus_data_generation)
5601 /* XXX generate optimised lists here? */
5606 bus_data_generation_update(void)
5608 atomic_add_int(&bus_data_generation, 1);
5612 bus_free_resource(device_t dev, int type, struct resource *r)
5616 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5620 device_lookup_by_name(const char *name)
5624 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5625 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5632 * /dev/devctl2 implementation. The existing /dev/devctl device has
5633 * implicit semantics on open, so it could not be reused for this.
5634 * Another option would be to call this /dev/bus?
5637 find_device(struct devreq *req, device_t *devp)
5642 * First, ensure that the name is nul terminated.
5644 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5648 * Second, try to find an attached device whose name matches
5651 dev = device_lookup_by_name(req->dr_name);
5657 /* Finally, give device enumerators a chance. */
5659 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5667 driver_exists(device_t bus, const char *driver)
5671 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5672 if (devclass_find_driver_internal(dc, driver) != NULL)
5679 device_gen_nomatch(device_t dev)
5683 if (dev->flags & DF_NEEDNOMATCH &&
5684 dev->state == DS_NOTPRESENT) {
5685 BUS_PROBE_NOMATCH(dev->parent, dev);
5687 dev->flags |= DF_DONENOMATCH;
5689 dev->flags &= ~DF_NEEDNOMATCH;
5690 TAILQ_FOREACH(child, &dev->children, link) {
5691 device_gen_nomatch(child);
5696 device_do_deferred_actions(void)
5702 * Walk through the devclasses to find all the drivers we've tagged as
5703 * deferred during the freeze and call the driver added routines. They
5704 * have already been added to the lists in the background, so the driver
5705 * added routines that trigger a probe will have all the right bidders
5706 * for the probe auction.
5708 TAILQ_FOREACH(dc, &devclasses, link) {
5709 TAILQ_FOREACH(dl, &dc->drivers, link) {
5710 if (dl->flags & DL_DEFERRED_PROBE) {
5711 devclass_driver_added(dc, dl->driver);
5712 dl->flags &= ~DL_DEFERRED_PROBE;
5718 * We also defer no-match events during a freeze. Walk the tree and
5719 * generate all the pent-up events that are still relevant.
5721 device_gen_nomatch(root_bus);
5722 bus_data_generation_update();
5726 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5733 /* Locate the device to control. */
5735 req = (struct devreq *)data;
5743 case DEV_SET_DRIVER:
5744 case DEV_CLEAR_DRIVER:
5748 error = priv_check(td, PRIV_DRIVER);
5750 error = find_device(req, &dev);
5754 error = priv_check(td, PRIV_DRIVER);
5765 /* Perform the requested operation. */
5768 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5770 else if (!device_is_enabled(dev))
5773 error = device_probe_and_attach(dev);
5776 if (!device_is_attached(dev)) {
5780 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5781 error = device_quiesce(dev);
5785 error = device_detach(dev);
5788 if (device_is_enabled(dev)) {
5794 * If the device has been probed but not attached (e.g.
5795 * when it has been disabled by a loader hint), just
5796 * attach the device rather than doing a full probe.
5799 if (device_is_alive(dev)) {
5801 * If the device was disabled via a hint, clear
5804 if (resource_disabled(dev->driver->name, dev->unit))
5805 resource_unset_value(dev->driver->name,
5806 dev->unit, "disabled");
5807 error = device_attach(dev);
5809 error = device_probe_and_attach(dev);
5812 if (!device_is_enabled(dev)) {
5817 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5818 error = device_quiesce(dev);
5824 * Force DF_FIXEDCLASS on around detach to preserve
5825 * the existing name.
5828 dev->flags |= DF_FIXEDCLASS;
5829 error = device_detach(dev);
5830 if (!(old & DF_FIXEDCLASS))
5831 dev->flags &= ~DF_FIXEDCLASS;
5833 device_disable(dev);
5836 if (device_is_suspended(dev)) {
5840 if (device_get_parent(dev) == NULL) {
5844 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5847 if (!device_is_suspended(dev)) {
5851 if (device_get_parent(dev) == NULL) {
5855 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5857 case DEV_SET_DRIVER: {
5861 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5864 if (driver[0] == '\0') {
5868 if (dev->devclass != NULL &&
5869 strcmp(driver, dev->devclass->name) == 0)
5870 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5874 * Scan drivers for this device's bus looking for at
5875 * least one matching driver.
5877 if (dev->parent == NULL) {
5881 if (!driver_exists(dev->parent, driver)) {
5885 dc = devclass_create(driver);
5891 /* Detach device if necessary. */
5892 if (device_is_attached(dev)) {
5893 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5894 error = device_detach(dev);
5901 /* Clear any previously-fixed device class and unit. */
5902 if (dev->flags & DF_FIXEDCLASS)
5903 devclass_delete_device(dev->devclass, dev);
5904 dev->flags |= DF_WILDCARD;
5907 /* Force the new device class. */
5908 error = devclass_add_device(dc, dev);
5911 dev->flags |= DF_FIXEDCLASS;
5912 error = device_probe_and_attach(dev);
5915 case DEV_CLEAR_DRIVER:
5916 if (!(dev->flags & DF_FIXEDCLASS)) {
5920 if (device_is_attached(dev)) {
5921 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5922 error = device_detach(dev);
5929 dev->flags &= ~DF_FIXEDCLASS;
5930 dev->flags |= DF_WILDCARD;
5931 devclass_delete_device(dev->devclass, dev);
5932 error = device_probe_and_attach(dev);
5935 if (!device_is_attached(dev)) {
5939 error = BUS_RESCAN(dev);
5944 parent = device_get_parent(dev);
5945 if (parent == NULL) {
5949 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5950 if (bus_child_present(dev) != 0) {
5956 error = device_delete_child(parent, dev);
5963 device_frozen = true;
5969 device_do_deferred_actions();
5970 device_frozen = false;
5974 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5978 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5986 static struct cdevsw devctl2_cdevsw = {
5987 .d_version = D_VERSION,
5988 .d_ioctl = devctl2_ioctl,
5989 .d_name = "devctl2",
5995 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5996 UID_ROOT, GID_WHEEL, 0600, "devctl2");
6000 * APIs to manage deprecation and obsolescence.
6002 static int obsolete_panic = 0;
6003 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
6004 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
6005 "2 = if deprecated)");
6008 gone_panic(int major, int running, const char *msg)
6010 switch (obsolete_panic)
6015 if (running < major)
6024 _gone_in(int major, const char *msg)
6026 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6027 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6028 printf("Obsolete code will be removed soon: %s\n", msg);
6030 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
6035 _gone_in_dev(device_t dev, int major, const char *msg)
6037 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6038 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6040 "Obsolete code will be removed soon: %s\n", msg);
6043 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6048 DB_SHOW_COMMAND(device, db_show_device)
6055 dev = (device_t)addr;
6057 db_printf("name: %s\n", device_get_nameunit(dev));
6058 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6059 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6060 db_printf(" addr: %p\n", dev);
6061 db_printf(" parent: %p\n", dev->parent);
6062 db_printf(" softc: %p\n", dev->softc);
6063 db_printf(" ivars: %p\n", dev->ivars);
6066 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6070 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6071 db_show_device((db_expr_t)dev, true, count, modif);