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_MPSAFE,
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);
879 mtx_lock(bus_topo_mtx());
883 bus_topo_unlock(void)
886 mtx_unlock(bus_topo_mtx());
890 * Bus pass implementation
893 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
894 int bus_current_pass = BUS_PASS_ROOT;
898 * @brief Register the pass level of a new driver attachment
900 * Register a new driver attachment's pass level. If no driver
901 * attachment with the same pass level has been added, then @p new
902 * will be added to the global passes list.
904 * @param new the new driver attachment
907 driver_register_pass(struct driverlink *new)
909 struct driverlink *dl;
911 /* We only consider pass numbers during boot. */
912 if (bus_current_pass == BUS_PASS_DEFAULT)
916 * Walk the passes list. If we already know about this pass
917 * then there is nothing to do. If we don't, then insert this
918 * driver link into the list.
920 TAILQ_FOREACH(dl, &passes, passlink) {
921 if (dl->pass < new->pass)
923 if (dl->pass == new->pass)
925 TAILQ_INSERT_BEFORE(dl, new, passlink);
928 TAILQ_INSERT_TAIL(&passes, new, passlink);
932 * @brief Raise the current bus pass
934 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
935 * method on the root bus to kick off a new device tree scan for each
936 * new pass level that has at least one driver.
939 bus_set_pass(int pass)
941 struct driverlink *dl;
943 if (bus_current_pass > pass)
944 panic("Attempt to lower bus pass level");
946 TAILQ_FOREACH(dl, &passes, passlink) {
947 /* Skip pass values below the current pass level. */
948 if (dl->pass <= bus_current_pass)
952 * Bail once we hit a driver with a pass level that is
959 * Raise the pass level to the next level and rescan
962 bus_current_pass = dl->pass;
963 BUS_NEW_PASS(root_bus);
967 * If there isn't a driver registered for the requested pass,
968 * then bus_current_pass might still be less than 'pass'. Set
969 * it to 'pass' in that case.
971 if (bus_current_pass < pass)
972 bus_current_pass = pass;
973 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
977 * Devclass implementation
980 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
984 * @brief Find or create a device class
986 * If a device class with the name @p classname exists, return it,
987 * otherwise if @p create is non-zero create and return a new device
990 * If @p parentname is non-NULL, the parent of the devclass is set to
991 * the devclass of that name.
993 * @param classname the devclass name to find or create
994 * @param parentname the parent devclass name or @c NULL
995 * @param create non-zero to create a devclass
998 devclass_find_internal(const char *classname, const char *parentname,
1003 PDEBUG(("looking for %s", classname));
1007 TAILQ_FOREACH(dc, &devclasses, link) {
1008 if (!strcmp(dc->name, classname))
1012 if (create && !dc) {
1013 PDEBUG(("creating %s", classname));
1014 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1015 M_BUS, M_NOWAIT | M_ZERO);
1019 dc->name = (char*) (dc + 1);
1020 strcpy(dc->name, classname);
1021 TAILQ_INIT(&dc->drivers);
1022 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1024 bus_data_generation_update();
1028 * If a parent class is specified, then set that as our parent so
1029 * that this devclass will support drivers for the parent class as
1030 * well. If the parent class has the same name don't do this though
1031 * as it creates a cycle that can trigger an infinite loop in
1032 * device_probe_child() if a device exists for which there is no
1035 if (parentname && dc && !dc->parent &&
1036 strcmp(classname, parentname) != 0) {
1037 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1038 dc->parent->flags |= DC_HAS_CHILDREN;
1045 * @brief Create a device class
1047 * If a device class with the name @p classname exists, return it,
1048 * otherwise create and return a new device class.
1050 * @param classname the devclass name to find or create
1053 devclass_create(const char *classname)
1055 return (devclass_find_internal(classname, NULL, TRUE));
1059 * @brief Find a device class
1061 * If a device class with the name @p classname exists, return it,
1062 * otherwise return @c NULL.
1064 * @param classname the devclass name to find
1067 devclass_find(const char *classname)
1069 return (devclass_find_internal(classname, NULL, FALSE));
1073 * @brief Register that a device driver has been added to a devclass
1075 * Register that a device driver has been added to a devclass. This
1076 * is called by devclass_add_driver to accomplish the recursive
1077 * notification of all the children classes of dc, as well as dc.
1078 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1081 * We do a full search here of the devclass list at each iteration
1082 * level to save storing children-lists in the devclass structure. If
1083 * we ever move beyond a few dozen devices doing this, we may need to
1086 * @param dc the devclass to edit
1087 * @param driver the driver that was just added
1090 devclass_driver_added(devclass_t dc, driver_t *driver)
1096 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1098 for (i = 0; i < dc->maxunit; i++)
1099 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1100 BUS_DRIVER_ADDED(dc->devices[i], driver);
1103 * Walk through the children classes. Since we only keep a
1104 * single parent pointer around, we walk the entire list of
1105 * devclasses looking for children. We set the
1106 * DC_HAS_CHILDREN flag when a child devclass is created on
1107 * the parent, so we only walk the list for those devclasses
1108 * that have children.
1110 if (!(dc->flags & DC_HAS_CHILDREN))
1113 TAILQ_FOREACH(dc, &devclasses, link) {
1114 if (dc->parent == parent)
1115 devclass_driver_added(dc, driver);
1120 * @brief Add a device driver to a device class
1122 * Add a device driver to a devclass. This is normally called
1123 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1124 * all devices in the devclass will be called to allow them to attempt
1125 * to re-probe any unmatched children.
1127 * @param dc the devclass to edit
1128 * @param driver the driver to register
1131 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1134 devclass_t child_dc;
1135 const char *parentname;
1137 PDEBUG(("%s", DRIVERNAME(driver)));
1139 /* Don't allow invalid pass values. */
1140 if (pass <= BUS_PASS_ROOT)
1143 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1148 * Compile the driver's methods. Also increase the reference count
1149 * so that the class doesn't get freed when the last instance
1150 * goes. This means we can safely use static methods and avoids a
1151 * double-free in devclass_delete_driver.
1153 kobj_class_compile((kobj_class_t) driver);
1156 * If the driver has any base classes, make the
1157 * devclass inherit from the devclass of the driver's
1158 * first base class. This will allow the system to
1159 * search for drivers in both devclasses for children
1160 * of a device using this driver.
1162 if (driver->baseclasses)
1163 parentname = driver->baseclasses[0]->name;
1166 child_dc = devclass_find_internal(driver->name, parentname, TRUE);
1170 dl->driver = driver;
1171 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1172 driver->refs++; /* XXX: kobj_mtx */
1174 driver_register_pass(dl);
1176 if (device_frozen) {
1177 dl->flags |= DL_DEFERRED_PROBE;
1179 devclass_driver_added(dc, driver);
1181 bus_data_generation_update();
1186 * @brief Register that a device driver has been deleted from a devclass
1188 * Register that a device driver has been removed from a devclass.
1189 * This is called by devclass_delete_driver to accomplish the
1190 * recursive notification of all the children classes of busclass, as
1191 * well as busclass. Each layer will attempt to detach the driver
1192 * from any devices that are children of the bus's devclass. The function
1193 * will return an error if a device fails to detach.
1195 * We do a full search here of the devclass list at each iteration
1196 * level to save storing children-lists in the devclass structure. If
1197 * we ever move beyond a few dozen devices doing this, we may need to
1200 * @param busclass the devclass of the parent bus
1201 * @param dc the devclass of the driver being deleted
1202 * @param driver the driver being deleted
1205 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1212 * Disassociate from any devices. We iterate through all the
1213 * devices in the devclass of the driver and detach any which are
1214 * using the driver and which have a parent in the devclass which
1215 * we are deleting from.
1217 * Note that since a driver can be in multiple devclasses, we
1218 * should not detach devices which are not children of devices in
1219 * the affected devclass.
1221 * If we're frozen, we don't generate NOMATCH events. Mark to
1224 for (i = 0; i < dc->maxunit; i++) {
1225 if (dc->devices[i]) {
1226 dev = dc->devices[i];
1227 if (dev->driver == driver && dev->parent &&
1228 dev->parent->devclass == busclass) {
1229 if ((error = device_detach(dev)) != 0)
1231 if (device_frozen) {
1232 dev->flags &= ~DF_DONENOMATCH;
1233 dev->flags |= DF_NEEDNOMATCH;
1235 BUS_PROBE_NOMATCH(dev->parent, dev);
1237 dev->flags |= DF_DONENOMATCH;
1244 * Walk through the children classes. Since we only keep a
1245 * single parent pointer around, we walk the entire list of
1246 * devclasses looking for children. We set the
1247 * DC_HAS_CHILDREN flag when a child devclass is created on
1248 * the parent, so we only walk the list for those devclasses
1249 * that have children.
1251 if (!(busclass->flags & DC_HAS_CHILDREN))
1254 TAILQ_FOREACH(busclass, &devclasses, link) {
1255 if (busclass->parent == parent) {
1256 error = devclass_driver_deleted(busclass, dc, driver);
1265 * @brief Delete a device driver from a device class
1267 * Delete a device driver from a devclass. This is normally called
1268 * automatically by DRIVER_MODULE().
1270 * If the driver is currently attached to any devices,
1271 * devclass_delete_driver() will first attempt to detach from each
1272 * device. If one of the detach calls fails, the driver will not be
1275 * @param dc the devclass to edit
1276 * @param driver the driver to unregister
1279 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1281 devclass_t dc = devclass_find(driver->name);
1285 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1291 * Find the link structure in the bus' list of drivers.
1293 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1294 if (dl->driver == driver)
1299 PDEBUG(("%s not found in %s list", driver->name,
1304 error = devclass_driver_deleted(busclass, dc, driver);
1308 TAILQ_REMOVE(&busclass->drivers, dl, link);
1313 if (driver->refs == 0)
1314 kobj_class_free((kobj_class_t) driver);
1316 bus_data_generation_update();
1321 * @brief Quiesces a set of device drivers from a device class
1323 * Quiesce a device driver from a devclass. This is normally called
1324 * automatically by DRIVER_MODULE().
1326 * If the driver is currently attached to any devices,
1327 * devclass_quiesece_driver() will first attempt to quiesce each
1330 * @param dc the devclass to edit
1331 * @param driver the driver to unregister
1334 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1336 devclass_t dc = devclass_find(driver->name);
1342 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1348 * Find the link structure in the bus' list of drivers.
1350 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1351 if (dl->driver == driver)
1356 PDEBUG(("%s not found in %s list", driver->name,
1362 * Quiesce all devices. We iterate through all the devices in
1363 * the devclass of the driver and quiesce any which are using
1364 * the driver and which have a parent in the devclass which we
1367 * Note that since a driver can be in multiple devclasses, we
1368 * should not quiesce devices which are not children of
1369 * devices in the affected devclass.
1371 for (i = 0; i < dc->maxunit; i++) {
1372 if (dc->devices[i]) {
1373 dev = dc->devices[i];
1374 if (dev->driver == driver && dev->parent &&
1375 dev->parent->devclass == busclass) {
1376 if ((error = device_quiesce(dev)) != 0)
1389 devclass_find_driver_internal(devclass_t dc, const char *classname)
1393 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1395 TAILQ_FOREACH(dl, &dc->drivers, link) {
1396 if (!strcmp(dl->driver->name, classname))
1400 PDEBUG(("not found"));
1405 * @brief Return the name of the devclass
1408 devclass_get_name(devclass_t dc)
1414 * @brief Find a device given a unit number
1416 * @param dc the devclass to search
1417 * @param unit the unit number to search for
1419 * @returns the device with the given unit number or @c
1420 * NULL if there is no such device
1423 devclass_get_device(devclass_t dc, int unit)
1425 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1427 return (dc->devices[unit]);
1431 * @brief Find the softc field of a device given a unit number
1433 * @param dc the devclass to search
1434 * @param unit the unit number to search for
1436 * @returns the softc field of the device with the given
1437 * unit number or @c NULL if there is no such
1441 devclass_get_softc(devclass_t dc, int unit)
1445 dev = devclass_get_device(dc, unit);
1449 return (device_get_softc(dev));
1453 * @brief Get a list of devices in the devclass
1455 * An array containing a list of all the devices in the given devclass
1456 * is allocated and returned in @p *devlistp. The number of devices
1457 * in the array is returned in @p *devcountp. The caller should free
1458 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1460 * @param dc the devclass to examine
1461 * @param devlistp points at location for array pointer return
1463 * @param devcountp points at location for array size return value
1466 * @retval ENOMEM the array allocation failed
1469 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1474 count = devclass_get_count(dc);
1475 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1480 for (i = 0; i < dc->maxunit; i++) {
1481 if (dc->devices[i]) {
1482 list[count] = dc->devices[i];
1494 * @brief Get a list of drivers in the devclass
1496 * An array containing a list of pointers to all the drivers in the
1497 * given devclass is allocated and returned in @p *listp. The number
1498 * of drivers in the array is returned in @p *countp. The caller should
1499 * free the array using @c free(p, M_TEMP).
1501 * @param dc the devclass to examine
1502 * @param listp gives location for array pointer return value
1503 * @param countp gives location for number of array elements
1507 * @retval ENOMEM the array allocation failed
1510 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1517 TAILQ_FOREACH(dl, &dc->drivers, link)
1519 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1524 TAILQ_FOREACH(dl, &dc->drivers, link) {
1525 list[count] = dl->driver;
1535 * @brief Get the number of devices in a devclass
1537 * @param dc the devclass to examine
1540 devclass_get_count(devclass_t dc)
1545 for (i = 0; i < dc->maxunit; i++)
1552 * @brief Get the maximum unit number used in a devclass
1554 * Note that this is one greater than the highest currently-allocated
1555 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1556 * that not even the devclass has been allocated yet.
1558 * @param dc the devclass to examine
1561 devclass_get_maxunit(devclass_t dc)
1565 return (dc->maxunit);
1569 * @brief Find a free unit number in a devclass
1571 * This function searches for the first unused unit number greater
1572 * that or equal to @p unit.
1574 * @param dc the devclass to examine
1575 * @param unit the first unit number to check
1578 devclass_find_free_unit(devclass_t dc, int unit)
1582 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1588 * @brief Set the parent of a devclass
1590 * The parent class is normally initialised automatically by
1593 * @param dc the devclass to edit
1594 * @param pdc the new parent devclass
1597 devclass_set_parent(devclass_t dc, devclass_t pdc)
1603 * @brief Get the parent of a devclass
1605 * @param dc the devclass to examine
1608 devclass_get_parent(devclass_t dc)
1610 return (dc->parent);
1613 struct sysctl_ctx_list *
1614 devclass_get_sysctl_ctx(devclass_t dc)
1616 return (&dc->sysctl_ctx);
1620 devclass_get_sysctl_tree(devclass_t dc)
1622 return (dc->sysctl_tree);
1627 * @brief Allocate a unit number
1629 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1630 * will do). The allocated unit number is returned in @p *unitp.
1632 * @param dc the devclass to allocate from
1633 * @param unitp points at the location for the allocated unit
1637 * @retval EEXIST the requested unit number is already allocated
1638 * @retval ENOMEM memory allocation failure
1641 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1646 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1648 /* Ask the parent bus if it wants to wire this device. */
1650 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1653 /* If we were given a wired unit number, check for existing device */
1656 if (unit >= 0 && unit < dc->maxunit &&
1657 dc->devices[unit] != NULL) {
1659 printf("%s: %s%d already exists; skipping it\n",
1660 dc->name, dc->name, *unitp);
1664 /* Unwired device, find the next available slot for it */
1666 for (unit = 0;; unit++) {
1667 /* If this device slot is already in use, skip it. */
1668 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1671 /* If there is an "at" hint for a unit then skip it. */
1672 if (resource_string_value(dc->name, unit, "at", &s) ==
1681 * We've selected a unit beyond the length of the table, so let's
1682 * extend the table to make room for all units up to and including
1685 if (unit >= dc->maxunit) {
1686 device_t *newlist, *oldlist;
1689 oldlist = dc->devices;
1690 newsize = roundup((unit + 1),
1691 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1692 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1695 if (oldlist != NULL)
1696 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1697 bzero(newlist + dc->maxunit,
1698 sizeof(device_t) * (newsize - dc->maxunit));
1699 dc->devices = newlist;
1700 dc->maxunit = newsize;
1701 if (oldlist != NULL)
1702 free(oldlist, M_BUS);
1704 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1712 * @brief Add a device to a devclass
1714 * A unit number is allocated for the device (using the device's
1715 * preferred unit number if any) and the device is registered in the
1716 * devclass. This allows the device to be looked up by its unit
1717 * number, e.g. by decoding a dev_t minor number.
1719 * @param dc the devclass to add to
1720 * @param dev the device to add
1723 * @retval EEXIST the requested unit number is already allocated
1724 * @retval ENOMEM memory allocation failure
1727 devclass_add_device(devclass_t dc, device_t dev)
1731 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1733 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1736 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1740 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1741 free(dev->nameunit, M_BUS);
1742 dev->nameunit = NULL;
1745 dc->devices[dev->unit] = dev;
1747 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1754 * @brief Delete a device from a devclass
1756 * The device is removed from the devclass's device list and its unit
1759 * @param dc the devclass to delete from
1760 * @param dev the device to delete
1765 devclass_delete_device(devclass_t dc, device_t dev)
1770 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1772 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1773 panic("devclass_delete_device: inconsistent device class");
1774 dc->devices[dev->unit] = NULL;
1775 if (dev->flags & DF_WILDCARD)
1777 dev->devclass = NULL;
1778 free(dev->nameunit, M_BUS);
1779 dev->nameunit = NULL;
1786 * @brief Make a new device and add it as a child of @p parent
1788 * @param parent the parent of the new device
1789 * @param name the devclass name of the new device or @c NULL
1790 * to leave the devclass unspecified
1791 * @parem unit the unit number of the new device of @c -1 to
1792 * leave the unit number unspecified
1794 * @returns the new device
1797 make_device(device_t parent, const char *name, int unit)
1802 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1805 dc = devclass_find_internal(name, NULL, TRUE);
1807 printf("make_device: can't find device class %s\n",
1815 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1819 dev->parent = parent;
1820 TAILQ_INIT(&dev->children);
1821 kobj_init((kobj_t) dev, &null_class);
1823 dev->devclass = NULL;
1825 dev->nameunit = NULL;
1829 dev->flags = DF_ENABLED;
1832 dev->flags |= DF_WILDCARD;
1834 dev->flags |= DF_FIXEDCLASS;
1835 if (devclass_add_device(dc, dev)) {
1836 kobj_delete((kobj_t) dev, M_BUS);
1840 if (parent != NULL && device_has_quiet_children(parent))
1841 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1845 dev->state = DS_NOTPRESENT;
1847 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1848 bus_data_generation_update();
1855 * @brief Print a description of a device.
1858 device_print_child(device_t dev, device_t child)
1862 if (device_is_alive(child))
1863 retval += BUS_PRINT_CHILD(dev, child);
1865 retval += device_printf(child, " not found\n");
1871 * @brief Create a new device
1873 * This creates a new device and adds it as a child of an existing
1874 * parent device. The new device will be added after the last existing
1875 * child with order zero.
1877 * @param dev the device which will be the parent of the
1879 * @param name devclass name for new device or @c NULL if not
1881 * @param unit unit number for new device or @c -1 if not
1884 * @returns the new device
1887 device_add_child(device_t dev, const char *name, int unit)
1889 return (device_add_child_ordered(dev, 0, name, unit));
1893 * @brief Create a new device
1895 * This creates a new device and adds it as a child of an existing
1896 * parent device. The new device will be added after the last existing
1897 * child with the same order.
1899 * @param dev the device which will be the parent of the
1901 * @param order a value which is used to partially sort the
1902 * children of @p dev - devices created using
1903 * lower values of @p order appear first in @p
1904 * dev's list of children
1905 * @param name devclass name for new device or @c NULL if not
1907 * @param unit unit number for new device or @c -1 if not
1910 * @returns the new device
1913 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1918 PDEBUG(("%s at %s with order %u as unit %d",
1919 name, DEVICENAME(dev), order, unit));
1920 KASSERT(name != NULL || unit == -1,
1921 ("child device with wildcard name and specific unit number"));
1923 child = make_device(dev, name, unit);
1926 child->order = order;
1928 TAILQ_FOREACH(place, &dev->children, link) {
1929 if (place->order > order)
1935 * The device 'place' is the first device whose order is
1936 * greater than the new child.
1938 TAILQ_INSERT_BEFORE(place, child, link);
1941 * The new child's order is greater or equal to the order of
1942 * any existing device. Add the child to the tail of the list.
1944 TAILQ_INSERT_TAIL(&dev->children, child, link);
1947 bus_data_generation_update();
1952 * @brief Delete a device
1954 * This function deletes a device along with all of its children. If
1955 * the device currently has a driver attached to it, the device is
1956 * detached first using device_detach().
1958 * @param dev the parent device
1959 * @param child the device to delete
1962 * @retval non-zero a unit error code describing the error
1965 device_delete_child(device_t dev, device_t child)
1968 device_t grandchild;
1970 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1972 /* detach parent before deleting children, if any */
1973 if ((error = device_detach(child)) != 0)
1976 /* remove children second */
1977 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1978 error = device_delete_child(child, grandchild);
1983 if (child->devclass)
1984 devclass_delete_device(child->devclass, child);
1986 BUS_CHILD_DELETED(dev, child);
1987 TAILQ_REMOVE(&dev->children, child, link);
1988 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1989 kobj_delete((kobj_t) child, M_BUS);
1991 bus_data_generation_update();
1996 * @brief Delete all children devices of the given device, if any.
1998 * This function deletes all children devices of the given device, if
1999 * any, using the device_delete_child() function for each device it
2000 * finds. If a child device cannot be deleted, this function will
2001 * return an error code.
2003 * @param dev the parent device
2006 * @retval non-zero a device would not detach
2009 device_delete_children(device_t dev)
2014 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2018 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2019 error = device_delete_child(dev, child);
2021 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2029 * @brief Find a device given a unit number
2031 * This is similar to devclass_get_devices() but only searches for
2032 * devices which have @p dev as a parent.
2034 * @param dev the parent device to search
2035 * @param unit the unit number to search for. If the unit is -1,
2036 * return the first child of @p dev which has name
2037 * @p classname (that is, the one with the lowest unit.)
2039 * @returns the device with the given unit number or @c
2040 * NULL if there is no such device
2043 device_find_child(device_t dev, const char *classname, int unit)
2048 dc = devclass_find(classname);
2053 child = devclass_get_device(dc, unit);
2054 if (child && child->parent == dev)
2057 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2058 child = devclass_get_device(dc, unit);
2059 if (child && child->parent == dev)
2070 first_matching_driver(devclass_t dc, device_t dev)
2073 return (devclass_find_driver_internal(dc, dev->devclass->name));
2074 return (TAILQ_FIRST(&dc->drivers));
2081 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2083 if (dev->devclass) {
2085 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2086 if (!strcmp(dev->devclass->name, dl->driver->name))
2090 return (TAILQ_NEXT(last, link));
2097 device_probe_child(device_t dev, device_t child)
2100 driverlink_t best = NULL;
2102 int result, pri = 0;
2103 /* We should preserve the devclass (or lack of) set by the bus. */
2104 int hasclass = (child->devclass != NULL);
2110 panic("device_probe_child: parent device has no devclass");
2113 * If the state is already probed, then return.
2115 if (child->state == DS_ALIVE)
2118 for (; dc; dc = dc->parent) {
2119 for (dl = first_matching_driver(dc, child);
2121 dl = next_matching_driver(dc, child, dl)) {
2122 /* If this driver's pass is too high, then ignore it. */
2123 if (dl->pass > bus_current_pass)
2126 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2127 result = device_set_driver(child, dl->driver);
2128 if (result == ENOMEM)
2130 else if (result != 0)
2133 if (device_set_devclass(child,
2134 dl->driver->name) != 0) {
2135 char const * devname =
2136 device_get_name(child);
2137 if (devname == NULL)
2138 devname = "(unknown)";
2139 printf("driver bug: Unable to set "
2140 "devclass (class: %s "
2144 (void)device_set_driver(child, NULL);
2149 /* Fetch any flags for the device before probing. */
2150 resource_int_value(dl->driver->name, child->unit,
2151 "flags", &child->devflags);
2153 result = DEVICE_PROBE(child);
2156 * If the driver returns SUCCESS, there can be
2157 * no higher match for this device.
2165 /* Reset flags and devclass before the next probe. */
2166 child->devflags = 0;
2168 (void)device_set_devclass(child, NULL);
2171 * Reset DF_QUIET in case this driver doesn't
2172 * end up as the best driver.
2174 device_verbose(child);
2177 * Probes that return BUS_PROBE_NOWILDCARD or lower
2178 * only match on devices whose driver was explicitly
2181 if (result <= BUS_PROBE_NOWILDCARD &&
2182 !(child->flags & DF_FIXEDCLASS)) {
2187 * The driver returned an error so it
2188 * certainly doesn't match.
2191 (void)device_set_driver(child, NULL);
2196 * A priority lower than SUCCESS, remember the
2197 * best matching driver. Initialise the value
2198 * of pri for the first match.
2200 if (best == NULL || result > pri) {
2207 * If we have an unambiguous match in this devclass,
2208 * don't look in the parent.
2210 if (best && pri == 0)
2218 * If we found a driver, change state and initialise the devclass.
2221 /* Set the winning driver, devclass, and flags. */
2222 result = device_set_driver(child, best->driver);
2225 if (!child->devclass) {
2226 result = device_set_devclass(child, best->driver->name);
2228 (void)device_set_driver(child, NULL);
2232 resource_int_value(best->driver->name, child->unit,
2233 "flags", &child->devflags);
2236 * A bit bogus. Call the probe method again to make sure
2237 * that we have the right description.
2239 result = DEVICE_PROBE(child);
2242 (void)device_set_devclass(child, NULL);
2243 (void)device_set_driver(child, NULL);
2248 child->state = DS_ALIVE;
2249 bus_data_generation_update();
2254 * @brief Return the parent of a device
2257 device_get_parent(device_t dev)
2259 return (dev->parent);
2263 * @brief Get a list of children of a device
2265 * An array containing a list of all the children of the given device
2266 * is allocated and returned in @p *devlistp. The number of devices
2267 * in the array is returned in @p *devcountp. The caller should free
2268 * the array using @c free(p, M_TEMP).
2270 * @param dev the device to examine
2271 * @param devlistp points at location for array pointer return
2273 * @param devcountp points at location for array size return value
2276 * @retval ENOMEM the array allocation failed
2279 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2286 TAILQ_FOREACH(child, &dev->children, link) {
2295 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2300 TAILQ_FOREACH(child, &dev->children, link) {
2301 list[count] = child;
2312 * @brief Return the current driver for the device or @c NULL if there
2313 * is no driver currently attached
2316 device_get_driver(device_t dev)
2318 return (dev->driver);
2322 * @brief Return the current devclass for the device or @c NULL if
2326 device_get_devclass(device_t dev)
2328 return (dev->devclass);
2332 * @brief Return the name of the device's devclass or @c NULL if there
2336 device_get_name(device_t dev)
2338 if (dev != NULL && dev->devclass)
2339 return (devclass_get_name(dev->devclass));
2344 * @brief Return a string containing the device's devclass name
2345 * followed by an ascii representation of the device's unit number
2349 device_get_nameunit(device_t dev)
2351 return (dev->nameunit);
2355 * @brief Return the device's unit number.
2358 device_get_unit(device_t dev)
2364 * @brief Return the device's description string
2367 device_get_desc(device_t dev)
2373 * @brief Return the device's flags
2376 device_get_flags(device_t dev)
2378 return (dev->devflags);
2381 struct sysctl_ctx_list *
2382 device_get_sysctl_ctx(device_t dev)
2384 return (&dev->sysctl_ctx);
2388 device_get_sysctl_tree(device_t dev)
2390 return (dev->sysctl_tree);
2394 * @brief Print the name of the device followed by a colon and a space
2396 * @returns the number of characters printed
2399 device_print_prettyname(device_t dev)
2401 const char *name = device_get_name(dev);
2404 return (printf("unknown: "));
2405 return (printf("%s%d: ", name, device_get_unit(dev)));
2409 * @brief Print the name of the device followed by a colon, a space
2410 * and the result of calling vprintf() with the value of @p fmt and
2411 * the following arguments.
2413 * @returns the number of characters printed
2416 device_printf(device_t dev, const char * fmt, ...)
2426 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2427 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2429 name = device_get_name(dev);
2432 sbuf_cat(&sb, "unknown: ");
2434 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2437 sbuf_vprintf(&sb, fmt, ap);
2450 device_set_desc_internal(device_t dev, const char* desc, int copy)
2452 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2453 free(dev->desc, M_BUS);
2454 dev->flags &= ~DF_DESCMALLOCED;
2459 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2461 strcpy(dev->desc, desc);
2462 dev->flags |= DF_DESCMALLOCED;
2465 /* Avoid a -Wcast-qual warning */
2466 dev->desc = (char *)(uintptr_t) desc;
2469 bus_data_generation_update();
2473 * @brief Set the device's description
2475 * The value of @c desc should be a string constant that will not
2476 * change (at least until the description is changed in a subsequent
2477 * call to device_set_desc() or device_set_desc_copy()).
2480 device_set_desc(device_t dev, const char* desc)
2482 device_set_desc_internal(dev, desc, FALSE);
2486 * @brief Set the device's description
2488 * The string pointed to by @c desc is copied. Use this function if
2489 * the device description is generated, (e.g. with sprintf()).
2492 device_set_desc_copy(device_t dev, const char* desc)
2494 device_set_desc_internal(dev, desc, TRUE);
2498 * @brief Set the device's flags
2501 device_set_flags(device_t dev, uint32_t flags)
2503 dev->devflags = flags;
2507 * @brief Return the device's softc field
2509 * The softc is allocated and zeroed when a driver is attached, based
2510 * on the size field of the driver.
2513 device_get_softc(device_t dev)
2515 return (dev->softc);
2519 * @brief Set the device's softc field
2521 * Most drivers do not need to use this since the softc is allocated
2522 * automatically when the driver is attached.
2525 device_set_softc(device_t dev, void *softc)
2527 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2528 free(dev->softc, M_BUS_SC);
2531 dev->flags |= DF_EXTERNALSOFTC;
2533 dev->flags &= ~DF_EXTERNALSOFTC;
2537 * @brief Free claimed softc
2539 * Most drivers do not need to use this since the softc is freed
2540 * automatically when the driver is detached.
2543 device_free_softc(void *softc)
2545 free(softc, M_BUS_SC);
2549 * @brief Claim softc
2551 * This function can be used to let the driver free the automatically
2552 * allocated softc using "device_free_softc()". This function is
2553 * useful when the driver is refcounting the softc and the softc
2554 * cannot be freed when the "device_detach" method is called.
2557 device_claim_softc(device_t dev)
2560 dev->flags |= DF_EXTERNALSOFTC;
2562 dev->flags &= ~DF_EXTERNALSOFTC;
2566 * @brief Get the device's ivars field
2568 * The ivars field is used by the parent device to store per-device
2569 * state (e.g. the physical location of the device or a list of
2573 device_get_ivars(device_t dev)
2575 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2576 return (dev->ivars);
2580 * @brief Set the device's ivars field
2583 device_set_ivars(device_t dev, void * ivars)
2585 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2590 * @brief Return the device's state
2593 device_get_state(device_t dev)
2595 return (dev->state);
2599 * @brief Set the DF_ENABLED flag for the device
2602 device_enable(device_t dev)
2604 dev->flags |= DF_ENABLED;
2608 * @brief Clear the DF_ENABLED flag for the device
2611 device_disable(device_t dev)
2613 dev->flags &= ~DF_ENABLED;
2617 * @brief Increment the busy counter for the device
2620 device_busy(device_t dev)
2622 if (dev->state < DS_ATTACHING)
2623 panic("device_busy: called for unattached device");
2624 if (dev->busy == 0 && dev->parent)
2625 device_busy(dev->parent);
2627 if (dev->state == DS_ATTACHED)
2628 dev->state = DS_BUSY;
2632 * @brief Decrement the busy counter for the device
2635 device_unbusy(device_t dev)
2637 if (dev->busy != 0 && dev->state != DS_BUSY &&
2638 dev->state != DS_ATTACHING)
2639 panic("device_unbusy: called for non-busy device %s",
2640 device_get_nameunit(dev));
2642 if (dev->busy == 0) {
2644 device_unbusy(dev->parent);
2645 if (dev->state == DS_BUSY)
2646 dev->state = DS_ATTACHED;
2651 * @brief Set the DF_QUIET flag for the device
2654 device_quiet(device_t dev)
2656 dev->flags |= DF_QUIET;
2660 * @brief Set the DF_QUIET_CHILDREN flag for the device
2663 device_quiet_children(device_t dev)
2665 dev->flags |= DF_QUIET_CHILDREN;
2669 * @brief Clear the DF_QUIET flag for the device
2672 device_verbose(device_t dev)
2674 dev->flags &= ~DF_QUIET;
2678 device_get_property(device_t dev, const char *prop, void *val, size_t sz,
2679 device_property_type_t type)
2681 device_t bus = device_get_parent(dev);
2684 case DEVICE_PROP_ANY:
2685 case DEVICE_PROP_BUFFER:
2687 case DEVICE_PROP_UINT32:
2691 case DEVICE_PROP_UINT64:
2699 return (BUS_GET_PROPERTY(bus, dev, prop, val, sz, type));
2703 device_has_property(device_t dev, const char *prop)
2705 return (device_get_property(dev, prop, NULL, 0, DEVICE_PROP_ANY) >= 0);
2709 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2712 device_has_quiet_children(device_t dev)
2714 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2718 * @brief Return non-zero if the DF_QUIET flag is set on the device
2721 device_is_quiet(device_t dev)
2723 return ((dev->flags & DF_QUIET) != 0);
2727 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2730 device_is_enabled(device_t dev)
2732 return ((dev->flags & DF_ENABLED) != 0);
2736 * @brief Return non-zero if the device was successfully probed
2739 device_is_alive(device_t dev)
2741 return (dev->state >= DS_ALIVE);
2745 * @brief Return non-zero if the device currently has a driver
2749 device_is_attached(device_t dev)
2751 return (dev->state >= DS_ATTACHED);
2755 * @brief Return non-zero if the device is currently suspended.
2758 device_is_suspended(device_t dev)
2760 return ((dev->flags & DF_SUSPENDED) != 0);
2764 * @brief Set the devclass of a device
2765 * @see devclass_add_device().
2768 device_set_devclass(device_t dev, const char *classname)
2775 devclass_delete_device(dev->devclass, dev);
2779 if (dev->devclass) {
2780 printf("device_set_devclass: device class already set\n");
2784 dc = devclass_find_internal(classname, NULL, TRUE);
2788 error = devclass_add_device(dc, dev);
2790 bus_data_generation_update();
2795 * @brief Set the devclass of a device and mark the devclass fixed.
2796 * @see device_set_devclass()
2799 device_set_devclass_fixed(device_t dev, const char *classname)
2803 if (classname == NULL)
2806 error = device_set_devclass(dev, classname);
2809 dev->flags |= DF_FIXEDCLASS;
2814 * @brief Query the device to determine if it's of a fixed devclass
2815 * @see device_set_devclass_fixed()
2818 device_is_devclass_fixed(device_t dev)
2820 return ((dev->flags & DF_FIXEDCLASS) != 0);
2824 * @brief Set the driver of a device
2827 * @retval EBUSY the device already has a driver attached
2828 * @retval ENOMEM a memory allocation failure occurred
2831 device_set_driver(device_t dev, driver_t *driver)
2834 struct domainset *policy;
2836 if (dev->state >= DS_ATTACHED)
2839 if (dev->driver == driver)
2842 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2843 free(dev->softc, M_BUS_SC);
2846 device_set_desc(dev, NULL);
2847 kobj_delete((kobj_t) dev, NULL);
2848 dev->driver = driver;
2850 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2851 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2852 if (bus_get_domain(dev, &domain) == 0)
2853 policy = DOMAINSET_PREF(domain);
2855 policy = DOMAINSET_RR();
2856 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2857 policy, M_NOWAIT | M_ZERO);
2859 kobj_delete((kobj_t) dev, NULL);
2860 kobj_init((kobj_t) dev, &null_class);
2866 kobj_init((kobj_t) dev, &null_class);
2869 bus_data_generation_update();
2874 * @brief Probe a device, and return this status.
2876 * This function is the core of the device autoconfiguration
2877 * system. Its purpose is to select a suitable driver for a device and
2878 * then call that driver to initialise the hardware appropriately. The
2879 * driver is selected by calling the DEVICE_PROBE() method of a set of
2880 * candidate drivers and then choosing the driver which returned the
2881 * best value. This driver is then attached to the device using
2884 * The set of suitable drivers is taken from the list of drivers in
2885 * the parent device's devclass. If the device was originally created
2886 * with a specific class name (see device_add_child()), only drivers
2887 * with that name are probed, otherwise all drivers in the devclass
2888 * are probed. If no drivers return successful probe values in the
2889 * parent devclass, the search continues in the parent of that
2890 * devclass (see devclass_get_parent()) if any.
2892 * @param dev the device to initialise
2895 * @retval ENXIO no driver was found
2896 * @retval ENOMEM memory allocation failure
2897 * @retval non-zero some other unix error code
2898 * @retval -1 Device already attached
2901 device_probe(device_t dev)
2907 if (dev->state >= DS_ALIVE)
2910 if (!(dev->flags & DF_ENABLED)) {
2911 if (bootverbose && device_get_name(dev) != NULL) {
2912 device_print_prettyname(dev);
2913 printf("not probed (disabled)\n");
2917 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2918 if (bus_current_pass == BUS_PASS_DEFAULT &&
2919 !(dev->flags & DF_DONENOMATCH)) {
2920 BUS_PROBE_NOMATCH(dev->parent, dev);
2922 dev->flags |= DF_DONENOMATCH;
2930 * @brief Probe a device and attach a driver if possible
2932 * calls device_probe() and attaches if that was successful.
2935 device_probe_and_attach(device_t dev)
2941 error = device_probe(dev);
2944 else if (error != 0)
2947 CURVNET_SET_QUIET(vnet0);
2948 error = device_attach(dev);
2954 * @brief Attach a device driver to a device
2956 * This function is a wrapper around the DEVICE_ATTACH() driver
2957 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2958 * device's sysctl tree, optionally prints a description of the device
2959 * and queues a notification event for user-based device management
2962 * Normally this function is only called internally from
2963 * device_probe_and_attach().
2965 * @param dev the device to initialise
2968 * @retval ENXIO no driver was found
2969 * @retval ENOMEM memory allocation failure
2970 * @retval non-zero some other unix error code
2973 device_attach(device_t dev)
2975 uint64_t attachtime;
2976 uint16_t attachentropy;
2979 if (resource_disabled(dev->driver->name, dev->unit)) {
2980 device_disable(dev);
2982 device_printf(dev, "disabled via hints entry\n");
2986 device_sysctl_init(dev);
2987 if (!device_is_quiet(dev))
2988 device_print_child(dev->parent, dev);
2989 attachtime = get_cyclecount();
2990 dev->state = DS_ATTACHING;
2991 if ((error = DEVICE_ATTACH(dev)) != 0) {
2992 printf("device_attach: %s%d attach returned %d\n",
2993 dev->driver->name, dev->unit, error);
2994 if (!(dev->flags & DF_FIXEDCLASS))
2995 devclass_delete_device(dev->devclass, dev);
2996 (void)device_set_driver(dev, NULL);
2997 device_sysctl_fini(dev);
2998 KASSERT(dev->busy == 0, ("attach failed but busy"));
2999 dev->state = DS_NOTPRESENT;
3002 dev->flags |= DF_ATTACHED_ONCE;
3003 /* We only need the low bits of this time, but ranges from tens to thousands
3004 * have been seen, so keep 2 bytes' worth.
3006 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3007 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3008 device_sysctl_update(dev);
3010 dev->state = DS_BUSY;
3012 dev->state = DS_ATTACHED;
3013 dev->flags &= ~DF_DONENOMATCH;
3014 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3020 * @brief Detach a driver from a device
3022 * This function is a wrapper around the DEVICE_DETACH() driver
3023 * method. If the call to DEVICE_DETACH() succeeds, it calls
3024 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3025 * notification event for user-based device management services and
3026 * cleans up the device's sysctl tree.
3028 * @param dev the device to un-initialise
3031 * @retval ENXIO no driver was found
3032 * @retval ENOMEM memory allocation failure
3033 * @retval non-zero some other unix error code
3036 device_detach(device_t dev)
3042 PDEBUG(("%s", DEVICENAME(dev)));
3043 if (dev->state == DS_BUSY)
3045 if (dev->state == DS_ATTACHING) {
3046 device_printf(dev, "device in attaching state! Deferring detach.\n");
3049 if (dev->state != DS_ATTACHED)
3052 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3053 if ((error = DEVICE_DETACH(dev)) != 0) {
3054 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3055 EVHDEV_DETACH_FAILED);
3058 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3059 EVHDEV_DETACH_COMPLETE);
3062 if (!device_is_quiet(dev))
3063 device_printf(dev, "detached\n");
3065 BUS_CHILD_DETACHED(dev->parent, dev);
3067 if (!(dev->flags & DF_FIXEDCLASS))
3068 devclass_delete_device(dev->devclass, dev);
3070 device_verbose(dev);
3071 dev->state = DS_NOTPRESENT;
3072 (void)device_set_driver(dev, NULL);
3073 device_sysctl_fini(dev);
3079 * @brief Tells a driver to quiesce itself.
3081 * This function is a wrapper around the DEVICE_QUIESCE() driver
3082 * method. If the call to DEVICE_QUIESCE() succeeds.
3084 * @param dev the device to quiesce
3087 * @retval ENXIO no driver was found
3088 * @retval ENOMEM memory allocation failure
3089 * @retval non-zero some other unix error code
3092 device_quiesce(device_t dev)
3094 PDEBUG(("%s", DEVICENAME(dev)));
3095 if (dev->state == DS_BUSY)
3097 if (dev->state != DS_ATTACHED)
3100 return (DEVICE_QUIESCE(dev));
3104 * @brief Notify a device of system shutdown
3106 * This function calls the DEVICE_SHUTDOWN() driver method if the
3107 * device currently has an attached driver.
3109 * @returns the value returned by DEVICE_SHUTDOWN()
3112 device_shutdown(device_t dev)
3114 if (dev->state < DS_ATTACHED)
3116 return (DEVICE_SHUTDOWN(dev));
3120 * @brief Set the unit number of a device
3122 * This function can be used to override the unit number used for a
3123 * device (e.g. to wire a device to a pre-configured unit number).
3126 device_set_unit(device_t dev, int unit)
3131 if (unit == dev->unit)
3133 dc = device_get_devclass(dev);
3134 if (unit < dc->maxunit && dc->devices[unit])
3136 err = devclass_delete_device(dc, dev);
3140 err = devclass_add_device(dc, dev);
3144 bus_data_generation_update();
3148 /*======================================*/
3150 * Some useful method implementations to make life easier for bus drivers.
3154 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3158 args->memattr = VM_MEMATTR_DEVICE;
3162 * @brief Initialise a resource list.
3164 * @param rl the resource list to initialise
3167 resource_list_init(struct resource_list *rl)
3173 * @brief Reclaim memory used by a resource list.
3175 * This function frees the memory for all resource entries on the list
3178 * @param rl the resource list to free
3181 resource_list_free(struct resource_list *rl)
3183 struct resource_list_entry *rle;
3185 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3187 panic("resource_list_free: resource entry is busy");
3188 STAILQ_REMOVE_HEAD(rl, link);
3194 * @brief Add a resource entry.
3196 * This function adds a resource entry using the given @p type, @p
3197 * start, @p end and @p count values. A rid value is chosen by
3198 * searching sequentially for the first unused rid starting at zero.
3200 * @param rl the resource list to edit
3201 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3202 * @param start the start address of the resource
3203 * @param end the end address of the resource
3204 * @param count XXX end-start+1
3207 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3208 rman_res_t end, rman_res_t count)
3213 while (resource_list_find(rl, type, rid) != NULL)
3215 resource_list_add(rl, type, rid, start, end, count);
3220 * @brief Add or modify a resource entry.
3222 * If an existing entry exists with the same type and rid, it will be
3223 * modified using the given values of @p start, @p end and @p
3224 * count. If no entry exists, a new one will be created using the
3225 * given values. The resource list entry that matches is then returned.
3227 * @param rl the resource list to edit
3228 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3229 * @param rid the resource identifier
3230 * @param start the start address of the resource
3231 * @param end the end address of the resource
3232 * @param count XXX end-start+1
3234 struct resource_list_entry *
3235 resource_list_add(struct resource_list *rl, int type, int rid,
3236 rman_res_t start, rman_res_t end, rman_res_t count)
3238 struct resource_list_entry *rle;
3240 rle = resource_list_find(rl, type, rid);
3242 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3245 panic("resource_list_add: can't record entry");
3246 STAILQ_INSERT_TAIL(rl, rle, link);
3254 panic("resource_list_add: resource entry is busy");
3263 * @brief Determine if a resource entry is busy.
3265 * Returns true if a resource entry is busy meaning that it has an
3266 * associated resource that is not an unallocated "reserved" resource.
3268 * @param rl the resource list to search
3269 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3270 * @param rid the resource identifier
3272 * @returns Non-zero if the entry is busy, zero otherwise.
3275 resource_list_busy(struct resource_list *rl, int type, int rid)
3277 struct resource_list_entry *rle;
3279 rle = resource_list_find(rl, type, rid);
3280 if (rle == NULL || rle->res == NULL)
3282 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3283 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3284 ("reserved resource is active"));
3291 * @brief Determine if a resource entry is reserved.
3293 * Returns true if a resource entry is reserved meaning that it has an
3294 * associated "reserved" resource. The resource can either be
3295 * allocated or unallocated.
3297 * @param rl the resource list to search
3298 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3299 * @param rid the resource identifier
3301 * @returns Non-zero if the entry is reserved, zero otherwise.
3304 resource_list_reserved(struct resource_list *rl, int type, int rid)
3306 struct resource_list_entry *rle;
3308 rle = resource_list_find(rl, type, rid);
3309 if (rle != NULL && rle->flags & RLE_RESERVED)
3315 * @brief Find a resource entry by type and rid.
3317 * @param rl the resource list to search
3318 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3319 * @param rid the resource identifier
3321 * @returns the resource entry pointer or NULL if there is no such
3324 struct resource_list_entry *
3325 resource_list_find(struct resource_list *rl, int type, int rid)
3327 struct resource_list_entry *rle;
3329 STAILQ_FOREACH(rle, rl, link) {
3330 if (rle->type == type && rle->rid == rid)
3337 * @brief Delete a resource entry.
3339 * @param rl the resource list to edit
3340 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3341 * @param rid the resource identifier
3344 resource_list_delete(struct resource_list *rl, int type, int rid)
3346 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3349 if (rle->res != NULL)
3350 panic("resource_list_delete: resource has not been released");
3351 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3357 * @brief Allocate a reserved resource
3359 * This can be used by buses to force the allocation of resources
3360 * that are always active in the system even if they are not allocated
3361 * by a driver (e.g. PCI BARs). This function is usually called when
3362 * adding a new child to the bus. The resource is allocated from the
3363 * parent bus when it is reserved. The resource list entry is marked
3364 * with RLE_RESERVED to note that it is a reserved resource.
3366 * Subsequent attempts to allocate the resource with
3367 * resource_list_alloc() will succeed the first time and will set
3368 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3369 * resource that has been allocated is released with
3370 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3371 * the actual resource remains allocated. The resource can be released to
3372 * the parent bus by calling resource_list_unreserve().
3374 * @param rl the resource list to allocate from
3375 * @param bus the parent device of @p child
3376 * @param child the device for which the resource is being reserved
3377 * @param type the type of resource to allocate
3378 * @param rid a pointer to the resource identifier
3379 * @param start hint at the start of the resource range - pass
3380 * @c 0 for any start address
3381 * @param end hint at the end of the resource range - pass
3382 * @c ~0 for any end address
3383 * @param count hint at the size of range required - pass @c 1
3385 * @param flags any extra flags to control the resource
3386 * allocation - see @c RF_XXX flags in
3387 * <sys/rman.h> for details
3389 * @returns the resource which was allocated or @c NULL if no
3390 * resource could be allocated
3393 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3394 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3396 struct resource_list_entry *rle = NULL;
3397 int passthrough = (device_get_parent(child) != bus);
3402 "resource_list_reserve() should only be called for direct children");
3403 if (flags & RF_ACTIVE)
3405 "resource_list_reserve() should only reserve inactive resources");
3407 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3410 rle = resource_list_find(rl, type, *rid);
3411 rle->flags |= RLE_RESERVED;
3417 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3419 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3420 * and passing the allocation up to the parent of @p bus. This assumes
3421 * that the first entry of @c device_get_ivars(child) is a struct
3422 * resource_list. This also handles 'passthrough' allocations where a
3423 * child is a remote descendant of bus by passing the allocation up to
3424 * the parent of bus.
3426 * Typically, a bus driver would store a list of child resources
3427 * somewhere in the child device's ivars (see device_get_ivars()) and
3428 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3429 * then call resource_list_alloc() to perform the allocation.
3431 * @param rl the resource list to allocate from
3432 * @param bus the parent device of @p child
3433 * @param child the device which is requesting an allocation
3434 * @param type the type of resource to allocate
3435 * @param rid a pointer to the resource identifier
3436 * @param start hint at the start of the resource range - pass
3437 * @c 0 for any start address
3438 * @param end hint at the end of the resource range - pass
3439 * @c ~0 for any end address
3440 * @param count hint at the size of range required - pass @c 1
3442 * @param flags any extra flags to control the resource
3443 * allocation - see @c RF_XXX flags in
3444 * <sys/rman.h> for details
3446 * @returns the resource which was allocated or @c NULL if no
3447 * resource could be allocated
3450 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3451 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3453 struct resource_list_entry *rle = NULL;
3454 int passthrough = (device_get_parent(child) != bus);
3455 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3458 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3459 type, rid, start, end, count, flags));
3462 rle = resource_list_find(rl, type, *rid);
3465 return (NULL); /* no resource of that type/rid */
3468 if (rle->flags & RLE_RESERVED) {
3469 if (rle->flags & RLE_ALLOCATED)
3471 if ((flags & RF_ACTIVE) &&
3472 bus_activate_resource(child, type, *rid,
3475 rle->flags |= RLE_ALLOCATED;
3479 "resource entry %#x type %d for child %s is busy\n", *rid,
3480 type, device_get_nameunit(child));
3486 count = ulmax(count, rle->count);
3487 end = ulmax(rle->end, start + count - 1);
3490 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3491 type, rid, start, end, count, flags);
3494 * Record the new range.
3497 rle->start = rman_get_start(rle->res);
3498 rle->end = rman_get_end(rle->res);
3506 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3508 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3509 * used with resource_list_alloc().
3511 * @param rl the resource list which was allocated from
3512 * @param bus the parent device of @p child
3513 * @param child the device which is requesting a release
3514 * @param type the type of resource to release
3515 * @param rid the resource identifier
3516 * @param res the resource to release
3519 * @retval non-zero a standard unix error code indicating what
3520 * error condition prevented the operation
3523 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3524 int type, int rid, struct resource *res)
3526 struct resource_list_entry *rle = NULL;
3527 int passthrough = (device_get_parent(child) != bus);
3531 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3535 rle = resource_list_find(rl, type, rid);
3538 panic("resource_list_release: can't find resource");
3540 panic("resource_list_release: resource entry is not busy");
3541 if (rle->flags & RLE_RESERVED) {
3542 if (rle->flags & RLE_ALLOCATED) {
3543 if (rman_get_flags(res) & RF_ACTIVE) {
3544 error = bus_deactivate_resource(child, type,
3549 rle->flags &= ~RLE_ALLOCATED;
3555 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3565 * @brief Release all active resources of a given type
3567 * Release all active resources of a specified type. This is intended
3568 * to be used to cleanup resources leaked by a driver after detach or
3571 * @param rl the resource list which was allocated from
3572 * @param bus the parent device of @p child
3573 * @param child the device whose active resources are being released
3574 * @param type the type of resources to release
3577 * @retval EBUSY at least one resource was active
3580 resource_list_release_active(struct resource_list *rl, device_t bus,
3581 device_t child, int type)
3583 struct resource_list_entry *rle;
3587 STAILQ_FOREACH(rle, rl, link) {
3588 if (rle->type != type)
3590 if (rle->res == NULL)
3592 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3596 error = resource_list_release(rl, bus, child, type,
3597 rman_get_rid(rle->res), rle->res);
3600 "Failed to release active resource: %d\n", error);
3606 * @brief Fully release a reserved resource
3608 * Fully releases a resource reserved via resource_list_reserve().
3610 * @param rl the resource list which was allocated from
3611 * @param bus the parent device of @p child
3612 * @param child the device whose reserved resource is being released
3613 * @param type the type of resource to release
3614 * @param rid the resource identifier
3615 * @param res the resource to release
3618 * @retval non-zero a standard unix error code indicating what
3619 * error condition prevented the operation
3622 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3625 struct resource_list_entry *rle = NULL;
3626 int passthrough = (device_get_parent(child) != bus);
3630 "resource_list_unreserve() should only be called for direct children");
3632 rle = resource_list_find(rl, type, rid);
3635 panic("resource_list_unreserve: can't find resource");
3636 if (!(rle->flags & RLE_RESERVED))
3638 if (rle->flags & RLE_ALLOCATED)
3640 rle->flags &= ~RLE_RESERVED;
3641 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3645 * @brief Print a description of resources in a resource list
3647 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3648 * The name is printed if at least one resource of the given type is available.
3649 * The format is used to print resource start and end.
3651 * @param rl the resource list to print
3652 * @param name the name of @p type, e.g. @c "memory"
3653 * @param type type type of resource entry to print
3654 * @param format printf(9) format string to print resource
3655 * start and end values
3657 * @returns the number of characters printed
3660 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3663 struct resource_list_entry *rle;
3664 int printed, retval;
3668 /* Yes, this is kinda cheating */
3669 STAILQ_FOREACH(rle, rl, link) {
3670 if (rle->type == type) {
3672 retval += printf(" %s ", name);
3674 retval += printf(",");
3676 retval += printf(format, rle->start);
3677 if (rle->count > 1) {
3678 retval += printf("-");
3679 retval += printf(format, rle->start +
3688 * @brief Releases all the resources in a list.
3690 * @param rl The resource list to purge.
3695 resource_list_purge(struct resource_list *rl)
3697 struct resource_list_entry *rle;
3699 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3701 bus_release_resource(rman_get_device(rle->res),
3702 rle->type, rle->rid, rle->res);
3703 STAILQ_REMOVE_HEAD(rl, link);
3709 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3711 return (device_add_child_ordered(dev, order, name, unit));
3715 * @brief Helper function for implementing DEVICE_PROBE()
3717 * This function can be used to help implement the DEVICE_PROBE() for
3718 * a bus (i.e. a device which has other devices attached to it). It
3719 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3723 bus_generic_probe(device_t dev)
3725 devclass_t dc = dev->devclass;
3728 TAILQ_FOREACH(dl, &dc->drivers, link) {
3730 * If this driver's pass is too high, then ignore it.
3731 * For most drivers in the default pass, this will
3732 * never be true. For early-pass drivers they will
3733 * only call the identify routines of eligible drivers
3734 * when this routine is called. Drivers for later
3735 * passes should have their identify routines called
3736 * on early-pass buses during BUS_NEW_PASS().
3738 if (dl->pass > bus_current_pass)
3740 DEVICE_IDENTIFY(dl->driver, dev);
3747 * @brief Helper function for implementing DEVICE_ATTACH()
3749 * This function can be used to help implement the DEVICE_ATTACH() for
3750 * a bus. It calls device_probe_and_attach() for each of the device's
3754 bus_generic_attach(device_t dev)
3758 TAILQ_FOREACH(child, &dev->children, link) {
3759 device_probe_and_attach(child);
3766 * @brief Helper function for delaying attaching children
3768 * Many buses can't run transactions on the bus which children need to probe and
3769 * attach until after interrupts and/or timers are running. This function
3770 * delays their attach until interrupts and timers are enabled.
3773 bus_delayed_attach_children(device_t dev)
3775 /* Probe and attach the bus children when interrupts are available */
3776 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3782 * @brief Helper function for implementing DEVICE_DETACH()
3784 * This function can be used to help implement the DEVICE_DETACH() for
3785 * a bus. It calls device_detach() for each of the device's
3789 bus_generic_detach(device_t dev)
3794 if (dev->state != DS_ATTACHED)
3798 * Detach children in the reverse order.
3799 * See bus_generic_suspend for details.
3801 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3802 if ((error = device_detach(child)) != 0)
3810 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3812 * This function can be used to help implement the DEVICE_SHUTDOWN()
3813 * for a bus. It calls device_shutdown() for each of the device's
3817 bus_generic_shutdown(device_t dev)
3822 * Shut down children in the reverse order.
3823 * See bus_generic_suspend for details.
3825 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3826 device_shutdown(child);
3833 * @brief Default function for suspending a child device.
3835 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3838 bus_generic_suspend_child(device_t dev, device_t child)
3842 error = DEVICE_SUSPEND(child);
3845 child->flags |= DF_SUSPENDED;
3851 * @brief Default function for resuming a child device.
3853 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3856 bus_generic_resume_child(device_t dev, device_t child)
3858 DEVICE_RESUME(child);
3859 child->flags &= ~DF_SUSPENDED;
3865 * @brief Helper function for implementing DEVICE_SUSPEND()
3867 * This function can be used to help implement the DEVICE_SUSPEND()
3868 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3869 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3870 * operation is aborted and any devices which were suspended are
3871 * resumed immediately by calling their DEVICE_RESUME() methods.
3874 bus_generic_suspend(device_t dev)
3880 * Suspend children in the reverse order.
3881 * For most buses all children are equal, so the order does not matter.
3882 * Other buses, such as acpi, carefully order their child devices to
3883 * express implicit dependencies between them. For such buses it is
3884 * safer to bring down devices in the reverse order.
3886 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3887 error = BUS_SUSPEND_CHILD(dev, child);
3889 child = TAILQ_NEXT(child, link);
3890 if (child != NULL) {
3891 TAILQ_FOREACH_FROM(child, &dev->children, link)
3892 BUS_RESUME_CHILD(dev, child);
3901 * @brief Helper function for implementing DEVICE_RESUME()
3903 * This function can be used to help implement the DEVICE_RESUME() for
3904 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3907 bus_generic_resume(device_t dev)
3911 TAILQ_FOREACH(child, &dev->children, link) {
3912 BUS_RESUME_CHILD(dev, child);
3913 /* if resume fails, there's nothing we can usefully do... */
3919 * @brief Helper function for implementing BUS_RESET_POST
3921 * Bus can use this function to implement common operations of
3922 * re-attaching or resuming the children after the bus itself was
3923 * reset, and after restoring bus-unique state of children.
3925 * @param dev The bus
3926 * #param flags DEVF_RESET_*
3929 bus_helper_reset_post(device_t dev, int flags)
3935 TAILQ_FOREACH(child, &dev->children,link) {
3936 BUS_RESET_POST(dev, child);
3937 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3938 device_probe_and_attach(child) :
3939 BUS_RESUME_CHILD(dev, child);
3940 if (error == 0 && error1 != 0)
3947 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3949 child = TAILQ_NEXT(child, link);
3952 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3953 BUS_RESET_POST(dev, child);
3954 if ((flags & DEVF_RESET_DETACH) != 0)
3955 device_probe_and_attach(child);
3957 BUS_RESUME_CHILD(dev, child);
3962 * @brief Helper function for implementing BUS_RESET_PREPARE
3964 * Bus can use this function to implement common operations of
3965 * detaching or suspending the children before the bus itself is
3966 * reset, and then save bus-unique state of children that must
3967 * persists around reset.
3969 * @param dev The bus
3970 * #param flags DEVF_RESET_*
3973 bus_helper_reset_prepare(device_t dev, int flags)
3978 if (dev->state != DS_ATTACHED)
3981 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3982 if ((flags & DEVF_RESET_DETACH) != 0) {
3983 error = device_get_state(child) == DS_ATTACHED ?
3984 device_detach(child) : 0;
3986 error = BUS_SUSPEND_CHILD(dev, child);
3989 error = BUS_RESET_PREPARE(dev, child);
3991 if ((flags & DEVF_RESET_DETACH) != 0)
3992 device_probe_and_attach(child);
3994 BUS_RESUME_CHILD(dev, child);
3998 bus_helper_reset_prepare_rollback(dev, child, flags);
4006 * @brief Helper function for implementing BUS_PRINT_CHILD().
4008 * This function prints the first part of the ascii representation of
4009 * @p child, including its name, unit and description (if any - see
4010 * device_set_desc()).
4012 * @returns the number of characters printed
4015 bus_print_child_header(device_t dev, device_t child)
4019 if (device_get_desc(child)) {
4020 retval += device_printf(child, "<%s>", device_get_desc(child));
4022 retval += printf("%s", device_get_nameunit(child));
4029 * @brief Helper function for implementing BUS_PRINT_CHILD().
4031 * This function prints the last part of the ascii representation of
4032 * @p child, which consists of the string @c " on " followed by the
4033 * name and unit of the @p dev.
4035 * @returns the number of characters printed
4038 bus_print_child_footer(device_t dev, device_t child)
4040 return (printf(" on %s\n", device_get_nameunit(dev)));
4044 * @brief Helper function for implementing BUS_PRINT_CHILD().
4046 * This function prints out the VM domain for the given device.
4048 * @returns the number of characters printed
4051 bus_print_child_domain(device_t dev, device_t child)
4055 /* No domain? Don't print anything */
4056 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4059 return (printf(" numa-domain %d", domain));
4063 * @brief Helper function for implementing BUS_PRINT_CHILD().
4065 * This function simply calls bus_print_child_header() followed by
4066 * bus_print_child_footer().
4068 * @returns the number of characters printed
4071 bus_generic_print_child(device_t dev, device_t child)
4075 retval += bus_print_child_header(dev, child);
4076 retval += bus_print_child_domain(dev, child);
4077 retval += bus_print_child_footer(dev, child);
4083 * @brief Stub function for implementing BUS_READ_IVAR().
4088 bus_generic_read_ivar(device_t dev, device_t child, int index,
4095 * @brief Stub function for implementing BUS_WRITE_IVAR().
4100 bus_generic_write_ivar(device_t dev, device_t child, int index,
4107 * @brief Helper function for implementing BUS_GET_PROPERTY().
4109 * This simply calls the BUS_GET_PROPERTY of the parent of dev,
4110 * until a non-default implementation is found.
4113 bus_generic_get_property(device_t dev, device_t child, const char *propname,
4114 void *propvalue, size_t size, device_property_type_t type)
4116 if (device_get_parent(dev) != NULL)
4117 return (BUS_GET_PROPERTY(device_get_parent(dev), child,
4118 propname, propvalue, size, type));
4124 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4128 struct resource_list *
4129 bus_generic_get_resource_list(device_t dev, device_t child)
4135 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4137 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4138 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4139 * and then calls device_probe_and_attach() for each unattached child.
4142 bus_generic_driver_added(device_t dev, driver_t *driver)
4146 DEVICE_IDENTIFY(driver, dev);
4147 TAILQ_FOREACH(child, &dev->children, link) {
4148 if (child->state == DS_NOTPRESENT)
4149 device_probe_and_attach(child);
4154 * @brief Helper function for implementing BUS_NEW_PASS().
4156 * This implementing of BUS_NEW_PASS() first calls the identify
4157 * routines for any drivers that probe at the current pass. Then it
4158 * walks the list of devices for this bus. If a device is already
4159 * attached, then it calls BUS_NEW_PASS() on that device. If the
4160 * device is not already attached, it attempts to attach a driver to
4164 bus_generic_new_pass(device_t dev)
4171 TAILQ_FOREACH(dl, &dc->drivers, link) {
4172 if (dl->pass == bus_current_pass)
4173 DEVICE_IDENTIFY(dl->driver, dev);
4175 TAILQ_FOREACH(child, &dev->children, link) {
4176 if (child->state >= DS_ATTACHED)
4177 BUS_NEW_PASS(child);
4178 else if (child->state == DS_NOTPRESENT)
4179 device_probe_and_attach(child);
4184 * @brief Helper function for implementing BUS_SETUP_INTR().
4186 * This simple implementation of BUS_SETUP_INTR() simply calls the
4187 * BUS_SETUP_INTR() method of the parent of @p dev.
4190 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4191 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4194 /* Propagate up the bus hierarchy until someone handles it. */
4196 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4197 filter, intr, arg, cookiep));
4202 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4204 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4205 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4208 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4211 /* Propagate up the bus hierarchy until someone handles it. */
4213 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4218 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4220 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4221 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4224 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4226 /* Propagate up the bus hierarchy until someone handles it. */
4228 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4233 * @brief Helper function for implementing BUS_RESUME_INTR().
4235 * This simple implementation of BUS_RESUME_INTR() simply calls the
4236 * BUS_RESUME_INTR() method of the parent of @p dev.
4239 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4241 /* Propagate up the bus hierarchy until someone handles it. */
4243 return (BUS_RESUME_INTR(dev->parent, child, irq));
4248 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4250 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4251 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4254 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4255 struct resource *r, rman_res_t start, rman_res_t end)
4257 /* Propagate up the bus hierarchy until someone handles it. */
4259 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4265 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4267 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4268 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4271 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4272 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4274 /* Propagate up the bus hierarchy until someone handles it. */
4276 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4277 start, end, count, flags));
4282 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4284 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4285 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4288 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4291 /* Propagate up the bus hierarchy until someone handles it. */
4293 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4299 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4301 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4302 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4305 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4308 /* Propagate up the bus hierarchy until someone handles it. */
4310 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4316 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4318 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4319 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4322 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4323 int rid, struct resource *r)
4325 /* Propagate up the bus hierarchy until someone handles it. */
4327 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4333 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4335 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4336 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4339 bus_generic_map_resource(device_t dev, device_t child, int type,
4340 struct resource *r, struct resource_map_request *args,
4341 struct resource_map *map)
4343 /* Propagate up the bus hierarchy until someone handles it. */
4345 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4351 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4353 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4354 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4357 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4358 struct resource *r, struct resource_map *map)
4360 /* Propagate up the bus hierarchy until someone handles it. */
4362 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4367 * @brief Helper function for implementing BUS_BIND_INTR().
4369 * This simple implementation of BUS_BIND_INTR() simply calls the
4370 * BUS_BIND_INTR() method of the parent of @p dev.
4373 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4376 /* Propagate up the bus hierarchy until someone handles it. */
4378 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4383 * @brief Helper function for implementing BUS_CONFIG_INTR().
4385 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4386 * BUS_CONFIG_INTR() method of the parent of @p dev.
4389 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4390 enum intr_polarity pol)
4392 /* Propagate up the bus hierarchy until someone handles it. */
4394 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4399 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4401 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4402 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4405 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4406 void *cookie, const char *descr)
4408 /* Propagate up the bus hierarchy until someone handles it. */
4410 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4416 * @brief Helper function for implementing BUS_GET_CPUS().
4418 * This simple implementation of BUS_GET_CPUS() simply calls the
4419 * BUS_GET_CPUS() method of the parent of @p dev.
4422 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4423 size_t setsize, cpuset_t *cpuset)
4425 /* Propagate up the bus hierarchy until someone handles it. */
4426 if (dev->parent != NULL)
4427 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4432 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4434 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4435 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4438 bus_generic_get_dma_tag(device_t dev, device_t child)
4440 /* Propagate up the bus hierarchy until someone handles it. */
4441 if (dev->parent != NULL)
4442 return (BUS_GET_DMA_TAG(dev->parent, child));
4447 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4449 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4450 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4453 bus_generic_get_bus_tag(device_t dev, device_t child)
4455 /* Propagate up the bus hierarchy until someone handles it. */
4456 if (dev->parent != NULL)
4457 return (BUS_GET_BUS_TAG(dev->parent, child));
4458 return ((bus_space_tag_t)0);
4462 * @brief Helper function for implementing BUS_GET_RESOURCE().
4464 * This implementation of BUS_GET_RESOURCE() uses the
4465 * resource_list_find() 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_get_resource(device_t dev, device_t child, int type, int rid,
4471 rman_res_t *startp, rman_res_t *countp)
4473 struct resource_list * rl = NULL;
4474 struct resource_list_entry * rle = NULL;
4476 rl = BUS_GET_RESOURCE_LIST(dev, child);
4480 rle = resource_list_find(rl, type, rid);
4485 *startp = rle->start;
4487 *countp = rle->count;
4493 * @brief Helper function for implementing BUS_SET_RESOURCE().
4495 * This implementation of BUS_SET_RESOURCE() uses the
4496 * resource_list_add() function to do most of the work. It calls
4497 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4501 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4502 rman_res_t start, rman_res_t count)
4504 struct resource_list * rl = NULL;
4506 rl = BUS_GET_RESOURCE_LIST(dev, child);
4510 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4516 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4518 * This implementation of BUS_DELETE_RESOURCE() uses the
4519 * resource_list_delete() function to do most of the work. It calls
4520 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4524 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4526 struct resource_list * rl = NULL;
4528 rl = BUS_GET_RESOURCE_LIST(dev, child);
4532 resource_list_delete(rl, type, rid);
4538 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4540 * This implementation of BUS_RELEASE_RESOURCE() uses the
4541 * resource_list_release() function to do most of the work. It calls
4542 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4545 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4546 int rid, struct resource *r)
4548 struct resource_list * rl = NULL;
4550 if (device_get_parent(child) != dev)
4551 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4554 rl = BUS_GET_RESOURCE_LIST(dev, child);
4558 return (resource_list_release(rl, dev, child, type, rid, r));
4562 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4564 * This implementation of BUS_ALLOC_RESOURCE() uses the
4565 * resource_list_alloc() function to do most of the work. It calls
4566 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4569 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4570 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4572 struct resource_list * rl = NULL;
4574 if (device_get_parent(child) != dev)
4575 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4576 type, rid, start, end, count, flags));
4578 rl = BUS_GET_RESOURCE_LIST(dev, child);
4582 return (resource_list_alloc(rl, dev, child, type, rid,
4583 start, end, count, flags));
4587 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4589 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4590 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4593 bus_generic_child_present(device_t dev, device_t child)
4595 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4599 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4602 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4608 * @brief Helper function for implementing BUS_RESCAN().
4610 * This null implementation of BUS_RESCAN() always fails to indicate
4611 * the bus does not support rescanning.
4614 bus_null_rescan(device_t dev)
4620 * Some convenience functions to make it easier for drivers to use the
4621 * resource-management functions. All these really do is hide the
4622 * indirection through the parent's method table, making for slightly
4623 * less-wordy code. In the future, it might make sense for this code
4624 * to maintain some sort of a list of resources allocated by each device.
4628 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4629 struct resource **res)
4633 for (i = 0; rs[i].type != -1; i++)
4635 for (i = 0; rs[i].type != -1; i++) {
4636 res[i] = bus_alloc_resource_any(dev,
4637 rs[i].type, &rs[i].rid, rs[i].flags);
4638 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4639 bus_release_resources(dev, rs, res);
4647 bus_release_resources(device_t dev, const struct resource_spec *rs,
4648 struct resource **res)
4652 for (i = 0; rs[i].type != -1; i++)
4653 if (res[i] != NULL) {
4654 bus_release_resource(
4655 dev, rs[i].type, rs[i].rid, res[i]);
4661 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4663 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4667 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4668 rman_res_t end, rman_res_t count, u_int flags)
4670 struct resource *res;
4672 if (dev->parent == NULL)
4674 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4680 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4682 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4686 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4689 if (dev->parent == NULL)
4691 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4695 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4697 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4701 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4703 if (dev->parent == NULL)
4705 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4709 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4711 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4715 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4717 if (dev->parent == NULL)
4719 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4723 * @brief Wrapper function for BUS_MAP_RESOURCE().
4725 * This function simply calls the BUS_MAP_RESOURCE() method of the
4729 bus_map_resource(device_t dev, int type, struct resource *r,
4730 struct resource_map_request *args, struct resource_map *map)
4732 if (dev->parent == NULL)
4734 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4738 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4740 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4744 bus_unmap_resource(device_t dev, int type, struct resource *r,
4745 struct resource_map *map)
4747 if (dev->parent == NULL)
4749 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4753 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4755 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4759 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4763 if (dev->parent == NULL)
4765 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4770 * @brief Wrapper function for BUS_SETUP_INTR().
4772 * This function simply calls the BUS_SETUP_INTR() method of the
4776 bus_setup_intr(device_t dev, struct resource *r, int flags,
4777 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4781 if (dev->parent == NULL)
4783 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4787 if (handler != NULL && !(flags & INTR_MPSAFE))
4788 device_printf(dev, "[GIANT-LOCKED]\n");
4793 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4795 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4799 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4801 if (dev->parent == NULL)
4803 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4807 * @brief Wrapper function for BUS_SUSPEND_INTR().
4809 * This function simply calls the BUS_SUSPEND_INTR() method of the
4813 bus_suspend_intr(device_t dev, struct resource *r)
4815 if (dev->parent == NULL)
4817 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4821 * @brief Wrapper function for BUS_RESUME_INTR().
4823 * This function simply calls the BUS_RESUME_INTR() method of the
4827 bus_resume_intr(device_t dev, struct resource *r)
4829 if (dev->parent == NULL)
4831 return (BUS_RESUME_INTR(dev->parent, dev, r));
4835 * @brief Wrapper function for BUS_BIND_INTR().
4837 * This function simply calls the BUS_BIND_INTR() method of the
4841 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4843 if (dev->parent == NULL)
4845 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4849 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4851 * This function first formats the requested description into a
4852 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4853 * the parent of @p dev.
4856 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4857 const char *fmt, ...)
4860 char descr[MAXCOMLEN + 1];
4862 if (dev->parent == NULL)
4865 vsnprintf(descr, sizeof(descr), fmt, ap);
4867 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4871 * @brief Wrapper function for BUS_SET_RESOURCE().
4873 * This function simply calls the BUS_SET_RESOURCE() method of the
4877 bus_set_resource(device_t dev, int type, int rid,
4878 rman_res_t start, rman_res_t count)
4880 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4885 * @brief Wrapper function for BUS_GET_RESOURCE().
4887 * This function simply calls the BUS_GET_RESOURCE() method of the
4891 bus_get_resource(device_t dev, int type, int rid,
4892 rman_res_t *startp, rman_res_t *countp)
4894 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4899 * @brief Wrapper function for BUS_GET_RESOURCE().
4901 * This function simply calls the BUS_GET_RESOURCE() method of the
4902 * parent of @p dev and returns the start value.
4905 bus_get_resource_start(device_t dev, int type, int rid)
4911 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4919 * @brief Wrapper function for BUS_GET_RESOURCE().
4921 * This function simply calls the BUS_GET_RESOURCE() method of the
4922 * parent of @p dev and returns the count value.
4925 bus_get_resource_count(device_t dev, int type, int rid)
4931 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4939 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4941 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4945 bus_delete_resource(device_t dev, int type, int rid)
4947 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4951 * @brief Wrapper function for BUS_CHILD_PRESENT().
4953 * This function simply calls the BUS_CHILD_PRESENT() method of the
4957 bus_child_present(device_t child)
4959 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4963 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4965 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4969 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4973 parent = device_get_parent(child);
4974 if (parent == NULL) {
4978 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4982 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4984 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4988 bus_child_location_str(device_t child, char *buf, size_t buflen)
4992 parent = device_get_parent(child);
4993 if (parent == NULL) {
4997 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
5001 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
5003 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
5004 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
5005 * accomplish this, however. It is an interim function until we can convert
5006 * this interface more fully.
5008 /* Note: we reach inside of sbuf because it's API isn't rich enough to do this */
5009 #define SPACE(s) ((s)->s_size - (s)->s_len)
5010 #define EOB(s) ((s)->s_buf + (s)->s_len)
5013 bus_child_pnpinfo_sb(device_t dev, struct sbuf *sb)
5018 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5019 MPASS(sb->s_size >= sb->s_len);
5020 if (sb->s_error != 0)
5024 sb->s_error = ENOMEM;
5028 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5029 bus_child_pnpinfo_str(dev, p, space);
5030 sb->s_len += strlen(p);
5035 * @brief Wrapper function for bus_child_pnpinfo_str using sbuf
5037 * A convenient wrapper frunction for bus_child_pnpinfo_str that allows
5038 * us to splat that into an sbuf. It uses unholy knowledge of sbuf to
5039 * accomplish this, however. It is an interim function until we can convert
5040 * this interface more fully.
5043 bus_child_location_sb(device_t dev, struct sbuf *sb)
5048 MPASS((sb->s_flags & SBUF_INCLUDENUL) == 0);
5049 MPASS(sb->s_size >= sb->s_len);
5050 if (sb->s_error != 0)
5054 sb->s_error = ENOMEM;
5058 *p = '\0'; /* sbuf buffer isn't NUL terminated until sbuf_finish() */
5059 bus_child_location_str(dev, p, space);
5060 sb->s_len += strlen(p);
5067 * @brief Wrapper function for BUS_GET_CPUS().
5069 * This function simply calls the BUS_GET_CPUS() method of the
5073 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5077 parent = device_get_parent(dev);
5080 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5084 * @brief Wrapper function for BUS_GET_DMA_TAG().
5086 * This function simply calls the BUS_GET_DMA_TAG() method of the
5090 bus_get_dma_tag(device_t dev)
5094 parent = device_get_parent(dev);
5097 return (BUS_GET_DMA_TAG(parent, dev));
5101 * @brief Wrapper function for BUS_GET_BUS_TAG().
5103 * This function simply calls the BUS_GET_BUS_TAG() method of the
5107 bus_get_bus_tag(device_t dev)
5111 parent = device_get_parent(dev);
5113 return ((bus_space_tag_t)0);
5114 return (BUS_GET_BUS_TAG(parent, dev));
5118 * @brief Wrapper function for BUS_GET_DOMAIN().
5120 * This function simply calls the BUS_GET_DOMAIN() method of the
5124 bus_get_domain(device_t dev, int *domain)
5126 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5129 /* Resume all devices and then notify userland that we're up again. */
5131 root_resume(device_t dev)
5135 error = bus_generic_resume(dev);
5137 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5138 devctl_notify("kernel", "power", "resume", NULL);
5144 root_print_child(device_t dev, device_t child)
5148 retval += bus_print_child_header(dev, child);
5149 retval += printf("\n");
5155 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5156 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5159 * If an interrupt mapping gets to here something bad has happened.
5161 panic("root_setup_intr");
5165 * If we get here, assume that the device is permanent and really is
5166 * present in the system. Removable bus drivers are expected to intercept
5167 * this call long before it gets here. We return -1 so that drivers that
5168 * really care can check vs -1 or some ERRNO returned higher in the food
5172 root_child_present(device_t dev, device_t child)
5178 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5183 /* Default to returning the set of all CPUs. */
5184 if (setsize != sizeof(cpuset_t))
5193 static kobj_method_t root_methods[] = {
5194 /* Device interface */
5195 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5196 KOBJMETHOD(device_suspend, bus_generic_suspend),
5197 KOBJMETHOD(device_resume, root_resume),
5200 KOBJMETHOD(bus_print_child, root_print_child),
5201 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5202 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5203 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5204 KOBJMETHOD(bus_child_present, root_child_present),
5205 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5210 static driver_t root_driver = {
5217 devclass_t root_devclass;
5220 root_bus_module_handler(module_t mod, int what, void* arg)
5224 TAILQ_INIT(&bus_data_devices);
5225 kobj_class_compile((kobj_class_t) &root_driver);
5226 root_bus = make_device(NULL, "root", 0);
5227 root_bus->desc = "System root bus";
5228 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5229 root_bus->driver = &root_driver;
5230 root_bus->state = DS_ATTACHED;
5231 root_devclass = devclass_find_internal("root", NULL, FALSE);
5236 device_shutdown(root_bus);
5239 return (EOPNOTSUPP);
5245 static moduledata_t root_bus_mod = {
5247 root_bus_module_handler,
5250 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5253 * @brief Automatically configure devices
5255 * This function begins the autoconfiguration process by calling
5256 * device_probe_and_attach() for each child of the @c root0 device.
5259 root_bus_configure(void)
5263 /* Eventually this will be split up, but this is sufficient for now. */
5264 bus_set_pass(BUS_PASS_DEFAULT);
5268 * @brief Module handler for registering device drivers
5270 * This module handler is used to automatically register device
5271 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5272 * devclass_add_driver() for the driver described by the
5273 * driver_module_data structure pointed to by @p arg
5276 driver_module_handler(module_t mod, int what, void *arg)
5278 struct driver_module_data *dmd;
5279 devclass_t bus_devclass;
5280 kobj_class_t driver;
5283 dmd = (struct driver_module_data *)arg;
5284 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5289 if (dmd->dmd_chainevh)
5290 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5292 pass = dmd->dmd_pass;
5293 driver = dmd->dmd_driver;
5294 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5295 DRIVERNAME(driver), dmd->dmd_busname, pass));
5296 error = devclass_add_driver(bus_devclass, driver, pass,
5301 PDEBUG(("Unloading module: driver %s from bus %s",
5302 DRIVERNAME(dmd->dmd_driver),
5304 error = devclass_delete_driver(bus_devclass,
5307 if (!error && dmd->dmd_chainevh)
5308 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5311 PDEBUG(("Quiesce module: driver %s from bus %s",
5312 DRIVERNAME(dmd->dmd_driver),
5314 error = devclass_quiesce_driver(bus_devclass,
5317 if (!error && dmd->dmd_chainevh)
5318 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5329 * @brief Enumerate all hinted devices for this bus.
5331 * Walks through the hints for this bus and calls the bus_hinted_child
5332 * routine for each one it fines. It searches first for the specific
5333 * bus that's being probed for hinted children (eg isa0), and then for
5334 * generic children (eg isa).
5336 * @param dev bus device to enumerate
5339 bus_enumerate_hinted_children(device_t bus)
5342 const char *dname, *busname;
5346 * enumerate all devices on the specific bus
5348 busname = device_get_nameunit(bus);
5350 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5351 BUS_HINTED_CHILD(bus, dname, dunit);
5354 * and all the generic ones.
5356 busname = device_get_name(bus);
5358 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5359 BUS_HINTED_CHILD(bus, dname, dunit);
5364 /* the _short versions avoid iteration by not calling anything that prints
5365 * more than oneliners. I love oneliners.
5369 print_device_short(device_t dev, int indent)
5374 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5375 dev->unit, dev->desc,
5376 (dev->parent? "":"no "),
5377 (TAILQ_EMPTY(&dev->children)? "no ":""),
5378 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5379 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5380 (dev->flags&DF_WILDCARD? "wildcard,":""),
5381 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5382 (dev->flags&DF_SUSPENDED? "suspended,":""),
5383 (dev->ivars? "":"no "),
5384 (dev->softc? "":"no "),
5389 print_device(device_t dev, int indent)
5394 print_device_short(dev, indent);
5396 indentprintf(("Parent:\n"));
5397 print_device_short(dev->parent, indent+1);
5398 indentprintf(("Driver:\n"));
5399 print_driver_short(dev->driver, indent+1);
5400 indentprintf(("Devclass:\n"));
5401 print_devclass_short(dev->devclass, indent+1);
5405 print_device_tree_short(device_t dev, int indent)
5406 /* print the device and all its children (indented) */
5413 print_device_short(dev, indent);
5415 TAILQ_FOREACH(child, &dev->children, link) {
5416 print_device_tree_short(child, indent+1);
5421 print_device_tree(device_t dev, int indent)
5422 /* print the device and all its children (indented) */
5429 print_device(dev, indent);
5431 TAILQ_FOREACH(child, &dev->children, link) {
5432 print_device_tree(child, indent+1);
5437 print_driver_short(driver_t *driver, int indent)
5442 indentprintf(("driver %s: softc size = %zd\n",
5443 driver->name, driver->size));
5447 print_driver(driver_t *driver, int indent)
5452 print_driver_short(driver, indent);
5456 print_driver_list(driver_list_t drivers, int indent)
5458 driverlink_t driver;
5460 TAILQ_FOREACH(driver, &drivers, link) {
5461 print_driver(driver->driver, indent);
5466 print_devclass_short(devclass_t dc, int indent)
5471 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5475 print_devclass(devclass_t dc, int indent)
5482 print_devclass_short(dc, indent);
5483 indentprintf(("Drivers:\n"));
5484 print_driver_list(dc->drivers, indent+1);
5486 indentprintf(("Devices:\n"));
5487 for (i = 0; i < dc->maxunit; i++)
5489 print_device(dc->devices[i], indent+1);
5493 print_devclass_list_short(void)
5497 printf("Short listing of devclasses, drivers & devices:\n");
5498 TAILQ_FOREACH(dc, &devclasses, link) {
5499 print_devclass_short(dc, 0);
5504 print_devclass_list(void)
5508 printf("Full listing of devclasses, drivers & devices:\n");
5509 TAILQ_FOREACH(dc, &devclasses, link) {
5510 print_devclass(dc, 0);
5517 * User-space access to the device tree.
5519 * We implement a small set of nodes:
5521 * hw.bus Single integer read method to obtain the
5522 * current generation count.
5523 * hw.bus.devices Reads the entire device tree in flat space.
5524 * hw.bus.rman Resource manager interface
5526 * We might like to add the ability to scan devclasses and/or drivers to
5527 * determine what else is currently loaded/available.
5531 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5533 struct u_businfo ubus;
5535 ubus.ub_version = BUS_USER_VERSION;
5536 ubus.ub_generation = bus_data_generation;
5538 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5540 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5541 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5542 "bus-related data");
5545 sysctl_devices(SYSCTL_HANDLER_ARGS)
5548 int *name = (int *)arg1;
5549 u_int namelen = arg2;
5552 struct u_device *udev;
5558 if (bus_data_generation_check(name[0]))
5564 * Scan the list of devices, looking for the requested index.
5566 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5574 * Populate the return item, careful not to overflow the buffer.
5576 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5579 udev->dv_handle = (uintptr_t)dev;
5580 udev->dv_parent = (uintptr_t)dev->parent;
5581 udev->dv_devflags = dev->devflags;
5582 udev->dv_flags = dev->flags;
5583 udev->dv_state = dev->state;
5584 sbuf_new(&sb, udev->dv_fields, sizeof(udev->dv_fields), SBUF_FIXEDLEN);
5585 if (dev->nameunit != NULL)
5586 sbuf_cat(&sb, dev->nameunit);
5587 sbuf_putc(&sb, '\0');
5588 if (dev->desc != NULL)
5589 sbuf_cat(&sb, dev->desc);
5590 sbuf_putc(&sb, '\0');
5591 if (dev->driver != NULL)
5592 sbuf_cat(&sb, dev->driver->name);
5593 sbuf_putc(&sb, '\0');
5594 bus_child_pnpinfo_sb(dev, &sb);
5595 sbuf_putc(&sb, '\0');
5596 bus_child_location_sb(dev, &sb);
5597 sbuf_putc(&sb, '\0');
5598 error = sbuf_finish(&sb);
5600 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5606 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5607 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5608 "system device tree");
5611 bus_data_generation_check(int generation)
5613 if (generation != bus_data_generation)
5616 /* XXX generate optimised lists here? */
5621 bus_data_generation_update(void)
5623 atomic_add_int(&bus_data_generation, 1);
5627 bus_free_resource(device_t dev, int type, struct resource *r)
5631 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5635 device_lookup_by_name(const char *name)
5639 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5640 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5647 * /dev/devctl2 implementation. The existing /dev/devctl device has
5648 * implicit semantics on open, so it could not be reused for this.
5649 * Another option would be to call this /dev/bus?
5652 find_device(struct devreq *req, device_t *devp)
5657 * First, ensure that the name is nul terminated.
5659 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5663 * Second, try to find an attached device whose name matches
5666 dev = device_lookup_by_name(req->dr_name);
5672 /* Finally, give device enumerators a chance. */
5674 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5682 driver_exists(device_t bus, const char *driver)
5686 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5687 if (devclass_find_driver_internal(dc, driver) != NULL)
5694 device_gen_nomatch(device_t dev)
5698 if (dev->flags & DF_NEEDNOMATCH &&
5699 dev->state == DS_NOTPRESENT) {
5700 BUS_PROBE_NOMATCH(dev->parent, dev);
5702 dev->flags |= DF_DONENOMATCH;
5704 dev->flags &= ~DF_NEEDNOMATCH;
5705 TAILQ_FOREACH(child, &dev->children, link) {
5706 device_gen_nomatch(child);
5711 device_do_deferred_actions(void)
5717 * Walk through the devclasses to find all the drivers we've tagged as
5718 * deferred during the freeze and call the driver added routines. They
5719 * have already been added to the lists in the background, so the driver
5720 * added routines that trigger a probe will have all the right bidders
5721 * for the probe auction.
5723 TAILQ_FOREACH(dc, &devclasses, link) {
5724 TAILQ_FOREACH(dl, &dc->drivers, link) {
5725 if (dl->flags & DL_DEFERRED_PROBE) {
5726 devclass_driver_added(dc, dl->driver);
5727 dl->flags &= ~DL_DEFERRED_PROBE;
5733 * We also defer no-match events during a freeze. Walk the tree and
5734 * generate all the pent-up events that are still relevant.
5736 device_gen_nomatch(root_bus);
5737 bus_data_generation_update();
5741 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5748 /* Locate the device to control. */
5750 req = (struct devreq *)data;
5758 case DEV_SET_DRIVER:
5759 case DEV_CLEAR_DRIVER:
5763 error = priv_check(td, PRIV_DRIVER);
5765 error = find_device(req, &dev);
5769 error = priv_check(td, PRIV_DRIVER);
5780 /* Perform the requested operation. */
5783 if (device_is_attached(dev))
5785 else if (!device_is_enabled(dev))
5788 error = device_probe_and_attach(dev);
5791 if (!device_is_attached(dev)) {
5795 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5796 error = device_quiesce(dev);
5800 error = device_detach(dev);
5803 if (device_is_enabled(dev)) {
5809 * If the device has been probed but not attached (e.g.
5810 * when it has been disabled by a loader hint), just
5811 * attach the device rather than doing a full probe.
5814 if (device_is_alive(dev)) {
5816 * If the device was disabled via a hint, clear
5819 if (resource_disabled(dev->driver->name, dev->unit))
5820 resource_unset_value(dev->driver->name,
5821 dev->unit, "disabled");
5822 error = device_attach(dev);
5824 error = device_probe_and_attach(dev);
5827 if (!device_is_enabled(dev)) {
5832 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5833 error = device_quiesce(dev);
5839 * Force DF_FIXEDCLASS on around detach to preserve
5840 * the existing name.
5843 dev->flags |= DF_FIXEDCLASS;
5844 error = device_detach(dev);
5845 if (!(old & DF_FIXEDCLASS))
5846 dev->flags &= ~DF_FIXEDCLASS;
5848 device_disable(dev);
5851 if (device_is_suspended(dev)) {
5855 if (device_get_parent(dev) == NULL) {
5859 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5862 if (!device_is_suspended(dev)) {
5866 if (device_get_parent(dev) == NULL) {
5870 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5872 case DEV_SET_DRIVER: {
5876 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5879 if (driver[0] == '\0') {
5883 if (dev->devclass != NULL &&
5884 strcmp(driver, dev->devclass->name) == 0)
5885 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5889 * Scan drivers for this device's bus looking for at
5890 * least one matching driver.
5892 if (dev->parent == NULL) {
5896 if (!driver_exists(dev->parent, driver)) {
5900 dc = devclass_create(driver);
5906 /* Detach device if necessary. */
5907 if (device_is_attached(dev)) {
5908 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5909 error = device_detach(dev);
5916 /* Clear any previously-fixed device class and unit. */
5917 if (dev->flags & DF_FIXEDCLASS)
5918 devclass_delete_device(dev->devclass, dev);
5919 dev->flags |= DF_WILDCARD;
5922 /* Force the new device class. */
5923 error = devclass_add_device(dc, dev);
5926 dev->flags |= DF_FIXEDCLASS;
5927 error = device_probe_and_attach(dev);
5930 case DEV_CLEAR_DRIVER:
5931 if (!(dev->flags & DF_FIXEDCLASS)) {
5935 if (device_is_attached(dev)) {
5936 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5937 error = device_detach(dev);
5944 dev->flags &= ~DF_FIXEDCLASS;
5945 dev->flags |= DF_WILDCARD;
5946 devclass_delete_device(dev->devclass, dev);
5947 error = device_probe_and_attach(dev);
5950 if (!device_is_attached(dev)) {
5954 error = BUS_RESCAN(dev);
5959 parent = device_get_parent(dev);
5960 if (parent == NULL) {
5964 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5965 if (bus_child_present(dev) != 0) {
5971 error = device_delete_child(parent, dev);
5978 device_frozen = true;
5984 device_do_deferred_actions();
5985 device_frozen = false;
5989 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5993 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
6001 static struct cdevsw devctl2_cdevsw = {
6002 .d_version = D_VERSION,
6003 .d_ioctl = devctl2_ioctl,
6004 .d_name = "devctl2",
6010 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
6011 UID_ROOT, GID_WHEEL, 0600, "devctl2");
6015 * APIs to manage deprecation and obsolescence.
6017 static int obsolete_panic = 0;
6018 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
6019 "Panic when obsolete features are used (0 = never, 1 = if obsolete, "
6020 "2 = if deprecated)");
6023 gone_panic(int major, int running, const char *msg)
6025 switch (obsolete_panic)
6030 if (running < major)
6039 _gone_in(int major, const char *msg)
6041 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6042 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6043 printf("Obsolete code will be removed soon: %s\n", msg);
6045 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
6050 _gone_in_dev(device_t dev, int major, const char *msg)
6052 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
6053 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
6055 "Obsolete code will be removed soon: %s\n", msg);
6058 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6063 DB_SHOW_COMMAND(device, db_show_device)
6070 dev = (device_t)addr;
6072 db_printf("name: %s\n", device_get_nameunit(dev));
6073 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6074 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6075 db_printf(" addr: %p\n", dev);
6076 db_printf(" parent: %p\n", dev->parent);
6077 db_printf(" softc: %p\n", dev->softc);
6078 db_printf(" ivars: %p\n", dev->ivars);
6081 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6085 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6086 db_show_device((db_expr_t)dev, true, count, modif);