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. One could also further argue that the
369 * sysctl interface that we have not might more properly be an ioctl
370 * interface, but at this stage of the game, I'm not inclined to rock that
373 * I'm also not sure that the SIGIO support is done correctly or not, as
374 * I copied it from a driver that had SIGIO support that likely hasn't been
375 * tested since 3.4 or 2.2.8!
378 /* Deprecated way to adjust queue length */
379 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
380 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
381 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
382 "devctl disable -- deprecated");
384 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
385 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
386 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
387 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
388 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
390 static d_open_t devopen;
391 static d_close_t devclose;
392 static d_read_t devread;
393 static d_ioctl_t devioctl;
394 static d_poll_t devpoll;
395 static d_kqfilter_t devkqfilter;
397 static struct cdevsw dev_cdevsw = {
398 .d_version = D_VERSION,
404 .d_kqfilter = devkqfilter,
408 struct dev_event_info
411 TAILQ_ENTRY(dev_event_info) dei_link;
414 TAILQ_HEAD(devq, dev_event_info);
416 static struct dev_softc
429 static void filt_devctl_detach(struct knote *kn);
430 static int filt_devctl_read(struct knote *kn, long hint);
432 struct filterops devctl_rfiltops = {
434 .f_detach = filt_devctl_detach,
435 .f_event = filt_devctl_read,
438 static struct cdev *devctl_dev;
443 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
444 UID_ROOT, GID_WHEEL, 0600, "devctl");
445 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
446 cv_init(&devsoftc.cv, "dev cv");
447 TAILQ_INIT(&devsoftc.devq);
448 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
453 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
455 mtx_lock(&devsoftc.mtx);
456 if (devsoftc.inuse) {
457 mtx_unlock(&devsoftc.mtx);
462 mtx_unlock(&devsoftc.mtx);
467 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
469 mtx_lock(&devsoftc.mtx);
471 devsoftc.nonblock = 0;
473 cv_broadcast(&devsoftc.cv);
474 funsetown(&devsoftc.sigio);
475 mtx_unlock(&devsoftc.mtx);
480 * The read channel for this device is used to report changes to
481 * userland in realtime. We are required to free the data as well as
482 * the n1 object because we allocate them separately. Also note that
483 * we return one record at a time. If you try to read this device a
484 * character at a time, you will lose the rest of the data. Listening
485 * programs are expected to cope.
488 devread(struct cdev *dev, struct uio *uio, int ioflag)
490 struct dev_event_info *n1;
493 mtx_lock(&devsoftc.mtx);
494 while (TAILQ_EMPTY(&devsoftc.devq)) {
495 if (devsoftc.nonblock) {
496 mtx_unlock(&devsoftc.mtx);
499 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
502 * Need to translate ERESTART to EINTR here? -- jake
504 mtx_unlock(&devsoftc.mtx);
508 n1 = TAILQ_FIRST(&devsoftc.devq);
509 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
511 mtx_unlock(&devsoftc.mtx);
512 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
513 free(n1->dei_data, M_BUS);
519 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
524 devsoftc.nonblock = 1;
526 devsoftc.nonblock = 0;
535 return fsetown(*(int *)data, &devsoftc.sigio);
537 *(int *)data = fgetown(&devsoftc.sigio);
540 /* (un)Support for other fcntl() calls. */
551 devpoll(struct cdev *dev, int events, struct thread *td)
555 mtx_lock(&devsoftc.mtx);
556 if (events & (POLLIN | POLLRDNORM)) {
557 if (!TAILQ_EMPTY(&devsoftc.devq))
558 revents = events & (POLLIN | POLLRDNORM);
560 selrecord(td, &devsoftc.sel);
562 mtx_unlock(&devsoftc.mtx);
568 devkqfilter(struct cdev *dev, struct knote *kn)
572 if (kn->kn_filter == EVFILT_READ) {
573 kn->kn_fop = &devctl_rfiltops;
574 knlist_add(&devsoftc.sel.si_note, kn, 0);
582 filt_devctl_detach(struct knote *kn)
584 knlist_remove(&devsoftc.sel.si_note, kn, 0);
588 filt_devctl_read(struct knote *kn, long hint)
590 kn->kn_data = devsoftc.queued;
591 return (kn->kn_data != 0);
595 * @brief Return whether the userland process is running
598 devctl_process_running(void)
600 return (devsoftc.inuse == 1);
604 * @brief Queue data to be read from the devctl device
606 * Generic interface to queue data to the devctl device. It is
607 * assumed that @p data is properly formatted. It is further assumed
608 * that @p data is allocated using the M_BUS malloc type.
611 devctl_queue_data_f(char *data, int flags)
613 struct dev_event_info *n1 = NULL, *n2 = NULL;
615 if (strlen(data) == 0)
617 if (devctl_queue_length == 0)
619 n1 = malloc(sizeof(*n1), M_BUS, flags);
623 mtx_lock(&devsoftc.mtx);
624 if (devctl_queue_length == 0) {
625 mtx_unlock(&devsoftc.mtx);
626 free(n1->dei_data, M_BUS);
630 /* Leave at least one spot in the queue... */
631 while (devsoftc.queued > devctl_queue_length - 1) {
632 n2 = TAILQ_FIRST(&devsoftc.devq);
633 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
634 free(n2->dei_data, M_BUS);
638 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
640 cv_broadcast(&devsoftc.cv);
641 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
642 mtx_unlock(&devsoftc.mtx);
643 selwakeup(&devsoftc.sel);
644 if (devsoftc.async && devsoftc.sigio != NULL)
645 pgsigio(&devsoftc.sigio, SIGIO, 0);
649 * We have to free data on all error paths since the caller
650 * assumes it will be free'd when this item is dequeued.
657 devctl_queue_data(char *data)
659 devctl_queue_data_f(data, M_NOWAIT);
663 * @brief Send a 'notification' to userland, using standard ways
666 devctl_notify_f(const char *system, const char *subsystem, const char *type,
667 const char *data, int flags)
673 return; /* BOGUS! Must specify system. */
674 if (subsystem == NULL)
675 return; /* BOGUS! Must specify subsystem. */
677 return; /* BOGUS! Must specify type. */
678 len += strlen(" system=") + strlen(system);
679 len += strlen(" subsystem=") + strlen(subsystem);
680 len += strlen(" type=") + strlen(type);
681 /* add in the data message plus newline. */
684 len += 3; /* '!', '\n', and NUL */
685 msg = malloc(len, M_BUS, flags);
687 return; /* Drop it on the floor */
689 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
690 system, subsystem, type, data);
692 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
693 system, subsystem, type);
694 devctl_queue_data_f(msg, flags);
698 devctl_notify(const char *system, const char *subsystem, const char *type,
701 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
705 * Common routine that tries to make sending messages as easy as possible.
706 * We allocate memory for the data, copy strings into that, but do not
707 * free it unless there's an error. The dequeue part of the driver should
708 * free the data. We don't send data when the device is disabled. We do
709 * send data, even when we have no listeners, because we wish to avoid
710 * races relating to startup and restart of listening applications.
712 * devaddq is designed to string together the type of event, with the
713 * object of that event, plus the plug and play info and location info
714 * for that event. This is likely most useful for devices, but less
715 * useful for other consumers of this interface. Those should use
716 * the devctl_queue_data() interface instead.
719 devaddq(const char *type, const char *what, device_t dev)
726 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
728 data = malloc(1024, M_BUS, M_NOWAIT);
732 /* get the bus specific location of this device */
733 loc = malloc(1024, M_BUS, M_NOWAIT);
737 bus_child_location_str(dev, loc, 1024);
739 /* Get the bus specific pnp info of this device */
740 pnp = malloc(1024, M_BUS, M_NOWAIT);
744 bus_child_pnpinfo_str(dev, pnp, 1024);
746 /* Get the parent of this device, or / if high enough in the tree. */
747 if (device_get_parent(dev) == NULL)
748 parstr = "."; /* Or '/' ? */
750 parstr = device_get_nameunit(device_get_parent(dev));
751 /* String it all together. */
752 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
756 devctl_queue_data(data);
766 * A device was added to the tree. We are called just after it successfully
767 * attaches (that is, probe and attach success for this device). No call
768 * is made if a device is merely parented into the tree. See devnomatch
769 * if probe fails. If attach fails, no notification is sent (but maybe
770 * we should have a different message for this).
773 devadded(device_t dev)
775 devaddq("+", device_get_nameunit(dev), dev);
779 * A device was removed from the tree. We are called just before this
783 devremoved(device_t dev)
785 devaddq("-", device_get_nameunit(dev), dev);
789 * Called when there's no match for this device. This is only called
790 * the first time that no match happens, so we don't keep getting this
791 * message. Should that prove to be undesirable, we can change it.
792 * This is called when all drivers that can attach to a given bus
793 * decline to accept this device. Other errors may not be detected.
796 devnomatch(device_t dev)
798 devaddq("?", "", dev);
802 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
804 struct dev_event_info *n1;
807 dis = (devctl_queue_length == 0);
808 error = sysctl_handle_int(oidp, &dis, 0, req);
809 if (error || !req->newptr)
811 if (mtx_initialized(&devsoftc.mtx))
812 mtx_lock(&devsoftc.mtx);
814 while (!TAILQ_EMPTY(&devsoftc.devq)) {
815 n1 = TAILQ_FIRST(&devsoftc.devq);
816 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
817 free(n1->dei_data, M_BUS);
821 devctl_queue_length = 0;
823 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
825 if (mtx_initialized(&devsoftc.mtx))
826 mtx_unlock(&devsoftc.mtx);
831 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
833 struct dev_event_info *n1;
836 q = devctl_queue_length;
837 error = sysctl_handle_int(oidp, &q, 0, req);
838 if (error || !req->newptr)
842 if (mtx_initialized(&devsoftc.mtx))
843 mtx_lock(&devsoftc.mtx);
844 devctl_queue_length = q;
845 while (devsoftc.queued > devctl_queue_length) {
846 n1 = TAILQ_FIRST(&devsoftc.devq);
847 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
848 free(n1->dei_data, M_BUS);
852 if (mtx_initialized(&devsoftc.mtx))
853 mtx_unlock(&devsoftc.mtx);
858 * @brief safely quotes strings that might have double quotes in them.
860 * The devctl protocol relies on quoted strings having matching quotes.
861 * This routine quotes any internal quotes so the resulting string
862 * is safe to pass to snprintf to construct, for example pnp info strings.
863 * Strings are always terminated with a NUL, but may be truncated if longer
864 * than @p len bytes after quotes.
866 * @param sb sbuf to place the characters into
867 * @param src Original buffer.
870 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
872 while (*src != '\0') {
873 if (*src == '"' || *src == '\\')
875 sbuf_putc(sb, *src++);
879 /* End of /dev/devctl code */
881 static TAILQ_HEAD(,device) bus_data_devices;
882 static int bus_data_generation = 1;
884 static kobj_method_t null_methods[] = {
888 DEFINE_CLASS(null, null_methods, 0);
891 * Bus pass implementation
894 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
895 int bus_current_pass = BUS_PASS_ROOT;
899 * @brief Register the pass level of a new driver attachment
901 * Register a new driver attachment's pass level. If no driver
902 * attachment with the same pass level has been added, then @p new
903 * will be added to the global passes list.
905 * @param new the new driver attachment
908 driver_register_pass(struct driverlink *new)
910 struct driverlink *dl;
912 /* We only consider pass numbers during boot. */
913 if (bus_current_pass == BUS_PASS_DEFAULT)
917 * Walk the passes list. If we already know about this pass
918 * then there is nothing to do. If we don't, then insert this
919 * driver link into the list.
921 TAILQ_FOREACH(dl, &passes, passlink) {
922 if (dl->pass < new->pass)
924 if (dl->pass == new->pass)
926 TAILQ_INSERT_BEFORE(dl, new, passlink);
929 TAILQ_INSERT_TAIL(&passes, new, passlink);
933 * @brief Raise the current bus pass
935 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
936 * method on the root bus to kick off a new device tree scan for each
937 * new pass level that has at least one driver.
940 bus_set_pass(int pass)
942 struct driverlink *dl;
944 if (bus_current_pass > pass)
945 panic("Attempt to lower bus pass level");
947 TAILQ_FOREACH(dl, &passes, passlink) {
948 /* Skip pass values below the current pass level. */
949 if (dl->pass <= bus_current_pass)
953 * Bail once we hit a driver with a pass level that is
960 * Raise the pass level to the next level and rescan
963 bus_current_pass = dl->pass;
964 BUS_NEW_PASS(root_bus);
968 * If there isn't a driver registered for the requested pass,
969 * then bus_current_pass might still be less than 'pass'. Set
970 * it to 'pass' in that case.
972 if (bus_current_pass < pass)
973 bus_current_pass = pass;
974 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
978 * Devclass implementation
981 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
985 * @brief Find or create a device class
987 * If a device class with the name @p classname exists, return it,
988 * otherwise if @p create is non-zero create and return a new device
991 * If @p parentname is non-NULL, the parent of the devclass is set to
992 * the devclass of that name.
994 * @param classname the devclass name to find or create
995 * @param parentname the parent devclass name or @c NULL
996 * @param create non-zero to create a devclass
999 devclass_find_internal(const char *classname, const char *parentname,
1004 PDEBUG(("looking for %s", classname));
1008 TAILQ_FOREACH(dc, &devclasses, link) {
1009 if (!strcmp(dc->name, classname))
1013 if (create && !dc) {
1014 PDEBUG(("creating %s", classname));
1015 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1016 M_BUS, M_NOWAIT | M_ZERO);
1020 dc->name = (char*) (dc + 1);
1021 strcpy(dc->name, classname);
1022 TAILQ_INIT(&dc->drivers);
1023 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1025 bus_data_generation_update();
1029 * If a parent class is specified, then set that as our parent so
1030 * that this devclass will support drivers for the parent class as
1031 * well. If the parent class has the same name don't do this though
1032 * as it creates a cycle that can trigger an infinite loop in
1033 * device_probe_child() if a device exists for which there is no
1036 if (parentname && dc && !dc->parent &&
1037 strcmp(classname, parentname) != 0) {
1038 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1039 dc->parent->flags |= DC_HAS_CHILDREN;
1046 * @brief Create a device class
1048 * If a device class with the name @p classname exists, return it,
1049 * otherwise create and return a new device class.
1051 * @param classname the devclass name to find or create
1054 devclass_create(const char *classname)
1056 return (devclass_find_internal(classname, NULL, TRUE));
1060 * @brief Find a device class
1062 * If a device class with the name @p classname exists, return it,
1063 * otherwise return @c NULL.
1065 * @param classname the devclass name to find
1068 devclass_find(const char *classname)
1070 return (devclass_find_internal(classname, NULL, FALSE));
1074 * @brief Register that a device driver has been added to a devclass
1076 * Register that a device driver has been added to a devclass. This
1077 * is called by devclass_add_driver to accomplish the recursive
1078 * notification of all the children classes of dc, as well as dc.
1079 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1082 * We do a full search here of the devclass list at each iteration
1083 * level to save storing children-lists in the devclass structure. If
1084 * we ever move beyond a few dozen devices doing this, we may need to
1087 * @param dc the devclass to edit
1088 * @param driver the driver that was just added
1091 devclass_driver_added(devclass_t dc, driver_t *driver)
1097 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1099 for (i = 0; i < dc->maxunit; i++)
1100 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1101 BUS_DRIVER_ADDED(dc->devices[i], driver);
1104 * Walk through the children classes. Since we only keep a
1105 * single parent pointer around, we walk the entire list of
1106 * devclasses looking for children. We set the
1107 * DC_HAS_CHILDREN flag when a child devclass is created on
1108 * the parent, so we only walk the list for those devclasses
1109 * that have children.
1111 if (!(dc->flags & DC_HAS_CHILDREN))
1114 TAILQ_FOREACH(dc, &devclasses, link) {
1115 if (dc->parent == parent)
1116 devclass_driver_added(dc, driver);
1121 * @brief Add a device driver to a device class
1123 * Add a device driver to a devclass. This is normally called
1124 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1125 * all devices in the devclass will be called to allow them to attempt
1126 * to re-probe any unmatched children.
1128 * @param dc the devclass to edit
1129 * @param driver the driver to register
1132 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1135 const char *parentname;
1137 PDEBUG(("%s", DRIVERNAME(driver)));
1139 /* Don't allow invalid pass values. */
1140 if (pass <= BUS_PASS_ROOT)
1143 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1148 * Compile the driver's methods. Also increase the reference count
1149 * so that the class doesn't get freed when the last instance
1150 * goes. This means we can safely use static methods and avoids a
1151 * double-free in devclass_delete_driver.
1153 kobj_class_compile((kobj_class_t) driver);
1156 * If the driver has any base classes, make the
1157 * devclass inherit from the devclass of the driver's
1158 * first base class. This will allow the system to
1159 * search for drivers in both devclasses for children
1160 * of a device using this driver.
1162 if (driver->baseclasses)
1163 parentname = driver->baseclasses[0]->name;
1166 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1168 dl->driver = driver;
1169 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1170 driver->refs++; /* XXX: kobj_mtx */
1172 driver_register_pass(dl);
1174 if (device_frozen) {
1175 dl->flags |= DL_DEFERRED_PROBE;
1177 devclass_driver_added(dc, driver);
1179 bus_data_generation_update();
1184 * @brief Register that a device driver has been deleted from a devclass
1186 * Register that a device driver has been removed from a devclass.
1187 * This is called by devclass_delete_driver to accomplish the
1188 * recursive notification of all the children classes of busclass, as
1189 * well as busclass. Each layer will attempt to detach the driver
1190 * from any devices that are children of the bus's devclass. The function
1191 * will return an error if a device fails to detach.
1193 * We do a full search here of the devclass list at each iteration
1194 * level to save storing children-lists in the devclass structure. If
1195 * we ever move beyond a few dozen devices doing this, we may need to
1198 * @param busclass the devclass of the parent bus
1199 * @param dc the devclass of the driver being deleted
1200 * @param driver the driver being deleted
1203 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1210 * Disassociate from any devices. We iterate through all the
1211 * devices in the devclass of the driver and detach any which are
1212 * using the driver and which have a parent in the devclass which
1213 * we are deleting from.
1215 * Note that since a driver can be in multiple devclasses, we
1216 * should not detach devices which are not children of devices in
1217 * the affected devclass.
1219 * If we're frozen, we don't generate NOMATCH events. Mark to
1222 for (i = 0; i < dc->maxunit; i++) {
1223 if (dc->devices[i]) {
1224 dev = dc->devices[i];
1225 if (dev->driver == driver && dev->parent &&
1226 dev->parent->devclass == busclass) {
1227 if ((error = device_detach(dev)) != 0)
1229 if (device_frozen) {
1230 dev->flags &= ~DF_DONENOMATCH;
1231 dev->flags |= DF_NEEDNOMATCH;
1233 BUS_PROBE_NOMATCH(dev->parent, dev);
1235 dev->flags |= DF_DONENOMATCH;
1242 * Walk through the children classes. Since we only keep a
1243 * single parent pointer around, we walk the entire list of
1244 * devclasses looking for children. We set the
1245 * DC_HAS_CHILDREN flag when a child devclass is created on
1246 * the parent, so we only walk the list for those devclasses
1247 * that have children.
1249 if (!(busclass->flags & DC_HAS_CHILDREN))
1252 TAILQ_FOREACH(busclass, &devclasses, link) {
1253 if (busclass->parent == parent) {
1254 error = devclass_driver_deleted(busclass, dc, driver);
1263 * @brief Delete a device driver from a device class
1265 * Delete a device driver from a devclass. This is normally called
1266 * automatically by DRIVER_MODULE().
1268 * If the driver is currently attached to any devices,
1269 * devclass_delete_driver() will first attempt to detach from each
1270 * device. If one of the detach calls fails, the driver will not be
1273 * @param dc the devclass to edit
1274 * @param driver the driver to unregister
1277 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1279 devclass_t dc = devclass_find(driver->name);
1283 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1289 * Find the link structure in the bus' list of drivers.
1291 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1292 if (dl->driver == driver)
1297 PDEBUG(("%s not found in %s list", driver->name,
1302 error = devclass_driver_deleted(busclass, dc, driver);
1306 TAILQ_REMOVE(&busclass->drivers, dl, link);
1311 if (driver->refs == 0)
1312 kobj_class_free((kobj_class_t) driver);
1314 bus_data_generation_update();
1319 * @brief Quiesces a set of device drivers from a device class
1321 * Quiesce a device driver from a devclass. This is normally called
1322 * automatically by DRIVER_MODULE().
1324 * If the driver is currently attached to any devices,
1325 * devclass_quiesece_driver() will first attempt to quiesce each
1328 * @param dc the devclass to edit
1329 * @param driver the driver to unregister
1332 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1334 devclass_t dc = devclass_find(driver->name);
1340 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1346 * Find the link structure in the bus' list of drivers.
1348 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1349 if (dl->driver == driver)
1354 PDEBUG(("%s not found in %s list", driver->name,
1360 * Quiesce all devices. We iterate through all the devices in
1361 * the devclass of the driver and quiesce any which are using
1362 * the driver and which have a parent in the devclass which we
1365 * Note that since a driver can be in multiple devclasses, we
1366 * should not quiesce devices which are not children of
1367 * devices in the affected devclass.
1369 for (i = 0; i < dc->maxunit; i++) {
1370 if (dc->devices[i]) {
1371 dev = dc->devices[i];
1372 if (dev->driver == driver && dev->parent &&
1373 dev->parent->devclass == busclass) {
1374 if ((error = device_quiesce(dev)) != 0)
1387 devclass_find_driver_internal(devclass_t dc, const char *classname)
1391 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1393 TAILQ_FOREACH(dl, &dc->drivers, link) {
1394 if (!strcmp(dl->driver->name, classname))
1398 PDEBUG(("not found"));
1403 * @brief Return the name of the devclass
1406 devclass_get_name(devclass_t dc)
1412 * @brief Find a device given a unit number
1414 * @param dc the devclass to search
1415 * @param unit the unit number to search for
1417 * @returns the device with the given unit number or @c
1418 * NULL if there is no such device
1421 devclass_get_device(devclass_t dc, int unit)
1423 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1425 return (dc->devices[unit]);
1429 * @brief Find the softc field of a device given a unit number
1431 * @param dc the devclass to search
1432 * @param unit the unit number to search for
1434 * @returns the softc field of the device with the given
1435 * unit number or @c NULL if there is no such
1439 devclass_get_softc(devclass_t dc, int unit)
1443 dev = devclass_get_device(dc, unit);
1447 return (device_get_softc(dev));
1451 * @brief Get a list of devices in the devclass
1453 * An array containing a list of all the devices in the given devclass
1454 * is allocated and returned in @p *devlistp. The number of devices
1455 * in the array is returned in @p *devcountp. The caller should free
1456 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1458 * @param dc the devclass to examine
1459 * @param devlistp points at location for array pointer return
1461 * @param devcountp points at location for array size return value
1464 * @retval ENOMEM the array allocation failed
1467 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1472 count = devclass_get_count(dc);
1473 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1478 for (i = 0; i < dc->maxunit; i++) {
1479 if (dc->devices[i]) {
1480 list[count] = dc->devices[i];
1492 * @brief Get a list of drivers in the devclass
1494 * An array containing a list of pointers to all the drivers in the
1495 * given devclass is allocated and returned in @p *listp. The number
1496 * of drivers in the array is returned in @p *countp. The caller should
1497 * free the array using @c free(p, M_TEMP).
1499 * @param dc the devclass to examine
1500 * @param listp gives location for array pointer return value
1501 * @param countp gives location for number of array elements
1505 * @retval ENOMEM the array allocation failed
1508 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1515 TAILQ_FOREACH(dl, &dc->drivers, link)
1517 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1522 TAILQ_FOREACH(dl, &dc->drivers, link) {
1523 list[count] = dl->driver;
1533 * @brief Get the number of devices in a devclass
1535 * @param dc the devclass to examine
1538 devclass_get_count(devclass_t dc)
1543 for (i = 0; i < dc->maxunit; i++)
1550 * @brief Get the maximum unit number used in a devclass
1552 * Note that this is one greater than the highest currently-allocated
1553 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1554 * that not even the devclass has been allocated yet.
1556 * @param dc the devclass to examine
1559 devclass_get_maxunit(devclass_t dc)
1563 return (dc->maxunit);
1567 * @brief Find a free unit number in a devclass
1569 * This function searches for the first unused unit number greater
1570 * that or equal to @p unit.
1572 * @param dc the devclass to examine
1573 * @param unit the first unit number to check
1576 devclass_find_free_unit(devclass_t dc, int unit)
1580 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1586 * @brief Set the parent of a devclass
1588 * The parent class is normally initialised automatically by
1591 * @param dc the devclass to edit
1592 * @param pdc the new parent devclass
1595 devclass_set_parent(devclass_t dc, devclass_t pdc)
1601 * @brief Get the parent of a devclass
1603 * @param dc the devclass to examine
1606 devclass_get_parent(devclass_t dc)
1608 return (dc->parent);
1611 struct sysctl_ctx_list *
1612 devclass_get_sysctl_ctx(devclass_t dc)
1614 return (&dc->sysctl_ctx);
1618 devclass_get_sysctl_tree(devclass_t dc)
1620 return (dc->sysctl_tree);
1625 * @brief Allocate a unit number
1627 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1628 * will do). The allocated unit number is returned in @p *unitp.
1630 * @param dc the devclass to allocate from
1631 * @param unitp points at the location for the allocated unit
1635 * @retval EEXIST the requested unit number is already allocated
1636 * @retval ENOMEM memory allocation failure
1639 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1644 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1646 /* Ask the parent bus if it wants to wire this device. */
1648 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1651 /* If we were given a wired unit number, check for existing device */
1654 if (unit >= 0 && unit < dc->maxunit &&
1655 dc->devices[unit] != NULL) {
1657 printf("%s: %s%d already exists; skipping it\n",
1658 dc->name, dc->name, *unitp);
1662 /* Unwired device, find the next available slot for it */
1664 for (unit = 0;; unit++) {
1665 /* If there is an "at" hint for a unit then skip it. */
1666 if (resource_string_value(dc->name, unit, "at", &s) ==
1670 /* If this device slot is already in use, skip it. */
1671 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1679 * We've selected a unit beyond the length of the table, so let's
1680 * extend the table to make room for all units up to and including
1683 if (unit >= dc->maxunit) {
1684 device_t *newlist, *oldlist;
1687 oldlist = dc->devices;
1688 newsize = roundup((unit + 1),
1689 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1690 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1693 if (oldlist != NULL)
1694 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1695 bzero(newlist + dc->maxunit,
1696 sizeof(device_t) * (newsize - dc->maxunit));
1697 dc->devices = newlist;
1698 dc->maxunit = newsize;
1699 if (oldlist != NULL)
1700 free(oldlist, M_BUS);
1702 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1710 * @brief Add a device to a devclass
1712 * A unit number is allocated for the device (using the device's
1713 * preferred unit number if any) and the device is registered in the
1714 * devclass. This allows the device to be looked up by its unit
1715 * number, e.g. by decoding a dev_t minor number.
1717 * @param dc the devclass to add to
1718 * @param dev the device to add
1721 * @retval EEXIST the requested unit number is already allocated
1722 * @retval ENOMEM memory allocation failure
1725 devclass_add_device(devclass_t dc, device_t dev)
1729 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1731 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1734 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1738 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1739 free(dev->nameunit, M_BUS);
1740 dev->nameunit = NULL;
1743 dc->devices[dev->unit] = dev;
1745 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1752 * @brief Delete a device from a devclass
1754 * The device is removed from the devclass's device list and its unit
1757 * @param dc the devclass to delete from
1758 * @param dev the device to delete
1763 devclass_delete_device(devclass_t dc, device_t dev)
1768 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1770 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1771 panic("devclass_delete_device: inconsistent device class");
1772 dc->devices[dev->unit] = NULL;
1773 if (dev->flags & DF_WILDCARD)
1775 dev->devclass = NULL;
1776 free(dev->nameunit, M_BUS);
1777 dev->nameunit = NULL;
1784 * @brief Make a new device and add it as a child of @p parent
1786 * @param parent the parent of the new device
1787 * @param name the devclass name of the new device or @c NULL
1788 * to leave the devclass unspecified
1789 * @parem unit the unit number of the new device of @c -1 to
1790 * leave the unit number unspecified
1792 * @returns the new device
1795 make_device(device_t parent, const char *name, int unit)
1800 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1803 dc = devclass_find_internal(name, NULL, TRUE);
1805 printf("make_device: can't find device class %s\n",
1813 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1817 dev->parent = parent;
1818 TAILQ_INIT(&dev->children);
1819 kobj_init((kobj_t) dev, &null_class);
1821 dev->devclass = NULL;
1823 dev->nameunit = NULL;
1827 dev->flags = DF_ENABLED;
1830 dev->flags |= DF_WILDCARD;
1832 dev->flags |= DF_FIXEDCLASS;
1833 if (devclass_add_device(dc, dev)) {
1834 kobj_delete((kobj_t) dev, M_BUS);
1838 if (parent != NULL && device_has_quiet_children(parent))
1839 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1843 dev->state = DS_NOTPRESENT;
1845 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1846 bus_data_generation_update();
1853 * @brief Print a description of a device.
1856 device_print_child(device_t dev, device_t child)
1860 if (device_is_alive(child))
1861 retval += BUS_PRINT_CHILD(dev, child);
1863 retval += device_printf(child, " not found\n");
1869 * @brief Create a new device
1871 * This creates a new device and adds it as a child of an existing
1872 * parent device. The new device will be added after the last existing
1873 * child with order zero.
1875 * @param dev the device which will be the parent of the
1877 * @param name devclass name for new device or @c NULL if not
1879 * @param unit unit number for new device or @c -1 if not
1882 * @returns the new device
1885 device_add_child(device_t dev, const char *name, int unit)
1887 return (device_add_child_ordered(dev, 0, name, unit));
1891 * @brief Create a new device
1893 * This creates a new device and adds it as a child of an existing
1894 * parent device. The new device will be added after the last existing
1895 * child with the same order.
1897 * @param dev the device which will be the parent of the
1899 * @param order a value which is used to partially sort the
1900 * children of @p dev - devices created using
1901 * lower values of @p order appear first in @p
1902 * dev's list of children
1903 * @param name devclass name for new device or @c NULL if not
1905 * @param unit unit number for new device or @c -1 if not
1908 * @returns the new device
1911 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1916 PDEBUG(("%s at %s with order %u as unit %d",
1917 name, DEVICENAME(dev), order, unit));
1918 KASSERT(name != NULL || unit == -1,
1919 ("child device with wildcard name and specific unit number"));
1921 child = make_device(dev, name, unit);
1924 child->order = order;
1926 TAILQ_FOREACH(place, &dev->children, link) {
1927 if (place->order > order)
1933 * The device 'place' is the first device whose order is
1934 * greater than the new child.
1936 TAILQ_INSERT_BEFORE(place, child, link);
1939 * The new child's order is greater or equal to the order of
1940 * any existing device. Add the child to the tail of the list.
1942 TAILQ_INSERT_TAIL(&dev->children, child, link);
1945 bus_data_generation_update();
1950 * @brief Delete a device
1952 * This function deletes a device along with all of its children. If
1953 * the device currently has a driver attached to it, the device is
1954 * detached first using device_detach().
1956 * @param dev the parent device
1957 * @param child the device to delete
1960 * @retval non-zero a unit error code describing the error
1963 device_delete_child(device_t dev, device_t child)
1966 device_t grandchild;
1968 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1970 /* detach parent before deleting children, if any */
1971 if ((error = device_detach(child)) != 0)
1974 /* remove children second */
1975 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1976 error = device_delete_child(child, grandchild);
1981 if (child->devclass)
1982 devclass_delete_device(child->devclass, child);
1984 BUS_CHILD_DELETED(dev, child);
1985 TAILQ_REMOVE(&dev->children, child, link);
1986 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1987 kobj_delete((kobj_t) child, M_BUS);
1989 bus_data_generation_update();
1994 * @brief Delete all children devices of the given device, if any.
1996 * This function deletes all children devices of the given device, if
1997 * any, using the device_delete_child() function for each device it
1998 * finds. If a child device cannot be deleted, this function will
1999 * return an error code.
2001 * @param dev the parent device
2004 * @retval non-zero a device would not detach
2007 device_delete_children(device_t dev)
2012 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2016 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2017 error = device_delete_child(dev, child);
2019 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2027 * @brief Find a device given a unit number
2029 * This is similar to devclass_get_devices() but only searches for
2030 * devices which have @p dev as a parent.
2032 * @param dev the parent device to search
2033 * @param unit the unit number to search for. If the unit is -1,
2034 * return the first child of @p dev which has name
2035 * @p classname (that is, the one with the lowest unit.)
2037 * @returns the device with the given unit number or @c
2038 * NULL if there is no such device
2041 device_find_child(device_t dev, const char *classname, int unit)
2046 dc = devclass_find(classname);
2051 child = devclass_get_device(dc, unit);
2052 if (child && child->parent == dev)
2055 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2056 child = devclass_get_device(dc, unit);
2057 if (child && child->parent == dev)
2068 first_matching_driver(devclass_t dc, device_t dev)
2071 return (devclass_find_driver_internal(dc, dev->devclass->name));
2072 return (TAILQ_FIRST(&dc->drivers));
2079 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2081 if (dev->devclass) {
2083 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2084 if (!strcmp(dev->devclass->name, dl->driver->name))
2088 return (TAILQ_NEXT(last, link));
2095 device_probe_child(device_t dev, device_t child)
2098 driverlink_t best = NULL;
2100 int result, pri = 0;
2101 int hasclass = (child->devclass != NULL);
2107 panic("device_probe_child: parent device has no devclass");
2110 * If the state is already probed, then return. However, don't
2111 * return if we can rebid this object.
2113 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2116 for (; dc; dc = dc->parent) {
2117 for (dl = first_matching_driver(dc, child);
2119 dl = next_matching_driver(dc, child, dl)) {
2120 /* If this driver's pass is too high, then ignore it. */
2121 if (dl->pass > bus_current_pass)
2124 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2125 result = device_set_driver(child, dl->driver);
2126 if (result == ENOMEM)
2128 else if (result != 0)
2131 if (device_set_devclass(child,
2132 dl->driver->name) != 0) {
2133 char const * devname =
2134 device_get_name(child);
2135 if (devname == NULL)
2136 devname = "(unknown)";
2137 printf("driver bug: Unable to set "
2138 "devclass (class: %s "
2142 (void)device_set_driver(child, NULL);
2147 /* Fetch any flags for the device before probing. */
2148 resource_int_value(dl->driver->name, child->unit,
2149 "flags", &child->devflags);
2151 result = DEVICE_PROBE(child);
2153 /* Reset flags and devclass before the next probe. */
2154 child->devflags = 0;
2156 (void)device_set_devclass(child, NULL);
2159 * If the driver returns SUCCESS, there can be
2160 * no higher match for this device.
2169 * Reset DF_QUIET in case this driver doesn't
2170 * end up as the best driver.
2172 device_verbose(child);
2175 * Probes that return BUS_PROBE_NOWILDCARD or lower
2176 * only match on devices whose driver was explicitly
2179 if (result <= BUS_PROBE_NOWILDCARD &&
2180 !(child->flags & DF_FIXEDCLASS)) {
2185 * The driver returned an error so it
2186 * certainly doesn't match.
2189 (void)device_set_driver(child, NULL);
2194 * A priority lower than SUCCESS, remember the
2195 * best matching driver. Initialise the value
2196 * of pri for the first match.
2198 if (best == NULL || result > pri) {
2205 * If we have an unambiguous match in this devclass,
2206 * don't look in the parent.
2208 if (best && pri == 0)
2213 * If we found a driver, change state and initialise the devclass.
2215 /* XXX What happens if we rebid and got no best? */
2218 * If this device was attached, and we were asked to
2219 * rescan, and it is a different driver, then we have
2220 * to detach the old driver and reattach this new one.
2221 * Note, we don't have to check for DF_REBID here
2222 * because if the state is > DS_ALIVE, we know it must
2225 * This assumes that all DF_REBID drivers can have
2226 * their probe routine called at any time and that
2227 * they are idempotent as well as completely benign in
2228 * normal operations.
2230 * We also have to make sure that the detach
2231 * succeeded, otherwise we fail the operation (or
2232 * maybe it should just fail silently? I'm torn).
2234 if (child->state > DS_ALIVE && best->driver != child->driver)
2235 if ((result = device_detach(dev)) != 0)
2238 /* Set the winning driver, devclass, and flags. */
2239 if (!child->devclass) {
2240 result = device_set_devclass(child, best->driver->name);
2244 result = device_set_driver(child, best->driver);
2247 resource_int_value(best->driver->name, child->unit,
2248 "flags", &child->devflags);
2252 * A bit bogus. Call the probe method again to make
2253 * sure that we have the right description.
2255 DEVICE_PROBE(child);
2257 child->flags |= DF_REBID;
2260 child->flags &= ~DF_REBID;
2261 child->state = DS_ALIVE;
2263 bus_data_generation_update();
2271 * @brief Return the parent of a device
2274 device_get_parent(device_t dev)
2276 return (dev->parent);
2280 * @brief Get a list of children of a device
2282 * An array containing a list of all the children of the given device
2283 * is allocated and returned in @p *devlistp. The number of devices
2284 * in the array is returned in @p *devcountp. The caller should free
2285 * the array using @c free(p, M_TEMP).
2287 * @param dev the device to examine
2288 * @param devlistp points at location for array pointer return
2290 * @param devcountp points at location for array size return value
2293 * @retval ENOMEM the array allocation failed
2296 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2303 TAILQ_FOREACH(child, &dev->children, link) {
2312 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2317 TAILQ_FOREACH(child, &dev->children, link) {
2318 list[count] = child;
2329 * @brief Return the current driver for the device or @c NULL if there
2330 * is no driver currently attached
2333 device_get_driver(device_t dev)
2335 return (dev->driver);
2339 * @brief Return the current devclass for the device or @c NULL if
2343 device_get_devclass(device_t dev)
2345 return (dev->devclass);
2349 * @brief Return the name of the device's devclass or @c NULL if there
2353 device_get_name(device_t dev)
2355 if (dev != NULL && dev->devclass)
2356 return (devclass_get_name(dev->devclass));
2361 * @brief Return a string containing the device's devclass name
2362 * followed by an ascii representation of the device's unit number
2366 device_get_nameunit(device_t dev)
2368 return (dev->nameunit);
2372 * @brief Return the device's unit number.
2375 device_get_unit(device_t dev)
2381 * @brief Return the device's description string
2384 device_get_desc(device_t dev)
2390 * @brief Return the device's flags
2393 device_get_flags(device_t dev)
2395 return (dev->devflags);
2398 struct sysctl_ctx_list *
2399 device_get_sysctl_ctx(device_t dev)
2401 return (&dev->sysctl_ctx);
2405 device_get_sysctl_tree(device_t dev)
2407 return (dev->sysctl_tree);
2411 * @brief Print the name of the device followed by a colon and a space
2413 * @returns the number of characters printed
2416 device_print_prettyname(device_t dev)
2418 const char *name = device_get_name(dev);
2421 return (printf("unknown: "));
2422 return (printf("%s%d: ", name, device_get_unit(dev)));
2426 * @brief Print the name of the device followed by a colon, a space
2427 * and the result of calling vprintf() with the value of @p fmt and
2428 * the following arguments.
2430 * @returns the number of characters printed
2433 device_printf(device_t dev, const char * fmt, ...)
2443 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2444 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2446 name = device_get_name(dev);
2449 sbuf_cat(&sb, "unknown: ");
2451 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2454 sbuf_vprintf(&sb, fmt, ap);
2467 device_set_desc_internal(device_t dev, const char* desc, int copy)
2469 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2470 free(dev->desc, M_BUS);
2471 dev->flags &= ~DF_DESCMALLOCED;
2476 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2478 strcpy(dev->desc, desc);
2479 dev->flags |= DF_DESCMALLOCED;
2482 /* Avoid a -Wcast-qual warning */
2483 dev->desc = (char *)(uintptr_t) desc;
2486 bus_data_generation_update();
2490 * @brief Set the device's description
2492 * The value of @c desc should be a string constant that will not
2493 * change (at least until the description is changed in a subsequent
2494 * call to device_set_desc() or device_set_desc_copy()).
2497 device_set_desc(device_t dev, const char* desc)
2499 device_set_desc_internal(dev, desc, FALSE);
2503 * @brief Set the device's description
2505 * The string pointed to by @c desc is copied. Use this function if
2506 * the device description is generated, (e.g. with sprintf()).
2509 device_set_desc_copy(device_t dev, const char* desc)
2511 device_set_desc_internal(dev, desc, TRUE);
2515 * @brief Set the device's flags
2518 device_set_flags(device_t dev, uint32_t flags)
2520 dev->devflags = flags;
2524 * @brief Return the device's softc field
2526 * The softc is allocated and zeroed when a driver is attached, based
2527 * on the size field of the driver.
2530 device_get_softc(device_t dev)
2532 return (dev->softc);
2536 * @brief Set the device's softc field
2538 * Most drivers do not need to use this since the softc is allocated
2539 * automatically when the driver is attached.
2542 device_set_softc(device_t dev, void *softc)
2544 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2545 free_domain(dev->softc, M_BUS_SC);
2548 dev->flags |= DF_EXTERNALSOFTC;
2550 dev->flags &= ~DF_EXTERNALSOFTC;
2554 * @brief Free claimed softc
2556 * Most drivers do not need to use this since the softc is freed
2557 * automatically when the driver is detached.
2560 device_free_softc(void *softc)
2562 free_domain(softc, M_BUS_SC);
2566 * @brief Claim softc
2568 * This function can be used to let the driver free the automatically
2569 * allocated softc using "device_free_softc()". This function is
2570 * useful when the driver is refcounting the softc and the softc
2571 * cannot be freed when the "device_detach" method is called.
2574 device_claim_softc(device_t dev)
2577 dev->flags |= DF_EXTERNALSOFTC;
2579 dev->flags &= ~DF_EXTERNALSOFTC;
2583 * @brief Get the device's ivars field
2585 * The ivars field is used by the parent device to store per-device
2586 * state (e.g. the physical location of the device or a list of
2590 device_get_ivars(device_t dev)
2592 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2593 return (dev->ivars);
2597 * @brief Set the device's ivars field
2600 device_set_ivars(device_t dev, void * ivars)
2602 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2607 * @brief Return the device's state
2610 device_get_state(device_t dev)
2612 return (dev->state);
2616 * @brief Set the DF_ENABLED flag for the device
2619 device_enable(device_t dev)
2621 dev->flags |= DF_ENABLED;
2625 * @brief Clear the DF_ENABLED flag for the device
2628 device_disable(device_t dev)
2630 dev->flags &= ~DF_ENABLED;
2634 * @brief Increment the busy counter for the device
2637 device_busy(device_t dev)
2639 if (dev->state < DS_ATTACHING)
2640 panic("device_busy: called for unattached device");
2641 if (dev->busy == 0 && dev->parent)
2642 device_busy(dev->parent);
2644 if (dev->state == DS_ATTACHED)
2645 dev->state = DS_BUSY;
2649 * @brief Decrement the busy counter for the device
2652 device_unbusy(device_t dev)
2654 if (dev->busy != 0 && dev->state != DS_BUSY &&
2655 dev->state != DS_ATTACHING)
2656 panic("device_unbusy: called for non-busy device %s",
2657 device_get_nameunit(dev));
2659 if (dev->busy == 0) {
2661 device_unbusy(dev->parent);
2662 if (dev->state == DS_BUSY)
2663 dev->state = DS_ATTACHED;
2668 * @brief Set the DF_QUIET flag for the device
2671 device_quiet(device_t dev)
2673 dev->flags |= DF_QUIET;
2677 * @brief Set the DF_QUIET_CHILDREN flag for the device
2680 device_quiet_children(device_t dev)
2682 dev->flags |= DF_QUIET_CHILDREN;
2686 * @brief Clear the DF_QUIET flag for the device
2689 device_verbose(device_t dev)
2691 dev->flags &= ~DF_QUIET;
2695 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2698 device_has_quiet_children(device_t dev)
2700 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2704 * @brief Return non-zero if the DF_QUIET flag is set on the device
2707 device_is_quiet(device_t dev)
2709 return ((dev->flags & DF_QUIET) != 0);
2713 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2716 device_is_enabled(device_t dev)
2718 return ((dev->flags & DF_ENABLED) != 0);
2722 * @brief Return non-zero if the device was successfully probed
2725 device_is_alive(device_t dev)
2727 return (dev->state >= DS_ALIVE);
2731 * @brief Return non-zero if the device currently has a driver
2735 device_is_attached(device_t dev)
2737 return (dev->state >= DS_ATTACHED);
2741 * @brief Return non-zero if the device is currently suspended.
2744 device_is_suspended(device_t dev)
2746 return ((dev->flags & DF_SUSPENDED) != 0);
2750 * @brief Set the devclass of a device
2751 * @see devclass_add_device().
2754 device_set_devclass(device_t dev, const char *classname)
2761 devclass_delete_device(dev->devclass, dev);
2765 if (dev->devclass) {
2766 printf("device_set_devclass: device class already set\n");
2770 dc = devclass_find_internal(classname, NULL, TRUE);
2774 error = devclass_add_device(dc, dev);
2776 bus_data_generation_update();
2781 * @brief Set the devclass of a device and mark the devclass fixed.
2782 * @see device_set_devclass()
2785 device_set_devclass_fixed(device_t dev, const char *classname)
2789 if (classname == NULL)
2792 error = device_set_devclass(dev, classname);
2795 dev->flags |= DF_FIXEDCLASS;
2800 * @brief Query the device to determine if it's of a fixed devclass
2801 * @see device_set_devclass_fixed()
2804 device_is_devclass_fixed(device_t dev)
2806 return ((dev->flags & DF_FIXEDCLASS) != 0);
2810 * @brief Set the driver of a device
2813 * @retval EBUSY the device already has a driver attached
2814 * @retval ENOMEM a memory allocation failure occurred
2817 device_set_driver(device_t dev, driver_t *driver)
2820 struct domainset *policy;
2822 if (dev->state >= DS_ATTACHED)
2825 if (dev->driver == driver)
2828 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2829 free_domain(dev->softc, M_BUS_SC);
2832 device_set_desc(dev, NULL);
2833 kobj_delete((kobj_t) dev, NULL);
2834 dev->driver = driver;
2836 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2837 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2838 if (bus_get_domain(dev, &domain) == 0)
2839 policy = DOMAINSET_PREF(domain);
2841 policy = DOMAINSET_RR();
2842 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2843 policy, M_NOWAIT | M_ZERO);
2845 kobj_delete((kobj_t) dev, NULL);
2846 kobj_init((kobj_t) dev, &null_class);
2852 kobj_init((kobj_t) dev, &null_class);
2855 bus_data_generation_update();
2860 * @brief Probe a device, and return this status.
2862 * This function is the core of the device autoconfiguration
2863 * system. Its purpose is to select a suitable driver for a device and
2864 * then call that driver to initialise the hardware appropriately. The
2865 * driver is selected by calling the DEVICE_PROBE() method of a set of
2866 * candidate drivers and then choosing the driver which returned the
2867 * best value. This driver is then attached to the device using
2870 * The set of suitable drivers is taken from the list of drivers in
2871 * the parent device's devclass. If the device was originally created
2872 * with a specific class name (see device_add_child()), only drivers
2873 * with that name are probed, otherwise all drivers in the devclass
2874 * are probed. If no drivers return successful probe values in the
2875 * parent devclass, the search continues in the parent of that
2876 * devclass (see devclass_get_parent()) if any.
2878 * @param dev the device to initialise
2881 * @retval ENXIO no driver was found
2882 * @retval ENOMEM memory allocation failure
2883 * @retval non-zero some other unix error code
2884 * @retval -1 Device already attached
2887 device_probe(device_t dev)
2893 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2896 if (!(dev->flags & DF_ENABLED)) {
2897 if (bootverbose && device_get_name(dev) != NULL) {
2898 device_print_prettyname(dev);
2899 printf("not probed (disabled)\n");
2903 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2904 if (bus_current_pass == BUS_PASS_DEFAULT &&
2905 !(dev->flags & DF_DONENOMATCH)) {
2906 BUS_PROBE_NOMATCH(dev->parent, dev);
2908 dev->flags |= DF_DONENOMATCH;
2916 * @brief Probe a device and attach a driver if possible
2918 * calls device_probe() and attaches if that was successful.
2921 device_probe_and_attach(device_t dev)
2927 error = device_probe(dev);
2930 else if (error != 0)
2933 CURVNET_SET_QUIET(vnet0);
2934 error = device_attach(dev);
2940 * @brief Attach a device driver to a device
2942 * This function is a wrapper around the DEVICE_ATTACH() driver
2943 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2944 * device's sysctl tree, optionally prints a description of the device
2945 * and queues a notification event for user-based device management
2948 * Normally this function is only called internally from
2949 * device_probe_and_attach().
2951 * @param dev the device to initialise
2954 * @retval ENXIO no driver was found
2955 * @retval ENOMEM memory allocation failure
2956 * @retval non-zero some other unix error code
2959 device_attach(device_t dev)
2961 uint64_t attachtime;
2962 uint16_t attachentropy;
2965 if (resource_disabled(dev->driver->name, dev->unit)) {
2966 device_disable(dev);
2968 device_printf(dev, "disabled via hints entry\n");
2972 device_sysctl_init(dev);
2973 if (!device_is_quiet(dev))
2974 device_print_child(dev->parent, dev);
2975 attachtime = get_cyclecount();
2976 dev->state = DS_ATTACHING;
2977 if ((error = DEVICE_ATTACH(dev)) != 0) {
2978 printf("device_attach: %s%d attach returned %d\n",
2979 dev->driver->name, dev->unit, error);
2980 if (!(dev->flags & DF_FIXEDCLASS))
2981 devclass_delete_device(dev->devclass, dev);
2982 (void)device_set_driver(dev, NULL);
2983 device_sysctl_fini(dev);
2984 KASSERT(dev->busy == 0, ("attach failed but busy"));
2985 dev->state = DS_NOTPRESENT;
2988 dev->flags |= DF_ATTACHED_ONCE;
2989 /* We only need the low bits of this time, but ranges from tens to thousands
2990 * have been seen, so keep 2 bytes' worth.
2992 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2993 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2994 device_sysctl_update(dev);
2996 dev->state = DS_BUSY;
2998 dev->state = DS_ATTACHED;
2999 dev->flags &= ~DF_DONENOMATCH;
3000 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3006 * @brief Detach a driver from a device
3008 * This function is a wrapper around the DEVICE_DETACH() driver
3009 * method. If the call to DEVICE_DETACH() succeeds, it calls
3010 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3011 * notification event for user-based device management services and
3012 * cleans up the device's sysctl tree.
3014 * @param dev the device to un-initialise
3017 * @retval ENXIO no driver was found
3018 * @retval ENOMEM memory allocation failure
3019 * @retval non-zero some other unix error code
3022 device_detach(device_t dev)
3028 PDEBUG(("%s", DEVICENAME(dev)));
3029 if (dev->state == DS_BUSY)
3031 if (dev->state == DS_ATTACHING) {
3032 device_printf(dev, "device in attaching state! Deferring detach.\n");
3035 if (dev->state != DS_ATTACHED)
3038 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3039 if ((error = DEVICE_DETACH(dev)) != 0) {
3040 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3041 EVHDEV_DETACH_FAILED);
3044 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3045 EVHDEV_DETACH_COMPLETE);
3048 if (!device_is_quiet(dev))
3049 device_printf(dev, "detached\n");
3051 BUS_CHILD_DETACHED(dev->parent, dev);
3053 if (!(dev->flags & DF_FIXEDCLASS))
3054 devclass_delete_device(dev->devclass, dev);
3056 device_verbose(dev);
3057 dev->state = DS_NOTPRESENT;
3058 (void)device_set_driver(dev, NULL);
3059 device_sysctl_fini(dev);
3065 * @brief Tells a driver to quiesce itself.
3067 * This function is a wrapper around the DEVICE_QUIESCE() driver
3068 * method. If the call to DEVICE_QUIESCE() succeeds.
3070 * @param dev the device to quiesce
3073 * @retval ENXIO no driver was found
3074 * @retval ENOMEM memory allocation failure
3075 * @retval non-zero some other unix error code
3078 device_quiesce(device_t dev)
3080 PDEBUG(("%s", DEVICENAME(dev)));
3081 if (dev->state == DS_BUSY)
3083 if (dev->state != DS_ATTACHED)
3086 return (DEVICE_QUIESCE(dev));
3090 * @brief Notify a device of system shutdown
3092 * This function calls the DEVICE_SHUTDOWN() driver method if the
3093 * device currently has an attached driver.
3095 * @returns the value returned by DEVICE_SHUTDOWN()
3098 device_shutdown(device_t dev)
3100 if (dev->state < DS_ATTACHED)
3102 return (DEVICE_SHUTDOWN(dev));
3106 * @brief Set the unit number of a device
3108 * This function can be used to override the unit number used for a
3109 * device (e.g. to wire a device to a pre-configured unit number).
3112 device_set_unit(device_t dev, int unit)
3117 dc = device_get_devclass(dev);
3118 if (unit < dc->maxunit && dc->devices[unit])
3120 err = devclass_delete_device(dc, dev);
3124 err = devclass_add_device(dc, dev);
3128 bus_data_generation_update();
3132 /*======================================*/
3134 * Some useful method implementations to make life easier for bus drivers.
3138 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3142 args->memattr = VM_MEMATTR_UNCACHEABLE;
3146 * @brief Initialise a resource list.
3148 * @param rl the resource list to initialise
3151 resource_list_init(struct resource_list *rl)
3157 * @brief Reclaim memory used by a resource list.
3159 * This function frees the memory for all resource entries on the list
3162 * @param rl the resource list to free
3165 resource_list_free(struct resource_list *rl)
3167 struct resource_list_entry *rle;
3169 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3171 panic("resource_list_free: resource entry is busy");
3172 STAILQ_REMOVE_HEAD(rl, link);
3178 * @brief Add a resource entry.
3180 * This function adds a resource entry using the given @p type, @p
3181 * start, @p end and @p count values. A rid value is chosen by
3182 * searching sequentially for the first unused rid starting at zero.
3184 * @param rl the resource list to edit
3185 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3186 * @param start the start address of the resource
3187 * @param end the end address of the resource
3188 * @param count XXX end-start+1
3191 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3192 rman_res_t end, rman_res_t count)
3197 while (resource_list_find(rl, type, rid) != NULL)
3199 resource_list_add(rl, type, rid, start, end, count);
3204 * @brief Add or modify a resource entry.
3206 * If an existing entry exists with the same type and rid, it will be
3207 * modified using the given values of @p start, @p end and @p
3208 * count. If no entry exists, a new one will be created using the
3209 * given values. The resource list entry that matches is then returned.
3211 * @param rl the resource list to edit
3212 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3213 * @param rid the resource identifier
3214 * @param start the start address of the resource
3215 * @param end the end address of the resource
3216 * @param count XXX end-start+1
3218 struct resource_list_entry *
3219 resource_list_add(struct resource_list *rl, int type, int rid,
3220 rman_res_t start, rman_res_t end, rman_res_t count)
3222 struct resource_list_entry *rle;
3224 rle = resource_list_find(rl, type, rid);
3226 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3229 panic("resource_list_add: can't record entry");
3230 STAILQ_INSERT_TAIL(rl, rle, link);
3238 panic("resource_list_add: resource entry is busy");
3247 * @brief Determine if a resource entry is busy.
3249 * Returns true if a resource entry is busy meaning that it has an
3250 * associated resource that is not an unallocated "reserved" resource.
3252 * @param rl the resource list to search
3253 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3254 * @param rid the resource identifier
3256 * @returns Non-zero if the entry is busy, zero otherwise.
3259 resource_list_busy(struct resource_list *rl, int type, int rid)
3261 struct resource_list_entry *rle;
3263 rle = resource_list_find(rl, type, rid);
3264 if (rle == NULL || rle->res == NULL)
3266 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3267 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3268 ("reserved resource is active"));
3275 * @brief Determine if a resource entry is reserved.
3277 * Returns true if a resource entry is reserved meaning that it has an
3278 * associated "reserved" resource. The resource can either be
3279 * allocated or unallocated.
3281 * @param rl the resource list to search
3282 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3283 * @param rid the resource identifier
3285 * @returns Non-zero if the entry is reserved, zero otherwise.
3288 resource_list_reserved(struct resource_list *rl, int type, int rid)
3290 struct resource_list_entry *rle;
3292 rle = resource_list_find(rl, type, rid);
3293 if (rle != NULL && rle->flags & RLE_RESERVED)
3299 * @brief Find a resource entry by type and rid.
3301 * @param rl the resource list to search
3302 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3303 * @param rid the resource identifier
3305 * @returns the resource entry pointer or NULL if there is no such
3308 struct resource_list_entry *
3309 resource_list_find(struct resource_list *rl, int type, int rid)
3311 struct resource_list_entry *rle;
3313 STAILQ_FOREACH(rle, rl, link) {
3314 if (rle->type == type && rle->rid == rid)
3321 * @brief Delete a resource entry.
3323 * @param rl the resource list to edit
3324 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3325 * @param rid the resource identifier
3328 resource_list_delete(struct resource_list *rl, int type, int rid)
3330 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3333 if (rle->res != NULL)
3334 panic("resource_list_delete: resource has not been released");
3335 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3341 * @brief Allocate a reserved resource
3343 * This can be used by buses to force the allocation of resources
3344 * that are always active in the system even if they are not allocated
3345 * by a driver (e.g. PCI BARs). This function is usually called when
3346 * adding a new child to the bus. The resource is allocated from the
3347 * parent bus when it is reserved. The resource list entry is marked
3348 * with RLE_RESERVED to note that it is a reserved resource.
3350 * Subsequent attempts to allocate the resource with
3351 * resource_list_alloc() will succeed the first time and will set
3352 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3353 * resource that has been allocated is released with
3354 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3355 * the actual resource remains allocated. The resource can be released to
3356 * the parent bus by calling resource_list_unreserve().
3358 * @param rl the resource list to allocate from
3359 * @param bus the parent device of @p child
3360 * @param child the device for which the resource is being reserved
3361 * @param type the type of resource to allocate
3362 * @param rid a pointer to the resource identifier
3363 * @param start hint at the start of the resource range - pass
3364 * @c 0 for any start address
3365 * @param end hint at the end of the resource range - pass
3366 * @c ~0 for any end address
3367 * @param count hint at the size of range required - pass @c 1
3369 * @param flags any extra flags to control the resource
3370 * allocation - see @c RF_XXX flags in
3371 * <sys/rman.h> for details
3373 * @returns the resource which was allocated or @c NULL if no
3374 * resource could be allocated
3377 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3378 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3380 struct resource_list_entry *rle = NULL;
3381 int passthrough = (device_get_parent(child) != bus);
3386 "resource_list_reserve() should only be called for direct children");
3387 if (flags & RF_ACTIVE)
3389 "resource_list_reserve() should only reserve inactive resources");
3391 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3394 rle = resource_list_find(rl, type, *rid);
3395 rle->flags |= RLE_RESERVED;
3401 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3403 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3404 * and passing the allocation up to the parent of @p bus. This assumes
3405 * that the first entry of @c device_get_ivars(child) is a struct
3406 * resource_list. This also handles 'passthrough' allocations where a
3407 * child is a remote descendant of bus by passing the allocation up to
3408 * the parent of bus.
3410 * Typically, a bus driver would store a list of child resources
3411 * somewhere in the child device's ivars (see device_get_ivars()) and
3412 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3413 * then call resource_list_alloc() to perform the allocation.
3415 * @param rl the resource list to allocate from
3416 * @param bus the parent device of @p child
3417 * @param child the device which is requesting an allocation
3418 * @param type the type of resource to allocate
3419 * @param rid a pointer to the resource identifier
3420 * @param start hint at the start of the resource range - pass
3421 * @c 0 for any start address
3422 * @param end hint at the end of the resource range - pass
3423 * @c ~0 for any end address
3424 * @param count hint at the size of range required - pass @c 1
3426 * @param flags any extra flags to control the resource
3427 * allocation - see @c RF_XXX flags in
3428 * <sys/rman.h> for details
3430 * @returns the resource which was allocated or @c NULL if no
3431 * resource could be allocated
3434 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3435 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3437 struct resource_list_entry *rle = NULL;
3438 int passthrough = (device_get_parent(child) != bus);
3439 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3442 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3443 type, rid, start, end, count, flags));
3446 rle = resource_list_find(rl, type, *rid);
3449 return (NULL); /* no resource of that type/rid */
3452 if (rle->flags & RLE_RESERVED) {
3453 if (rle->flags & RLE_ALLOCATED)
3455 if ((flags & RF_ACTIVE) &&
3456 bus_activate_resource(child, type, *rid,
3459 rle->flags |= RLE_ALLOCATED;
3463 "resource entry %#x type %d for child %s is busy\n", *rid,
3464 type, device_get_nameunit(child));
3470 count = ulmax(count, rle->count);
3471 end = ulmax(rle->end, start + count - 1);
3474 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3475 type, rid, start, end, count, flags);
3478 * Record the new range.
3481 rle->start = rman_get_start(rle->res);
3482 rle->end = rman_get_end(rle->res);
3490 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3492 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3493 * used with resource_list_alloc().
3495 * @param rl the resource list which was allocated from
3496 * @param bus the parent device of @p child
3497 * @param child the device which is requesting a release
3498 * @param type the type of resource to release
3499 * @param rid the resource identifier
3500 * @param res the resource to release
3503 * @retval non-zero a standard unix error code indicating what
3504 * error condition prevented the operation
3507 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3508 int type, int rid, struct resource *res)
3510 struct resource_list_entry *rle = NULL;
3511 int passthrough = (device_get_parent(child) != bus);
3515 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3519 rle = resource_list_find(rl, type, rid);
3522 panic("resource_list_release: can't find resource");
3524 panic("resource_list_release: resource entry is not busy");
3525 if (rle->flags & RLE_RESERVED) {
3526 if (rle->flags & RLE_ALLOCATED) {
3527 if (rman_get_flags(res) & RF_ACTIVE) {
3528 error = bus_deactivate_resource(child, type,
3533 rle->flags &= ~RLE_ALLOCATED;
3539 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3549 * @brief Release all active resources of a given type
3551 * Release all active resources of a specified type. This is intended
3552 * to be used to cleanup resources leaked by a driver after detach or
3555 * @param rl the resource list which was allocated from
3556 * @param bus the parent device of @p child
3557 * @param child the device whose active resources are being released
3558 * @param type the type of resources to release
3561 * @retval EBUSY at least one resource was active
3564 resource_list_release_active(struct resource_list *rl, device_t bus,
3565 device_t child, int type)
3567 struct resource_list_entry *rle;
3571 STAILQ_FOREACH(rle, rl, link) {
3572 if (rle->type != type)
3574 if (rle->res == NULL)
3576 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3580 error = resource_list_release(rl, bus, child, type,
3581 rman_get_rid(rle->res), rle->res);
3584 "Failed to release active resource: %d\n", error);
3590 * @brief Fully release a reserved resource
3592 * Fully releases a resource reserved via resource_list_reserve().
3594 * @param rl the resource list which was allocated from
3595 * @param bus the parent device of @p child
3596 * @param child the device whose reserved resource is being released
3597 * @param type the type of resource to release
3598 * @param rid the resource identifier
3599 * @param res the resource to release
3602 * @retval non-zero a standard unix error code indicating what
3603 * error condition prevented the operation
3606 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3609 struct resource_list_entry *rle = NULL;
3610 int passthrough = (device_get_parent(child) != bus);
3614 "resource_list_unreserve() should only be called for direct children");
3616 rle = resource_list_find(rl, type, rid);
3619 panic("resource_list_unreserve: can't find resource");
3620 if (!(rle->flags & RLE_RESERVED))
3622 if (rle->flags & RLE_ALLOCATED)
3624 rle->flags &= ~RLE_RESERVED;
3625 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3629 * @brief Print a description of resources in a resource list
3631 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3632 * The name is printed if at least one resource of the given type is available.
3633 * The format is used to print resource start and end.
3635 * @param rl the resource list to print
3636 * @param name the name of @p type, e.g. @c "memory"
3637 * @param type type type of resource entry to print
3638 * @param format printf(9) format string to print resource
3639 * start and end values
3641 * @returns the number of characters printed
3644 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3647 struct resource_list_entry *rle;
3648 int printed, retval;
3652 /* Yes, this is kinda cheating */
3653 STAILQ_FOREACH(rle, rl, link) {
3654 if (rle->type == type) {
3656 retval += printf(" %s ", name);
3658 retval += printf(",");
3660 retval += printf(format, rle->start);
3661 if (rle->count > 1) {
3662 retval += printf("-");
3663 retval += printf(format, rle->start +
3672 * @brief Releases all the resources in a list.
3674 * @param rl The resource list to purge.
3679 resource_list_purge(struct resource_list *rl)
3681 struct resource_list_entry *rle;
3683 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3685 bus_release_resource(rman_get_device(rle->res),
3686 rle->type, rle->rid, rle->res);
3687 STAILQ_REMOVE_HEAD(rl, link);
3693 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3695 return (device_add_child_ordered(dev, order, name, unit));
3699 * @brief Helper function for implementing DEVICE_PROBE()
3701 * This function can be used to help implement the DEVICE_PROBE() for
3702 * a bus (i.e. a device which has other devices attached to it). It
3703 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3707 bus_generic_probe(device_t dev)
3709 devclass_t dc = dev->devclass;
3712 TAILQ_FOREACH(dl, &dc->drivers, link) {
3714 * If this driver's pass is too high, then ignore it.
3715 * For most drivers in the default pass, this will
3716 * never be true. For early-pass drivers they will
3717 * only call the identify routines of eligible drivers
3718 * when this routine is called. Drivers for later
3719 * passes should have their identify routines called
3720 * on early-pass buses during BUS_NEW_PASS().
3722 if (dl->pass > bus_current_pass)
3724 DEVICE_IDENTIFY(dl->driver, dev);
3731 * @brief Helper function for implementing DEVICE_ATTACH()
3733 * This function can be used to help implement the DEVICE_ATTACH() for
3734 * a bus. It calls device_probe_and_attach() for each of the device's
3738 bus_generic_attach(device_t dev)
3742 TAILQ_FOREACH(child, &dev->children, link) {
3743 device_probe_and_attach(child);
3750 * @brief Helper function for delaying attaching children
3752 * Many buses can't run transactions on the bus which children need to probe and
3753 * attach until after interrupts and/or timers are running. This function
3754 * delays their attach until interrupts and timers are enabled.
3757 bus_delayed_attach_children(device_t dev)
3759 /* Probe and attach the bus children when interrupts are available */
3760 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3766 * @brief Helper function for implementing DEVICE_DETACH()
3768 * This function can be used to help implement the DEVICE_DETACH() for
3769 * a bus. It calls device_detach() for each of the device's
3773 bus_generic_detach(device_t dev)
3778 if (dev->state != DS_ATTACHED)
3782 * Detach children in the reverse order.
3783 * See bus_generic_suspend for details.
3785 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3786 if ((error = device_detach(child)) != 0)
3794 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3796 * This function can be used to help implement the DEVICE_SHUTDOWN()
3797 * for a bus. It calls device_shutdown() for each of the device's
3801 bus_generic_shutdown(device_t dev)
3806 * Shut down children in the reverse order.
3807 * See bus_generic_suspend for details.
3809 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3810 device_shutdown(child);
3817 * @brief Default function for suspending a child device.
3819 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3822 bus_generic_suspend_child(device_t dev, device_t child)
3826 error = DEVICE_SUSPEND(child);
3829 child->flags |= DF_SUSPENDED;
3835 * @brief Default function for resuming a child device.
3837 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3840 bus_generic_resume_child(device_t dev, device_t child)
3842 DEVICE_RESUME(child);
3843 child->flags &= ~DF_SUSPENDED;
3849 * @brief Helper function for implementing DEVICE_SUSPEND()
3851 * This function can be used to help implement the DEVICE_SUSPEND()
3852 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3853 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3854 * operation is aborted and any devices which were suspended are
3855 * resumed immediately by calling their DEVICE_RESUME() methods.
3858 bus_generic_suspend(device_t dev)
3864 * Suspend children in the reverse order.
3865 * For most buses all children are equal, so the order does not matter.
3866 * Other buses, such as acpi, carefully order their child devices to
3867 * express implicit dependencies between them. For such buses it is
3868 * safer to bring down devices in the reverse order.
3870 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3871 error = BUS_SUSPEND_CHILD(dev, child);
3873 child = TAILQ_NEXT(child, link);
3874 if (child != NULL) {
3875 TAILQ_FOREACH_FROM(child, &dev->children, link)
3876 BUS_RESUME_CHILD(dev, child);
3885 * @brief Helper function for implementing DEVICE_RESUME()
3887 * This function can be used to help implement the DEVICE_RESUME() for
3888 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3891 bus_generic_resume(device_t dev)
3895 TAILQ_FOREACH(child, &dev->children, link) {
3896 BUS_RESUME_CHILD(dev, child);
3897 /* if resume fails, there's nothing we can usefully do... */
3903 * @brief Helper function for implementing BUS_RESET_POST
3905 * Bus can use this function to implement common operations of
3906 * re-attaching or resuming the children after the bus itself was
3907 * reset, and after restoring bus-unique state of children.
3909 * @param dev The bus
3910 * #param flags DEVF_RESET_*
3913 bus_helper_reset_post(device_t dev, int flags)
3919 TAILQ_FOREACH(child, &dev->children,link) {
3920 BUS_RESET_POST(dev, child);
3921 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3922 device_probe_and_attach(child) :
3923 BUS_RESUME_CHILD(dev, child);
3924 if (error == 0 && error1 != 0)
3931 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3933 child = TAILQ_NEXT(child, link);
3936 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3937 BUS_RESET_POST(dev, child);
3938 if ((flags & DEVF_RESET_DETACH) != 0)
3939 device_probe_and_attach(child);
3941 BUS_RESUME_CHILD(dev, child);
3946 * @brief Helper function for implementing BUS_RESET_PREPARE
3948 * Bus can use this function to implement common operations of
3949 * detaching or suspending the children before the bus itself is
3950 * reset, and then save bus-unique state of children that must
3951 * persists around reset.
3953 * @param dev The bus
3954 * #param flags DEVF_RESET_*
3957 bus_helper_reset_prepare(device_t dev, int flags)
3962 if (dev->state != DS_ATTACHED)
3965 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3966 if ((flags & DEVF_RESET_DETACH) != 0) {
3967 error = device_get_state(child) == DS_ATTACHED ?
3968 device_detach(child) : 0;
3970 error = BUS_SUSPEND_CHILD(dev, child);
3973 error = BUS_RESET_PREPARE(dev, child);
3975 if ((flags & DEVF_RESET_DETACH) != 0)
3976 device_probe_and_attach(child);
3978 BUS_RESUME_CHILD(dev, child);
3982 bus_helper_reset_prepare_rollback(dev, child, flags);
3990 * @brief Helper function for implementing BUS_PRINT_CHILD().
3992 * This function prints the first part of the ascii representation of
3993 * @p child, including its name, unit and description (if any - see
3994 * device_set_desc()).
3996 * @returns the number of characters printed
3999 bus_print_child_header(device_t dev, device_t child)
4003 if (device_get_desc(child)) {
4004 retval += device_printf(child, "<%s>", device_get_desc(child));
4006 retval += printf("%s", device_get_nameunit(child));
4013 * @brief Helper function for implementing BUS_PRINT_CHILD().
4015 * This function prints the last part of the ascii representation of
4016 * @p child, which consists of the string @c " on " followed by the
4017 * name and unit of the @p dev.
4019 * @returns the number of characters printed
4022 bus_print_child_footer(device_t dev, device_t child)
4024 return (printf(" on %s\n", device_get_nameunit(dev)));
4028 * @brief Helper function for implementing BUS_PRINT_CHILD().
4030 * This function prints out the VM domain for the given device.
4032 * @returns the number of characters printed
4035 bus_print_child_domain(device_t dev, device_t child)
4039 /* No domain? Don't print anything */
4040 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4043 return (printf(" numa-domain %d", domain));
4047 * @brief Helper function for implementing BUS_PRINT_CHILD().
4049 * This function simply calls bus_print_child_header() followed by
4050 * bus_print_child_footer().
4052 * @returns the number of characters printed
4055 bus_generic_print_child(device_t dev, device_t child)
4059 retval += bus_print_child_header(dev, child);
4060 retval += bus_print_child_domain(dev, child);
4061 retval += bus_print_child_footer(dev, child);
4067 * @brief Stub function for implementing BUS_READ_IVAR().
4072 bus_generic_read_ivar(device_t dev, device_t child, int index,
4079 * @brief Stub function for implementing BUS_WRITE_IVAR().
4084 bus_generic_write_ivar(device_t dev, device_t child, int index,
4091 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4095 struct resource_list *
4096 bus_generic_get_resource_list(device_t dev, device_t child)
4102 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4104 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4105 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4106 * and then calls device_probe_and_attach() for each unattached child.
4109 bus_generic_driver_added(device_t dev, driver_t *driver)
4113 DEVICE_IDENTIFY(driver, dev);
4114 TAILQ_FOREACH(child, &dev->children, link) {
4115 if (child->state == DS_NOTPRESENT ||
4116 (child->flags & DF_REBID))
4117 device_probe_and_attach(child);
4122 * @brief Helper function for implementing BUS_NEW_PASS().
4124 * This implementing of BUS_NEW_PASS() first calls the identify
4125 * routines for any drivers that probe at the current pass. Then it
4126 * walks the list of devices for this bus. If a device is already
4127 * attached, then it calls BUS_NEW_PASS() on that device. If the
4128 * device is not already attached, it attempts to attach a driver to
4132 bus_generic_new_pass(device_t dev)
4139 TAILQ_FOREACH(dl, &dc->drivers, link) {
4140 if (dl->pass == bus_current_pass)
4141 DEVICE_IDENTIFY(dl->driver, dev);
4143 TAILQ_FOREACH(child, &dev->children, link) {
4144 if (child->state >= DS_ATTACHED)
4145 BUS_NEW_PASS(child);
4146 else if (child->state == DS_NOTPRESENT)
4147 device_probe_and_attach(child);
4152 * @brief Helper function for implementing BUS_SETUP_INTR().
4154 * This simple implementation of BUS_SETUP_INTR() simply calls the
4155 * BUS_SETUP_INTR() method of the parent of @p dev.
4158 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4159 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4162 /* Propagate up the bus hierarchy until someone handles it. */
4164 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4165 filter, intr, arg, cookiep));
4170 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4172 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4173 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4176 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4179 /* Propagate up the bus hierarchy until someone handles it. */
4181 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4186 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4188 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4189 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4192 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4194 /* Propagate up the bus hierarchy until someone handles it. */
4196 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4201 * @brief Helper function for implementing BUS_RESUME_INTR().
4203 * This simple implementation of BUS_RESUME_INTR() simply calls the
4204 * BUS_RESUME_INTR() method of the parent of @p dev.
4207 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4209 /* Propagate up the bus hierarchy until someone handles it. */
4211 return (BUS_RESUME_INTR(dev->parent, child, irq));
4216 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4218 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4219 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4222 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4223 struct resource *r, rman_res_t start, rman_res_t end)
4225 /* Propagate up the bus hierarchy until someone handles it. */
4227 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4233 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4235 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4236 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4239 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4240 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4242 /* Propagate up the bus hierarchy until someone handles it. */
4244 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4245 start, end, count, flags));
4250 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4252 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4253 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4256 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4259 /* Propagate up the bus hierarchy until someone handles it. */
4261 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4267 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4269 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4270 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4273 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4276 /* Propagate up the bus hierarchy until someone handles it. */
4278 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4284 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4286 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4287 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4290 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4291 int rid, struct resource *r)
4293 /* Propagate up the bus hierarchy until someone handles it. */
4295 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4301 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4303 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4304 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4307 bus_generic_map_resource(device_t dev, device_t child, int type,
4308 struct resource *r, struct resource_map_request *args,
4309 struct resource_map *map)
4311 /* Propagate up the bus hierarchy until someone handles it. */
4313 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4319 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4321 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4322 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4325 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4326 struct resource *r, struct resource_map *map)
4328 /* Propagate up the bus hierarchy until someone handles it. */
4330 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4335 * @brief Helper function for implementing BUS_BIND_INTR().
4337 * This simple implementation of BUS_BIND_INTR() simply calls the
4338 * BUS_BIND_INTR() method of the parent of @p dev.
4341 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4344 /* Propagate up the bus hierarchy until someone handles it. */
4346 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4351 * @brief Helper function for implementing BUS_CONFIG_INTR().
4353 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4354 * BUS_CONFIG_INTR() method of the parent of @p dev.
4357 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4358 enum intr_polarity pol)
4360 /* Propagate up the bus hierarchy until someone handles it. */
4362 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4367 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4369 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4370 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4373 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4374 void *cookie, const char *descr)
4376 /* Propagate up the bus hierarchy until someone handles it. */
4378 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4384 * @brief Helper function for implementing BUS_GET_CPUS().
4386 * This simple implementation of BUS_GET_CPUS() simply calls the
4387 * BUS_GET_CPUS() method of the parent of @p dev.
4390 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4391 size_t setsize, cpuset_t *cpuset)
4393 /* Propagate up the bus hierarchy until someone handles it. */
4394 if (dev->parent != NULL)
4395 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4400 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4402 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4403 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4406 bus_generic_get_dma_tag(device_t dev, device_t child)
4408 /* Propagate up the bus hierarchy until someone handles it. */
4409 if (dev->parent != NULL)
4410 return (BUS_GET_DMA_TAG(dev->parent, child));
4415 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4417 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4418 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4421 bus_generic_get_bus_tag(device_t dev, device_t child)
4423 /* Propagate up the bus hierarchy until someone handles it. */
4424 if (dev->parent != NULL)
4425 return (BUS_GET_BUS_TAG(dev->parent, child));
4426 return ((bus_space_tag_t)0);
4430 * @brief Helper function for implementing BUS_GET_RESOURCE().
4432 * This implementation of BUS_GET_RESOURCE() uses the
4433 * resource_list_find() function to do most of the work. It calls
4434 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4438 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4439 rman_res_t *startp, rman_res_t *countp)
4441 struct resource_list * rl = NULL;
4442 struct resource_list_entry * rle = NULL;
4444 rl = BUS_GET_RESOURCE_LIST(dev, child);
4448 rle = resource_list_find(rl, type, rid);
4453 *startp = rle->start;
4455 *countp = rle->count;
4461 * @brief Helper function for implementing BUS_SET_RESOURCE().
4463 * This implementation of BUS_SET_RESOURCE() uses the
4464 * resource_list_add() function to do most of the work. It calls
4465 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4469 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4470 rman_res_t start, rman_res_t count)
4472 struct resource_list * rl = NULL;
4474 rl = BUS_GET_RESOURCE_LIST(dev, child);
4478 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4484 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4486 * This implementation of BUS_DELETE_RESOURCE() uses the
4487 * resource_list_delete() function to do most of the work. It calls
4488 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4492 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4494 struct resource_list * rl = NULL;
4496 rl = BUS_GET_RESOURCE_LIST(dev, child);
4500 resource_list_delete(rl, type, rid);
4506 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4508 * This implementation of BUS_RELEASE_RESOURCE() uses the
4509 * resource_list_release() function to do most of the work. It calls
4510 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4513 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4514 int rid, struct resource *r)
4516 struct resource_list * rl = NULL;
4518 if (device_get_parent(child) != dev)
4519 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4522 rl = BUS_GET_RESOURCE_LIST(dev, child);
4526 return (resource_list_release(rl, dev, child, type, rid, r));
4530 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4532 * This implementation of BUS_ALLOC_RESOURCE() uses the
4533 * resource_list_alloc() function to do most of the work. It calls
4534 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4537 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4538 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4540 struct resource_list * rl = NULL;
4542 if (device_get_parent(child) != dev)
4543 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4544 type, rid, start, end, count, flags));
4546 rl = BUS_GET_RESOURCE_LIST(dev, child);
4550 return (resource_list_alloc(rl, dev, child, type, rid,
4551 start, end, count, flags));
4555 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4557 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4558 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4561 bus_generic_child_present(device_t dev, device_t child)
4563 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4567 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4570 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4576 * @brief Helper function for implementing BUS_RESCAN().
4578 * This null implementation of BUS_RESCAN() always fails to indicate
4579 * the bus does not support rescanning.
4582 bus_null_rescan(device_t dev)
4588 * Some convenience functions to make it easier for drivers to use the
4589 * resource-management functions. All these really do is hide the
4590 * indirection through the parent's method table, making for slightly
4591 * less-wordy code. In the future, it might make sense for this code
4592 * to maintain some sort of a list of resources allocated by each device.
4596 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4597 struct resource **res)
4601 for (i = 0; rs[i].type != -1; i++)
4603 for (i = 0; rs[i].type != -1; i++) {
4604 res[i] = bus_alloc_resource_any(dev,
4605 rs[i].type, &rs[i].rid, rs[i].flags);
4606 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4607 bus_release_resources(dev, rs, res);
4615 bus_release_resources(device_t dev, const struct resource_spec *rs,
4616 struct resource **res)
4620 for (i = 0; rs[i].type != -1; i++)
4621 if (res[i] != NULL) {
4622 bus_release_resource(
4623 dev, rs[i].type, rs[i].rid, res[i]);
4629 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4631 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4635 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4636 rman_res_t end, rman_res_t count, u_int flags)
4638 struct resource *res;
4640 if (dev->parent == NULL)
4642 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4648 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4650 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4654 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4657 if (dev->parent == NULL)
4659 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4663 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4665 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4669 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4671 if (dev->parent == NULL)
4673 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4677 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4679 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4683 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4685 if (dev->parent == NULL)
4687 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4691 * @brief Wrapper function for BUS_MAP_RESOURCE().
4693 * This function simply calls the BUS_MAP_RESOURCE() method of the
4697 bus_map_resource(device_t dev, int type, struct resource *r,
4698 struct resource_map_request *args, struct resource_map *map)
4700 if (dev->parent == NULL)
4702 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4706 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4708 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4712 bus_unmap_resource(device_t dev, int type, struct resource *r,
4713 struct resource_map *map)
4715 if (dev->parent == NULL)
4717 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4721 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4723 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4727 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4731 if (dev->parent == NULL)
4733 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4738 * @brief Wrapper function for BUS_SETUP_INTR().
4740 * This function simply calls the BUS_SETUP_INTR() method of the
4744 bus_setup_intr(device_t dev, struct resource *r, int flags,
4745 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4749 if (dev->parent == NULL)
4751 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4755 if (handler != NULL && !(flags & INTR_MPSAFE))
4756 device_printf(dev, "[GIANT-LOCKED]\n");
4761 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4763 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4767 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4769 if (dev->parent == NULL)
4771 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4775 * @brief Wrapper function for BUS_SUSPEND_INTR().
4777 * This function simply calls the BUS_SUSPEND_INTR() method of the
4781 bus_suspend_intr(device_t dev, struct resource *r)
4783 if (dev->parent == NULL)
4785 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4789 * @brief Wrapper function for BUS_RESUME_INTR().
4791 * This function simply calls the BUS_RESUME_INTR() method of the
4795 bus_resume_intr(device_t dev, struct resource *r)
4797 if (dev->parent == NULL)
4799 return (BUS_RESUME_INTR(dev->parent, dev, r));
4803 * @brief Wrapper function for BUS_BIND_INTR().
4805 * This function simply calls the BUS_BIND_INTR() method of the
4809 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4811 if (dev->parent == NULL)
4813 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4817 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4819 * This function first formats the requested description into a
4820 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4821 * the parent of @p dev.
4824 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4825 const char *fmt, ...)
4828 char descr[MAXCOMLEN + 1];
4830 if (dev->parent == NULL)
4833 vsnprintf(descr, sizeof(descr), fmt, ap);
4835 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4839 * @brief Wrapper function for BUS_SET_RESOURCE().
4841 * This function simply calls the BUS_SET_RESOURCE() method of the
4845 bus_set_resource(device_t dev, int type, int rid,
4846 rman_res_t start, rman_res_t count)
4848 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4853 * @brief Wrapper function for BUS_GET_RESOURCE().
4855 * This function simply calls the BUS_GET_RESOURCE() method of the
4859 bus_get_resource(device_t dev, int type, int rid,
4860 rman_res_t *startp, rman_res_t *countp)
4862 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4867 * @brief Wrapper function for BUS_GET_RESOURCE().
4869 * This function simply calls the BUS_GET_RESOURCE() method of the
4870 * parent of @p dev and returns the start value.
4873 bus_get_resource_start(device_t dev, int type, int rid)
4879 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4887 * @brief Wrapper function for BUS_GET_RESOURCE().
4889 * This function simply calls the BUS_GET_RESOURCE() method of the
4890 * parent of @p dev and returns the count value.
4893 bus_get_resource_count(device_t dev, int type, int rid)
4899 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4907 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4909 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4913 bus_delete_resource(device_t dev, int type, int rid)
4915 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4919 * @brief Wrapper function for BUS_CHILD_PRESENT().
4921 * This function simply calls the BUS_CHILD_PRESENT() method of the
4925 bus_child_present(device_t child)
4927 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4931 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4933 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4937 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4941 parent = device_get_parent(child);
4942 if (parent == NULL) {
4946 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4950 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4952 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4956 bus_child_location_str(device_t child, char *buf, size_t buflen)
4960 parent = device_get_parent(child);
4961 if (parent == NULL) {
4965 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4969 * @brief Wrapper function for BUS_GET_CPUS().
4971 * This function simply calls the BUS_GET_CPUS() method of the
4975 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4979 parent = device_get_parent(dev);
4982 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4986 * @brief Wrapper function for BUS_GET_DMA_TAG().
4988 * This function simply calls the BUS_GET_DMA_TAG() method of the
4992 bus_get_dma_tag(device_t dev)
4996 parent = device_get_parent(dev);
4999 return (BUS_GET_DMA_TAG(parent, dev));
5003 * @brief Wrapper function for BUS_GET_BUS_TAG().
5005 * This function simply calls the BUS_GET_BUS_TAG() method of the
5009 bus_get_bus_tag(device_t dev)
5013 parent = device_get_parent(dev);
5015 return ((bus_space_tag_t)0);
5016 return (BUS_GET_BUS_TAG(parent, dev));
5020 * @brief Wrapper function for BUS_GET_DOMAIN().
5022 * This function simply calls the BUS_GET_DOMAIN() method of the
5026 bus_get_domain(device_t dev, int *domain)
5028 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5031 /* Resume all devices and then notify userland that we're up again. */
5033 root_resume(device_t dev)
5037 error = bus_generic_resume(dev);
5039 devctl_notify("kern", "power", "resume", NULL);
5044 root_print_child(device_t dev, device_t child)
5048 retval += bus_print_child_header(dev, child);
5049 retval += printf("\n");
5055 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5056 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5059 * If an interrupt mapping gets to here something bad has happened.
5061 panic("root_setup_intr");
5065 * If we get here, assume that the device is permanent and really is
5066 * present in the system. Removable bus drivers are expected to intercept
5067 * this call long before it gets here. We return -1 so that drivers that
5068 * really care can check vs -1 or some ERRNO returned higher in the food
5072 root_child_present(device_t dev, device_t child)
5078 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5083 /* Default to returning the set of all CPUs. */
5084 if (setsize != sizeof(cpuset_t))
5093 static kobj_method_t root_methods[] = {
5094 /* Device interface */
5095 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5096 KOBJMETHOD(device_suspend, bus_generic_suspend),
5097 KOBJMETHOD(device_resume, root_resume),
5100 KOBJMETHOD(bus_print_child, root_print_child),
5101 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5102 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5103 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5104 KOBJMETHOD(bus_child_present, root_child_present),
5105 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5110 static driver_t root_driver = {
5117 devclass_t root_devclass;
5120 root_bus_module_handler(module_t mod, int what, void* arg)
5124 TAILQ_INIT(&bus_data_devices);
5125 kobj_class_compile((kobj_class_t) &root_driver);
5126 root_bus = make_device(NULL, "root", 0);
5127 root_bus->desc = "System root bus";
5128 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5129 root_bus->driver = &root_driver;
5130 root_bus->state = DS_ATTACHED;
5131 root_devclass = devclass_find_internal("root", NULL, FALSE);
5136 device_shutdown(root_bus);
5139 return (EOPNOTSUPP);
5145 static moduledata_t root_bus_mod = {
5147 root_bus_module_handler,
5150 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5153 * @brief Automatically configure devices
5155 * This function begins the autoconfiguration process by calling
5156 * device_probe_and_attach() for each child of the @c root0 device.
5159 root_bus_configure(void)
5163 /* Eventually this will be split up, but this is sufficient for now. */
5164 bus_set_pass(BUS_PASS_DEFAULT);
5168 * @brief Module handler for registering device drivers
5170 * This module handler is used to automatically register device
5171 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5172 * devclass_add_driver() for the driver described by the
5173 * driver_module_data structure pointed to by @p arg
5176 driver_module_handler(module_t mod, int what, void *arg)
5178 struct driver_module_data *dmd;
5179 devclass_t bus_devclass;
5180 kobj_class_t driver;
5183 dmd = (struct driver_module_data *)arg;
5184 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5189 if (dmd->dmd_chainevh)
5190 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5192 pass = dmd->dmd_pass;
5193 driver = dmd->dmd_driver;
5194 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5195 DRIVERNAME(driver), dmd->dmd_busname, pass));
5196 error = devclass_add_driver(bus_devclass, driver, pass,
5201 PDEBUG(("Unloading module: driver %s from bus %s",
5202 DRIVERNAME(dmd->dmd_driver),
5204 error = devclass_delete_driver(bus_devclass,
5207 if (!error && dmd->dmd_chainevh)
5208 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5211 PDEBUG(("Quiesce module: driver %s from bus %s",
5212 DRIVERNAME(dmd->dmd_driver),
5214 error = devclass_quiesce_driver(bus_devclass,
5217 if (!error && dmd->dmd_chainevh)
5218 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5229 * @brief Enumerate all hinted devices for this bus.
5231 * Walks through the hints for this bus and calls the bus_hinted_child
5232 * routine for each one it fines. It searches first for the specific
5233 * bus that's being probed for hinted children (eg isa0), and then for
5234 * generic children (eg isa).
5236 * @param dev bus device to enumerate
5239 bus_enumerate_hinted_children(device_t bus)
5242 const char *dname, *busname;
5246 * enumerate all devices on the specific bus
5248 busname = device_get_nameunit(bus);
5250 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5251 BUS_HINTED_CHILD(bus, dname, dunit);
5254 * and all the generic ones.
5256 busname = device_get_name(bus);
5258 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5259 BUS_HINTED_CHILD(bus, dname, dunit);
5264 /* the _short versions avoid iteration by not calling anything that prints
5265 * more than oneliners. I love oneliners.
5269 print_device_short(device_t dev, int indent)
5274 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5275 dev->unit, dev->desc,
5276 (dev->parent? "":"no "),
5277 (TAILQ_EMPTY(&dev->children)? "no ":""),
5278 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5279 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5280 (dev->flags&DF_WILDCARD? "wildcard,":""),
5281 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5282 (dev->flags&DF_REBID? "rebiddable,":""),
5283 (dev->flags&DF_SUSPENDED? "suspended,":""),
5284 (dev->ivars? "":"no "),
5285 (dev->softc? "":"no "),
5290 print_device(device_t dev, int indent)
5295 print_device_short(dev, indent);
5297 indentprintf(("Parent:\n"));
5298 print_device_short(dev->parent, indent+1);
5299 indentprintf(("Driver:\n"));
5300 print_driver_short(dev->driver, indent+1);
5301 indentprintf(("Devclass:\n"));
5302 print_devclass_short(dev->devclass, indent+1);
5306 print_device_tree_short(device_t dev, int indent)
5307 /* print the device and all its children (indented) */
5314 print_device_short(dev, indent);
5316 TAILQ_FOREACH(child, &dev->children, link) {
5317 print_device_tree_short(child, indent+1);
5322 print_device_tree(device_t dev, int indent)
5323 /* print the device and all its children (indented) */
5330 print_device(dev, indent);
5332 TAILQ_FOREACH(child, &dev->children, link) {
5333 print_device_tree(child, indent+1);
5338 print_driver_short(driver_t *driver, int indent)
5343 indentprintf(("driver %s: softc size = %zd\n",
5344 driver->name, driver->size));
5348 print_driver(driver_t *driver, int indent)
5353 print_driver_short(driver, indent);
5357 print_driver_list(driver_list_t drivers, int indent)
5359 driverlink_t driver;
5361 TAILQ_FOREACH(driver, &drivers, link) {
5362 print_driver(driver->driver, indent);
5367 print_devclass_short(devclass_t dc, int indent)
5372 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5376 print_devclass(devclass_t dc, int indent)
5383 print_devclass_short(dc, indent);
5384 indentprintf(("Drivers:\n"));
5385 print_driver_list(dc->drivers, indent+1);
5387 indentprintf(("Devices:\n"));
5388 for (i = 0; i < dc->maxunit; i++)
5390 print_device(dc->devices[i], indent+1);
5394 print_devclass_list_short(void)
5398 printf("Short listing of devclasses, drivers & devices:\n");
5399 TAILQ_FOREACH(dc, &devclasses, link) {
5400 print_devclass_short(dc, 0);
5405 print_devclass_list(void)
5409 printf("Full listing of devclasses, drivers & devices:\n");
5410 TAILQ_FOREACH(dc, &devclasses, link) {
5411 print_devclass(dc, 0);
5418 * User-space access to the device tree.
5420 * We implement a small set of nodes:
5422 * hw.bus Single integer read method to obtain the
5423 * current generation count.
5424 * hw.bus.devices Reads the entire device tree in flat space.
5425 * hw.bus.rman Resource manager interface
5427 * We might like to add the ability to scan devclasses and/or drivers to
5428 * determine what else is currently loaded/available.
5432 sysctl_bus_info(SYSCTL_HANDLER_ARGS)
5434 struct u_businfo ubus;
5436 ubus.ub_version = BUS_USER_VERSION;
5437 ubus.ub_generation = bus_data_generation;
5439 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5441 SYSCTL_PROC(_hw_bus, OID_AUTO, info, CTLTYPE_STRUCT | CTLFLAG_RD |
5442 CTLFLAG_MPSAFE, NULL, 0, sysctl_bus_info, "S,u_businfo",
5443 "bus-related data");
5446 sysctl_devices(SYSCTL_HANDLER_ARGS)
5448 int *name = (int *)arg1;
5449 u_int namelen = arg2;
5452 struct u_device *udev;
5459 if (bus_data_generation_check(name[0]))
5465 * Scan the list of devices, looking for the requested index.
5467 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5475 * Populate the return item, careful not to overflow the buffer.
5477 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5480 udev->dv_handle = (uintptr_t)dev;
5481 udev->dv_parent = (uintptr_t)dev->parent;
5482 udev->dv_devflags = dev->devflags;
5483 udev->dv_flags = dev->flags;
5484 udev->dv_state = dev->state;
5485 walker = udev->dv_fields;
5486 ep = walker + sizeof(udev->dv_fields);
5488 if ((src) == NULL) \
5491 strlcpy(walker, (src), ep - walker); \
5492 walker += strlen(walker) + 1; \
5500 CP(dev->driver != NULL ? dev->driver->name : NULL);
5501 bus_child_pnpinfo_str(dev, walker, ep - walker);
5502 walker += strlen(walker) + 1;
5505 bus_child_location_str(dev, walker, ep - walker);
5506 walker += strlen(walker) + 1;
5512 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5517 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5518 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5519 "system device tree");
5522 bus_data_generation_check(int generation)
5524 if (generation != bus_data_generation)
5527 /* XXX generate optimised lists here? */
5532 bus_data_generation_update(void)
5534 atomic_add_int(&bus_data_generation, 1);
5538 bus_free_resource(device_t dev, int type, struct resource *r)
5542 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5546 device_lookup_by_name(const char *name)
5550 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5551 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5558 * /dev/devctl2 implementation. The existing /dev/devctl device has
5559 * implicit semantics on open, so it could not be reused for this.
5560 * Another option would be to call this /dev/bus?
5563 find_device(struct devreq *req, device_t *devp)
5568 * First, ensure that the name is nul terminated.
5570 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5574 * Second, try to find an attached device whose name matches
5577 dev = device_lookup_by_name(req->dr_name);
5583 /* Finally, give device enumerators a chance. */
5585 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5593 driver_exists(device_t bus, const char *driver)
5597 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5598 if (devclass_find_driver_internal(dc, driver) != NULL)
5605 device_gen_nomatch(device_t dev)
5609 if (dev->flags & DF_NEEDNOMATCH &&
5610 dev->state == DS_NOTPRESENT) {
5611 BUS_PROBE_NOMATCH(dev->parent, dev);
5613 dev->flags |= DF_DONENOMATCH;
5615 dev->flags &= ~DF_NEEDNOMATCH;
5616 TAILQ_FOREACH(child, &dev->children, link) {
5617 device_gen_nomatch(child);
5622 device_do_deferred_actions(void)
5628 * Walk through the devclasses to find all the drivers we've tagged as
5629 * deferred during the freeze and call the driver added routines. They
5630 * have already been added to the lists in the background, so the driver
5631 * added routines that trigger a probe will have all the right bidders
5632 * for the probe auction.
5634 TAILQ_FOREACH(dc, &devclasses, link) {
5635 TAILQ_FOREACH(dl, &dc->drivers, link) {
5636 if (dl->flags & DL_DEFERRED_PROBE) {
5637 devclass_driver_added(dc, dl->driver);
5638 dl->flags &= ~DL_DEFERRED_PROBE;
5644 * We also defer no-match events during a freeze. Walk the tree and
5645 * generate all the pent-up events that are still relevant.
5647 device_gen_nomatch(root_bus);
5648 bus_data_generation_update();
5652 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5659 /* Locate the device to control. */
5661 req = (struct devreq *)data;
5669 case DEV_SET_DRIVER:
5670 case DEV_CLEAR_DRIVER:
5674 error = priv_check(td, PRIV_DRIVER);
5676 error = find_device(req, &dev);
5680 error = priv_check(td, PRIV_DRIVER);
5691 /* Perform the requested operation. */
5694 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5696 else if (!device_is_enabled(dev))
5699 error = device_probe_and_attach(dev);
5702 if (!device_is_attached(dev)) {
5706 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5707 error = device_quiesce(dev);
5711 error = device_detach(dev);
5714 if (device_is_enabled(dev)) {
5720 * If the device has been probed but not attached (e.g.
5721 * when it has been disabled by a loader hint), just
5722 * attach the device rather than doing a full probe.
5725 if (device_is_alive(dev)) {
5727 * If the device was disabled via a hint, clear
5730 if (resource_disabled(dev->driver->name, dev->unit))
5731 resource_unset_value(dev->driver->name,
5732 dev->unit, "disabled");
5733 error = device_attach(dev);
5735 error = device_probe_and_attach(dev);
5738 if (!device_is_enabled(dev)) {
5743 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5744 error = device_quiesce(dev);
5750 * Force DF_FIXEDCLASS on around detach to preserve
5751 * the existing name.
5754 dev->flags |= DF_FIXEDCLASS;
5755 error = device_detach(dev);
5756 if (!(old & DF_FIXEDCLASS))
5757 dev->flags &= ~DF_FIXEDCLASS;
5759 device_disable(dev);
5762 if (device_is_suspended(dev)) {
5766 if (device_get_parent(dev) == NULL) {
5770 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5773 if (!device_is_suspended(dev)) {
5777 if (device_get_parent(dev) == NULL) {
5781 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5783 case DEV_SET_DRIVER: {
5787 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5790 if (driver[0] == '\0') {
5794 if (dev->devclass != NULL &&
5795 strcmp(driver, dev->devclass->name) == 0)
5796 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5800 * Scan drivers for this device's bus looking for at
5801 * least one matching driver.
5803 if (dev->parent == NULL) {
5807 if (!driver_exists(dev->parent, driver)) {
5811 dc = devclass_create(driver);
5817 /* Detach device if necessary. */
5818 if (device_is_attached(dev)) {
5819 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5820 error = device_detach(dev);
5827 /* Clear any previously-fixed device class and unit. */
5828 if (dev->flags & DF_FIXEDCLASS)
5829 devclass_delete_device(dev->devclass, dev);
5830 dev->flags |= DF_WILDCARD;
5833 /* Force the new device class. */
5834 error = devclass_add_device(dc, dev);
5837 dev->flags |= DF_FIXEDCLASS;
5838 error = device_probe_and_attach(dev);
5841 case DEV_CLEAR_DRIVER:
5842 if (!(dev->flags & DF_FIXEDCLASS)) {
5846 if (device_is_attached(dev)) {
5847 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5848 error = device_detach(dev);
5855 dev->flags &= ~DF_FIXEDCLASS;
5856 dev->flags |= DF_WILDCARD;
5857 devclass_delete_device(dev->devclass, dev);
5858 error = device_probe_and_attach(dev);
5861 if (!device_is_attached(dev)) {
5865 error = BUS_RESCAN(dev);
5870 parent = device_get_parent(dev);
5871 if (parent == NULL) {
5875 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5876 if (bus_child_present(dev) != 0) {
5882 error = device_delete_child(parent, dev);
5889 device_frozen = true;
5895 device_do_deferred_actions();
5896 device_frozen = false;
5900 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5904 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5912 static struct cdevsw devctl2_cdevsw = {
5913 .d_version = D_VERSION,
5914 .d_ioctl = devctl2_ioctl,
5915 .d_name = "devctl2",
5921 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5922 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5926 * APIs to manage deprecation and obsolescence.
5928 static int obsolete_panic = 0;
5929 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5930 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5931 "2 = if deprecated)");
5934 gone_panic(int major, int running, const char *msg)
5936 switch (obsolete_panic)
5941 if (running < major)
5950 _gone_in(int major, const char *msg)
5952 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5953 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5954 printf("Obsolete code will be removed soon: %s\n", msg);
5956 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5961 _gone_in_dev(device_t dev, int major, const char *msg)
5963 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5964 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5966 "Obsolete code will be removed soon: %s\n", msg);
5969 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5974 DB_SHOW_COMMAND(device, db_show_device)
5981 dev = (device_t)addr;
5983 db_printf("name: %s\n", device_get_nameunit(dev));
5984 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5985 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5986 db_printf(" addr: %p\n", dev);
5987 db_printf(" parent: %p\n", dev->parent);
5988 db_printf(" softc: %p\n", dev->softc);
5989 db_printf(" ivars: %p\n", dev->ivars);
5992 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5996 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5997 db_show_device((db_expr_t)dev, true, count, modif);