2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
77 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
81 * Used to attach drivers to devclasses.
83 typedef struct driverlink *driverlink_t;
86 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
89 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
90 TAILQ_ENTRY(driverlink) passlink;
94 * Forward declarations
96 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
97 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
98 typedef TAILQ_HEAD(device_list, device) device_list_t;
101 TAILQ_ENTRY(devclass) link;
102 devclass_t parent; /* parent in devclass hierarchy */
103 driver_list_t drivers; /* bus devclasses store drivers for bus */
105 device_t *devices; /* array of devices indexed by unit */
106 int maxunit; /* size of devices array */
108 #define DC_HAS_CHILDREN 1
110 struct sysctl_ctx_list sysctl_ctx;
111 struct sysctl_oid *sysctl_tree;
115 * @brief Implementation of device.
119 * A device is a kernel object. The first field must be the
120 * current ops table for the object.
127 TAILQ_ENTRY(device) link; /**< list of devices in parent */
128 TAILQ_ENTRY(device) devlink; /**< global device list membership */
129 device_t parent; /**< parent of this device */
130 device_list_t children; /**< list of child devices */
133 * Details of this device.
135 driver_t *driver; /**< current driver */
136 devclass_t devclass; /**< current device class */
137 int unit; /**< current unit number */
138 char* nameunit; /**< name+unit e.g. foodev0 */
139 char* desc; /**< driver specific description */
140 int busy; /**< count of calls to device_busy() */
141 device_state_t state; /**< current device state */
142 uint32_t devflags; /**< api level flags for device_get_flags() */
143 u_int flags; /**< internal device flags */
144 u_int order; /**< order from device_add_child_ordered() */
145 void *ivars; /**< instance variables */
146 void *softc; /**< current driver's variables */
148 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
149 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
152 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
153 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
155 EVENTHANDLER_LIST_DEFINE(device_attach);
156 EVENTHANDLER_LIST_DEFINE(device_detach);
157 EVENTHANDLER_LIST_DEFINE(dev_lookup);
159 static void devctl2_init(void);
160 static bool device_frozen;
162 #define DRIVERNAME(d) ((d)? d->name : "no driver")
163 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
167 static int bus_debug = 1;
168 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
171 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
172 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
175 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
176 * prevent syslog from deleting initial spaces
178 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
180 static void print_device_short(device_t dev, int indent);
181 static void print_device(device_t dev, int indent);
182 void print_device_tree_short(device_t dev, int indent);
183 void print_device_tree(device_t dev, int indent);
184 static void print_driver_short(driver_t *driver, int indent);
185 static void print_driver(driver_t *driver, int indent);
186 static void print_driver_list(driver_list_t drivers, int indent);
187 static void print_devclass_short(devclass_t dc, int indent);
188 static void print_devclass(devclass_t dc, int indent);
189 void print_devclass_list_short(void);
190 void print_devclass_list(void);
193 /* Make the compiler ignore the function calls */
194 #define PDEBUG(a) /* nop */
195 #define DEVICENAME(d) /* nop */
197 #define print_device_short(d,i) /* nop */
198 #define print_device(d,i) /* nop */
199 #define print_device_tree_short(d,i) /* nop */
200 #define print_device_tree(d,i) /* nop */
201 #define print_driver_short(d,i) /* nop */
202 #define print_driver(d,i) /* nop */
203 #define print_driver_list(d,i) /* nop */
204 #define print_devclass_short(d,i) /* nop */
205 #define print_devclass(d,i) /* nop */
206 #define print_devclass_list_short() /* nop */
207 #define print_devclass_list() /* nop */
215 DEVCLASS_SYSCTL_PARENT,
219 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
221 devclass_t dc = (devclass_t)arg1;
225 case DEVCLASS_SYSCTL_PARENT:
226 value = dc->parent ? dc->parent->name : "";
231 return (SYSCTL_OUT_STR(req, value));
235 devclass_sysctl_init(devclass_t dc)
237 if (dc->sysctl_tree != NULL)
239 sysctl_ctx_init(&dc->sysctl_ctx);
240 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
241 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
242 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
243 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
245 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
246 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
252 DEVICE_SYSCTL_DRIVER,
253 DEVICE_SYSCTL_LOCATION,
254 DEVICE_SYSCTL_PNPINFO,
255 DEVICE_SYSCTL_PARENT,
259 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
261 device_t dev = (device_t)arg1;
268 case DEVICE_SYSCTL_DESC:
269 value = dev->desc ? dev->desc : "";
271 case DEVICE_SYSCTL_DRIVER:
272 value = dev->driver ? dev->driver->name : "";
274 case DEVICE_SYSCTL_LOCATION:
275 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
276 bus_child_location_str(dev, buf, 1024);
278 case DEVICE_SYSCTL_PNPINFO:
279 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
280 bus_child_pnpinfo_str(dev, buf, 1024);
282 case DEVICE_SYSCTL_PARENT:
283 value = dev->parent ? dev->parent->nameunit : "";
288 error = SYSCTL_OUT_STR(req, value);
295 device_sysctl_init(device_t dev)
297 devclass_t dc = dev->devclass;
300 if (dev->sysctl_tree != NULL)
302 devclass_sysctl_init(dc);
303 sysctl_ctx_init(&dev->sysctl_ctx);
304 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
305 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
306 dev->nameunit + strlen(dc->name),
307 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
308 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
309 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
310 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
311 "device description");
312 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
314 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
315 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
316 "device driver name");
317 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 OID_AUTO, "%location",
319 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
320 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
321 "device location relative to parent");
322 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
323 OID_AUTO, "%pnpinfo",
324 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
325 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
326 "device identification");
327 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
329 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
330 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
332 if (bus_get_domain(dev, &domain) == 0)
333 SYSCTL_ADD_INT(&dev->sysctl_ctx,
334 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
335 CTLFLAG_RD, NULL, domain, "NUMA domain");
339 device_sysctl_update(device_t dev)
341 devclass_t dc = dev->devclass;
343 if (dev->sysctl_tree == NULL)
345 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
349 device_sysctl_fini(device_t dev)
351 if (dev->sysctl_tree == NULL)
353 sysctl_ctx_free(&dev->sysctl_ctx);
354 dev->sysctl_tree = NULL;
358 * /dev/devctl implementation
362 * This design allows only one reader for /dev/devctl. This is not desirable
363 * in the long run, but will get a lot of hair out of this implementation.
364 * Maybe we should make this device a clonable device.
366 * Also note: we specifically do not attach a device to the device_t tree
367 * to avoid potential chicken and egg problems. One could argue that all
368 * of this belongs to the root node.
371 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
372 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
373 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
374 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
375 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
377 static d_open_t devopen;
378 static d_close_t devclose;
379 static d_read_t devread;
380 static d_ioctl_t devioctl;
381 static d_poll_t devpoll;
382 static d_kqfilter_t devkqfilter;
384 static struct cdevsw dev_cdevsw = {
385 .d_version = D_VERSION,
391 .d_kqfilter = devkqfilter,
395 struct dev_event_info {
397 STAILQ_ENTRY(dev_event_info) dei_link;
400 STAILQ_HEAD(devq, dev_event_info);
402 static struct dev_softc {
414 static void filt_devctl_detach(struct knote *kn);
415 static int filt_devctl_read(struct knote *kn, long hint);
417 struct filterops devctl_rfiltops = {
419 .f_detach = filt_devctl_detach,
420 .f_event = filt_devctl_read,
423 static struct cdev *devctl_dev;
428 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
429 UID_ROOT, GID_WHEEL, 0600, "devctl");
430 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
431 cv_init(&devsoftc.cv, "dev cv");
432 STAILQ_INIT(&devsoftc.devq);
433 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
438 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
440 mtx_lock(&devsoftc.mtx);
441 if (devsoftc.inuse) {
442 mtx_unlock(&devsoftc.mtx);
447 mtx_unlock(&devsoftc.mtx);
452 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
454 mtx_lock(&devsoftc.mtx);
456 devsoftc.nonblock = 0;
458 cv_broadcast(&devsoftc.cv);
459 funsetown(&devsoftc.sigio);
460 mtx_unlock(&devsoftc.mtx);
465 * The read channel for this device is used to report changes to
466 * userland in realtime. We are required to free the data as well as
467 * the n1 object because we allocate them separately. Also note that
468 * we return one record at a time. If you try to read this device a
469 * character at a time, you will lose the rest of the data. Listening
470 * programs are expected to cope.
473 devread(struct cdev *dev, struct uio *uio, int ioflag)
475 struct dev_event_info *n1;
478 mtx_lock(&devsoftc.mtx);
479 while (STAILQ_EMPTY(&devsoftc.devq)) {
480 if (devsoftc.nonblock) {
481 mtx_unlock(&devsoftc.mtx);
484 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
487 * Need to translate ERESTART to EINTR here? -- jake
489 mtx_unlock(&devsoftc.mtx);
493 n1 = STAILQ_FIRST(&devsoftc.devq);
494 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
496 mtx_unlock(&devsoftc.mtx);
497 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
498 free(n1->dei_data, M_BUS);
504 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
509 devsoftc.nonblock = 1;
511 devsoftc.nonblock = 0;
520 return fsetown(*(int *)data, &devsoftc.sigio);
522 *(int *)data = fgetown(&devsoftc.sigio);
525 /* (un)Support for other fcntl() calls. */
536 devpoll(struct cdev *dev, int events, struct thread *td)
540 mtx_lock(&devsoftc.mtx);
541 if (events & (POLLIN | POLLRDNORM)) {
542 if (!STAILQ_EMPTY(&devsoftc.devq))
543 revents = events & (POLLIN | POLLRDNORM);
545 selrecord(td, &devsoftc.sel);
547 mtx_unlock(&devsoftc.mtx);
553 devkqfilter(struct cdev *dev, struct knote *kn)
557 if (kn->kn_filter == EVFILT_READ) {
558 kn->kn_fop = &devctl_rfiltops;
559 knlist_add(&devsoftc.sel.si_note, kn, 0);
567 filt_devctl_detach(struct knote *kn)
569 knlist_remove(&devsoftc.sel.si_note, kn, 0);
573 filt_devctl_read(struct knote *kn, long hint)
575 kn->kn_data = devsoftc.queued;
576 return (kn->kn_data != 0);
580 * @brief Return whether the userland process is running
583 devctl_process_running(void)
585 return (devsoftc.inuse == 1);
589 * @brief Queue data to be read from the devctl device
591 * Generic interface to queue data to the devctl device. It is
592 * assumed that @p data is properly formatted. It is further assumed
593 * that @p data is allocated using the M_BUS malloc type.
596 devctl_queue_data_f(char *data, int flags)
598 struct dev_event_info *n1 = NULL, *n2 = NULL;
600 if (strlen(data) == 0)
602 if (devctl_queue_length == 0)
604 n1 = malloc(sizeof(*n1), M_BUS, flags);
608 mtx_lock(&devsoftc.mtx);
609 if (devctl_queue_length == 0) {
610 mtx_unlock(&devsoftc.mtx);
611 free(n1->dei_data, M_BUS);
615 /* Leave at least one spot in the queue... */
616 while (devsoftc.queued > devctl_queue_length - 1) {
617 n2 = STAILQ_FIRST(&devsoftc.devq);
618 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
619 free(n2->dei_data, M_BUS);
623 STAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
625 cv_broadcast(&devsoftc.cv);
626 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
627 mtx_unlock(&devsoftc.mtx);
628 selwakeup(&devsoftc.sel);
629 if (devsoftc.async && devsoftc.sigio != NULL)
630 pgsigio(&devsoftc.sigio, SIGIO, 0);
634 * We have to free data on all error paths since the caller
635 * assumes it will be free'd when this item is dequeued.
642 devctl_queue_data(char *data)
644 devctl_queue_data_f(data, M_NOWAIT);
648 * @brief Send a 'notification' to userland, using standard ways
651 devctl_notify_f(const char *system, const char *subsystem, const char *type,
652 const char *data, int flags)
658 return; /* BOGUS! Must specify system. */
659 if (subsystem == NULL)
660 return; /* BOGUS! Must specify subsystem. */
662 return; /* BOGUS! Must specify type. */
663 len += strlen(" system=") + strlen(system);
664 len += strlen(" subsystem=") + strlen(subsystem);
665 len += strlen(" type=") + strlen(type);
666 /* add in the data message plus newline. */
669 len += 3; /* '!', '\n', and NUL */
670 msg = malloc(len, M_BUS, flags);
672 return; /* Drop it on the floor */
674 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
675 system, subsystem, type, data);
677 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
678 system, subsystem, type);
679 devctl_queue_data_f(msg, flags);
683 devctl_notify(const char *system, const char *subsystem, const char *type,
686 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
690 * Common routine that tries to make sending messages as easy as possible.
691 * We allocate memory for the data, copy strings into that, but do not
692 * free it unless there's an error. The dequeue part of the driver should
693 * free the data. We don't send data when the device is disabled. We do
694 * send data, even when we have no listeners, because we wish to avoid
695 * races relating to startup and restart of listening applications.
697 * devaddq is designed to string together the type of event, with the
698 * object of that event, plus the plug and play info and location info
699 * for that event. This is likely most useful for devices, but less
700 * useful for other consumers of this interface. Those should use
701 * the devctl_queue_data() interface instead.
704 devaddq(const char *type, const char *what, device_t dev)
711 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
713 data = malloc(1024, M_BUS, M_NOWAIT);
717 /* get the bus specific location of this device */
718 loc = malloc(1024, M_BUS, M_NOWAIT);
722 bus_child_location_str(dev, loc, 1024);
724 /* Get the bus specific pnp info of this device */
725 pnp = malloc(1024, M_BUS, M_NOWAIT);
729 bus_child_pnpinfo_str(dev, pnp, 1024);
731 /* Get the parent of this device, or / if high enough in the tree. */
732 if (device_get_parent(dev) == NULL)
733 parstr = "."; /* Or '/' ? */
735 parstr = device_get_nameunit(device_get_parent(dev));
736 /* String it all together. */
737 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
741 devctl_queue_data(data);
751 * A device was added to the tree. We are called just after it successfully
752 * attaches (that is, probe and attach success for this device). No call
753 * is made if a device is merely parented into the tree. See devnomatch
754 * if probe fails. If attach fails, no notification is sent (but maybe
755 * we should have a different message for this).
758 devadded(device_t dev)
760 devaddq("+", device_get_nameunit(dev), dev);
764 * A device was removed from the tree. We are called just before this
768 devremoved(device_t dev)
770 devaddq("-", device_get_nameunit(dev), dev);
774 * Called when there's no match for this device. This is only called
775 * the first time that no match happens, so we don't keep getting this
776 * message. Should that prove to be undesirable, we can change it.
777 * This is called when all drivers that can attach to a given bus
778 * decline to accept this device. Other errors may not be detected.
781 devnomatch(device_t dev)
783 devaddq("?", "", dev);
787 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
789 struct dev_event_info *n1;
792 q = devctl_queue_length;
793 error = sysctl_handle_int(oidp, &q, 0, req);
794 if (error || !req->newptr)
798 if (mtx_initialized(&devsoftc.mtx))
799 mtx_lock(&devsoftc.mtx);
800 devctl_queue_length = q;
801 while (devsoftc.queued > devctl_queue_length) {
802 n1 = STAILQ_FIRST(&devsoftc.devq);
803 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
804 free(n1->dei_data, M_BUS);
808 if (mtx_initialized(&devsoftc.mtx))
809 mtx_unlock(&devsoftc.mtx);
814 * @brief safely quotes strings that might have double quotes in them.
816 * The devctl protocol relies on quoted strings having matching quotes.
817 * This routine quotes any internal quotes so the resulting string
818 * is safe to pass to snprintf to construct, for example pnp info strings.
820 * @param sb sbuf to place the characters into
821 * @param src Original buffer.
824 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
826 while (*src != '\0') {
827 if (*src == '"' || *src == '\\')
829 sbuf_putc(sb, *src++);
833 /* End of /dev/devctl code */
835 static TAILQ_HEAD(,device) bus_data_devices;
836 static int bus_data_generation = 1;
838 static kobj_method_t null_methods[] = {
842 DEFINE_CLASS(null, null_methods, 0);
845 * Bus pass implementation
848 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
849 int bus_current_pass = BUS_PASS_ROOT;
853 * @brief Register the pass level of a new driver attachment
855 * Register a new driver attachment's pass level. If no driver
856 * attachment with the same pass level has been added, then @p new
857 * will be added to the global passes list.
859 * @param new the new driver attachment
862 driver_register_pass(struct driverlink *new)
864 struct driverlink *dl;
866 /* We only consider pass numbers during boot. */
867 if (bus_current_pass == BUS_PASS_DEFAULT)
871 * Walk the passes list. If we already know about this pass
872 * then there is nothing to do. If we don't, then insert this
873 * driver link into the list.
875 TAILQ_FOREACH(dl, &passes, passlink) {
876 if (dl->pass < new->pass)
878 if (dl->pass == new->pass)
880 TAILQ_INSERT_BEFORE(dl, new, passlink);
883 TAILQ_INSERT_TAIL(&passes, new, passlink);
887 * @brief Raise the current bus pass
889 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
890 * method on the root bus to kick off a new device tree scan for each
891 * new pass level that has at least one driver.
894 bus_set_pass(int pass)
896 struct driverlink *dl;
898 if (bus_current_pass > pass)
899 panic("Attempt to lower bus pass level");
901 TAILQ_FOREACH(dl, &passes, passlink) {
902 /* Skip pass values below the current pass level. */
903 if (dl->pass <= bus_current_pass)
907 * Bail once we hit a driver with a pass level that is
914 * Raise the pass level to the next level and rescan
917 bus_current_pass = dl->pass;
918 BUS_NEW_PASS(root_bus);
922 * If there isn't a driver registered for the requested pass,
923 * then bus_current_pass might still be less than 'pass'. Set
924 * it to 'pass' in that case.
926 if (bus_current_pass < pass)
927 bus_current_pass = pass;
928 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
932 * Devclass implementation
935 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
939 * @brief Find or create a device class
941 * If a device class with the name @p classname exists, return it,
942 * otherwise if @p create is non-zero create and return a new device
945 * If @p parentname is non-NULL, the parent of the devclass is set to
946 * the devclass of that name.
948 * @param classname the devclass name to find or create
949 * @param parentname the parent devclass name or @c NULL
950 * @param create non-zero to create a devclass
953 devclass_find_internal(const char *classname, const char *parentname,
958 PDEBUG(("looking for %s", classname));
962 TAILQ_FOREACH(dc, &devclasses, link) {
963 if (!strcmp(dc->name, classname))
968 PDEBUG(("creating %s", classname));
969 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
970 M_BUS, M_NOWAIT | M_ZERO);
974 dc->name = (char*) (dc + 1);
975 strcpy(dc->name, classname);
976 TAILQ_INIT(&dc->drivers);
977 TAILQ_INSERT_TAIL(&devclasses, dc, link);
979 bus_data_generation_update();
983 * If a parent class is specified, then set that as our parent so
984 * that this devclass will support drivers for the parent class as
985 * well. If the parent class has the same name don't do this though
986 * as it creates a cycle that can trigger an infinite loop in
987 * device_probe_child() if a device exists for which there is no
990 if (parentname && dc && !dc->parent &&
991 strcmp(classname, parentname) != 0) {
992 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
993 dc->parent->flags |= DC_HAS_CHILDREN;
1000 * @brief Create a device class
1002 * If a device class with the name @p classname exists, return it,
1003 * otherwise create and return a new device class.
1005 * @param classname the devclass name to find or create
1008 devclass_create(const char *classname)
1010 return (devclass_find_internal(classname, NULL, TRUE));
1014 * @brief Find a device class
1016 * If a device class with the name @p classname exists, return it,
1017 * otherwise return @c NULL.
1019 * @param classname the devclass name to find
1022 devclass_find(const char *classname)
1024 return (devclass_find_internal(classname, NULL, FALSE));
1028 * @brief Register that a device driver has been added to a devclass
1030 * Register that a device driver has been added to a devclass. This
1031 * is called by devclass_add_driver to accomplish the recursive
1032 * notification of all the children classes of dc, as well as dc.
1033 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1036 * We do a full search here of the devclass list at each iteration
1037 * level to save storing children-lists in the devclass structure. If
1038 * we ever move beyond a few dozen devices doing this, we may need to
1041 * @param dc the devclass to edit
1042 * @param driver the driver that was just added
1045 devclass_driver_added(devclass_t dc, driver_t *driver)
1051 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1053 for (i = 0; i < dc->maxunit; i++)
1054 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1055 BUS_DRIVER_ADDED(dc->devices[i], driver);
1058 * Walk through the children classes. Since we only keep a
1059 * single parent pointer around, we walk the entire list of
1060 * devclasses looking for children. We set the
1061 * DC_HAS_CHILDREN flag when a child devclass is created on
1062 * the parent, so we only walk the list for those devclasses
1063 * that have children.
1065 if (!(dc->flags & DC_HAS_CHILDREN))
1068 TAILQ_FOREACH(dc, &devclasses, link) {
1069 if (dc->parent == parent)
1070 devclass_driver_added(dc, driver);
1075 * @brief Add a device driver to a device class
1077 * Add a device driver to a devclass. This is normally called
1078 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1079 * all devices in the devclass will be called to allow them to attempt
1080 * to re-probe any unmatched children.
1082 * @param dc the devclass to edit
1083 * @param driver the driver to register
1086 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1089 const char *parentname;
1091 PDEBUG(("%s", DRIVERNAME(driver)));
1093 /* Don't allow invalid pass values. */
1094 if (pass <= BUS_PASS_ROOT)
1097 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1102 * Compile the driver's methods. Also increase the reference count
1103 * so that the class doesn't get freed when the last instance
1104 * goes. This means we can safely use static methods and avoids a
1105 * double-free in devclass_delete_driver.
1107 kobj_class_compile((kobj_class_t) driver);
1110 * If the driver has any base classes, make the
1111 * devclass inherit from the devclass of the driver's
1112 * first base class. This will allow the system to
1113 * search for drivers in both devclasses for children
1114 * of a device using this driver.
1116 if (driver->baseclasses)
1117 parentname = driver->baseclasses[0]->name;
1120 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1122 dl->driver = driver;
1123 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1124 driver->refs++; /* XXX: kobj_mtx */
1126 driver_register_pass(dl);
1128 if (device_frozen) {
1129 dl->flags |= DL_DEFERRED_PROBE;
1131 devclass_driver_added(dc, driver);
1133 bus_data_generation_update();
1138 * @brief Register that a device driver has been deleted from a devclass
1140 * Register that a device driver has been removed from a devclass.
1141 * This is called by devclass_delete_driver to accomplish the
1142 * recursive notification of all the children classes of busclass, as
1143 * well as busclass. Each layer will attempt to detach the driver
1144 * from any devices that are children of the bus's devclass. The function
1145 * will return an error if a device fails to detach.
1147 * We do a full search here of the devclass list at each iteration
1148 * level to save storing children-lists in the devclass structure. If
1149 * we ever move beyond a few dozen devices doing this, we may need to
1152 * @param busclass the devclass of the parent bus
1153 * @param dc the devclass of the driver being deleted
1154 * @param driver the driver being deleted
1157 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1164 * Disassociate from any devices. We iterate through all the
1165 * devices in the devclass of the driver and detach any which are
1166 * using the driver and which have a parent in the devclass which
1167 * we are deleting from.
1169 * Note that since a driver can be in multiple devclasses, we
1170 * should not detach devices which are not children of devices in
1171 * the affected devclass.
1173 * If we're frozen, we don't generate NOMATCH events. Mark to
1176 for (i = 0; i < dc->maxunit; i++) {
1177 if (dc->devices[i]) {
1178 dev = dc->devices[i];
1179 if (dev->driver == driver && dev->parent &&
1180 dev->parent->devclass == busclass) {
1181 if ((error = device_detach(dev)) != 0)
1183 if (device_frozen) {
1184 dev->flags &= ~DF_DONENOMATCH;
1185 dev->flags |= DF_NEEDNOMATCH;
1187 BUS_PROBE_NOMATCH(dev->parent, dev);
1189 dev->flags |= DF_DONENOMATCH;
1196 * Walk through the children classes. Since we only keep a
1197 * single parent pointer around, we walk the entire list of
1198 * devclasses looking for children. We set the
1199 * DC_HAS_CHILDREN flag when a child devclass is created on
1200 * the parent, so we only walk the list for those devclasses
1201 * that have children.
1203 if (!(busclass->flags & DC_HAS_CHILDREN))
1206 TAILQ_FOREACH(busclass, &devclasses, link) {
1207 if (busclass->parent == parent) {
1208 error = devclass_driver_deleted(busclass, dc, driver);
1217 * @brief Delete a device driver from a device class
1219 * Delete a device driver from a devclass. This is normally called
1220 * automatically by DRIVER_MODULE().
1222 * If the driver is currently attached to any devices,
1223 * devclass_delete_driver() will first attempt to detach from each
1224 * device. If one of the detach calls fails, the driver will not be
1227 * @param dc the devclass to edit
1228 * @param driver the driver to unregister
1231 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1233 devclass_t dc = devclass_find(driver->name);
1237 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1243 * Find the link structure in the bus' list of drivers.
1245 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1246 if (dl->driver == driver)
1251 PDEBUG(("%s not found in %s list", driver->name,
1256 error = devclass_driver_deleted(busclass, dc, driver);
1260 TAILQ_REMOVE(&busclass->drivers, dl, link);
1265 if (driver->refs == 0)
1266 kobj_class_free((kobj_class_t) driver);
1268 bus_data_generation_update();
1273 * @brief Quiesces a set of device drivers from a device class
1275 * Quiesce a device driver from a devclass. This is normally called
1276 * automatically by DRIVER_MODULE().
1278 * If the driver is currently attached to any devices,
1279 * devclass_quiesece_driver() will first attempt to quiesce each
1282 * @param dc the devclass to edit
1283 * @param driver the driver to unregister
1286 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1288 devclass_t dc = devclass_find(driver->name);
1294 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1300 * Find the link structure in the bus' list of drivers.
1302 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1303 if (dl->driver == driver)
1308 PDEBUG(("%s not found in %s list", driver->name,
1314 * Quiesce all devices. We iterate through all the devices in
1315 * the devclass of the driver and quiesce any which are using
1316 * the driver and which have a parent in the devclass which we
1319 * Note that since a driver can be in multiple devclasses, we
1320 * should not quiesce devices which are not children of
1321 * devices in the affected devclass.
1323 for (i = 0; i < dc->maxunit; i++) {
1324 if (dc->devices[i]) {
1325 dev = dc->devices[i];
1326 if (dev->driver == driver && dev->parent &&
1327 dev->parent->devclass == busclass) {
1328 if ((error = device_quiesce(dev)) != 0)
1341 devclass_find_driver_internal(devclass_t dc, const char *classname)
1345 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1347 TAILQ_FOREACH(dl, &dc->drivers, link) {
1348 if (!strcmp(dl->driver->name, classname))
1352 PDEBUG(("not found"));
1357 * @brief Return the name of the devclass
1360 devclass_get_name(devclass_t dc)
1366 * @brief Find a device given a unit number
1368 * @param dc the devclass to search
1369 * @param unit the unit number to search for
1371 * @returns the device with the given unit number or @c
1372 * NULL if there is no such device
1375 devclass_get_device(devclass_t dc, int unit)
1377 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1379 return (dc->devices[unit]);
1383 * @brief Find the softc field of a device given a unit number
1385 * @param dc the devclass to search
1386 * @param unit the unit number to search for
1388 * @returns the softc field of the device with the given
1389 * unit number or @c NULL if there is no such
1393 devclass_get_softc(devclass_t dc, int unit)
1397 dev = devclass_get_device(dc, unit);
1401 return (device_get_softc(dev));
1405 * @brief Get a list of devices in the devclass
1407 * An array containing a list of all the devices in the given devclass
1408 * is allocated and returned in @p *devlistp. The number of devices
1409 * in the array is returned in @p *devcountp. The caller should free
1410 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1412 * @param dc the devclass to examine
1413 * @param devlistp points at location for array pointer return
1415 * @param devcountp points at location for array size return value
1418 * @retval ENOMEM the array allocation failed
1421 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1426 count = devclass_get_count(dc);
1427 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1432 for (i = 0; i < dc->maxunit; i++) {
1433 if (dc->devices[i]) {
1434 list[count] = dc->devices[i];
1446 * @brief Get a list of drivers in the devclass
1448 * An array containing a list of pointers to all the drivers in the
1449 * given devclass is allocated and returned in @p *listp. The number
1450 * of drivers in the array is returned in @p *countp. The caller should
1451 * free the array using @c free(p, M_TEMP).
1453 * @param dc the devclass to examine
1454 * @param listp gives location for array pointer return value
1455 * @param countp gives location for number of array elements
1459 * @retval ENOMEM the array allocation failed
1462 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1469 TAILQ_FOREACH(dl, &dc->drivers, link)
1471 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1476 TAILQ_FOREACH(dl, &dc->drivers, link) {
1477 list[count] = dl->driver;
1487 * @brief Get the number of devices in a devclass
1489 * @param dc the devclass to examine
1492 devclass_get_count(devclass_t dc)
1497 for (i = 0; i < dc->maxunit; i++)
1504 * @brief Get the maximum unit number used in a devclass
1506 * Note that this is one greater than the highest currently-allocated
1507 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1508 * that not even the devclass has been allocated yet.
1510 * @param dc the devclass to examine
1513 devclass_get_maxunit(devclass_t dc)
1517 return (dc->maxunit);
1521 * @brief Find a free unit number in a devclass
1523 * This function searches for the first unused unit number greater
1524 * that or equal to @p unit.
1526 * @param dc the devclass to examine
1527 * @param unit the first unit number to check
1530 devclass_find_free_unit(devclass_t dc, int unit)
1534 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1540 * @brief Set the parent of a devclass
1542 * The parent class is normally initialised automatically by
1545 * @param dc the devclass to edit
1546 * @param pdc the new parent devclass
1549 devclass_set_parent(devclass_t dc, devclass_t pdc)
1555 * @brief Get the parent of a devclass
1557 * @param dc the devclass to examine
1560 devclass_get_parent(devclass_t dc)
1562 return (dc->parent);
1565 struct sysctl_ctx_list *
1566 devclass_get_sysctl_ctx(devclass_t dc)
1568 return (&dc->sysctl_ctx);
1572 devclass_get_sysctl_tree(devclass_t dc)
1574 return (dc->sysctl_tree);
1579 * @brief Allocate a unit number
1581 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1582 * will do). The allocated unit number is returned in @p *unitp.
1584 * @param dc the devclass to allocate from
1585 * @param unitp points at the location for the allocated unit
1589 * @retval EEXIST the requested unit number is already allocated
1590 * @retval ENOMEM memory allocation failure
1593 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1598 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1600 /* Ask the parent bus if it wants to wire this device. */
1602 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1605 /* If we were given a wired unit number, check for existing device */
1608 if (unit >= 0 && unit < dc->maxunit &&
1609 dc->devices[unit] != NULL) {
1611 printf("%s: %s%d already exists; skipping it\n",
1612 dc->name, dc->name, *unitp);
1616 /* Unwired device, find the next available slot for it */
1618 for (unit = 0;; unit++) {
1619 /* If there is an "at" hint for a unit then skip it. */
1620 if (resource_string_value(dc->name, unit, "at", &s) ==
1624 /* If this device slot is already in use, skip it. */
1625 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1633 * We've selected a unit beyond the length of the table, so let's
1634 * extend the table to make room for all units up to and including
1637 if (unit >= dc->maxunit) {
1638 device_t *newlist, *oldlist;
1641 oldlist = dc->devices;
1642 newsize = roundup((unit + 1),
1643 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1644 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1647 if (oldlist != NULL)
1648 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1649 bzero(newlist + dc->maxunit,
1650 sizeof(device_t) * (newsize - dc->maxunit));
1651 dc->devices = newlist;
1652 dc->maxunit = newsize;
1653 if (oldlist != NULL)
1654 free(oldlist, M_BUS);
1656 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1664 * @brief Add a device to a devclass
1666 * A unit number is allocated for the device (using the device's
1667 * preferred unit number if any) and the device is registered in the
1668 * devclass. This allows the device to be looked up by its unit
1669 * number, e.g. by decoding a dev_t minor number.
1671 * @param dc the devclass to add to
1672 * @param dev the device to add
1675 * @retval EEXIST the requested unit number is already allocated
1676 * @retval ENOMEM memory allocation failure
1679 devclass_add_device(devclass_t dc, device_t dev)
1683 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1685 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1688 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1692 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1693 free(dev->nameunit, M_BUS);
1694 dev->nameunit = NULL;
1697 dc->devices[dev->unit] = dev;
1699 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1706 * @brief Delete a device from a devclass
1708 * The device is removed from the devclass's device list and its unit
1711 * @param dc the devclass to delete from
1712 * @param dev the device to delete
1717 devclass_delete_device(devclass_t dc, device_t dev)
1722 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1724 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1725 panic("devclass_delete_device: inconsistent device class");
1726 dc->devices[dev->unit] = NULL;
1727 if (dev->flags & DF_WILDCARD)
1729 dev->devclass = NULL;
1730 free(dev->nameunit, M_BUS);
1731 dev->nameunit = NULL;
1738 * @brief Make a new device and add it as a child of @p parent
1740 * @param parent the parent of the new device
1741 * @param name the devclass name of the new device or @c NULL
1742 * to leave the devclass unspecified
1743 * @parem unit the unit number of the new device of @c -1 to
1744 * leave the unit number unspecified
1746 * @returns the new device
1749 make_device(device_t parent, const char *name, int unit)
1754 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1757 dc = devclass_find_internal(name, NULL, TRUE);
1759 printf("make_device: can't find device class %s\n",
1767 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1771 dev->parent = parent;
1772 TAILQ_INIT(&dev->children);
1773 kobj_init((kobj_t) dev, &null_class);
1775 dev->devclass = NULL;
1777 dev->nameunit = NULL;
1781 dev->flags = DF_ENABLED;
1784 dev->flags |= DF_WILDCARD;
1786 dev->flags |= DF_FIXEDCLASS;
1787 if (devclass_add_device(dc, dev)) {
1788 kobj_delete((kobj_t) dev, M_BUS);
1792 if (parent != NULL && device_has_quiet_children(parent))
1793 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1797 dev->state = DS_NOTPRESENT;
1799 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1800 bus_data_generation_update();
1807 * @brief Print a description of a device.
1810 device_print_child(device_t dev, device_t child)
1814 if (device_is_alive(child))
1815 retval += BUS_PRINT_CHILD(dev, child);
1817 retval += device_printf(child, " not found\n");
1823 * @brief Create a new device
1825 * This creates a new device and adds it as a child of an existing
1826 * parent device. The new device will be added after the last existing
1827 * child with order zero.
1829 * @param dev the device which will be the parent of the
1831 * @param name devclass name for new device or @c NULL if not
1833 * @param unit unit number for new device or @c -1 if not
1836 * @returns the new device
1839 device_add_child(device_t dev, const char *name, int unit)
1841 return (device_add_child_ordered(dev, 0, name, unit));
1845 * @brief Create a new device
1847 * This creates a new device and adds it as a child of an existing
1848 * parent device. The new device will be added after the last existing
1849 * child with the same order.
1851 * @param dev the device which will be the parent of the
1853 * @param order a value which is used to partially sort the
1854 * children of @p dev - devices created using
1855 * lower values of @p order appear first in @p
1856 * dev's list of children
1857 * @param name devclass name for new device or @c NULL if not
1859 * @param unit unit number for new device or @c -1 if not
1862 * @returns the new device
1865 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1870 PDEBUG(("%s at %s with order %u as unit %d",
1871 name, DEVICENAME(dev), order, unit));
1872 KASSERT(name != NULL || unit == -1,
1873 ("child device with wildcard name and specific unit number"));
1875 child = make_device(dev, name, unit);
1878 child->order = order;
1880 TAILQ_FOREACH(place, &dev->children, link) {
1881 if (place->order > order)
1887 * The device 'place' is the first device whose order is
1888 * greater than the new child.
1890 TAILQ_INSERT_BEFORE(place, child, link);
1893 * The new child's order is greater or equal to the order of
1894 * any existing device. Add the child to the tail of the list.
1896 TAILQ_INSERT_TAIL(&dev->children, child, link);
1899 bus_data_generation_update();
1904 * @brief Delete a device
1906 * This function deletes a device along with all of its children. If
1907 * the device currently has a driver attached to it, the device is
1908 * detached first using device_detach().
1910 * @param dev the parent device
1911 * @param child the device to delete
1914 * @retval non-zero a unit error code describing the error
1917 device_delete_child(device_t dev, device_t child)
1920 device_t grandchild;
1922 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1924 /* detach parent before deleting children, if any */
1925 if ((error = device_detach(child)) != 0)
1928 /* remove children second */
1929 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1930 error = device_delete_child(child, grandchild);
1935 if (child->devclass)
1936 devclass_delete_device(child->devclass, child);
1938 BUS_CHILD_DELETED(dev, child);
1939 TAILQ_REMOVE(&dev->children, child, link);
1940 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1941 kobj_delete((kobj_t) child, M_BUS);
1943 bus_data_generation_update();
1948 * @brief Delete all children devices of the given device, if any.
1950 * This function deletes all children devices of the given device, if
1951 * any, using the device_delete_child() function for each device it
1952 * finds. If a child device cannot be deleted, this function will
1953 * return an error code.
1955 * @param dev the parent device
1958 * @retval non-zero a device would not detach
1961 device_delete_children(device_t dev)
1966 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1970 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1971 error = device_delete_child(dev, child);
1973 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
1981 * @brief Find a device given a unit number
1983 * This is similar to devclass_get_devices() but only searches for
1984 * devices which have @p dev as a parent.
1986 * @param dev the parent device to search
1987 * @param unit the unit number to search for. If the unit is -1,
1988 * return the first child of @p dev which has name
1989 * @p classname (that is, the one with the lowest unit.)
1991 * @returns the device with the given unit number or @c
1992 * NULL if there is no such device
1995 device_find_child(device_t dev, const char *classname, int unit)
2000 dc = devclass_find(classname);
2005 child = devclass_get_device(dc, unit);
2006 if (child && child->parent == dev)
2009 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2010 child = devclass_get_device(dc, unit);
2011 if (child && child->parent == dev)
2022 first_matching_driver(devclass_t dc, device_t dev)
2025 return (devclass_find_driver_internal(dc, dev->devclass->name));
2026 return (TAILQ_FIRST(&dc->drivers));
2033 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2035 if (dev->devclass) {
2037 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2038 if (!strcmp(dev->devclass->name, dl->driver->name))
2042 return (TAILQ_NEXT(last, link));
2049 device_probe_child(device_t dev, device_t child)
2052 driverlink_t best = NULL;
2054 int result, pri = 0;
2055 int hasclass = (child->devclass != NULL);
2061 panic("device_probe_child: parent device has no devclass");
2064 * If the state is already probed, then return. However, don't
2065 * return if we can rebid this object.
2067 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2070 for (; dc; dc = dc->parent) {
2071 for (dl = first_matching_driver(dc, child);
2073 dl = next_matching_driver(dc, child, dl)) {
2074 /* If this driver's pass is too high, then ignore it. */
2075 if (dl->pass > bus_current_pass)
2078 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2079 result = device_set_driver(child, dl->driver);
2080 if (result == ENOMEM)
2082 else if (result != 0)
2085 if (device_set_devclass(child,
2086 dl->driver->name) != 0) {
2087 char const * devname =
2088 device_get_name(child);
2089 if (devname == NULL)
2090 devname = "(unknown)";
2091 printf("driver bug: Unable to set "
2092 "devclass (class: %s "
2096 (void)device_set_driver(child, NULL);
2101 /* Fetch any flags for the device before probing. */
2102 resource_int_value(dl->driver->name, child->unit,
2103 "flags", &child->devflags);
2105 result = DEVICE_PROBE(child);
2107 /* Reset flags and devclass before the next probe. */
2108 child->devflags = 0;
2110 (void)device_set_devclass(child, NULL);
2113 * If the driver returns SUCCESS, there can be
2114 * no higher match for this device.
2123 * Reset DF_QUIET in case this driver doesn't
2124 * end up as the best driver.
2126 device_verbose(child);
2129 * Probes that return BUS_PROBE_NOWILDCARD or lower
2130 * only match on devices whose driver was explicitly
2133 if (result <= BUS_PROBE_NOWILDCARD &&
2134 !(child->flags & DF_FIXEDCLASS)) {
2139 * The driver returned an error so it
2140 * certainly doesn't match.
2143 (void)device_set_driver(child, NULL);
2148 * A priority lower than SUCCESS, remember the
2149 * best matching driver. Initialise the value
2150 * of pri for the first match.
2152 if (best == NULL || result > pri) {
2159 * If we have an unambiguous match in this devclass,
2160 * don't look in the parent.
2162 if (best && pri == 0)
2167 * If we found a driver, change state and initialise the devclass.
2169 /* XXX What happens if we rebid and got no best? */
2172 * If this device was attached, and we were asked to
2173 * rescan, and it is a different driver, then we have
2174 * to detach the old driver and reattach this new one.
2175 * Note, we don't have to check for DF_REBID here
2176 * because if the state is > DS_ALIVE, we know it must
2179 * This assumes that all DF_REBID drivers can have
2180 * their probe routine called at any time and that
2181 * they are idempotent as well as completely benign in
2182 * normal operations.
2184 * We also have to make sure that the detach
2185 * succeeded, otherwise we fail the operation (or
2186 * maybe it should just fail silently? I'm torn).
2188 if (child->state > DS_ALIVE && best->driver != child->driver)
2189 if ((result = device_detach(dev)) != 0)
2192 /* Set the winning driver, devclass, and flags. */
2193 if (!child->devclass) {
2194 result = device_set_devclass(child, best->driver->name);
2198 result = device_set_driver(child, best->driver);
2201 resource_int_value(best->driver->name, child->unit,
2202 "flags", &child->devflags);
2206 * A bit bogus. Call the probe method again to make
2207 * sure that we have the right description.
2209 DEVICE_PROBE(child);
2211 child->flags |= DF_REBID;
2214 child->flags &= ~DF_REBID;
2215 child->state = DS_ALIVE;
2217 bus_data_generation_update();
2225 * @brief Return the parent of a device
2228 device_get_parent(device_t dev)
2230 return (dev->parent);
2234 * @brief Get a list of children of a device
2236 * An array containing a list of all the children of the given device
2237 * is allocated and returned in @p *devlistp. The number of devices
2238 * in the array is returned in @p *devcountp. The caller should free
2239 * the array using @c free(p, M_TEMP).
2241 * @param dev the device to examine
2242 * @param devlistp points at location for array pointer return
2244 * @param devcountp points at location for array size return value
2247 * @retval ENOMEM the array allocation failed
2250 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2257 TAILQ_FOREACH(child, &dev->children, link) {
2266 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2271 TAILQ_FOREACH(child, &dev->children, link) {
2272 list[count] = child;
2283 * @brief Return the current driver for the device or @c NULL if there
2284 * is no driver currently attached
2287 device_get_driver(device_t dev)
2289 return (dev->driver);
2293 * @brief Return the current devclass for the device or @c NULL if
2297 device_get_devclass(device_t dev)
2299 return (dev->devclass);
2303 * @brief Return the name of the device's devclass or @c NULL if there
2307 device_get_name(device_t dev)
2309 if (dev != NULL && dev->devclass)
2310 return (devclass_get_name(dev->devclass));
2315 * @brief Return a string containing the device's devclass name
2316 * followed by an ascii representation of the device's unit number
2320 device_get_nameunit(device_t dev)
2322 return (dev->nameunit);
2326 * @brief Return the device's unit number.
2329 device_get_unit(device_t dev)
2335 * @brief Return the device's description string
2338 device_get_desc(device_t dev)
2344 * @brief Return the device's flags
2347 device_get_flags(device_t dev)
2349 return (dev->devflags);
2352 struct sysctl_ctx_list *
2353 device_get_sysctl_ctx(device_t dev)
2355 return (&dev->sysctl_ctx);
2359 device_get_sysctl_tree(device_t dev)
2361 return (dev->sysctl_tree);
2365 * @brief Print the name of the device followed by a colon and a space
2367 * @returns the number of characters printed
2370 device_print_prettyname(device_t dev)
2372 const char *name = device_get_name(dev);
2375 return (printf("unknown: "));
2376 return (printf("%s%d: ", name, device_get_unit(dev)));
2380 * @brief Print the name of the device followed by a colon, a space
2381 * and the result of calling vprintf() with the value of @p fmt and
2382 * the following arguments.
2384 * @returns the number of characters printed
2387 device_printf(device_t dev, const char * fmt, ...)
2397 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2398 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2400 name = device_get_name(dev);
2403 sbuf_cat(&sb, "unknown: ");
2405 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2408 sbuf_vprintf(&sb, fmt, ap);
2421 device_set_desc_internal(device_t dev, const char* desc, int copy)
2423 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2424 free(dev->desc, M_BUS);
2425 dev->flags &= ~DF_DESCMALLOCED;
2430 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2432 strcpy(dev->desc, desc);
2433 dev->flags |= DF_DESCMALLOCED;
2436 /* Avoid a -Wcast-qual warning */
2437 dev->desc = (char *)(uintptr_t) desc;
2440 bus_data_generation_update();
2444 * @brief Set the device's description
2446 * The value of @c desc should be a string constant that will not
2447 * change (at least until the description is changed in a subsequent
2448 * call to device_set_desc() or device_set_desc_copy()).
2451 device_set_desc(device_t dev, const char* desc)
2453 device_set_desc_internal(dev, desc, FALSE);
2457 * @brief Set the device's description
2459 * The string pointed to by @c desc is copied. Use this function if
2460 * the device description is generated, (e.g. with sprintf()).
2463 device_set_desc_copy(device_t dev, const char* desc)
2465 device_set_desc_internal(dev, desc, TRUE);
2469 * @brief Set the device's flags
2472 device_set_flags(device_t dev, uint32_t flags)
2474 dev->devflags = flags;
2478 * @brief Return the device's softc field
2480 * The softc is allocated and zeroed when a driver is attached, based
2481 * on the size field of the driver.
2484 device_get_softc(device_t dev)
2486 return (dev->softc);
2490 * @brief Set the device's softc field
2492 * Most drivers do not need to use this since the softc is allocated
2493 * automatically when the driver is attached.
2496 device_set_softc(device_t dev, void *softc)
2498 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2499 free(dev->softc, M_BUS_SC);
2502 dev->flags |= DF_EXTERNALSOFTC;
2504 dev->flags &= ~DF_EXTERNALSOFTC;
2508 * @brief Free claimed softc
2510 * Most drivers do not need to use this since the softc is freed
2511 * automatically when the driver is detached.
2514 device_free_softc(void *softc)
2516 free(softc, M_BUS_SC);
2520 * @brief Claim softc
2522 * This function can be used to let the driver free the automatically
2523 * allocated softc using "device_free_softc()". This function is
2524 * useful when the driver is refcounting the softc and the softc
2525 * cannot be freed when the "device_detach" method is called.
2528 device_claim_softc(device_t dev)
2531 dev->flags |= DF_EXTERNALSOFTC;
2533 dev->flags &= ~DF_EXTERNALSOFTC;
2537 * @brief Get the device's ivars field
2539 * The ivars field is used by the parent device to store per-device
2540 * state (e.g. the physical location of the device or a list of
2544 device_get_ivars(device_t dev)
2546 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2547 return (dev->ivars);
2551 * @brief Set the device's ivars field
2554 device_set_ivars(device_t dev, void * ivars)
2556 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2561 * @brief Return the device's state
2564 device_get_state(device_t dev)
2566 return (dev->state);
2570 * @brief Set the DF_ENABLED flag for the device
2573 device_enable(device_t dev)
2575 dev->flags |= DF_ENABLED;
2579 * @brief Clear the DF_ENABLED flag for the device
2582 device_disable(device_t dev)
2584 dev->flags &= ~DF_ENABLED;
2588 * @brief Increment the busy counter for the device
2591 device_busy(device_t dev)
2593 if (dev->state < DS_ATTACHING)
2594 panic("device_busy: called for unattached device");
2595 if (dev->busy == 0 && dev->parent)
2596 device_busy(dev->parent);
2598 if (dev->state == DS_ATTACHED)
2599 dev->state = DS_BUSY;
2603 * @brief Decrement the busy counter for the device
2606 device_unbusy(device_t dev)
2608 if (dev->busy != 0 && dev->state != DS_BUSY &&
2609 dev->state != DS_ATTACHING)
2610 panic("device_unbusy: called for non-busy device %s",
2611 device_get_nameunit(dev));
2613 if (dev->busy == 0) {
2615 device_unbusy(dev->parent);
2616 if (dev->state == DS_BUSY)
2617 dev->state = DS_ATTACHED;
2622 * @brief Set the DF_QUIET flag for the device
2625 device_quiet(device_t dev)
2627 dev->flags |= DF_QUIET;
2631 * @brief Set the DF_QUIET_CHILDREN flag for the device
2634 device_quiet_children(device_t dev)
2636 dev->flags |= DF_QUIET_CHILDREN;
2640 * @brief Clear the DF_QUIET flag for the device
2643 device_verbose(device_t dev)
2645 dev->flags &= ~DF_QUIET;
2649 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2652 device_has_quiet_children(device_t dev)
2654 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2658 * @brief Return non-zero if the DF_QUIET flag is set on the device
2661 device_is_quiet(device_t dev)
2663 return ((dev->flags & DF_QUIET) != 0);
2667 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2670 device_is_enabled(device_t dev)
2672 return ((dev->flags & DF_ENABLED) != 0);
2676 * @brief Return non-zero if the device was successfully probed
2679 device_is_alive(device_t dev)
2681 return (dev->state >= DS_ALIVE);
2685 * @brief Return non-zero if the device currently has a driver
2689 device_is_attached(device_t dev)
2691 return (dev->state >= DS_ATTACHED);
2695 * @brief Return non-zero if the device is currently suspended.
2698 device_is_suspended(device_t dev)
2700 return ((dev->flags & DF_SUSPENDED) != 0);
2704 * @brief Set the devclass of a device
2705 * @see devclass_add_device().
2708 device_set_devclass(device_t dev, const char *classname)
2715 devclass_delete_device(dev->devclass, dev);
2719 if (dev->devclass) {
2720 printf("device_set_devclass: device class already set\n");
2724 dc = devclass_find_internal(classname, NULL, TRUE);
2728 error = devclass_add_device(dc, dev);
2730 bus_data_generation_update();
2735 * @brief Set the devclass of a device and mark the devclass fixed.
2736 * @see device_set_devclass()
2739 device_set_devclass_fixed(device_t dev, const char *classname)
2743 if (classname == NULL)
2746 error = device_set_devclass(dev, classname);
2749 dev->flags |= DF_FIXEDCLASS;
2754 * @brief Query the device to determine if it's of a fixed devclass
2755 * @see device_set_devclass_fixed()
2758 device_is_devclass_fixed(device_t dev)
2760 return ((dev->flags & DF_FIXEDCLASS) != 0);
2764 * @brief Set the driver of a device
2767 * @retval EBUSY the device already has a driver attached
2768 * @retval ENOMEM a memory allocation failure occurred
2771 device_set_driver(device_t dev, driver_t *driver)
2774 struct domainset *policy;
2776 if (dev->state >= DS_ATTACHED)
2779 if (dev->driver == driver)
2782 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2783 free(dev->softc, M_BUS_SC);
2786 device_set_desc(dev, NULL);
2787 kobj_delete((kobj_t) dev, NULL);
2788 dev->driver = driver;
2790 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2791 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2792 if (bus_get_domain(dev, &domain) == 0)
2793 policy = DOMAINSET_PREF(domain);
2795 policy = DOMAINSET_RR();
2796 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2797 policy, M_NOWAIT | M_ZERO);
2799 kobj_delete((kobj_t) dev, NULL);
2800 kobj_init((kobj_t) dev, &null_class);
2806 kobj_init((kobj_t) dev, &null_class);
2809 bus_data_generation_update();
2814 * @brief Probe a device, and return this status.
2816 * This function is the core of the device autoconfiguration
2817 * system. Its purpose is to select a suitable driver for a device and
2818 * then call that driver to initialise the hardware appropriately. The
2819 * driver is selected by calling the DEVICE_PROBE() method of a set of
2820 * candidate drivers and then choosing the driver which returned the
2821 * best value. This driver is then attached to the device using
2824 * The set of suitable drivers is taken from the list of drivers in
2825 * the parent device's devclass. If the device was originally created
2826 * with a specific class name (see device_add_child()), only drivers
2827 * with that name are probed, otherwise all drivers in the devclass
2828 * are probed. If no drivers return successful probe values in the
2829 * parent devclass, the search continues in the parent of that
2830 * devclass (see devclass_get_parent()) if any.
2832 * @param dev the device to initialise
2835 * @retval ENXIO no driver was found
2836 * @retval ENOMEM memory allocation failure
2837 * @retval non-zero some other unix error code
2838 * @retval -1 Device already attached
2841 device_probe(device_t dev)
2847 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2850 if (!(dev->flags & DF_ENABLED)) {
2851 if (bootverbose && device_get_name(dev) != NULL) {
2852 device_print_prettyname(dev);
2853 printf("not probed (disabled)\n");
2857 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2858 if (bus_current_pass == BUS_PASS_DEFAULT &&
2859 !(dev->flags & DF_DONENOMATCH)) {
2860 BUS_PROBE_NOMATCH(dev->parent, dev);
2862 dev->flags |= DF_DONENOMATCH;
2870 * @brief Probe a device and attach a driver if possible
2872 * calls device_probe() and attaches if that was successful.
2875 device_probe_and_attach(device_t dev)
2881 error = device_probe(dev);
2884 else if (error != 0)
2887 CURVNET_SET_QUIET(vnet0);
2888 error = device_attach(dev);
2894 * @brief Attach a device driver to a device
2896 * This function is a wrapper around the DEVICE_ATTACH() driver
2897 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2898 * device's sysctl tree, optionally prints a description of the device
2899 * and queues a notification event for user-based device management
2902 * Normally this function is only called internally from
2903 * device_probe_and_attach().
2905 * @param dev the device to initialise
2908 * @retval ENXIO no driver was found
2909 * @retval ENOMEM memory allocation failure
2910 * @retval non-zero some other unix error code
2913 device_attach(device_t dev)
2915 uint64_t attachtime;
2916 uint16_t attachentropy;
2919 if (resource_disabled(dev->driver->name, dev->unit)) {
2920 device_disable(dev);
2922 device_printf(dev, "disabled via hints entry\n");
2926 device_sysctl_init(dev);
2927 if (!device_is_quiet(dev))
2928 device_print_child(dev->parent, dev);
2929 attachtime = get_cyclecount();
2930 dev->state = DS_ATTACHING;
2931 if ((error = DEVICE_ATTACH(dev)) != 0) {
2932 printf("device_attach: %s%d attach returned %d\n",
2933 dev->driver->name, dev->unit, error);
2934 if (!(dev->flags & DF_FIXEDCLASS))
2935 devclass_delete_device(dev->devclass, dev);
2936 (void)device_set_driver(dev, NULL);
2937 device_sysctl_fini(dev);
2938 KASSERT(dev->busy == 0, ("attach failed but busy"));
2939 dev->state = DS_NOTPRESENT;
2942 dev->flags |= DF_ATTACHED_ONCE;
2943 /* We only need the low bits of this time, but ranges from tens to thousands
2944 * have been seen, so keep 2 bytes' worth.
2946 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2947 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2948 device_sysctl_update(dev);
2950 dev->state = DS_BUSY;
2952 dev->state = DS_ATTACHED;
2953 dev->flags &= ~DF_DONENOMATCH;
2954 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2960 * @brief Detach a driver from a device
2962 * This function is a wrapper around the DEVICE_DETACH() driver
2963 * method. If the call to DEVICE_DETACH() succeeds, it calls
2964 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2965 * notification event for user-based device management services and
2966 * cleans up the device's sysctl tree.
2968 * @param dev the device to un-initialise
2971 * @retval ENXIO no driver was found
2972 * @retval ENOMEM memory allocation failure
2973 * @retval non-zero some other unix error code
2976 device_detach(device_t dev)
2982 PDEBUG(("%s", DEVICENAME(dev)));
2983 if (dev->state == DS_BUSY)
2985 if (dev->state == DS_ATTACHING) {
2986 device_printf(dev, "device in attaching state! Deferring detach.\n");
2989 if (dev->state != DS_ATTACHED)
2992 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2993 if ((error = DEVICE_DETACH(dev)) != 0) {
2994 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2995 EVHDEV_DETACH_FAILED);
2998 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2999 EVHDEV_DETACH_COMPLETE);
3002 if (!device_is_quiet(dev))
3003 device_printf(dev, "detached\n");
3005 BUS_CHILD_DETACHED(dev->parent, dev);
3007 if (!(dev->flags & DF_FIXEDCLASS))
3008 devclass_delete_device(dev->devclass, dev);
3010 device_verbose(dev);
3011 dev->state = DS_NOTPRESENT;
3012 (void)device_set_driver(dev, NULL);
3013 device_sysctl_fini(dev);
3019 * @brief Tells a driver to quiesce itself.
3021 * This function is a wrapper around the DEVICE_QUIESCE() driver
3022 * method. If the call to DEVICE_QUIESCE() succeeds.
3024 * @param dev the device to quiesce
3027 * @retval ENXIO no driver was found
3028 * @retval ENOMEM memory allocation failure
3029 * @retval non-zero some other unix error code
3032 device_quiesce(device_t dev)
3034 PDEBUG(("%s", DEVICENAME(dev)));
3035 if (dev->state == DS_BUSY)
3037 if (dev->state != DS_ATTACHED)
3040 return (DEVICE_QUIESCE(dev));
3044 * @brief Notify a device of system shutdown
3046 * This function calls the DEVICE_SHUTDOWN() driver method if the
3047 * device currently has an attached driver.
3049 * @returns the value returned by DEVICE_SHUTDOWN()
3052 device_shutdown(device_t dev)
3054 if (dev->state < DS_ATTACHED)
3056 return (DEVICE_SHUTDOWN(dev));
3060 * @brief Set the unit number of a device
3062 * This function can be used to override the unit number used for a
3063 * device (e.g. to wire a device to a pre-configured unit number).
3066 device_set_unit(device_t dev, int unit)
3071 dc = device_get_devclass(dev);
3072 if (unit < dc->maxunit && dc->devices[unit])
3074 err = devclass_delete_device(dc, dev);
3078 err = devclass_add_device(dc, dev);
3082 bus_data_generation_update();
3086 /*======================================*/
3088 * Some useful method implementations to make life easier for bus drivers.
3092 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3096 args->memattr = VM_MEMATTR_UNCACHEABLE;
3100 * @brief Initialise a resource list.
3102 * @param rl the resource list to initialise
3105 resource_list_init(struct resource_list *rl)
3111 * @brief Reclaim memory used by a resource list.
3113 * This function frees the memory for all resource entries on the list
3116 * @param rl the resource list to free
3119 resource_list_free(struct resource_list *rl)
3121 struct resource_list_entry *rle;
3123 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3125 panic("resource_list_free: resource entry is busy");
3126 STAILQ_REMOVE_HEAD(rl, link);
3132 * @brief Add a resource entry.
3134 * This function adds a resource entry using the given @p type, @p
3135 * start, @p end and @p count values. A rid value is chosen by
3136 * searching sequentially for the first unused rid starting at zero.
3138 * @param rl the resource list to edit
3139 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3140 * @param start the start address of the resource
3141 * @param end the end address of the resource
3142 * @param count XXX end-start+1
3145 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3146 rman_res_t end, rman_res_t count)
3151 while (resource_list_find(rl, type, rid) != NULL)
3153 resource_list_add(rl, type, rid, start, end, count);
3158 * @brief Add or modify a resource entry.
3160 * If an existing entry exists with the same type and rid, it will be
3161 * modified using the given values of @p start, @p end and @p
3162 * count. If no entry exists, a new one will be created using the
3163 * given values. The resource list entry that matches is then returned.
3165 * @param rl the resource list to edit
3166 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3167 * @param rid the resource identifier
3168 * @param start the start address of the resource
3169 * @param end the end address of the resource
3170 * @param count XXX end-start+1
3172 struct resource_list_entry *
3173 resource_list_add(struct resource_list *rl, int type, int rid,
3174 rman_res_t start, rman_res_t end, rman_res_t count)
3176 struct resource_list_entry *rle;
3178 rle = resource_list_find(rl, type, rid);
3180 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3183 panic("resource_list_add: can't record entry");
3184 STAILQ_INSERT_TAIL(rl, rle, link);
3192 panic("resource_list_add: resource entry is busy");
3201 * @brief Determine if a resource entry is busy.
3203 * Returns true if a resource entry is busy meaning that it has an
3204 * associated resource that is not an unallocated "reserved" resource.
3206 * @param rl the resource list to search
3207 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3208 * @param rid the resource identifier
3210 * @returns Non-zero if the entry is busy, zero otherwise.
3213 resource_list_busy(struct resource_list *rl, int type, int rid)
3215 struct resource_list_entry *rle;
3217 rle = resource_list_find(rl, type, rid);
3218 if (rle == NULL || rle->res == NULL)
3220 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3221 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3222 ("reserved resource is active"));
3229 * @brief Determine if a resource entry is reserved.
3231 * Returns true if a resource entry is reserved meaning that it has an
3232 * associated "reserved" resource. The resource can either be
3233 * allocated or unallocated.
3235 * @param rl the resource list to search
3236 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3237 * @param rid the resource identifier
3239 * @returns Non-zero if the entry is reserved, zero otherwise.
3242 resource_list_reserved(struct resource_list *rl, int type, int rid)
3244 struct resource_list_entry *rle;
3246 rle = resource_list_find(rl, type, rid);
3247 if (rle != NULL && rle->flags & RLE_RESERVED)
3253 * @brief Find a resource entry by type and rid.
3255 * @param rl the resource list to search
3256 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3257 * @param rid the resource identifier
3259 * @returns the resource entry pointer or NULL if there is no such
3262 struct resource_list_entry *
3263 resource_list_find(struct resource_list *rl, int type, int rid)
3265 struct resource_list_entry *rle;
3267 STAILQ_FOREACH(rle, rl, link) {
3268 if (rle->type == type && rle->rid == rid)
3275 * @brief Delete a resource entry.
3277 * @param rl the resource list to edit
3278 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3279 * @param rid the resource identifier
3282 resource_list_delete(struct resource_list *rl, int type, int rid)
3284 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3287 if (rle->res != NULL)
3288 panic("resource_list_delete: resource has not been released");
3289 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3295 * @brief Allocate a reserved resource
3297 * This can be used by buses to force the allocation of resources
3298 * that are always active in the system even if they are not allocated
3299 * by a driver (e.g. PCI BARs). This function is usually called when
3300 * adding a new child to the bus. The resource is allocated from the
3301 * parent bus when it is reserved. The resource list entry is marked
3302 * with RLE_RESERVED to note that it is a reserved resource.
3304 * Subsequent attempts to allocate the resource with
3305 * resource_list_alloc() will succeed the first time and will set
3306 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3307 * resource that has been allocated is released with
3308 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3309 * the actual resource remains allocated. The resource can be released to
3310 * the parent bus by calling resource_list_unreserve().
3312 * @param rl the resource list to allocate from
3313 * @param bus the parent device of @p child
3314 * @param child the device for which the resource is being reserved
3315 * @param type the type of resource to allocate
3316 * @param rid a pointer to the resource identifier
3317 * @param start hint at the start of the resource range - pass
3318 * @c 0 for any start address
3319 * @param end hint at the end of the resource range - pass
3320 * @c ~0 for any end address
3321 * @param count hint at the size of range required - pass @c 1
3323 * @param flags any extra flags to control the resource
3324 * allocation - see @c RF_XXX flags in
3325 * <sys/rman.h> for details
3327 * @returns the resource which was allocated or @c NULL if no
3328 * resource could be allocated
3331 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3332 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3334 struct resource_list_entry *rle = NULL;
3335 int passthrough = (device_get_parent(child) != bus);
3340 "resource_list_reserve() should only be called for direct children");
3341 if (flags & RF_ACTIVE)
3343 "resource_list_reserve() should only reserve inactive resources");
3345 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3348 rle = resource_list_find(rl, type, *rid);
3349 rle->flags |= RLE_RESERVED;
3355 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3357 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3358 * and passing the allocation up to the parent of @p bus. This assumes
3359 * that the first entry of @c device_get_ivars(child) is a struct
3360 * resource_list. This also handles 'passthrough' allocations where a
3361 * child is a remote descendant of bus by passing the allocation up to
3362 * the parent of bus.
3364 * Typically, a bus driver would store a list of child resources
3365 * somewhere in the child device's ivars (see device_get_ivars()) and
3366 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3367 * then call resource_list_alloc() to perform the allocation.
3369 * @param rl the resource list to allocate from
3370 * @param bus the parent device of @p child
3371 * @param child the device which is requesting an allocation
3372 * @param type the type of resource to allocate
3373 * @param rid a pointer to the resource identifier
3374 * @param start hint at the start of the resource range - pass
3375 * @c 0 for any start address
3376 * @param end hint at the end of the resource range - pass
3377 * @c ~0 for any end address
3378 * @param count hint at the size of range required - pass @c 1
3380 * @param flags any extra flags to control the resource
3381 * allocation - see @c RF_XXX flags in
3382 * <sys/rman.h> for details
3384 * @returns the resource which was allocated or @c NULL if no
3385 * resource could be allocated
3388 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3389 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3391 struct resource_list_entry *rle = NULL;
3392 int passthrough = (device_get_parent(child) != bus);
3393 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3396 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3397 type, rid, start, end, count, flags));
3400 rle = resource_list_find(rl, type, *rid);
3403 return (NULL); /* no resource of that type/rid */
3406 if (rle->flags & RLE_RESERVED) {
3407 if (rle->flags & RLE_ALLOCATED)
3409 if ((flags & RF_ACTIVE) &&
3410 bus_activate_resource(child, type, *rid,
3413 rle->flags |= RLE_ALLOCATED;
3417 "resource entry %#x type %d for child %s is busy\n", *rid,
3418 type, device_get_nameunit(child));
3424 count = ulmax(count, rle->count);
3425 end = ulmax(rle->end, start + count - 1);
3428 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3429 type, rid, start, end, count, flags);
3432 * Record the new range.
3435 rle->start = rman_get_start(rle->res);
3436 rle->end = rman_get_end(rle->res);
3444 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3446 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3447 * used with resource_list_alloc().
3449 * @param rl the resource list which was allocated from
3450 * @param bus the parent device of @p child
3451 * @param child the device which is requesting a release
3452 * @param type the type of resource to release
3453 * @param rid the resource identifier
3454 * @param res the resource to release
3457 * @retval non-zero a standard unix error code indicating what
3458 * error condition prevented the operation
3461 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3462 int type, int rid, struct resource *res)
3464 struct resource_list_entry *rle = NULL;
3465 int passthrough = (device_get_parent(child) != bus);
3469 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3473 rle = resource_list_find(rl, type, rid);
3476 panic("resource_list_release: can't find resource");
3478 panic("resource_list_release: resource entry is not busy");
3479 if (rle->flags & RLE_RESERVED) {
3480 if (rle->flags & RLE_ALLOCATED) {
3481 if (rman_get_flags(res) & RF_ACTIVE) {
3482 error = bus_deactivate_resource(child, type,
3487 rle->flags &= ~RLE_ALLOCATED;
3493 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3503 * @brief Release all active resources of a given type
3505 * Release all active resources of a specified type. This is intended
3506 * to be used to cleanup resources leaked by a driver after detach or
3509 * @param rl the resource list which was allocated from
3510 * @param bus the parent device of @p child
3511 * @param child the device whose active resources are being released
3512 * @param type the type of resources to release
3515 * @retval EBUSY at least one resource was active
3518 resource_list_release_active(struct resource_list *rl, device_t bus,
3519 device_t child, int type)
3521 struct resource_list_entry *rle;
3525 STAILQ_FOREACH(rle, rl, link) {
3526 if (rle->type != type)
3528 if (rle->res == NULL)
3530 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3534 error = resource_list_release(rl, bus, child, type,
3535 rman_get_rid(rle->res), rle->res);
3538 "Failed to release active resource: %d\n", error);
3544 * @brief Fully release a reserved resource
3546 * Fully releases a resource reserved via resource_list_reserve().
3548 * @param rl the resource list which was allocated from
3549 * @param bus the parent device of @p child
3550 * @param child the device whose reserved resource is being released
3551 * @param type the type of resource to release
3552 * @param rid the resource identifier
3553 * @param res the resource to release
3556 * @retval non-zero a standard unix error code indicating what
3557 * error condition prevented the operation
3560 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3563 struct resource_list_entry *rle = NULL;
3564 int passthrough = (device_get_parent(child) != bus);
3568 "resource_list_unreserve() should only be called for direct children");
3570 rle = resource_list_find(rl, type, rid);
3573 panic("resource_list_unreserve: can't find resource");
3574 if (!(rle->flags & RLE_RESERVED))
3576 if (rle->flags & RLE_ALLOCATED)
3578 rle->flags &= ~RLE_RESERVED;
3579 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3583 * @brief Print a description of resources in a resource list
3585 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3586 * The name is printed if at least one resource of the given type is available.
3587 * The format is used to print resource start and end.
3589 * @param rl the resource list to print
3590 * @param name the name of @p type, e.g. @c "memory"
3591 * @param type type type of resource entry to print
3592 * @param format printf(9) format string to print resource
3593 * start and end values
3595 * @returns the number of characters printed
3598 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3601 struct resource_list_entry *rle;
3602 int printed, retval;
3606 /* Yes, this is kinda cheating */
3607 STAILQ_FOREACH(rle, rl, link) {
3608 if (rle->type == type) {
3610 retval += printf(" %s ", name);
3612 retval += printf(",");
3614 retval += printf(format, rle->start);
3615 if (rle->count > 1) {
3616 retval += printf("-");
3617 retval += printf(format, rle->start +
3626 * @brief Releases all the resources in a list.
3628 * @param rl The resource list to purge.
3633 resource_list_purge(struct resource_list *rl)
3635 struct resource_list_entry *rle;
3637 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3639 bus_release_resource(rman_get_device(rle->res),
3640 rle->type, rle->rid, rle->res);
3641 STAILQ_REMOVE_HEAD(rl, link);
3647 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3649 return (device_add_child_ordered(dev, order, name, unit));
3653 * @brief Helper function for implementing DEVICE_PROBE()
3655 * This function can be used to help implement the DEVICE_PROBE() for
3656 * a bus (i.e. a device which has other devices attached to it). It
3657 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3661 bus_generic_probe(device_t dev)
3663 devclass_t dc = dev->devclass;
3666 TAILQ_FOREACH(dl, &dc->drivers, link) {
3668 * If this driver's pass is too high, then ignore it.
3669 * For most drivers in the default pass, this will
3670 * never be true. For early-pass drivers they will
3671 * only call the identify routines of eligible drivers
3672 * when this routine is called. Drivers for later
3673 * passes should have their identify routines called
3674 * on early-pass buses during BUS_NEW_PASS().
3676 if (dl->pass > bus_current_pass)
3678 DEVICE_IDENTIFY(dl->driver, dev);
3685 * @brief Helper function for implementing DEVICE_ATTACH()
3687 * This function can be used to help implement the DEVICE_ATTACH() for
3688 * a bus. It calls device_probe_and_attach() for each of the device's
3692 bus_generic_attach(device_t dev)
3696 TAILQ_FOREACH(child, &dev->children, link) {
3697 device_probe_and_attach(child);
3704 * @brief Helper function for delaying attaching children
3706 * Many buses can't run transactions on the bus which children need to probe and
3707 * attach until after interrupts and/or timers are running. This function
3708 * delays their attach until interrupts and timers are enabled.
3711 bus_delayed_attach_children(device_t dev)
3713 /* Probe and attach the bus children when interrupts are available */
3714 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3720 * @brief Helper function for implementing DEVICE_DETACH()
3722 * This function can be used to help implement the DEVICE_DETACH() for
3723 * a bus. It calls device_detach() for each of the device's
3727 bus_generic_detach(device_t dev)
3732 if (dev->state != DS_ATTACHED)
3736 * Detach children in the reverse order.
3737 * See bus_generic_suspend for details.
3739 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3740 if ((error = device_detach(child)) != 0)
3748 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3750 * This function can be used to help implement the DEVICE_SHUTDOWN()
3751 * for a bus. It calls device_shutdown() for each of the device's
3755 bus_generic_shutdown(device_t dev)
3760 * Shut down children in the reverse order.
3761 * See bus_generic_suspend for details.
3763 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3764 device_shutdown(child);
3771 * @brief Default function for suspending a child device.
3773 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3776 bus_generic_suspend_child(device_t dev, device_t child)
3780 error = DEVICE_SUSPEND(child);
3783 child->flags |= DF_SUSPENDED;
3789 * @brief Default function for resuming a child device.
3791 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3794 bus_generic_resume_child(device_t dev, device_t child)
3796 DEVICE_RESUME(child);
3797 child->flags &= ~DF_SUSPENDED;
3803 * @brief Helper function for implementing DEVICE_SUSPEND()
3805 * This function can be used to help implement the DEVICE_SUSPEND()
3806 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3807 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3808 * operation is aborted and any devices which were suspended are
3809 * resumed immediately by calling their DEVICE_RESUME() methods.
3812 bus_generic_suspend(device_t dev)
3818 * Suspend children in the reverse order.
3819 * For most buses all children are equal, so the order does not matter.
3820 * Other buses, such as acpi, carefully order their child devices to
3821 * express implicit dependencies between them. For such buses it is
3822 * safer to bring down devices in the reverse order.
3824 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3825 error = BUS_SUSPEND_CHILD(dev, child);
3827 child = TAILQ_NEXT(child, link);
3828 if (child != NULL) {
3829 TAILQ_FOREACH_FROM(child, &dev->children, link)
3830 BUS_RESUME_CHILD(dev, child);
3839 * @brief Helper function for implementing DEVICE_RESUME()
3841 * This function can be used to help implement the DEVICE_RESUME() for
3842 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3845 bus_generic_resume(device_t dev)
3849 TAILQ_FOREACH(child, &dev->children, link) {
3850 BUS_RESUME_CHILD(dev, child);
3851 /* if resume fails, there's nothing we can usefully do... */
3857 * @brief Helper function for implementing BUS_RESET_POST
3859 * Bus can use this function to implement common operations of
3860 * re-attaching or resuming the children after the bus itself was
3861 * reset, and after restoring bus-unique state of children.
3863 * @param dev The bus
3864 * #param flags DEVF_RESET_*
3867 bus_helper_reset_post(device_t dev, int flags)
3873 TAILQ_FOREACH(child, &dev->children,link) {
3874 BUS_RESET_POST(dev, child);
3875 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3876 device_probe_and_attach(child) :
3877 BUS_RESUME_CHILD(dev, child);
3878 if (error == 0 && error1 != 0)
3885 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3887 child = TAILQ_NEXT(child, link);
3890 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3891 BUS_RESET_POST(dev, child);
3892 if ((flags & DEVF_RESET_DETACH) != 0)
3893 device_probe_and_attach(child);
3895 BUS_RESUME_CHILD(dev, child);
3900 * @brief Helper function for implementing BUS_RESET_PREPARE
3902 * Bus can use this function to implement common operations of
3903 * detaching or suspending the children before the bus itself is
3904 * reset, and then save bus-unique state of children that must
3905 * persists around reset.
3907 * @param dev The bus
3908 * #param flags DEVF_RESET_*
3911 bus_helper_reset_prepare(device_t dev, int flags)
3916 if (dev->state != DS_ATTACHED)
3919 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3920 if ((flags & DEVF_RESET_DETACH) != 0) {
3921 error = device_get_state(child) == DS_ATTACHED ?
3922 device_detach(child) : 0;
3924 error = BUS_SUSPEND_CHILD(dev, child);
3927 error = BUS_RESET_PREPARE(dev, child);
3929 if ((flags & DEVF_RESET_DETACH) != 0)
3930 device_probe_and_attach(child);
3932 BUS_RESUME_CHILD(dev, child);
3936 bus_helper_reset_prepare_rollback(dev, child, flags);
3944 * @brief Helper function for implementing BUS_PRINT_CHILD().
3946 * This function prints the first part of the ascii representation of
3947 * @p child, including its name, unit and description (if any - see
3948 * device_set_desc()).
3950 * @returns the number of characters printed
3953 bus_print_child_header(device_t dev, device_t child)
3957 if (device_get_desc(child)) {
3958 retval += device_printf(child, "<%s>", device_get_desc(child));
3960 retval += printf("%s", device_get_nameunit(child));
3967 * @brief Helper function for implementing BUS_PRINT_CHILD().
3969 * This function prints the last part of the ascii representation of
3970 * @p child, which consists of the string @c " on " followed by the
3971 * name and unit of the @p dev.
3973 * @returns the number of characters printed
3976 bus_print_child_footer(device_t dev, device_t child)
3978 return (printf(" on %s\n", device_get_nameunit(dev)));
3982 * @brief Helper function for implementing BUS_PRINT_CHILD().
3984 * This function prints out the VM domain for the given device.
3986 * @returns the number of characters printed
3989 bus_print_child_domain(device_t dev, device_t child)
3993 /* No domain? Don't print anything */
3994 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3997 return (printf(" numa-domain %d", domain));
4001 * @brief Helper function for implementing BUS_PRINT_CHILD().
4003 * This function simply calls bus_print_child_header() followed by
4004 * bus_print_child_footer().
4006 * @returns the number of characters printed
4009 bus_generic_print_child(device_t dev, device_t child)
4013 retval += bus_print_child_header(dev, child);
4014 retval += bus_print_child_domain(dev, child);
4015 retval += bus_print_child_footer(dev, child);
4021 * @brief Stub function for implementing BUS_READ_IVAR().
4026 bus_generic_read_ivar(device_t dev, device_t child, int index,
4033 * @brief Stub function for implementing BUS_WRITE_IVAR().
4038 bus_generic_write_ivar(device_t dev, device_t child, int index,
4045 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4049 struct resource_list *
4050 bus_generic_get_resource_list(device_t dev, device_t child)
4056 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4058 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4059 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4060 * and then calls device_probe_and_attach() for each unattached child.
4063 bus_generic_driver_added(device_t dev, driver_t *driver)
4067 DEVICE_IDENTIFY(driver, dev);
4068 TAILQ_FOREACH(child, &dev->children, link) {
4069 if (child->state == DS_NOTPRESENT ||
4070 (child->flags & DF_REBID))
4071 device_probe_and_attach(child);
4076 * @brief Helper function for implementing BUS_NEW_PASS().
4078 * This implementing of BUS_NEW_PASS() first calls the identify
4079 * routines for any drivers that probe at the current pass. Then it
4080 * walks the list of devices for this bus. If a device is already
4081 * attached, then it calls BUS_NEW_PASS() on that device. If the
4082 * device is not already attached, it attempts to attach a driver to
4086 bus_generic_new_pass(device_t dev)
4093 TAILQ_FOREACH(dl, &dc->drivers, link) {
4094 if (dl->pass == bus_current_pass)
4095 DEVICE_IDENTIFY(dl->driver, dev);
4097 TAILQ_FOREACH(child, &dev->children, link) {
4098 if (child->state >= DS_ATTACHED)
4099 BUS_NEW_PASS(child);
4100 else if (child->state == DS_NOTPRESENT)
4101 device_probe_and_attach(child);
4106 * @brief Helper function for implementing BUS_SETUP_INTR().
4108 * This simple implementation of BUS_SETUP_INTR() simply calls the
4109 * BUS_SETUP_INTR() method of the parent of @p dev.
4112 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4113 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4116 /* Propagate up the bus hierarchy until someone handles it. */
4118 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4119 filter, intr, arg, cookiep));
4124 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4126 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4127 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4130 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4133 /* Propagate up the bus hierarchy until someone handles it. */
4135 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4140 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4142 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4143 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4146 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4148 /* Propagate up the bus hierarchy until someone handles it. */
4150 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4155 * @brief Helper function for implementing BUS_RESUME_INTR().
4157 * This simple implementation of BUS_RESUME_INTR() simply calls the
4158 * BUS_RESUME_INTR() method of the parent of @p dev.
4161 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4163 /* Propagate up the bus hierarchy until someone handles it. */
4165 return (BUS_RESUME_INTR(dev->parent, child, irq));
4170 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4172 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4173 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4176 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4177 struct resource *r, rman_res_t start, rman_res_t end)
4179 /* Propagate up the bus hierarchy until someone handles it. */
4181 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4187 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4189 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4190 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4193 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4194 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4196 /* Propagate up the bus hierarchy until someone handles it. */
4198 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4199 start, end, count, flags));
4204 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4206 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4207 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4210 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4213 /* Propagate up the bus hierarchy until someone handles it. */
4215 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4221 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4223 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4224 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4227 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4230 /* Propagate up the bus hierarchy until someone handles it. */
4232 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4238 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4240 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4241 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4244 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4245 int rid, struct resource *r)
4247 /* Propagate up the bus hierarchy until someone handles it. */
4249 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4255 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4257 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4258 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4261 bus_generic_map_resource(device_t dev, device_t child, int type,
4262 struct resource *r, struct resource_map_request *args,
4263 struct resource_map *map)
4265 /* Propagate up the bus hierarchy until someone handles it. */
4267 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4273 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4275 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4276 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4279 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4280 struct resource *r, struct resource_map *map)
4282 /* Propagate up the bus hierarchy until someone handles it. */
4284 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4289 * @brief Helper function for implementing BUS_BIND_INTR().
4291 * This simple implementation of BUS_BIND_INTR() simply calls the
4292 * BUS_BIND_INTR() method of the parent of @p dev.
4295 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4298 /* Propagate up the bus hierarchy until someone handles it. */
4300 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4305 * @brief Helper function for implementing BUS_CONFIG_INTR().
4307 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4308 * BUS_CONFIG_INTR() method of the parent of @p dev.
4311 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4312 enum intr_polarity pol)
4314 /* Propagate up the bus hierarchy until someone handles it. */
4316 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4321 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4323 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4324 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4327 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4328 void *cookie, const char *descr)
4330 /* Propagate up the bus hierarchy until someone handles it. */
4332 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4338 * @brief Helper function for implementing BUS_GET_CPUS().
4340 * This simple implementation of BUS_GET_CPUS() simply calls the
4341 * BUS_GET_CPUS() method of the parent of @p dev.
4344 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4345 size_t setsize, cpuset_t *cpuset)
4347 /* Propagate up the bus hierarchy until someone handles it. */
4348 if (dev->parent != NULL)
4349 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4354 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4356 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4357 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4360 bus_generic_get_dma_tag(device_t dev, device_t child)
4362 /* Propagate up the bus hierarchy until someone handles it. */
4363 if (dev->parent != NULL)
4364 return (BUS_GET_DMA_TAG(dev->parent, child));
4369 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4371 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4372 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4375 bus_generic_get_bus_tag(device_t dev, device_t child)
4377 /* Propagate up the bus hierarchy until someone handles it. */
4378 if (dev->parent != NULL)
4379 return (BUS_GET_BUS_TAG(dev->parent, child));
4380 return ((bus_space_tag_t)0);
4384 * @brief Helper function for implementing BUS_GET_RESOURCE().
4386 * This implementation of BUS_GET_RESOURCE() uses the
4387 * resource_list_find() function to do most of the work. It calls
4388 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4392 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4393 rman_res_t *startp, rman_res_t *countp)
4395 struct resource_list * rl = NULL;
4396 struct resource_list_entry * rle = NULL;
4398 rl = BUS_GET_RESOURCE_LIST(dev, child);
4402 rle = resource_list_find(rl, type, rid);
4407 *startp = rle->start;
4409 *countp = rle->count;
4415 * @brief Helper function for implementing BUS_SET_RESOURCE().
4417 * This implementation of BUS_SET_RESOURCE() uses the
4418 * resource_list_add() function to do most of the work. It calls
4419 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4423 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4424 rman_res_t start, rman_res_t count)
4426 struct resource_list * rl = NULL;
4428 rl = BUS_GET_RESOURCE_LIST(dev, child);
4432 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4438 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4440 * This implementation of BUS_DELETE_RESOURCE() uses the
4441 * resource_list_delete() function to do most of the work. It calls
4442 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4446 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4448 struct resource_list * rl = NULL;
4450 rl = BUS_GET_RESOURCE_LIST(dev, child);
4454 resource_list_delete(rl, type, rid);
4460 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4462 * This implementation of BUS_RELEASE_RESOURCE() uses the
4463 * resource_list_release() function to do most of the work. It calls
4464 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4467 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4468 int rid, struct resource *r)
4470 struct resource_list * rl = NULL;
4472 if (device_get_parent(child) != dev)
4473 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4476 rl = BUS_GET_RESOURCE_LIST(dev, child);
4480 return (resource_list_release(rl, dev, child, type, rid, r));
4484 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4486 * This implementation of BUS_ALLOC_RESOURCE() uses the
4487 * resource_list_alloc() function to do most of the work. It calls
4488 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4491 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4492 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4494 struct resource_list * rl = NULL;
4496 if (device_get_parent(child) != dev)
4497 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4498 type, rid, start, end, count, flags));
4500 rl = BUS_GET_RESOURCE_LIST(dev, child);
4504 return (resource_list_alloc(rl, dev, child, type, rid,
4505 start, end, count, flags));
4509 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4511 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4512 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4515 bus_generic_child_present(device_t dev, device_t child)
4517 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4521 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4524 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4530 * @brief Helper function for implementing BUS_RESCAN().
4532 * This null implementation of BUS_RESCAN() always fails to indicate
4533 * the bus does not support rescanning.
4536 bus_null_rescan(device_t dev)
4542 * Some convenience functions to make it easier for drivers to use the
4543 * resource-management functions. All these really do is hide the
4544 * indirection through the parent's method table, making for slightly
4545 * less-wordy code. In the future, it might make sense for this code
4546 * to maintain some sort of a list of resources allocated by each device.
4550 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4551 struct resource **res)
4555 for (i = 0; rs[i].type != -1; i++)
4557 for (i = 0; rs[i].type != -1; i++) {
4558 res[i] = bus_alloc_resource_any(dev,
4559 rs[i].type, &rs[i].rid, rs[i].flags);
4560 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4561 bus_release_resources(dev, rs, res);
4569 bus_release_resources(device_t dev, const struct resource_spec *rs,
4570 struct resource **res)
4574 for (i = 0; rs[i].type != -1; i++)
4575 if (res[i] != NULL) {
4576 bus_release_resource(
4577 dev, rs[i].type, rs[i].rid, res[i]);
4583 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4585 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4589 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4590 rman_res_t end, rman_res_t count, u_int flags)
4592 struct resource *res;
4594 if (dev->parent == NULL)
4596 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4602 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4604 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4608 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4611 if (dev->parent == NULL)
4613 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4617 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4619 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4623 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4625 if (dev->parent == NULL)
4627 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4631 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4633 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4637 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4639 if (dev->parent == NULL)
4641 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4645 * @brief Wrapper function for BUS_MAP_RESOURCE().
4647 * This function simply calls the BUS_MAP_RESOURCE() method of the
4651 bus_map_resource(device_t dev, int type, struct resource *r,
4652 struct resource_map_request *args, struct resource_map *map)
4654 if (dev->parent == NULL)
4656 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4660 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4662 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4666 bus_unmap_resource(device_t dev, int type, struct resource *r,
4667 struct resource_map *map)
4669 if (dev->parent == NULL)
4671 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4675 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4677 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4681 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4685 if (dev->parent == NULL)
4687 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4692 * @brief Wrapper function for BUS_SETUP_INTR().
4694 * This function simply calls the BUS_SETUP_INTR() method of the
4698 bus_setup_intr(device_t dev, struct resource *r, int flags,
4699 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4703 if (dev->parent == NULL)
4705 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4709 if (handler != NULL && !(flags & INTR_MPSAFE))
4710 device_printf(dev, "[GIANT-LOCKED]\n");
4715 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4717 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4721 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4723 if (dev->parent == NULL)
4725 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4729 * @brief Wrapper function for BUS_SUSPEND_INTR().
4731 * This function simply calls the BUS_SUSPEND_INTR() method of the
4735 bus_suspend_intr(device_t dev, struct resource *r)
4737 if (dev->parent == NULL)
4739 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4743 * @brief Wrapper function for BUS_RESUME_INTR().
4745 * This function simply calls the BUS_RESUME_INTR() method of the
4749 bus_resume_intr(device_t dev, struct resource *r)
4751 if (dev->parent == NULL)
4753 return (BUS_RESUME_INTR(dev->parent, dev, r));
4757 * @brief Wrapper function for BUS_BIND_INTR().
4759 * This function simply calls the BUS_BIND_INTR() method of the
4763 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4765 if (dev->parent == NULL)
4767 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4771 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4773 * This function first formats the requested description into a
4774 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4775 * the parent of @p dev.
4778 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4779 const char *fmt, ...)
4782 char descr[MAXCOMLEN + 1];
4784 if (dev->parent == NULL)
4787 vsnprintf(descr, sizeof(descr), fmt, ap);
4789 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4793 * @brief Wrapper function for BUS_SET_RESOURCE().
4795 * This function simply calls the BUS_SET_RESOURCE() method of the
4799 bus_set_resource(device_t dev, int type, int rid,
4800 rman_res_t start, rman_res_t count)
4802 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4807 * @brief Wrapper function for BUS_GET_RESOURCE().
4809 * This function simply calls the BUS_GET_RESOURCE() method of the
4813 bus_get_resource(device_t dev, int type, int rid,
4814 rman_res_t *startp, rman_res_t *countp)
4816 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4821 * @brief Wrapper function for BUS_GET_RESOURCE().
4823 * This function simply calls the BUS_GET_RESOURCE() method of the
4824 * parent of @p dev and returns the start value.
4827 bus_get_resource_start(device_t dev, int type, int rid)
4833 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4841 * @brief Wrapper function for BUS_GET_RESOURCE().
4843 * This function simply calls the BUS_GET_RESOURCE() method of the
4844 * parent of @p dev and returns the count value.
4847 bus_get_resource_count(device_t dev, int type, int rid)
4853 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4861 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4863 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4867 bus_delete_resource(device_t dev, int type, int rid)
4869 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4873 * @brief Wrapper function for BUS_CHILD_PRESENT().
4875 * This function simply calls the BUS_CHILD_PRESENT() method of the
4879 bus_child_present(device_t child)
4881 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4885 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4887 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4891 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4895 parent = device_get_parent(child);
4896 if (parent == NULL) {
4900 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4904 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4906 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4910 bus_child_location_str(device_t child, char *buf, size_t buflen)
4914 parent = device_get_parent(child);
4915 if (parent == NULL) {
4919 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4923 * @brief Wrapper function for BUS_GET_CPUS().
4925 * This function simply calls the BUS_GET_CPUS() method of the
4929 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4933 parent = device_get_parent(dev);
4936 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4940 * @brief Wrapper function for BUS_GET_DMA_TAG().
4942 * This function simply calls the BUS_GET_DMA_TAG() method of the
4946 bus_get_dma_tag(device_t dev)
4950 parent = device_get_parent(dev);
4953 return (BUS_GET_DMA_TAG(parent, dev));
4957 * @brief Wrapper function for BUS_GET_BUS_TAG().
4959 * This function simply calls the BUS_GET_BUS_TAG() method of the
4963 bus_get_bus_tag(device_t dev)
4967 parent = device_get_parent(dev);
4969 return ((bus_space_tag_t)0);
4970 return (BUS_GET_BUS_TAG(parent, dev));
4974 * @brief Wrapper function for BUS_GET_DOMAIN().
4976 * This function simply calls the BUS_GET_DOMAIN() method of the
4980 bus_get_domain(device_t dev, int *domain)
4982 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4985 /* Resume all devices and then notify userland that we're up again. */
4987 root_resume(device_t dev)
4991 error = bus_generic_resume(dev);
4993 devctl_notify("kern", "power", "resume", NULL);
4998 root_print_child(device_t dev, device_t child)
5002 retval += bus_print_child_header(dev, child);
5003 retval += printf("\n");
5009 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5010 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5013 * If an interrupt mapping gets to here something bad has happened.
5015 panic("root_setup_intr");
5019 * If we get here, assume that the device is permanent and really is
5020 * present in the system. Removable bus drivers are expected to intercept
5021 * this call long before it gets here. We return -1 so that drivers that
5022 * really care can check vs -1 or some ERRNO returned higher in the food
5026 root_child_present(device_t dev, device_t child)
5032 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5037 /* Default to returning the set of all CPUs. */
5038 if (setsize != sizeof(cpuset_t))
5047 static kobj_method_t root_methods[] = {
5048 /* Device interface */
5049 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5050 KOBJMETHOD(device_suspend, bus_generic_suspend),
5051 KOBJMETHOD(device_resume, root_resume),
5054 KOBJMETHOD(bus_print_child, root_print_child),
5055 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5056 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5057 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5058 KOBJMETHOD(bus_child_present, root_child_present),
5059 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5064 static driver_t root_driver = {
5071 devclass_t root_devclass;
5074 root_bus_module_handler(module_t mod, int what, void* arg)
5078 TAILQ_INIT(&bus_data_devices);
5079 kobj_class_compile((kobj_class_t) &root_driver);
5080 root_bus = make_device(NULL, "root", 0);
5081 root_bus->desc = "System root bus";
5082 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5083 root_bus->driver = &root_driver;
5084 root_bus->state = DS_ATTACHED;
5085 root_devclass = devclass_find_internal("root", NULL, FALSE);
5090 device_shutdown(root_bus);
5093 return (EOPNOTSUPP);
5099 static moduledata_t root_bus_mod = {
5101 root_bus_module_handler,
5104 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5107 * @brief Automatically configure devices
5109 * This function begins the autoconfiguration process by calling
5110 * device_probe_and_attach() for each child of the @c root0 device.
5113 root_bus_configure(void)
5117 /* Eventually this will be split up, but this is sufficient for now. */
5118 bus_set_pass(BUS_PASS_DEFAULT);
5122 * @brief Module handler for registering device drivers
5124 * This module handler is used to automatically register device
5125 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5126 * devclass_add_driver() for the driver described by the
5127 * driver_module_data structure pointed to by @p arg
5130 driver_module_handler(module_t mod, int what, void *arg)
5132 struct driver_module_data *dmd;
5133 devclass_t bus_devclass;
5134 kobj_class_t driver;
5137 dmd = (struct driver_module_data *)arg;
5138 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5143 if (dmd->dmd_chainevh)
5144 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5146 pass = dmd->dmd_pass;
5147 driver = dmd->dmd_driver;
5148 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5149 DRIVERNAME(driver), dmd->dmd_busname, pass));
5150 error = devclass_add_driver(bus_devclass, driver, pass,
5155 PDEBUG(("Unloading module: driver %s from bus %s",
5156 DRIVERNAME(dmd->dmd_driver),
5158 error = devclass_delete_driver(bus_devclass,
5161 if (!error && dmd->dmd_chainevh)
5162 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5165 PDEBUG(("Quiesce module: driver %s from bus %s",
5166 DRIVERNAME(dmd->dmd_driver),
5168 error = devclass_quiesce_driver(bus_devclass,
5171 if (!error && dmd->dmd_chainevh)
5172 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5183 * @brief Enumerate all hinted devices for this bus.
5185 * Walks through the hints for this bus and calls the bus_hinted_child
5186 * routine for each one it fines. It searches first for the specific
5187 * bus that's being probed for hinted children (eg isa0), and then for
5188 * generic children (eg isa).
5190 * @param dev bus device to enumerate
5193 bus_enumerate_hinted_children(device_t bus)
5196 const char *dname, *busname;
5200 * enumerate all devices on the specific bus
5202 busname = device_get_nameunit(bus);
5204 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5205 BUS_HINTED_CHILD(bus, dname, dunit);
5208 * and all the generic ones.
5210 busname = device_get_name(bus);
5212 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5213 BUS_HINTED_CHILD(bus, dname, dunit);
5218 /* the _short versions avoid iteration by not calling anything that prints
5219 * more than oneliners. I love oneliners.
5223 print_device_short(device_t dev, int indent)
5228 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5229 dev->unit, dev->desc,
5230 (dev->parent? "":"no "),
5231 (TAILQ_EMPTY(&dev->children)? "no ":""),
5232 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5233 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5234 (dev->flags&DF_WILDCARD? "wildcard,":""),
5235 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5236 (dev->flags&DF_REBID? "rebiddable,":""),
5237 (dev->flags&DF_SUSPENDED? "suspended,":""),
5238 (dev->ivars? "":"no "),
5239 (dev->softc? "":"no "),
5244 print_device(device_t dev, int indent)
5249 print_device_short(dev, indent);
5251 indentprintf(("Parent:\n"));
5252 print_device_short(dev->parent, indent+1);
5253 indentprintf(("Driver:\n"));
5254 print_driver_short(dev->driver, indent+1);
5255 indentprintf(("Devclass:\n"));
5256 print_devclass_short(dev->devclass, indent+1);
5260 print_device_tree_short(device_t dev, int indent)
5261 /* print the device and all its children (indented) */
5268 print_device_short(dev, indent);
5270 TAILQ_FOREACH(child, &dev->children, link) {
5271 print_device_tree_short(child, indent+1);
5276 print_device_tree(device_t dev, int indent)
5277 /* print the device and all its children (indented) */
5284 print_device(dev, indent);
5286 TAILQ_FOREACH(child, &dev->children, link) {
5287 print_device_tree(child, indent+1);
5292 print_driver_short(driver_t *driver, int indent)
5297 indentprintf(("driver %s: softc size = %zd\n",
5298 driver->name, driver->size));
5302 print_driver(driver_t *driver, int indent)
5307 print_driver_short(driver, indent);
5311 print_driver_list(driver_list_t drivers, int indent)
5313 driverlink_t driver;
5315 TAILQ_FOREACH(driver, &drivers, link) {
5316 print_driver(driver->driver, indent);
5321 print_devclass_short(devclass_t dc, int indent)
5326 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5330 print_devclass(devclass_t dc, int indent)
5337 print_devclass_short(dc, indent);
5338 indentprintf(("Drivers:\n"));
5339 print_driver_list(dc->drivers, indent+1);
5341 indentprintf(("Devices:\n"));
5342 for (i = 0; i < dc->maxunit; i++)
5344 print_device(dc->devices[i], indent+1);
5348 print_devclass_list_short(void)
5352 printf("Short listing of devclasses, drivers & devices:\n");
5353 TAILQ_FOREACH(dc, &devclasses, link) {
5354 print_devclass_short(dc, 0);
5359 print_devclass_list(void)
5363 printf("Full listing of devclasses, drivers & devices:\n");
5364 TAILQ_FOREACH(dc, &devclasses, link) {
5365 print_devclass(dc, 0);
5372 * User-space access to the device tree.
5374 * We implement a small set of nodes:
5376 * hw.bus Single integer read method to obtain the
5377 * current generation count.
5378 * hw.bus.devices Reads the entire device tree in flat space.
5379 * hw.bus.rman Resource manager interface
5381 * We might like to add the ability to scan devclasses and/or drivers to
5382 * determine what else is currently loaded/available.
5386 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5388 struct u_businfo ubus;
5390 ubus.ub_version = BUS_USER_VERSION;
5391 ubus.ub_generation = bus_data_generation;
5393 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5395 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5396 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5397 "bus-related data");
5400 sysctl_devices(SYSCTL_HANDLER_ARGS)
5402 int *name = (int *)arg1;
5403 u_int namelen = arg2;
5406 struct u_device *udev;
5413 if (bus_data_generation_check(name[0]))
5419 * Scan the list of devices, looking for the requested index.
5421 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5429 * Populate the return item, careful not to overflow the buffer.
5431 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5434 udev->dv_handle = (uintptr_t)dev;
5435 udev->dv_parent = (uintptr_t)dev->parent;
5436 udev->dv_devflags = dev->devflags;
5437 udev->dv_flags = dev->flags;
5438 udev->dv_state = dev->state;
5439 walker = udev->dv_fields;
5440 ep = walker + sizeof(udev->dv_fields);
5442 if ((src) == NULL) \
5445 strlcpy(walker, (src), ep - walker); \
5446 walker += strlen(walker) + 1; \
5454 CP(dev->driver != NULL ? dev->driver->name : NULL);
5455 bus_child_pnpinfo_str(dev, walker, ep - walker);
5456 walker += strlen(walker) + 1;
5459 bus_child_location_str(dev, walker, ep - walker);
5460 walker += strlen(walker) + 1;
5466 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5471 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5472 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5473 "system device tree");
5476 bus_data_generation_check(int generation)
5478 if (generation != bus_data_generation)
5481 /* XXX generate optimised lists here? */
5486 bus_data_generation_update(void)
5488 atomic_add_int(&bus_data_generation, 1);
5492 bus_free_resource(device_t dev, int type, struct resource *r)
5496 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5500 device_lookup_by_name(const char *name)
5504 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5505 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5512 * /dev/devctl2 implementation. The existing /dev/devctl device has
5513 * implicit semantics on open, so it could not be reused for this.
5514 * Another option would be to call this /dev/bus?
5517 find_device(struct devreq *req, device_t *devp)
5522 * First, ensure that the name is nul terminated.
5524 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5528 * Second, try to find an attached device whose name matches
5531 dev = device_lookup_by_name(req->dr_name);
5537 /* Finally, give device enumerators a chance. */
5539 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5547 driver_exists(device_t bus, const char *driver)
5551 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5552 if (devclass_find_driver_internal(dc, driver) != NULL)
5559 device_gen_nomatch(device_t dev)
5563 if (dev->flags & DF_NEEDNOMATCH &&
5564 dev->state == DS_NOTPRESENT) {
5565 BUS_PROBE_NOMATCH(dev->parent, dev);
5567 dev->flags |= DF_DONENOMATCH;
5569 dev->flags &= ~DF_NEEDNOMATCH;
5570 TAILQ_FOREACH(child, &dev->children, link) {
5571 device_gen_nomatch(child);
5576 device_do_deferred_actions(void)
5582 * Walk through the devclasses to find all the drivers we've tagged as
5583 * deferred during the freeze and call the driver added routines. They
5584 * have already been added to the lists in the background, so the driver
5585 * added routines that trigger a probe will have all the right bidders
5586 * for the probe auction.
5588 TAILQ_FOREACH(dc, &devclasses, link) {
5589 TAILQ_FOREACH(dl, &dc->drivers, link) {
5590 if (dl->flags & DL_DEFERRED_PROBE) {
5591 devclass_driver_added(dc, dl->driver);
5592 dl->flags &= ~DL_DEFERRED_PROBE;
5598 * We also defer no-match events during a freeze. Walk the tree and
5599 * generate all the pent-up events that are still relevant.
5601 device_gen_nomatch(root_bus);
5602 bus_data_generation_update();
5606 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5613 /* Locate the device to control. */
5615 req = (struct devreq *)data;
5623 case DEV_SET_DRIVER:
5624 case DEV_CLEAR_DRIVER:
5628 error = priv_check(td, PRIV_DRIVER);
5630 error = find_device(req, &dev);
5634 error = priv_check(td, PRIV_DRIVER);
5645 /* Perform the requested operation. */
5648 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5650 else if (!device_is_enabled(dev))
5653 error = device_probe_and_attach(dev);
5656 if (!device_is_attached(dev)) {
5660 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5661 error = device_quiesce(dev);
5665 error = device_detach(dev);
5668 if (device_is_enabled(dev)) {
5674 * If the device has been probed but not attached (e.g.
5675 * when it has been disabled by a loader hint), just
5676 * attach the device rather than doing a full probe.
5679 if (device_is_alive(dev)) {
5681 * If the device was disabled via a hint, clear
5684 if (resource_disabled(dev->driver->name, dev->unit))
5685 resource_unset_value(dev->driver->name,
5686 dev->unit, "disabled");
5687 error = device_attach(dev);
5689 error = device_probe_and_attach(dev);
5692 if (!device_is_enabled(dev)) {
5697 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5698 error = device_quiesce(dev);
5704 * Force DF_FIXEDCLASS on around detach to preserve
5705 * the existing name.
5708 dev->flags |= DF_FIXEDCLASS;
5709 error = device_detach(dev);
5710 if (!(old & DF_FIXEDCLASS))
5711 dev->flags &= ~DF_FIXEDCLASS;
5713 device_disable(dev);
5716 if (device_is_suspended(dev)) {
5720 if (device_get_parent(dev) == NULL) {
5724 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5727 if (!device_is_suspended(dev)) {
5731 if (device_get_parent(dev) == NULL) {
5735 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5737 case DEV_SET_DRIVER: {
5741 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5744 if (driver[0] == '\0') {
5748 if (dev->devclass != NULL &&
5749 strcmp(driver, dev->devclass->name) == 0)
5750 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5754 * Scan drivers for this device's bus looking for at
5755 * least one matching driver.
5757 if (dev->parent == NULL) {
5761 if (!driver_exists(dev->parent, driver)) {
5765 dc = devclass_create(driver);
5771 /* Detach device if necessary. */
5772 if (device_is_attached(dev)) {
5773 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5774 error = device_detach(dev);
5781 /* Clear any previously-fixed device class and unit. */
5782 if (dev->flags & DF_FIXEDCLASS)
5783 devclass_delete_device(dev->devclass, dev);
5784 dev->flags |= DF_WILDCARD;
5787 /* Force the new device class. */
5788 error = devclass_add_device(dc, dev);
5791 dev->flags |= DF_FIXEDCLASS;
5792 error = device_probe_and_attach(dev);
5795 case DEV_CLEAR_DRIVER:
5796 if (!(dev->flags & DF_FIXEDCLASS)) {
5800 if (device_is_attached(dev)) {
5801 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5802 error = device_detach(dev);
5809 dev->flags &= ~DF_FIXEDCLASS;
5810 dev->flags |= DF_WILDCARD;
5811 devclass_delete_device(dev->devclass, dev);
5812 error = device_probe_and_attach(dev);
5815 if (!device_is_attached(dev)) {
5819 error = BUS_RESCAN(dev);
5824 parent = device_get_parent(dev);
5825 if (parent == NULL) {
5829 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5830 if (bus_child_present(dev) != 0) {
5836 error = device_delete_child(parent, dev);
5843 device_frozen = true;
5849 device_do_deferred_actions();
5850 device_frozen = false;
5854 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5858 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5866 static struct cdevsw devctl2_cdevsw = {
5867 .d_version = D_VERSION,
5868 .d_ioctl = devctl2_ioctl,
5869 .d_name = "devctl2",
5875 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5876 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5880 * APIs to manage deprecation and obsolescence.
5882 static int obsolete_panic = 0;
5883 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5884 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5885 "2 = if deprecated)");
5888 gone_panic(int major, int running, const char *msg)
5890 switch (obsolete_panic)
5895 if (running < major)
5904 _gone_in(int major, const char *msg)
5906 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5907 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5908 printf("Obsolete code will be removed soon: %s\n", msg);
5910 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5915 _gone_in_dev(device_t dev, int major, const char *msg)
5917 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5918 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5920 "Obsolete code will be removed soon: %s\n", msg);
5923 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5928 DB_SHOW_COMMAND(device, db_show_device)
5935 dev = (device_t)addr;
5937 db_printf("name: %s\n", device_get_nameunit(dev));
5938 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5939 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5940 db_printf(" addr: %p\n", dev);
5941 db_printf(" parent: %p\n", dev->parent);
5942 db_printf(" softc: %p\n", dev->softc);
5943 db_printf(" ivars: %p\n", dev->ivars);
5946 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5950 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5951 db_show_device((db_expr_t)dev, true, count, modif);