2 * SPDX-License-Identifier: BSD-2-Clause
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>
33 #include <sys/param.h>
35 #include <sys/domainset.h>
36 #include <sys/eventhandler.h>
37 #include <sys/filio.h>
39 #include <sys/kernel.h>
41 #include <sys/limits.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/mutex.h>
48 #include <sys/condvar.h>
49 #include <sys/queue.h>
50 #include <machine/bus.h>
51 #include <sys/random.h>
54 #include <sys/selinfo.h>
55 #include <sys/signalvar.h>
57 #include <sys/sysctl.h>
58 #include <sys/systm.h>
61 #include <sys/cpuset.h>
65 #include <machine/cpu.h>
66 #include <machine/stdarg.h>
73 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
75 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
79 * Used to attach drivers to devclasses.
81 typedef struct driverlink *driverlink_t;
84 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
87 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
88 TAILQ_ENTRY(driverlink) passlink;
92 * Forward declarations
94 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
95 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
96 typedef TAILQ_HEAD(device_list, _device) device_list_t;
99 TAILQ_ENTRY(devclass) link;
100 devclass_t parent; /* parent in devclass hierarchy */
101 driver_list_t drivers; /* bus devclasses store drivers for bus */
103 device_t *devices; /* array of devices indexed by unit */
104 int maxunit; /* size of devices array */
106 #define DC_HAS_CHILDREN 1
108 struct sysctl_ctx_list sysctl_ctx;
109 struct sysctl_oid *sysctl_tree;
113 * @brief Implementation of _device.
115 * The structure is named "_device" instead of "device" to avoid type confusion
116 * caused by other subsystems defining a (struct device).
120 * A device is a kernel object. The first field must be the
121 * current ops table for the object.
128 TAILQ_ENTRY(_device) link; /**< list of devices in parent */
129 TAILQ_ENTRY(_device) devlink; /**< global device list membership */
130 device_t parent; /**< parent of this device */
131 device_list_t children; /**< list of child devices */
134 * Details of this device.
136 driver_t *driver; /**< current driver */
137 devclass_t devclass; /**< current device class */
138 int unit; /**< current unit number */
139 char* nameunit; /**< name+unit e.g. foodev0 */
140 char* desc; /**< driver specific description */
141 int busy; /**< count of calls to device_busy() */
142 device_state_t state; /**< current device state */
143 uint32_t devflags; /**< api level flags for device_get_flags() */
144 u_int flags; /**< internal device flags */
145 u_int order; /**< order from device_add_child_ordered() */
146 void *ivars; /**< instance variables */
147 void *softc; /**< current driver's variables */
149 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
150 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
153 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
154 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
156 EVENTHANDLER_LIST_DEFINE(device_attach);
157 EVENTHANDLER_LIST_DEFINE(device_detach);
158 EVENTHANDLER_LIST_DEFINE(dev_lookup);
160 static int bus_child_location_sb(device_t child, struct sbuf *sb);
161 static int bus_child_pnpinfo_sb(device_t child, struct sbuf *sb);
162 static void devctl2_init(void);
163 static bool device_frozen;
165 #define DRIVERNAME(d) ((d)? d->name : "no driver")
166 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
170 static int bus_debug = 1;
171 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
173 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
174 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
177 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
178 * prevent syslog from deleting initial spaces
180 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
182 static void print_device_short(device_t dev, int indent);
183 static void print_device(device_t dev, int indent);
184 void print_device_tree_short(device_t dev, int indent);
185 void print_device_tree(device_t dev, int indent);
186 static void print_driver_short(driver_t *driver, int indent);
187 static void print_driver(driver_t *driver, int indent);
188 static void print_driver_list(driver_list_t drivers, int indent);
189 static void print_devclass_short(devclass_t dc, int indent);
190 static void print_devclass(devclass_t dc, int indent);
191 void print_devclass_list_short(void);
192 void print_devclass_list(void);
195 /* Make the compiler ignore the function calls */
196 #define PDEBUG(a) /* nop */
197 #define DEVICENAME(d) /* nop */
199 #define print_device_short(d,i) /* nop */
200 #define print_device(d,i) /* nop */
201 #define print_device_tree_short(d,i) /* nop */
202 #define print_device_tree(d,i) /* nop */
203 #define print_driver_short(d,i) /* nop */
204 #define print_driver(d,i) /* nop */
205 #define print_driver_list(d,i) /* nop */
206 #define print_devclass_short(d,i) /* nop */
207 #define print_devclass(d,i) /* nop */
208 #define print_devclass_list_short() /* nop */
209 #define print_devclass_list() /* nop */
217 DEVCLASS_SYSCTL_PARENT,
221 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
223 devclass_t dc = (devclass_t)arg1;
227 case DEVCLASS_SYSCTL_PARENT:
228 value = dc->parent ? dc->parent->name : "";
233 return (SYSCTL_OUT_STR(req, value));
237 devclass_sysctl_init(devclass_t dc)
239 if (dc->sysctl_tree != NULL)
241 sysctl_ctx_init(&dc->sysctl_ctx);
242 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
243 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
244 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
245 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
247 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
248 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
254 DEVICE_SYSCTL_DRIVER,
255 DEVICE_SYSCTL_LOCATION,
256 DEVICE_SYSCTL_PNPINFO,
257 DEVICE_SYSCTL_PARENT,
261 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
264 device_t dev = (device_t)arg1;
267 sbuf_new_for_sysctl(&sb, NULL, 1024, req);
268 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
270 case DEVICE_SYSCTL_DESC:
271 sbuf_cat(&sb, dev->desc ? dev->desc : "");
273 case DEVICE_SYSCTL_DRIVER:
274 sbuf_cat(&sb, dev->driver ? dev->driver->name : "");
276 case DEVICE_SYSCTL_LOCATION:
277 bus_child_location_sb(dev, &sb);
279 case DEVICE_SYSCTL_PNPINFO:
280 bus_child_pnpinfo_sb(dev, &sb);
282 case DEVICE_SYSCTL_PARENT:
283 sbuf_cat(&sb, dev->parent ? dev->parent->nameunit : "");
289 error = sbuf_finish(&sb);
295 device_sysctl_init(device_t dev)
297 devclass_t dc = dev->devclass;
300 if (dev->sysctl_tree != NULL)
302 devclass_sysctl_init(dc);
303 sysctl_ctx_init(&dev->sysctl_ctx);
304 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
305 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
306 dev->nameunit + strlen(dc->name),
307 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
308 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
309 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
310 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
311 "device description");
312 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
314 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
315 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
316 "device driver name");
317 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 OID_AUTO, "%location",
319 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
320 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
321 "device location relative to parent");
322 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
323 OID_AUTO, "%pnpinfo",
324 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
325 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
326 "device identification");
327 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
329 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
330 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
332 if (bus_get_domain(dev, &domain) == 0)
333 SYSCTL_ADD_INT(&dev->sysctl_ctx,
334 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
335 CTLFLAG_RD, NULL, domain, "NUMA domain");
339 device_sysctl_update(device_t dev)
341 devclass_t dc = dev->devclass;
343 if (dev->sysctl_tree == NULL)
345 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
349 device_sysctl_fini(device_t dev)
351 if (dev->sysctl_tree == NULL)
353 sysctl_ctx_free(&dev->sysctl_ctx);
354 dev->sysctl_tree = NULL;
358 * /dev/devctl implementation
362 * This design allows only one reader for /dev/devctl. This is not desirable
363 * in the long run, but will get a lot of hair out of this implementation.
364 * Maybe we should make this device a clonable device.
366 * Also note: we specifically do not attach a device to the device_t tree
367 * to avoid potential chicken and egg problems. One could argue that all
368 * of this belongs to the root node.
371 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
372 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
373 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
374 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
375 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
377 static d_open_t devopen;
378 static d_close_t devclose;
379 static d_read_t devread;
380 static d_ioctl_t devioctl;
381 static d_poll_t devpoll;
382 static d_kqfilter_t devkqfilter;
384 static struct cdevsw dev_cdevsw = {
385 .d_version = D_VERSION,
391 .d_kqfilter = devkqfilter,
395 #define DEVCTL_BUFFER (1024 - sizeof(void *))
396 struct dev_event_info {
397 STAILQ_ENTRY(dev_event_info) dei_link;
398 char dei_data[DEVCTL_BUFFER];
401 STAILQ_HEAD(devq, dev_event_info);
403 static struct dev_softc {
416 static void filt_devctl_detach(struct knote *kn);
417 static int filt_devctl_read(struct knote *kn, long hint);
419 struct filterops devctl_rfiltops = {
421 .f_detach = filt_devctl_detach,
422 .f_event = filt_devctl_read,
425 static struct cdev *devctl_dev;
433 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
434 UID_ROOT, GID_WHEEL, 0600, "devctl");
435 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
436 cv_init(&devsoftc.cv, "dev cv");
437 STAILQ_INIT(&devsoftc.devq);
438 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
439 if (devctl_queue_length > 0) {
441 * Allocate a zone for the messages. Preallocate 2% of these for
442 * a reserve. Allow only devctl_queue_length slabs to cap memory
443 * usage. The reserve usually allows coverage of surges of
444 * events during memory shortages. Normally we won't have to
445 * re-use events from the queue, but will in extreme shortages.
447 z = devsoftc.zone = uma_zcreate("DEVCTL",
448 sizeof(struct dev_event_info), NULL, NULL, NULL, NULL,
450 reserve = max(devctl_queue_length / 50, 100); /* 2% reserve */
451 uma_zone_set_max(z, devctl_queue_length);
452 uma_zone_set_maxcache(z, 0);
453 uma_zone_reserve(z, reserve);
454 uma_prealloc(z, reserve);
460 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
462 mtx_lock(&devsoftc.mtx);
463 if (devsoftc.inuse) {
464 mtx_unlock(&devsoftc.mtx);
469 mtx_unlock(&devsoftc.mtx);
474 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
476 mtx_lock(&devsoftc.mtx);
478 devsoftc.nonblock = 0;
480 cv_broadcast(&devsoftc.cv);
481 funsetown(&devsoftc.sigio);
482 mtx_unlock(&devsoftc.mtx);
487 * The read channel for this device is used to report changes to
488 * userland in realtime. We are required to free the data as well as
489 * the n1 object because we allocate them separately. Also note that
490 * we return one record at a time. If you try to read this device a
491 * character at a time, you will lose the rest of the data. Listening
492 * programs are expected to cope.
495 devread(struct cdev *dev, struct uio *uio, int ioflag)
497 struct dev_event_info *n1;
500 mtx_lock(&devsoftc.mtx);
501 while (STAILQ_EMPTY(&devsoftc.devq)) {
502 if (devsoftc.nonblock) {
503 mtx_unlock(&devsoftc.mtx);
506 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
509 * Need to translate ERESTART to EINTR here? -- jake
511 mtx_unlock(&devsoftc.mtx);
515 n1 = STAILQ_FIRST(&devsoftc.devq);
516 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
518 mtx_unlock(&devsoftc.mtx);
519 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
520 uma_zfree(devsoftc.zone, n1);
525 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
530 devsoftc.nonblock = 1;
532 devsoftc.nonblock = 0;
541 return fsetown(*(int *)data, &devsoftc.sigio);
543 *(int *)data = fgetown(&devsoftc.sigio);
546 /* (un)Support for other fcntl() calls. */
557 devpoll(struct cdev *dev, int events, struct thread *td)
561 mtx_lock(&devsoftc.mtx);
562 if (events & (POLLIN | POLLRDNORM)) {
563 if (!STAILQ_EMPTY(&devsoftc.devq))
564 revents = events & (POLLIN | POLLRDNORM);
566 selrecord(td, &devsoftc.sel);
568 mtx_unlock(&devsoftc.mtx);
574 devkqfilter(struct cdev *dev, struct knote *kn)
578 if (kn->kn_filter == EVFILT_READ) {
579 kn->kn_fop = &devctl_rfiltops;
580 knlist_add(&devsoftc.sel.si_note, kn, 0);
588 filt_devctl_detach(struct knote *kn)
590 knlist_remove(&devsoftc.sel.si_note, kn, 0);
594 filt_devctl_read(struct knote *kn, long hint)
596 kn->kn_data = devsoftc.queued;
597 return (kn->kn_data != 0);
601 * @brief Return whether the userland process is running
604 devctl_process_running(void)
606 return (devsoftc.inuse == 1);
609 static struct dev_event_info *
610 devctl_alloc_dei(void)
612 struct dev_event_info *dei = NULL;
614 mtx_lock(&devsoftc.mtx);
615 if (devctl_queue_length == 0)
617 dei = uma_zalloc(devsoftc.zone, M_NOWAIT);
619 dei = uma_zalloc(devsoftc.zone, M_NOWAIT | M_USE_RESERVE);
622 * Guard against no items in the queue. Normally, this won't
623 * happen, but if lots of events happen all at once and there's
624 * a chance we're out of allocated space but none have yet been
625 * queued when we get here, leaving nothing to steal. This can
626 * also happen with error injection. Fail safe by returning
627 * NULL in that case..
629 if (devsoftc.queued == 0)
631 dei = STAILQ_FIRST(&devsoftc.devq);
632 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
636 *dei->dei_data = '\0';
638 mtx_unlock(&devsoftc.mtx);
642 static struct dev_event_info *
643 devctl_alloc_dei_sb(struct sbuf *sb)
645 struct dev_event_info *dei;
647 dei = devctl_alloc_dei();
649 sbuf_new(sb, dei->dei_data, sizeof(dei->dei_data), SBUF_FIXEDLEN);
654 devctl_free_dei(struct dev_event_info *dei)
656 uma_zfree(devsoftc.zone, dei);
660 devctl_queue(struct dev_event_info *dei)
662 mtx_lock(&devsoftc.mtx);
663 STAILQ_INSERT_TAIL(&devsoftc.devq, dei, dei_link);
665 cv_broadcast(&devsoftc.cv);
666 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
667 mtx_unlock(&devsoftc.mtx);
668 selwakeup(&devsoftc.sel);
669 if (devsoftc.async && devsoftc.sigio != NULL)
670 pgsigio(&devsoftc.sigio, SIGIO, 0);
674 * @brief Send a 'notification' to userland, using standard ways
677 devctl_notify(const char *system, const char *subsystem, const char *type,
680 struct dev_event_info *dei;
683 if (system == NULL || subsystem == NULL || type == NULL)
685 dei = devctl_alloc_dei_sb(&sb);
688 sbuf_cpy(&sb, "!system=");
689 sbuf_cat(&sb, system);
690 sbuf_cat(&sb, " subsystem=");
691 sbuf_cat(&sb, subsystem);
692 sbuf_cat(&sb, " type=");
698 sbuf_putc(&sb, '\n');
699 if (sbuf_finish(&sb) != 0)
700 devctl_free_dei(dei); /* overflow -> drop it */
706 * Common routine that tries to make sending messages as easy as possible.
707 * We allocate memory for the data, copy strings into that, but do not
708 * free it unless there's an error. The dequeue part of the driver should
709 * free the data. We don't send data when the device is disabled. We do
710 * send data, even when we have no listeners, because we wish to avoid
711 * races relating to startup and restart of listening applications.
713 * devaddq is designed to string together the type of event, with the
714 * object of that event, plus the plug and play info and location info
715 * for that event. This is likely most useful for devices, but less
716 * useful for other consumers of this interface. Those should use
717 * the devctl_notify() interface instead.
720 * ${type}${what} at $(location dev) $(pnp-info dev) on $(parent dev)
723 devaddq(const char *type, const char *what, device_t dev)
725 struct dev_event_info *dei;
729 dei = devctl_alloc_dei_sb(&sb);
734 sbuf_cat(&sb, " at ");
736 /* Add in the location */
737 bus_child_location_sb(dev, &sb);
741 bus_child_pnpinfo_sb(dev, &sb);
743 /* Get the parent of this device, or / if high enough in the tree. */
744 if (device_get_parent(dev) == NULL)
745 parstr = "."; /* Or '/' ? */
747 parstr = device_get_nameunit(device_get_parent(dev));
748 sbuf_cat(&sb, " on ");
749 sbuf_cat(&sb, parstr);
750 sbuf_putc(&sb, '\n');
751 if (sbuf_finish(&sb) != 0)
756 devctl_free_dei(dei);
760 * A device was added to the tree. We are called just after it successfully
761 * attaches (that is, probe and attach success for this device). No call
762 * is made if a device is merely parented into the tree. See devnomatch
763 * if probe fails. If attach fails, no notification is sent (but maybe
764 * we should have a different message for this).
767 devadded(device_t dev)
769 devaddq("+", device_get_nameunit(dev), dev);
773 * A device was removed from the tree. We are called just before this
777 devremoved(device_t dev)
779 devaddq("-", device_get_nameunit(dev), dev);
783 * Called when there's no match for this device. This is only called
784 * the first time that no match happens, so we don't keep getting this
785 * message. Should that prove to be undesirable, we can change it.
786 * This is called when all drivers that can attach to a given bus
787 * decline to accept this device. Other errors may not be detected.
790 devnomatch(device_t dev)
792 devaddq("?", "", dev);
796 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
800 q = devctl_queue_length;
801 error = sysctl_handle_int(oidp, &q, 0, req);
802 if (error || !req->newptr)
808 * When set as a tunable, we've not yet initialized the mutex.
809 * It is safe to just assign to devctl_queue_length and return
810 * as we're racing no one. We'll use whatever value set in
813 if (!mtx_initialized(&devsoftc.mtx)) {
814 devctl_queue_length = q;
819 * XXX It's hard to grow or shrink the UMA zone. Only allow
820 * disabling the queue size for the moment until underlying
821 * UMA issues can be sorted out.
825 if (q == devctl_queue_length)
827 mtx_lock(&devsoftc.mtx);
828 devctl_queue_length = 0;
829 uma_zdestroy(devsoftc.zone);
831 mtx_unlock(&devsoftc.mtx);
836 * @brief safely quotes strings that might have double quotes in them.
838 * The devctl protocol relies on quoted strings having matching quotes.
839 * This routine quotes any internal quotes so the resulting string
840 * is safe to pass to snprintf to construct, for example pnp info strings.
842 * @param sb sbuf to place the characters into
843 * @param src Original buffer.
846 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
848 while (*src != '\0') {
849 if (*src == '"' || *src == '\\')
851 sbuf_putc(sb, *src++);
855 /* End of /dev/devctl code */
857 static struct device_list bus_data_devices;
858 static int bus_data_generation = 1;
860 static kobj_method_t null_methods[] = {
864 DEFINE_CLASS(null, null_methods, 0);
877 mtx_lock(bus_topo_mtx());
881 bus_topo_unlock(void)
884 mtx_unlock(bus_topo_mtx());
888 * Bus pass implementation
891 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
892 int bus_current_pass = BUS_PASS_ROOT;
896 * @brief Register the pass level of a new driver attachment
898 * Register a new driver attachment's pass level. If no driver
899 * attachment with the same pass level has been added, then @p new
900 * will be added to the global passes list.
902 * @param new the new driver attachment
905 driver_register_pass(struct driverlink *new)
907 struct driverlink *dl;
909 /* We only consider pass numbers during boot. */
910 if (bus_current_pass == BUS_PASS_DEFAULT)
914 * Walk the passes list. If we already know about this pass
915 * then there is nothing to do. If we don't, then insert this
916 * driver link into the list.
918 TAILQ_FOREACH(dl, &passes, passlink) {
919 if (dl->pass < new->pass)
921 if (dl->pass == new->pass)
923 TAILQ_INSERT_BEFORE(dl, new, passlink);
926 TAILQ_INSERT_TAIL(&passes, new, passlink);
930 * @brief Raise the current bus pass
932 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
933 * method on the root bus to kick off a new device tree scan for each
934 * new pass level that has at least one driver.
937 bus_set_pass(int pass)
939 struct driverlink *dl;
941 if (bus_current_pass > pass)
942 panic("Attempt to lower bus pass level");
944 TAILQ_FOREACH(dl, &passes, passlink) {
945 /* Skip pass values below the current pass level. */
946 if (dl->pass <= bus_current_pass)
950 * Bail once we hit a driver with a pass level that is
957 * Raise the pass level to the next level and rescan
960 bus_current_pass = dl->pass;
961 BUS_NEW_PASS(root_bus);
965 * If there isn't a driver registered for the requested pass,
966 * then bus_current_pass might still be less than 'pass'. Set
967 * it to 'pass' in that case.
969 if (bus_current_pass < pass)
970 bus_current_pass = pass;
971 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
975 * Devclass implementation
978 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
982 * @brief Find or create a device class
984 * If a device class with the name @p classname exists, return it,
985 * otherwise if @p create is non-zero create and return a new device
988 * If @p parentname is non-NULL, the parent of the devclass is set to
989 * the devclass of that name.
991 * @param classname the devclass name to find or create
992 * @param parentname the parent devclass name or @c NULL
993 * @param create non-zero to create a devclass
996 devclass_find_internal(const char *classname, const char *parentname,
1001 PDEBUG(("looking for %s", classname));
1005 TAILQ_FOREACH(dc, &devclasses, link) {
1006 if (!strcmp(dc->name, classname))
1010 if (create && !dc) {
1011 PDEBUG(("creating %s", classname));
1012 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1013 M_BUS, M_NOWAIT | M_ZERO);
1017 dc->name = (char*) (dc + 1);
1018 strcpy(dc->name, classname);
1019 TAILQ_INIT(&dc->drivers);
1020 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1022 bus_data_generation_update();
1026 * If a parent class is specified, then set that as our parent so
1027 * that this devclass will support drivers for the parent class as
1028 * well. If the parent class has the same name don't do this though
1029 * as it creates a cycle that can trigger an infinite loop in
1030 * device_probe_child() if a device exists for which there is no
1033 if (parentname && dc && !dc->parent &&
1034 strcmp(classname, parentname) != 0) {
1035 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1036 dc->parent->flags |= DC_HAS_CHILDREN;
1043 * @brief Create a device class
1045 * If a device class with the name @p classname exists, return it,
1046 * otherwise create and return a new device class.
1048 * @param classname the devclass name to find or create
1051 devclass_create(const char *classname)
1053 return (devclass_find_internal(classname, NULL, TRUE));
1057 * @brief Find a device class
1059 * If a device class with the name @p classname exists, return it,
1060 * otherwise return @c NULL.
1062 * @param classname the devclass name to find
1065 devclass_find(const char *classname)
1067 return (devclass_find_internal(classname, NULL, FALSE));
1071 * @brief Register that a device driver has been added to a devclass
1073 * Register that a device driver has been added to a devclass. This
1074 * is called by devclass_add_driver to accomplish the recursive
1075 * notification of all the children classes of dc, as well as dc.
1076 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1079 * We do a full search here of the devclass list at each iteration
1080 * level to save storing children-lists in the devclass structure. If
1081 * we ever move beyond a few dozen devices doing this, we may need to
1084 * @param dc the devclass to edit
1085 * @param driver the driver that was just added
1088 devclass_driver_added(devclass_t dc, driver_t *driver)
1094 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1096 for (i = 0; i < dc->maxunit; i++)
1097 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1098 BUS_DRIVER_ADDED(dc->devices[i], driver);
1101 * Walk through the children classes. Since we only keep a
1102 * single parent pointer around, we walk the entire list of
1103 * devclasses looking for children. We set the
1104 * DC_HAS_CHILDREN flag when a child devclass is created on
1105 * the parent, so we only walk the list for those devclasses
1106 * that have children.
1108 if (!(dc->flags & DC_HAS_CHILDREN))
1111 TAILQ_FOREACH(dc, &devclasses, link) {
1112 if (dc->parent == parent)
1113 devclass_driver_added(dc, driver);
1118 * @brief Add a device driver to a device class
1120 * Add a device driver to a devclass. This is normally called
1121 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1122 * all devices in the devclass will be called to allow them to attempt
1123 * to re-probe any unmatched children.
1125 * @param dc the devclass to edit
1126 * @param driver the driver to register
1129 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1132 devclass_t child_dc;
1133 const char *parentname;
1135 PDEBUG(("%s", DRIVERNAME(driver)));
1137 /* Don't allow invalid pass values. */
1138 if (pass <= BUS_PASS_ROOT)
1141 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1146 * Compile the driver's methods. Also increase the reference count
1147 * so that the class doesn't get freed when the last instance
1148 * goes. This means we can safely use static methods and avoids a
1149 * double-free in devclass_delete_driver.
1151 kobj_class_compile((kobj_class_t) driver);
1154 * If the driver has any base classes, make the
1155 * devclass inherit from the devclass of the driver's
1156 * first base class. This will allow the system to
1157 * search for drivers in both devclasses for children
1158 * of a device using this driver.
1160 if (driver->baseclasses)
1161 parentname = driver->baseclasses[0]->name;
1164 child_dc = devclass_find_internal(driver->name, parentname, TRUE);
1168 dl->driver = driver;
1169 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1170 driver->refs++; /* XXX: kobj_mtx */
1172 driver_register_pass(dl);
1174 if (device_frozen) {
1175 dl->flags |= DL_DEFERRED_PROBE;
1177 devclass_driver_added(dc, driver);
1179 bus_data_generation_update();
1184 * @brief Register that a device driver has been deleted from a devclass
1186 * Register that a device driver has been removed from a devclass.
1187 * This is called by devclass_delete_driver to accomplish the
1188 * recursive notification of all the children classes of busclass, as
1189 * well as busclass. Each layer will attempt to detach the driver
1190 * from any devices that are children of the bus's devclass. The function
1191 * will return an error if a device fails to detach.
1193 * We do a full search here of the devclass list at each iteration
1194 * level to save storing children-lists in the devclass structure. If
1195 * we ever move beyond a few dozen devices doing this, we may need to
1198 * @param busclass the devclass of the parent bus
1199 * @param dc the devclass of the driver being deleted
1200 * @param driver the driver being deleted
1203 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1210 * Disassociate from any devices. We iterate through all the
1211 * devices in the devclass of the driver and detach any which are
1212 * using the driver and which have a parent in the devclass which
1213 * we are deleting from.
1215 * Note that since a driver can be in multiple devclasses, we
1216 * should not detach devices which are not children of devices in
1217 * the affected devclass.
1219 * If we're frozen, we don't generate NOMATCH events. Mark to
1222 for (i = 0; i < dc->maxunit; i++) {
1223 if (dc->devices[i]) {
1224 dev = dc->devices[i];
1225 if (dev->driver == driver && dev->parent &&
1226 dev->parent->devclass == busclass) {
1227 if ((error = device_detach(dev)) != 0)
1229 if (device_frozen) {
1230 dev->flags &= ~DF_DONENOMATCH;
1231 dev->flags |= DF_NEEDNOMATCH;
1233 BUS_PROBE_NOMATCH(dev->parent, dev);
1235 dev->flags |= DF_DONENOMATCH;
1242 * Walk through the children classes. Since we only keep a
1243 * single parent pointer around, we walk the entire list of
1244 * devclasses looking for children. We set the
1245 * DC_HAS_CHILDREN flag when a child devclass is created on
1246 * the parent, so we only walk the list for those devclasses
1247 * that have children.
1249 if (!(busclass->flags & DC_HAS_CHILDREN))
1252 TAILQ_FOREACH(busclass, &devclasses, link) {
1253 if (busclass->parent == parent) {
1254 error = devclass_driver_deleted(busclass, dc, driver);
1263 * @brief Delete a device driver from a device class
1265 * Delete a device driver from a devclass. This is normally called
1266 * automatically by DRIVER_MODULE().
1268 * If the driver is currently attached to any devices,
1269 * devclass_delete_driver() will first attempt to detach from each
1270 * device. If one of the detach calls fails, the driver will not be
1273 * @param dc the devclass to edit
1274 * @param driver the driver to unregister
1277 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1279 devclass_t dc = devclass_find(driver->name);
1283 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1289 * Find the link structure in the bus' list of drivers.
1291 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1292 if (dl->driver == driver)
1297 PDEBUG(("%s not found in %s list", driver->name,
1302 error = devclass_driver_deleted(busclass, dc, driver);
1306 TAILQ_REMOVE(&busclass->drivers, dl, link);
1311 if (driver->refs == 0)
1312 kobj_class_free((kobj_class_t) driver);
1314 bus_data_generation_update();
1319 * @brief Quiesces a set of device drivers from a device class
1321 * Quiesce a device driver from a devclass. This is normally called
1322 * automatically by DRIVER_MODULE().
1324 * If the driver is currently attached to any devices,
1325 * devclass_quiesece_driver() will first attempt to quiesce each
1328 * @param dc the devclass to edit
1329 * @param driver the driver to unregister
1332 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1334 devclass_t dc = devclass_find(driver->name);
1340 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1346 * Find the link structure in the bus' list of drivers.
1348 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1349 if (dl->driver == driver)
1354 PDEBUG(("%s not found in %s list", driver->name,
1360 * Quiesce all devices. We iterate through all the devices in
1361 * the devclass of the driver and quiesce any which are using
1362 * the driver and which have a parent in the devclass which we
1365 * Note that since a driver can be in multiple devclasses, we
1366 * should not quiesce devices which are not children of
1367 * devices in the affected devclass.
1369 for (i = 0; i < dc->maxunit; i++) {
1370 if (dc->devices[i]) {
1371 dev = dc->devices[i];
1372 if (dev->driver == driver && dev->parent &&
1373 dev->parent->devclass == busclass) {
1374 if ((error = device_quiesce(dev)) != 0)
1387 devclass_find_driver_internal(devclass_t dc, const char *classname)
1391 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1393 TAILQ_FOREACH(dl, &dc->drivers, link) {
1394 if (!strcmp(dl->driver->name, classname))
1398 PDEBUG(("not found"));
1403 * @brief Return the name of the devclass
1406 devclass_get_name(devclass_t dc)
1412 * @brief Find a device given a unit number
1414 * @param dc the devclass to search
1415 * @param unit the unit number to search for
1417 * @returns the device with the given unit number or @c
1418 * NULL if there is no such device
1421 devclass_get_device(devclass_t dc, int unit)
1423 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1425 return (dc->devices[unit]);
1429 * @brief Find the softc field of a device given a unit number
1431 * @param dc the devclass to search
1432 * @param unit the unit number to search for
1434 * @returns the softc field of the device with the given
1435 * unit number or @c NULL if there is no such
1439 devclass_get_softc(devclass_t dc, int unit)
1443 dev = devclass_get_device(dc, unit);
1447 return (device_get_softc(dev));
1451 * @brief Get a list of devices in the devclass
1453 * An array containing a list of all the devices in the given devclass
1454 * is allocated and returned in @p *devlistp. The number of devices
1455 * in the array is returned in @p *devcountp. The caller should free
1456 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1458 * @param dc the devclass to examine
1459 * @param devlistp points at location for array pointer return
1461 * @param devcountp points at location for array size return value
1464 * @retval ENOMEM the array allocation failed
1467 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1472 count = devclass_get_count(dc);
1473 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1478 for (i = 0; i < dc->maxunit; i++) {
1479 if (dc->devices[i]) {
1480 list[count] = dc->devices[i];
1492 * @brief Get a list of drivers in the devclass
1494 * An array containing a list of pointers to all the drivers in the
1495 * given devclass is allocated and returned in @p *listp. The number
1496 * of drivers in the array is returned in @p *countp. The caller should
1497 * free the array using @c free(p, M_TEMP).
1499 * @param dc the devclass to examine
1500 * @param listp gives location for array pointer return value
1501 * @param countp gives location for number of array elements
1505 * @retval ENOMEM the array allocation failed
1508 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1515 TAILQ_FOREACH(dl, &dc->drivers, link)
1517 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1522 TAILQ_FOREACH(dl, &dc->drivers, link) {
1523 list[count] = dl->driver;
1533 * @brief Get the number of devices in a devclass
1535 * @param dc the devclass to examine
1538 devclass_get_count(devclass_t dc)
1543 for (i = 0; i < dc->maxunit; i++)
1550 * @brief Get the maximum unit number used in a devclass
1552 * Note that this is one greater than the highest currently-allocated
1553 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1554 * that not even the devclass has been allocated yet.
1556 * @param dc the devclass to examine
1559 devclass_get_maxunit(devclass_t dc)
1563 return (dc->maxunit);
1567 * @brief Find a free unit number in a devclass
1569 * This function searches for the first unused unit number greater
1570 * that or equal to @p unit.
1572 * @param dc the devclass to examine
1573 * @param unit the first unit number to check
1576 devclass_find_free_unit(devclass_t dc, int unit)
1580 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1586 * @brief Set the parent of a devclass
1588 * The parent class is normally initialised automatically by
1591 * @param dc the devclass to edit
1592 * @param pdc the new parent devclass
1595 devclass_set_parent(devclass_t dc, devclass_t pdc)
1601 * @brief Get the parent of a devclass
1603 * @param dc the devclass to examine
1606 devclass_get_parent(devclass_t dc)
1608 return (dc->parent);
1611 struct sysctl_ctx_list *
1612 devclass_get_sysctl_ctx(devclass_t dc)
1614 return (&dc->sysctl_ctx);
1618 devclass_get_sysctl_tree(devclass_t dc)
1620 return (dc->sysctl_tree);
1625 * @brief Allocate a unit number
1627 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1628 * will do). The allocated unit number is returned in @p *unitp.
1630 * @param dc the devclass to allocate from
1631 * @param unitp points at the location for the allocated unit
1635 * @retval EEXIST the requested unit number is already allocated
1636 * @retval ENOMEM memory allocation failure
1639 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1644 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1646 /* Ask the parent bus if it wants to wire this device. */
1648 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1651 /* If we were given a wired unit number, check for existing device */
1654 if (unit >= 0 && unit < dc->maxunit &&
1655 dc->devices[unit] != NULL) {
1657 printf("%s: %s%d already exists; skipping it\n",
1658 dc->name, dc->name, *unitp);
1662 /* Unwired device, find the next available slot for it */
1664 for (unit = 0;; unit++) {
1665 /* If this device slot is already in use, skip it. */
1666 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1669 /* If there is an "at" hint for a unit then skip it. */
1670 if (resource_string_value(dc->name, unit, "at", &s) ==
1679 * We've selected a unit beyond the length of the table, so let's
1680 * extend the table to make room for all units up to and including
1683 if (unit >= dc->maxunit) {
1684 device_t *newlist, *oldlist;
1687 oldlist = dc->devices;
1688 newsize = roundup((unit + 1),
1689 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1690 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1693 if (oldlist != NULL)
1694 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1695 bzero(newlist + dc->maxunit,
1696 sizeof(device_t) * (newsize - dc->maxunit));
1697 dc->devices = newlist;
1698 dc->maxunit = newsize;
1699 if (oldlist != NULL)
1700 free(oldlist, M_BUS);
1702 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1710 * @brief Add a device to a devclass
1712 * A unit number is allocated for the device (using the device's
1713 * preferred unit number if any) and the device is registered in the
1714 * devclass. This allows the device to be looked up by its unit
1715 * number, e.g. by decoding a dev_t minor number.
1717 * @param dc the devclass to add to
1718 * @param dev the device to add
1721 * @retval EEXIST the requested unit number is already allocated
1722 * @retval ENOMEM memory allocation failure
1725 devclass_add_device(devclass_t dc, device_t dev)
1729 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1731 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1734 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1738 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1739 free(dev->nameunit, M_BUS);
1740 dev->nameunit = NULL;
1743 dc->devices[dev->unit] = dev;
1745 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1752 * @brief Delete a device from a devclass
1754 * The device is removed from the devclass's device list and its unit
1757 * @param dc the devclass to delete from
1758 * @param dev the device to delete
1763 devclass_delete_device(devclass_t dc, device_t dev)
1768 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1770 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1771 panic("devclass_delete_device: inconsistent device class");
1772 dc->devices[dev->unit] = NULL;
1773 if (dev->flags & DF_WILDCARD)
1775 dev->devclass = NULL;
1776 free(dev->nameunit, M_BUS);
1777 dev->nameunit = NULL;
1784 * @brief Make a new device and add it as a child of @p parent
1786 * @param parent the parent of the new device
1787 * @param name the devclass name of the new device or @c NULL
1788 * to leave the devclass unspecified
1789 * @parem unit the unit number of the new device of @c -1 to
1790 * leave the unit number unspecified
1792 * @returns the new device
1795 make_device(device_t parent, const char *name, int unit)
1800 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1803 dc = devclass_find_internal(name, NULL, TRUE);
1805 printf("make_device: can't find device class %s\n",
1813 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1817 dev->parent = parent;
1818 TAILQ_INIT(&dev->children);
1819 kobj_init((kobj_t) dev, &null_class);
1821 dev->devclass = NULL;
1823 dev->nameunit = NULL;
1827 dev->flags = DF_ENABLED;
1830 dev->flags |= DF_WILDCARD;
1832 dev->flags |= DF_FIXEDCLASS;
1833 if (devclass_add_device(dc, dev)) {
1834 kobj_delete((kobj_t) dev, M_BUS);
1838 if (parent != NULL && device_has_quiet_children(parent))
1839 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1843 dev->state = DS_NOTPRESENT;
1845 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1846 bus_data_generation_update();
1853 * @brief Print a description of a device.
1856 device_print_child(device_t dev, device_t child)
1860 if (device_is_alive(child))
1861 retval += BUS_PRINT_CHILD(dev, child);
1863 retval += device_printf(child, " not found\n");
1869 * @brief Create a new device
1871 * This creates a new device and adds it as a child of an existing
1872 * parent device. The new device will be added after the last existing
1873 * child with order zero.
1875 * @param dev the device which will be the parent of the
1877 * @param name devclass name for new device or @c NULL if not
1879 * @param unit unit number for new device or @c -1 if not
1882 * @returns the new device
1885 device_add_child(device_t dev, const char *name, int unit)
1887 return (device_add_child_ordered(dev, 0, name, unit));
1891 * @brief Create a new device
1893 * This creates a new device and adds it as a child of an existing
1894 * parent device. The new device will be added after the last existing
1895 * child with the same order.
1897 * @param dev the device which will be the parent of the
1899 * @param order a value which is used to partially sort the
1900 * children of @p dev - devices created using
1901 * lower values of @p order appear first in @p
1902 * dev's list of children
1903 * @param name devclass name for new device or @c NULL if not
1905 * @param unit unit number for new device or @c -1 if not
1908 * @returns the new device
1911 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1916 PDEBUG(("%s at %s with order %u as unit %d",
1917 name, DEVICENAME(dev), order, unit));
1918 KASSERT(name != NULL || unit == -1,
1919 ("child device with wildcard name and specific unit number"));
1921 child = make_device(dev, name, unit);
1924 child->order = order;
1926 TAILQ_FOREACH(place, &dev->children, link) {
1927 if (place->order > order)
1933 * The device 'place' is the first device whose order is
1934 * greater than the new child.
1936 TAILQ_INSERT_BEFORE(place, child, link);
1939 * The new child's order is greater or equal to the order of
1940 * any existing device. Add the child to the tail of the list.
1942 TAILQ_INSERT_TAIL(&dev->children, child, link);
1945 bus_data_generation_update();
1950 * @brief Delete a device
1952 * This function deletes a device along with all of its children. If
1953 * the device currently has a driver attached to it, the device is
1954 * detached first using device_detach().
1956 * @param dev the parent device
1957 * @param child the device to delete
1960 * @retval non-zero a unit error code describing the error
1963 device_delete_child(device_t dev, device_t child)
1966 device_t grandchild;
1968 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1970 /* detach parent before deleting children, if any */
1971 if ((error = device_detach(child)) != 0)
1974 /* remove children second */
1975 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1976 error = device_delete_child(child, grandchild);
1981 if (child->devclass)
1982 devclass_delete_device(child->devclass, child);
1984 BUS_CHILD_DELETED(dev, child);
1985 TAILQ_REMOVE(&dev->children, child, link);
1986 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1987 kobj_delete((kobj_t) child, M_BUS);
1989 bus_data_generation_update();
1994 * @brief Delete all children devices of the given device, if any.
1996 * This function deletes all children devices of the given device, if
1997 * any, using the device_delete_child() function for each device it
1998 * finds. If a child device cannot be deleted, this function will
1999 * return an error code.
2001 * @param dev the parent device
2004 * @retval non-zero a device would not detach
2007 device_delete_children(device_t dev)
2012 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2016 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2017 error = device_delete_child(dev, child);
2019 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2027 * @brief Find a device given a unit number
2029 * This is similar to devclass_get_devices() but only searches for
2030 * devices which have @p dev as a parent.
2032 * @param dev the parent device to search
2033 * @param unit the unit number to search for. If the unit is -1,
2034 * return the first child of @p dev which has name
2035 * @p classname (that is, the one with the lowest unit.)
2037 * @returns the device with the given unit number or @c
2038 * NULL if there is no such device
2041 device_find_child(device_t dev, const char *classname, int unit)
2046 dc = devclass_find(classname);
2051 child = devclass_get_device(dc, unit);
2052 if (child && child->parent == dev)
2055 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2056 child = devclass_get_device(dc, unit);
2057 if (child && child->parent == dev)
2068 first_matching_driver(devclass_t dc, device_t dev)
2071 return (devclass_find_driver_internal(dc, dev->devclass->name));
2072 return (TAILQ_FIRST(&dc->drivers));
2079 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2081 if (dev->devclass) {
2083 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2084 if (!strcmp(dev->devclass->name, dl->driver->name))
2088 return (TAILQ_NEXT(last, link));
2095 device_probe_child(device_t dev, device_t child)
2098 driverlink_t best = NULL;
2100 int result, pri = 0;
2101 /* We should preserve the devclass (or lack of) set by the bus. */
2102 int hasclass = (child->devclass != NULL);
2108 panic("device_probe_child: parent device has no devclass");
2111 * If the state is already probed, then return.
2113 if (child->state == DS_ALIVE)
2116 for (; dc; dc = dc->parent) {
2117 for (dl = first_matching_driver(dc, child);
2119 dl = next_matching_driver(dc, child, dl)) {
2120 /* If this driver's pass is too high, then ignore it. */
2121 if (dl->pass > bus_current_pass)
2124 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2125 result = device_set_driver(child, dl->driver);
2126 if (result == ENOMEM)
2128 else if (result != 0)
2131 if (device_set_devclass(child,
2132 dl->driver->name) != 0) {
2133 char const * devname =
2134 device_get_name(child);
2135 if (devname == NULL)
2136 devname = "(unknown)";
2137 printf("driver bug: Unable to set "
2138 "devclass (class: %s "
2142 (void)device_set_driver(child, NULL);
2147 /* Fetch any flags for the device before probing. */
2148 resource_int_value(dl->driver->name, child->unit,
2149 "flags", &child->devflags);
2151 result = DEVICE_PROBE(child);
2154 * If the driver returns SUCCESS, there can be
2155 * no higher match for this device.
2163 /* Reset flags and devclass before the next probe. */
2164 child->devflags = 0;
2166 (void)device_set_devclass(child, NULL);
2169 * Reset DF_QUIET in case this driver doesn't
2170 * end up as the best driver.
2172 device_verbose(child);
2175 * Probes that return BUS_PROBE_NOWILDCARD or lower
2176 * only match on devices whose driver was explicitly
2179 if (result <= BUS_PROBE_NOWILDCARD &&
2180 !(child->flags & DF_FIXEDCLASS)) {
2185 * The driver returned an error so it
2186 * certainly doesn't match.
2189 (void)device_set_driver(child, NULL);
2194 * A priority lower than SUCCESS, remember the
2195 * best matching driver. Initialise the value
2196 * of pri for the first match.
2198 if (best == NULL || result > pri) {
2205 * If we have an unambiguous match in this devclass,
2206 * don't look in the parent.
2208 if (best && pri == 0)
2216 * If we found a driver, change state and initialise the devclass.
2219 /* Set the winning driver, devclass, and flags. */
2220 result = device_set_driver(child, best->driver);
2223 if (!child->devclass) {
2224 result = device_set_devclass(child, best->driver->name);
2226 (void)device_set_driver(child, NULL);
2230 resource_int_value(best->driver->name, child->unit,
2231 "flags", &child->devflags);
2234 * A bit bogus. Call the probe method again to make sure
2235 * that we have the right description.
2237 result = DEVICE_PROBE(child);
2240 (void)device_set_devclass(child, NULL);
2241 (void)device_set_driver(child, NULL);
2246 child->state = DS_ALIVE;
2247 bus_data_generation_update();
2252 * @brief Return the parent of a device
2255 device_get_parent(device_t dev)
2257 return (dev->parent);
2261 * @brief Get a list of children of a device
2263 * An array containing a list of all the children of the given device
2264 * is allocated and returned in @p *devlistp. The number of devices
2265 * in the array is returned in @p *devcountp. The caller should free
2266 * the array using @c free(p, M_TEMP).
2268 * @param dev the device to examine
2269 * @param devlistp points at location for array pointer return
2271 * @param devcountp points at location for array size return value
2274 * @retval ENOMEM the array allocation failed
2277 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2284 TAILQ_FOREACH(child, &dev->children, link) {
2293 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2298 TAILQ_FOREACH(child, &dev->children, link) {
2299 list[count] = child;
2310 * @brief Return the current driver for the device or @c NULL if there
2311 * is no driver currently attached
2314 device_get_driver(device_t dev)
2316 return (dev->driver);
2320 * @brief Return the current devclass for the device or @c NULL if
2324 device_get_devclass(device_t dev)
2326 return (dev->devclass);
2330 * @brief Return the name of the device's devclass or @c NULL if there
2334 device_get_name(device_t dev)
2336 if (dev != NULL && dev->devclass)
2337 return (devclass_get_name(dev->devclass));
2342 * @brief Return a string containing the device's devclass name
2343 * followed by an ascii representation of the device's unit number
2347 device_get_nameunit(device_t dev)
2349 return (dev->nameunit);
2353 * @brief Return the device's unit number.
2356 device_get_unit(device_t dev)
2362 * @brief Return the device's description string
2365 device_get_desc(device_t dev)
2371 * @brief Return the device's flags
2374 device_get_flags(device_t dev)
2376 return (dev->devflags);
2379 struct sysctl_ctx_list *
2380 device_get_sysctl_ctx(device_t dev)
2382 return (&dev->sysctl_ctx);
2386 device_get_sysctl_tree(device_t dev)
2388 return (dev->sysctl_tree);
2392 * @brief Print the name of the device followed by a colon and a space
2394 * @returns the number of characters printed
2397 device_print_prettyname(device_t dev)
2399 const char *name = device_get_name(dev);
2402 return (printf("unknown: "));
2403 return (printf("%s%d: ", name, device_get_unit(dev)));
2407 * @brief Print the name of the device followed by a colon, a space
2408 * and the result of calling vprintf() with the value of @p fmt and
2409 * the following arguments.
2411 * @returns the number of characters printed
2414 device_printf(device_t dev, const char * fmt, ...)
2424 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2425 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2427 name = device_get_name(dev);
2430 sbuf_cat(&sb, "unknown: ");
2432 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2435 sbuf_vprintf(&sb, fmt, ap);
2445 * @brief Print the name of the device followed by a colon, a space
2446 * and the result of calling log() with the value of @p fmt and
2447 * the following arguments.
2449 * @returns the number of characters printed
2452 device_log(device_t dev, int pri, const char * fmt, ...)
2462 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2464 name = device_get_name(dev);
2467 sbuf_cat(&sb, "unknown: ");
2469 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2472 sbuf_vprintf(&sb, fmt, ap);
2477 log(pri, "%.*s", (int) sbuf_len(&sb), sbuf_data(&sb));
2478 retval = sbuf_len(&sb);
2489 device_set_desc_internal(device_t dev, const char* desc, int copy)
2491 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2492 free(dev->desc, M_BUS);
2493 dev->flags &= ~DF_DESCMALLOCED;
2498 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2500 strcpy(dev->desc, desc);
2501 dev->flags |= DF_DESCMALLOCED;
2504 /* Avoid a -Wcast-qual warning */
2505 dev->desc = (char *)(uintptr_t) desc;
2508 bus_data_generation_update();
2512 * @brief Set the device's description
2514 * The value of @c desc should be a string constant that will not
2515 * change (at least until the description is changed in a subsequent
2516 * call to device_set_desc() or device_set_desc_copy()).
2519 device_set_desc(device_t dev, const char* desc)
2521 device_set_desc_internal(dev, desc, FALSE);
2525 * @brief Set the device's description
2527 * The string pointed to by @c desc is copied. Use this function if
2528 * the device description is generated, (e.g. with sprintf()).
2531 device_set_desc_copy(device_t dev, const char* desc)
2533 device_set_desc_internal(dev, desc, TRUE);
2537 * @brief Set the device's flags
2540 device_set_flags(device_t dev, uint32_t flags)
2542 dev->devflags = flags;
2546 * @brief Return the device's softc field
2548 * The softc is allocated and zeroed when a driver is attached, based
2549 * on the size field of the driver.
2552 device_get_softc(device_t dev)
2554 return (dev->softc);
2558 * @brief Set the device's softc field
2560 * Most drivers do not need to use this since the softc is allocated
2561 * automatically when the driver is attached.
2564 device_set_softc(device_t dev, void *softc)
2566 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2567 free(dev->softc, M_BUS_SC);
2570 dev->flags |= DF_EXTERNALSOFTC;
2572 dev->flags &= ~DF_EXTERNALSOFTC;
2576 * @brief Free claimed softc
2578 * Most drivers do not need to use this since the softc is freed
2579 * automatically when the driver is detached.
2582 device_free_softc(void *softc)
2584 free(softc, M_BUS_SC);
2588 * @brief Claim softc
2590 * This function can be used to let the driver free the automatically
2591 * allocated softc using "device_free_softc()". This function is
2592 * useful when the driver is refcounting the softc and the softc
2593 * cannot be freed when the "device_detach" method is called.
2596 device_claim_softc(device_t dev)
2599 dev->flags |= DF_EXTERNALSOFTC;
2601 dev->flags &= ~DF_EXTERNALSOFTC;
2605 * @brief Get the device's ivars field
2607 * The ivars field is used by the parent device to store per-device
2608 * state (e.g. the physical location of the device or a list of
2612 device_get_ivars(device_t dev)
2614 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2615 return (dev->ivars);
2619 * @brief Set the device's ivars field
2622 device_set_ivars(device_t dev, void * ivars)
2624 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2629 * @brief Return the device's state
2632 device_get_state(device_t dev)
2634 return (dev->state);
2638 * @brief Set the DF_ENABLED flag for the device
2641 device_enable(device_t dev)
2643 dev->flags |= DF_ENABLED;
2647 * @brief Clear the DF_ENABLED flag for the device
2650 device_disable(device_t dev)
2652 dev->flags &= ~DF_ENABLED;
2656 * @brief Increment the busy counter for the device
2659 device_busy(device_t dev)
2661 if (dev->state < DS_ATTACHING)
2662 panic("device_busy: called for unattached device");
2663 if (dev->busy == 0 && dev->parent)
2664 device_busy(dev->parent);
2666 if (dev->state == DS_ATTACHED)
2667 dev->state = DS_BUSY;
2671 * @brief Decrement the busy counter for the device
2674 device_unbusy(device_t dev)
2676 if (dev->busy != 0 && dev->state != DS_BUSY &&
2677 dev->state != DS_ATTACHING)
2678 panic("device_unbusy: called for non-busy device %s",
2679 device_get_nameunit(dev));
2681 if (dev->busy == 0) {
2683 device_unbusy(dev->parent);
2684 if (dev->state == DS_BUSY)
2685 dev->state = DS_ATTACHED;
2690 * @brief Set the DF_QUIET flag for the device
2693 device_quiet(device_t dev)
2695 dev->flags |= DF_QUIET;
2699 * @brief Set the DF_QUIET_CHILDREN flag for the device
2702 device_quiet_children(device_t dev)
2704 dev->flags |= DF_QUIET_CHILDREN;
2708 * @brief Clear the DF_QUIET flag for the device
2711 device_verbose(device_t dev)
2713 dev->flags &= ~DF_QUIET;
2717 device_get_property(device_t dev, const char *prop, void *val, size_t sz,
2718 device_property_type_t type)
2720 device_t bus = device_get_parent(dev);
2723 case DEVICE_PROP_ANY:
2724 case DEVICE_PROP_BUFFER:
2725 case DEVICE_PROP_HANDLE: /* Size checks done in implementation. */
2727 case DEVICE_PROP_UINT32:
2731 case DEVICE_PROP_UINT64:
2739 return (BUS_GET_PROPERTY(bus, dev, prop, val, sz, type));
2743 device_has_property(device_t dev, const char *prop)
2745 return (device_get_property(dev, prop, NULL, 0, DEVICE_PROP_ANY) >= 0);
2749 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2752 device_has_quiet_children(device_t dev)
2754 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2758 * @brief Return non-zero if the DF_QUIET flag is set on the device
2761 device_is_quiet(device_t dev)
2763 return ((dev->flags & DF_QUIET) != 0);
2767 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2770 device_is_enabled(device_t dev)
2772 return ((dev->flags & DF_ENABLED) != 0);
2776 * @brief Return non-zero if the device was successfully probed
2779 device_is_alive(device_t dev)
2781 return (dev->state >= DS_ALIVE);
2785 * @brief Return non-zero if the device currently has a driver
2789 device_is_attached(device_t dev)
2791 return (dev->state >= DS_ATTACHED);
2795 * @brief Return non-zero if the device is currently suspended.
2798 device_is_suspended(device_t dev)
2800 return ((dev->flags & DF_SUSPENDED) != 0);
2804 * @brief Set the devclass of a device
2805 * @see devclass_add_device().
2808 device_set_devclass(device_t dev, const char *classname)
2815 devclass_delete_device(dev->devclass, dev);
2819 if (dev->devclass) {
2820 printf("device_set_devclass: device class already set\n");
2824 dc = devclass_find_internal(classname, NULL, TRUE);
2828 error = devclass_add_device(dc, dev);
2830 bus_data_generation_update();
2835 * @brief Set the devclass of a device and mark the devclass fixed.
2836 * @see device_set_devclass()
2839 device_set_devclass_fixed(device_t dev, const char *classname)
2843 if (classname == NULL)
2846 error = device_set_devclass(dev, classname);
2849 dev->flags |= DF_FIXEDCLASS;
2854 * @brief Query the device to determine if it's of a fixed devclass
2855 * @see device_set_devclass_fixed()
2858 device_is_devclass_fixed(device_t dev)
2860 return ((dev->flags & DF_FIXEDCLASS) != 0);
2864 * @brief Set the driver of a device
2867 * @retval EBUSY the device already has a driver attached
2868 * @retval ENOMEM a memory allocation failure occurred
2871 device_set_driver(device_t dev, driver_t *driver)
2874 struct domainset *policy;
2876 if (dev->state >= DS_ATTACHED)
2879 if (dev->driver == driver)
2882 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2883 free(dev->softc, M_BUS_SC);
2886 device_set_desc(dev, NULL);
2887 kobj_delete((kobj_t) dev, NULL);
2888 dev->driver = driver;
2890 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2891 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2892 if (bus_get_domain(dev, &domain) == 0)
2893 policy = DOMAINSET_PREF(domain);
2895 policy = DOMAINSET_RR();
2896 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2897 policy, M_NOWAIT | M_ZERO);
2899 kobj_delete((kobj_t) dev, NULL);
2900 kobj_init((kobj_t) dev, &null_class);
2906 kobj_init((kobj_t) dev, &null_class);
2909 bus_data_generation_update();
2914 * @brief Probe a device, and return this status.
2916 * This function is the core of the device autoconfiguration
2917 * system. Its purpose is to select a suitable driver for a device and
2918 * then call that driver to initialise the hardware appropriately. The
2919 * driver is selected by calling the DEVICE_PROBE() method of a set of
2920 * candidate drivers and then choosing the driver which returned the
2921 * best value. This driver is then attached to the device using
2924 * The set of suitable drivers is taken from the list of drivers in
2925 * the parent device's devclass. If the device was originally created
2926 * with a specific class name (see device_add_child()), only drivers
2927 * with that name are probed, otherwise all drivers in the devclass
2928 * are probed. If no drivers return successful probe values in the
2929 * parent devclass, the search continues in the parent of that
2930 * devclass (see devclass_get_parent()) if any.
2932 * @param dev the device to initialise
2935 * @retval ENXIO no driver was found
2936 * @retval ENOMEM memory allocation failure
2937 * @retval non-zero some other unix error code
2938 * @retval -1 Device already attached
2941 device_probe(device_t dev)
2947 if (dev->state >= DS_ALIVE)
2950 if (!(dev->flags & DF_ENABLED)) {
2951 if (bootverbose && device_get_name(dev) != NULL) {
2952 device_print_prettyname(dev);
2953 printf("not probed (disabled)\n");
2957 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2958 if (bus_current_pass == BUS_PASS_DEFAULT &&
2959 !(dev->flags & DF_DONENOMATCH)) {
2960 BUS_PROBE_NOMATCH(dev->parent, dev);
2962 dev->flags |= DF_DONENOMATCH;
2970 * @brief Probe a device and attach a driver if possible
2972 * calls device_probe() and attaches if that was successful.
2975 device_probe_and_attach(device_t dev)
2981 error = device_probe(dev);
2984 else if (error != 0)
2987 CURVNET_SET_QUIET(vnet0);
2988 error = device_attach(dev);
2994 * @brief Attach a device driver to a device
2996 * This function is a wrapper around the DEVICE_ATTACH() driver
2997 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2998 * device's sysctl tree, optionally prints a description of the device
2999 * and queues a notification event for user-based device management
3002 * Normally this function is only called internally from
3003 * device_probe_and_attach().
3005 * @param dev the device to initialise
3008 * @retval ENXIO no driver was found
3009 * @retval ENOMEM memory allocation failure
3010 * @retval non-zero some other unix error code
3013 device_attach(device_t dev)
3015 uint64_t attachtime;
3016 uint16_t attachentropy;
3019 if (resource_disabled(dev->driver->name, dev->unit)) {
3020 device_disable(dev);
3022 device_printf(dev, "disabled via hints entry\n");
3026 device_sysctl_init(dev);
3027 if (!device_is_quiet(dev))
3028 device_print_child(dev->parent, dev);
3029 attachtime = get_cyclecount();
3030 dev->state = DS_ATTACHING;
3031 if ((error = DEVICE_ATTACH(dev)) != 0) {
3032 printf("device_attach: %s%d attach returned %d\n",
3033 dev->driver->name, dev->unit, error);
3034 if (!(dev->flags & DF_FIXEDCLASS))
3035 devclass_delete_device(dev->devclass, dev);
3036 (void)device_set_driver(dev, NULL);
3037 device_sysctl_fini(dev);
3038 KASSERT(dev->busy == 0, ("attach failed but busy"));
3039 dev->state = DS_NOTPRESENT;
3042 dev->flags |= DF_ATTACHED_ONCE;
3043 /* We only need the low bits of this time, but ranges from tens to thousands
3044 * have been seen, so keep 2 bytes' worth.
3046 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3047 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3048 device_sysctl_update(dev);
3050 dev->state = DS_BUSY;
3052 dev->state = DS_ATTACHED;
3053 dev->flags &= ~DF_DONENOMATCH;
3054 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3060 * @brief Detach a driver from a device
3062 * This function is a wrapper around the DEVICE_DETACH() driver
3063 * method. If the call to DEVICE_DETACH() succeeds, it calls
3064 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3065 * notification event for user-based device management services and
3066 * cleans up the device's sysctl tree.
3068 * @param dev the device to un-initialise
3071 * @retval ENXIO no driver was found
3072 * @retval ENOMEM memory allocation failure
3073 * @retval non-zero some other unix error code
3076 device_detach(device_t dev)
3082 PDEBUG(("%s", DEVICENAME(dev)));
3083 if (dev->state == DS_BUSY)
3085 if (dev->state == DS_ATTACHING) {
3086 device_printf(dev, "device in attaching state! Deferring detach.\n");
3089 if (dev->state != DS_ATTACHED)
3092 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3093 if ((error = DEVICE_DETACH(dev)) != 0) {
3094 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3095 EVHDEV_DETACH_FAILED);
3098 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3099 EVHDEV_DETACH_COMPLETE);
3102 if (!device_is_quiet(dev))
3103 device_printf(dev, "detached\n");
3105 BUS_CHILD_DETACHED(dev->parent, dev);
3107 if (!(dev->flags & DF_FIXEDCLASS))
3108 devclass_delete_device(dev->devclass, dev);
3110 device_verbose(dev);
3111 dev->state = DS_NOTPRESENT;
3112 (void)device_set_driver(dev, NULL);
3113 device_sysctl_fini(dev);
3119 * @brief Tells a driver to quiesce itself.
3121 * This function is a wrapper around the DEVICE_QUIESCE() driver
3122 * method. If the call to DEVICE_QUIESCE() succeeds.
3124 * @param dev the device to quiesce
3127 * @retval ENXIO no driver was found
3128 * @retval ENOMEM memory allocation failure
3129 * @retval non-zero some other unix error code
3132 device_quiesce(device_t dev)
3134 PDEBUG(("%s", DEVICENAME(dev)));
3135 if (dev->state == DS_BUSY)
3137 if (dev->state != DS_ATTACHED)
3140 return (DEVICE_QUIESCE(dev));
3144 * @brief Notify a device of system shutdown
3146 * This function calls the DEVICE_SHUTDOWN() driver method if the
3147 * device currently has an attached driver.
3149 * @returns the value returned by DEVICE_SHUTDOWN()
3152 device_shutdown(device_t dev)
3154 if (dev->state < DS_ATTACHED)
3156 return (DEVICE_SHUTDOWN(dev));
3160 * @brief Set the unit number of a device
3162 * This function can be used to override the unit number used for a
3163 * device (e.g. to wire a device to a pre-configured unit number).
3166 device_set_unit(device_t dev, int unit)
3171 if (unit == dev->unit)
3173 dc = device_get_devclass(dev);
3174 if (unit < dc->maxunit && dc->devices[unit])
3176 err = devclass_delete_device(dc, dev);
3180 err = devclass_add_device(dc, dev);
3184 bus_data_generation_update();
3188 /*======================================*/
3190 * Some useful method implementations to make life easier for bus drivers.
3194 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3198 args->memattr = VM_MEMATTR_DEVICE;
3202 * @brief Initialise a resource list.
3204 * @param rl the resource list to initialise
3207 resource_list_init(struct resource_list *rl)
3213 * @brief Reclaim memory used by a resource list.
3215 * This function frees the memory for all resource entries on the list
3218 * @param rl the resource list to free
3221 resource_list_free(struct resource_list *rl)
3223 struct resource_list_entry *rle;
3225 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3227 panic("resource_list_free: resource entry is busy");
3228 STAILQ_REMOVE_HEAD(rl, link);
3234 * @brief Add a resource entry.
3236 * This function adds a resource entry using the given @p type, @p
3237 * start, @p end and @p count values. A rid value is chosen by
3238 * searching sequentially for the first unused rid starting at zero.
3240 * @param rl the resource list to edit
3241 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3242 * @param start the start address of the resource
3243 * @param end the end address of the resource
3244 * @param count XXX end-start+1
3247 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3248 rman_res_t end, rman_res_t count)
3253 while (resource_list_find(rl, type, rid) != NULL)
3255 resource_list_add(rl, type, rid, start, end, count);
3260 * @brief Add or modify a resource entry.
3262 * If an existing entry exists with the same type and rid, it will be
3263 * modified using the given values of @p start, @p end and @p
3264 * count. If no entry exists, a new one will be created using the
3265 * given values. The resource list entry that matches is then returned.
3267 * @param rl the resource list to edit
3268 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3269 * @param rid the resource identifier
3270 * @param start the start address of the resource
3271 * @param end the end address of the resource
3272 * @param count XXX end-start+1
3274 struct resource_list_entry *
3275 resource_list_add(struct resource_list *rl, int type, int rid,
3276 rman_res_t start, rman_res_t end, rman_res_t count)
3278 struct resource_list_entry *rle;
3280 rle = resource_list_find(rl, type, rid);
3282 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3285 panic("resource_list_add: can't record entry");
3286 STAILQ_INSERT_TAIL(rl, rle, link);
3294 panic("resource_list_add: resource entry is busy");
3303 * @brief Determine if a resource entry is busy.
3305 * Returns true if a resource entry is busy meaning that it has an
3306 * associated resource that is not an unallocated "reserved" resource.
3308 * @param rl the resource list to search
3309 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3310 * @param rid the resource identifier
3312 * @returns Non-zero if the entry is busy, zero otherwise.
3315 resource_list_busy(struct resource_list *rl, int type, int rid)
3317 struct resource_list_entry *rle;
3319 rle = resource_list_find(rl, type, rid);
3320 if (rle == NULL || rle->res == NULL)
3322 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3323 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3324 ("reserved resource is active"));
3331 * @brief Determine if a resource entry is reserved.
3333 * Returns true if a resource entry is reserved meaning that it has an
3334 * associated "reserved" resource. The resource can either be
3335 * allocated or unallocated.
3337 * @param rl the resource list to search
3338 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3339 * @param rid the resource identifier
3341 * @returns Non-zero if the entry is reserved, zero otherwise.
3344 resource_list_reserved(struct resource_list *rl, int type, int rid)
3346 struct resource_list_entry *rle;
3348 rle = resource_list_find(rl, type, rid);
3349 if (rle != NULL && rle->flags & RLE_RESERVED)
3355 * @brief Find a resource entry by type and rid.
3357 * @param rl the resource list to search
3358 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3359 * @param rid the resource identifier
3361 * @returns the resource entry pointer or NULL if there is no such
3364 struct resource_list_entry *
3365 resource_list_find(struct resource_list *rl, int type, int rid)
3367 struct resource_list_entry *rle;
3369 STAILQ_FOREACH(rle, rl, link) {
3370 if (rle->type == type && rle->rid == rid)
3377 * @brief Delete a resource entry.
3379 * @param rl the resource list to edit
3380 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3381 * @param rid the resource identifier
3384 resource_list_delete(struct resource_list *rl, int type, int rid)
3386 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3389 if (rle->res != NULL)
3390 panic("resource_list_delete: resource has not been released");
3391 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3397 * @brief Allocate a reserved resource
3399 * This can be used by buses to force the allocation of resources
3400 * that are always active in the system even if they are not allocated
3401 * by a driver (e.g. PCI BARs). This function is usually called when
3402 * adding a new child to the bus. The resource is allocated from the
3403 * parent bus when it is reserved. The resource list entry is marked
3404 * with RLE_RESERVED to note that it is a reserved resource.
3406 * Subsequent attempts to allocate the resource with
3407 * resource_list_alloc() will succeed the first time and will set
3408 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3409 * resource that has been allocated is released with
3410 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3411 * the actual resource remains allocated. The resource can be released to
3412 * the parent bus by calling resource_list_unreserve().
3414 * @param rl the resource list to allocate from
3415 * @param bus the parent device of @p child
3416 * @param child the device for which the resource is being reserved
3417 * @param type the type of resource to allocate
3418 * @param rid a pointer to the resource identifier
3419 * @param start hint at the start of the resource range - pass
3420 * @c 0 for any start address
3421 * @param end hint at the end of the resource range - pass
3422 * @c ~0 for any end address
3423 * @param count hint at the size of range required - pass @c 1
3425 * @param flags any extra flags to control the resource
3426 * allocation - see @c RF_XXX flags in
3427 * <sys/rman.h> for details
3429 * @returns the resource which was allocated or @c NULL if no
3430 * resource could be allocated
3433 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3434 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3436 struct resource_list_entry *rle = NULL;
3437 int passthrough = (device_get_parent(child) != bus);
3442 "resource_list_reserve() should only be called for direct children");
3443 if (flags & RF_ACTIVE)
3445 "resource_list_reserve() should only reserve inactive resources");
3447 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3450 rle = resource_list_find(rl, type, *rid);
3451 rle->flags |= RLE_RESERVED;
3457 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3459 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3460 * and passing the allocation up to the parent of @p bus. This assumes
3461 * that the first entry of @c device_get_ivars(child) is a struct
3462 * resource_list. This also handles 'passthrough' allocations where a
3463 * child is a remote descendant of bus by passing the allocation up to
3464 * the parent of bus.
3466 * Typically, a bus driver would store a list of child resources
3467 * somewhere in the child device's ivars (see device_get_ivars()) and
3468 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3469 * then call resource_list_alloc() to perform the allocation.
3471 * @param rl the resource list to allocate from
3472 * @param bus the parent device of @p child
3473 * @param child the device which is requesting an allocation
3474 * @param type the type of resource to allocate
3475 * @param rid a pointer to the resource identifier
3476 * @param start hint at the start of the resource range - pass
3477 * @c 0 for any start address
3478 * @param end hint at the end of the resource range - pass
3479 * @c ~0 for any end address
3480 * @param count hint at the size of range required - pass @c 1
3482 * @param flags any extra flags to control the resource
3483 * allocation - see @c RF_XXX flags in
3484 * <sys/rman.h> for details
3486 * @returns the resource which was allocated or @c NULL if no
3487 * resource could be allocated
3490 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3491 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3493 struct resource_list_entry *rle = NULL;
3494 int passthrough = (device_get_parent(child) != bus);
3495 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3498 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3499 type, rid, start, end, count, flags));
3502 rle = resource_list_find(rl, type, *rid);
3505 return (NULL); /* no resource of that type/rid */
3508 if (rle->flags & RLE_RESERVED) {
3509 if (rle->flags & RLE_ALLOCATED)
3511 if ((flags & RF_ACTIVE) &&
3512 bus_activate_resource(child, type, *rid,
3515 rle->flags |= RLE_ALLOCATED;
3519 "resource entry %#x type %d for child %s is busy\n", *rid,
3520 type, device_get_nameunit(child));
3526 count = ulmax(count, rle->count);
3527 end = ulmax(rle->end, start + count - 1);
3530 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3531 type, rid, start, end, count, flags);
3534 * Record the new range.
3537 rle->start = rman_get_start(rle->res);
3538 rle->end = rman_get_end(rle->res);
3546 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3548 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3549 * used with resource_list_alloc().
3551 * @param rl the resource list which was allocated from
3552 * @param bus the parent device of @p child
3553 * @param child the device which is requesting a release
3554 * @param type the type of resource to release
3555 * @param rid the resource identifier
3556 * @param res the resource to release
3559 * @retval non-zero a standard unix error code indicating what
3560 * error condition prevented the operation
3563 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3564 int type, int rid, struct resource *res)
3566 struct resource_list_entry *rle = NULL;
3567 int passthrough = (device_get_parent(child) != bus);
3571 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3575 rle = resource_list_find(rl, type, rid);
3578 panic("resource_list_release: can't find resource");
3580 panic("resource_list_release: resource entry is not busy");
3581 if (rle->flags & RLE_RESERVED) {
3582 if (rle->flags & RLE_ALLOCATED) {
3583 if (rman_get_flags(res) & RF_ACTIVE) {
3584 error = bus_deactivate_resource(child, type,
3589 rle->flags &= ~RLE_ALLOCATED;
3595 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3605 * @brief Release all active resources of a given type
3607 * Release all active resources of a specified type. This is intended
3608 * to be used to cleanup resources leaked by a driver after detach or
3611 * @param rl the resource list which was allocated from
3612 * @param bus the parent device of @p child
3613 * @param child the device whose active resources are being released
3614 * @param type the type of resources to release
3617 * @retval EBUSY at least one resource was active
3620 resource_list_release_active(struct resource_list *rl, device_t bus,
3621 device_t child, int type)
3623 struct resource_list_entry *rle;
3627 STAILQ_FOREACH(rle, rl, link) {
3628 if (rle->type != type)
3630 if (rle->res == NULL)
3632 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3636 error = resource_list_release(rl, bus, child, type,
3637 rman_get_rid(rle->res), rle->res);
3640 "Failed to release active resource: %d\n", error);
3646 * @brief Fully release a reserved resource
3648 * Fully releases a resource reserved via resource_list_reserve().
3650 * @param rl the resource list which was allocated from
3651 * @param bus the parent device of @p child
3652 * @param child the device whose reserved resource is being released
3653 * @param type the type of resource to release
3654 * @param rid the resource identifier
3655 * @param res the resource to release
3658 * @retval non-zero a standard unix error code indicating what
3659 * error condition prevented the operation
3662 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3665 struct resource_list_entry *rle = NULL;
3666 int passthrough = (device_get_parent(child) != bus);
3670 "resource_list_unreserve() should only be called for direct children");
3672 rle = resource_list_find(rl, type, rid);
3675 panic("resource_list_unreserve: can't find resource");
3676 if (!(rle->flags & RLE_RESERVED))
3678 if (rle->flags & RLE_ALLOCATED)
3680 rle->flags &= ~RLE_RESERVED;
3681 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3685 * @brief Print a description of resources in a resource list
3687 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3688 * The name is printed if at least one resource of the given type is available.
3689 * The format is used to print resource start and end.
3691 * @param rl the resource list to print
3692 * @param name the name of @p type, e.g. @c "memory"
3693 * @param type type type of resource entry to print
3694 * @param format printf(9) format string to print resource
3695 * start and end values
3697 * @returns the number of characters printed
3700 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3703 struct resource_list_entry *rle;
3704 int printed, retval;
3708 /* Yes, this is kinda cheating */
3709 STAILQ_FOREACH(rle, rl, link) {
3710 if (rle->type == type) {
3712 retval += printf(" %s ", name);
3714 retval += printf(",");
3716 retval += printf(format, rle->start);
3717 if (rle->count > 1) {
3718 retval += printf("-");
3719 retval += printf(format, rle->start +
3728 * @brief Releases all the resources in a list.
3730 * @param rl The resource list to purge.
3735 resource_list_purge(struct resource_list *rl)
3737 struct resource_list_entry *rle;
3739 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3741 bus_release_resource(rman_get_device(rle->res),
3742 rle->type, rle->rid, rle->res);
3743 STAILQ_REMOVE_HEAD(rl, link);
3749 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3751 return (device_add_child_ordered(dev, order, name, unit));
3755 * @brief Helper function for implementing DEVICE_PROBE()
3757 * This function can be used to help implement the DEVICE_PROBE() for
3758 * a bus (i.e. a device which has other devices attached to it). It
3759 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3763 bus_generic_probe(device_t dev)
3765 devclass_t dc = dev->devclass;
3768 TAILQ_FOREACH(dl, &dc->drivers, link) {
3770 * If this driver's pass is too high, then ignore it.
3771 * For most drivers in the default pass, this will
3772 * never be true. For early-pass drivers they will
3773 * only call the identify routines of eligible drivers
3774 * when this routine is called. Drivers for later
3775 * passes should have their identify routines called
3776 * on early-pass buses during BUS_NEW_PASS().
3778 if (dl->pass > bus_current_pass)
3780 DEVICE_IDENTIFY(dl->driver, dev);
3787 * @brief Helper function for implementing DEVICE_ATTACH()
3789 * This function can be used to help implement the DEVICE_ATTACH() for
3790 * a bus. It calls device_probe_and_attach() for each of the device's
3794 bus_generic_attach(device_t dev)
3798 TAILQ_FOREACH(child, &dev->children, link) {
3799 device_probe_and_attach(child);
3806 * @brief Helper function for delaying attaching children
3808 * Many buses can't run transactions on the bus which children need to probe and
3809 * attach until after interrupts and/or timers are running. This function
3810 * delays their attach until interrupts and timers are enabled.
3813 bus_delayed_attach_children(device_t dev)
3815 /* Probe and attach the bus children when interrupts are available */
3816 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3822 * @brief Helper function for implementing DEVICE_DETACH()
3824 * This function can be used to help implement the DEVICE_DETACH() for
3825 * a bus. It calls device_detach() for each of the device's
3829 bus_generic_detach(device_t dev)
3834 if (dev->state != DS_ATTACHED)
3838 * Detach children in the reverse order.
3839 * See bus_generic_suspend for details.
3841 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3842 if ((error = device_detach(child)) != 0)
3850 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3852 * This function can be used to help implement the DEVICE_SHUTDOWN()
3853 * for a bus. It calls device_shutdown() for each of the device's
3857 bus_generic_shutdown(device_t dev)
3862 * Shut down children in the reverse order.
3863 * See bus_generic_suspend for details.
3865 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3866 device_shutdown(child);
3873 * @brief Default function for suspending a child device.
3875 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3878 bus_generic_suspend_child(device_t dev, device_t child)
3882 error = DEVICE_SUSPEND(child);
3885 child->flags |= DF_SUSPENDED;
3891 * @brief Default function for resuming a child device.
3893 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3896 bus_generic_resume_child(device_t dev, device_t child)
3898 DEVICE_RESUME(child);
3899 child->flags &= ~DF_SUSPENDED;
3905 * @brief Helper function for implementing DEVICE_SUSPEND()
3907 * This function can be used to help implement the DEVICE_SUSPEND()
3908 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3909 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3910 * operation is aborted and any devices which were suspended are
3911 * resumed immediately by calling their DEVICE_RESUME() methods.
3914 bus_generic_suspend(device_t dev)
3920 * Suspend children in the reverse order.
3921 * For most buses all children are equal, so the order does not matter.
3922 * Other buses, such as acpi, carefully order their child devices to
3923 * express implicit dependencies between them. For such buses it is
3924 * safer to bring down devices in the reverse order.
3926 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3927 error = BUS_SUSPEND_CHILD(dev, child);
3929 child = TAILQ_NEXT(child, link);
3930 if (child != NULL) {
3931 TAILQ_FOREACH_FROM(child, &dev->children, link)
3932 BUS_RESUME_CHILD(dev, child);
3941 * @brief Helper function for implementing DEVICE_RESUME()
3943 * This function can be used to help implement the DEVICE_RESUME() for
3944 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3947 bus_generic_resume(device_t dev)
3951 TAILQ_FOREACH(child, &dev->children, link) {
3952 BUS_RESUME_CHILD(dev, child);
3953 /* if resume fails, there's nothing we can usefully do... */
3959 * @brief Helper function for implementing BUS_RESET_POST
3961 * Bus can use this function to implement common operations of
3962 * re-attaching or resuming the children after the bus itself was
3963 * reset, and after restoring bus-unique state of children.
3965 * @param dev The bus
3966 * #param flags DEVF_RESET_*
3969 bus_helper_reset_post(device_t dev, int flags)
3975 TAILQ_FOREACH(child, &dev->children,link) {
3976 BUS_RESET_POST(dev, child);
3977 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3978 device_probe_and_attach(child) :
3979 BUS_RESUME_CHILD(dev, child);
3980 if (error == 0 && error1 != 0)
3987 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3989 child = TAILQ_NEXT(child, link);
3992 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3993 BUS_RESET_POST(dev, child);
3994 if ((flags & DEVF_RESET_DETACH) != 0)
3995 device_probe_and_attach(child);
3997 BUS_RESUME_CHILD(dev, child);
4002 * @brief Helper function for implementing BUS_RESET_PREPARE
4004 * Bus can use this function to implement common operations of
4005 * detaching or suspending the children before the bus itself is
4006 * reset, and then save bus-unique state of children that must
4007 * persists around reset.
4009 * @param dev The bus
4010 * #param flags DEVF_RESET_*
4013 bus_helper_reset_prepare(device_t dev, int flags)
4018 if (dev->state != DS_ATTACHED)
4021 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
4022 if ((flags & DEVF_RESET_DETACH) != 0) {
4023 error = device_get_state(child) == DS_ATTACHED ?
4024 device_detach(child) : 0;
4026 error = BUS_SUSPEND_CHILD(dev, child);
4029 error = BUS_RESET_PREPARE(dev, child);
4031 if ((flags & DEVF_RESET_DETACH) != 0)
4032 device_probe_and_attach(child);
4034 BUS_RESUME_CHILD(dev, child);
4038 bus_helper_reset_prepare_rollback(dev, child, flags);
4046 * @brief Helper function for implementing BUS_PRINT_CHILD().
4048 * This function prints the first part of the ascii representation of
4049 * @p child, including its name, unit and description (if any - see
4050 * device_set_desc()).
4052 * @returns the number of characters printed
4055 bus_print_child_header(device_t dev, device_t child)
4059 if (device_get_desc(child)) {
4060 retval += device_printf(child, "<%s>", device_get_desc(child));
4062 retval += printf("%s", device_get_nameunit(child));
4069 * @brief Helper function for implementing BUS_PRINT_CHILD().
4071 * This function prints the last part of the ascii representation of
4072 * @p child, which consists of the string @c " on " followed by the
4073 * name and unit of the @p dev.
4075 * @returns the number of characters printed
4078 bus_print_child_footer(device_t dev, device_t child)
4080 return (printf(" on %s\n", device_get_nameunit(dev)));
4084 * @brief Helper function for implementing BUS_PRINT_CHILD().
4086 * This function prints out the VM domain for the given device.
4088 * @returns the number of characters printed
4091 bus_print_child_domain(device_t dev, device_t child)
4095 /* No domain? Don't print anything */
4096 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4099 return (printf(" numa-domain %d", domain));
4103 * @brief Helper function for implementing BUS_PRINT_CHILD().
4105 * This function simply calls bus_print_child_header() followed by
4106 * bus_print_child_footer().
4108 * @returns the number of characters printed
4111 bus_generic_print_child(device_t dev, device_t child)
4115 retval += bus_print_child_header(dev, child);
4116 retval += bus_print_child_domain(dev, child);
4117 retval += bus_print_child_footer(dev, child);
4123 * @brief Stub function for implementing BUS_READ_IVAR().
4128 bus_generic_read_ivar(device_t dev, device_t child, int index,
4135 * @brief Stub function for implementing BUS_WRITE_IVAR().
4140 bus_generic_write_ivar(device_t dev, device_t child, int index,
4147 * @brief Helper function for implementing BUS_GET_PROPERTY().
4149 * This simply calls the BUS_GET_PROPERTY of the parent of dev,
4150 * until a non-default implementation is found.
4153 bus_generic_get_property(device_t dev, device_t child, const char *propname,
4154 void *propvalue, size_t size, device_property_type_t type)
4156 if (device_get_parent(dev) != NULL)
4157 return (BUS_GET_PROPERTY(device_get_parent(dev), child,
4158 propname, propvalue, size, type));
4164 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4168 struct resource_list *
4169 bus_generic_get_resource_list(device_t dev, device_t child)
4175 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4177 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4178 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4179 * and then calls device_probe_and_attach() for each unattached child.
4182 bus_generic_driver_added(device_t dev, driver_t *driver)
4186 DEVICE_IDENTIFY(driver, dev);
4187 TAILQ_FOREACH(child, &dev->children, link) {
4188 if (child->state == DS_NOTPRESENT)
4189 device_probe_and_attach(child);
4194 * @brief Helper function for implementing BUS_NEW_PASS().
4196 * This implementing of BUS_NEW_PASS() first calls the identify
4197 * routines for any drivers that probe at the current pass. Then it
4198 * walks the list of devices for this bus. If a device is already
4199 * attached, then it calls BUS_NEW_PASS() on that device. If the
4200 * device is not already attached, it attempts to attach a driver to
4204 bus_generic_new_pass(device_t dev)
4211 TAILQ_FOREACH(dl, &dc->drivers, link) {
4212 if (dl->pass == bus_current_pass)
4213 DEVICE_IDENTIFY(dl->driver, dev);
4215 TAILQ_FOREACH(child, &dev->children, link) {
4216 if (child->state >= DS_ATTACHED)
4217 BUS_NEW_PASS(child);
4218 else if (child->state == DS_NOTPRESENT)
4219 device_probe_and_attach(child);
4224 * @brief Helper function for implementing BUS_SETUP_INTR().
4226 * This simple implementation of BUS_SETUP_INTR() simply calls the
4227 * BUS_SETUP_INTR() method of the parent of @p dev.
4230 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4231 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4234 /* Propagate up the bus hierarchy until someone handles it. */
4236 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4237 filter, intr, arg, cookiep));
4242 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4244 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4245 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4248 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4251 /* Propagate up the bus hierarchy until someone handles it. */
4253 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4258 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4260 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4261 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4264 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4266 /* Propagate up the bus hierarchy until someone handles it. */
4268 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4273 * @brief Helper function for implementing BUS_RESUME_INTR().
4275 * This simple implementation of BUS_RESUME_INTR() simply calls the
4276 * BUS_RESUME_INTR() method of the parent of @p dev.
4279 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4281 /* Propagate up the bus hierarchy until someone handles it. */
4283 return (BUS_RESUME_INTR(dev->parent, child, irq));
4288 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4290 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4291 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4294 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4295 struct resource *r, rman_res_t start, rman_res_t end)
4297 /* Propagate up the bus hierarchy until someone handles it. */
4299 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4305 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4307 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4308 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4311 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4312 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4314 /* Propagate up the bus hierarchy until someone handles it. */
4316 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4317 start, end, count, flags));
4322 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4324 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4325 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4328 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4331 /* Propagate up the bus hierarchy until someone handles it. */
4333 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4339 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4341 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4342 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4345 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4348 /* Propagate up the bus hierarchy until someone handles it. */
4350 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4356 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4358 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4359 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4362 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4363 int rid, struct resource *r)
4365 /* Propagate up the bus hierarchy until someone handles it. */
4367 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4373 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4375 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4376 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4379 bus_generic_map_resource(device_t dev, device_t child, int type,
4380 struct resource *r, struct resource_map_request *args,
4381 struct resource_map *map)
4383 /* Propagate up the bus hierarchy until someone handles it. */
4385 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4391 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4393 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4394 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4397 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4398 struct resource *r, struct resource_map *map)
4400 /* Propagate up the bus hierarchy until someone handles it. */
4402 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4407 * @brief Helper function for implementing BUS_BIND_INTR().
4409 * This simple implementation of BUS_BIND_INTR() simply calls the
4410 * BUS_BIND_INTR() method of the parent of @p dev.
4413 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4416 /* Propagate up the bus hierarchy until someone handles it. */
4418 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4423 * @brief Helper function for implementing BUS_CONFIG_INTR().
4425 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4426 * BUS_CONFIG_INTR() method of the parent of @p dev.
4429 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4430 enum intr_polarity pol)
4432 /* Propagate up the bus hierarchy until someone handles it. */
4434 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4439 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4441 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4442 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4445 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4446 void *cookie, const char *descr)
4448 /* Propagate up the bus hierarchy until someone handles it. */
4450 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4456 * @brief Helper function for implementing BUS_GET_CPUS().
4458 * This simple implementation of BUS_GET_CPUS() simply calls the
4459 * BUS_GET_CPUS() method of the parent of @p dev.
4462 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4463 size_t setsize, cpuset_t *cpuset)
4465 /* Propagate up the bus hierarchy until someone handles it. */
4466 if (dev->parent != NULL)
4467 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4472 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4474 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4475 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4478 bus_generic_get_dma_tag(device_t dev, device_t child)
4480 /* Propagate up the bus hierarchy until someone handles it. */
4481 if (dev->parent != NULL)
4482 return (BUS_GET_DMA_TAG(dev->parent, child));
4487 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4489 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4490 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4493 bus_generic_get_bus_tag(device_t dev, device_t child)
4495 /* Propagate up the bus hierarchy until someone handles it. */
4496 if (dev->parent != NULL)
4497 return (BUS_GET_BUS_TAG(dev->parent, child));
4498 return ((bus_space_tag_t)0);
4502 * @brief Helper function for implementing BUS_GET_RESOURCE().
4504 * This implementation of BUS_GET_RESOURCE() uses the
4505 * resource_list_find() function to do most of the work. It calls
4506 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4510 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4511 rman_res_t *startp, rman_res_t *countp)
4513 struct resource_list * rl = NULL;
4514 struct resource_list_entry * rle = NULL;
4516 rl = BUS_GET_RESOURCE_LIST(dev, child);
4520 rle = resource_list_find(rl, type, rid);
4525 *startp = rle->start;
4527 *countp = rle->count;
4533 * @brief Helper function for implementing BUS_SET_RESOURCE().
4535 * This implementation of BUS_SET_RESOURCE() uses the
4536 * resource_list_add() function to do most of the work. It calls
4537 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4541 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4542 rman_res_t start, rman_res_t count)
4544 struct resource_list * rl = NULL;
4546 rl = BUS_GET_RESOURCE_LIST(dev, child);
4550 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4556 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4558 * This implementation of BUS_DELETE_RESOURCE() uses the
4559 * resource_list_delete() function to do most of the work. It calls
4560 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4564 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4566 struct resource_list * rl = NULL;
4568 rl = BUS_GET_RESOURCE_LIST(dev, child);
4572 resource_list_delete(rl, type, rid);
4578 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4580 * This implementation of BUS_RELEASE_RESOURCE() uses the
4581 * resource_list_release() function to do most of the work. It calls
4582 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4585 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4586 int rid, struct resource *r)
4588 struct resource_list * rl = NULL;
4590 if (device_get_parent(child) != dev)
4591 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4594 rl = BUS_GET_RESOURCE_LIST(dev, child);
4598 return (resource_list_release(rl, dev, child, type, rid, r));
4602 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4604 * This implementation of BUS_ALLOC_RESOURCE() uses the
4605 * resource_list_alloc() function to do most of the work. It calls
4606 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4609 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4610 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4612 struct resource_list * rl = NULL;
4614 if (device_get_parent(child) != dev)
4615 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4616 type, rid, start, end, count, flags));
4618 rl = BUS_GET_RESOURCE_LIST(dev, child);
4622 return (resource_list_alloc(rl, dev, child, type, rid,
4623 start, end, count, flags));
4627 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4629 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4630 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4633 bus_generic_child_present(device_t dev, device_t child)
4635 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4639 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4642 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4648 * @brief Helper function for implementing BUS_RESCAN().
4650 * This null implementation of BUS_RESCAN() always fails to indicate
4651 * the bus does not support rescanning.
4654 bus_null_rescan(device_t dev)
4660 * Some convenience functions to make it easier for drivers to use the
4661 * resource-management functions. All these really do is hide the
4662 * indirection through the parent's method table, making for slightly
4663 * less-wordy code. In the future, it might make sense for this code
4664 * to maintain some sort of a list of resources allocated by each device.
4668 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4669 struct resource **res)
4673 for (i = 0; rs[i].type != -1; i++)
4675 for (i = 0; rs[i].type != -1; i++) {
4676 res[i] = bus_alloc_resource_any(dev,
4677 rs[i].type, &rs[i].rid, rs[i].flags);
4678 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4679 bus_release_resources(dev, rs, res);
4687 bus_release_resources(device_t dev, const struct resource_spec *rs,
4688 struct resource **res)
4692 for (i = 0; rs[i].type != -1; i++)
4693 if (res[i] != NULL) {
4694 bus_release_resource(
4695 dev, rs[i].type, rs[i].rid, res[i]);
4701 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4703 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4707 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4708 rman_res_t end, rman_res_t count, u_int flags)
4710 struct resource *res;
4712 if (dev->parent == NULL)
4714 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4720 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4722 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4726 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4729 if (dev->parent == NULL)
4731 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4735 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4737 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4741 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4743 if (dev->parent == NULL)
4745 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4749 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4751 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4755 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4757 if (dev->parent == NULL)
4759 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4763 * @brief Wrapper function for BUS_MAP_RESOURCE().
4765 * This function simply calls the BUS_MAP_RESOURCE() method of the
4769 bus_map_resource(device_t dev, int type, struct resource *r,
4770 struct resource_map_request *args, struct resource_map *map)
4772 if (dev->parent == NULL)
4774 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4778 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4780 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4784 bus_unmap_resource(device_t dev, int type, struct resource *r,
4785 struct resource_map *map)
4787 if (dev->parent == NULL)
4789 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4793 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4795 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4799 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4803 if (dev->parent == NULL)
4805 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4810 * @brief Wrapper function for BUS_SETUP_INTR().
4812 * This function simply calls the BUS_SETUP_INTR() method of the
4816 bus_setup_intr(device_t dev, struct resource *r, int flags,
4817 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4821 if (dev->parent == NULL)
4823 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4827 if (handler != NULL && !(flags & INTR_MPSAFE))
4828 device_printf(dev, "[GIANT-LOCKED]\n");
4833 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4835 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4839 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4841 if (dev->parent == NULL)
4843 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4847 * @brief Wrapper function for BUS_SUSPEND_INTR().
4849 * This function simply calls the BUS_SUSPEND_INTR() method of the
4853 bus_suspend_intr(device_t dev, struct resource *r)
4855 if (dev->parent == NULL)
4857 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4861 * @brief Wrapper function for BUS_RESUME_INTR().
4863 * This function simply calls the BUS_RESUME_INTR() method of the
4867 bus_resume_intr(device_t dev, struct resource *r)
4869 if (dev->parent == NULL)
4871 return (BUS_RESUME_INTR(dev->parent, dev, r));
4875 * @brief Wrapper function for BUS_BIND_INTR().
4877 * This function simply calls the BUS_BIND_INTR() method of the
4881 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4883 if (dev->parent == NULL)
4885 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4889 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4891 * This function first formats the requested description into a
4892 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4893 * the parent of @p dev.
4896 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4897 const char *fmt, ...)
4900 char descr[MAXCOMLEN + 1];
4902 if (dev->parent == NULL)
4905 vsnprintf(descr, sizeof(descr), fmt, ap);
4907 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4911 * @brief Wrapper function for BUS_SET_RESOURCE().
4913 * This function simply calls the BUS_SET_RESOURCE() method of the
4917 bus_set_resource(device_t dev, int type, int rid,
4918 rman_res_t start, rman_res_t count)
4920 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4925 * @brief Wrapper function for BUS_GET_RESOURCE().
4927 * This function simply calls the BUS_GET_RESOURCE() method of the
4931 bus_get_resource(device_t dev, int type, int rid,
4932 rman_res_t *startp, rman_res_t *countp)
4934 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4939 * @brief Wrapper function for BUS_GET_RESOURCE().
4941 * This function simply calls the BUS_GET_RESOURCE() method of the
4942 * parent of @p dev and returns the start value.
4945 bus_get_resource_start(device_t dev, int type, int rid)
4951 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4959 * @brief Wrapper function for BUS_GET_RESOURCE().
4961 * This function simply calls the BUS_GET_RESOURCE() method of the
4962 * parent of @p dev and returns the count value.
4965 bus_get_resource_count(device_t dev, int type, int rid)
4971 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4979 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4981 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4985 bus_delete_resource(device_t dev, int type, int rid)
4987 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4991 * @brief Wrapper function for BUS_CHILD_PRESENT().
4993 * This function simply calls the BUS_CHILD_PRESENT() method of the
4997 bus_child_present(device_t child)
4999 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
5003 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
5005 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
5009 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
5013 parent = device_get_parent(child);
5014 if (parent == NULL) {
5018 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
5022 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
5024 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
5028 bus_child_location_str(device_t child, char *buf, size_t buflen)
5032 parent = device_get_parent(child);
5033 if (parent == NULL) {
5037 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
5041 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
5043 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
5044 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
5045 * accomplish this, however. It is an interim function until we can convert
5046 * this interface more fully.
5048 /* Note: we reach inside of sbuf because it's API isn't rich enough to do this */
5049 #define SPACE(s) ((s)->s_size - (s)->s_len)
5050 #define EOB(s) ((s)->s_buf + (s)->s_len)
5053 bus_child_pnpinfo_sb(device_t dev, struct sbuf *sb)
5058 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5059 MPASS(sb->s_size >= sb->s_len);
5060 if (sb->s_error != 0)
5064 sb->s_error = ENOMEM;
5068 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5069 bus_child_pnpinfo_str(dev, p, space);
5070 sb->s_len += strlen(p);
5075 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
5077 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
5078 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
5079 * accomplish this, however. It is an interim function until we can convert
5080 * this interface more fully.
5083 bus_child_location_sb(device_t dev, struct sbuf *sb)
5088 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5089 MPASS(sb->s_size >= sb->s_len);
5090 if (sb->s_error != 0)
5094 sb->s_error = ENOMEM;
5098 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5099 bus_child_location_str(dev, p, space);
5100 sb->s_len += strlen(p);
5107 * @brief Wrapper function for BUS_GET_CPUS().
5109 * This function simply calls the BUS_GET_CPUS() method of the
5113 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5117 parent = device_get_parent(dev);
5120 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5124 * @brief Wrapper function for BUS_GET_DMA_TAG().
5126 * This function simply calls the BUS_GET_DMA_TAG() method of the
5130 bus_get_dma_tag(device_t dev)
5134 parent = device_get_parent(dev);
5137 return (BUS_GET_DMA_TAG(parent, dev));
5141 * @brief Wrapper function for BUS_GET_BUS_TAG().
5143 * This function simply calls the BUS_GET_BUS_TAG() method of the
5147 bus_get_bus_tag(device_t dev)
5151 parent = device_get_parent(dev);
5153 return ((bus_space_tag_t)0);
5154 return (BUS_GET_BUS_TAG(parent, dev));
5158 * @brief Wrapper function for BUS_GET_DOMAIN().
5160 * This function simply calls the BUS_GET_DOMAIN() method of the
5164 bus_get_domain(device_t dev, int *domain)
5166 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5169 /* Resume all devices and then notify userland that we're up again. */
5171 root_resume(device_t dev)
5175 error = bus_generic_resume(dev);
5177 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5178 devctl_notify("kernel", "power", "resume", NULL);
5184 root_print_child(device_t dev, device_t child)
5188 retval += bus_print_child_header(dev, child);
5189 retval += printf("\n");
5195 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5196 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5199 * If an interrupt mapping gets to here something bad has happened.
5201 panic("root_setup_intr");
5205 * If we get here, assume that the device is permanent and really is
5206 * present in the system. Removable bus drivers are expected to intercept
5207 * this call long before it gets here. We return -1 so that drivers that
5208 * really care can check vs -1 or some ERRNO returned higher in the food
5212 root_child_present(device_t dev, device_t child)
5218 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5223 /* Default to returning the set of all CPUs. */
5224 if (setsize != sizeof(cpuset_t))
5233 static kobj_method_t root_methods[] = {
5234 /* Device interface */
5235 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5236 KOBJMETHOD(device_suspend, bus_generic_suspend),
5237 KOBJMETHOD(device_resume, root_resume),
5240 KOBJMETHOD(bus_print_child, root_print_child),
5241 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5242 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5243 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5244 KOBJMETHOD(bus_child_present, root_child_present),
5245 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5250 static driver_t root_driver = {
5257 devclass_t root_devclass;
5260 root_bus_module_handler(module_t mod, int what, void* arg)
5264 TAILQ_INIT(&bus_data_devices);
5265 kobj_class_compile((kobj_class_t) &root_driver);
5266 root_bus = make_device(NULL, "root", 0);
5267 root_bus->desc = "System root bus";
5268 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5269 root_bus->driver = &root_driver;
5270 root_bus->state = DS_ATTACHED;
5271 root_devclass = devclass_find_internal("root", NULL, FALSE);
5276 device_shutdown(root_bus);
5279 return (EOPNOTSUPP);
5285 static moduledata_t root_bus_mod = {
5287 root_bus_module_handler,
5290 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5293 * @brief Automatically configure devices
5295 * This function begins the autoconfiguration process by calling
5296 * device_probe_and_attach() for each child of the @c root0 device.
5299 root_bus_configure(void)
5303 /* Eventually this will be split up, but this is sufficient for now. */
5304 bus_set_pass(BUS_PASS_DEFAULT);
5308 * @brief Module handler for registering device drivers
5310 * This module handler is used to automatically register device
5311 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5312 * devclass_add_driver() for the driver described by the
5313 * driver_module_data structure pointed to by @p arg
5316 driver_module_handler(module_t mod, int what, void *arg)
5318 struct driver_module_data *dmd;
5319 devclass_t bus_devclass;
5320 kobj_class_t driver;
5323 dmd = (struct driver_module_data *)arg;
5324 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5329 if (dmd->dmd_chainevh)
5330 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5332 pass = dmd->dmd_pass;
5333 driver = dmd->dmd_driver;
5334 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5335 DRIVERNAME(driver), dmd->dmd_busname, pass));
5336 error = devclass_add_driver(bus_devclass, driver, pass,
5341 PDEBUG(("Unloading module: driver %s from bus %s",
5342 DRIVERNAME(dmd->dmd_driver),
5344 error = devclass_delete_driver(bus_devclass,
5347 if (!error && dmd->dmd_chainevh)
5348 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5351 PDEBUG(("Quiesce module: driver %s from bus %s",
5352 DRIVERNAME(dmd->dmd_driver),
5354 error = devclass_quiesce_driver(bus_devclass,
5357 if (!error && dmd->dmd_chainevh)
5358 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5369 * @brief Enumerate all hinted devices for this bus.
5371 * Walks through the hints for this bus and calls the bus_hinted_child
5372 * routine for each one it fines. It searches first for the specific
5373 * bus that's being probed for hinted children (eg isa0), and then for
5374 * generic children (eg isa).
5376 * @param dev bus device to enumerate
5379 bus_enumerate_hinted_children(device_t bus)
5382 const char *dname, *busname;
5386 * enumerate all devices on the specific bus
5388 busname = device_get_nameunit(bus);
5390 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5391 BUS_HINTED_CHILD(bus, dname, dunit);
5394 * and all the generic ones.
5396 busname = device_get_name(bus);
5398 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5399 BUS_HINTED_CHILD(bus, dname, dunit);
5404 /* the _short versions avoid iteration by not calling anything that prints
5405 * more than oneliners. I love oneliners.
5409 print_device_short(device_t dev, int indent)
5414 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5415 dev->unit, dev->desc,
5416 (dev->parent? "":"no "),
5417 (TAILQ_EMPTY(&dev->children)? "no ":""),
5418 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5419 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5420 (dev->flags&DF_WILDCARD? "wildcard,":""),
5421 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5422 (dev->flags&DF_SUSPENDED? "suspended,":""),
5423 (dev->ivars? "":"no "),
5424 (dev->softc? "":"no "),
5429 print_device(device_t dev, int indent)
5434 print_device_short(dev, indent);
5436 indentprintf(("Parent:\n"));
5437 print_device_short(dev->parent, indent+1);
5438 indentprintf(("Driver:\n"));
5439 print_driver_short(dev->driver, indent+1);
5440 indentprintf(("Devclass:\n"));
5441 print_devclass_short(dev->devclass, indent+1);
5445 print_device_tree_short(device_t dev, int indent)
5446 /* print the device and all its children (indented) */
5453 print_device_short(dev, indent);
5455 TAILQ_FOREACH(child, &dev->children, link) {
5456 print_device_tree_short(child, indent+1);
5461 print_device_tree(device_t dev, int indent)
5462 /* print the device and all its children (indented) */
5469 print_device(dev, indent);
5471 TAILQ_FOREACH(child, &dev->children, link) {
5472 print_device_tree(child, indent+1);
5477 print_driver_short(driver_t *driver, int indent)
5482 indentprintf(("driver %s: softc size = %zd\n",
5483 driver->name, driver->size));
5487 print_driver(driver_t *driver, int indent)
5492 print_driver_short(driver, indent);
5496 print_driver_list(driver_list_t drivers, int indent)
5498 driverlink_t driver;
5500 TAILQ_FOREACH(driver, &drivers, link) {
5501 print_driver(driver->driver, indent);
5506 print_devclass_short(devclass_t dc, int indent)
5511 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5515 print_devclass(devclass_t dc, int indent)
5522 print_devclass_short(dc, indent);
5523 indentprintf(("Drivers:\n"));
5524 print_driver_list(dc->drivers, indent+1);
5526 indentprintf(("Devices:\n"));
5527 for (i = 0; i < dc->maxunit; i++)
5529 print_device(dc->devices[i], indent+1);
5533 print_devclass_list_short(void)
5537 printf("Short listing of devclasses, drivers & devices:\n");
5538 TAILQ_FOREACH(dc, &devclasses, link) {
5539 print_devclass_short(dc, 0);
5544 print_devclass_list(void)
5548 printf("Full listing of devclasses, drivers & devices:\n");
5549 TAILQ_FOREACH(dc, &devclasses, link) {
5550 print_devclass(dc, 0);
5557 * User-space access to the device tree.
5559 * We implement a small set of nodes:
5561 * hw.bus Single integer read method to obtain the
5562 * current generation count.
5563 * hw.bus.devices Reads the entire device tree in flat space.
5564 * hw.bus.rman Resource manager interface
5566 * We might like to add the ability to scan devclasses and/or drivers to
5567 * determine what else is currently loaded/available.
5571 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5573 struct u_businfo ubus;
5575 ubus.ub_version = BUS_USER_VERSION;
5576 ubus.ub_generation = bus_data_generation;
5578 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5580 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5581 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5582 "bus-related data");
5585 sysctl_devices(SYSCTL_HANDLER_ARGS)
5588 int *name = (int *)arg1;
5589 u_int namelen = arg2;
5592 struct u_device *udev;
5598 if (bus_data_generation_check(name[0]))
5604 * Scan the list of devices, looking for the requested index.
5606 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5614 * Populate the return item, careful not to overflow the buffer.
5616 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5619 udev->dv_handle = (uintptr_t)dev;
5620 udev->dv_parent = (uintptr_t)dev->parent;
5621 udev->dv_devflags = dev->devflags;
5622 udev->dv_flags = dev->flags;
5623 udev->dv_state = dev->state;
5624 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5625 if (dev->nameunit != NULL)
5626 sbuf_cat(&sb, dev->nameunit);
5627 sbuf_putc(&sb, '\0');
5628 if (dev->desc != NULL)
5629 sbuf_cat(&sb, dev->desc);
5630 sbuf_putc(&sb, '\0');
5631 if (dev->driver != NULL)
5632 sbuf_cat(&sb, dev->driver->name);
5633 sbuf_putc(&sb, '\0');
5634 bus_child_pnpinfo_sb(dev, &sb);
5635 sbuf_putc(&sb, '\0');
5636 bus_child_location_sb(dev, &sb);
5637 sbuf_putc(&sb, '\0');
5638 error = sbuf_finish(&sb);
5640 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5646 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5647 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5648 "system device tree");
5651 bus_data_generation_check(int generation)
5653 if (generation != bus_data_generation)
5656 /* XXX generate optimised lists here? */
5661 bus_data_generation_update(void)
5663 atomic_add_int(&bus_data_generation, 1);
5667 bus_free_resource(device_t dev, int type, struct resource *r)
5671 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5675 device_lookup_by_name(const char *name)
5679 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5680 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5687 * /dev/devctl2 implementation. The existing /dev/devctl device has
5688 * implicit semantics on open, so it could not be reused for this.
5689 * Another option would be to call this /dev/bus?
5692 find_device(struct devreq *req, device_t *devp)
5697 * First, ensure that the name is nul terminated.
5699 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5703 * Second, try to find an attached device whose name matches
5706 dev = device_lookup_by_name(req->dr_name);
5712 /* Finally, give device enumerators a chance. */
5714 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5722 driver_exists(device_t bus, const char *driver)
5726 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5727 if (devclass_find_driver_internal(dc, driver) != NULL)
5734 device_gen_nomatch(device_t dev)
5738 if (dev->flags & DF_NEEDNOMATCH &&
5739 dev->state == DS_NOTPRESENT) {
5740 BUS_PROBE_NOMATCH(dev->parent, dev);
5742 dev->flags |= DF_DONENOMATCH;
5744 dev->flags &= ~DF_NEEDNOMATCH;
5745 TAILQ_FOREACH(child, &dev->children, link) {
5746 device_gen_nomatch(child);
5751 device_do_deferred_actions(void)
5757 * Walk through the devclasses to find all the drivers we've tagged as
5758 * deferred during the freeze and call the driver added routines. They
5759 * have already been added to the lists in the background, so the driver
5760 * added routines that trigger a probe will have all the right bidders
5761 * for the probe auction.
5763 TAILQ_FOREACH(dc, &devclasses, link) {
5764 TAILQ_FOREACH(dl, &dc->drivers, link) {
5765 if (dl->flags & DL_DEFERRED_PROBE) {
5766 devclass_driver_added(dc, dl->driver);
5767 dl->flags &= ~DL_DEFERRED_PROBE;
5773 * We also defer no-match events during a freeze. Walk the tree and
5774 * generate all the pent-up events that are still relevant.
5776 device_gen_nomatch(root_bus);
5777 bus_data_generation_update();
5781 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5788 /* Locate the device to control. */
5790 req = (struct devreq *)data;
5798 case DEV_SET_DRIVER:
5799 case DEV_CLEAR_DRIVER:
5803 error = priv_check(td, PRIV_DRIVER);
5805 error = find_device(req, &dev);
5809 error = priv_check(td, PRIV_DRIVER);
5820 /* Perform the requested operation. */
5823 if (device_is_attached(dev))
5825 else if (!device_is_enabled(dev))
5828 error = device_probe_and_attach(dev);
5831 if (!device_is_attached(dev)) {
5835 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5836 error = device_quiesce(dev);
5840 error = device_detach(dev);
5843 if (device_is_enabled(dev)) {
5849 * If the device has been probed but not attached (e.g.
5850 * when it has been disabled by a loader hint), just
5851 * attach the device rather than doing a full probe.
5854 if (device_is_alive(dev)) {
5856 * If the device was disabled via a hint, clear
5859 if (resource_disabled(dev->driver->name, dev->unit))
5860 resource_unset_value(dev->driver->name,
5861 dev->unit, "disabled");
5862 error = device_attach(dev);
5864 error = device_probe_and_attach(dev);
5867 if (!device_is_enabled(dev)) {
5872 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5873 error = device_quiesce(dev);
5879 * Force DF_FIXEDCLASS on around detach to preserve
5880 * the existing name.
5883 dev->flags |= DF_FIXEDCLASS;
5884 error = device_detach(dev);
5885 if (!(old & DF_FIXEDCLASS))
5886 dev->flags &= ~DF_FIXEDCLASS;
5888 device_disable(dev);
5891 if (device_is_suspended(dev)) {
5895 if (device_get_parent(dev) == NULL) {
5899 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5902 if (!device_is_suspended(dev)) {
5906 if (device_get_parent(dev) == NULL) {
5910 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5912 case DEV_SET_DRIVER: {
5916 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5919 if (driver[0] == '\0') {
5923 if (dev->devclass != NULL &&
5924 strcmp(driver, dev->devclass->name) == 0)
5925 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5929 * Scan drivers for this device's bus looking for at
5930 * least one matching driver.
5932 if (dev->parent == NULL) {
5936 if (!driver_exists(dev->parent, driver)) {
5940 dc = devclass_create(driver);
5946 /* Detach device if necessary. */
5947 if (device_is_attached(dev)) {
5948 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5949 error = device_detach(dev);
5956 /* Clear any previously-fixed device class and unit. */
5957 if (dev->flags & DF_FIXEDCLASS)
5958 devclass_delete_device(dev->devclass, dev);
5959 dev->flags |= DF_WILDCARD;
5962 /* Force the new device class. */
5963 error = devclass_add_device(dc, dev);
5966 dev->flags |= DF_FIXEDCLASS;
5967 error = device_probe_and_attach(dev);
5970 case DEV_CLEAR_DRIVER:
5971 if (!(dev->flags & DF_FIXEDCLASS)) {
5975 if (device_is_attached(dev)) {
5976 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5977 error = device_detach(dev);
5984 dev->flags &= ~DF_FIXEDCLASS;
5985 dev->flags |= DF_WILDCARD;
5986 devclass_delete_device(dev->devclass, dev);
5987 error = device_probe_and_attach(dev);
5990 if (!device_is_attached(dev)) {
5994 error = BUS_RESCAN(dev);
5999 parent = device_get_parent(dev);
6000 if (parent == NULL) {
6004 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
6005 if (bus_child_present(dev) != 0) {
6011 error = device_delete_child(parent, dev);
6018 device_frozen = true;
6024 device_do_deferred_actions();
6025 device_frozen = false;
6029 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
6033 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
6041 static struct cdevsw devctl2_cdevsw = {
6042 .d_version = D_VERSION,
6043 .d_ioctl = devctl2_ioctl,
6044 .d_name = "devctl2",
6050 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
6051 UID_ROOT, GID_WHEEL, 0600, "devctl2");
6055 * APIs to manage deprecation and obsolescence.
6057 static int obsolete_panic = 0;
6058 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
6059 "Panic when obsolete features are used (0 = never, 1 = if obsolete, "
6060 "2 = if deprecated)");
6063 gone_panic(int major, int running, const char *msg)
6065 switch (obsolete_panic)
6070 if (running < major)
6079 _gone_in(int major, const char *msg)
6081 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6082 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6083 printf("Obsolete code will be removed soon: %s\n", msg);
6085 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
6090 _gone_in_dev(device_t dev, int major, const char *msg)
6092 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6093 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6095 "Obsolete code will be removed soon: %s\n", msg);
6098 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6103 DB_SHOW_COMMAND(device, db_show_device)
6110 dev = (device_t)addr;
6112 db_printf("name: %s\n", device_get_nameunit(dev));
6113 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6114 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6115 db_printf(" addr: %p\n", dev);
6116 db_printf(" parent: %p\n", dev->parent);
6117 db_printf(" softc: %p\n", dev->softc);
6118 db_printf(" ivars: %p\n", dev->ivars);
6121 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6125 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6126 db_show_device((db_expr_t)dev, true, count, modif);