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
398 STAILQ_ENTRY(dev_event_info) dei_link;
401 STAILQ_HEAD(devq, dev_event_info);
403 static struct dev_softc
416 static void filt_devctl_detach(struct knote *kn);
417 static int filt_devctl_read(struct knote *kn, long hint);
419 struct filterops devctl_rfiltops = {
421 .f_detach = filt_devctl_detach,
422 .f_event = filt_devctl_read,
425 static struct cdev *devctl_dev;
430 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
431 UID_ROOT, GID_WHEEL, 0600, "devctl");
432 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
433 cv_init(&devsoftc.cv, "dev cv");
434 STAILQ_INIT(&devsoftc.devq);
435 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
440 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
442 mtx_lock(&devsoftc.mtx);
443 if (devsoftc.inuse) {
444 mtx_unlock(&devsoftc.mtx);
449 mtx_unlock(&devsoftc.mtx);
454 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
456 mtx_lock(&devsoftc.mtx);
458 devsoftc.nonblock = 0;
460 cv_broadcast(&devsoftc.cv);
461 funsetown(&devsoftc.sigio);
462 mtx_unlock(&devsoftc.mtx);
467 * The read channel for this device is used to report changes to
468 * userland in realtime. We are required to free the data as well as
469 * the n1 object because we allocate them separately. Also note that
470 * we return one record at a time. If you try to read this device a
471 * character at a time, you will lose the rest of the data. Listening
472 * programs are expected to cope.
475 devread(struct cdev *dev, struct uio *uio, int ioflag)
477 struct dev_event_info *n1;
480 mtx_lock(&devsoftc.mtx);
481 while (STAILQ_EMPTY(&devsoftc.devq)) {
482 if (devsoftc.nonblock) {
483 mtx_unlock(&devsoftc.mtx);
486 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
489 * Need to translate ERESTART to EINTR here? -- jake
491 mtx_unlock(&devsoftc.mtx);
495 n1 = STAILQ_FIRST(&devsoftc.devq);
496 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
498 mtx_unlock(&devsoftc.mtx);
499 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
500 free(n1->dei_data, M_BUS);
506 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
511 devsoftc.nonblock = 1;
513 devsoftc.nonblock = 0;
522 return fsetown(*(int *)data, &devsoftc.sigio);
524 *(int *)data = fgetown(&devsoftc.sigio);
527 /* (un)Support for other fcntl() calls. */
538 devpoll(struct cdev *dev, int events, struct thread *td)
542 mtx_lock(&devsoftc.mtx);
543 if (events & (POLLIN | POLLRDNORM)) {
544 if (!STAILQ_EMPTY(&devsoftc.devq))
545 revents = events & (POLLIN | POLLRDNORM);
547 selrecord(td, &devsoftc.sel);
549 mtx_unlock(&devsoftc.mtx);
555 devkqfilter(struct cdev *dev, struct knote *kn)
559 if (kn->kn_filter == EVFILT_READ) {
560 kn->kn_fop = &devctl_rfiltops;
561 knlist_add(&devsoftc.sel.si_note, kn, 0);
569 filt_devctl_detach(struct knote *kn)
571 knlist_remove(&devsoftc.sel.si_note, kn, 0);
575 filt_devctl_read(struct knote *kn, long hint)
577 kn->kn_data = devsoftc.queued;
578 return (kn->kn_data != 0);
582 * @brief Return whether the userland process is running
585 devctl_process_running(void)
587 return (devsoftc.inuse == 1);
591 * @brief Queue data to be read from the devctl device
593 * Generic interface to queue data to the devctl device. It is
594 * assumed that @p data is properly formatted. It is further assumed
595 * that @p data is allocated using the M_BUS malloc type.
598 devctl_queue_data_f(char *data, int flags)
600 struct dev_event_info *n1 = NULL, *n2 = NULL;
602 if (strlen(data) == 0)
604 if (devctl_queue_length == 0)
606 n1 = malloc(sizeof(*n1), M_BUS, flags);
610 mtx_lock(&devsoftc.mtx);
611 if (devctl_queue_length == 0) {
612 mtx_unlock(&devsoftc.mtx);
613 free(n1->dei_data, M_BUS);
617 /* Leave at least one spot in the queue... */
618 while (devsoftc.queued > devctl_queue_length - 1) {
619 n2 = STAILQ_FIRST(&devsoftc.devq);
620 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
621 free(n2->dei_data, M_BUS);
625 STAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
627 cv_broadcast(&devsoftc.cv);
628 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
629 mtx_unlock(&devsoftc.mtx);
630 selwakeup(&devsoftc.sel);
631 if (devsoftc.async && devsoftc.sigio != NULL)
632 pgsigio(&devsoftc.sigio, SIGIO, 0);
636 * We have to free data on all error paths since the caller
637 * assumes it will be free'd when this item is dequeued.
644 devctl_queue_data(char *data)
646 devctl_queue_data_f(data, M_NOWAIT);
650 * @brief Send a 'notification' to userland, using standard ways
653 devctl_notify_f(const char *system, const char *subsystem, const char *type,
654 const char *data, int flags)
660 return; /* BOGUS! Must specify system. */
661 if (subsystem == NULL)
662 return; /* BOGUS! Must specify subsystem. */
664 return; /* BOGUS! Must specify type. */
665 len += strlen(" system=") + strlen(system);
666 len += strlen(" subsystem=") + strlen(subsystem);
667 len += strlen(" type=") + strlen(type);
668 /* add in the data message plus newline. */
671 len += 3; /* '!', '\n', and NUL */
672 msg = malloc(len, M_BUS, flags);
674 return; /* Drop it on the floor */
676 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
677 system, subsystem, type, data);
679 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
680 system, subsystem, type);
681 devctl_queue_data_f(msg, flags);
685 devctl_notify(const char *system, const char *subsystem, const char *type,
688 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
692 * Common routine that tries to make sending messages as easy as possible.
693 * We allocate memory for the data, copy strings into that, but do not
694 * free it unless there's an error. The dequeue part of the driver should
695 * free the data. We don't send data when the device is disabled. We do
696 * send data, even when we have no listeners, because we wish to avoid
697 * races relating to startup and restart of listening applications.
699 * devaddq is designed to string together the type of event, with the
700 * object of that event, plus the plug and play info and location info
701 * for that event. This is likely most useful for devices, but less
702 * useful for other consumers of this interface. Those should use
703 * the devctl_queue_data() interface instead.
706 devaddq(const char *type, const char *what, device_t dev)
713 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
715 data = malloc(1024, M_BUS, M_NOWAIT);
719 /* get the bus specific location of this device */
720 loc = malloc(1024, M_BUS, M_NOWAIT);
724 bus_child_location_str(dev, loc, 1024);
726 /* Get the bus specific pnp info of this device */
727 pnp = malloc(1024, M_BUS, M_NOWAIT);
731 bus_child_pnpinfo_str(dev, pnp, 1024);
733 /* Get the parent of this device, or / if high enough in the tree. */
734 if (device_get_parent(dev) == NULL)
735 parstr = "."; /* Or '/' ? */
737 parstr = device_get_nameunit(device_get_parent(dev));
738 /* String it all together. */
739 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
743 devctl_queue_data(data);
753 * A device was added to the tree. We are called just after it successfully
754 * attaches (that is, probe and attach success for this device). No call
755 * is made if a device is merely parented into the tree. See devnomatch
756 * if probe fails. If attach fails, no notification is sent (but maybe
757 * we should have a different message for this).
760 devadded(device_t dev)
762 devaddq("+", device_get_nameunit(dev), dev);
766 * A device was removed from the tree. We are called just before this
770 devremoved(device_t dev)
772 devaddq("-", device_get_nameunit(dev), dev);
776 * Called when there's no match for this device. This is only called
777 * the first time that no match happens, so we don't keep getting this
778 * message. Should that prove to be undesirable, we can change it.
779 * This is called when all drivers that can attach to a given bus
780 * decline to accept this device. Other errors may not be detected.
783 devnomatch(device_t dev)
785 devaddq("?", "", dev);
789 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
791 struct dev_event_info *n1;
794 q = devctl_queue_length;
795 error = sysctl_handle_int(oidp, &q, 0, req);
796 if (error || !req->newptr)
800 if (mtx_initialized(&devsoftc.mtx))
801 mtx_lock(&devsoftc.mtx);
802 devctl_queue_length = q;
803 while (devsoftc.queued > devctl_queue_length) {
804 n1 = STAILQ_FIRST(&devsoftc.devq);
805 STAILQ_REMOVE_HEAD(&devsoftc.devq, dei_link);
806 free(n1->dei_data, M_BUS);
810 if (mtx_initialized(&devsoftc.mtx))
811 mtx_unlock(&devsoftc.mtx);
816 * @brief safely quotes strings that might have double quotes in them.
818 * The devctl protocol relies on quoted strings having matching quotes.
819 * This routine quotes any internal quotes so the resulting string
820 * is safe to pass to snprintf to construct, for example pnp info strings.
822 * @param sb sbuf to place the characters into
823 * @param src Original buffer.
826 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
828 while (*src != '\0') {
829 if (*src == '"' || *src == '\\')
831 sbuf_putc(sb, *src++);
835 /* End of /dev/devctl code */
837 static TAILQ_HEAD(,device) bus_data_devices;
838 static int bus_data_generation = 1;
840 static kobj_method_t null_methods[] = {
844 DEFINE_CLASS(null, null_methods, 0);
847 * Bus pass implementation
850 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
851 int bus_current_pass = BUS_PASS_ROOT;
855 * @brief Register the pass level of a new driver attachment
857 * Register a new driver attachment's pass level. If no driver
858 * attachment with the same pass level has been added, then @p new
859 * will be added to the global passes list.
861 * @param new the new driver attachment
864 driver_register_pass(struct driverlink *new)
866 struct driverlink *dl;
868 /* We only consider pass numbers during boot. */
869 if (bus_current_pass == BUS_PASS_DEFAULT)
873 * Walk the passes list. If we already know about this pass
874 * then there is nothing to do. If we don't, then insert this
875 * driver link into the list.
877 TAILQ_FOREACH(dl, &passes, passlink) {
878 if (dl->pass < new->pass)
880 if (dl->pass == new->pass)
882 TAILQ_INSERT_BEFORE(dl, new, passlink);
885 TAILQ_INSERT_TAIL(&passes, new, passlink);
889 * @brief Raise the current bus pass
891 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
892 * method on the root bus to kick off a new device tree scan for each
893 * new pass level that has at least one driver.
896 bus_set_pass(int pass)
898 struct driverlink *dl;
900 if (bus_current_pass > pass)
901 panic("Attempt to lower bus pass level");
903 TAILQ_FOREACH(dl, &passes, passlink) {
904 /* Skip pass values below the current pass level. */
905 if (dl->pass <= bus_current_pass)
909 * Bail once we hit a driver with a pass level that is
916 * Raise the pass level to the next level and rescan
919 bus_current_pass = dl->pass;
920 BUS_NEW_PASS(root_bus);
924 * If there isn't a driver registered for the requested pass,
925 * then bus_current_pass might still be less than 'pass'. Set
926 * it to 'pass' in that case.
928 if (bus_current_pass < pass)
929 bus_current_pass = pass;
930 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
934 * Devclass implementation
937 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
941 * @brief Find or create a device class
943 * If a device class with the name @p classname exists, return it,
944 * otherwise if @p create is non-zero create and return a new device
947 * If @p parentname is non-NULL, the parent of the devclass is set to
948 * the devclass of that name.
950 * @param classname the devclass name to find or create
951 * @param parentname the parent devclass name or @c NULL
952 * @param create non-zero to create a devclass
955 devclass_find_internal(const char *classname, const char *parentname,
960 PDEBUG(("looking for %s", classname));
964 TAILQ_FOREACH(dc, &devclasses, link) {
965 if (!strcmp(dc->name, classname))
970 PDEBUG(("creating %s", classname));
971 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
972 M_BUS, M_NOWAIT | M_ZERO);
976 dc->name = (char*) (dc + 1);
977 strcpy(dc->name, classname);
978 TAILQ_INIT(&dc->drivers);
979 TAILQ_INSERT_TAIL(&devclasses, dc, link);
981 bus_data_generation_update();
985 * If a parent class is specified, then set that as our parent so
986 * that this devclass will support drivers for the parent class as
987 * well. If the parent class has the same name don't do this though
988 * as it creates a cycle that can trigger an infinite loop in
989 * device_probe_child() if a device exists for which there is no
992 if (parentname && dc && !dc->parent &&
993 strcmp(classname, parentname) != 0) {
994 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
995 dc->parent->flags |= DC_HAS_CHILDREN;
1002 * @brief Create a device class
1004 * If a device class with the name @p classname exists, return it,
1005 * otherwise create and return a new device class.
1007 * @param classname the devclass name to find or create
1010 devclass_create(const char *classname)
1012 return (devclass_find_internal(classname, NULL, TRUE));
1016 * @brief Find a device class
1018 * If a device class with the name @p classname exists, return it,
1019 * otherwise return @c NULL.
1021 * @param classname the devclass name to find
1024 devclass_find(const char *classname)
1026 return (devclass_find_internal(classname, NULL, FALSE));
1030 * @brief Register that a device driver has been added to a devclass
1032 * Register that a device driver has been added to a devclass. This
1033 * is called by devclass_add_driver to accomplish the recursive
1034 * notification of all the children classes of dc, as well as dc.
1035 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1038 * We do a full search here of the devclass list at each iteration
1039 * level to save storing children-lists in the devclass structure. If
1040 * we ever move beyond a few dozen devices doing this, we may need to
1043 * @param dc the devclass to edit
1044 * @param driver the driver that was just added
1047 devclass_driver_added(devclass_t dc, driver_t *driver)
1053 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1055 for (i = 0; i < dc->maxunit; i++)
1056 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1057 BUS_DRIVER_ADDED(dc->devices[i], driver);
1060 * Walk through the children classes. Since we only keep a
1061 * single parent pointer around, we walk the entire list of
1062 * devclasses looking for children. We set the
1063 * DC_HAS_CHILDREN flag when a child devclass is created on
1064 * the parent, so we only walk the list for those devclasses
1065 * that have children.
1067 if (!(dc->flags & DC_HAS_CHILDREN))
1070 TAILQ_FOREACH(dc, &devclasses, link) {
1071 if (dc->parent == parent)
1072 devclass_driver_added(dc, driver);
1077 * @brief Add a device driver to a device class
1079 * Add a device driver to a devclass. This is normally called
1080 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1081 * all devices in the devclass will be called to allow them to attempt
1082 * to re-probe any unmatched children.
1084 * @param dc the devclass to edit
1085 * @param driver the driver to register
1088 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1091 const char *parentname;
1093 PDEBUG(("%s", DRIVERNAME(driver)));
1095 /* Don't allow invalid pass values. */
1096 if (pass <= BUS_PASS_ROOT)
1099 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1104 * Compile the driver's methods. Also increase the reference count
1105 * so that the class doesn't get freed when the last instance
1106 * goes. This means we can safely use static methods and avoids a
1107 * double-free in devclass_delete_driver.
1109 kobj_class_compile((kobj_class_t) driver);
1112 * If the driver has any base classes, make the
1113 * devclass inherit from the devclass of the driver's
1114 * first base class. This will allow the system to
1115 * search for drivers in both devclasses for children
1116 * of a device using this driver.
1118 if (driver->baseclasses)
1119 parentname = driver->baseclasses[0]->name;
1122 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1124 dl->driver = driver;
1125 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1126 driver->refs++; /* XXX: kobj_mtx */
1128 driver_register_pass(dl);
1130 if (device_frozen) {
1131 dl->flags |= DL_DEFERRED_PROBE;
1133 devclass_driver_added(dc, driver);
1135 bus_data_generation_update();
1140 * @brief Register that a device driver has been deleted from a devclass
1142 * Register that a device driver has been removed from a devclass.
1143 * This is called by devclass_delete_driver to accomplish the
1144 * recursive notification of all the children classes of busclass, as
1145 * well as busclass. Each layer will attempt to detach the driver
1146 * from any devices that are children of the bus's devclass. The function
1147 * will return an error if a device fails to detach.
1149 * We do a full search here of the devclass list at each iteration
1150 * level to save storing children-lists in the devclass structure. If
1151 * we ever move beyond a few dozen devices doing this, we may need to
1154 * @param busclass the devclass of the parent bus
1155 * @param dc the devclass of the driver being deleted
1156 * @param driver the driver being deleted
1159 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1166 * Disassociate from any devices. We iterate through all the
1167 * devices in the devclass of the driver and detach any which are
1168 * using the driver and which have a parent in the devclass which
1169 * we are deleting from.
1171 * Note that since a driver can be in multiple devclasses, we
1172 * should not detach devices which are not children of devices in
1173 * the affected devclass.
1175 * If we're frozen, we don't generate NOMATCH events. Mark to
1178 for (i = 0; i < dc->maxunit; i++) {
1179 if (dc->devices[i]) {
1180 dev = dc->devices[i];
1181 if (dev->driver == driver && dev->parent &&
1182 dev->parent->devclass == busclass) {
1183 if ((error = device_detach(dev)) != 0)
1185 if (device_frozen) {
1186 dev->flags &= ~DF_DONENOMATCH;
1187 dev->flags |= DF_NEEDNOMATCH;
1189 BUS_PROBE_NOMATCH(dev->parent, dev);
1191 dev->flags |= DF_DONENOMATCH;
1198 * Walk through the children classes. Since we only keep a
1199 * single parent pointer around, we walk the entire list of
1200 * devclasses looking for children. We set the
1201 * DC_HAS_CHILDREN flag when a child devclass is created on
1202 * the parent, so we only walk the list for those devclasses
1203 * that have children.
1205 if (!(busclass->flags & DC_HAS_CHILDREN))
1208 TAILQ_FOREACH(busclass, &devclasses, link) {
1209 if (busclass->parent == parent) {
1210 error = devclass_driver_deleted(busclass, dc, driver);
1219 * @brief Delete a device driver from a device class
1221 * Delete a device driver from a devclass. This is normally called
1222 * automatically by DRIVER_MODULE().
1224 * If the driver is currently attached to any devices,
1225 * devclass_delete_driver() will first attempt to detach from each
1226 * device. If one of the detach calls fails, the driver will not be
1229 * @param dc the devclass to edit
1230 * @param driver the driver to unregister
1233 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1235 devclass_t dc = devclass_find(driver->name);
1239 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1245 * Find the link structure in the bus' list of drivers.
1247 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1248 if (dl->driver == driver)
1253 PDEBUG(("%s not found in %s list", driver->name,
1258 error = devclass_driver_deleted(busclass, dc, driver);
1262 TAILQ_REMOVE(&busclass->drivers, dl, link);
1267 if (driver->refs == 0)
1268 kobj_class_free((kobj_class_t) driver);
1270 bus_data_generation_update();
1275 * @brief Quiesces a set of device drivers from a device class
1277 * Quiesce a device driver from a devclass. This is normally called
1278 * automatically by DRIVER_MODULE().
1280 * If the driver is currently attached to any devices,
1281 * devclass_quiesece_driver() will first attempt to quiesce each
1284 * @param dc the devclass to edit
1285 * @param driver the driver to unregister
1288 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1290 devclass_t dc = devclass_find(driver->name);
1296 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1302 * Find the link structure in the bus' list of drivers.
1304 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1305 if (dl->driver == driver)
1310 PDEBUG(("%s not found in %s list", driver->name,
1316 * Quiesce all devices. We iterate through all the devices in
1317 * the devclass of the driver and quiesce any which are using
1318 * the driver and which have a parent in the devclass which we
1321 * Note that since a driver can be in multiple devclasses, we
1322 * should not quiesce devices which are not children of
1323 * devices in the affected devclass.
1325 for (i = 0; i < dc->maxunit; i++) {
1326 if (dc->devices[i]) {
1327 dev = dc->devices[i];
1328 if (dev->driver == driver && dev->parent &&
1329 dev->parent->devclass == busclass) {
1330 if ((error = device_quiesce(dev)) != 0)
1343 devclass_find_driver_internal(devclass_t dc, const char *classname)
1347 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1349 TAILQ_FOREACH(dl, &dc->drivers, link) {
1350 if (!strcmp(dl->driver->name, classname))
1354 PDEBUG(("not found"));
1359 * @brief Return the name of the devclass
1362 devclass_get_name(devclass_t dc)
1368 * @brief Find a device given a unit number
1370 * @param dc the devclass to search
1371 * @param unit the unit number to search for
1373 * @returns the device with the given unit number or @c
1374 * NULL if there is no such device
1377 devclass_get_device(devclass_t dc, int unit)
1379 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1381 return (dc->devices[unit]);
1385 * @brief Find the softc field of a device given a unit number
1387 * @param dc the devclass to search
1388 * @param unit the unit number to search for
1390 * @returns the softc field of the device with the given
1391 * unit number or @c NULL if there is no such
1395 devclass_get_softc(devclass_t dc, int unit)
1399 dev = devclass_get_device(dc, unit);
1403 return (device_get_softc(dev));
1407 * @brief Get a list of devices in the devclass
1409 * An array containing a list of all the devices in the given devclass
1410 * is allocated and returned in @p *devlistp. The number of devices
1411 * in the array is returned in @p *devcountp. The caller should free
1412 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1414 * @param dc the devclass to examine
1415 * @param devlistp points at location for array pointer return
1417 * @param devcountp points at location for array size return value
1420 * @retval ENOMEM the array allocation failed
1423 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1428 count = devclass_get_count(dc);
1429 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1434 for (i = 0; i < dc->maxunit; i++) {
1435 if (dc->devices[i]) {
1436 list[count] = dc->devices[i];
1448 * @brief Get a list of drivers in the devclass
1450 * An array containing a list of pointers to all the drivers in the
1451 * given devclass is allocated and returned in @p *listp. The number
1452 * of drivers in the array is returned in @p *countp. The caller should
1453 * free the array using @c free(p, M_TEMP).
1455 * @param dc the devclass to examine
1456 * @param listp gives location for array pointer return value
1457 * @param countp gives location for number of array elements
1461 * @retval ENOMEM the array allocation failed
1464 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1471 TAILQ_FOREACH(dl, &dc->drivers, link)
1473 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1478 TAILQ_FOREACH(dl, &dc->drivers, link) {
1479 list[count] = dl->driver;
1489 * @brief Get the number of devices in a devclass
1491 * @param dc the devclass to examine
1494 devclass_get_count(devclass_t dc)
1499 for (i = 0; i < dc->maxunit; i++)
1506 * @brief Get the maximum unit number used in a devclass
1508 * Note that this is one greater than the highest currently-allocated
1509 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1510 * that not even the devclass has been allocated yet.
1512 * @param dc the devclass to examine
1515 devclass_get_maxunit(devclass_t dc)
1519 return (dc->maxunit);
1523 * @brief Find a free unit number in a devclass
1525 * This function searches for the first unused unit number greater
1526 * that or equal to @p unit.
1528 * @param dc the devclass to examine
1529 * @param unit the first unit number to check
1532 devclass_find_free_unit(devclass_t dc, int unit)
1536 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1542 * @brief Set the parent of a devclass
1544 * The parent class is normally initialised automatically by
1547 * @param dc the devclass to edit
1548 * @param pdc the new parent devclass
1551 devclass_set_parent(devclass_t dc, devclass_t pdc)
1557 * @brief Get the parent of a devclass
1559 * @param dc the devclass to examine
1562 devclass_get_parent(devclass_t dc)
1564 return (dc->parent);
1567 struct sysctl_ctx_list *
1568 devclass_get_sysctl_ctx(devclass_t dc)
1570 return (&dc->sysctl_ctx);
1574 devclass_get_sysctl_tree(devclass_t dc)
1576 return (dc->sysctl_tree);
1581 * @brief Allocate a unit number
1583 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1584 * will do). The allocated unit number is returned in @p *unitp.
1586 * @param dc the devclass to allocate from
1587 * @param unitp points at the location for the allocated unit
1591 * @retval EEXIST the requested unit number is already allocated
1592 * @retval ENOMEM memory allocation failure
1595 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1600 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1602 /* Ask the parent bus if it wants to wire this device. */
1604 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1607 /* If we were given a wired unit number, check for existing device */
1610 if (unit >= 0 && unit < dc->maxunit &&
1611 dc->devices[unit] != NULL) {
1613 printf("%s: %s%d already exists; skipping it\n",
1614 dc->name, dc->name, *unitp);
1618 /* Unwired device, find the next available slot for it */
1620 for (unit = 0;; unit++) {
1621 /* If there is an "at" hint for a unit then skip it. */
1622 if (resource_string_value(dc->name, unit, "at", &s) ==
1626 /* If this device slot is already in use, skip it. */
1627 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1635 * We've selected a unit beyond the length of the table, so let's
1636 * extend the table to make room for all units up to and including
1639 if (unit >= dc->maxunit) {
1640 device_t *newlist, *oldlist;
1643 oldlist = dc->devices;
1644 newsize = roundup((unit + 1),
1645 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1646 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1649 if (oldlist != NULL)
1650 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1651 bzero(newlist + dc->maxunit,
1652 sizeof(device_t) * (newsize - dc->maxunit));
1653 dc->devices = newlist;
1654 dc->maxunit = newsize;
1655 if (oldlist != NULL)
1656 free(oldlist, M_BUS);
1658 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1666 * @brief Add a device to a devclass
1668 * A unit number is allocated for the device (using the device's
1669 * preferred unit number if any) and the device is registered in the
1670 * devclass. This allows the device to be looked up by its unit
1671 * number, e.g. by decoding a dev_t minor number.
1673 * @param dc the devclass to add to
1674 * @param dev the device to add
1677 * @retval EEXIST the requested unit number is already allocated
1678 * @retval ENOMEM memory allocation failure
1681 devclass_add_device(devclass_t dc, device_t dev)
1685 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1687 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1690 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1694 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1695 free(dev->nameunit, M_BUS);
1696 dev->nameunit = NULL;
1699 dc->devices[dev->unit] = dev;
1701 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1708 * @brief Delete a device from a devclass
1710 * The device is removed from the devclass's device list and its unit
1713 * @param dc the devclass to delete from
1714 * @param dev the device to delete
1719 devclass_delete_device(devclass_t dc, device_t dev)
1724 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1726 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1727 panic("devclass_delete_device: inconsistent device class");
1728 dc->devices[dev->unit] = NULL;
1729 if (dev->flags & DF_WILDCARD)
1731 dev->devclass = NULL;
1732 free(dev->nameunit, M_BUS);
1733 dev->nameunit = NULL;
1740 * @brief Make a new device and add it as a child of @p parent
1742 * @param parent the parent of the new device
1743 * @param name the devclass name of the new device or @c NULL
1744 * to leave the devclass unspecified
1745 * @parem unit the unit number of the new device of @c -1 to
1746 * leave the unit number unspecified
1748 * @returns the new device
1751 make_device(device_t parent, const char *name, int unit)
1756 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1759 dc = devclass_find_internal(name, NULL, TRUE);
1761 printf("make_device: can't find device class %s\n",
1769 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1773 dev->parent = parent;
1774 TAILQ_INIT(&dev->children);
1775 kobj_init((kobj_t) dev, &null_class);
1777 dev->devclass = NULL;
1779 dev->nameunit = NULL;
1783 dev->flags = DF_ENABLED;
1786 dev->flags |= DF_WILDCARD;
1788 dev->flags |= DF_FIXEDCLASS;
1789 if (devclass_add_device(dc, dev)) {
1790 kobj_delete((kobj_t) dev, M_BUS);
1794 if (parent != NULL && device_has_quiet_children(parent))
1795 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1799 dev->state = DS_NOTPRESENT;
1801 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1802 bus_data_generation_update();
1809 * @brief Print a description of a device.
1812 device_print_child(device_t dev, device_t child)
1816 if (device_is_alive(child))
1817 retval += BUS_PRINT_CHILD(dev, child);
1819 retval += device_printf(child, " not found\n");
1825 * @brief Create a new device
1827 * This creates a new device and adds it as a child of an existing
1828 * parent device. The new device will be added after the last existing
1829 * child with order zero.
1831 * @param dev the device which will be the parent of the
1833 * @param name devclass name for new device or @c NULL if not
1835 * @param unit unit number for new device or @c -1 if not
1838 * @returns the new device
1841 device_add_child(device_t dev, const char *name, int unit)
1843 return (device_add_child_ordered(dev, 0, name, unit));
1847 * @brief Create a new device
1849 * This creates a new device and adds it as a child of an existing
1850 * parent device. The new device will be added after the last existing
1851 * child with the same order.
1853 * @param dev the device which will be the parent of the
1855 * @param order a value which is used to partially sort the
1856 * children of @p dev - devices created using
1857 * lower values of @p order appear first in @p
1858 * dev's list of children
1859 * @param name devclass name for new device or @c NULL if not
1861 * @param unit unit number for new device or @c -1 if not
1864 * @returns the new device
1867 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1872 PDEBUG(("%s at %s with order %u as unit %d",
1873 name, DEVICENAME(dev), order, unit));
1874 KASSERT(name != NULL || unit == -1,
1875 ("child device with wildcard name and specific unit number"));
1877 child = make_device(dev, name, unit);
1880 child->order = order;
1882 TAILQ_FOREACH(place, &dev->children, link) {
1883 if (place->order > order)
1889 * The device 'place' is the first device whose order is
1890 * greater than the new child.
1892 TAILQ_INSERT_BEFORE(place, child, link);
1895 * The new child's order is greater or equal to the order of
1896 * any existing device. Add the child to the tail of the list.
1898 TAILQ_INSERT_TAIL(&dev->children, child, link);
1901 bus_data_generation_update();
1906 * @brief Delete a device
1908 * This function deletes a device along with all of its children. If
1909 * the device currently has a driver attached to it, the device is
1910 * detached first using device_detach().
1912 * @param dev the parent device
1913 * @param child the device to delete
1916 * @retval non-zero a unit error code describing the error
1919 device_delete_child(device_t dev, device_t child)
1922 device_t grandchild;
1924 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1926 /* detach parent before deleting children, if any */
1927 if ((error = device_detach(child)) != 0)
1930 /* remove children second */
1931 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1932 error = device_delete_child(child, grandchild);
1937 if (child->devclass)
1938 devclass_delete_device(child->devclass, child);
1940 BUS_CHILD_DELETED(dev, child);
1941 TAILQ_REMOVE(&dev->children, child, link);
1942 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1943 kobj_delete((kobj_t) child, M_BUS);
1945 bus_data_generation_update();
1950 * @brief Delete all children devices of the given device, if any.
1952 * This function deletes all children devices of the given device, if
1953 * any, using the device_delete_child() function for each device it
1954 * finds. If a child device cannot be deleted, this function will
1955 * return an error code.
1957 * @param dev the parent device
1960 * @retval non-zero a device would not detach
1963 device_delete_children(device_t dev)
1968 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1972 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1973 error = device_delete_child(dev, child);
1975 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
1983 * @brief Find a device given a unit number
1985 * This is similar to devclass_get_devices() but only searches for
1986 * devices which have @p dev as a parent.
1988 * @param dev the parent device to search
1989 * @param unit the unit number to search for. If the unit is -1,
1990 * return the first child of @p dev which has name
1991 * @p classname (that is, the one with the lowest unit.)
1993 * @returns the device with the given unit number or @c
1994 * NULL if there is no such device
1997 device_find_child(device_t dev, const char *classname, int unit)
2002 dc = devclass_find(classname);
2007 child = devclass_get_device(dc, unit);
2008 if (child && child->parent == dev)
2011 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2012 child = devclass_get_device(dc, unit);
2013 if (child && child->parent == dev)
2024 first_matching_driver(devclass_t dc, device_t dev)
2027 return (devclass_find_driver_internal(dc, dev->devclass->name));
2028 return (TAILQ_FIRST(&dc->drivers));
2035 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2037 if (dev->devclass) {
2039 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2040 if (!strcmp(dev->devclass->name, dl->driver->name))
2044 return (TAILQ_NEXT(last, link));
2051 device_probe_child(device_t dev, device_t child)
2054 driverlink_t best = NULL;
2056 int result, pri = 0;
2057 int hasclass = (child->devclass != NULL);
2063 panic("device_probe_child: parent device has no devclass");
2066 * If the state is already probed, then return. However, don't
2067 * return if we can rebid this object.
2069 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2072 for (; dc; dc = dc->parent) {
2073 for (dl = first_matching_driver(dc, child);
2075 dl = next_matching_driver(dc, child, dl)) {
2076 /* If this driver's pass is too high, then ignore it. */
2077 if (dl->pass > bus_current_pass)
2080 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2081 result = device_set_driver(child, dl->driver);
2082 if (result == ENOMEM)
2084 else if (result != 0)
2087 if (device_set_devclass(child,
2088 dl->driver->name) != 0) {
2089 char const * devname =
2090 device_get_name(child);
2091 if (devname == NULL)
2092 devname = "(unknown)";
2093 printf("driver bug: Unable to set "
2094 "devclass (class: %s "
2098 (void)device_set_driver(child, NULL);
2103 /* Fetch any flags for the device before probing. */
2104 resource_int_value(dl->driver->name, child->unit,
2105 "flags", &child->devflags);
2107 result = DEVICE_PROBE(child);
2109 /* Reset flags and devclass before the next probe. */
2110 child->devflags = 0;
2112 (void)device_set_devclass(child, NULL);
2115 * If the driver returns SUCCESS, there can be
2116 * no higher match for this device.
2125 * Reset DF_QUIET in case this driver doesn't
2126 * end up as the best driver.
2128 device_verbose(child);
2131 * Probes that return BUS_PROBE_NOWILDCARD or lower
2132 * only match on devices whose driver was explicitly
2135 if (result <= BUS_PROBE_NOWILDCARD &&
2136 !(child->flags & DF_FIXEDCLASS)) {
2141 * The driver returned an error so it
2142 * certainly doesn't match.
2145 (void)device_set_driver(child, NULL);
2150 * A priority lower than SUCCESS, remember the
2151 * best matching driver. Initialise the value
2152 * of pri for the first match.
2154 if (best == NULL || result > pri) {
2161 * If we have an unambiguous match in this devclass,
2162 * don't look in the parent.
2164 if (best && pri == 0)
2169 * If we found a driver, change state and initialise the devclass.
2171 /* XXX What happens if we rebid and got no best? */
2174 * If this device was attached, and we were asked to
2175 * rescan, and it is a different driver, then we have
2176 * to detach the old driver and reattach this new one.
2177 * Note, we don't have to check for DF_REBID here
2178 * because if the state is > DS_ALIVE, we know it must
2181 * This assumes that all DF_REBID drivers can have
2182 * their probe routine called at any time and that
2183 * they are idempotent as well as completely benign in
2184 * normal operations.
2186 * We also have to make sure that the detach
2187 * succeeded, otherwise we fail the operation (or
2188 * maybe it should just fail silently? I'm torn).
2190 if (child->state > DS_ALIVE && best->driver != child->driver)
2191 if ((result = device_detach(dev)) != 0)
2194 /* Set the winning driver, devclass, and flags. */
2195 if (!child->devclass) {
2196 result = device_set_devclass(child, best->driver->name);
2200 result = device_set_driver(child, best->driver);
2203 resource_int_value(best->driver->name, child->unit,
2204 "flags", &child->devflags);
2208 * A bit bogus. Call the probe method again to make
2209 * sure that we have the right description.
2211 DEVICE_PROBE(child);
2213 child->flags |= DF_REBID;
2216 child->flags &= ~DF_REBID;
2217 child->state = DS_ALIVE;
2219 bus_data_generation_update();
2227 * @brief Return the parent of a device
2230 device_get_parent(device_t dev)
2232 return (dev->parent);
2236 * @brief Get a list of children of a device
2238 * An array containing a list of all the children of the given device
2239 * is allocated and returned in @p *devlistp. The number of devices
2240 * in the array is returned in @p *devcountp. The caller should free
2241 * the array using @c free(p, M_TEMP).
2243 * @param dev the device to examine
2244 * @param devlistp points at location for array pointer return
2246 * @param devcountp points at location for array size return value
2249 * @retval ENOMEM the array allocation failed
2252 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2259 TAILQ_FOREACH(child, &dev->children, link) {
2268 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2273 TAILQ_FOREACH(child, &dev->children, link) {
2274 list[count] = child;
2285 * @brief Return the current driver for the device or @c NULL if there
2286 * is no driver currently attached
2289 device_get_driver(device_t dev)
2291 return (dev->driver);
2295 * @brief Return the current devclass for the device or @c NULL if
2299 device_get_devclass(device_t dev)
2301 return (dev->devclass);
2305 * @brief Return the name of the device's devclass or @c NULL if there
2309 device_get_name(device_t dev)
2311 if (dev != NULL && dev->devclass)
2312 return (devclass_get_name(dev->devclass));
2317 * @brief Return a string containing the device's devclass name
2318 * followed by an ascii representation of the device's unit number
2322 device_get_nameunit(device_t dev)
2324 return (dev->nameunit);
2328 * @brief Return the device's unit number.
2331 device_get_unit(device_t dev)
2337 * @brief Return the device's description string
2340 device_get_desc(device_t dev)
2346 * @brief Return the device's flags
2349 device_get_flags(device_t dev)
2351 return (dev->devflags);
2354 struct sysctl_ctx_list *
2355 device_get_sysctl_ctx(device_t dev)
2357 return (&dev->sysctl_ctx);
2361 device_get_sysctl_tree(device_t dev)
2363 return (dev->sysctl_tree);
2367 * @brief Print the name of the device followed by a colon and a space
2369 * @returns the number of characters printed
2372 device_print_prettyname(device_t dev)
2374 const char *name = device_get_name(dev);
2377 return (printf("unknown: "));
2378 return (printf("%s%d: ", name, device_get_unit(dev)));
2382 * @brief Print the name of the device followed by a colon, a space
2383 * and the result of calling vprintf() with the value of @p fmt and
2384 * the following arguments.
2386 * @returns the number of characters printed
2389 device_printf(device_t dev, const char * fmt, ...)
2399 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2400 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2402 name = device_get_name(dev);
2405 sbuf_cat(&sb, "unknown: ");
2407 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2410 sbuf_vprintf(&sb, fmt, ap);
2423 device_set_desc_internal(device_t dev, const char* desc, int copy)
2425 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2426 free(dev->desc, M_BUS);
2427 dev->flags &= ~DF_DESCMALLOCED;
2432 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2434 strcpy(dev->desc, desc);
2435 dev->flags |= DF_DESCMALLOCED;
2438 /* Avoid a -Wcast-qual warning */
2439 dev->desc = (char *)(uintptr_t) desc;
2442 bus_data_generation_update();
2446 * @brief Set the device's description
2448 * The value of @c desc should be a string constant that will not
2449 * change (at least until the description is changed in a subsequent
2450 * call to device_set_desc() or device_set_desc_copy()).
2453 device_set_desc(device_t dev, const char* desc)
2455 device_set_desc_internal(dev, desc, FALSE);
2459 * @brief Set the device's description
2461 * The string pointed to by @c desc is copied. Use this function if
2462 * the device description is generated, (e.g. with sprintf()).
2465 device_set_desc_copy(device_t dev, const char* desc)
2467 device_set_desc_internal(dev, desc, TRUE);
2471 * @brief Set the device's flags
2474 device_set_flags(device_t dev, uint32_t flags)
2476 dev->devflags = flags;
2480 * @brief Return the device's softc field
2482 * The softc is allocated and zeroed when a driver is attached, based
2483 * on the size field of the driver.
2486 device_get_softc(device_t dev)
2488 return (dev->softc);
2492 * @brief Set the device's softc field
2494 * Most drivers do not need to use this since the softc is allocated
2495 * automatically when the driver is attached.
2498 device_set_softc(device_t dev, void *softc)
2500 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2501 free(dev->softc, M_BUS_SC);
2504 dev->flags |= DF_EXTERNALSOFTC;
2506 dev->flags &= ~DF_EXTERNALSOFTC;
2510 * @brief Free claimed softc
2512 * Most drivers do not need to use this since the softc is freed
2513 * automatically when the driver is detached.
2516 device_free_softc(void *softc)
2518 free(softc, M_BUS_SC);
2522 * @brief Claim softc
2524 * This function can be used to let the driver free the automatically
2525 * allocated softc using "device_free_softc()". This function is
2526 * useful when the driver is refcounting the softc and the softc
2527 * cannot be freed when the "device_detach" method is called.
2530 device_claim_softc(device_t dev)
2533 dev->flags |= DF_EXTERNALSOFTC;
2535 dev->flags &= ~DF_EXTERNALSOFTC;
2539 * @brief Get the device's ivars field
2541 * The ivars field is used by the parent device to store per-device
2542 * state (e.g. the physical location of the device or a list of
2546 device_get_ivars(device_t dev)
2548 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2549 return (dev->ivars);
2553 * @brief Set the device's ivars field
2556 device_set_ivars(device_t dev, void * ivars)
2558 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2563 * @brief Return the device's state
2566 device_get_state(device_t dev)
2568 return (dev->state);
2572 * @brief Set the DF_ENABLED flag for the device
2575 device_enable(device_t dev)
2577 dev->flags |= DF_ENABLED;
2581 * @brief Clear the DF_ENABLED flag for the device
2584 device_disable(device_t dev)
2586 dev->flags &= ~DF_ENABLED;
2590 * @brief Increment the busy counter for the device
2593 device_busy(device_t dev)
2595 if (dev->state < DS_ATTACHING)
2596 panic("device_busy: called for unattached device");
2597 if (dev->busy == 0 && dev->parent)
2598 device_busy(dev->parent);
2600 if (dev->state == DS_ATTACHED)
2601 dev->state = DS_BUSY;
2605 * @brief Decrement the busy counter for the device
2608 device_unbusy(device_t dev)
2610 if (dev->busy != 0 && dev->state != DS_BUSY &&
2611 dev->state != DS_ATTACHING)
2612 panic("device_unbusy: called for non-busy device %s",
2613 device_get_nameunit(dev));
2615 if (dev->busy == 0) {
2617 device_unbusy(dev->parent);
2618 if (dev->state == DS_BUSY)
2619 dev->state = DS_ATTACHED;
2624 * @brief Set the DF_QUIET flag for the device
2627 device_quiet(device_t dev)
2629 dev->flags |= DF_QUIET;
2633 * @brief Set the DF_QUIET_CHILDREN flag for the device
2636 device_quiet_children(device_t dev)
2638 dev->flags |= DF_QUIET_CHILDREN;
2642 * @brief Clear the DF_QUIET flag for the device
2645 device_verbose(device_t dev)
2647 dev->flags &= ~DF_QUIET;
2651 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2654 device_has_quiet_children(device_t dev)
2656 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2660 * @brief Return non-zero if the DF_QUIET flag is set on the device
2663 device_is_quiet(device_t dev)
2665 return ((dev->flags & DF_QUIET) != 0);
2669 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2672 device_is_enabled(device_t dev)
2674 return ((dev->flags & DF_ENABLED) != 0);
2678 * @brief Return non-zero if the device was successfully probed
2681 device_is_alive(device_t dev)
2683 return (dev->state >= DS_ALIVE);
2687 * @brief Return non-zero if the device currently has a driver
2691 device_is_attached(device_t dev)
2693 return (dev->state >= DS_ATTACHED);
2697 * @brief Return non-zero if the device is currently suspended.
2700 device_is_suspended(device_t dev)
2702 return ((dev->flags & DF_SUSPENDED) != 0);
2706 * @brief Set the devclass of a device
2707 * @see devclass_add_device().
2710 device_set_devclass(device_t dev, const char *classname)
2717 devclass_delete_device(dev->devclass, dev);
2721 if (dev->devclass) {
2722 printf("device_set_devclass: device class already set\n");
2726 dc = devclass_find_internal(classname, NULL, TRUE);
2730 error = devclass_add_device(dc, dev);
2732 bus_data_generation_update();
2737 * @brief Set the devclass of a device and mark the devclass fixed.
2738 * @see device_set_devclass()
2741 device_set_devclass_fixed(device_t dev, const char *classname)
2745 if (classname == NULL)
2748 error = device_set_devclass(dev, classname);
2751 dev->flags |= DF_FIXEDCLASS;
2756 * @brief Query the device to determine if it's of a fixed devclass
2757 * @see device_set_devclass_fixed()
2760 device_is_devclass_fixed(device_t dev)
2762 return ((dev->flags & DF_FIXEDCLASS) != 0);
2766 * @brief Set the driver of a device
2769 * @retval EBUSY the device already has a driver attached
2770 * @retval ENOMEM a memory allocation failure occurred
2773 device_set_driver(device_t dev, driver_t *driver)
2776 struct domainset *policy;
2778 if (dev->state >= DS_ATTACHED)
2781 if (dev->driver == driver)
2784 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2785 free(dev->softc, M_BUS_SC);
2788 device_set_desc(dev, NULL);
2789 kobj_delete((kobj_t) dev, NULL);
2790 dev->driver = driver;
2792 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2793 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2794 if (bus_get_domain(dev, &domain) == 0)
2795 policy = DOMAINSET_PREF(domain);
2797 policy = DOMAINSET_RR();
2798 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2799 policy, M_NOWAIT | M_ZERO);
2801 kobj_delete((kobj_t) dev, NULL);
2802 kobj_init((kobj_t) dev, &null_class);
2808 kobj_init((kobj_t) dev, &null_class);
2811 bus_data_generation_update();
2816 * @brief Probe a device, and return this status.
2818 * This function is the core of the device autoconfiguration
2819 * system. Its purpose is to select a suitable driver for a device and
2820 * then call that driver to initialise the hardware appropriately. The
2821 * driver is selected by calling the DEVICE_PROBE() method of a set of
2822 * candidate drivers and then choosing the driver which returned the
2823 * best value. This driver is then attached to the device using
2826 * The set of suitable drivers is taken from the list of drivers in
2827 * the parent device's devclass. If the device was originally created
2828 * with a specific class name (see device_add_child()), only drivers
2829 * with that name are probed, otherwise all drivers in the devclass
2830 * are probed. If no drivers return successful probe values in the
2831 * parent devclass, the search continues in the parent of that
2832 * devclass (see devclass_get_parent()) if any.
2834 * @param dev the device to initialise
2837 * @retval ENXIO no driver was found
2838 * @retval ENOMEM memory allocation failure
2839 * @retval non-zero some other unix error code
2840 * @retval -1 Device already attached
2843 device_probe(device_t dev)
2849 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2852 if (!(dev->flags & DF_ENABLED)) {
2853 if (bootverbose && device_get_name(dev) != NULL) {
2854 device_print_prettyname(dev);
2855 printf("not probed (disabled)\n");
2859 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2860 if (bus_current_pass == BUS_PASS_DEFAULT &&
2861 !(dev->flags & DF_DONENOMATCH)) {
2862 BUS_PROBE_NOMATCH(dev->parent, dev);
2864 dev->flags |= DF_DONENOMATCH;
2872 * @brief Probe a device and attach a driver if possible
2874 * calls device_probe() and attaches if that was successful.
2877 device_probe_and_attach(device_t dev)
2883 error = device_probe(dev);
2886 else if (error != 0)
2889 CURVNET_SET_QUIET(vnet0);
2890 error = device_attach(dev);
2896 * @brief Attach a device driver to a device
2898 * This function is a wrapper around the DEVICE_ATTACH() driver
2899 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2900 * device's sysctl tree, optionally prints a description of the device
2901 * and queues a notification event for user-based device management
2904 * Normally this function is only called internally from
2905 * device_probe_and_attach().
2907 * @param dev the device to initialise
2910 * @retval ENXIO no driver was found
2911 * @retval ENOMEM memory allocation failure
2912 * @retval non-zero some other unix error code
2915 device_attach(device_t dev)
2917 uint64_t attachtime;
2918 uint16_t attachentropy;
2921 if (resource_disabled(dev->driver->name, dev->unit)) {
2922 device_disable(dev);
2924 device_printf(dev, "disabled via hints entry\n");
2928 device_sysctl_init(dev);
2929 if (!device_is_quiet(dev))
2930 device_print_child(dev->parent, dev);
2931 attachtime = get_cyclecount();
2932 dev->state = DS_ATTACHING;
2933 if ((error = DEVICE_ATTACH(dev)) != 0) {
2934 printf("device_attach: %s%d attach returned %d\n",
2935 dev->driver->name, dev->unit, error);
2936 if (!(dev->flags & DF_FIXEDCLASS))
2937 devclass_delete_device(dev->devclass, dev);
2938 (void)device_set_driver(dev, NULL);
2939 device_sysctl_fini(dev);
2940 KASSERT(dev->busy == 0, ("attach failed but busy"));
2941 dev->state = DS_NOTPRESENT;
2944 dev->flags |= DF_ATTACHED_ONCE;
2945 /* We only need the low bits of this time, but ranges from tens to thousands
2946 * have been seen, so keep 2 bytes' worth.
2948 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2949 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2950 device_sysctl_update(dev);
2952 dev->state = DS_BUSY;
2954 dev->state = DS_ATTACHED;
2955 dev->flags &= ~DF_DONENOMATCH;
2956 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2962 * @brief Detach a driver from a device
2964 * This function is a wrapper around the DEVICE_DETACH() driver
2965 * method. If the call to DEVICE_DETACH() succeeds, it calls
2966 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2967 * notification event for user-based device management services and
2968 * cleans up the device's sysctl tree.
2970 * @param dev the device to un-initialise
2973 * @retval ENXIO no driver was found
2974 * @retval ENOMEM memory allocation failure
2975 * @retval non-zero some other unix error code
2978 device_detach(device_t dev)
2984 PDEBUG(("%s", DEVICENAME(dev)));
2985 if (dev->state == DS_BUSY)
2987 if (dev->state == DS_ATTACHING) {
2988 device_printf(dev, "device in attaching state! Deferring detach.\n");
2991 if (dev->state != DS_ATTACHED)
2994 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2995 if ((error = DEVICE_DETACH(dev)) != 0) {
2996 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2997 EVHDEV_DETACH_FAILED);
3000 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3001 EVHDEV_DETACH_COMPLETE);
3004 if (!device_is_quiet(dev))
3005 device_printf(dev, "detached\n");
3007 BUS_CHILD_DETACHED(dev->parent, dev);
3009 if (!(dev->flags & DF_FIXEDCLASS))
3010 devclass_delete_device(dev->devclass, dev);
3012 device_verbose(dev);
3013 dev->state = DS_NOTPRESENT;
3014 (void)device_set_driver(dev, NULL);
3015 device_sysctl_fini(dev);
3021 * @brief Tells a driver to quiesce itself.
3023 * This function is a wrapper around the DEVICE_QUIESCE() driver
3024 * method. If the call to DEVICE_QUIESCE() succeeds.
3026 * @param dev the device to quiesce
3029 * @retval ENXIO no driver was found
3030 * @retval ENOMEM memory allocation failure
3031 * @retval non-zero some other unix error code
3034 device_quiesce(device_t dev)
3036 PDEBUG(("%s", DEVICENAME(dev)));
3037 if (dev->state == DS_BUSY)
3039 if (dev->state != DS_ATTACHED)
3042 return (DEVICE_QUIESCE(dev));
3046 * @brief Notify a device of system shutdown
3048 * This function calls the DEVICE_SHUTDOWN() driver method if the
3049 * device currently has an attached driver.
3051 * @returns the value returned by DEVICE_SHUTDOWN()
3054 device_shutdown(device_t dev)
3056 if (dev->state < DS_ATTACHED)
3058 return (DEVICE_SHUTDOWN(dev));
3062 * @brief Set the unit number of a device
3064 * This function can be used to override the unit number used for a
3065 * device (e.g. to wire a device to a pre-configured unit number).
3068 device_set_unit(device_t dev, int unit)
3073 dc = device_get_devclass(dev);
3074 if (unit < dc->maxunit && dc->devices[unit])
3076 err = devclass_delete_device(dc, dev);
3080 err = devclass_add_device(dc, dev);
3084 bus_data_generation_update();
3088 /*======================================*/
3090 * Some useful method implementations to make life easier for bus drivers.
3094 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3098 args->memattr = VM_MEMATTR_UNCACHEABLE;
3102 * @brief Initialise a resource list.
3104 * @param rl the resource list to initialise
3107 resource_list_init(struct resource_list *rl)
3113 * @brief Reclaim memory used by a resource list.
3115 * This function frees the memory for all resource entries on the list
3118 * @param rl the resource list to free
3121 resource_list_free(struct resource_list *rl)
3123 struct resource_list_entry *rle;
3125 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3127 panic("resource_list_free: resource entry is busy");
3128 STAILQ_REMOVE_HEAD(rl, link);
3134 * @brief Add a resource entry.
3136 * This function adds a resource entry using the given @p type, @p
3137 * start, @p end and @p count values. A rid value is chosen by
3138 * searching sequentially for the first unused rid starting at zero.
3140 * @param rl the resource list to edit
3141 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3142 * @param start the start address of the resource
3143 * @param end the end address of the resource
3144 * @param count XXX end-start+1
3147 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3148 rman_res_t end, rman_res_t count)
3153 while (resource_list_find(rl, type, rid) != NULL)
3155 resource_list_add(rl, type, rid, start, end, count);
3160 * @brief Add or modify a resource entry.
3162 * If an existing entry exists with the same type and rid, it will be
3163 * modified using the given values of @p start, @p end and @p
3164 * count. If no entry exists, a new one will be created using the
3165 * given values. The resource list entry that matches is then returned.
3167 * @param rl the resource list to edit
3168 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3169 * @param rid the resource identifier
3170 * @param start the start address of the resource
3171 * @param end the end address of the resource
3172 * @param count XXX end-start+1
3174 struct resource_list_entry *
3175 resource_list_add(struct resource_list *rl, int type, int rid,
3176 rman_res_t start, rman_res_t end, rman_res_t count)
3178 struct resource_list_entry *rle;
3180 rle = resource_list_find(rl, type, rid);
3182 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3185 panic("resource_list_add: can't record entry");
3186 STAILQ_INSERT_TAIL(rl, rle, link);
3194 panic("resource_list_add: resource entry is busy");
3203 * @brief Determine if a resource entry is busy.
3205 * Returns true if a resource entry is busy meaning that it has an
3206 * associated resource that is not an unallocated "reserved" resource.
3208 * @param rl the resource list to search
3209 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3210 * @param rid the resource identifier
3212 * @returns Non-zero if the entry is busy, zero otherwise.
3215 resource_list_busy(struct resource_list *rl, int type, int rid)
3217 struct resource_list_entry *rle;
3219 rle = resource_list_find(rl, type, rid);
3220 if (rle == NULL || rle->res == NULL)
3222 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3223 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3224 ("reserved resource is active"));
3231 * @brief Determine if a resource entry is reserved.
3233 * Returns true if a resource entry is reserved meaning that it has an
3234 * associated "reserved" resource. The resource can either be
3235 * allocated or unallocated.
3237 * @param rl the resource list to search
3238 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3239 * @param rid the resource identifier
3241 * @returns Non-zero if the entry is reserved, zero otherwise.
3244 resource_list_reserved(struct resource_list *rl, int type, int rid)
3246 struct resource_list_entry *rle;
3248 rle = resource_list_find(rl, type, rid);
3249 if (rle != NULL && rle->flags & RLE_RESERVED)
3255 * @brief Find a resource entry by type and rid.
3257 * @param rl the resource list to search
3258 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3259 * @param rid the resource identifier
3261 * @returns the resource entry pointer or NULL if there is no such
3264 struct resource_list_entry *
3265 resource_list_find(struct resource_list *rl, int type, int rid)
3267 struct resource_list_entry *rle;
3269 STAILQ_FOREACH(rle, rl, link) {
3270 if (rle->type == type && rle->rid == rid)
3277 * @brief Delete a resource entry.
3279 * @param rl the resource list to edit
3280 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3281 * @param rid the resource identifier
3284 resource_list_delete(struct resource_list *rl, int type, int rid)
3286 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3289 if (rle->res != NULL)
3290 panic("resource_list_delete: resource has not been released");
3291 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3297 * @brief Allocate a reserved resource
3299 * This can be used by buses to force the allocation of resources
3300 * that are always active in the system even if they are not allocated
3301 * by a driver (e.g. PCI BARs). This function is usually called when
3302 * adding a new child to the bus. The resource is allocated from the
3303 * parent bus when it is reserved. The resource list entry is marked
3304 * with RLE_RESERVED to note that it is a reserved resource.
3306 * Subsequent attempts to allocate the resource with
3307 * resource_list_alloc() will succeed the first time and will set
3308 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3309 * resource that has been allocated is released with
3310 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3311 * the actual resource remains allocated. The resource can be released to
3312 * the parent bus by calling resource_list_unreserve().
3314 * @param rl the resource list to allocate from
3315 * @param bus the parent device of @p child
3316 * @param child the device for which the resource is being reserved
3317 * @param type the type of resource to allocate
3318 * @param rid a pointer to the resource identifier
3319 * @param start hint at the start of the resource range - pass
3320 * @c 0 for any start address
3321 * @param end hint at the end of the resource range - pass
3322 * @c ~0 for any end address
3323 * @param count hint at the size of range required - pass @c 1
3325 * @param flags any extra flags to control the resource
3326 * allocation - see @c RF_XXX flags in
3327 * <sys/rman.h> for details
3329 * @returns the resource which was allocated or @c NULL if no
3330 * resource could be allocated
3333 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3334 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3336 struct resource_list_entry *rle = NULL;
3337 int passthrough = (device_get_parent(child) != bus);
3342 "resource_list_reserve() should only be called for direct children");
3343 if (flags & RF_ACTIVE)
3345 "resource_list_reserve() should only reserve inactive resources");
3347 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3350 rle = resource_list_find(rl, type, *rid);
3351 rle->flags |= RLE_RESERVED;
3357 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3359 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3360 * and passing the allocation up to the parent of @p bus. This assumes
3361 * that the first entry of @c device_get_ivars(child) is a struct
3362 * resource_list. This also handles 'passthrough' allocations where a
3363 * child is a remote descendant of bus by passing the allocation up to
3364 * the parent of bus.
3366 * Typically, a bus driver would store a list of child resources
3367 * somewhere in the child device's ivars (see device_get_ivars()) and
3368 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3369 * then call resource_list_alloc() to perform the allocation.
3371 * @param rl the resource list to allocate from
3372 * @param bus the parent device of @p child
3373 * @param child the device which is requesting an allocation
3374 * @param type the type of resource to allocate
3375 * @param rid a pointer to the resource identifier
3376 * @param start hint at the start of the resource range - pass
3377 * @c 0 for any start address
3378 * @param end hint at the end of the resource range - pass
3379 * @c ~0 for any end address
3380 * @param count hint at the size of range required - pass @c 1
3382 * @param flags any extra flags to control the resource
3383 * allocation - see @c RF_XXX flags in
3384 * <sys/rman.h> for details
3386 * @returns the resource which was allocated or @c NULL if no
3387 * resource could be allocated
3390 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3391 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3393 struct resource_list_entry *rle = NULL;
3394 int passthrough = (device_get_parent(child) != bus);
3395 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3398 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3399 type, rid, start, end, count, flags));
3402 rle = resource_list_find(rl, type, *rid);
3405 return (NULL); /* no resource of that type/rid */
3408 if (rle->flags & RLE_RESERVED) {
3409 if (rle->flags & RLE_ALLOCATED)
3411 if ((flags & RF_ACTIVE) &&
3412 bus_activate_resource(child, type, *rid,
3415 rle->flags |= RLE_ALLOCATED;
3419 "resource entry %#x type %d for child %s is busy\n", *rid,
3420 type, device_get_nameunit(child));
3426 count = ulmax(count, rle->count);
3427 end = ulmax(rle->end, start + count - 1);
3430 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3431 type, rid, start, end, count, flags);
3434 * Record the new range.
3437 rle->start = rman_get_start(rle->res);
3438 rle->end = rman_get_end(rle->res);
3446 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3448 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3449 * used with resource_list_alloc().
3451 * @param rl the resource list which was allocated from
3452 * @param bus the parent device of @p child
3453 * @param child the device which is requesting a release
3454 * @param type the type of resource to release
3455 * @param rid the resource identifier
3456 * @param res the resource to release
3459 * @retval non-zero a standard unix error code indicating what
3460 * error condition prevented the operation
3463 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3464 int type, int rid, struct resource *res)
3466 struct resource_list_entry *rle = NULL;
3467 int passthrough = (device_get_parent(child) != bus);
3471 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3475 rle = resource_list_find(rl, type, rid);
3478 panic("resource_list_release: can't find resource");
3480 panic("resource_list_release: resource entry is not busy");
3481 if (rle->flags & RLE_RESERVED) {
3482 if (rle->flags & RLE_ALLOCATED) {
3483 if (rman_get_flags(res) & RF_ACTIVE) {
3484 error = bus_deactivate_resource(child, type,
3489 rle->flags &= ~RLE_ALLOCATED;
3495 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3505 * @brief Release all active resources of a given type
3507 * Release all active resources of a specified type. This is intended
3508 * to be used to cleanup resources leaked by a driver after detach or
3511 * @param rl the resource list which was allocated from
3512 * @param bus the parent device of @p child
3513 * @param child the device whose active resources are being released
3514 * @param type the type of resources to release
3517 * @retval EBUSY at least one resource was active
3520 resource_list_release_active(struct resource_list *rl, device_t bus,
3521 device_t child, int type)
3523 struct resource_list_entry *rle;
3527 STAILQ_FOREACH(rle, rl, link) {
3528 if (rle->type != type)
3530 if (rle->res == NULL)
3532 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3536 error = resource_list_release(rl, bus, child, type,
3537 rman_get_rid(rle->res), rle->res);
3540 "Failed to release active resource: %d\n", error);
3546 * @brief Fully release a reserved resource
3548 * Fully releases a resource reserved via resource_list_reserve().
3550 * @param rl the resource list which was allocated from
3551 * @param bus the parent device of @p child
3552 * @param child the device whose reserved resource is being released
3553 * @param type the type of resource to release
3554 * @param rid the resource identifier
3555 * @param res the resource to release
3558 * @retval non-zero a standard unix error code indicating what
3559 * error condition prevented the operation
3562 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3565 struct resource_list_entry *rle = NULL;
3566 int passthrough = (device_get_parent(child) != bus);
3570 "resource_list_unreserve() should only be called for direct children");
3572 rle = resource_list_find(rl, type, rid);
3575 panic("resource_list_unreserve: can't find resource");
3576 if (!(rle->flags & RLE_RESERVED))
3578 if (rle->flags & RLE_ALLOCATED)
3580 rle->flags &= ~RLE_RESERVED;
3581 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3585 * @brief Print a description of resources in a resource list
3587 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3588 * The name is printed if at least one resource of the given type is available.
3589 * The format is used to print resource start and end.
3591 * @param rl the resource list to print
3592 * @param name the name of @p type, e.g. @c "memory"
3593 * @param type type type of resource entry to print
3594 * @param format printf(9) format string to print resource
3595 * start and end values
3597 * @returns the number of characters printed
3600 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3603 struct resource_list_entry *rle;
3604 int printed, retval;
3608 /* Yes, this is kinda cheating */
3609 STAILQ_FOREACH(rle, rl, link) {
3610 if (rle->type == type) {
3612 retval += printf(" %s ", name);
3614 retval += printf(",");
3616 retval += printf(format, rle->start);
3617 if (rle->count > 1) {
3618 retval += printf("-");
3619 retval += printf(format, rle->start +
3628 * @brief Releases all the resources in a list.
3630 * @param rl The resource list to purge.
3635 resource_list_purge(struct resource_list *rl)
3637 struct resource_list_entry *rle;
3639 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3641 bus_release_resource(rman_get_device(rle->res),
3642 rle->type, rle->rid, rle->res);
3643 STAILQ_REMOVE_HEAD(rl, link);
3649 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3651 return (device_add_child_ordered(dev, order, name, unit));
3655 * @brief Helper function for implementing DEVICE_PROBE()
3657 * This function can be used to help implement the DEVICE_PROBE() for
3658 * a bus (i.e. a device which has other devices attached to it). It
3659 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3663 bus_generic_probe(device_t dev)
3665 devclass_t dc = dev->devclass;
3668 TAILQ_FOREACH(dl, &dc->drivers, link) {
3670 * If this driver's pass is too high, then ignore it.
3671 * For most drivers in the default pass, this will
3672 * never be true. For early-pass drivers they will
3673 * only call the identify routines of eligible drivers
3674 * when this routine is called. Drivers for later
3675 * passes should have their identify routines called
3676 * on early-pass buses during BUS_NEW_PASS().
3678 if (dl->pass > bus_current_pass)
3680 DEVICE_IDENTIFY(dl->driver, dev);
3687 * @brief Helper function for implementing DEVICE_ATTACH()
3689 * This function can be used to help implement the DEVICE_ATTACH() for
3690 * a bus. It calls device_probe_and_attach() for each of the device's
3694 bus_generic_attach(device_t dev)
3698 TAILQ_FOREACH(child, &dev->children, link) {
3699 device_probe_and_attach(child);
3706 * @brief Helper function for delaying attaching children
3708 * Many buses can't run transactions on the bus which children need to probe and
3709 * attach until after interrupts and/or timers are running. This function
3710 * delays their attach until interrupts and timers are enabled.
3713 bus_delayed_attach_children(device_t dev)
3715 /* Probe and attach the bus children when interrupts are available */
3716 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3722 * @brief Helper function for implementing DEVICE_DETACH()
3724 * This function can be used to help implement the DEVICE_DETACH() for
3725 * a bus. It calls device_detach() for each of the device's
3729 bus_generic_detach(device_t dev)
3734 if (dev->state != DS_ATTACHED)
3738 * Detach children in the reverse order.
3739 * See bus_generic_suspend for details.
3741 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3742 if ((error = device_detach(child)) != 0)
3750 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3752 * This function can be used to help implement the DEVICE_SHUTDOWN()
3753 * for a bus. It calls device_shutdown() for each of the device's
3757 bus_generic_shutdown(device_t dev)
3762 * Shut down children in the reverse order.
3763 * See bus_generic_suspend for details.
3765 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3766 device_shutdown(child);
3773 * @brief Default function for suspending a child device.
3775 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3778 bus_generic_suspend_child(device_t dev, device_t child)
3782 error = DEVICE_SUSPEND(child);
3785 child->flags |= DF_SUSPENDED;
3791 * @brief Default function for resuming a child device.
3793 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3796 bus_generic_resume_child(device_t dev, device_t child)
3798 DEVICE_RESUME(child);
3799 child->flags &= ~DF_SUSPENDED;
3805 * @brief Helper function for implementing DEVICE_SUSPEND()
3807 * This function can be used to help implement the DEVICE_SUSPEND()
3808 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3809 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3810 * operation is aborted and any devices which were suspended are
3811 * resumed immediately by calling their DEVICE_RESUME() methods.
3814 bus_generic_suspend(device_t dev)
3820 * Suspend children in the reverse order.
3821 * For most buses all children are equal, so the order does not matter.
3822 * Other buses, such as acpi, carefully order their child devices to
3823 * express implicit dependencies between them. For such buses it is
3824 * safer to bring down devices in the reverse order.
3826 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3827 error = BUS_SUSPEND_CHILD(dev, child);
3829 child = TAILQ_NEXT(child, link);
3830 if (child != NULL) {
3831 TAILQ_FOREACH_FROM(child, &dev->children, link)
3832 BUS_RESUME_CHILD(dev, child);
3841 * @brief Helper function for implementing DEVICE_RESUME()
3843 * This function can be used to help implement the DEVICE_RESUME() for
3844 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3847 bus_generic_resume(device_t dev)
3851 TAILQ_FOREACH(child, &dev->children, link) {
3852 BUS_RESUME_CHILD(dev, child);
3853 /* if resume fails, there's nothing we can usefully do... */
3859 * @brief Helper function for implementing BUS_RESET_POST
3861 * Bus can use this function to implement common operations of
3862 * re-attaching or resuming the children after the bus itself was
3863 * reset, and after restoring bus-unique state of children.
3865 * @param dev The bus
3866 * #param flags DEVF_RESET_*
3869 bus_helper_reset_post(device_t dev, int flags)
3875 TAILQ_FOREACH(child, &dev->children,link) {
3876 BUS_RESET_POST(dev, child);
3877 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3878 device_probe_and_attach(child) :
3879 BUS_RESUME_CHILD(dev, child);
3880 if (error == 0 && error1 != 0)
3887 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3889 child = TAILQ_NEXT(child, link);
3892 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3893 BUS_RESET_POST(dev, child);
3894 if ((flags & DEVF_RESET_DETACH) != 0)
3895 device_probe_and_attach(child);
3897 BUS_RESUME_CHILD(dev, child);
3902 * @brief Helper function for implementing BUS_RESET_PREPARE
3904 * Bus can use this function to implement common operations of
3905 * detaching or suspending the children before the bus itself is
3906 * reset, and then save bus-unique state of children that must
3907 * persists around reset.
3909 * @param dev The bus
3910 * #param flags DEVF_RESET_*
3913 bus_helper_reset_prepare(device_t dev, int flags)
3918 if (dev->state != DS_ATTACHED)
3921 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3922 if ((flags & DEVF_RESET_DETACH) != 0) {
3923 error = device_get_state(child) == DS_ATTACHED ?
3924 device_detach(child) : 0;
3926 error = BUS_SUSPEND_CHILD(dev, child);
3929 error = BUS_RESET_PREPARE(dev, child);
3931 if ((flags & DEVF_RESET_DETACH) != 0)
3932 device_probe_and_attach(child);
3934 BUS_RESUME_CHILD(dev, child);
3938 bus_helper_reset_prepare_rollback(dev, child, flags);
3946 * @brief Helper function for implementing BUS_PRINT_CHILD().
3948 * This function prints the first part of the ascii representation of
3949 * @p child, including its name, unit and description (if any - see
3950 * device_set_desc()).
3952 * @returns the number of characters printed
3955 bus_print_child_header(device_t dev, device_t child)
3959 if (device_get_desc(child)) {
3960 retval += device_printf(child, "<%s>", device_get_desc(child));
3962 retval += printf("%s", device_get_nameunit(child));
3969 * @brief Helper function for implementing BUS_PRINT_CHILD().
3971 * This function prints the last part of the ascii representation of
3972 * @p child, which consists of the string @c " on " followed by the
3973 * name and unit of the @p dev.
3975 * @returns the number of characters printed
3978 bus_print_child_footer(device_t dev, device_t child)
3980 return (printf(" on %s\n", device_get_nameunit(dev)));
3984 * @brief Helper function for implementing BUS_PRINT_CHILD().
3986 * This function prints out the VM domain for the given device.
3988 * @returns the number of characters printed
3991 bus_print_child_domain(device_t dev, device_t child)
3995 /* No domain? Don't print anything */
3996 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3999 return (printf(" numa-domain %d", domain));
4003 * @brief Helper function for implementing BUS_PRINT_CHILD().
4005 * This function simply calls bus_print_child_header() followed by
4006 * bus_print_child_footer().
4008 * @returns the number of characters printed
4011 bus_generic_print_child(device_t dev, device_t child)
4015 retval += bus_print_child_header(dev, child);
4016 retval += bus_print_child_domain(dev, child);
4017 retval += bus_print_child_footer(dev, child);
4023 * @brief Stub function for implementing BUS_READ_IVAR().
4028 bus_generic_read_ivar(device_t dev, device_t child, int index,
4035 * @brief Stub function for implementing BUS_WRITE_IVAR().
4040 bus_generic_write_ivar(device_t dev, device_t child, int index,
4047 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4051 struct resource_list *
4052 bus_generic_get_resource_list(device_t dev, device_t child)
4058 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4060 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4061 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4062 * and then calls device_probe_and_attach() for each unattached child.
4065 bus_generic_driver_added(device_t dev, driver_t *driver)
4069 DEVICE_IDENTIFY(driver, dev);
4070 TAILQ_FOREACH(child, &dev->children, link) {
4071 if (child->state == DS_NOTPRESENT ||
4072 (child->flags & DF_REBID))
4073 device_probe_and_attach(child);
4078 * @brief Helper function for implementing BUS_NEW_PASS().
4080 * This implementing of BUS_NEW_PASS() first calls the identify
4081 * routines for any drivers that probe at the current pass. Then it
4082 * walks the list of devices for this bus. If a device is already
4083 * attached, then it calls BUS_NEW_PASS() on that device. If the
4084 * device is not already attached, it attempts to attach a driver to
4088 bus_generic_new_pass(device_t dev)
4095 TAILQ_FOREACH(dl, &dc->drivers, link) {
4096 if (dl->pass == bus_current_pass)
4097 DEVICE_IDENTIFY(dl->driver, dev);
4099 TAILQ_FOREACH(child, &dev->children, link) {
4100 if (child->state >= DS_ATTACHED)
4101 BUS_NEW_PASS(child);
4102 else if (child->state == DS_NOTPRESENT)
4103 device_probe_and_attach(child);
4108 * @brief Helper function for implementing BUS_SETUP_INTR().
4110 * This simple implementation of BUS_SETUP_INTR() simply calls the
4111 * BUS_SETUP_INTR() method of the parent of @p dev.
4114 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4115 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4118 /* Propagate up the bus hierarchy until someone handles it. */
4120 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4121 filter, intr, arg, cookiep));
4126 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4128 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4129 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4132 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4135 /* Propagate up the bus hierarchy until someone handles it. */
4137 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4142 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4144 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4145 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4148 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4150 /* Propagate up the bus hierarchy until someone handles it. */
4152 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4157 * @brief Helper function for implementing BUS_RESUME_INTR().
4159 * This simple implementation of BUS_RESUME_INTR() simply calls the
4160 * BUS_RESUME_INTR() method of the parent of @p dev.
4163 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4165 /* Propagate up the bus hierarchy until someone handles it. */
4167 return (BUS_RESUME_INTR(dev->parent, child, irq));
4172 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4174 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4175 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4178 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4179 struct resource *r, rman_res_t start, rman_res_t end)
4181 /* Propagate up the bus hierarchy until someone handles it. */
4183 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4189 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4191 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4192 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4195 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4196 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4198 /* Propagate up the bus hierarchy until someone handles it. */
4200 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4201 start, end, count, flags));
4206 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4208 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4209 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4212 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4215 /* Propagate up the bus hierarchy until someone handles it. */
4217 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4223 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4225 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4226 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4229 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4232 /* Propagate up the bus hierarchy until someone handles it. */
4234 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4240 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4242 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4243 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4246 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4247 int rid, struct resource *r)
4249 /* Propagate up the bus hierarchy until someone handles it. */
4251 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4257 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4259 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4260 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4263 bus_generic_map_resource(device_t dev, device_t child, int type,
4264 struct resource *r, struct resource_map_request *args,
4265 struct resource_map *map)
4267 /* Propagate up the bus hierarchy until someone handles it. */
4269 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4275 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4277 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4278 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4281 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4282 struct resource *r, struct resource_map *map)
4284 /* Propagate up the bus hierarchy until someone handles it. */
4286 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4291 * @brief Helper function for implementing BUS_BIND_INTR().
4293 * This simple implementation of BUS_BIND_INTR() simply calls the
4294 * BUS_BIND_INTR() method of the parent of @p dev.
4297 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4300 /* Propagate up the bus hierarchy until someone handles it. */
4302 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4307 * @brief Helper function for implementing BUS_CONFIG_INTR().
4309 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4310 * BUS_CONFIG_INTR() method of the parent of @p dev.
4313 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4314 enum intr_polarity pol)
4316 /* Propagate up the bus hierarchy until someone handles it. */
4318 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4323 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4325 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4326 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4329 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4330 void *cookie, const char *descr)
4332 /* Propagate up the bus hierarchy until someone handles it. */
4334 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4340 * @brief Helper function for implementing BUS_GET_CPUS().
4342 * This simple implementation of BUS_GET_CPUS() simply calls the
4343 * BUS_GET_CPUS() method of the parent of @p dev.
4346 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4347 size_t setsize, cpuset_t *cpuset)
4349 /* Propagate up the bus hierarchy until someone handles it. */
4350 if (dev->parent != NULL)
4351 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4356 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4358 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4359 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4362 bus_generic_get_dma_tag(device_t dev, device_t child)
4364 /* Propagate up the bus hierarchy until someone handles it. */
4365 if (dev->parent != NULL)
4366 return (BUS_GET_DMA_TAG(dev->parent, child));
4371 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4373 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4374 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4377 bus_generic_get_bus_tag(device_t dev, device_t child)
4379 /* Propagate up the bus hierarchy until someone handles it. */
4380 if (dev->parent != NULL)
4381 return (BUS_GET_BUS_TAG(dev->parent, child));
4382 return ((bus_space_tag_t)0);
4386 * @brief Helper function for implementing BUS_GET_RESOURCE().
4388 * This implementation of BUS_GET_RESOURCE() uses the
4389 * resource_list_find() function to do most of the work. It calls
4390 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4394 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4395 rman_res_t *startp, rman_res_t *countp)
4397 struct resource_list * rl = NULL;
4398 struct resource_list_entry * rle = NULL;
4400 rl = BUS_GET_RESOURCE_LIST(dev, child);
4404 rle = resource_list_find(rl, type, rid);
4409 *startp = rle->start;
4411 *countp = rle->count;
4417 * @brief Helper function for implementing BUS_SET_RESOURCE().
4419 * This implementation of BUS_SET_RESOURCE() uses the
4420 * resource_list_add() function to do most of the work. It calls
4421 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4425 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4426 rman_res_t start, rman_res_t count)
4428 struct resource_list * rl = NULL;
4430 rl = BUS_GET_RESOURCE_LIST(dev, child);
4434 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4440 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4442 * This implementation of BUS_DELETE_RESOURCE() uses the
4443 * resource_list_delete() function to do most of the work. It calls
4444 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4448 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4450 struct resource_list * rl = NULL;
4452 rl = BUS_GET_RESOURCE_LIST(dev, child);
4456 resource_list_delete(rl, type, rid);
4462 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4464 * This implementation of BUS_RELEASE_RESOURCE() uses the
4465 * resource_list_release() function to do most of the work. It calls
4466 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4469 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4470 int rid, struct resource *r)
4472 struct resource_list * rl = NULL;
4474 if (device_get_parent(child) != dev)
4475 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4478 rl = BUS_GET_RESOURCE_LIST(dev, child);
4482 return (resource_list_release(rl, dev, child, type, rid, r));
4486 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4488 * This implementation of BUS_ALLOC_RESOURCE() uses the
4489 * resource_list_alloc() function to do most of the work. It calls
4490 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4493 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4494 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4496 struct resource_list * rl = NULL;
4498 if (device_get_parent(child) != dev)
4499 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4500 type, rid, start, end, count, flags));
4502 rl = BUS_GET_RESOURCE_LIST(dev, child);
4506 return (resource_list_alloc(rl, dev, child, type, rid,
4507 start, end, count, flags));
4511 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4513 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4514 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4517 bus_generic_child_present(device_t dev, device_t child)
4519 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4523 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4526 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4532 * @brief Helper function for implementing BUS_RESCAN().
4534 * This null implementation of BUS_RESCAN() always fails to indicate
4535 * the bus does not support rescanning.
4538 bus_null_rescan(device_t dev)
4544 * Some convenience functions to make it easier for drivers to use the
4545 * resource-management functions. All these really do is hide the
4546 * indirection through the parent's method table, making for slightly
4547 * less-wordy code. In the future, it might make sense for this code
4548 * to maintain some sort of a list of resources allocated by each device.
4552 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4553 struct resource **res)
4557 for (i = 0; rs[i].type != -1; i++)
4559 for (i = 0; rs[i].type != -1; i++) {
4560 res[i] = bus_alloc_resource_any(dev,
4561 rs[i].type, &rs[i].rid, rs[i].flags);
4562 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4563 bus_release_resources(dev, rs, res);
4571 bus_release_resources(device_t dev, const struct resource_spec *rs,
4572 struct resource **res)
4576 for (i = 0; rs[i].type != -1; i++)
4577 if (res[i] != NULL) {
4578 bus_release_resource(
4579 dev, rs[i].type, rs[i].rid, res[i]);
4585 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4587 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4591 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4592 rman_res_t end, rman_res_t count, u_int flags)
4594 struct resource *res;
4596 if (dev->parent == NULL)
4598 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4604 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4606 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4610 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4613 if (dev->parent == NULL)
4615 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4619 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4621 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4625 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4627 if (dev->parent == NULL)
4629 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4633 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4635 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4639 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4641 if (dev->parent == NULL)
4643 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4647 * @brief Wrapper function for BUS_MAP_RESOURCE().
4649 * This function simply calls the BUS_MAP_RESOURCE() method of the
4653 bus_map_resource(device_t dev, int type, struct resource *r,
4654 struct resource_map_request *args, struct resource_map *map)
4656 if (dev->parent == NULL)
4658 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4662 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4664 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4668 bus_unmap_resource(device_t dev, int type, struct resource *r,
4669 struct resource_map *map)
4671 if (dev->parent == NULL)
4673 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4677 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4679 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4683 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4687 if (dev->parent == NULL)
4689 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4694 * @brief Wrapper function for BUS_SETUP_INTR().
4696 * This function simply calls the BUS_SETUP_INTR() method of the
4700 bus_setup_intr(device_t dev, struct resource *r, int flags,
4701 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4705 if (dev->parent == NULL)
4707 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4711 if (handler != NULL && !(flags & INTR_MPSAFE))
4712 device_printf(dev, "[GIANT-LOCKED]\n");
4717 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4719 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4723 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4725 if (dev->parent == NULL)
4727 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4731 * @brief Wrapper function for BUS_SUSPEND_INTR().
4733 * This function simply calls the BUS_SUSPEND_INTR() method of the
4737 bus_suspend_intr(device_t dev, struct resource *r)
4739 if (dev->parent == NULL)
4741 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4745 * @brief Wrapper function for BUS_RESUME_INTR().
4747 * This function simply calls the BUS_RESUME_INTR() method of the
4751 bus_resume_intr(device_t dev, struct resource *r)
4753 if (dev->parent == NULL)
4755 return (BUS_RESUME_INTR(dev->parent, dev, r));
4759 * @brief Wrapper function for BUS_BIND_INTR().
4761 * This function simply calls the BUS_BIND_INTR() method of the
4765 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4767 if (dev->parent == NULL)
4769 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4773 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4775 * This function first formats the requested description into a
4776 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4777 * the parent of @p dev.
4780 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4781 const char *fmt, ...)
4784 char descr[MAXCOMLEN + 1];
4786 if (dev->parent == NULL)
4789 vsnprintf(descr, sizeof(descr), fmt, ap);
4791 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4795 * @brief Wrapper function for BUS_SET_RESOURCE().
4797 * This function simply calls the BUS_SET_RESOURCE() method of the
4801 bus_set_resource(device_t dev, int type, int rid,
4802 rman_res_t start, rman_res_t count)
4804 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4809 * @brief Wrapper function for BUS_GET_RESOURCE().
4811 * This function simply calls the BUS_GET_RESOURCE() method of the
4815 bus_get_resource(device_t dev, int type, int rid,
4816 rman_res_t *startp, rman_res_t *countp)
4818 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4823 * @brief Wrapper function for BUS_GET_RESOURCE().
4825 * This function simply calls the BUS_GET_RESOURCE() method of the
4826 * parent of @p dev and returns the start value.
4829 bus_get_resource_start(device_t dev, int type, int rid)
4835 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4843 * @brief Wrapper function for BUS_GET_RESOURCE().
4845 * This function simply calls the BUS_GET_RESOURCE() method of the
4846 * parent of @p dev and returns the count value.
4849 bus_get_resource_count(device_t dev, int type, int rid)
4855 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4863 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4865 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4869 bus_delete_resource(device_t dev, int type, int rid)
4871 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4875 * @brief Wrapper function for BUS_CHILD_PRESENT().
4877 * This function simply calls the BUS_CHILD_PRESENT() method of the
4881 bus_child_present(device_t child)
4883 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4887 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4889 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4893 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4897 parent = device_get_parent(child);
4898 if (parent == NULL) {
4902 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4906 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4908 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4912 bus_child_location_str(device_t child, char *buf, size_t buflen)
4916 parent = device_get_parent(child);
4917 if (parent == NULL) {
4921 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4925 * @brief Wrapper function for BUS_GET_CPUS().
4927 * This function simply calls the BUS_GET_CPUS() method of the
4931 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4935 parent = device_get_parent(dev);
4938 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4942 * @brief Wrapper function for BUS_GET_DMA_TAG().
4944 * This function simply calls the BUS_GET_DMA_TAG() method of the
4948 bus_get_dma_tag(device_t dev)
4952 parent = device_get_parent(dev);
4955 return (BUS_GET_DMA_TAG(parent, dev));
4959 * @brief Wrapper function for BUS_GET_BUS_TAG().
4961 * This function simply calls the BUS_GET_BUS_TAG() method of the
4965 bus_get_bus_tag(device_t dev)
4969 parent = device_get_parent(dev);
4971 return ((bus_space_tag_t)0);
4972 return (BUS_GET_BUS_TAG(parent, dev));
4976 * @brief Wrapper function for BUS_GET_DOMAIN().
4978 * This function simply calls the BUS_GET_DOMAIN() method of the
4982 bus_get_domain(device_t dev, int *domain)
4984 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4987 /* Resume all devices and then notify userland that we're up again. */
4989 root_resume(device_t dev)
4993 error = bus_generic_resume(dev);
4995 devctl_notify("kern", "power", "resume", NULL);
5000 root_print_child(device_t dev, device_t child)
5004 retval += bus_print_child_header(dev, child);
5005 retval += printf("\n");
5011 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5012 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5015 * If an interrupt mapping gets to here something bad has happened.
5017 panic("root_setup_intr");
5021 * If we get here, assume that the device is permanent and really is
5022 * present in the system. Removable bus drivers are expected to intercept
5023 * this call long before it gets here. We return -1 so that drivers that
5024 * really care can check vs -1 or some ERRNO returned higher in the food
5028 root_child_present(device_t dev, device_t child)
5034 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5039 /* Default to returning the set of all CPUs. */
5040 if (setsize != sizeof(cpuset_t))
5049 static kobj_method_t root_methods[] = {
5050 /* Device interface */
5051 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5052 KOBJMETHOD(device_suspend, bus_generic_suspend),
5053 KOBJMETHOD(device_resume, root_resume),
5056 KOBJMETHOD(bus_print_child, root_print_child),
5057 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5058 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5059 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5060 KOBJMETHOD(bus_child_present, root_child_present),
5061 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5066 static driver_t root_driver = {
5073 devclass_t root_devclass;
5076 root_bus_module_handler(module_t mod, int what, void* arg)
5080 TAILQ_INIT(&bus_data_devices);
5081 kobj_class_compile((kobj_class_t) &root_driver);
5082 root_bus = make_device(NULL, "root", 0);
5083 root_bus->desc = "System root bus";
5084 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5085 root_bus->driver = &root_driver;
5086 root_bus->state = DS_ATTACHED;
5087 root_devclass = devclass_find_internal("root", NULL, FALSE);
5092 device_shutdown(root_bus);
5095 return (EOPNOTSUPP);
5101 static moduledata_t root_bus_mod = {
5103 root_bus_module_handler,
5106 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5109 * @brief Automatically configure devices
5111 * This function begins the autoconfiguration process by calling
5112 * device_probe_and_attach() for each child of the @c root0 device.
5115 root_bus_configure(void)
5119 /* Eventually this will be split up, but this is sufficient for now. */
5120 bus_set_pass(BUS_PASS_DEFAULT);
5124 * @brief Module handler for registering device drivers
5126 * This module handler is used to automatically register device
5127 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5128 * devclass_add_driver() for the driver described by the
5129 * driver_module_data structure pointed to by @p arg
5132 driver_module_handler(module_t mod, int what, void *arg)
5134 struct driver_module_data *dmd;
5135 devclass_t bus_devclass;
5136 kobj_class_t driver;
5139 dmd = (struct driver_module_data *)arg;
5140 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5145 if (dmd->dmd_chainevh)
5146 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5148 pass = dmd->dmd_pass;
5149 driver = dmd->dmd_driver;
5150 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5151 DRIVERNAME(driver), dmd->dmd_busname, pass));
5152 error = devclass_add_driver(bus_devclass, driver, pass,
5157 PDEBUG(("Unloading module: driver %s from bus %s",
5158 DRIVERNAME(dmd->dmd_driver),
5160 error = devclass_delete_driver(bus_devclass,
5163 if (!error && dmd->dmd_chainevh)
5164 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5167 PDEBUG(("Quiesce module: driver %s from bus %s",
5168 DRIVERNAME(dmd->dmd_driver),
5170 error = devclass_quiesce_driver(bus_devclass,
5173 if (!error && dmd->dmd_chainevh)
5174 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5185 * @brief Enumerate all hinted devices for this bus.
5187 * Walks through the hints for this bus and calls the bus_hinted_child
5188 * routine for each one it fines. It searches first for the specific
5189 * bus that's being probed for hinted children (eg isa0), and then for
5190 * generic children (eg isa).
5192 * @param dev bus device to enumerate
5195 bus_enumerate_hinted_children(device_t bus)
5198 const char *dname, *busname;
5202 * enumerate all devices on the specific bus
5204 busname = device_get_nameunit(bus);
5206 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5207 BUS_HINTED_CHILD(bus, dname, dunit);
5210 * and all the generic ones.
5212 busname = device_get_name(bus);
5214 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5215 BUS_HINTED_CHILD(bus, dname, dunit);
5220 /* the _short versions avoid iteration by not calling anything that prints
5221 * more than oneliners. I love oneliners.
5225 print_device_short(device_t dev, int indent)
5230 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5231 dev->unit, dev->desc,
5232 (dev->parent? "":"no "),
5233 (TAILQ_EMPTY(&dev->children)? "no ":""),
5234 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5235 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5236 (dev->flags&DF_WILDCARD? "wildcard,":""),
5237 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5238 (dev->flags&DF_REBID? "rebiddable,":""),
5239 (dev->flags&DF_SUSPENDED? "suspended,":""),
5240 (dev->ivars? "":"no "),
5241 (dev->softc? "":"no "),
5246 print_device(device_t dev, int indent)
5251 print_device_short(dev, indent);
5253 indentprintf(("Parent:\n"));
5254 print_device_short(dev->parent, indent+1);
5255 indentprintf(("Driver:\n"));
5256 print_driver_short(dev->driver, indent+1);
5257 indentprintf(("Devclass:\n"));
5258 print_devclass_short(dev->devclass, indent+1);
5262 print_device_tree_short(device_t dev, int indent)
5263 /* print the device and all its children (indented) */
5270 print_device_short(dev, indent);
5272 TAILQ_FOREACH(child, &dev->children, link) {
5273 print_device_tree_short(child, indent+1);
5278 print_device_tree(device_t dev, int indent)
5279 /* print the device and all its children (indented) */
5286 print_device(dev, indent);
5288 TAILQ_FOREACH(child, &dev->children, link) {
5289 print_device_tree(child, indent+1);
5294 print_driver_short(driver_t *driver, int indent)
5299 indentprintf(("driver %s: softc size = %zd\n",
5300 driver->name, driver->size));
5304 print_driver(driver_t *driver, int indent)
5309 print_driver_short(driver, indent);
5313 print_driver_list(driver_list_t drivers, int indent)
5315 driverlink_t driver;
5317 TAILQ_FOREACH(driver, &drivers, link) {
5318 print_driver(driver->driver, indent);
5323 print_devclass_short(devclass_t dc, int indent)
5328 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5332 print_devclass(devclass_t dc, int indent)
5339 print_devclass_short(dc, indent);
5340 indentprintf(("Drivers:\n"));
5341 print_driver_list(dc->drivers, indent+1);
5343 indentprintf(("Devices:\n"));
5344 for (i = 0; i < dc->maxunit; i++)
5346 print_device(dc->devices[i], indent+1);
5350 print_devclass_list_short(void)
5354 printf("Short listing of devclasses, drivers & devices:\n");
5355 TAILQ_FOREACH(dc, &devclasses, link) {
5356 print_devclass_short(dc, 0);
5361 print_devclass_list(void)
5365 printf("Full listing of devclasses, drivers & devices:\n");
5366 TAILQ_FOREACH(dc, &devclasses, link) {
5367 print_devclass(dc, 0);
5374 * User-space access to the device tree.
5376 * We implement a small set of nodes:
5378 * hw.bus Single integer read method to obtain the
5379 * current generation count.
5380 * hw.bus.devices Reads the entire device tree in flat space.
5381 * hw.bus.rman Resource manager interface
5383 * We might like to add the ability to scan devclasses and/or drivers to
5384 * determine what else is currently loaded/available.
5388 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5390 struct u_businfo ubus;
5392 ubus.ub_version = BUS_USER_VERSION;
5393 ubus.ub_generation = bus_data_generation;
5395 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5397 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5398 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5399 "bus-related data");
5402 sysctl_devices(SYSCTL_HANDLER_ARGS)
5404 int *name = (int *)arg1;
5405 u_int namelen = arg2;
5408 struct u_device *udev;
5415 if (bus_data_generation_check(name[0]))
5421 * Scan the list of devices, looking for the requested index.
5423 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5431 * Populate the return item, careful not to overflow the buffer.
5433 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5436 udev->dv_handle = (uintptr_t)dev;
5437 udev->dv_parent = (uintptr_t)dev->parent;
5438 udev->dv_devflags = dev->devflags;
5439 udev->dv_flags = dev->flags;
5440 udev->dv_state = dev->state;
5441 walker = udev->dv_fields;
5442 ep = walker + sizeof(udev->dv_fields);
5444 if ((src) == NULL) \
5447 strlcpy(walker, (src), ep - walker); \
5448 walker += strlen(walker) + 1; \
5456 CP(dev->driver != NULL ? dev->driver->name : NULL);
5457 bus_child_pnpinfo_str(dev, walker, ep - walker);
5458 walker += strlen(walker) + 1;
5461 bus_child_location_str(dev, walker, ep - walker);
5462 walker += strlen(walker) + 1;
5468 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5473 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5474 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5475 "system device tree");
5478 bus_data_generation_check(int generation)
5480 if (generation != bus_data_generation)
5483 /* XXX generate optimised lists here? */
5488 bus_data_generation_update(void)
5490 atomic_add_int(&bus_data_generation, 1);
5494 bus_free_resource(device_t dev, int type, struct resource *r)
5498 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5502 device_lookup_by_name(const char *name)
5506 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5507 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5514 * /dev/devctl2 implementation. The existing /dev/devctl device has
5515 * implicit semantics on open, so it could not be reused for this.
5516 * Another option would be to call this /dev/bus?
5519 find_device(struct devreq *req, device_t *devp)
5524 * First, ensure that the name is nul terminated.
5526 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5530 * Second, try to find an attached device whose name matches
5533 dev = device_lookup_by_name(req->dr_name);
5539 /* Finally, give device enumerators a chance. */
5541 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5549 driver_exists(device_t bus, const char *driver)
5553 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5554 if (devclass_find_driver_internal(dc, driver) != NULL)
5561 device_gen_nomatch(device_t dev)
5565 if (dev->flags & DF_NEEDNOMATCH &&
5566 dev->state == DS_NOTPRESENT) {
5567 BUS_PROBE_NOMATCH(dev->parent, dev);
5569 dev->flags |= DF_DONENOMATCH;
5571 dev->flags &= ~DF_NEEDNOMATCH;
5572 TAILQ_FOREACH(child, &dev->children, link) {
5573 device_gen_nomatch(child);
5578 device_do_deferred_actions(void)
5584 * Walk through the devclasses to find all the drivers we've tagged as
5585 * deferred during the freeze and call the driver added routines. They
5586 * have already been added to the lists in the background, so the driver
5587 * added routines that trigger a probe will have all the right bidders
5588 * for the probe auction.
5590 TAILQ_FOREACH(dc, &devclasses, link) {
5591 TAILQ_FOREACH(dl, &dc->drivers, link) {
5592 if (dl->flags & DL_DEFERRED_PROBE) {
5593 devclass_driver_added(dc, dl->driver);
5594 dl->flags &= ~DL_DEFERRED_PROBE;
5600 * We also defer no-match events during a freeze. Walk the tree and
5601 * generate all the pent-up events that are still relevant.
5603 device_gen_nomatch(root_bus);
5604 bus_data_generation_update();
5608 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5615 /* Locate the device to control. */
5617 req = (struct devreq *)data;
5625 case DEV_SET_DRIVER:
5626 case DEV_CLEAR_DRIVER:
5630 error = priv_check(td, PRIV_DRIVER);
5632 error = find_device(req, &dev);
5636 error = priv_check(td, PRIV_DRIVER);
5647 /* Perform the requested operation. */
5650 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5652 else if (!device_is_enabled(dev))
5655 error = device_probe_and_attach(dev);
5658 if (!device_is_attached(dev)) {
5662 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5663 error = device_quiesce(dev);
5667 error = device_detach(dev);
5670 if (device_is_enabled(dev)) {
5676 * If the device has been probed but not attached (e.g.
5677 * when it has been disabled by a loader hint), just
5678 * attach the device rather than doing a full probe.
5681 if (device_is_alive(dev)) {
5683 * If the device was disabled via a hint, clear
5686 if (resource_disabled(dev->driver->name, dev->unit))
5687 resource_unset_value(dev->driver->name,
5688 dev->unit, "disabled");
5689 error = device_attach(dev);
5691 error = device_probe_and_attach(dev);
5694 if (!device_is_enabled(dev)) {
5699 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5700 error = device_quiesce(dev);
5706 * Force DF_FIXEDCLASS on around detach to preserve
5707 * the existing name.
5710 dev->flags |= DF_FIXEDCLASS;
5711 error = device_detach(dev);
5712 if (!(old & DF_FIXEDCLASS))
5713 dev->flags &= ~DF_FIXEDCLASS;
5715 device_disable(dev);
5718 if (device_is_suspended(dev)) {
5722 if (device_get_parent(dev) == NULL) {
5726 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5729 if (!device_is_suspended(dev)) {
5733 if (device_get_parent(dev) == NULL) {
5737 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5739 case DEV_SET_DRIVER: {
5743 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5746 if (driver[0] == '\0') {
5750 if (dev->devclass != NULL &&
5751 strcmp(driver, dev->devclass->name) == 0)
5752 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5756 * Scan drivers for this device's bus looking for at
5757 * least one matching driver.
5759 if (dev->parent == NULL) {
5763 if (!driver_exists(dev->parent, driver)) {
5767 dc = devclass_create(driver);
5773 /* Detach device if necessary. */
5774 if (device_is_attached(dev)) {
5775 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5776 error = device_detach(dev);
5783 /* Clear any previously-fixed device class and unit. */
5784 if (dev->flags & DF_FIXEDCLASS)
5785 devclass_delete_device(dev->devclass, dev);
5786 dev->flags |= DF_WILDCARD;
5789 /* Force the new device class. */
5790 error = devclass_add_device(dc, dev);
5793 dev->flags |= DF_FIXEDCLASS;
5794 error = device_probe_and_attach(dev);
5797 case DEV_CLEAR_DRIVER:
5798 if (!(dev->flags & DF_FIXEDCLASS)) {
5802 if (device_is_attached(dev)) {
5803 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5804 error = device_detach(dev);
5811 dev->flags &= ~DF_FIXEDCLASS;
5812 dev->flags |= DF_WILDCARD;
5813 devclass_delete_device(dev->devclass, dev);
5814 error = device_probe_and_attach(dev);
5817 if (!device_is_attached(dev)) {
5821 error = BUS_RESCAN(dev);
5826 parent = device_get_parent(dev);
5827 if (parent == NULL) {
5831 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5832 if (bus_child_present(dev) != 0) {
5838 error = device_delete_child(parent, dev);
5845 device_frozen = true;
5851 device_do_deferred_actions();
5852 device_frozen = false;
5856 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5860 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5868 static struct cdevsw devctl2_cdevsw = {
5869 .d_version = D_VERSION,
5870 .d_ioctl = devctl2_ioctl,
5871 .d_name = "devctl2",
5877 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5878 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5882 * APIs to manage deprecation and obsolescence.
5884 static int obsolete_panic = 0;
5885 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5886 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5887 "2 = if deprecated)");
5890 gone_panic(int major, int running, const char *msg)
5892 switch (obsolete_panic)
5897 if (running < major)
5906 _gone_in(int major, const char *msg)
5908 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5909 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5910 printf("Obsolete code will be removed soon: %s\n", msg);
5912 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5917 _gone_in_dev(device_t dev, int major, const char *msg)
5919 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5920 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5922 "Obsolete code will be removed soon: %s\n", msg);
5925 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5930 DB_SHOW_COMMAND(device, db_show_device)
5937 dev = (device_t)addr;
5939 db_printf("name: %s\n", device_get_nameunit(dev));
5940 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5941 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5942 db_printf(" addr: %p\n", dev);
5943 db_printf(" parent: %p\n", dev->parent);
5944 db_printf(" softc: %p\n", dev->softc);
5945 db_printf(" ivars: %p\n", dev->ivars);
5948 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5952 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5953 db_show_device((db_expr_t)dev, true, count, modif);