2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
77 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
81 * Used to attach drivers to devclasses.
83 typedef struct driverlink *driverlink_t;
86 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
89 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
90 TAILQ_ENTRY(driverlink) passlink;
94 * Forward declarations
96 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
97 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
98 typedef TAILQ_HEAD(device_list, _device) device_list_t;
101 TAILQ_ENTRY(devclass) link;
102 devclass_t parent; /* parent in devclass hierarchy */
103 driver_list_t drivers; /* bus devclasses store drivers for bus */
105 device_t *devices; /* array of devices indexed by unit */
106 int maxunit; /* size of devices array */
108 #define DC_HAS_CHILDREN 1
110 struct sysctl_ctx_list sysctl_ctx;
111 struct sysctl_oid *sysctl_tree;
115 * @brief Implementation of _device.
117 * The structure is named "_device" instead of "device" to avoid type confusion
118 * caused by other subsystems defining a (struct device).
122 * A device is a kernel object. The first field must be the
123 * current ops table for the object.
130 TAILQ_ENTRY(_device) link; /**< list of devices in parent */
131 TAILQ_ENTRY(_device) devlink; /**< global device list membership */
132 device_t parent; /**< parent of this device */
133 device_list_t children; /**< list of child devices */
136 * Details of this device.
138 driver_t *driver; /**< current driver */
139 devclass_t devclass; /**< current device class */
140 int unit; /**< current unit number */
141 char* nameunit; /**< name+unit e.g. foodev0 */
142 char* desc; /**< driver specific description */
143 int busy; /**< count of calls to device_busy() */
144 device_state_t state; /**< current device state */
145 uint32_t devflags; /**< api level flags for device_get_flags() */
146 u_int flags; /**< internal device flags */
147 u_int order; /**< order from device_add_child_ordered() */
148 void *ivars; /**< instance variables */
149 void *softc; /**< current driver's variables */
151 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
152 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
155 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
156 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
158 EVENTHANDLER_LIST_DEFINE(device_attach);
159 EVENTHANDLER_LIST_DEFINE(device_detach);
160 EVENTHANDLER_LIST_DEFINE(dev_lookup);
162 static int bus_child_location_sb(device_t child, struct sbuf *sb);
163 static int bus_child_pnpinfo_sb(device_t child, struct sbuf *sb);
164 static void devctl2_init(void);
165 static bool device_frozen;
167 #define DRIVERNAME(d) ((d)? d->name : "no driver")
168 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
172 static int bus_debug = 1;
173 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
175 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
176 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
179 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
180 * prevent syslog from deleting initial spaces
182 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
184 static void print_device_short(device_t dev, int indent);
185 static void print_device(device_t dev, int indent);
186 void print_device_tree_short(device_t dev, int indent);
187 void print_device_tree(device_t dev, int indent);
188 static void print_driver_short(driver_t *driver, int indent);
189 static void print_driver(driver_t *driver, int indent);
190 static void print_driver_list(driver_list_t drivers, int indent);
191 static void print_devclass_short(devclass_t dc, int indent);
192 static void print_devclass(devclass_t dc, int indent);
193 void print_devclass_list_short(void);
194 void print_devclass_list(void);
197 /* Make the compiler ignore the function calls */
198 #define PDEBUG(a) /* nop */
199 #define DEVICENAME(d) /* nop */
201 #define print_device_short(d,i) /* nop */
202 #define print_device(d,i) /* nop */
203 #define print_device_tree_short(d,i) /* nop */
204 #define print_device_tree(d,i) /* nop */
205 #define print_driver_short(d,i) /* nop */
206 #define print_driver(d,i) /* nop */
207 #define print_driver_list(d,i) /* nop */
208 #define print_devclass_short(d,i) /* nop */
209 #define print_devclass(d,i) /* nop */
210 #define print_devclass_list_short() /* nop */
211 #define print_devclass_list() /* nop */
219 DEVCLASS_SYSCTL_PARENT,
223 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
225 devclass_t dc = (devclass_t)arg1;
229 case DEVCLASS_SYSCTL_PARENT:
230 value = dc->parent ? dc->parent->name : "";
235 return (SYSCTL_OUT_STR(req, value));
239 devclass_sysctl_init(devclass_t dc)
241 if (dc->sysctl_tree != NULL)
243 sysctl_ctx_init(&dc->sysctl_ctx);
244 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
245 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
246 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
247 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
249 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
250 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
256 DEVICE_SYSCTL_DRIVER,
257 DEVICE_SYSCTL_LOCATION,
258 DEVICE_SYSCTL_PNPINFO,
259 DEVICE_SYSCTL_PARENT,
263 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
266 device_t dev = (device_t)arg1;
269 sbuf_new_for_sysctl(&sb, NULL, 1024, req);
270 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
272 case DEVICE_SYSCTL_DESC:
273 sbuf_cat(&sb, dev->desc ? dev->desc : "");
275 case DEVICE_SYSCTL_DRIVER:
276 sbuf_cat(&sb, dev->driver ? dev->driver->name : "");
278 case DEVICE_SYSCTL_LOCATION:
279 bus_child_location_sb(dev, &sb);
281 case DEVICE_SYSCTL_PNPINFO:
282 bus_child_pnpinfo_sb(dev, &sb);
284 case DEVICE_SYSCTL_PARENT:
285 sbuf_cat(&sb, dev->parent ? dev->parent->nameunit : "");
291 error = sbuf_finish(&sb);
297 device_sysctl_init(device_t dev)
299 devclass_t dc = dev->devclass;
302 if (dev->sysctl_tree != NULL)
304 devclass_sysctl_init(dc);
305 sysctl_ctx_init(&dev->sysctl_ctx);
306 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
307 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
308 dev->nameunit + strlen(dc->name),
309 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
310 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
311 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
312 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
313 "device description");
314 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
316 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
317 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
318 "device driver name");
319 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
320 OID_AUTO, "%location",
321 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
322 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
323 "device location relative to parent");
324 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
325 OID_AUTO, "%pnpinfo",
326 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
327 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
328 "device identification");
329 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
331 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
332 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
334 if (bus_get_domain(dev, &domain) == 0)
335 SYSCTL_ADD_INT(&dev->sysctl_ctx,
336 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
337 CTLFLAG_RD, NULL, domain, "NUMA domain");
341 device_sysctl_update(device_t dev)
343 devclass_t dc = dev->devclass;
345 if (dev->sysctl_tree == NULL)
347 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
351 device_sysctl_fini(device_t dev)
353 if (dev->sysctl_tree == NULL)
355 sysctl_ctx_free(&dev->sysctl_ctx);
356 dev->sysctl_tree = NULL;
360 * /dev/devctl implementation
364 * This design allows only one reader for /dev/devctl. This is not desirable
365 * in the long run, but will get a lot of hair out of this implementation.
366 * Maybe we should make this device a clonable device.
368 * Also note: we specifically do not attach a device to the device_t tree
369 * to avoid potential chicken and egg problems. One could argue that all
370 * of this belongs to the root node.
373 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
374 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
375 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
376 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
377 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
379 static d_open_t devopen;
380 static d_close_t devclose;
381 static d_read_t devread;
382 static d_ioctl_t devioctl;
383 static d_poll_t devpoll;
384 static d_kqfilter_t devkqfilter;
386 static struct cdevsw dev_cdevsw = {
387 .d_version = D_VERSION,
393 .d_kqfilter = devkqfilter,
397 #define DEVCTL_BUFFER (1024 - sizeof(void *))
398 struct dev_event_info {
399 STAILQ_ENTRY(dev_event_info) dei_link;
400 char dei_data[DEVCTL_BUFFER];
403 STAILQ_HEAD(devq, dev_event_info);
405 static struct dev_softc {
418 static void filt_devctl_detach(struct knote *kn);
419 static int filt_devctl_read(struct knote *kn, long hint);
421 struct filterops devctl_rfiltops = {
423 .f_detach = filt_devctl_detach,
424 .f_event = filt_devctl_read,
427 static struct cdev *devctl_dev;
435 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
436 UID_ROOT, GID_WHEEL, 0600, "devctl");
437 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
438 cv_init(&devsoftc.cv, "dev cv");
439 STAILQ_INIT(&devsoftc.devq);
440 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
441 if (devctl_queue_length > 0) {
443 * Allocate a zone for the messages. Preallocate 2% of these for
444 * a reserve. Allow only devctl_queue_length slabs to cap memory
445 * usage. The reserve usually allows coverage of surges of
446 * events during memory shortages. Normally we won't have to
447 * re-use events from the queue, but will in extreme shortages.
449 z = devsoftc.zone = uma_zcreate("DEVCTL",
450 sizeof(struct dev_event_info), NULL, NULL, NULL, NULL,
452 reserve = max(devctl_queue_length / 50, 100); /* 2% reserve */
453 uma_zone_set_max(z, devctl_queue_length);
454 uma_zone_set_maxcache(z, 0);
455 uma_zone_reserve(z, reserve);
456 uma_prealloc(z, reserve);
462 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
464 mtx_lock(&devsoftc.mtx);
465 if (devsoftc.inuse) {
466 mtx_unlock(&devsoftc.mtx);
471 mtx_unlock(&devsoftc.mtx);
476 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
478 mtx_lock(&devsoftc.mtx);
480 devsoftc.nonblock = 0;
482 cv_broadcast(&devsoftc.cv);
483 funsetown(&devsoftc.sigio);
484 mtx_unlock(&devsoftc.mtx);
489 * The read channel for this device is used to report changes to
490 * userland in realtime. We are required to free the data as well as
491 * the n1 object because we allocate them separately. Also note that
492 * we return one record at a time. If you try to read this device a
493 * character at a time, you will lose the rest of the data. Listening
494 * programs are expected to cope.
497 devread(struct cdev *dev, struct uio *uio, int ioflag)
499 struct dev_event_info *n1;
502 mtx_lock(&devsoftc.mtx);
503 while (STAILQ_EMPTY(&devsoftc.devq)) {
504 if (devsoftc.nonblock) {
505 mtx_unlock(&devsoftc.mtx);
508 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
511 * Need to translate ERESTART to EINTR here? -- jake
513 mtx_unlock(&devsoftc.mtx);
517 n1 = STAILQ_FIRST(&devsoftc.devq);
518 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
520 mtx_unlock(&devsoftc.mtx);
521 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
522 uma_zfree(devsoftc.zone, n1);
527 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
532 devsoftc.nonblock = 1;
534 devsoftc.nonblock = 0;
543 return fsetown(*(int *)data, &devsoftc.sigio);
545 *(int *)data = fgetown(&devsoftc.sigio);
548 /* (un)Support for other fcntl() calls. */
559 devpoll(struct cdev *dev, int events, struct thread *td)
563 mtx_lock(&devsoftc.mtx);
564 if (events & (POLLIN | POLLRDNORM)) {
565 if (!STAILQ_EMPTY(&devsoftc.devq))
566 revents = events & (POLLIN | POLLRDNORM);
568 selrecord(td, &devsoftc.sel);
570 mtx_unlock(&devsoftc.mtx);
576 devkqfilter(struct cdev *dev, struct knote *kn)
580 if (kn->kn_filter == EVFILT_READ) {
581 kn->kn_fop = &devctl_rfiltops;
582 knlist_add(&devsoftc.sel.si_note, kn, 0);
590 filt_devctl_detach(struct knote *kn)
592 knlist_remove(&devsoftc.sel.si_note, kn, 0);
596 filt_devctl_read(struct knote *kn, long hint)
598 kn->kn_data = devsoftc.queued;
599 return (kn->kn_data != 0);
603 * @brief Return whether the userland process is running
606 devctl_process_running(void)
608 return (devsoftc.inuse == 1);
611 static struct dev_event_info *
612 devctl_alloc_dei(void)
614 struct dev_event_info *dei = NULL;
616 mtx_lock(&devsoftc.mtx);
617 if (devctl_queue_length == 0)
619 dei = uma_zalloc(devsoftc.zone, M_NOWAIT);
621 dei = uma_zalloc(devsoftc.zone, M_NOWAIT | M_USE_RESERVE);
624 * Guard against no items in the queue. Normally, this won't
625 * happen, but if lots of events happen all at once and there's
626 * a chance we're out of allocated space but none have yet been
627 * queued when we get here, leaving nothing to steal. This can
628 * also happen with error injection. Fail safe by returning
629 * NULL in that case..
631 if (devsoftc.queued == 0)
633 dei = STAILQ_FIRST(&devsoftc.devq);
634 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
638 *dei->dei_data = '\0';
640 mtx_unlock(&devsoftc.mtx);
644 static struct dev_event_info *
645 devctl_alloc_dei_sb(struct sbuf *sb)
647 struct dev_event_info *dei;
649 dei = devctl_alloc_dei();
651 sbuf_new(sb, dei->dei_data, sizeof(dei->dei_data), SBUF_FIXEDLEN);
656 devctl_free_dei(struct dev_event_info *dei)
658 uma_zfree(devsoftc.zone, dei);
662 devctl_queue(struct dev_event_info *dei)
664 mtx_lock(&devsoftc.mtx);
665 STAILQ_INSERT_TAIL(&devsoftc.devq, dei, dei_link);
667 cv_broadcast(&devsoftc.cv);
668 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
669 mtx_unlock(&devsoftc.mtx);
670 selwakeup(&devsoftc.sel);
671 if (devsoftc.async && devsoftc.sigio != NULL)
672 pgsigio(&devsoftc.sigio, SIGIO, 0);
676 * @brief Send a 'notification' to userland, using standard ways
679 devctl_notify(const char *system, const char *subsystem, const char *type,
682 struct dev_event_info *dei;
685 if (system == NULL || subsystem == NULL || type == NULL)
687 dei = devctl_alloc_dei_sb(&sb);
690 sbuf_cpy(&sb, "!system=");
691 sbuf_cat(&sb, system);
692 sbuf_cat(&sb, " subsystem=");
693 sbuf_cat(&sb, subsystem);
694 sbuf_cat(&sb, " type=");
700 sbuf_putc(&sb, '\n');
701 if (sbuf_finish(&sb) != 0)
702 devctl_free_dei(dei); /* overflow -> drop it */
708 * Common routine that tries to make sending messages as easy as possible.
709 * We allocate memory for the data, copy strings into that, but do not
710 * free it unless there's an error. The dequeue part of the driver should
711 * free the data. We don't send data when the device is disabled. We do
712 * send data, even when we have no listeners, because we wish to avoid
713 * races relating to startup and restart of listening applications.
715 * devaddq is designed to string together the type of event, with the
716 * object of that event, plus the plug and play info and location info
717 * for that event. This is likely most useful for devices, but less
718 * useful for other consumers of this interface. Those should use
719 * the devctl_notify() interface instead.
722 * ${type}${what} at $(location dev) $(pnp-info dev) on $(parent dev)
725 devaddq(const char *type, const char *what, device_t dev)
727 struct dev_event_info *dei;
731 dei = devctl_alloc_dei_sb(&sb);
736 sbuf_cat(&sb, " at ");
738 /* Add in the location */
739 bus_child_location_sb(dev, &sb);
743 bus_child_pnpinfo_sb(dev, &sb);
745 /* Get the parent of this device, or / if high enough in the tree. */
746 if (device_get_parent(dev) == NULL)
747 parstr = "."; /* Or '/' ? */
749 parstr = device_get_nameunit(device_get_parent(dev));
750 sbuf_cat(&sb, " on ");
751 sbuf_cat(&sb, parstr);
752 sbuf_putc(&sb, '\n');
753 if (sbuf_finish(&sb) != 0)
758 devctl_free_dei(dei);
762 * A device was added to the tree. We are called just after it successfully
763 * attaches (that is, probe and attach success for this device). No call
764 * is made if a device is merely parented into the tree. See devnomatch
765 * if probe fails. If attach fails, no notification is sent (but maybe
766 * we should have a different message for this).
769 devadded(device_t dev)
771 devaddq("+", device_get_nameunit(dev), dev);
775 * A device was removed from the tree. We are called just before this
779 devremoved(device_t dev)
781 devaddq("-", device_get_nameunit(dev), dev);
785 * Called when there's no match for this device. This is only called
786 * the first time that no match happens, so we don't keep getting this
787 * message. Should that prove to be undesirable, we can change it.
788 * This is called when all drivers that can attach to a given bus
789 * decline to accept this device. Other errors may not be detected.
792 devnomatch(device_t dev)
794 devaddq("?", "", dev);
798 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
802 q = devctl_queue_length;
803 error = sysctl_handle_int(oidp, &q, 0, req);
804 if (error || !req->newptr)
810 * When set as a tunable, we've not yet initialized the mutex.
811 * It is safe to just assign to devctl_queue_length and return
812 * as we're racing no one. We'll use whatever value set in
815 if (!mtx_initialized(&devsoftc.mtx)) {
816 devctl_queue_length = q;
821 * XXX It's hard to grow or shrink the UMA zone. Only allow
822 * disabling the queue size for the moment until underlying
823 * UMA issues can be sorted out.
827 if (q == devctl_queue_length)
829 mtx_lock(&devsoftc.mtx);
830 devctl_queue_length = 0;
831 uma_zdestroy(devsoftc.zone);
833 mtx_unlock(&devsoftc.mtx);
838 * @brief safely quotes strings that might have double quotes in them.
840 * The devctl protocol relies on quoted strings having matching quotes.
841 * This routine quotes any internal quotes so the resulting string
842 * is safe to pass to snprintf to construct, for example pnp info strings.
844 * @param sb sbuf to place the characters into
845 * @param src Original buffer.
848 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
850 while (*src != '\0') {
851 if (*src == '"' || *src == '\\')
853 sbuf_putc(sb, *src++);
857 /* End of /dev/devctl code */
859 static struct device_list bus_data_devices;
860 static int bus_data_generation = 1;
862 static kobj_method_t null_methods[] = {
866 DEFINE_CLASS(null, null_methods, 0);
869 * Bus pass implementation
872 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
873 int bus_current_pass = BUS_PASS_ROOT;
877 * @brief Register the pass level of a new driver attachment
879 * Register a new driver attachment's pass level. If no driver
880 * attachment with the same pass level has been added, then @p new
881 * will be added to the global passes list.
883 * @param new the new driver attachment
886 driver_register_pass(struct driverlink *new)
888 struct driverlink *dl;
890 /* We only consider pass numbers during boot. */
891 if (bus_current_pass == BUS_PASS_DEFAULT)
895 * Walk the passes list. If we already know about this pass
896 * then there is nothing to do. If we don't, then insert this
897 * driver link into the list.
899 TAILQ_FOREACH(dl, &passes, passlink) {
900 if (dl->pass < new->pass)
902 if (dl->pass == new->pass)
904 TAILQ_INSERT_BEFORE(dl, new, passlink);
907 TAILQ_INSERT_TAIL(&passes, new, passlink);
911 * @brief Raise the current bus pass
913 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
914 * method on the root bus to kick off a new device tree scan for each
915 * new pass level that has at least one driver.
918 bus_set_pass(int pass)
920 struct driverlink *dl;
922 if (bus_current_pass > pass)
923 panic("Attempt to lower bus pass level");
925 TAILQ_FOREACH(dl, &passes, passlink) {
926 /* Skip pass values below the current pass level. */
927 if (dl->pass <= bus_current_pass)
931 * Bail once we hit a driver with a pass level that is
938 * Raise the pass level to the next level and rescan
941 bus_current_pass = dl->pass;
942 BUS_NEW_PASS(root_bus);
946 * If there isn't a driver registered for the requested pass,
947 * then bus_current_pass might still be less than 'pass'. Set
948 * it to 'pass' in that case.
950 if (bus_current_pass < pass)
951 bus_current_pass = pass;
952 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
956 * Devclass implementation
959 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
963 * @brief Find or create a device class
965 * If a device class with the name @p classname exists, return it,
966 * otherwise if @p create is non-zero create and return a new device
969 * If @p parentname is non-NULL, the parent of the devclass is set to
970 * the devclass of that name.
972 * @param classname the devclass name to find or create
973 * @param parentname the parent devclass name or @c NULL
974 * @param create non-zero to create a devclass
977 devclass_find_internal(const char *classname, const char *parentname,
982 PDEBUG(("looking for %s", classname));
986 TAILQ_FOREACH(dc, &devclasses, link) {
987 if (!strcmp(dc->name, classname))
992 PDEBUG(("creating %s", classname));
993 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
994 M_BUS, M_NOWAIT | M_ZERO);
998 dc->name = (char*) (dc + 1);
999 strcpy(dc->name, classname);
1000 TAILQ_INIT(&dc->drivers);
1001 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1003 bus_data_generation_update();
1007 * If a parent class is specified, then set that as our parent so
1008 * that this devclass will support drivers for the parent class as
1009 * well. If the parent class has the same name don't do this though
1010 * as it creates a cycle that can trigger an infinite loop in
1011 * device_probe_child() if a device exists for which there is no
1014 if (parentname && dc && !dc->parent &&
1015 strcmp(classname, parentname) != 0) {
1016 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1017 dc->parent->flags |= DC_HAS_CHILDREN;
1024 * @brief Create a device class
1026 * If a device class with the name @p classname exists, return it,
1027 * otherwise create and return a new device class.
1029 * @param classname the devclass name to find or create
1032 devclass_create(const char *classname)
1034 return (devclass_find_internal(classname, NULL, TRUE));
1038 * @brief Find a device class
1040 * If a device class with the name @p classname exists, return it,
1041 * otherwise return @c NULL.
1043 * @param classname the devclass name to find
1046 devclass_find(const char *classname)
1048 return (devclass_find_internal(classname, NULL, FALSE));
1052 * @brief Register that a device driver has been added to a devclass
1054 * Register that a device driver has been added to a devclass. This
1055 * is called by devclass_add_driver to accomplish the recursive
1056 * notification of all the children classes of dc, as well as dc.
1057 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1060 * We do a full search here of the devclass list at each iteration
1061 * level to save storing children-lists in the devclass structure. If
1062 * we ever move beyond a few dozen devices doing this, we may need to
1065 * @param dc the devclass to edit
1066 * @param driver the driver that was just added
1069 devclass_driver_added(devclass_t dc, driver_t *driver)
1075 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1077 for (i = 0; i < dc->maxunit; i++)
1078 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1079 BUS_DRIVER_ADDED(dc->devices[i], driver);
1082 * Walk through the children classes. Since we only keep a
1083 * single parent pointer around, we walk the entire list of
1084 * devclasses looking for children. We set the
1085 * DC_HAS_CHILDREN flag when a child devclass is created on
1086 * the parent, so we only walk the list for those devclasses
1087 * that have children.
1089 if (!(dc->flags & DC_HAS_CHILDREN))
1092 TAILQ_FOREACH(dc, &devclasses, link) {
1093 if (dc->parent == parent)
1094 devclass_driver_added(dc, driver);
1099 * @brief Add a device driver to a device class
1101 * Add a device driver to a devclass. This is normally called
1102 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1103 * all devices in the devclass will be called to allow them to attempt
1104 * to re-probe any unmatched children.
1106 * @param dc the devclass to edit
1107 * @param driver the driver to register
1110 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1113 const char *parentname;
1115 PDEBUG(("%s", DRIVERNAME(driver)));
1117 /* Don't allow invalid pass values. */
1118 if (pass <= BUS_PASS_ROOT)
1121 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1126 * Compile the driver's methods. Also increase the reference count
1127 * so that the class doesn't get freed when the last instance
1128 * goes. This means we can safely use static methods and avoids a
1129 * double-free in devclass_delete_driver.
1131 kobj_class_compile((kobj_class_t) driver);
1134 * If the driver has any base classes, make the
1135 * devclass inherit from the devclass of the driver's
1136 * first base class. This will allow the system to
1137 * search for drivers in both devclasses for children
1138 * of a device using this driver.
1140 if (driver->baseclasses)
1141 parentname = driver->baseclasses[0]->name;
1144 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1146 dl->driver = driver;
1147 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1148 driver->refs++; /* XXX: kobj_mtx */
1150 driver_register_pass(dl);
1152 if (device_frozen) {
1153 dl->flags |= DL_DEFERRED_PROBE;
1155 devclass_driver_added(dc, driver);
1157 bus_data_generation_update();
1162 * @brief Register that a device driver has been deleted from a devclass
1164 * Register that a device driver has been removed from a devclass.
1165 * This is called by devclass_delete_driver to accomplish the
1166 * recursive notification of all the children classes of busclass, as
1167 * well as busclass. Each layer will attempt to detach the driver
1168 * from any devices that are children of the bus's devclass. The function
1169 * will return an error if a device fails to detach.
1171 * We do a full search here of the devclass list at each iteration
1172 * level to save storing children-lists in the devclass structure. If
1173 * we ever move beyond a few dozen devices doing this, we may need to
1176 * @param busclass the devclass of the parent bus
1177 * @param dc the devclass of the driver being deleted
1178 * @param driver the driver being deleted
1181 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1188 * Disassociate from any devices. We iterate through all the
1189 * devices in the devclass of the driver and detach any which are
1190 * using the driver and which have a parent in the devclass which
1191 * we are deleting from.
1193 * Note that since a driver can be in multiple devclasses, we
1194 * should not detach devices which are not children of devices in
1195 * the affected devclass.
1197 * If we're frozen, we don't generate NOMATCH events. Mark to
1200 for (i = 0; i < dc->maxunit; i++) {
1201 if (dc->devices[i]) {
1202 dev = dc->devices[i];
1203 if (dev->driver == driver && dev->parent &&
1204 dev->parent->devclass == busclass) {
1205 if ((error = device_detach(dev)) != 0)
1207 if (device_frozen) {
1208 dev->flags &= ~DF_DONENOMATCH;
1209 dev->flags |= DF_NEEDNOMATCH;
1211 BUS_PROBE_NOMATCH(dev->parent, dev);
1213 dev->flags |= DF_DONENOMATCH;
1220 * Walk through the children classes. Since we only keep a
1221 * single parent pointer around, we walk the entire list of
1222 * devclasses looking for children. We set the
1223 * DC_HAS_CHILDREN flag when a child devclass is created on
1224 * the parent, so we only walk the list for those devclasses
1225 * that have children.
1227 if (!(busclass->flags & DC_HAS_CHILDREN))
1230 TAILQ_FOREACH(busclass, &devclasses, link) {
1231 if (busclass->parent == parent) {
1232 error = devclass_driver_deleted(busclass, dc, driver);
1241 * @brief Delete a device driver from a device class
1243 * Delete a device driver from a devclass. This is normally called
1244 * automatically by DRIVER_MODULE().
1246 * If the driver is currently attached to any devices,
1247 * devclass_delete_driver() will first attempt to detach from each
1248 * device. If one of the detach calls fails, the driver will not be
1251 * @param dc the devclass to edit
1252 * @param driver the driver to unregister
1255 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1257 devclass_t dc = devclass_find(driver->name);
1261 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1267 * Find the link structure in the bus' list of drivers.
1269 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1270 if (dl->driver == driver)
1275 PDEBUG(("%s not found in %s list", driver->name,
1280 error = devclass_driver_deleted(busclass, dc, driver);
1284 TAILQ_REMOVE(&busclass->drivers, dl, link);
1289 if (driver->refs == 0)
1290 kobj_class_free((kobj_class_t) driver);
1292 bus_data_generation_update();
1297 * @brief Quiesces a set of device drivers from a device class
1299 * Quiesce a device driver from a devclass. This is normally called
1300 * automatically by DRIVER_MODULE().
1302 * If the driver is currently attached to any devices,
1303 * devclass_quiesece_driver() will first attempt to quiesce each
1306 * @param dc the devclass to edit
1307 * @param driver the driver to unregister
1310 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1312 devclass_t dc = devclass_find(driver->name);
1318 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1324 * Find the link structure in the bus' list of drivers.
1326 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1327 if (dl->driver == driver)
1332 PDEBUG(("%s not found in %s list", driver->name,
1338 * Quiesce all devices. We iterate through all the devices in
1339 * the devclass of the driver and quiesce any which are using
1340 * the driver and which have a parent in the devclass which we
1343 * Note that since a driver can be in multiple devclasses, we
1344 * should not quiesce devices which are not children of
1345 * devices in the affected devclass.
1347 for (i = 0; i < dc->maxunit; i++) {
1348 if (dc->devices[i]) {
1349 dev = dc->devices[i];
1350 if (dev->driver == driver && dev->parent &&
1351 dev->parent->devclass == busclass) {
1352 if ((error = device_quiesce(dev)) != 0)
1365 devclass_find_driver_internal(devclass_t dc, const char *classname)
1369 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1371 TAILQ_FOREACH(dl, &dc->drivers, link) {
1372 if (!strcmp(dl->driver->name, classname))
1376 PDEBUG(("not found"));
1381 * @brief Return the name of the devclass
1384 devclass_get_name(devclass_t dc)
1390 * @brief Find a device given a unit number
1392 * @param dc the devclass to search
1393 * @param unit the unit number to search for
1395 * @returns the device with the given unit number or @c
1396 * NULL if there is no such device
1399 devclass_get_device(devclass_t dc, int unit)
1401 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1403 return (dc->devices[unit]);
1407 * @brief Find the softc field of a device given a unit number
1409 * @param dc the devclass to search
1410 * @param unit the unit number to search for
1412 * @returns the softc field of the device with the given
1413 * unit number or @c NULL if there is no such
1417 devclass_get_softc(devclass_t dc, int unit)
1421 dev = devclass_get_device(dc, unit);
1425 return (device_get_softc(dev));
1429 * @brief Get a list of devices in the devclass
1431 * An array containing a list of all the devices in the given devclass
1432 * is allocated and returned in @p *devlistp. The number of devices
1433 * in the array is returned in @p *devcountp. The caller should free
1434 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1436 * @param dc the devclass to examine
1437 * @param devlistp points at location for array pointer return
1439 * @param devcountp points at location for array size return value
1442 * @retval ENOMEM the array allocation failed
1445 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1450 count = devclass_get_count(dc);
1451 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1456 for (i = 0; i < dc->maxunit; i++) {
1457 if (dc->devices[i]) {
1458 list[count] = dc->devices[i];
1470 * @brief Get a list of drivers in the devclass
1472 * An array containing a list of pointers to all the drivers in the
1473 * given devclass is allocated and returned in @p *listp. The number
1474 * of drivers in the array is returned in @p *countp. The caller should
1475 * free the array using @c free(p, M_TEMP).
1477 * @param dc the devclass to examine
1478 * @param listp gives location for array pointer return value
1479 * @param countp gives location for number of array elements
1483 * @retval ENOMEM the array allocation failed
1486 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1493 TAILQ_FOREACH(dl, &dc->drivers, link)
1495 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1500 TAILQ_FOREACH(dl, &dc->drivers, link) {
1501 list[count] = dl->driver;
1511 * @brief Get the number of devices in a devclass
1513 * @param dc the devclass to examine
1516 devclass_get_count(devclass_t dc)
1521 for (i = 0; i < dc->maxunit; i++)
1528 * @brief Get the maximum unit number used in a devclass
1530 * Note that this is one greater than the highest currently-allocated
1531 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1532 * that not even the devclass has been allocated yet.
1534 * @param dc the devclass to examine
1537 devclass_get_maxunit(devclass_t dc)
1541 return (dc->maxunit);
1545 * @brief Find a free unit number in a devclass
1547 * This function searches for the first unused unit number greater
1548 * that or equal to @p unit.
1550 * @param dc the devclass to examine
1551 * @param unit the first unit number to check
1554 devclass_find_free_unit(devclass_t dc, int unit)
1558 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1564 * @brief Set the parent of a devclass
1566 * The parent class is normally initialised automatically by
1569 * @param dc the devclass to edit
1570 * @param pdc the new parent devclass
1573 devclass_set_parent(devclass_t dc, devclass_t pdc)
1579 * @brief Get the parent of a devclass
1581 * @param dc the devclass to examine
1584 devclass_get_parent(devclass_t dc)
1586 return (dc->parent);
1589 struct sysctl_ctx_list *
1590 devclass_get_sysctl_ctx(devclass_t dc)
1592 return (&dc->sysctl_ctx);
1596 devclass_get_sysctl_tree(devclass_t dc)
1598 return (dc->sysctl_tree);
1603 * @brief Allocate a unit number
1605 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1606 * will do). The allocated unit number is returned in @p *unitp.
1608 * @param dc the devclass to allocate from
1609 * @param unitp points at the location for the allocated unit
1613 * @retval EEXIST the requested unit number is already allocated
1614 * @retval ENOMEM memory allocation failure
1617 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1622 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1624 /* Ask the parent bus if it wants to wire this device. */
1626 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1629 /* If we were given a wired unit number, check for existing device */
1632 if (unit >= 0 && unit < dc->maxunit &&
1633 dc->devices[unit] != NULL) {
1635 printf("%s: %s%d already exists; skipping it\n",
1636 dc->name, dc->name, *unitp);
1640 /* Unwired device, find the next available slot for it */
1642 for (unit = 0;; unit++) {
1643 /* If there is an "at" hint for a unit then skip it. */
1644 if (resource_string_value(dc->name, unit, "at", &s) ==
1648 /* If this device slot is already in use, skip it. */
1649 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1657 * We've selected a unit beyond the length of the table, so let's
1658 * extend the table to make room for all units up to and including
1661 if (unit >= dc->maxunit) {
1662 device_t *newlist, *oldlist;
1665 oldlist = dc->devices;
1666 newsize = roundup((unit + 1),
1667 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1668 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1671 if (oldlist != NULL)
1672 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1673 bzero(newlist + dc->maxunit,
1674 sizeof(device_t) * (newsize - dc->maxunit));
1675 dc->devices = newlist;
1676 dc->maxunit = newsize;
1677 if (oldlist != NULL)
1678 free(oldlist, M_BUS);
1680 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1688 * @brief Add a device to a devclass
1690 * A unit number is allocated for the device (using the device's
1691 * preferred unit number if any) and the device is registered in the
1692 * devclass. This allows the device to be looked up by its unit
1693 * number, e.g. by decoding a dev_t minor number.
1695 * @param dc the devclass to add to
1696 * @param dev the device to add
1699 * @retval EEXIST the requested unit number is already allocated
1700 * @retval ENOMEM memory allocation failure
1703 devclass_add_device(devclass_t dc, device_t dev)
1707 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1709 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1712 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1716 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1717 free(dev->nameunit, M_BUS);
1718 dev->nameunit = NULL;
1721 dc->devices[dev->unit] = dev;
1723 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1730 * @brief Delete a device from a devclass
1732 * The device is removed from the devclass's device list and its unit
1735 * @param dc the devclass to delete from
1736 * @param dev the device to delete
1741 devclass_delete_device(devclass_t dc, device_t dev)
1746 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1748 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1749 panic("devclass_delete_device: inconsistent device class");
1750 dc->devices[dev->unit] = NULL;
1751 if (dev->flags & DF_WILDCARD)
1753 dev->devclass = NULL;
1754 free(dev->nameunit, M_BUS);
1755 dev->nameunit = NULL;
1762 * @brief Make a new device and add it as a child of @p parent
1764 * @param parent the parent of the new device
1765 * @param name the devclass name of the new device or @c NULL
1766 * to leave the devclass unspecified
1767 * @parem unit the unit number of the new device of @c -1 to
1768 * leave the unit number unspecified
1770 * @returns the new device
1773 make_device(device_t parent, const char *name, int unit)
1778 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1781 dc = devclass_find_internal(name, NULL, TRUE);
1783 printf("make_device: can't find device class %s\n",
1791 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1795 dev->parent = parent;
1796 TAILQ_INIT(&dev->children);
1797 kobj_init((kobj_t) dev, &null_class);
1799 dev->devclass = NULL;
1801 dev->nameunit = NULL;
1805 dev->flags = DF_ENABLED;
1808 dev->flags |= DF_WILDCARD;
1810 dev->flags |= DF_FIXEDCLASS;
1811 if (devclass_add_device(dc, dev)) {
1812 kobj_delete((kobj_t) dev, M_BUS);
1816 if (parent != NULL && device_has_quiet_children(parent))
1817 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1821 dev->state = DS_NOTPRESENT;
1823 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1824 bus_data_generation_update();
1831 * @brief Print a description of a device.
1834 device_print_child(device_t dev, device_t child)
1838 if (device_is_alive(child))
1839 retval += BUS_PRINT_CHILD(dev, child);
1841 retval += device_printf(child, " not found\n");
1847 * @brief Create a new device
1849 * This creates a new device and adds it as a child of an existing
1850 * parent device. The new device will be added after the last existing
1851 * child with order zero.
1853 * @param dev the device which will be the parent of the
1855 * @param name devclass name for new device or @c NULL if not
1857 * @param unit unit number for new device or @c -1 if not
1860 * @returns the new device
1863 device_add_child(device_t dev, const char *name, int unit)
1865 return (device_add_child_ordered(dev, 0, name, unit));
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 the same order.
1875 * @param dev the device which will be the parent of the
1877 * @param order a value which is used to partially sort the
1878 * children of @p dev - devices created using
1879 * lower values of @p order appear first in @p
1880 * dev's list of children
1881 * @param name devclass name for new device or @c NULL if not
1883 * @param unit unit number for new device or @c -1 if not
1886 * @returns the new device
1889 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1894 PDEBUG(("%s at %s with order %u as unit %d",
1895 name, DEVICENAME(dev), order, unit));
1896 KASSERT(name != NULL || unit == -1,
1897 ("child device with wildcard name and specific unit number"));
1899 child = make_device(dev, name, unit);
1902 child->order = order;
1904 TAILQ_FOREACH(place, &dev->children, link) {
1905 if (place->order > order)
1911 * The device 'place' is the first device whose order is
1912 * greater than the new child.
1914 TAILQ_INSERT_BEFORE(place, child, link);
1917 * The new child's order is greater or equal to the order of
1918 * any existing device. Add the child to the tail of the list.
1920 TAILQ_INSERT_TAIL(&dev->children, child, link);
1923 bus_data_generation_update();
1928 * @brief Delete a device
1930 * This function deletes a device along with all of its children. If
1931 * the device currently has a driver attached to it, the device is
1932 * detached first using device_detach().
1934 * @param dev the parent device
1935 * @param child the device to delete
1938 * @retval non-zero a unit error code describing the error
1941 device_delete_child(device_t dev, device_t child)
1944 device_t grandchild;
1946 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1948 /* detach parent before deleting children, if any */
1949 if ((error = device_detach(child)) != 0)
1952 /* remove children second */
1953 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1954 error = device_delete_child(child, grandchild);
1959 if (child->devclass)
1960 devclass_delete_device(child->devclass, child);
1962 BUS_CHILD_DELETED(dev, child);
1963 TAILQ_REMOVE(&dev->children, child, link);
1964 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1965 kobj_delete((kobj_t) child, M_BUS);
1967 bus_data_generation_update();
1972 * @brief Delete all children devices of the given device, if any.
1974 * This function deletes all children devices of the given device, if
1975 * any, using the device_delete_child() function for each device it
1976 * finds. If a child device cannot be deleted, this function will
1977 * return an error code.
1979 * @param dev the parent device
1982 * @retval non-zero a device would not detach
1985 device_delete_children(device_t dev)
1990 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1994 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1995 error = device_delete_child(dev, child);
1997 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2005 * @brief Find a device given a unit number
2007 * This is similar to devclass_get_devices() but only searches for
2008 * devices which have @p dev as a parent.
2010 * @param dev the parent device to search
2011 * @param unit the unit number to search for. If the unit is -1,
2012 * return the first child of @p dev which has name
2013 * @p classname (that is, the one with the lowest unit.)
2015 * @returns the device with the given unit number or @c
2016 * NULL if there is no such device
2019 device_find_child(device_t dev, const char *classname, int unit)
2024 dc = devclass_find(classname);
2029 child = devclass_get_device(dc, unit);
2030 if (child && child->parent == dev)
2033 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2034 child = devclass_get_device(dc, unit);
2035 if (child && child->parent == dev)
2046 first_matching_driver(devclass_t dc, device_t dev)
2049 return (devclass_find_driver_internal(dc, dev->devclass->name));
2050 return (TAILQ_FIRST(&dc->drivers));
2057 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2059 if (dev->devclass) {
2061 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2062 if (!strcmp(dev->devclass->name, dl->driver->name))
2066 return (TAILQ_NEXT(last, link));
2073 device_probe_child(device_t dev, device_t child)
2076 driverlink_t best = NULL;
2078 int result, pri = 0;
2079 int hasclass = (child->devclass != NULL);
2085 panic("device_probe_child: parent device has no devclass");
2088 * If the state is already probed, then return. However, don't
2089 * return if we can rebid this object.
2091 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2094 for (; dc; dc = dc->parent) {
2095 for (dl = first_matching_driver(dc, child);
2097 dl = next_matching_driver(dc, child, dl)) {
2098 /* If this driver's pass is too high, then ignore it. */
2099 if (dl->pass > bus_current_pass)
2102 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2103 result = device_set_driver(child, dl->driver);
2104 if (result == ENOMEM)
2106 else if (result != 0)
2109 if (device_set_devclass(child,
2110 dl->driver->name) != 0) {
2111 char const * devname =
2112 device_get_name(child);
2113 if (devname == NULL)
2114 devname = "(unknown)";
2115 printf("driver bug: Unable to set "
2116 "devclass (class: %s "
2120 (void)device_set_driver(child, NULL);
2125 /* Fetch any flags for the device before probing. */
2126 resource_int_value(dl->driver->name, child->unit,
2127 "flags", &child->devflags);
2129 result = DEVICE_PROBE(child);
2131 /* Reset flags and devclass before the next probe. */
2132 child->devflags = 0;
2134 (void)device_set_devclass(child, NULL);
2137 * If the driver returns SUCCESS, there can be
2138 * no higher match for this device.
2147 * Reset DF_QUIET in case this driver doesn't
2148 * end up as the best driver.
2150 device_verbose(child);
2153 * Probes that return BUS_PROBE_NOWILDCARD or lower
2154 * only match on devices whose driver was explicitly
2157 if (result <= BUS_PROBE_NOWILDCARD &&
2158 !(child->flags & DF_FIXEDCLASS)) {
2163 * The driver returned an error so it
2164 * certainly doesn't match.
2167 (void)device_set_driver(child, NULL);
2172 * A priority lower than SUCCESS, remember the
2173 * best matching driver. Initialise the value
2174 * of pri for the first match.
2176 if (best == NULL || result > pri) {
2183 * If we have an unambiguous match in this devclass,
2184 * don't look in the parent.
2186 if (best && pri == 0)
2191 * If we found a driver, change state and initialise the devclass.
2193 /* XXX What happens if we rebid and got no best? */
2196 * If this device was attached, and we were asked to
2197 * rescan, and it is a different driver, then we have
2198 * to detach the old driver and reattach this new one.
2199 * Note, we don't have to check for DF_REBID here
2200 * because if the state is > DS_ALIVE, we know it must
2203 * This assumes that all DF_REBID drivers can have
2204 * their probe routine called at any time and that
2205 * they are idempotent as well as completely benign in
2206 * normal operations.
2208 * We also have to make sure that the detach
2209 * succeeded, otherwise we fail the operation (or
2210 * maybe it should just fail silently? I'm torn).
2212 if (child->state > DS_ALIVE && best->driver != child->driver)
2213 if ((result = device_detach(dev)) != 0)
2216 /* Set the winning driver, devclass, and flags. */
2217 if (!child->devclass) {
2218 result = device_set_devclass(child, best->driver->name);
2222 result = device_set_driver(child, best->driver);
2225 resource_int_value(best->driver->name, child->unit,
2226 "flags", &child->devflags);
2230 * A bit bogus. Call the probe method again to make
2231 * sure that we have the right description.
2233 DEVICE_PROBE(child);
2235 child->flags |= DF_REBID;
2238 child->flags &= ~DF_REBID;
2239 child->state = DS_ALIVE;
2241 bus_data_generation_update();
2249 * @brief Return the parent of a device
2252 device_get_parent(device_t dev)
2254 return (dev->parent);
2258 * @brief Get a list of children of a device
2260 * An array containing a list of all the children of the given device
2261 * is allocated and returned in @p *devlistp. The number of devices
2262 * in the array is returned in @p *devcountp. The caller should free
2263 * the array using @c free(p, M_TEMP).
2265 * @param dev the device to examine
2266 * @param devlistp points at location for array pointer return
2268 * @param devcountp points at location for array size return value
2271 * @retval ENOMEM the array allocation failed
2274 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2281 TAILQ_FOREACH(child, &dev->children, link) {
2290 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2295 TAILQ_FOREACH(child, &dev->children, link) {
2296 list[count] = child;
2307 * @brief Return the current driver for the device or @c NULL if there
2308 * is no driver currently attached
2311 device_get_driver(device_t dev)
2313 return (dev->driver);
2317 * @brief Return the current devclass for the device or @c NULL if
2321 device_get_devclass(device_t dev)
2323 return (dev->devclass);
2327 * @brief Return the name of the device's devclass or @c NULL if there
2331 device_get_name(device_t dev)
2333 if (dev != NULL && dev->devclass)
2334 return (devclass_get_name(dev->devclass));
2339 * @brief Return a string containing the device's devclass name
2340 * followed by an ascii representation of the device's unit number
2344 device_get_nameunit(device_t dev)
2346 return (dev->nameunit);
2350 * @brief Return the device's unit number.
2353 device_get_unit(device_t dev)
2359 * @brief Return the device's description string
2362 device_get_desc(device_t dev)
2368 * @brief Return the device's flags
2371 device_get_flags(device_t dev)
2373 return (dev->devflags);
2376 struct sysctl_ctx_list *
2377 device_get_sysctl_ctx(device_t dev)
2379 return (&dev->sysctl_ctx);
2383 device_get_sysctl_tree(device_t dev)
2385 return (dev->sysctl_tree);
2389 * @brief Print the name of the device followed by a colon and a space
2391 * @returns the number of characters printed
2394 device_print_prettyname(device_t dev)
2396 const char *name = device_get_name(dev);
2399 return (printf("unknown: "));
2400 return (printf("%s%d: ", name, device_get_unit(dev)));
2404 * @brief Print the name of the device followed by a colon, a space
2405 * and the result of calling vprintf() with the value of @p fmt and
2406 * the following arguments.
2408 * @returns the number of characters printed
2411 device_printf(device_t dev, const char * fmt, ...)
2421 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2422 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2424 name = device_get_name(dev);
2427 sbuf_cat(&sb, "unknown: ");
2429 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2432 sbuf_vprintf(&sb, fmt, ap);
2445 device_set_desc_internal(device_t dev, const char* desc, int copy)
2447 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2448 free(dev->desc, M_BUS);
2449 dev->flags &= ~DF_DESCMALLOCED;
2454 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2456 strcpy(dev->desc, desc);
2457 dev->flags |= DF_DESCMALLOCED;
2460 /* Avoid a -Wcast-qual warning */
2461 dev->desc = (char *)(uintptr_t) desc;
2464 bus_data_generation_update();
2468 * @brief Set the device's description
2470 * The value of @c desc should be a string constant that will not
2471 * change (at least until the description is changed in a subsequent
2472 * call to device_set_desc() or device_set_desc_copy()).
2475 device_set_desc(device_t dev, const char* desc)
2477 device_set_desc_internal(dev, desc, FALSE);
2481 * @brief Set the device's description
2483 * The string pointed to by @c desc is copied. Use this function if
2484 * the device description is generated, (e.g. with sprintf()).
2487 device_set_desc_copy(device_t dev, const char* desc)
2489 device_set_desc_internal(dev, desc, TRUE);
2493 * @brief Set the device's flags
2496 device_set_flags(device_t dev, uint32_t flags)
2498 dev->devflags = flags;
2502 * @brief Return the device's softc field
2504 * The softc is allocated and zeroed when a driver is attached, based
2505 * on the size field of the driver.
2508 device_get_softc(device_t dev)
2510 return (dev->softc);
2514 * @brief Set the device's softc field
2516 * Most drivers do not need to use this since the softc is allocated
2517 * automatically when the driver is attached.
2520 device_set_softc(device_t dev, void *softc)
2522 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2523 free(dev->softc, M_BUS_SC);
2526 dev->flags |= DF_EXTERNALSOFTC;
2528 dev->flags &= ~DF_EXTERNALSOFTC;
2532 * @brief Free claimed softc
2534 * Most drivers do not need to use this since the softc is freed
2535 * automatically when the driver is detached.
2538 device_free_softc(void *softc)
2540 free(softc, M_BUS_SC);
2544 * @brief Claim softc
2546 * This function can be used to let the driver free the automatically
2547 * allocated softc using "device_free_softc()". This function is
2548 * useful when the driver is refcounting the softc and the softc
2549 * cannot be freed when the "device_detach" method is called.
2552 device_claim_softc(device_t dev)
2555 dev->flags |= DF_EXTERNALSOFTC;
2557 dev->flags &= ~DF_EXTERNALSOFTC;
2561 * @brief Get the device's ivars field
2563 * The ivars field is used by the parent device to store per-device
2564 * state (e.g. the physical location of the device or a list of
2568 device_get_ivars(device_t dev)
2570 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2571 return (dev->ivars);
2575 * @brief Set the device's ivars field
2578 device_set_ivars(device_t dev, void * ivars)
2580 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2585 * @brief Return the device's state
2588 device_get_state(device_t dev)
2590 return (dev->state);
2594 * @brief Set the DF_ENABLED flag for the device
2597 device_enable(device_t dev)
2599 dev->flags |= DF_ENABLED;
2603 * @brief Clear the DF_ENABLED flag for the device
2606 device_disable(device_t dev)
2608 dev->flags &= ~DF_ENABLED;
2612 * @brief Increment the busy counter for the device
2615 device_busy(device_t dev)
2617 if (dev->state < DS_ATTACHING)
2618 panic("device_busy: called for unattached device");
2619 if (dev->busy == 0 && dev->parent)
2620 device_busy(dev->parent);
2622 if (dev->state == DS_ATTACHED)
2623 dev->state = DS_BUSY;
2627 * @brief Decrement the busy counter for the device
2630 device_unbusy(device_t dev)
2632 if (dev->busy != 0 && dev->state != DS_BUSY &&
2633 dev->state != DS_ATTACHING)
2634 panic("device_unbusy: called for non-busy device %s",
2635 device_get_nameunit(dev));
2637 if (dev->busy == 0) {
2639 device_unbusy(dev->parent);
2640 if (dev->state == DS_BUSY)
2641 dev->state = DS_ATTACHED;
2646 * @brief Set the DF_QUIET flag for the device
2649 device_quiet(device_t dev)
2651 dev->flags |= DF_QUIET;
2655 * @brief Set the DF_QUIET_CHILDREN flag for the device
2658 device_quiet_children(device_t dev)
2660 dev->flags |= DF_QUIET_CHILDREN;
2664 * @brief Clear the DF_QUIET flag for the device
2667 device_verbose(device_t dev)
2669 dev->flags &= ~DF_QUIET;
2673 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2676 device_has_quiet_children(device_t dev)
2678 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2682 * @brief Return non-zero if the DF_QUIET flag is set on the device
2685 device_is_quiet(device_t dev)
2687 return ((dev->flags & DF_QUIET) != 0);
2691 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2694 device_is_enabled(device_t dev)
2696 return ((dev->flags & DF_ENABLED) != 0);
2700 * @brief Return non-zero if the device was successfully probed
2703 device_is_alive(device_t dev)
2705 return (dev->state >= DS_ALIVE);
2709 * @brief Return non-zero if the device currently has a driver
2713 device_is_attached(device_t dev)
2715 return (dev->state >= DS_ATTACHED);
2719 * @brief Return non-zero if the device is currently suspended.
2722 device_is_suspended(device_t dev)
2724 return ((dev->flags & DF_SUSPENDED) != 0);
2728 * @brief Set the devclass of a device
2729 * @see devclass_add_device().
2732 device_set_devclass(device_t dev, const char *classname)
2739 devclass_delete_device(dev->devclass, dev);
2743 if (dev->devclass) {
2744 printf("device_set_devclass: device class already set\n");
2748 dc = devclass_find_internal(classname, NULL, TRUE);
2752 error = devclass_add_device(dc, dev);
2754 bus_data_generation_update();
2759 * @brief Set the devclass of a device and mark the devclass fixed.
2760 * @see device_set_devclass()
2763 device_set_devclass_fixed(device_t dev, const char *classname)
2767 if (classname == NULL)
2770 error = device_set_devclass(dev, classname);
2773 dev->flags |= DF_FIXEDCLASS;
2778 * @brief Query the device to determine if it's of a fixed devclass
2779 * @see device_set_devclass_fixed()
2782 device_is_devclass_fixed(device_t dev)
2784 return ((dev->flags & DF_FIXEDCLASS) != 0);
2788 * @brief Set the driver of a device
2791 * @retval EBUSY the device already has a driver attached
2792 * @retval ENOMEM a memory allocation failure occurred
2795 device_set_driver(device_t dev, driver_t *driver)
2798 struct domainset *policy;
2800 if (dev->state >= DS_ATTACHED)
2803 if (dev->driver == driver)
2806 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2807 free(dev->softc, M_BUS_SC);
2810 device_set_desc(dev, NULL);
2811 kobj_delete((kobj_t) dev, NULL);
2812 dev->driver = driver;
2814 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2815 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2816 if (bus_get_domain(dev, &domain) == 0)
2817 policy = DOMAINSET_PREF(domain);
2819 policy = DOMAINSET_RR();
2820 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2821 policy, M_NOWAIT | M_ZERO);
2823 kobj_delete((kobj_t) dev, NULL);
2824 kobj_init((kobj_t) dev, &null_class);
2830 kobj_init((kobj_t) dev, &null_class);
2833 bus_data_generation_update();
2838 * @brief Probe a device, and return this status.
2840 * This function is the core of the device autoconfiguration
2841 * system. Its purpose is to select a suitable driver for a device and
2842 * then call that driver to initialise the hardware appropriately. The
2843 * driver is selected by calling the DEVICE_PROBE() method of a set of
2844 * candidate drivers and then choosing the driver which returned the
2845 * best value. This driver is then attached to the device using
2848 * The set of suitable drivers is taken from the list of drivers in
2849 * the parent device's devclass. If the device was originally created
2850 * with a specific class name (see device_add_child()), only drivers
2851 * with that name are probed, otherwise all drivers in the devclass
2852 * are probed. If no drivers return successful probe values in the
2853 * parent devclass, the search continues in the parent of that
2854 * devclass (see devclass_get_parent()) if any.
2856 * @param dev the device to initialise
2859 * @retval ENXIO no driver was found
2860 * @retval ENOMEM memory allocation failure
2861 * @retval non-zero some other unix error code
2862 * @retval -1 Device already attached
2865 device_probe(device_t dev)
2871 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2874 if (!(dev->flags & DF_ENABLED)) {
2875 if (bootverbose && device_get_name(dev) != NULL) {
2876 device_print_prettyname(dev);
2877 printf("not probed (disabled)\n");
2881 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2882 if (bus_current_pass == BUS_PASS_DEFAULT &&
2883 !(dev->flags & DF_DONENOMATCH)) {
2884 BUS_PROBE_NOMATCH(dev->parent, dev);
2886 dev->flags |= DF_DONENOMATCH;
2894 * @brief Probe a device and attach a driver if possible
2896 * calls device_probe() and attaches if that was successful.
2899 device_probe_and_attach(device_t dev)
2905 error = device_probe(dev);
2908 else if (error != 0)
2911 CURVNET_SET_QUIET(vnet0);
2912 error = device_attach(dev);
2918 * @brief Attach a device driver to a device
2920 * This function is a wrapper around the DEVICE_ATTACH() driver
2921 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2922 * device's sysctl tree, optionally prints a description of the device
2923 * and queues a notification event for user-based device management
2926 * Normally this function is only called internally from
2927 * device_probe_and_attach().
2929 * @param dev the device to initialise
2932 * @retval ENXIO no driver was found
2933 * @retval ENOMEM memory allocation failure
2934 * @retval non-zero some other unix error code
2937 device_attach(device_t dev)
2939 uint64_t attachtime;
2940 uint16_t attachentropy;
2943 if (resource_disabled(dev->driver->name, dev->unit)) {
2944 device_disable(dev);
2946 device_printf(dev, "disabled via hints entry\n");
2950 device_sysctl_init(dev);
2951 if (!device_is_quiet(dev))
2952 device_print_child(dev->parent, dev);
2953 attachtime = get_cyclecount();
2954 dev->state = DS_ATTACHING;
2955 if ((error = DEVICE_ATTACH(dev)) != 0) {
2956 printf("device_attach: %s%d attach returned %d\n",
2957 dev->driver->name, dev->unit, error);
2958 if (!(dev->flags & DF_FIXEDCLASS))
2959 devclass_delete_device(dev->devclass, dev);
2960 (void)device_set_driver(dev, NULL);
2961 device_sysctl_fini(dev);
2962 KASSERT(dev->busy == 0, ("attach failed but busy"));
2963 dev->state = DS_NOTPRESENT;
2966 dev->flags |= DF_ATTACHED_ONCE;
2967 /* We only need the low bits of this time, but ranges from tens to thousands
2968 * have been seen, so keep 2 bytes' worth.
2970 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2971 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2972 device_sysctl_update(dev);
2974 dev->state = DS_BUSY;
2976 dev->state = DS_ATTACHED;
2977 dev->flags &= ~DF_DONENOMATCH;
2978 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2984 * @brief Detach a driver from a device
2986 * This function is a wrapper around the DEVICE_DETACH() driver
2987 * method. If the call to DEVICE_DETACH() succeeds, it calls
2988 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2989 * notification event for user-based device management services and
2990 * cleans up the device's sysctl tree.
2992 * @param dev the device to un-initialise
2995 * @retval ENXIO no driver was found
2996 * @retval ENOMEM memory allocation failure
2997 * @retval non-zero some other unix error code
3000 device_detach(device_t dev)
3006 PDEBUG(("%s", DEVICENAME(dev)));
3007 if (dev->state == DS_BUSY)
3009 if (dev->state == DS_ATTACHING) {
3010 device_printf(dev, "device in attaching state! Deferring detach.\n");
3013 if (dev->state != DS_ATTACHED)
3016 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3017 if ((error = DEVICE_DETACH(dev)) != 0) {
3018 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3019 EVHDEV_DETACH_FAILED);
3022 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3023 EVHDEV_DETACH_COMPLETE);
3026 if (!device_is_quiet(dev))
3027 device_printf(dev, "detached\n");
3029 BUS_CHILD_DETACHED(dev->parent, dev);
3031 if (!(dev->flags & DF_FIXEDCLASS))
3032 devclass_delete_device(dev->devclass, dev);
3034 device_verbose(dev);
3035 dev->state = DS_NOTPRESENT;
3036 (void)device_set_driver(dev, NULL);
3037 device_sysctl_fini(dev);
3043 * @brief Tells a driver to quiesce itself.
3045 * This function is a wrapper around the DEVICE_QUIESCE() driver
3046 * method. If the call to DEVICE_QUIESCE() succeeds.
3048 * @param dev the device to quiesce
3051 * @retval ENXIO no driver was found
3052 * @retval ENOMEM memory allocation failure
3053 * @retval non-zero some other unix error code
3056 device_quiesce(device_t dev)
3058 PDEBUG(("%s", DEVICENAME(dev)));
3059 if (dev->state == DS_BUSY)
3061 if (dev->state != DS_ATTACHED)
3064 return (DEVICE_QUIESCE(dev));
3068 * @brief Notify a device of system shutdown
3070 * This function calls the DEVICE_SHUTDOWN() driver method if the
3071 * device currently has an attached driver.
3073 * @returns the value returned by DEVICE_SHUTDOWN()
3076 device_shutdown(device_t dev)
3078 if (dev->state < DS_ATTACHED)
3080 return (DEVICE_SHUTDOWN(dev));
3084 * @brief Set the unit number of a device
3086 * This function can be used to override the unit number used for a
3087 * device (e.g. to wire a device to a pre-configured unit number).
3090 device_set_unit(device_t dev, int unit)
3095 dc = device_get_devclass(dev);
3096 if (unit < dc->maxunit && dc->devices[unit])
3098 err = devclass_delete_device(dc, dev);
3102 err = devclass_add_device(dc, dev);
3106 bus_data_generation_update();
3110 /*======================================*/
3112 * Some useful method implementations to make life easier for bus drivers.
3116 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3120 args->memattr = VM_MEMATTR_UNCACHEABLE;
3124 * @brief Initialise a resource list.
3126 * @param rl the resource list to initialise
3129 resource_list_init(struct resource_list *rl)
3135 * @brief Reclaim memory used by a resource list.
3137 * This function frees the memory for all resource entries on the list
3140 * @param rl the resource list to free
3143 resource_list_free(struct resource_list *rl)
3145 struct resource_list_entry *rle;
3147 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3149 panic("resource_list_free: resource entry is busy");
3150 STAILQ_REMOVE_HEAD(rl, link);
3156 * @brief Add a resource entry.
3158 * This function adds a resource entry using the given @p type, @p
3159 * start, @p end and @p count values. A rid value is chosen by
3160 * searching sequentially for the first unused rid starting at zero.
3162 * @param rl the resource list to edit
3163 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3164 * @param start the start address of the resource
3165 * @param end the end address of the resource
3166 * @param count XXX end-start+1
3169 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3170 rman_res_t end, rman_res_t count)
3175 while (resource_list_find(rl, type, rid) != NULL)
3177 resource_list_add(rl, type, rid, start, end, count);
3182 * @brief Add or modify a resource entry.
3184 * If an existing entry exists with the same type and rid, it will be
3185 * modified using the given values of @p start, @p end and @p
3186 * count. If no entry exists, a new one will be created using the
3187 * given values. The resource list entry that matches is then returned.
3189 * @param rl the resource list to edit
3190 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3191 * @param rid the resource identifier
3192 * @param start the start address of the resource
3193 * @param end the end address of the resource
3194 * @param count XXX end-start+1
3196 struct resource_list_entry *
3197 resource_list_add(struct resource_list *rl, int type, int rid,
3198 rman_res_t start, rman_res_t end, rman_res_t count)
3200 struct resource_list_entry *rle;
3202 rle = resource_list_find(rl, type, rid);
3204 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3207 panic("resource_list_add: can't record entry");
3208 STAILQ_INSERT_TAIL(rl, rle, link);
3216 panic("resource_list_add: resource entry is busy");
3225 * @brief Determine if a resource entry is busy.
3227 * Returns true if a resource entry is busy meaning that it has an
3228 * associated resource that is not an unallocated "reserved" resource.
3230 * @param rl the resource list to search
3231 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3232 * @param rid the resource identifier
3234 * @returns Non-zero if the entry is busy, zero otherwise.
3237 resource_list_busy(struct resource_list *rl, int type, int rid)
3239 struct resource_list_entry *rle;
3241 rle = resource_list_find(rl, type, rid);
3242 if (rle == NULL || rle->res == NULL)
3244 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3245 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3246 ("reserved resource is active"));
3253 * @brief Determine if a resource entry is reserved.
3255 * Returns true if a resource entry is reserved meaning that it has an
3256 * associated "reserved" resource. The resource can either be
3257 * allocated or unallocated.
3259 * @param rl the resource list to search
3260 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3261 * @param rid the resource identifier
3263 * @returns Non-zero if the entry is reserved, zero otherwise.
3266 resource_list_reserved(struct resource_list *rl, int type, int rid)
3268 struct resource_list_entry *rle;
3270 rle = resource_list_find(rl, type, rid);
3271 if (rle != NULL && rle->flags & RLE_RESERVED)
3277 * @brief Find a resource entry by type and rid.
3279 * @param rl the resource list to search
3280 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3281 * @param rid the resource identifier
3283 * @returns the resource entry pointer or NULL if there is no such
3286 struct resource_list_entry *
3287 resource_list_find(struct resource_list *rl, int type, int rid)
3289 struct resource_list_entry *rle;
3291 STAILQ_FOREACH(rle, rl, link) {
3292 if (rle->type == type && rle->rid == rid)
3299 * @brief Delete a resource entry.
3301 * @param rl the resource list to edit
3302 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3303 * @param rid the resource identifier
3306 resource_list_delete(struct resource_list *rl, int type, int rid)
3308 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3311 if (rle->res != NULL)
3312 panic("resource_list_delete: resource has not been released");
3313 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3319 * @brief Allocate a reserved resource
3321 * This can be used by buses to force the allocation of resources
3322 * that are always active in the system even if they are not allocated
3323 * by a driver (e.g. PCI BARs). This function is usually called when
3324 * adding a new child to the bus. The resource is allocated from the
3325 * parent bus when it is reserved. The resource list entry is marked
3326 * with RLE_RESERVED to note that it is a reserved resource.
3328 * Subsequent attempts to allocate the resource with
3329 * resource_list_alloc() will succeed the first time and will set
3330 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3331 * resource that has been allocated is released with
3332 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3333 * the actual resource remains allocated. The resource can be released to
3334 * the parent bus by calling resource_list_unreserve().
3336 * @param rl the resource list to allocate from
3337 * @param bus the parent device of @p child
3338 * @param child the device for which the resource is being reserved
3339 * @param type the type of resource to allocate
3340 * @param rid a pointer to the resource identifier
3341 * @param start hint at the start of the resource range - pass
3342 * @c 0 for any start address
3343 * @param end hint at the end of the resource range - pass
3344 * @c ~0 for any end address
3345 * @param count hint at the size of range required - pass @c 1
3347 * @param flags any extra flags to control the resource
3348 * allocation - see @c RF_XXX flags in
3349 * <sys/rman.h> for details
3351 * @returns the resource which was allocated or @c NULL if no
3352 * resource could be allocated
3355 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3356 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3358 struct resource_list_entry *rle = NULL;
3359 int passthrough = (device_get_parent(child) != bus);
3364 "resource_list_reserve() should only be called for direct children");
3365 if (flags & RF_ACTIVE)
3367 "resource_list_reserve() should only reserve inactive resources");
3369 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3372 rle = resource_list_find(rl, type, *rid);
3373 rle->flags |= RLE_RESERVED;
3379 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3381 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3382 * and passing the allocation up to the parent of @p bus. This assumes
3383 * that the first entry of @c device_get_ivars(child) is a struct
3384 * resource_list. This also handles 'passthrough' allocations where a
3385 * child is a remote descendant of bus by passing the allocation up to
3386 * the parent of bus.
3388 * Typically, a bus driver would store a list of child resources
3389 * somewhere in the child device's ivars (see device_get_ivars()) and
3390 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3391 * then call resource_list_alloc() to perform the allocation.
3393 * @param rl the resource list to allocate from
3394 * @param bus the parent device of @p child
3395 * @param child the device which is requesting an allocation
3396 * @param type the type of resource to allocate
3397 * @param rid a pointer to the resource identifier
3398 * @param start hint at the start of the resource range - pass
3399 * @c 0 for any start address
3400 * @param end hint at the end of the resource range - pass
3401 * @c ~0 for any end address
3402 * @param count hint at the size of range required - pass @c 1
3404 * @param flags any extra flags to control the resource
3405 * allocation - see @c RF_XXX flags in
3406 * <sys/rman.h> for details
3408 * @returns the resource which was allocated or @c NULL if no
3409 * resource could be allocated
3412 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3413 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3415 struct resource_list_entry *rle = NULL;
3416 int passthrough = (device_get_parent(child) != bus);
3417 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3420 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3421 type, rid, start, end, count, flags));
3424 rle = resource_list_find(rl, type, *rid);
3427 return (NULL); /* no resource of that type/rid */
3430 if (rle->flags & RLE_RESERVED) {
3431 if (rle->flags & RLE_ALLOCATED)
3433 if ((flags & RF_ACTIVE) &&
3434 bus_activate_resource(child, type, *rid,
3437 rle->flags |= RLE_ALLOCATED;
3441 "resource entry %#x type %d for child %s is busy\n", *rid,
3442 type, device_get_nameunit(child));
3448 count = ulmax(count, rle->count);
3449 end = ulmax(rle->end, start + count - 1);
3452 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3453 type, rid, start, end, count, flags);
3456 * Record the new range.
3459 rle->start = rman_get_start(rle->res);
3460 rle->end = rman_get_end(rle->res);
3468 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3470 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3471 * used with resource_list_alloc().
3473 * @param rl the resource list which was allocated from
3474 * @param bus the parent device of @p child
3475 * @param child the device which is requesting a release
3476 * @param type the type of resource to release
3477 * @param rid the resource identifier
3478 * @param res the resource to release
3481 * @retval non-zero a standard unix error code indicating what
3482 * error condition prevented the operation
3485 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3486 int type, int rid, struct resource *res)
3488 struct resource_list_entry *rle = NULL;
3489 int passthrough = (device_get_parent(child) != bus);
3493 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3497 rle = resource_list_find(rl, type, rid);
3500 panic("resource_list_release: can't find resource");
3502 panic("resource_list_release: resource entry is not busy");
3503 if (rle->flags & RLE_RESERVED) {
3504 if (rle->flags & RLE_ALLOCATED) {
3505 if (rman_get_flags(res) & RF_ACTIVE) {
3506 error = bus_deactivate_resource(child, type,
3511 rle->flags &= ~RLE_ALLOCATED;
3517 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3527 * @brief Release all active resources of a given type
3529 * Release all active resources of a specified type. This is intended
3530 * to be used to cleanup resources leaked by a driver after detach or
3533 * @param rl the resource list which was allocated from
3534 * @param bus the parent device of @p child
3535 * @param child the device whose active resources are being released
3536 * @param type the type of resources to release
3539 * @retval EBUSY at least one resource was active
3542 resource_list_release_active(struct resource_list *rl, device_t bus,
3543 device_t child, int type)
3545 struct resource_list_entry *rle;
3549 STAILQ_FOREACH(rle, rl, link) {
3550 if (rle->type != type)
3552 if (rle->res == NULL)
3554 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3558 error = resource_list_release(rl, bus, child, type,
3559 rman_get_rid(rle->res), rle->res);
3562 "Failed to release active resource: %d\n", error);
3568 * @brief Fully release a reserved resource
3570 * Fully releases a resource reserved via resource_list_reserve().
3572 * @param rl the resource list which was allocated from
3573 * @param bus the parent device of @p child
3574 * @param child the device whose reserved resource is being released
3575 * @param type the type of resource to release
3576 * @param rid the resource identifier
3577 * @param res the resource to release
3580 * @retval non-zero a standard unix error code indicating what
3581 * error condition prevented the operation
3584 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3587 struct resource_list_entry *rle = NULL;
3588 int passthrough = (device_get_parent(child) != bus);
3592 "resource_list_unreserve() should only be called for direct children");
3594 rle = resource_list_find(rl, type, rid);
3597 panic("resource_list_unreserve: can't find resource");
3598 if (!(rle->flags & RLE_RESERVED))
3600 if (rle->flags & RLE_ALLOCATED)
3602 rle->flags &= ~RLE_RESERVED;
3603 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3607 * @brief Print a description of resources in a resource list
3609 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3610 * The name is printed if at least one resource of the given type is available.
3611 * The format is used to print resource start and end.
3613 * @param rl the resource list to print
3614 * @param name the name of @p type, e.g. @c "memory"
3615 * @param type type type of resource entry to print
3616 * @param format printf(9) format string to print resource
3617 * start and end values
3619 * @returns the number of characters printed
3622 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3625 struct resource_list_entry *rle;
3626 int printed, retval;
3630 /* Yes, this is kinda cheating */
3631 STAILQ_FOREACH(rle, rl, link) {
3632 if (rle->type == type) {
3634 retval += printf(" %s ", name);
3636 retval += printf(",");
3638 retval += printf(format, rle->start);
3639 if (rle->count > 1) {
3640 retval += printf("-");
3641 retval += printf(format, rle->start +
3650 * @brief Releases all the resources in a list.
3652 * @param rl The resource list to purge.
3657 resource_list_purge(struct resource_list *rl)
3659 struct resource_list_entry *rle;
3661 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3663 bus_release_resource(rman_get_device(rle->res),
3664 rle->type, rle->rid, rle->res);
3665 STAILQ_REMOVE_HEAD(rl, link);
3671 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3673 return (device_add_child_ordered(dev, order, name, unit));
3677 * @brief Helper function for implementing DEVICE_PROBE()
3679 * This function can be used to help implement the DEVICE_PROBE() for
3680 * a bus (i.e. a device which has other devices attached to it). It
3681 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3685 bus_generic_probe(device_t dev)
3687 devclass_t dc = dev->devclass;
3690 TAILQ_FOREACH(dl, &dc->drivers, link) {
3692 * If this driver's pass is too high, then ignore it.
3693 * For most drivers in the default pass, this will
3694 * never be true. For early-pass drivers they will
3695 * only call the identify routines of eligible drivers
3696 * when this routine is called. Drivers for later
3697 * passes should have their identify routines called
3698 * on early-pass buses during BUS_NEW_PASS().
3700 if (dl->pass > bus_current_pass)
3702 DEVICE_IDENTIFY(dl->driver, dev);
3709 * @brief Helper function for implementing DEVICE_ATTACH()
3711 * This function can be used to help implement the DEVICE_ATTACH() for
3712 * a bus. It calls device_probe_and_attach() for each of the device's
3716 bus_generic_attach(device_t dev)
3720 TAILQ_FOREACH(child, &dev->children, link) {
3721 device_probe_and_attach(child);
3728 * @brief Helper function for delaying attaching children
3730 * Many buses can't run transactions on the bus which children need to probe and
3731 * attach until after interrupts and/or timers are running. This function
3732 * delays their attach until interrupts and timers are enabled.
3735 bus_delayed_attach_children(device_t dev)
3737 /* Probe and attach the bus children when interrupts are available */
3738 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3744 * @brief Helper function for implementing DEVICE_DETACH()
3746 * This function can be used to help implement the DEVICE_DETACH() for
3747 * a bus. It calls device_detach() for each of the device's
3751 bus_generic_detach(device_t dev)
3756 if (dev->state != DS_ATTACHED)
3760 * Detach children in the reverse order.
3761 * See bus_generic_suspend for details.
3763 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3764 if ((error = device_detach(child)) != 0)
3772 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3774 * This function can be used to help implement the DEVICE_SHUTDOWN()
3775 * for a bus. It calls device_shutdown() for each of the device's
3779 bus_generic_shutdown(device_t dev)
3784 * Shut down children in the reverse order.
3785 * See bus_generic_suspend for details.
3787 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3788 device_shutdown(child);
3795 * @brief Default function for suspending a child device.
3797 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3800 bus_generic_suspend_child(device_t dev, device_t child)
3804 error = DEVICE_SUSPEND(child);
3807 child->flags |= DF_SUSPENDED;
3813 * @brief Default function for resuming a child device.
3815 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3818 bus_generic_resume_child(device_t dev, device_t child)
3820 DEVICE_RESUME(child);
3821 child->flags &= ~DF_SUSPENDED;
3827 * @brief Helper function for implementing DEVICE_SUSPEND()
3829 * This function can be used to help implement the DEVICE_SUSPEND()
3830 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3831 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3832 * operation is aborted and any devices which were suspended are
3833 * resumed immediately by calling their DEVICE_RESUME() methods.
3836 bus_generic_suspend(device_t dev)
3842 * Suspend children in the reverse order.
3843 * For most buses all children are equal, so the order does not matter.
3844 * Other buses, such as acpi, carefully order their child devices to
3845 * express implicit dependencies between them. For such buses it is
3846 * safer to bring down devices in the reverse order.
3848 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3849 error = BUS_SUSPEND_CHILD(dev, child);
3851 child = TAILQ_NEXT(child, link);
3852 if (child != NULL) {
3853 TAILQ_FOREACH_FROM(child, &dev->children, link)
3854 BUS_RESUME_CHILD(dev, child);
3863 * @brief Helper function for implementing DEVICE_RESUME()
3865 * This function can be used to help implement the DEVICE_RESUME() for
3866 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3869 bus_generic_resume(device_t dev)
3873 TAILQ_FOREACH(child, &dev->children, link) {
3874 BUS_RESUME_CHILD(dev, child);
3875 /* if resume fails, there's nothing we can usefully do... */
3881 * @brief Helper function for implementing BUS_RESET_POST
3883 * Bus can use this function to implement common operations of
3884 * re-attaching or resuming the children after the bus itself was
3885 * reset, and after restoring bus-unique state of children.
3887 * @param dev The bus
3888 * #param flags DEVF_RESET_*
3891 bus_helper_reset_post(device_t dev, int flags)
3897 TAILQ_FOREACH(child, &dev->children,link) {
3898 BUS_RESET_POST(dev, child);
3899 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3900 device_probe_and_attach(child) :
3901 BUS_RESUME_CHILD(dev, child);
3902 if (error == 0 && error1 != 0)
3909 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3911 child = TAILQ_NEXT(child, link);
3914 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3915 BUS_RESET_POST(dev, child);
3916 if ((flags & DEVF_RESET_DETACH) != 0)
3917 device_probe_and_attach(child);
3919 BUS_RESUME_CHILD(dev, child);
3924 * @brief Helper function for implementing BUS_RESET_PREPARE
3926 * Bus can use this function to implement common operations of
3927 * detaching or suspending the children before the bus itself is
3928 * reset, and then save bus-unique state of children that must
3929 * persists around reset.
3931 * @param dev The bus
3932 * #param flags DEVF_RESET_*
3935 bus_helper_reset_prepare(device_t dev, int flags)
3940 if (dev->state != DS_ATTACHED)
3943 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3944 if ((flags & DEVF_RESET_DETACH) != 0) {
3945 error = device_get_state(child) == DS_ATTACHED ?
3946 device_detach(child) : 0;
3948 error = BUS_SUSPEND_CHILD(dev, child);
3951 error = BUS_RESET_PREPARE(dev, child);
3953 if ((flags & DEVF_RESET_DETACH) != 0)
3954 device_probe_and_attach(child);
3956 BUS_RESUME_CHILD(dev, child);
3960 bus_helper_reset_prepare_rollback(dev, child, flags);
3968 * @brief Helper function for implementing BUS_PRINT_CHILD().
3970 * This function prints the first part of the ascii representation of
3971 * @p child, including its name, unit and description (if any - see
3972 * device_set_desc()).
3974 * @returns the number of characters printed
3977 bus_print_child_header(device_t dev, device_t child)
3981 if (device_get_desc(child)) {
3982 retval += device_printf(child, "<%s>", device_get_desc(child));
3984 retval += printf("%s", device_get_nameunit(child));
3991 * @brief Helper function for implementing BUS_PRINT_CHILD().
3993 * This function prints the last part of the ascii representation of
3994 * @p child, which consists of the string @c " on " followed by the
3995 * name and unit of the @p dev.
3997 * @returns the number of characters printed
4000 bus_print_child_footer(device_t dev, device_t child)
4002 return (printf(" on %s\n", device_get_nameunit(dev)));
4006 * @brief Helper function for implementing BUS_PRINT_CHILD().
4008 * This function prints out the VM domain for the given device.
4010 * @returns the number of characters printed
4013 bus_print_child_domain(device_t dev, device_t child)
4017 /* No domain? Don't print anything */
4018 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4021 return (printf(" numa-domain %d", domain));
4025 * @brief Helper function for implementing BUS_PRINT_CHILD().
4027 * This function simply calls bus_print_child_header() followed by
4028 * bus_print_child_footer().
4030 * @returns the number of characters printed
4033 bus_generic_print_child(device_t dev, device_t child)
4037 retval += bus_print_child_header(dev, child);
4038 retval += bus_print_child_domain(dev, child);
4039 retval += bus_print_child_footer(dev, child);
4045 * @brief Stub function for implementing BUS_READ_IVAR().
4050 bus_generic_read_ivar(device_t dev, device_t child, int index,
4057 * @brief Stub function for implementing BUS_WRITE_IVAR().
4062 bus_generic_write_ivar(device_t dev, device_t child, int index,
4069 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4073 struct resource_list *
4074 bus_generic_get_resource_list(device_t dev, device_t child)
4080 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4082 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4083 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4084 * and then calls device_probe_and_attach() for each unattached child.
4087 bus_generic_driver_added(device_t dev, driver_t *driver)
4091 DEVICE_IDENTIFY(driver, dev);
4092 TAILQ_FOREACH(child, &dev->children, link) {
4093 if (child->state == DS_NOTPRESENT ||
4094 (child->flags & DF_REBID))
4095 device_probe_and_attach(child);
4100 * @brief Helper function for implementing BUS_NEW_PASS().
4102 * This implementing of BUS_NEW_PASS() first calls the identify
4103 * routines for any drivers that probe at the current pass. Then it
4104 * walks the list of devices for this bus. If a device is already
4105 * attached, then it calls BUS_NEW_PASS() on that device. If the
4106 * device is not already attached, it attempts to attach a driver to
4110 bus_generic_new_pass(device_t dev)
4117 TAILQ_FOREACH(dl, &dc->drivers, link) {
4118 if (dl->pass == bus_current_pass)
4119 DEVICE_IDENTIFY(dl->driver, dev);
4121 TAILQ_FOREACH(child, &dev->children, link) {
4122 if (child->state >= DS_ATTACHED)
4123 BUS_NEW_PASS(child);
4124 else if (child->state == DS_NOTPRESENT)
4125 device_probe_and_attach(child);
4130 * @brief Helper function for implementing BUS_SETUP_INTR().
4132 * This simple implementation of BUS_SETUP_INTR() simply calls the
4133 * BUS_SETUP_INTR() method of the parent of @p dev.
4136 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4137 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4140 /* Propagate up the bus hierarchy until someone handles it. */
4142 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4143 filter, intr, arg, cookiep));
4148 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4150 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4151 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4154 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4157 /* Propagate up the bus hierarchy until someone handles it. */
4159 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4164 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4166 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4167 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4170 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4172 /* Propagate up the bus hierarchy until someone handles it. */
4174 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4179 * @brief Helper function for implementing BUS_RESUME_INTR().
4181 * This simple implementation of BUS_RESUME_INTR() simply calls the
4182 * BUS_RESUME_INTR() method of the parent of @p dev.
4185 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4187 /* Propagate up the bus hierarchy until someone handles it. */
4189 return (BUS_RESUME_INTR(dev->parent, child, irq));
4194 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4196 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4197 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4200 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4201 struct resource *r, rman_res_t start, rman_res_t end)
4203 /* Propagate up the bus hierarchy until someone handles it. */
4205 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4211 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4213 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4214 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4217 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4218 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4220 /* Propagate up the bus hierarchy until someone handles it. */
4222 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4223 start, end, count, flags));
4228 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4230 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4231 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4234 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4237 /* Propagate up the bus hierarchy until someone handles it. */
4239 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4245 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4247 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4248 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4251 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4254 /* Propagate up the bus hierarchy until someone handles it. */
4256 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4262 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4264 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4265 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4268 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4269 int rid, struct resource *r)
4271 /* Propagate up the bus hierarchy until someone handles it. */
4273 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4279 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4281 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4282 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4285 bus_generic_map_resource(device_t dev, device_t child, int type,
4286 struct resource *r, struct resource_map_request *args,
4287 struct resource_map *map)
4289 /* Propagate up the bus hierarchy until someone handles it. */
4291 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4297 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4299 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4300 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4303 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4304 struct resource *r, struct resource_map *map)
4306 /* Propagate up the bus hierarchy until someone handles it. */
4308 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4313 * @brief Helper function for implementing BUS_BIND_INTR().
4315 * This simple implementation of BUS_BIND_INTR() simply calls the
4316 * BUS_BIND_INTR() method of the parent of @p dev.
4319 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4322 /* Propagate up the bus hierarchy until someone handles it. */
4324 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4329 * @brief Helper function for implementing BUS_CONFIG_INTR().
4331 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4332 * BUS_CONFIG_INTR() method of the parent of @p dev.
4335 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4336 enum intr_polarity pol)
4338 /* Propagate up the bus hierarchy until someone handles it. */
4340 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4345 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4347 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4348 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4351 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4352 void *cookie, const char *descr)
4354 /* Propagate up the bus hierarchy until someone handles it. */
4356 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4362 * @brief Helper function for implementing BUS_GET_CPUS().
4364 * This simple implementation of BUS_GET_CPUS() simply calls the
4365 * BUS_GET_CPUS() method of the parent of @p dev.
4368 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4369 size_t setsize, cpuset_t *cpuset)
4371 /* Propagate up the bus hierarchy until someone handles it. */
4372 if (dev->parent != NULL)
4373 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4378 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4380 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4381 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4384 bus_generic_get_dma_tag(device_t dev, device_t child)
4386 /* Propagate up the bus hierarchy until someone handles it. */
4387 if (dev->parent != NULL)
4388 return (BUS_GET_DMA_TAG(dev->parent, child));
4393 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4395 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4396 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4399 bus_generic_get_bus_tag(device_t dev, device_t child)
4401 /* Propagate up the bus hierarchy until someone handles it. */
4402 if (dev->parent != NULL)
4403 return (BUS_GET_BUS_TAG(dev->parent, child));
4404 return ((bus_space_tag_t)0);
4408 * @brief Helper function for implementing BUS_GET_RESOURCE().
4410 * This implementation of BUS_GET_RESOURCE() uses the
4411 * resource_list_find() function to do most of the work. It calls
4412 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4416 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4417 rman_res_t *startp, rman_res_t *countp)
4419 struct resource_list * rl = NULL;
4420 struct resource_list_entry * rle = NULL;
4422 rl = BUS_GET_RESOURCE_LIST(dev, child);
4426 rle = resource_list_find(rl, type, rid);
4431 *startp = rle->start;
4433 *countp = rle->count;
4439 * @brief Helper function for implementing BUS_SET_RESOURCE().
4441 * This implementation of BUS_SET_RESOURCE() uses the
4442 * resource_list_add() function to do most of the work. It calls
4443 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4447 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4448 rman_res_t start, rman_res_t count)
4450 struct resource_list * rl = NULL;
4452 rl = BUS_GET_RESOURCE_LIST(dev, child);
4456 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4462 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4464 * This implementation of BUS_DELETE_RESOURCE() uses the
4465 * resource_list_delete() function to do most of the work. It calls
4466 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4470 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4472 struct resource_list * rl = NULL;
4474 rl = BUS_GET_RESOURCE_LIST(dev, child);
4478 resource_list_delete(rl, type, rid);
4484 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4486 * This implementation of BUS_RELEASE_RESOURCE() uses the
4487 * resource_list_release() function to do most of the work. It calls
4488 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4491 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4492 int rid, struct resource *r)
4494 struct resource_list * rl = NULL;
4496 if (device_get_parent(child) != dev)
4497 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4500 rl = BUS_GET_RESOURCE_LIST(dev, child);
4504 return (resource_list_release(rl, dev, child, type, rid, r));
4508 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4510 * This implementation of BUS_ALLOC_RESOURCE() uses the
4511 * resource_list_alloc() function to do most of the work. It calls
4512 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4515 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4516 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4518 struct resource_list * rl = NULL;
4520 if (device_get_parent(child) != dev)
4521 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4522 type, rid, start, end, count, flags));
4524 rl = BUS_GET_RESOURCE_LIST(dev, child);
4528 return (resource_list_alloc(rl, dev, child, type, rid,
4529 start, end, count, flags));
4533 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4535 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4536 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4539 bus_generic_child_present(device_t dev, device_t child)
4541 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4545 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4548 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4554 * @brief Helper function for implementing BUS_RESCAN().
4556 * This null implementation of BUS_RESCAN() always fails to indicate
4557 * the bus does not support rescanning.
4560 bus_null_rescan(device_t dev)
4566 * Some convenience functions to make it easier for drivers to use the
4567 * resource-management functions. All these really do is hide the
4568 * indirection through the parent's method table, making for slightly
4569 * less-wordy code. In the future, it might make sense for this code
4570 * to maintain some sort of a list of resources allocated by each device.
4574 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4575 struct resource **res)
4579 for (i = 0; rs[i].type != -1; i++)
4581 for (i = 0; rs[i].type != -1; i++) {
4582 res[i] = bus_alloc_resource_any(dev,
4583 rs[i].type, &rs[i].rid, rs[i].flags);
4584 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4585 bus_release_resources(dev, rs, res);
4593 bus_release_resources(device_t dev, const struct resource_spec *rs,
4594 struct resource **res)
4598 for (i = 0; rs[i].type != -1; i++)
4599 if (res[i] != NULL) {
4600 bus_release_resource(
4601 dev, rs[i].type, rs[i].rid, res[i]);
4607 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4609 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4613 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4614 rman_res_t end, rman_res_t count, u_int flags)
4616 struct resource *res;
4618 if (dev->parent == NULL)
4620 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4626 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4628 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4632 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4635 if (dev->parent == NULL)
4637 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4641 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4643 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4647 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4649 if (dev->parent == NULL)
4651 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4655 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4657 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4661 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4663 if (dev->parent == NULL)
4665 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4669 * @brief Wrapper function for BUS_MAP_RESOURCE().
4671 * This function simply calls the BUS_MAP_RESOURCE() method of the
4675 bus_map_resource(device_t dev, int type, struct resource *r,
4676 struct resource_map_request *args, struct resource_map *map)
4678 if (dev->parent == NULL)
4680 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4684 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4686 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4690 bus_unmap_resource(device_t dev, int type, struct resource *r,
4691 struct resource_map *map)
4693 if (dev->parent == NULL)
4695 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4699 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4701 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4705 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4709 if (dev->parent == NULL)
4711 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4716 * @brief Wrapper function for BUS_SETUP_INTR().
4718 * This function simply calls the BUS_SETUP_INTR() method of the
4722 bus_setup_intr(device_t dev, struct resource *r, int flags,
4723 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4727 if (dev->parent == NULL)
4729 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4733 if (handler != NULL && !(flags & INTR_MPSAFE))
4734 device_printf(dev, "[GIANT-LOCKED]\n");
4739 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4741 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4745 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4747 if (dev->parent == NULL)
4749 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4753 * @brief Wrapper function for BUS_SUSPEND_INTR().
4755 * This function simply calls the BUS_SUSPEND_INTR() method of the
4759 bus_suspend_intr(device_t dev, struct resource *r)
4761 if (dev->parent == NULL)
4763 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4767 * @brief Wrapper function for BUS_RESUME_INTR().
4769 * This function simply calls the BUS_RESUME_INTR() method of the
4773 bus_resume_intr(device_t dev, struct resource *r)
4775 if (dev->parent == NULL)
4777 return (BUS_RESUME_INTR(dev->parent, dev, r));
4781 * @brief Wrapper function for BUS_BIND_INTR().
4783 * This function simply calls the BUS_BIND_INTR() method of the
4787 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4789 if (dev->parent == NULL)
4791 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4795 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4797 * This function first formats the requested description into a
4798 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4799 * the parent of @p dev.
4802 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4803 const char *fmt, ...)
4806 char descr[MAXCOMLEN + 1];
4808 if (dev->parent == NULL)
4811 vsnprintf(descr, sizeof(descr), fmt, ap);
4813 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4817 * @brief Wrapper function for BUS_SET_RESOURCE().
4819 * This function simply calls the BUS_SET_RESOURCE() method of the
4823 bus_set_resource(device_t dev, int type, int rid,
4824 rman_res_t start, rman_res_t count)
4826 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4831 * @brief Wrapper function for BUS_GET_RESOURCE().
4833 * This function simply calls the BUS_GET_RESOURCE() method of the
4837 bus_get_resource(device_t dev, int type, int rid,
4838 rman_res_t *startp, rman_res_t *countp)
4840 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4845 * @brief Wrapper function for BUS_GET_RESOURCE().
4847 * This function simply calls the BUS_GET_RESOURCE() method of the
4848 * parent of @p dev and returns the start value.
4851 bus_get_resource_start(device_t dev, int type, int rid)
4857 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4865 * @brief Wrapper function for BUS_GET_RESOURCE().
4867 * This function simply calls the BUS_GET_RESOURCE() method of the
4868 * parent of @p dev and returns the count value.
4871 bus_get_resource_count(device_t dev, int type, int rid)
4877 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4885 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4887 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4891 bus_delete_resource(device_t dev, int type, int rid)
4893 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4897 * @brief Wrapper function for BUS_CHILD_PRESENT().
4899 * This function simply calls the BUS_CHILD_PRESENT() method of the
4903 bus_child_present(device_t child)
4905 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4909 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4911 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4915 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4919 parent = device_get_parent(child);
4920 if (parent == NULL) {
4924 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4928 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4930 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4934 bus_child_location_str(device_t child, char *buf, size_t buflen)
4938 parent = device_get_parent(child);
4939 if (parent == NULL) {
4943 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4947 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
4949 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
4950 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
4951 * accomplish this, however. It is an interim function until we can convert
4952 * this interface more fully.
4954 /* Note: we reach inside of sbuf because it's API isn't rich enough to do this */
4955 #define SPACE(s) ((s)->s_size - (s)->s_len)
4956 #define EOB(s) ((s)->s_buf + (s)->s_len)
4959 bus_child_pnpinfo_sb(device_t dev, struct sbuf *sb)
4964 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
4965 MPASS(sb->s_size >= sb->s_len);
4966 if (sb->s_error != 0)
4970 sb->s_error = ENOMEM;
4974 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
4975 bus_child_pnpinfo_str(dev, p, space);
4976 sb->s_len += strlen(p);
4981 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
4983 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
4984 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
4985 * accomplish this, however. It is an interim function until we can convert
4986 * this interface more fully.
4989 bus_child_location_sb(device_t dev, struct sbuf *sb)
4994 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
4995 MPASS(sb->s_size >= sb->s_len);
4996 if (sb->s_error != 0)
5000 sb->s_error = ENOMEM;
5004 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5005 bus_child_location_str(dev, p, space);
5006 sb->s_len += strlen(p);
5013 * @brief Wrapper function for BUS_GET_CPUS().
5015 * This function simply calls the BUS_GET_CPUS() method of the
5019 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5023 parent = device_get_parent(dev);
5026 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5030 * @brief Wrapper function for BUS_GET_DMA_TAG().
5032 * This function simply calls the BUS_GET_DMA_TAG() method of the
5036 bus_get_dma_tag(device_t dev)
5040 parent = device_get_parent(dev);
5043 return (BUS_GET_DMA_TAG(parent, dev));
5047 * @brief Wrapper function for BUS_GET_BUS_TAG().
5049 * This function simply calls the BUS_GET_BUS_TAG() method of the
5053 bus_get_bus_tag(device_t dev)
5057 parent = device_get_parent(dev);
5059 return ((bus_space_tag_t)0);
5060 return (BUS_GET_BUS_TAG(parent, dev));
5064 * @brief Wrapper function for BUS_GET_DOMAIN().
5066 * This function simply calls the BUS_GET_DOMAIN() method of the
5070 bus_get_domain(device_t dev, int *domain)
5072 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5075 /* Resume all devices and then notify userland that we're up again. */
5077 root_resume(device_t dev)
5081 error = bus_generic_resume(dev);
5083 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5084 devctl_notify("kernel", "power", "resume", NULL);
5090 root_print_child(device_t dev, device_t child)
5094 retval += bus_print_child_header(dev, child);
5095 retval += printf("\n");
5101 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5102 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5105 * If an interrupt mapping gets to here something bad has happened.
5107 panic("root_setup_intr");
5111 * If we get here, assume that the device is permanent and really is
5112 * present in the system. Removable bus drivers are expected to intercept
5113 * this call long before it gets here. We return -1 so that drivers that
5114 * really care can check vs -1 or some ERRNO returned higher in the food
5118 root_child_present(device_t dev, device_t child)
5124 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5129 /* Default to returning the set of all CPUs. */
5130 if (setsize != sizeof(cpuset_t))
5139 static kobj_method_t root_methods[] = {
5140 /* Device interface */
5141 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5142 KOBJMETHOD(device_suspend, bus_generic_suspend),
5143 KOBJMETHOD(device_resume, root_resume),
5146 KOBJMETHOD(bus_print_child, root_print_child),
5147 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5148 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5149 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5150 KOBJMETHOD(bus_child_present, root_child_present),
5151 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5156 static driver_t root_driver = {
5163 devclass_t root_devclass;
5166 root_bus_module_handler(module_t mod, int what, void* arg)
5170 TAILQ_INIT(&bus_data_devices);
5171 kobj_class_compile((kobj_class_t) &root_driver);
5172 root_bus = make_device(NULL, "root", 0);
5173 root_bus->desc = "System root bus";
5174 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5175 root_bus->driver = &root_driver;
5176 root_bus->state = DS_ATTACHED;
5177 root_devclass = devclass_find_internal("root", NULL, FALSE);
5182 device_shutdown(root_bus);
5185 return (EOPNOTSUPP);
5191 static moduledata_t root_bus_mod = {
5193 root_bus_module_handler,
5196 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5199 * @brief Automatically configure devices
5201 * This function begins the autoconfiguration process by calling
5202 * device_probe_and_attach() for each child of the @c root0 device.
5205 root_bus_configure(void)
5209 /* Eventually this will be split up, but this is sufficient for now. */
5210 bus_set_pass(BUS_PASS_DEFAULT);
5214 * @brief Module handler for registering device drivers
5216 * This module handler is used to automatically register device
5217 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5218 * devclass_add_driver() for the driver described by the
5219 * driver_module_data structure pointed to by @p arg
5222 driver_module_handler(module_t mod, int what, void *arg)
5224 struct driver_module_data *dmd;
5225 devclass_t bus_devclass;
5226 kobj_class_t driver;
5229 dmd = (struct driver_module_data *)arg;
5230 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5235 if (dmd->dmd_chainevh)
5236 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5238 pass = dmd->dmd_pass;
5239 driver = dmd->dmd_driver;
5240 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5241 DRIVERNAME(driver), dmd->dmd_busname, pass));
5242 error = devclass_add_driver(bus_devclass, driver, pass,
5247 PDEBUG(("Unloading module: driver %s from bus %s",
5248 DRIVERNAME(dmd->dmd_driver),
5250 error = devclass_delete_driver(bus_devclass,
5253 if (!error && dmd->dmd_chainevh)
5254 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5257 PDEBUG(("Quiesce module: driver %s from bus %s",
5258 DRIVERNAME(dmd->dmd_driver),
5260 error = devclass_quiesce_driver(bus_devclass,
5263 if (!error && dmd->dmd_chainevh)
5264 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5275 * @brief Enumerate all hinted devices for this bus.
5277 * Walks through the hints for this bus and calls the bus_hinted_child
5278 * routine for each one it fines. It searches first for the specific
5279 * bus that's being probed for hinted children (eg isa0), and then for
5280 * generic children (eg isa).
5282 * @param dev bus device to enumerate
5285 bus_enumerate_hinted_children(device_t bus)
5288 const char *dname, *busname;
5292 * enumerate all devices on the specific bus
5294 busname = device_get_nameunit(bus);
5296 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5297 BUS_HINTED_CHILD(bus, dname, dunit);
5300 * and all the generic ones.
5302 busname = device_get_name(bus);
5304 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5305 BUS_HINTED_CHILD(bus, dname, dunit);
5310 /* the _short versions avoid iteration by not calling anything that prints
5311 * more than oneliners. I love oneliners.
5315 print_device_short(device_t dev, int indent)
5320 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5321 dev->unit, dev->desc,
5322 (dev->parent? "":"no "),
5323 (TAILQ_EMPTY(&dev->children)? "no ":""),
5324 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5325 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5326 (dev->flags&DF_WILDCARD? "wildcard,":""),
5327 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5328 (dev->flags&DF_REBID? "rebiddable,":""),
5329 (dev->flags&DF_SUSPENDED? "suspended,":""),
5330 (dev->ivars? "":"no "),
5331 (dev->softc? "":"no "),
5336 print_device(device_t dev, int indent)
5341 print_device_short(dev, indent);
5343 indentprintf(("Parent:\n"));
5344 print_device_short(dev->parent, indent+1);
5345 indentprintf(("Driver:\n"));
5346 print_driver_short(dev->driver, indent+1);
5347 indentprintf(("Devclass:\n"));
5348 print_devclass_short(dev->devclass, indent+1);
5352 print_device_tree_short(device_t dev, int indent)
5353 /* print the device and all its children (indented) */
5360 print_device_short(dev, indent);
5362 TAILQ_FOREACH(child, &dev->children, link) {
5363 print_device_tree_short(child, indent+1);
5368 print_device_tree(device_t dev, int indent)
5369 /* print the device and all its children (indented) */
5376 print_device(dev, indent);
5378 TAILQ_FOREACH(child, &dev->children, link) {
5379 print_device_tree(child, indent+1);
5384 print_driver_short(driver_t *driver, int indent)
5389 indentprintf(("driver %s: softc size = %zd\n",
5390 driver->name, driver->size));
5394 print_driver(driver_t *driver, int indent)
5399 print_driver_short(driver, indent);
5403 print_driver_list(driver_list_t drivers, int indent)
5405 driverlink_t driver;
5407 TAILQ_FOREACH(driver, &drivers, link) {
5408 print_driver(driver->driver, indent);
5413 print_devclass_short(devclass_t dc, int indent)
5418 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5422 print_devclass(devclass_t dc, int indent)
5429 print_devclass_short(dc, indent);
5430 indentprintf(("Drivers:\n"));
5431 print_driver_list(dc->drivers, indent+1);
5433 indentprintf(("Devices:\n"));
5434 for (i = 0; i < dc->maxunit; i++)
5436 print_device(dc->devices[i], indent+1);
5440 print_devclass_list_short(void)
5444 printf("Short listing of devclasses, drivers & devices:\n");
5445 TAILQ_FOREACH(dc, &devclasses, link) {
5446 print_devclass_short(dc, 0);
5451 print_devclass_list(void)
5455 printf("Full listing of devclasses, drivers & devices:\n");
5456 TAILQ_FOREACH(dc, &devclasses, link) {
5457 print_devclass(dc, 0);
5464 * User-space access to the device tree.
5466 * We implement a small set of nodes:
5468 * hw.bus Single integer read method to obtain the
5469 * current generation count.
5470 * hw.bus.devices Reads the entire device tree in flat space.
5471 * hw.bus.rman Resource manager interface
5473 * We might like to add the ability to scan devclasses and/or drivers to
5474 * determine what else is currently loaded/available.
5478 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5480 struct u_businfo ubus;
5482 ubus.ub_version = BUS_USER_VERSION;
5483 ubus.ub_generation = bus_data_generation;
5485 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5487 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5488 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5489 "bus-related data");
5492 sysctl_devices(SYSCTL_HANDLER_ARGS)
5495 int *name = (int *)arg1;
5496 u_int namelen = arg2;
5499 struct u_device *udev;
5505 if (bus_data_generation_check(name[0]))
5511 * Scan the list of devices, looking for the requested index.
5513 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5521 * Populate the return item, careful not to overflow the buffer.
5523 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5526 udev->dv_handle = (uintptr_t)dev;
5527 udev->dv_parent = (uintptr_t)dev->parent;
5528 udev->dv_devflags = dev->devflags;
5529 udev->dv_flags = dev->flags;
5530 udev->dv_state = dev->state;
5531 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5532 if (dev->nameunit != NULL)
5533 sbuf_cat(&sb, dev->nameunit);
5534 sbuf_putc(&sb, '\0');
5535 if (dev->desc != NULL)
5536 sbuf_cat(&sb, dev->desc);
5537 sbuf_putc(&sb, '\0');
5538 if (dev->driver != NULL)
5539 sbuf_cat(&sb, dev->driver->name);
5540 sbuf_putc(&sb, '\0');
5541 bus_child_pnpinfo_sb(dev, &sb);
5542 sbuf_putc(&sb, '\0');
5543 bus_child_location_sb(dev, &sb);
5544 sbuf_putc(&sb, '\0');
5545 error = sbuf_finish(&sb);
5547 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5553 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5554 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5555 "system device tree");
5558 bus_data_generation_check(int generation)
5560 if (generation != bus_data_generation)
5563 /* XXX generate optimised lists here? */
5568 bus_data_generation_update(void)
5570 atomic_add_int(&bus_data_generation, 1);
5574 bus_free_resource(device_t dev, int type, struct resource *r)
5578 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5582 device_lookup_by_name(const char *name)
5586 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5587 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5594 * /dev/devctl2 implementation. The existing /dev/devctl device has
5595 * implicit semantics on open, so it could not be reused for this.
5596 * Another option would be to call this /dev/bus?
5599 find_device(struct devreq *req, device_t *devp)
5604 * First, ensure that the name is nul terminated.
5606 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5610 * Second, try to find an attached device whose name matches
5613 dev = device_lookup_by_name(req->dr_name);
5619 /* Finally, give device enumerators a chance. */
5621 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5629 driver_exists(device_t bus, const char *driver)
5633 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5634 if (devclass_find_driver_internal(dc, driver) != NULL)
5641 device_gen_nomatch(device_t dev)
5645 if (dev->flags & DF_NEEDNOMATCH &&
5646 dev->state == DS_NOTPRESENT) {
5647 BUS_PROBE_NOMATCH(dev->parent, dev);
5649 dev->flags |= DF_DONENOMATCH;
5651 dev->flags &= ~DF_NEEDNOMATCH;
5652 TAILQ_FOREACH(child, &dev->children, link) {
5653 device_gen_nomatch(child);
5658 device_do_deferred_actions(void)
5664 * Walk through the devclasses to find all the drivers we've tagged as
5665 * deferred during the freeze and call the driver added routines. They
5666 * have already been added to the lists in the background, so the driver
5667 * added routines that trigger a probe will have all the right bidders
5668 * for the probe auction.
5670 TAILQ_FOREACH(dc, &devclasses, link) {
5671 TAILQ_FOREACH(dl, &dc->drivers, link) {
5672 if (dl->flags & DL_DEFERRED_PROBE) {
5673 devclass_driver_added(dc, dl->driver);
5674 dl->flags &= ~DL_DEFERRED_PROBE;
5680 * We also defer no-match events during a freeze. Walk the tree and
5681 * generate all the pent-up events that are still relevant.
5683 device_gen_nomatch(root_bus);
5684 bus_data_generation_update();
5688 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5695 /* Locate the device to control. */
5697 req = (struct devreq *)data;
5705 case DEV_SET_DRIVER:
5706 case DEV_CLEAR_DRIVER:
5710 error = priv_check(td, PRIV_DRIVER);
5712 error = find_device(req, &dev);
5716 error = priv_check(td, PRIV_DRIVER);
5727 /* Perform the requested operation. */
5730 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5732 else if (!device_is_enabled(dev))
5735 error = device_probe_and_attach(dev);
5738 if (!device_is_attached(dev)) {
5742 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5743 error = device_quiesce(dev);
5747 error = device_detach(dev);
5750 if (device_is_enabled(dev)) {
5756 * If the device has been probed but not attached (e.g.
5757 * when it has been disabled by a loader hint), just
5758 * attach the device rather than doing a full probe.
5761 if (device_is_alive(dev)) {
5763 * If the device was disabled via a hint, clear
5766 if (resource_disabled(dev->driver->name, dev->unit))
5767 resource_unset_value(dev->driver->name,
5768 dev->unit, "disabled");
5769 error = device_attach(dev);
5771 error = device_probe_and_attach(dev);
5774 if (!device_is_enabled(dev)) {
5779 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5780 error = device_quiesce(dev);
5786 * Force DF_FIXEDCLASS on around detach to preserve
5787 * the existing name.
5790 dev->flags |= DF_FIXEDCLASS;
5791 error = device_detach(dev);
5792 if (!(old & DF_FIXEDCLASS))
5793 dev->flags &= ~DF_FIXEDCLASS;
5795 device_disable(dev);
5798 if (device_is_suspended(dev)) {
5802 if (device_get_parent(dev) == NULL) {
5806 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5809 if (!device_is_suspended(dev)) {
5813 if (device_get_parent(dev) == NULL) {
5817 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5819 case DEV_SET_DRIVER: {
5823 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5826 if (driver[0] == '\0') {
5830 if (dev->devclass != NULL &&
5831 strcmp(driver, dev->devclass->name) == 0)
5832 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5836 * Scan drivers for this device's bus looking for at
5837 * least one matching driver.
5839 if (dev->parent == NULL) {
5843 if (!driver_exists(dev->parent, driver)) {
5847 dc = devclass_create(driver);
5853 /* Detach device if necessary. */
5854 if (device_is_attached(dev)) {
5855 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5856 error = device_detach(dev);
5863 /* Clear any previously-fixed device class and unit. */
5864 if (dev->flags & DF_FIXEDCLASS)
5865 devclass_delete_device(dev->devclass, dev);
5866 dev->flags |= DF_WILDCARD;
5869 /* Force the new device class. */
5870 error = devclass_add_device(dc, dev);
5873 dev->flags |= DF_FIXEDCLASS;
5874 error = device_probe_and_attach(dev);
5877 case DEV_CLEAR_DRIVER:
5878 if (!(dev->flags & DF_FIXEDCLASS)) {
5882 if (device_is_attached(dev)) {
5883 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5884 error = device_detach(dev);
5891 dev->flags &= ~DF_FIXEDCLASS;
5892 dev->flags |= DF_WILDCARD;
5893 devclass_delete_device(dev->devclass, dev);
5894 error = device_probe_and_attach(dev);
5897 if (!device_is_attached(dev)) {
5901 error = BUS_RESCAN(dev);
5906 parent = device_get_parent(dev);
5907 if (parent == NULL) {
5911 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5912 if (bus_child_present(dev) != 0) {
5918 error = device_delete_child(parent, dev);
5925 device_frozen = true;
5931 device_do_deferred_actions();
5932 device_frozen = false;
5936 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5940 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5948 static struct cdevsw devctl2_cdevsw = {
5949 .d_version = D_VERSION,
5950 .d_ioctl = devctl2_ioctl,
5951 .d_name = "devctl2",
5957 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5958 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5962 * APIs to manage deprecation and obsolescence.
5964 static int obsolete_panic = 0;
5965 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5966 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5967 "2 = if deprecated)");
5970 gone_panic(int major, int running, const char *msg)
5972 switch (obsolete_panic)
5977 if (running < major)
5986 _gone_in(int major, const char *msg)
5988 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5989 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5990 printf("Obsolete code will be removed soon: %s\n", msg);
5992 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5997 _gone_in_dev(device_t dev, int major, const char *msg)
5999 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6000 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6002 "Obsolete code will be removed soon: %s\n", msg);
6005 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6010 DB_SHOW_COMMAND(device, db_show_device)
6017 dev = (device_t)addr;
6019 db_printf("name: %s\n", device_get_nameunit(dev));
6020 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6021 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6022 db_printf(" addr: %p\n", dev);
6023 db_printf(" parent: %p\n", dev->parent);
6024 db_printf(" softc: %p\n", dev->softc);
6025 db_printf(" ivars: %p\n", dev->ivars);
6028 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6032 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6033 db_show_device((db_expr_t)dev, true, count, modif);