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/eventhandler.h>
38 #include <sys/filio.h>
40 #include <sys/kernel.h>
42 #include <sys/limits.h>
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #include <sys/queue.h>
51 #include <machine/bus.h>
52 #include <sys/random.h>
55 #include <sys/selinfo.h>
56 #include <sys/signalvar.h>
58 #include <sys/sysctl.h>
59 #include <sys/systm.h>
62 #include <sys/cpuset.h>
66 #include <machine/cpu.h>
67 #include <machine/stdarg.h>
74 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
75 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
78 * Used to attach drivers to devclasses.
80 typedef struct driverlink *driverlink_t;
83 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
85 TAILQ_ENTRY(driverlink) passlink;
89 * Forward declarations
91 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
92 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
93 typedef TAILQ_HEAD(device_list, device) device_list_t;
96 TAILQ_ENTRY(devclass) link;
97 devclass_t parent; /* parent in devclass hierarchy */
98 driver_list_t drivers; /* bus devclasses store drivers for bus */
100 device_t *devices; /* array of devices indexed by unit */
101 int maxunit; /* size of devices array */
103 #define DC_HAS_CHILDREN 1
105 struct sysctl_ctx_list sysctl_ctx;
106 struct sysctl_oid *sysctl_tree;
110 * @brief Implementation of device.
114 * A device is a kernel object. The first field must be the
115 * current ops table for the object.
122 TAILQ_ENTRY(device) link; /**< list of devices in parent */
123 TAILQ_ENTRY(device) devlink; /**< global device list membership */
124 device_t parent; /**< parent of this device */
125 device_list_t children; /**< list of child devices */
128 * Details of this device.
130 driver_t *driver; /**< current driver */
131 devclass_t devclass; /**< current device class */
132 int unit; /**< current unit number */
133 char* nameunit; /**< name+unit e.g. foodev0 */
134 char* desc; /**< driver specific description */
135 int busy; /**< count of calls to device_busy() */
136 device_state_t state; /**< current device state */
137 uint32_t devflags; /**< api level flags for device_get_flags() */
138 u_int flags; /**< internal device flags */
139 u_int order; /**< order from device_add_child_ordered() */
140 void *ivars; /**< instance variables */
141 void *softc; /**< current driver's variables */
143 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
144 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
147 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
148 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
150 EVENTHANDLER_LIST_DEFINE(device_attach);
151 EVENTHANDLER_LIST_DEFINE(device_detach);
152 EVENTHANDLER_LIST_DEFINE(dev_lookup);
154 static void devctl2_init(void);
156 #define DRIVERNAME(d) ((d)? d->name : "no driver")
157 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
161 static int bus_debug = 1;
162 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
165 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
166 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
169 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
170 * prevent syslog from deleting initial spaces
172 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
174 static void print_device_short(device_t dev, int indent);
175 static void print_device(device_t dev, int indent);
176 void print_device_tree_short(device_t dev, int indent);
177 void print_device_tree(device_t dev, int indent);
178 static void print_driver_short(driver_t *driver, int indent);
179 static void print_driver(driver_t *driver, int indent);
180 static void print_driver_list(driver_list_t drivers, int indent);
181 static void print_devclass_short(devclass_t dc, int indent);
182 static void print_devclass(devclass_t dc, int indent);
183 void print_devclass_list_short(void);
184 void print_devclass_list(void);
187 /* Make the compiler ignore the function calls */
188 #define PDEBUG(a) /* nop */
189 #define DEVICENAME(d) /* nop */
191 #define print_device_short(d,i) /* nop */
192 #define print_device(d,i) /* nop */
193 #define print_device_tree_short(d,i) /* nop */
194 #define print_device_tree(d,i) /* nop */
195 #define print_driver_short(d,i) /* nop */
196 #define print_driver(d,i) /* nop */
197 #define print_driver_list(d,i) /* nop */
198 #define print_devclass_short(d,i) /* nop */
199 #define print_devclass(d,i) /* nop */
200 #define print_devclass_list_short() /* nop */
201 #define print_devclass_list() /* nop */
209 DEVCLASS_SYSCTL_PARENT,
213 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
215 devclass_t dc = (devclass_t)arg1;
219 case DEVCLASS_SYSCTL_PARENT:
220 value = dc->parent ? dc->parent->name : "";
225 return (SYSCTL_OUT_STR(req, value));
229 devclass_sysctl_init(devclass_t dc)
232 if (dc->sysctl_tree != NULL)
234 sysctl_ctx_init(&dc->sysctl_ctx);
235 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
236 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
237 CTLFLAG_RD, NULL, "");
238 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
239 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
240 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
246 DEVICE_SYSCTL_DRIVER,
247 DEVICE_SYSCTL_LOCATION,
248 DEVICE_SYSCTL_PNPINFO,
249 DEVICE_SYSCTL_PARENT,
253 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
255 device_t dev = (device_t)arg1;
262 case DEVICE_SYSCTL_DESC:
263 value = dev->desc ? dev->desc : "";
265 case DEVICE_SYSCTL_DRIVER:
266 value = dev->driver ? dev->driver->name : "";
268 case DEVICE_SYSCTL_LOCATION:
269 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
270 bus_child_location_str(dev, buf, 1024);
272 case DEVICE_SYSCTL_PNPINFO:
273 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
274 bus_child_pnpinfo_str(dev, buf, 1024);
276 case DEVICE_SYSCTL_PARENT:
277 value = dev->parent ? dev->parent->nameunit : "";
282 error = SYSCTL_OUT_STR(req, value);
289 device_sysctl_init(device_t dev)
291 devclass_t dc = dev->devclass;
294 if (dev->sysctl_tree != NULL)
296 devclass_sysctl_init(dc);
297 sysctl_ctx_init(&dev->sysctl_ctx);
298 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
299 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
300 dev->nameunit + strlen(dc->name),
301 CTLFLAG_RD, NULL, "", "device_index");
302 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
303 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
304 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
305 "device description");
306 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
307 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
308 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
309 "device driver name");
310 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
311 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
312 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
313 "device location relative to parent");
314 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
315 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
316 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
317 "device identification");
318 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
319 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
320 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
322 if (bus_get_domain(dev, &domain) == 0)
323 SYSCTL_ADD_INT(&dev->sysctl_ctx,
324 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
325 CTLFLAG_RD, NULL, domain, "NUMA domain");
329 device_sysctl_update(device_t dev)
331 devclass_t dc = dev->devclass;
333 if (dev->sysctl_tree == NULL)
335 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
339 device_sysctl_fini(device_t dev)
341 if (dev->sysctl_tree == NULL)
343 sysctl_ctx_free(&dev->sysctl_ctx);
344 dev->sysctl_tree = NULL;
348 * /dev/devctl implementation
352 * This design allows only one reader for /dev/devctl. This is not desirable
353 * in the long run, but will get a lot of hair out of this implementation.
354 * Maybe we should make this device a clonable device.
356 * Also note: we specifically do not attach a device to the device_t tree
357 * to avoid potential chicken and egg problems. One could argue that all
358 * of this belongs to the root node. One could also further argue that the
359 * sysctl interface that we have not might more properly be an ioctl
360 * interface, but at this stage of the game, I'm not inclined to rock that
363 * I'm also not sure that the SIGIO support is done correctly or not, as
364 * I copied it from a driver that had SIGIO support that likely hasn't been
365 * tested since 3.4 or 2.2.8!
368 /* Deprecated way to adjust queue length */
369 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
370 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
371 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
372 "devctl disable -- deprecated");
374 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
375 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
376 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
377 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
378 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
380 static d_open_t devopen;
381 static d_close_t devclose;
382 static d_read_t devread;
383 static d_ioctl_t devioctl;
384 static d_poll_t devpoll;
385 static d_kqfilter_t devkqfilter;
387 static struct cdevsw dev_cdevsw = {
388 .d_version = D_VERSION,
394 .d_kqfilter = devkqfilter,
398 struct dev_event_info
401 TAILQ_ENTRY(dev_event_info) dei_link;
404 TAILQ_HEAD(devq, dev_event_info);
406 static struct dev_softc
419 static void filt_devctl_detach(struct knote *kn);
420 static int filt_devctl_read(struct knote *kn, long hint);
422 struct filterops devctl_rfiltops = {
424 .f_detach = filt_devctl_detach,
425 .f_event = filt_devctl_read,
428 static struct cdev *devctl_dev;
433 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
434 UID_ROOT, GID_WHEEL, 0600, "devctl");
435 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
436 cv_init(&devsoftc.cv, "dev cv");
437 TAILQ_INIT(&devsoftc.devq);
438 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
443 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
446 mtx_lock(&devsoftc.mtx);
447 if (devsoftc.inuse) {
448 mtx_unlock(&devsoftc.mtx);
453 mtx_unlock(&devsoftc.mtx);
458 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
461 mtx_lock(&devsoftc.mtx);
463 devsoftc.nonblock = 0;
465 cv_broadcast(&devsoftc.cv);
466 funsetown(&devsoftc.sigio);
467 mtx_unlock(&devsoftc.mtx);
472 * The read channel for this device is used to report changes to
473 * userland in realtime. We are required to free the data as well as
474 * the n1 object because we allocate them separately. Also note that
475 * we return one record at a time. If you try to read this device a
476 * character at a time, you will lose the rest of the data. Listening
477 * programs are expected to cope.
480 devread(struct cdev *dev, struct uio *uio, int ioflag)
482 struct dev_event_info *n1;
485 mtx_lock(&devsoftc.mtx);
486 while (TAILQ_EMPTY(&devsoftc.devq)) {
487 if (devsoftc.nonblock) {
488 mtx_unlock(&devsoftc.mtx);
491 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
494 * Need to translate ERESTART to EINTR here? -- jake
496 mtx_unlock(&devsoftc.mtx);
500 n1 = TAILQ_FIRST(&devsoftc.devq);
501 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
503 mtx_unlock(&devsoftc.mtx);
504 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
505 free(n1->dei_data, M_BUS);
511 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
517 devsoftc.nonblock = 1;
519 devsoftc.nonblock = 0;
528 return fsetown(*(int *)data, &devsoftc.sigio);
530 *(int *)data = fgetown(&devsoftc.sigio);
533 /* (un)Support for other fcntl() calls. */
544 devpoll(struct cdev *dev, int events, struct thread *td)
548 mtx_lock(&devsoftc.mtx);
549 if (events & (POLLIN | POLLRDNORM)) {
550 if (!TAILQ_EMPTY(&devsoftc.devq))
551 revents = events & (POLLIN | POLLRDNORM);
553 selrecord(td, &devsoftc.sel);
555 mtx_unlock(&devsoftc.mtx);
561 devkqfilter(struct cdev *dev, struct knote *kn)
565 if (kn->kn_filter == EVFILT_READ) {
566 kn->kn_fop = &devctl_rfiltops;
567 knlist_add(&devsoftc.sel.si_note, kn, 0);
575 filt_devctl_detach(struct knote *kn)
578 knlist_remove(&devsoftc.sel.si_note, kn, 0);
582 filt_devctl_read(struct knote *kn, long hint)
584 kn->kn_data = devsoftc.queued;
585 return (kn->kn_data != 0);
589 * @brief Return whether the userland process is running
592 devctl_process_running(void)
594 return (devsoftc.inuse == 1);
598 * @brief Queue data to be read from the devctl device
600 * Generic interface to queue data to the devctl device. It is
601 * assumed that @p data is properly formatted. It is further assumed
602 * that @p data is allocated using the M_BUS malloc type.
605 devctl_queue_data_f(char *data, int flags)
607 struct dev_event_info *n1 = NULL, *n2 = NULL;
609 if (strlen(data) == 0)
611 if (devctl_queue_length == 0)
613 n1 = malloc(sizeof(*n1), M_BUS, flags);
617 mtx_lock(&devsoftc.mtx);
618 if (devctl_queue_length == 0) {
619 mtx_unlock(&devsoftc.mtx);
620 free(n1->dei_data, M_BUS);
624 /* Leave at least one spot in the queue... */
625 while (devsoftc.queued > devctl_queue_length - 1) {
626 n2 = TAILQ_FIRST(&devsoftc.devq);
627 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
628 free(n2->dei_data, M_BUS);
632 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
634 cv_broadcast(&devsoftc.cv);
635 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
636 mtx_unlock(&devsoftc.mtx);
637 selwakeup(&devsoftc.sel);
638 if (devsoftc.async && devsoftc.sigio != NULL)
639 pgsigio(&devsoftc.sigio, SIGIO, 0);
643 * We have to free data on all error paths since the caller
644 * assumes it will be free'd when this item is dequeued.
651 devctl_queue_data(char *data)
654 devctl_queue_data_f(data, M_NOWAIT);
658 * @brief Send a 'notification' to userland, using standard ways
661 devctl_notify_f(const char *system, const char *subsystem, const char *type,
662 const char *data, int flags)
668 return; /* BOGUS! Must specify system. */
669 if (subsystem == NULL)
670 return; /* BOGUS! Must specify subsystem. */
672 return; /* BOGUS! Must specify type. */
673 len += strlen(" system=") + strlen(system);
674 len += strlen(" subsystem=") + strlen(subsystem);
675 len += strlen(" type=") + strlen(type);
676 /* add in the data message plus newline. */
679 len += 3; /* '!', '\n', and NUL */
680 msg = malloc(len, M_BUS, flags);
682 return; /* Drop it on the floor */
684 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
685 system, subsystem, type, data);
687 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
688 system, subsystem, type);
689 devctl_queue_data_f(msg, flags);
693 devctl_notify(const char *system, const char *subsystem, const char *type,
697 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
701 * Common routine that tries to make sending messages as easy as possible.
702 * We allocate memory for the data, copy strings into that, but do not
703 * free it unless there's an error. The dequeue part of the driver should
704 * free the data. We don't send data when the device is disabled. We do
705 * send data, even when we have no listeners, because we wish to avoid
706 * races relating to startup and restart of listening applications.
708 * devaddq is designed to string together the type of event, with the
709 * object of that event, plus the plug and play info and location info
710 * for that event. This is likely most useful for devices, but less
711 * useful for other consumers of this interface. Those should use
712 * the devctl_queue_data() interface instead.
715 devaddq(const char *type, const char *what, device_t dev)
722 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
724 data = malloc(1024, M_BUS, M_NOWAIT);
728 /* get the bus specific location of this device */
729 loc = malloc(1024, M_BUS, M_NOWAIT);
733 bus_child_location_str(dev, loc, 1024);
735 /* Get the bus specific pnp info of this device */
736 pnp = malloc(1024, M_BUS, M_NOWAIT);
740 bus_child_pnpinfo_str(dev, pnp, 1024);
742 /* Get the parent of this device, or / if high enough in the tree. */
743 if (device_get_parent(dev) == NULL)
744 parstr = "."; /* Or '/' ? */
746 parstr = device_get_nameunit(device_get_parent(dev));
747 /* String it all together. */
748 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
752 devctl_queue_data(data);
762 * A device was added to the tree. We are called just after it successfully
763 * attaches (that is, probe and attach success for this device). No call
764 * is made if a device is merely parented into the tree. See devnomatch
765 * if probe fails. If attach fails, no notification is sent (but maybe
766 * we should have a different message for this).
769 devadded(device_t dev)
771 devaddq("+", device_get_nameunit(dev), dev);
775 * A device was removed from the tree. We are called just before this
779 devremoved(device_t dev)
781 devaddq("-", device_get_nameunit(dev), dev);
785 * Called when there's no match for this device. This is only called
786 * the first time that no match happens, so we don't keep getting this
787 * message. Should that prove to be undesirable, we can change it.
788 * This is called when all drivers that can attach to a given bus
789 * decline to accept this device. Other errors may not be detected.
792 devnomatch(device_t dev)
794 devaddq("?", "", dev);
798 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
800 struct dev_event_info *n1;
803 dis = (devctl_queue_length == 0);
804 error = sysctl_handle_int(oidp, &dis, 0, req);
805 if (error || !req->newptr)
807 if (mtx_initialized(&devsoftc.mtx))
808 mtx_lock(&devsoftc.mtx);
810 while (!TAILQ_EMPTY(&devsoftc.devq)) {
811 n1 = TAILQ_FIRST(&devsoftc.devq);
812 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
813 free(n1->dei_data, M_BUS);
817 devctl_queue_length = 0;
819 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
821 if (mtx_initialized(&devsoftc.mtx))
822 mtx_unlock(&devsoftc.mtx);
827 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
829 struct dev_event_info *n1;
832 q = devctl_queue_length;
833 error = sysctl_handle_int(oidp, &q, 0, req);
834 if (error || !req->newptr)
838 if (mtx_initialized(&devsoftc.mtx))
839 mtx_lock(&devsoftc.mtx);
840 devctl_queue_length = q;
841 while (devsoftc.queued > devctl_queue_length) {
842 n1 = TAILQ_FIRST(&devsoftc.devq);
843 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
844 free(n1->dei_data, M_BUS);
848 if (mtx_initialized(&devsoftc.mtx))
849 mtx_unlock(&devsoftc.mtx);
854 * @brief safely quotes strings that might have double quotes in them.
856 * The devctl protocol relies on quoted strings having matching quotes.
857 * This routine quotes any internal quotes so the resulting string
858 * is safe to pass to snprintf to construct, for example pnp info strings.
859 * Strings are always terminated with a NUL, but may be truncated if longer
860 * than @p len bytes after quotes.
862 * @param sb sbuf to place the characters into
863 * @param src Original buffer.
866 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
869 while (*src != '\0') {
870 if (*src == '"' || *src == '\\')
872 sbuf_putc(sb, *src++);
876 /* End of /dev/devctl code */
878 static TAILQ_HEAD(,device) bus_data_devices;
879 static int bus_data_generation = 1;
881 static kobj_method_t null_methods[] = {
885 DEFINE_CLASS(null, null_methods, 0);
888 * Bus pass implementation
891 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
892 int bus_current_pass = BUS_PASS_ROOT;
896 * @brief Register the pass level of a new driver attachment
898 * Register a new driver attachment's pass level. If no driver
899 * attachment with the same pass level has been added, then @p new
900 * will be added to the global passes list.
902 * @param new the new driver attachment
905 driver_register_pass(struct driverlink *new)
907 struct driverlink *dl;
909 /* We only consider pass numbers during boot. */
910 if (bus_current_pass == BUS_PASS_DEFAULT)
914 * Walk the passes list. If we already know about this pass
915 * then there is nothing to do. If we don't, then insert this
916 * driver link into the list.
918 TAILQ_FOREACH(dl, &passes, passlink) {
919 if (dl->pass < new->pass)
921 if (dl->pass == new->pass)
923 TAILQ_INSERT_BEFORE(dl, new, passlink);
926 TAILQ_INSERT_TAIL(&passes, new, passlink);
930 * @brief Raise the current bus pass
932 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
933 * method on the root bus to kick off a new device tree scan for each
934 * new pass level that has at least one driver.
937 bus_set_pass(int pass)
939 struct driverlink *dl;
941 if (bus_current_pass > pass)
942 panic("Attempt to lower bus pass level");
944 TAILQ_FOREACH(dl, &passes, passlink) {
945 /* Skip pass values below the current pass level. */
946 if (dl->pass <= bus_current_pass)
950 * Bail once we hit a driver with a pass level that is
957 * Raise the pass level to the next level and rescan
960 bus_current_pass = dl->pass;
961 BUS_NEW_PASS(root_bus);
965 * If there isn't a driver registered for the requested pass,
966 * then bus_current_pass might still be less than 'pass'. Set
967 * it to 'pass' in that case.
969 if (bus_current_pass < pass)
970 bus_current_pass = pass;
971 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
975 * Devclass implementation
978 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
982 * @brief Find or create a device class
984 * If a device class with the name @p classname exists, return it,
985 * otherwise if @p create is non-zero create and return a new device
988 * If @p parentname is non-NULL, the parent of the devclass is set to
989 * the devclass of that name.
991 * @param classname the devclass name to find or create
992 * @param parentname the parent devclass name or @c NULL
993 * @param create non-zero to create a devclass
996 devclass_find_internal(const char *classname, const char *parentname,
1001 PDEBUG(("looking for %s", classname));
1005 TAILQ_FOREACH(dc, &devclasses, link) {
1006 if (!strcmp(dc->name, classname))
1010 if (create && !dc) {
1011 PDEBUG(("creating %s", classname));
1012 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1013 M_BUS, M_NOWAIT | M_ZERO);
1017 dc->name = (char*) (dc + 1);
1018 strcpy(dc->name, classname);
1019 TAILQ_INIT(&dc->drivers);
1020 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1022 bus_data_generation_update();
1026 * If a parent class is specified, then set that as our parent so
1027 * that this devclass will support drivers for the parent class as
1028 * well. If the parent class has the same name don't do this though
1029 * as it creates a cycle that can trigger an infinite loop in
1030 * device_probe_child() if a device exists for which there is no
1033 if (parentname && dc && !dc->parent &&
1034 strcmp(classname, parentname) != 0) {
1035 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1036 dc->parent->flags |= DC_HAS_CHILDREN;
1043 * @brief Create a device class
1045 * If a device class with the name @p classname exists, return it,
1046 * otherwise create and return a new device class.
1048 * @param classname the devclass name to find or create
1051 devclass_create(const char *classname)
1053 return (devclass_find_internal(classname, NULL, TRUE));
1057 * @brief Find a device class
1059 * If a device class with the name @p classname exists, return it,
1060 * otherwise return @c NULL.
1062 * @param classname the devclass name to find
1065 devclass_find(const char *classname)
1067 return (devclass_find_internal(classname, NULL, FALSE));
1071 * @brief Register that a device driver has been added to a devclass
1073 * Register that a device driver has been added to a devclass. This
1074 * is called by devclass_add_driver to accomplish the recursive
1075 * notification of all the children classes of dc, as well as dc.
1076 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1079 * We do a full search here of the devclass list at each iteration
1080 * level to save storing children-lists in the devclass structure. If
1081 * we ever move beyond a few dozen devices doing this, we may need to
1084 * @param dc the devclass to edit
1085 * @param driver the driver that was just added
1088 devclass_driver_added(devclass_t dc, driver_t *driver)
1094 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1096 for (i = 0; i < dc->maxunit; i++)
1097 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1098 BUS_DRIVER_ADDED(dc->devices[i], driver);
1101 * Walk through the children classes. Since we only keep a
1102 * single parent pointer around, we walk the entire list of
1103 * devclasses looking for children. We set the
1104 * DC_HAS_CHILDREN flag when a child devclass is created on
1105 * the parent, so we only walk the list for those devclasses
1106 * that have children.
1108 if (!(dc->flags & DC_HAS_CHILDREN))
1111 TAILQ_FOREACH(dc, &devclasses, link) {
1112 if (dc->parent == parent)
1113 devclass_driver_added(dc, driver);
1118 * @brief Add a device driver to a device class
1120 * Add a device driver to a devclass. This is normally called
1121 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1122 * all devices in the devclass will be called to allow them to attempt
1123 * to re-probe any unmatched children.
1125 * @param dc the devclass to edit
1126 * @param driver the driver to register
1129 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1132 const char *parentname;
1134 PDEBUG(("%s", DRIVERNAME(driver)));
1136 /* Don't allow invalid pass values. */
1137 if (pass <= BUS_PASS_ROOT)
1140 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1145 * Compile the driver's methods. Also increase the reference count
1146 * so that the class doesn't get freed when the last instance
1147 * goes. This means we can safely use static methods and avoids a
1148 * double-free in devclass_delete_driver.
1150 kobj_class_compile((kobj_class_t) driver);
1153 * If the driver has any base classes, make the
1154 * devclass inherit from the devclass of the driver's
1155 * first base class. This will allow the system to
1156 * search for drivers in both devclasses for children
1157 * of a device using this driver.
1159 if (driver->baseclasses)
1160 parentname = driver->baseclasses[0]->name;
1163 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1165 dl->driver = driver;
1166 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1167 driver->refs++; /* XXX: kobj_mtx */
1169 driver_register_pass(dl);
1171 devclass_driver_added(dc, driver);
1172 bus_data_generation_update();
1177 * @brief Register that a device driver has been deleted from a devclass
1179 * Register that a device driver has been removed from a devclass.
1180 * This is called by devclass_delete_driver to accomplish the
1181 * recursive notification of all the children classes of busclass, as
1182 * well as busclass. Each layer will attempt to detach the driver
1183 * from any devices that are children of the bus's devclass. The function
1184 * will return an error if a device fails to detach.
1186 * We do a full search here of the devclass list at each iteration
1187 * level to save storing children-lists in the devclass structure. If
1188 * we ever move beyond a few dozen devices doing this, we may need to
1191 * @param busclass the devclass of the parent bus
1192 * @param dc the devclass of the driver being deleted
1193 * @param driver the driver being deleted
1196 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1203 * Disassociate from any devices. We iterate through all the
1204 * devices in the devclass of the driver and detach any which are
1205 * using the driver and which have a parent in the devclass which
1206 * we are deleting from.
1208 * Note that since a driver can be in multiple devclasses, we
1209 * should not detach devices which are not children of devices in
1210 * the affected devclass.
1212 for (i = 0; i < dc->maxunit; i++) {
1213 if (dc->devices[i]) {
1214 dev = dc->devices[i];
1215 if (dev->driver == driver && dev->parent &&
1216 dev->parent->devclass == busclass) {
1217 if ((error = device_detach(dev)) != 0)
1219 BUS_PROBE_NOMATCH(dev->parent, dev);
1221 dev->flags |= DF_DONENOMATCH;
1227 * Walk through the children classes. Since we only keep a
1228 * single parent pointer around, we walk the entire list of
1229 * devclasses looking for children. We set the
1230 * DC_HAS_CHILDREN flag when a child devclass is created on
1231 * the parent, so we only walk the list for those devclasses
1232 * that have children.
1234 if (!(busclass->flags & DC_HAS_CHILDREN))
1237 TAILQ_FOREACH(busclass, &devclasses, link) {
1238 if (busclass->parent == parent) {
1239 error = devclass_driver_deleted(busclass, dc, driver);
1248 * @brief Delete a device driver from a device class
1250 * Delete a device driver from a devclass. This is normally called
1251 * automatically by DRIVER_MODULE().
1253 * If the driver is currently attached to any devices,
1254 * devclass_delete_driver() will first attempt to detach from each
1255 * device. If one of the detach calls fails, the driver will not be
1258 * @param dc the devclass to edit
1259 * @param driver the driver to unregister
1262 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1264 devclass_t dc = devclass_find(driver->name);
1268 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1274 * Find the link structure in the bus' list of drivers.
1276 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1277 if (dl->driver == driver)
1282 PDEBUG(("%s not found in %s list", driver->name,
1287 error = devclass_driver_deleted(busclass, dc, driver);
1291 TAILQ_REMOVE(&busclass->drivers, dl, link);
1296 if (driver->refs == 0)
1297 kobj_class_free((kobj_class_t) driver);
1299 bus_data_generation_update();
1304 * @brief Quiesces a set of device drivers from a device class
1306 * Quiesce a device driver from a devclass. This is normally called
1307 * automatically by DRIVER_MODULE().
1309 * If the driver is currently attached to any devices,
1310 * devclass_quiesece_driver() will first attempt to quiesce each
1313 * @param dc the devclass to edit
1314 * @param driver the driver to unregister
1317 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1319 devclass_t dc = devclass_find(driver->name);
1325 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1331 * Find the link structure in the bus' list of drivers.
1333 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1334 if (dl->driver == driver)
1339 PDEBUG(("%s not found in %s list", driver->name,
1345 * Quiesce all devices. We iterate through all the devices in
1346 * the devclass of the driver and quiesce any which are using
1347 * the driver and which have a parent in the devclass which we
1350 * Note that since a driver can be in multiple devclasses, we
1351 * should not quiesce devices which are not children of
1352 * devices in the affected devclass.
1354 for (i = 0; i < dc->maxunit; i++) {
1355 if (dc->devices[i]) {
1356 dev = dc->devices[i];
1357 if (dev->driver == driver && dev->parent &&
1358 dev->parent->devclass == busclass) {
1359 if ((error = device_quiesce(dev)) != 0)
1372 devclass_find_driver_internal(devclass_t dc, const char *classname)
1376 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1378 TAILQ_FOREACH(dl, &dc->drivers, link) {
1379 if (!strcmp(dl->driver->name, classname))
1383 PDEBUG(("not found"));
1388 * @brief Return the name of the devclass
1391 devclass_get_name(devclass_t dc)
1397 * @brief Find a device given a unit number
1399 * @param dc the devclass to search
1400 * @param unit the unit number to search for
1402 * @returns the device with the given unit number or @c
1403 * NULL if there is no such device
1406 devclass_get_device(devclass_t dc, int unit)
1408 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1410 return (dc->devices[unit]);
1414 * @brief Find the softc field of a device given a unit number
1416 * @param dc the devclass to search
1417 * @param unit the unit number to search for
1419 * @returns the softc field of the device with the given
1420 * unit number or @c NULL if there is no such
1424 devclass_get_softc(devclass_t dc, int unit)
1428 dev = devclass_get_device(dc, unit);
1432 return (device_get_softc(dev));
1436 * @brief Get a list of devices in the devclass
1438 * An array containing a list of all the devices in the given devclass
1439 * is allocated and returned in @p *devlistp. The number of devices
1440 * in the array is returned in @p *devcountp. The caller should free
1441 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1443 * @param dc the devclass to examine
1444 * @param devlistp points at location for array pointer return
1446 * @param devcountp points at location for array size return value
1449 * @retval ENOMEM the array allocation failed
1452 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1457 count = devclass_get_count(dc);
1458 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1463 for (i = 0; i < dc->maxunit; i++) {
1464 if (dc->devices[i]) {
1465 list[count] = dc->devices[i];
1477 * @brief Get a list of drivers in the devclass
1479 * An array containing a list of pointers to all the drivers in the
1480 * given devclass is allocated and returned in @p *listp. The number
1481 * of drivers in the array is returned in @p *countp. The caller should
1482 * free the array using @c free(p, M_TEMP).
1484 * @param dc the devclass to examine
1485 * @param listp gives location for array pointer return value
1486 * @param countp gives location for number of array elements
1490 * @retval ENOMEM the array allocation failed
1493 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1500 TAILQ_FOREACH(dl, &dc->drivers, link)
1502 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1507 TAILQ_FOREACH(dl, &dc->drivers, link) {
1508 list[count] = dl->driver;
1518 * @brief Get the number of devices in a devclass
1520 * @param dc the devclass to examine
1523 devclass_get_count(devclass_t dc)
1528 for (i = 0; i < dc->maxunit; i++)
1535 * @brief Get the maximum unit number used in a devclass
1537 * Note that this is one greater than the highest currently-allocated
1538 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1539 * that not even the devclass has been allocated yet.
1541 * @param dc the devclass to examine
1544 devclass_get_maxunit(devclass_t dc)
1548 return (dc->maxunit);
1552 * @brief Find a free unit number in a devclass
1554 * This function searches for the first unused unit number greater
1555 * that or equal to @p unit.
1557 * @param dc the devclass to examine
1558 * @param unit the first unit number to check
1561 devclass_find_free_unit(devclass_t dc, int unit)
1565 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1571 * @brief Set the parent of a devclass
1573 * The parent class is normally initialised automatically by
1576 * @param dc the devclass to edit
1577 * @param pdc the new parent devclass
1580 devclass_set_parent(devclass_t dc, devclass_t pdc)
1586 * @brief Get the parent of a devclass
1588 * @param dc the devclass to examine
1591 devclass_get_parent(devclass_t dc)
1593 return (dc->parent);
1596 struct sysctl_ctx_list *
1597 devclass_get_sysctl_ctx(devclass_t dc)
1599 return (&dc->sysctl_ctx);
1603 devclass_get_sysctl_tree(devclass_t dc)
1605 return (dc->sysctl_tree);
1610 * @brief Allocate a unit number
1612 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1613 * will do). The allocated unit number is returned in @p *unitp.
1615 * @param dc the devclass to allocate from
1616 * @param unitp points at the location for the allocated unit
1620 * @retval EEXIST the requested unit number is already allocated
1621 * @retval ENOMEM memory allocation failure
1624 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1629 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1631 /* Ask the parent bus if it wants to wire this device. */
1633 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1636 /* If we were given a wired unit number, check for existing device */
1639 if (unit >= 0 && unit < dc->maxunit &&
1640 dc->devices[unit] != NULL) {
1642 printf("%s: %s%d already exists; skipping it\n",
1643 dc->name, dc->name, *unitp);
1647 /* Unwired device, find the next available slot for it */
1649 for (unit = 0;; unit++) {
1650 /* If there is an "at" hint for a unit then skip it. */
1651 if (resource_string_value(dc->name, unit, "at", &s) ==
1655 /* If this device slot is already in use, skip it. */
1656 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1664 * We've selected a unit beyond the length of the table, so let's
1665 * extend the table to make room for all units up to and including
1668 if (unit >= dc->maxunit) {
1669 device_t *newlist, *oldlist;
1672 oldlist = dc->devices;
1673 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1674 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1677 if (oldlist != NULL)
1678 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1679 bzero(newlist + dc->maxunit,
1680 sizeof(device_t) * (newsize - dc->maxunit));
1681 dc->devices = newlist;
1682 dc->maxunit = newsize;
1683 if (oldlist != NULL)
1684 free(oldlist, M_BUS);
1686 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1694 * @brief Add a device to a devclass
1696 * A unit number is allocated for the device (using the device's
1697 * preferred unit number if any) and the device is registered in the
1698 * devclass. This allows the device to be looked up by its unit
1699 * number, e.g. by decoding a dev_t minor number.
1701 * @param dc the devclass to add to
1702 * @param dev the device to add
1705 * @retval EEXIST the requested unit number is already allocated
1706 * @retval ENOMEM memory allocation failure
1709 devclass_add_device(devclass_t dc, device_t dev)
1713 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1715 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1718 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1722 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1723 free(dev->nameunit, M_BUS);
1724 dev->nameunit = NULL;
1727 dc->devices[dev->unit] = dev;
1729 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1736 * @brief Delete a device from a devclass
1738 * The device is removed from the devclass's device list and its unit
1741 * @param dc the devclass to delete from
1742 * @param dev the device to delete
1747 devclass_delete_device(devclass_t dc, device_t dev)
1752 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1754 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1755 panic("devclass_delete_device: inconsistent device class");
1756 dc->devices[dev->unit] = NULL;
1757 if (dev->flags & DF_WILDCARD)
1759 dev->devclass = NULL;
1760 free(dev->nameunit, M_BUS);
1761 dev->nameunit = NULL;
1768 * @brief Make a new device and add it as a child of @p parent
1770 * @param parent the parent of the new device
1771 * @param name the devclass name of the new device or @c NULL
1772 * to leave the devclass unspecified
1773 * @parem unit the unit number of the new device of @c -1 to
1774 * leave the unit number unspecified
1776 * @returns the new device
1779 make_device(device_t parent, const char *name, int unit)
1784 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1787 dc = devclass_find_internal(name, NULL, TRUE);
1789 printf("make_device: can't find device class %s\n",
1797 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1801 dev->parent = parent;
1802 TAILQ_INIT(&dev->children);
1803 kobj_init((kobj_t) dev, &null_class);
1805 dev->devclass = NULL;
1807 dev->nameunit = NULL;
1811 dev->flags = DF_ENABLED;
1814 dev->flags |= DF_WILDCARD;
1816 dev->flags |= DF_FIXEDCLASS;
1817 if (devclass_add_device(dc, dev)) {
1818 kobj_delete((kobj_t) dev, M_BUS);
1822 if (parent != NULL && device_has_quiet_children(parent))
1823 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1827 dev->state = DS_NOTPRESENT;
1829 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1830 bus_data_generation_update();
1837 * @brief Print a description of a device.
1840 device_print_child(device_t dev, device_t child)
1844 if (device_is_alive(child))
1845 retval += BUS_PRINT_CHILD(dev, child);
1847 retval += device_printf(child, " not found\n");
1853 * @brief Create a new device
1855 * This creates a new device and adds it as a child of an existing
1856 * parent device. The new device will be added after the last existing
1857 * child with order zero.
1859 * @param dev the device which will be the parent of the
1861 * @param name devclass name for new device or @c NULL if not
1863 * @param unit unit number for new device or @c -1 if not
1866 * @returns the new device
1869 device_add_child(device_t dev, const char *name, int unit)
1871 return (device_add_child_ordered(dev, 0, name, unit));
1875 * @brief Create a new device
1877 * This creates a new device and adds it as a child of an existing
1878 * parent device. The new device will be added after the last existing
1879 * child with the same order.
1881 * @param dev the device which will be the parent of the
1883 * @param order a value which is used to partially sort the
1884 * children of @p dev - devices created using
1885 * lower values of @p order appear first in @p
1886 * dev's list of children
1887 * @param name devclass name for new device or @c NULL if not
1889 * @param unit unit number for new device or @c -1 if not
1892 * @returns the new device
1895 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1900 PDEBUG(("%s at %s with order %u as unit %d",
1901 name, DEVICENAME(dev), order, unit));
1902 KASSERT(name != NULL || unit == -1,
1903 ("child device with wildcard name and specific unit number"));
1905 child = make_device(dev, name, unit);
1908 child->order = order;
1910 TAILQ_FOREACH(place, &dev->children, link) {
1911 if (place->order > order)
1917 * The device 'place' is the first device whose order is
1918 * greater than the new child.
1920 TAILQ_INSERT_BEFORE(place, child, link);
1923 * The new child's order is greater or equal to the order of
1924 * any existing device. Add the child to the tail of the list.
1926 TAILQ_INSERT_TAIL(&dev->children, child, link);
1929 bus_data_generation_update();
1934 * @brief Delete a device
1936 * This function deletes a device along with all of its children. If
1937 * the device currently has a driver attached to it, the device is
1938 * detached first using device_detach().
1940 * @param dev the parent device
1941 * @param child the device to delete
1944 * @retval non-zero a unit error code describing the error
1947 device_delete_child(device_t dev, device_t child)
1950 device_t grandchild;
1952 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1954 /* detach parent before deleting children, if any */
1955 if ((error = device_detach(child)) != 0)
1958 /* remove children second */
1959 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1960 error = device_delete_child(child, grandchild);
1965 if (child->devclass)
1966 devclass_delete_device(child->devclass, child);
1968 BUS_CHILD_DELETED(dev, child);
1969 TAILQ_REMOVE(&dev->children, child, link);
1970 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1971 kobj_delete((kobj_t) child, M_BUS);
1973 bus_data_generation_update();
1978 * @brief Delete all children devices of the given device, if any.
1980 * This function deletes all children devices of the given device, if
1981 * any, using the device_delete_child() function for each device it
1982 * finds. If a child device cannot be deleted, this function will
1983 * return an error code.
1985 * @param dev the parent device
1988 * @retval non-zero a device would not detach
1991 device_delete_children(device_t dev)
1996 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2000 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2001 error = device_delete_child(dev, child);
2003 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2011 * @brief Find a device given a unit number
2013 * This is similar to devclass_get_devices() but only searches for
2014 * devices which have @p dev as a parent.
2016 * @param dev the parent device to search
2017 * @param unit the unit number to search for. If the unit is -1,
2018 * return the first child of @p dev which has name
2019 * @p classname (that is, the one with the lowest unit.)
2021 * @returns the device with the given unit number or @c
2022 * NULL if there is no such device
2025 device_find_child(device_t dev, const char *classname, int unit)
2030 dc = devclass_find(classname);
2035 child = devclass_get_device(dc, unit);
2036 if (child && child->parent == dev)
2039 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2040 child = devclass_get_device(dc, unit);
2041 if (child && child->parent == dev)
2052 first_matching_driver(devclass_t dc, device_t dev)
2055 return (devclass_find_driver_internal(dc, dev->devclass->name));
2056 return (TAILQ_FIRST(&dc->drivers));
2063 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2065 if (dev->devclass) {
2067 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2068 if (!strcmp(dev->devclass->name, dl->driver->name))
2072 return (TAILQ_NEXT(last, link));
2079 device_probe_child(device_t dev, device_t child)
2082 driverlink_t best = NULL;
2084 int result, pri = 0;
2085 int hasclass = (child->devclass != NULL);
2091 panic("device_probe_child: parent device has no devclass");
2094 * If the state is already probed, then return. However, don't
2095 * return if we can rebid this object.
2097 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2100 for (; dc; dc = dc->parent) {
2101 for (dl = first_matching_driver(dc, child);
2103 dl = next_matching_driver(dc, child, dl)) {
2104 /* If this driver's pass is too high, then ignore it. */
2105 if (dl->pass > bus_current_pass)
2108 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2109 result = device_set_driver(child, dl->driver);
2110 if (result == ENOMEM)
2112 else if (result != 0)
2115 if (device_set_devclass(child,
2116 dl->driver->name) != 0) {
2117 char const * devname =
2118 device_get_name(child);
2119 if (devname == NULL)
2120 devname = "(unknown)";
2121 printf("driver bug: Unable to set "
2122 "devclass (class: %s "
2126 (void)device_set_driver(child, NULL);
2131 /* Fetch any flags for the device before probing. */
2132 resource_int_value(dl->driver->name, child->unit,
2133 "flags", &child->devflags);
2135 result = DEVICE_PROBE(child);
2137 /* Reset flags and devclass before the next probe. */
2138 child->devflags = 0;
2140 (void)device_set_devclass(child, NULL);
2143 * If the driver returns SUCCESS, there can be
2144 * no higher match for this device.
2153 * Reset DF_QUIET in case this driver doesn't
2154 * end up as the best driver.
2156 device_verbose(child);
2159 * Probes that return BUS_PROBE_NOWILDCARD or lower
2160 * only match on devices whose driver was explicitly
2163 if (result <= BUS_PROBE_NOWILDCARD &&
2164 !(child->flags & DF_FIXEDCLASS)) {
2169 * The driver returned an error so it
2170 * certainly doesn't match.
2173 (void)device_set_driver(child, NULL);
2178 * A priority lower than SUCCESS, remember the
2179 * best matching driver. Initialise the value
2180 * of pri for the first match.
2182 if (best == NULL || result > pri) {
2189 * If we have an unambiguous match in this devclass,
2190 * don't look in the parent.
2192 if (best && pri == 0)
2197 * If we found a driver, change state and initialise the devclass.
2199 /* XXX What happens if we rebid and got no best? */
2202 * If this device was attached, and we were asked to
2203 * rescan, and it is a different driver, then we have
2204 * to detach the old driver and reattach this new one.
2205 * Note, we don't have to check for DF_REBID here
2206 * because if the state is > DS_ALIVE, we know it must
2209 * This assumes that all DF_REBID drivers can have
2210 * their probe routine called at any time and that
2211 * they are idempotent as well as completely benign in
2212 * normal operations.
2214 * We also have to make sure that the detach
2215 * succeeded, otherwise we fail the operation (or
2216 * maybe it should just fail silently? I'm torn).
2218 if (child->state > DS_ALIVE && best->driver != child->driver)
2219 if ((result = device_detach(dev)) != 0)
2222 /* Set the winning driver, devclass, and flags. */
2223 if (!child->devclass) {
2224 result = device_set_devclass(child, best->driver->name);
2228 result = device_set_driver(child, best->driver);
2231 resource_int_value(best->driver->name, child->unit,
2232 "flags", &child->devflags);
2236 * A bit bogus. Call the probe method again to make
2237 * sure that we have the right description.
2239 DEVICE_PROBE(child);
2241 child->flags |= DF_REBID;
2244 child->flags &= ~DF_REBID;
2245 child->state = DS_ALIVE;
2247 bus_data_generation_update();
2255 * @brief Return the parent of a device
2258 device_get_parent(device_t dev)
2260 return (dev->parent);
2264 * @brief Get a list of children of a device
2266 * An array containing a list of all the children of the given device
2267 * is allocated and returned in @p *devlistp. The number of devices
2268 * in the array is returned in @p *devcountp. The caller should free
2269 * the array using @c free(p, M_TEMP).
2271 * @param dev the device to examine
2272 * @param devlistp points at location for array pointer return
2274 * @param devcountp points at location for array size return value
2277 * @retval ENOMEM the array allocation failed
2280 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2287 TAILQ_FOREACH(child, &dev->children, link) {
2296 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2301 TAILQ_FOREACH(child, &dev->children, link) {
2302 list[count] = child;
2313 * @brief Return the current driver for the device or @c NULL if there
2314 * is no driver currently attached
2317 device_get_driver(device_t dev)
2319 return (dev->driver);
2323 * @brief Return the current devclass for the device or @c NULL if
2327 device_get_devclass(device_t dev)
2329 return (dev->devclass);
2333 * @brief Return the name of the device's devclass or @c NULL if there
2337 device_get_name(device_t dev)
2339 if (dev != NULL && dev->devclass)
2340 return (devclass_get_name(dev->devclass));
2345 * @brief Return a string containing the device's devclass name
2346 * followed by an ascii representation of the device's unit number
2350 device_get_nameunit(device_t dev)
2352 return (dev->nameunit);
2356 * @brief Return the device's unit number.
2359 device_get_unit(device_t dev)
2365 * @brief Return the device's description string
2368 device_get_desc(device_t dev)
2374 * @brief Return the device's flags
2377 device_get_flags(device_t dev)
2379 return (dev->devflags);
2382 struct sysctl_ctx_list *
2383 device_get_sysctl_ctx(device_t dev)
2385 return (&dev->sysctl_ctx);
2389 device_get_sysctl_tree(device_t dev)
2391 return (dev->sysctl_tree);
2395 * @brief Print the name of the device followed by a colon and a space
2397 * @returns the number of characters printed
2400 device_print_prettyname(device_t dev)
2402 const char *name = device_get_name(dev);
2405 return (printf("unknown: "));
2406 return (printf("%s%d: ", name, device_get_unit(dev)));
2410 * @brief Print the name of the device followed by a colon, a space
2411 * and the result of calling vprintf() with the value of @p fmt and
2412 * the following arguments.
2414 * @returns the number of characters printed
2417 device_printf(device_t dev, const char * fmt, ...)
2422 retval = device_print_prettyname(dev);
2424 retval += vprintf(fmt, ap);
2433 device_set_desc_internal(device_t dev, const char* desc, int copy)
2435 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2436 free(dev->desc, M_BUS);
2437 dev->flags &= ~DF_DESCMALLOCED;
2442 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2444 strcpy(dev->desc, desc);
2445 dev->flags |= DF_DESCMALLOCED;
2448 /* Avoid a -Wcast-qual warning */
2449 dev->desc = (char *)(uintptr_t) desc;
2452 bus_data_generation_update();
2456 * @brief Set the device's description
2458 * The value of @c desc should be a string constant that will not
2459 * change (at least until the description is changed in a subsequent
2460 * call to device_set_desc() or device_set_desc_copy()).
2463 device_set_desc(device_t dev, const char* desc)
2465 device_set_desc_internal(dev, desc, FALSE);
2469 * @brief Set the device's description
2471 * The string pointed to by @c desc is copied. Use this function if
2472 * the device description is generated, (e.g. with sprintf()).
2475 device_set_desc_copy(device_t dev, const char* desc)
2477 device_set_desc_internal(dev, desc, TRUE);
2481 * @brief Set the device's flags
2484 device_set_flags(device_t dev, uint32_t flags)
2486 dev->devflags = flags;
2490 * @brief Return the device's softc field
2492 * The softc is allocated and zeroed when a driver is attached, based
2493 * on the size field of the driver.
2496 device_get_softc(device_t dev)
2498 return (dev->softc);
2502 * @brief Set the device's softc field
2504 * Most drivers do not need to use this since the softc is allocated
2505 * automatically when the driver is attached.
2508 device_set_softc(device_t dev, void *softc)
2510 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2511 free(dev->softc, M_BUS_SC);
2514 dev->flags |= DF_EXTERNALSOFTC;
2516 dev->flags &= ~DF_EXTERNALSOFTC;
2520 * @brief Free claimed softc
2522 * Most drivers do not need to use this since the softc is freed
2523 * automatically when the driver is detached.
2526 device_free_softc(void *softc)
2528 free(softc, M_BUS_SC);
2532 * @brief Claim softc
2534 * This function can be used to let the driver free the automatically
2535 * allocated softc using "device_free_softc()". This function is
2536 * useful when the driver is refcounting the softc and the softc
2537 * cannot be freed when the "device_detach" method is called.
2540 device_claim_softc(device_t dev)
2543 dev->flags |= DF_EXTERNALSOFTC;
2545 dev->flags &= ~DF_EXTERNALSOFTC;
2549 * @brief Get the device's ivars field
2551 * The ivars field is used by the parent device to store per-device
2552 * state (e.g. the physical location of the device or a list of
2556 device_get_ivars(device_t dev)
2559 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2560 return (dev->ivars);
2564 * @brief Set the device's ivars field
2567 device_set_ivars(device_t dev, void * ivars)
2570 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2575 * @brief Return the device's state
2578 device_get_state(device_t dev)
2580 return (dev->state);
2584 * @brief Set the DF_ENABLED flag for the device
2587 device_enable(device_t dev)
2589 dev->flags |= DF_ENABLED;
2593 * @brief Clear the DF_ENABLED flag for the device
2596 device_disable(device_t dev)
2598 dev->flags &= ~DF_ENABLED;
2602 * @brief Increment the busy counter for the device
2605 device_busy(device_t dev)
2607 if (dev->state < DS_ATTACHING)
2608 panic("device_busy: called for unattached device");
2609 if (dev->busy == 0 && dev->parent)
2610 device_busy(dev->parent);
2612 if (dev->state == DS_ATTACHED)
2613 dev->state = DS_BUSY;
2617 * @brief Decrement the busy counter for the device
2620 device_unbusy(device_t dev)
2622 if (dev->busy != 0 && dev->state != DS_BUSY &&
2623 dev->state != DS_ATTACHING)
2624 panic("device_unbusy: called for non-busy device %s",
2625 device_get_nameunit(dev));
2627 if (dev->busy == 0) {
2629 device_unbusy(dev->parent);
2630 if (dev->state == DS_BUSY)
2631 dev->state = DS_ATTACHED;
2636 * @brief Set the DF_QUIET flag for the device
2639 device_quiet(device_t dev)
2641 dev->flags |= DF_QUIET;
2645 * @brief Set the DF_QUIET_CHILDREN flag for the device
2648 device_quiet_children(device_t dev)
2650 dev->flags |= DF_QUIET_CHILDREN;
2654 * @brief Clear the DF_QUIET flag for the device
2657 device_verbose(device_t dev)
2659 dev->flags &= ~DF_QUIET;
2663 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2666 device_has_quiet_children(device_t dev)
2668 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2672 * @brief Return non-zero if the DF_QUIET flag is set on the device
2675 device_is_quiet(device_t dev)
2677 return ((dev->flags & DF_QUIET) != 0);
2681 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2684 device_is_enabled(device_t dev)
2686 return ((dev->flags & DF_ENABLED) != 0);
2690 * @brief Return non-zero if the device was successfully probed
2693 device_is_alive(device_t dev)
2695 return (dev->state >= DS_ALIVE);
2699 * @brief Return non-zero if the device currently has a driver
2703 device_is_attached(device_t dev)
2705 return (dev->state >= DS_ATTACHED);
2709 * @brief Return non-zero if the device is currently suspended.
2712 device_is_suspended(device_t dev)
2714 return ((dev->flags & DF_SUSPENDED) != 0);
2718 * @brief Set the devclass of a device
2719 * @see devclass_add_device().
2722 device_set_devclass(device_t dev, const char *classname)
2729 devclass_delete_device(dev->devclass, dev);
2733 if (dev->devclass) {
2734 printf("device_set_devclass: device class already set\n");
2738 dc = devclass_find_internal(classname, NULL, TRUE);
2742 error = devclass_add_device(dc, dev);
2744 bus_data_generation_update();
2749 * @brief Set the devclass of a device and mark the devclass fixed.
2750 * @see device_set_devclass()
2753 device_set_devclass_fixed(device_t dev, const char *classname)
2757 if (classname == NULL)
2760 error = device_set_devclass(dev, classname);
2763 dev->flags |= DF_FIXEDCLASS;
2768 * @brief Set the driver of a device
2771 * @retval EBUSY the device already has a driver attached
2772 * @retval ENOMEM a memory allocation failure occurred
2775 device_set_driver(device_t dev, driver_t *driver)
2777 if (dev->state >= DS_ATTACHED)
2780 if (dev->driver == driver)
2783 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2784 free(dev->softc, M_BUS_SC);
2787 device_set_desc(dev, NULL);
2788 kobj_delete((kobj_t) dev, NULL);
2789 dev->driver = driver;
2791 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2792 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2793 dev->softc = malloc(driver->size, M_BUS_SC,
2796 kobj_delete((kobj_t) dev, NULL);
2797 kobj_init((kobj_t) dev, &null_class);
2803 kobj_init((kobj_t) dev, &null_class);
2806 bus_data_generation_update();
2811 * @brief Probe a device, and return this status.
2813 * This function is the core of the device autoconfiguration
2814 * system. Its purpose is to select a suitable driver for a device and
2815 * then call that driver to initialise the hardware appropriately. The
2816 * driver is selected by calling the DEVICE_PROBE() method of a set of
2817 * candidate drivers and then choosing the driver which returned the
2818 * best value. This driver is then attached to the device using
2821 * The set of suitable drivers is taken from the list of drivers in
2822 * the parent device's devclass. If the device was originally created
2823 * with a specific class name (see device_add_child()), only drivers
2824 * with that name are probed, otherwise all drivers in the devclass
2825 * are probed. If no drivers return successful probe values in the
2826 * parent devclass, the search continues in the parent of that
2827 * devclass (see devclass_get_parent()) if any.
2829 * @param dev the device to initialise
2832 * @retval ENXIO no driver was found
2833 * @retval ENOMEM memory allocation failure
2834 * @retval non-zero some other unix error code
2835 * @retval -1 Device already attached
2838 device_probe(device_t dev)
2844 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2847 if (!(dev->flags & DF_ENABLED)) {
2848 if (bootverbose && device_get_name(dev) != NULL) {
2849 device_print_prettyname(dev);
2850 printf("not probed (disabled)\n");
2854 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2855 if (bus_current_pass == BUS_PASS_DEFAULT &&
2856 !(dev->flags & DF_DONENOMATCH)) {
2857 BUS_PROBE_NOMATCH(dev->parent, dev);
2859 dev->flags |= DF_DONENOMATCH;
2867 * @brief Probe a device and attach a driver if possible
2869 * calls device_probe() and attaches if that was successful.
2872 device_probe_and_attach(device_t dev)
2878 error = device_probe(dev);
2881 else if (error != 0)
2884 CURVNET_SET_QUIET(vnet0);
2885 error = device_attach(dev);
2891 * @brief Attach a device driver to a device
2893 * This function is a wrapper around the DEVICE_ATTACH() driver
2894 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2895 * device's sysctl tree, optionally prints a description of the device
2896 * and queues a notification event for user-based device management
2899 * Normally this function is only called internally from
2900 * device_probe_and_attach().
2902 * @param dev the device to initialise
2905 * @retval ENXIO no driver was found
2906 * @retval ENOMEM memory allocation failure
2907 * @retval non-zero some other unix error code
2910 device_attach(device_t dev)
2912 uint64_t attachtime;
2915 if (resource_disabled(dev->driver->name, dev->unit)) {
2916 device_disable(dev);
2918 device_printf(dev, "disabled via hints entry\n");
2922 device_sysctl_init(dev);
2923 if (!device_is_quiet(dev))
2924 device_print_child(dev->parent, dev);
2925 attachtime = get_cyclecount();
2926 dev->state = DS_ATTACHING;
2927 if ((error = DEVICE_ATTACH(dev)) != 0) {
2928 printf("device_attach: %s%d attach returned %d\n",
2929 dev->driver->name, dev->unit, error);
2930 if (!(dev->flags & DF_FIXEDCLASS))
2931 devclass_delete_device(dev->devclass, dev);
2932 (void)device_set_driver(dev, NULL);
2933 device_sysctl_fini(dev);
2934 KASSERT(dev->busy == 0, ("attach failed but busy"));
2935 dev->state = DS_NOTPRESENT;
2938 attachtime = get_cyclecount() - attachtime;
2940 * 4 bits per device is a reasonable value for desktop and server
2941 * hardware with good get_cyclecount() implementations, but WILL
2942 * need to be adjusted on other platforms.
2944 #define RANDOM_PROBE_BIT_GUESS 4
2946 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2947 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2948 dev->driver->name, dev->unit);
2949 random_harvest_direct(&attachtime, sizeof(attachtime),
2950 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2951 device_sysctl_update(dev);
2953 dev->state = DS_BUSY;
2955 dev->state = DS_ATTACHED;
2956 dev->flags &= ~DF_DONENOMATCH;
2957 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2963 * @brief Detach a driver from a device
2965 * This function is a wrapper around the DEVICE_DETACH() driver
2966 * method. If the call to DEVICE_DETACH() succeeds, it calls
2967 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2968 * notification event for user-based device management services and
2969 * cleans up the device's sysctl tree.
2971 * @param dev the device to un-initialise
2974 * @retval ENXIO no driver was found
2975 * @retval ENOMEM memory allocation failure
2976 * @retval non-zero some other unix error code
2979 device_detach(device_t dev)
2985 PDEBUG(("%s", DEVICENAME(dev)));
2986 if (dev->state == DS_BUSY)
2988 if (dev->state != DS_ATTACHED)
2991 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2992 if ((error = DEVICE_DETACH(dev)) != 0) {
2993 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2994 EVHDEV_DETACH_FAILED);
2997 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2998 EVHDEV_DETACH_COMPLETE);
3001 if (!device_is_quiet(dev))
3002 device_printf(dev, "detached\n");
3004 BUS_CHILD_DETACHED(dev->parent, dev);
3006 if (!(dev->flags & DF_FIXEDCLASS))
3007 devclass_delete_device(dev->devclass, dev);
3009 device_verbose(dev);
3010 dev->state = DS_NOTPRESENT;
3011 (void)device_set_driver(dev, NULL);
3012 device_sysctl_fini(dev);
3018 * @brief Tells a driver to quiesce itself.
3020 * This function is a wrapper around the DEVICE_QUIESCE() driver
3021 * method. If the call to DEVICE_QUIESCE() succeeds.
3023 * @param dev the device to quiesce
3026 * @retval ENXIO no driver was found
3027 * @retval ENOMEM memory allocation failure
3028 * @retval non-zero some other unix error code
3031 device_quiesce(device_t dev)
3034 PDEBUG(("%s", DEVICENAME(dev)));
3035 if (dev->state == DS_BUSY)
3037 if (dev->state != DS_ATTACHED)
3040 return (DEVICE_QUIESCE(dev));
3044 * @brief Notify a device of system shutdown
3046 * This function calls the DEVICE_SHUTDOWN() driver method if the
3047 * device currently has an attached driver.
3049 * @returns the value returned by DEVICE_SHUTDOWN()
3052 device_shutdown(device_t dev)
3054 if (dev->state < DS_ATTACHED)
3056 return (DEVICE_SHUTDOWN(dev));
3060 * @brief Set the unit number of a device
3062 * This function can be used to override the unit number used for a
3063 * device (e.g. to wire a device to a pre-configured unit number).
3066 device_set_unit(device_t dev, int unit)
3071 dc = device_get_devclass(dev);
3072 if (unit < dc->maxunit && dc->devices[unit])
3074 err = devclass_delete_device(dc, dev);
3078 err = devclass_add_device(dc, dev);
3082 bus_data_generation_update();
3086 /*======================================*/
3088 * Some useful method implementations to make life easier for bus drivers.
3092 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3097 args->memattr = VM_MEMATTR_UNCACHEABLE;
3101 * @brief Initialise a resource list.
3103 * @param rl the resource list to initialise
3106 resource_list_init(struct resource_list *rl)
3112 * @brief Reclaim memory used by a resource list.
3114 * This function frees the memory for all resource entries on the list
3117 * @param rl the resource list to free
3120 resource_list_free(struct resource_list *rl)
3122 struct resource_list_entry *rle;
3124 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3126 panic("resource_list_free: resource entry is busy");
3127 STAILQ_REMOVE_HEAD(rl, link);
3133 * @brief Add a resource entry.
3135 * This function adds a resource entry using the given @p type, @p
3136 * start, @p end and @p count values. A rid value is chosen by
3137 * searching sequentially for the first unused rid starting at zero.
3139 * @param rl the resource list to edit
3140 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3141 * @param start the start address of the resource
3142 * @param end the end address of the resource
3143 * @param count XXX end-start+1
3146 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3147 rman_res_t end, rman_res_t count)
3152 while (resource_list_find(rl, type, rid) != NULL)
3154 resource_list_add(rl, type, rid, start, end, count);
3159 * @brief Add or modify a resource entry.
3161 * If an existing entry exists with the same type and rid, it will be
3162 * modified using the given values of @p start, @p end and @p
3163 * count. If no entry exists, a new one will be created using the
3164 * given values. The resource list entry that matches is then returned.
3166 * @param rl the resource list to edit
3167 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3168 * @param rid the resource identifier
3169 * @param start the start address of the resource
3170 * @param end the end address of the resource
3171 * @param count XXX end-start+1
3173 struct resource_list_entry *
3174 resource_list_add(struct resource_list *rl, int type, int rid,
3175 rman_res_t start, rman_res_t end, rman_res_t count)
3177 struct resource_list_entry *rle;
3179 rle = resource_list_find(rl, type, rid);
3181 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3184 panic("resource_list_add: can't record entry");
3185 STAILQ_INSERT_TAIL(rl, rle, link);
3193 panic("resource_list_add: resource entry is busy");
3202 * @brief Determine if a resource entry is busy.
3204 * Returns true if a resource entry is busy meaning that it has an
3205 * associated resource that is not an unallocated "reserved" resource.
3207 * @param rl the resource list to search
3208 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3209 * @param rid the resource identifier
3211 * @returns Non-zero if the entry is busy, zero otherwise.
3214 resource_list_busy(struct resource_list *rl, int type, int rid)
3216 struct resource_list_entry *rle;
3218 rle = resource_list_find(rl, type, rid);
3219 if (rle == NULL || rle->res == NULL)
3221 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3222 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3223 ("reserved resource is active"));
3230 * @brief Determine if a resource entry is reserved.
3232 * Returns true if a resource entry is reserved meaning that it has an
3233 * associated "reserved" resource. The resource can either be
3234 * allocated or unallocated.
3236 * @param rl the resource list to search
3237 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3238 * @param rid the resource identifier
3240 * @returns Non-zero if the entry is reserved, zero otherwise.
3243 resource_list_reserved(struct resource_list *rl, int type, int rid)
3245 struct resource_list_entry *rle;
3247 rle = resource_list_find(rl, type, rid);
3248 if (rle != NULL && rle->flags & RLE_RESERVED)
3254 * @brief Find a resource entry by type and rid.
3256 * @param rl the resource list to search
3257 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3258 * @param rid the resource identifier
3260 * @returns the resource entry pointer or NULL if there is no such
3263 struct resource_list_entry *
3264 resource_list_find(struct resource_list *rl, int type, int rid)
3266 struct resource_list_entry *rle;
3268 STAILQ_FOREACH(rle, rl, link) {
3269 if (rle->type == type && rle->rid == rid)
3276 * @brief Delete a resource entry.
3278 * @param rl the resource list to edit
3279 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3280 * @param rid the resource identifier
3283 resource_list_delete(struct resource_list *rl, int type, int rid)
3285 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3288 if (rle->res != NULL)
3289 panic("resource_list_delete: resource has not been released");
3290 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3296 * @brief Allocate a reserved resource
3298 * This can be used by buses to force the allocation of resources
3299 * that are always active in the system even if they are not allocated
3300 * by a driver (e.g. PCI BARs). This function is usually called when
3301 * adding a new child to the bus. The resource is allocated from the
3302 * parent bus when it is reserved. The resource list entry is marked
3303 * with RLE_RESERVED to note that it is a reserved resource.
3305 * Subsequent attempts to allocate the resource with
3306 * resource_list_alloc() will succeed the first time and will set
3307 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3308 * resource that has been allocated is released with
3309 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3310 * the actual resource remains allocated. The resource can be released to
3311 * the parent bus by calling resource_list_unreserve().
3313 * @param rl the resource list to allocate from
3314 * @param bus the parent device of @p child
3315 * @param child the device for which the resource is being reserved
3316 * @param type the type of resource to allocate
3317 * @param rid a pointer to the resource identifier
3318 * @param start hint at the start of the resource range - pass
3319 * @c 0 for any start address
3320 * @param end hint at the end of the resource range - pass
3321 * @c ~0 for any end address
3322 * @param count hint at the size of range required - pass @c 1
3324 * @param flags any extra flags to control the resource
3325 * allocation - see @c RF_XXX flags in
3326 * <sys/rman.h> for details
3328 * @returns the resource which was allocated or @c NULL if no
3329 * resource could be allocated
3332 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3333 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3335 struct resource_list_entry *rle = NULL;
3336 int passthrough = (device_get_parent(child) != bus);
3341 "resource_list_reserve() should only be called for direct children");
3342 if (flags & RF_ACTIVE)
3344 "resource_list_reserve() should only reserve inactive resources");
3346 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3349 rle = resource_list_find(rl, type, *rid);
3350 rle->flags |= RLE_RESERVED;
3356 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3358 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3359 * and passing the allocation up to the parent of @p bus. This assumes
3360 * that the first entry of @c device_get_ivars(child) is a struct
3361 * resource_list. This also handles 'passthrough' allocations where a
3362 * child is a remote descendant of bus by passing the allocation up to
3363 * the parent of bus.
3365 * Typically, a bus driver would store a list of child resources
3366 * somewhere in the child device's ivars (see device_get_ivars()) and
3367 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3368 * then call resource_list_alloc() to perform the allocation.
3370 * @param rl the resource list to allocate from
3371 * @param bus the parent device of @p child
3372 * @param child the device which is requesting an allocation
3373 * @param type the type of resource to allocate
3374 * @param rid a pointer to the resource identifier
3375 * @param start hint at the start of the resource range - pass
3376 * @c 0 for any start address
3377 * @param end hint at the end of the resource range - pass
3378 * @c ~0 for any end address
3379 * @param count hint at the size of range required - pass @c 1
3381 * @param flags any extra flags to control the resource
3382 * allocation - see @c RF_XXX flags in
3383 * <sys/rman.h> for details
3385 * @returns the resource which was allocated or @c NULL if no
3386 * resource could be allocated
3389 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3390 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3392 struct resource_list_entry *rle = NULL;
3393 int passthrough = (device_get_parent(child) != bus);
3394 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3397 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3398 type, rid, start, end, count, flags));
3401 rle = resource_list_find(rl, type, *rid);
3404 return (NULL); /* no resource of that type/rid */
3407 if (rle->flags & RLE_RESERVED) {
3408 if (rle->flags & RLE_ALLOCATED)
3410 if ((flags & RF_ACTIVE) &&
3411 bus_activate_resource(child, type, *rid,
3414 rle->flags |= RLE_ALLOCATED;
3418 "resource entry %#x type %d for child %s is busy\n", *rid,
3419 type, device_get_nameunit(child));
3425 count = ulmax(count, rle->count);
3426 end = ulmax(rle->end, start + count - 1);
3429 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3430 type, rid, start, end, count, flags);
3433 * Record the new range.
3436 rle->start = rman_get_start(rle->res);
3437 rle->end = rman_get_end(rle->res);
3445 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3447 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3448 * used with resource_list_alloc().
3450 * @param rl the resource list which was allocated from
3451 * @param bus the parent device of @p child
3452 * @param child the device which is requesting a release
3453 * @param type the type of resource to release
3454 * @param rid the resource identifier
3455 * @param res the resource to release
3458 * @retval non-zero a standard unix error code indicating what
3459 * error condition prevented the operation
3462 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3463 int type, int rid, struct resource *res)
3465 struct resource_list_entry *rle = NULL;
3466 int passthrough = (device_get_parent(child) != bus);
3470 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3474 rle = resource_list_find(rl, type, rid);
3477 panic("resource_list_release: can't find resource");
3479 panic("resource_list_release: resource entry is not busy");
3480 if (rle->flags & RLE_RESERVED) {
3481 if (rle->flags & RLE_ALLOCATED) {
3482 if (rman_get_flags(res) & RF_ACTIVE) {
3483 error = bus_deactivate_resource(child, type,
3488 rle->flags &= ~RLE_ALLOCATED;
3494 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3504 * @brief Release all active resources of a given type
3506 * Release all active resources of a specified type. This is intended
3507 * to be used to cleanup resources leaked by a driver after detach or
3510 * @param rl the resource list which was allocated from
3511 * @param bus the parent device of @p child
3512 * @param child the device whose active resources are being released
3513 * @param type the type of resources to release
3516 * @retval EBUSY at least one resource was active
3519 resource_list_release_active(struct resource_list *rl, device_t bus,
3520 device_t child, int type)
3522 struct resource_list_entry *rle;
3526 STAILQ_FOREACH(rle, rl, link) {
3527 if (rle->type != type)
3529 if (rle->res == NULL)
3531 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3535 error = resource_list_release(rl, bus, child, type,
3536 rman_get_rid(rle->res), rle->res);
3539 "Failed to release active resource: %d\n", error);
3546 * @brief Fully release a reserved resource
3548 * Fully releases a resource reserved via resource_list_reserve().
3550 * @param rl the resource list which was allocated from
3551 * @param bus the parent device of @p child
3552 * @param child the device whose reserved resource is being released
3553 * @param type the type of resource to release
3554 * @param rid the resource identifier
3555 * @param res the resource to release
3558 * @retval non-zero a standard unix error code indicating what
3559 * error condition prevented the operation
3562 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3565 struct resource_list_entry *rle = NULL;
3566 int passthrough = (device_get_parent(child) != bus);
3570 "resource_list_unreserve() should only be called for direct children");
3572 rle = resource_list_find(rl, type, rid);
3575 panic("resource_list_unreserve: can't find resource");
3576 if (!(rle->flags & RLE_RESERVED))
3578 if (rle->flags & RLE_ALLOCATED)
3580 rle->flags &= ~RLE_RESERVED;
3581 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3585 * @brief Print a description of resources in a resource list
3587 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3588 * The name is printed if at least one resource of the given type is available.
3589 * The format is used to print resource start and end.
3591 * @param rl the resource list to print
3592 * @param name the name of @p type, e.g. @c "memory"
3593 * @param type type type of resource entry to print
3594 * @param format printf(9) format string to print resource
3595 * start and end values
3597 * @returns the number of characters printed
3600 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3603 struct resource_list_entry *rle;
3604 int printed, retval;
3608 /* Yes, this is kinda cheating */
3609 STAILQ_FOREACH(rle, rl, link) {
3610 if (rle->type == type) {
3612 retval += printf(" %s ", name);
3614 retval += printf(",");
3616 retval += printf(format, rle->start);
3617 if (rle->count > 1) {
3618 retval += printf("-");
3619 retval += printf(format, rle->start +
3628 * @brief Releases all the resources in a list.
3630 * @param rl The resource list to purge.
3635 resource_list_purge(struct resource_list *rl)
3637 struct resource_list_entry *rle;
3639 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3641 bus_release_resource(rman_get_device(rle->res),
3642 rle->type, rle->rid, rle->res);
3643 STAILQ_REMOVE_HEAD(rl, link);
3649 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3652 return (device_add_child_ordered(dev, order, name, unit));
3656 * @brief Helper function for implementing DEVICE_PROBE()
3658 * This function can be used to help implement the DEVICE_PROBE() for
3659 * a bus (i.e. a device which has other devices attached to it). It
3660 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3664 bus_generic_probe(device_t dev)
3666 devclass_t dc = dev->devclass;
3669 TAILQ_FOREACH(dl, &dc->drivers, link) {
3671 * If this driver's pass is too high, then ignore it.
3672 * For most drivers in the default pass, this will
3673 * never be true. For early-pass drivers they will
3674 * only call the identify routines of eligible drivers
3675 * when this routine is called. Drivers for later
3676 * passes should have their identify routines called
3677 * on early-pass buses during BUS_NEW_PASS().
3679 if (dl->pass > bus_current_pass)
3681 DEVICE_IDENTIFY(dl->driver, dev);
3688 * @brief Helper function for implementing DEVICE_ATTACH()
3690 * This function can be used to help implement the DEVICE_ATTACH() for
3691 * a bus. It calls device_probe_and_attach() for each of the device's
3695 bus_generic_attach(device_t dev)
3699 TAILQ_FOREACH(child, &dev->children, link) {
3700 device_probe_and_attach(child);
3707 * @brief Helper function for implementing DEVICE_DETACH()
3709 * This function can be used to help implement the DEVICE_DETACH() for
3710 * a bus. It calls device_detach() for each of the device's
3714 bus_generic_detach(device_t dev)
3719 if (dev->state != DS_ATTACHED)
3723 * Detach children in the reverse order.
3724 * See bus_generic_suspend for details.
3726 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3727 if ((error = device_detach(child)) != 0)
3735 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3737 * This function can be used to help implement the DEVICE_SHUTDOWN()
3738 * for a bus. It calls device_shutdown() for each of the device's
3742 bus_generic_shutdown(device_t dev)
3747 * Shut down children in the reverse order.
3748 * See bus_generic_suspend for details.
3750 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3751 device_shutdown(child);
3758 * @brief Default function for suspending a child device.
3760 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3763 bus_generic_suspend_child(device_t dev, device_t child)
3767 error = DEVICE_SUSPEND(child);
3770 child->flags |= DF_SUSPENDED;
3776 * @brief Default function for resuming a child device.
3778 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3781 bus_generic_resume_child(device_t dev, device_t child)
3784 DEVICE_RESUME(child);
3785 child->flags &= ~DF_SUSPENDED;
3791 * @brief Helper function for implementing DEVICE_SUSPEND()
3793 * This function can be used to help implement the DEVICE_SUSPEND()
3794 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3795 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3796 * operation is aborted and any devices which were suspended are
3797 * resumed immediately by calling their DEVICE_RESUME() methods.
3800 bus_generic_suspend(device_t dev)
3806 * Suspend children in the reverse order.
3807 * For most buses all children are equal, so the order does not matter.
3808 * Other buses, such as acpi, carefully order their child devices to
3809 * express implicit dependencies between them. For such buses it is
3810 * safer to bring down devices in the reverse order.
3812 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3813 error = BUS_SUSPEND_CHILD(dev, child);
3815 child = TAILQ_NEXT(child, link);
3816 if (child != NULL) {
3817 TAILQ_FOREACH_FROM(child, &dev->children, link)
3818 BUS_RESUME_CHILD(dev, child);
3827 * @brief Helper function for implementing DEVICE_RESUME()
3829 * This function can be used to help implement the DEVICE_RESUME() for
3830 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3833 bus_generic_resume(device_t dev)
3837 TAILQ_FOREACH(child, &dev->children, link) {
3838 BUS_RESUME_CHILD(dev, child);
3839 /* if resume fails, there's nothing we can usefully do... */
3845 * @brief Helper function for implementing BUS_PRINT_CHILD().
3847 * This function prints the first part of the ascii representation of
3848 * @p child, including its name, unit and description (if any - see
3849 * device_set_desc()).
3851 * @returns the number of characters printed
3854 bus_print_child_header(device_t dev, device_t child)
3858 if (device_get_desc(child)) {
3859 retval += device_printf(child, "<%s>", device_get_desc(child));
3861 retval += printf("%s", device_get_nameunit(child));
3868 * @brief Helper function for implementing BUS_PRINT_CHILD().
3870 * This function prints the last part of the ascii representation of
3871 * @p child, which consists of the string @c " on " followed by the
3872 * name and unit of the @p dev.
3874 * @returns the number of characters printed
3877 bus_print_child_footer(device_t dev, device_t child)
3879 return (printf(" on %s\n", device_get_nameunit(dev)));
3883 * @brief Helper function for implementing BUS_PRINT_CHILD().
3885 * This function prints out the VM domain for the given device.
3887 * @returns the number of characters printed
3890 bus_print_child_domain(device_t dev, device_t child)
3894 /* No domain? Don't print anything */
3895 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3898 return (printf(" numa-domain %d", domain));
3902 * @brief Helper function for implementing BUS_PRINT_CHILD().
3904 * This function simply calls bus_print_child_header() followed by
3905 * bus_print_child_footer().
3907 * @returns the number of characters printed
3910 bus_generic_print_child(device_t dev, device_t child)
3914 retval += bus_print_child_header(dev, child);
3915 retval += bus_print_child_domain(dev, child);
3916 retval += bus_print_child_footer(dev, child);
3922 * @brief Stub function for implementing BUS_READ_IVAR().
3927 bus_generic_read_ivar(device_t dev, device_t child, int index,
3934 * @brief Stub function for implementing BUS_WRITE_IVAR().
3939 bus_generic_write_ivar(device_t dev, device_t child, int index,
3946 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3950 struct resource_list *
3951 bus_generic_get_resource_list(device_t dev, device_t child)
3957 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3959 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3960 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3961 * and then calls device_probe_and_attach() for each unattached child.
3964 bus_generic_driver_added(device_t dev, driver_t *driver)
3968 DEVICE_IDENTIFY(driver, dev);
3969 TAILQ_FOREACH(child, &dev->children, link) {
3970 if (child->state == DS_NOTPRESENT ||
3971 (child->flags & DF_REBID))
3972 device_probe_and_attach(child);
3977 * @brief Helper function for implementing BUS_NEW_PASS().
3979 * This implementing of BUS_NEW_PASS() first calls the identify
3980 * routines for any drivers that probe at the current pass. Then it
3981 * walks the list of devices for this bus. If a device is already
3982 * attached, then it calls BUS_NEW_PASS() on that device. If the
3983 * device is not already attached, it attempts to attach a driver to
3987 bus_generic_new_pass(device_t dev)
3994 TAILQ_FOREACH(dl, &dc->drivers, link) {
3995 if (dl->pass == bus_current_pass)
3996 DEVICE_IDENTIFY(dl->driver, dev);
3998 TAILQ_FOREACH(child, &dev->children, link) {
3999 if (child->state >= DS_ATTACHED)
4000 BUS_NEW_PASS(child);
4001 else if (child->state == DS_NOTPRESENT)
4002 device_probe_and_attach(child);
4007 * @brief Helper function for implementing BUS_SETUP_INTR().
4009 * This simple implementation of BUS_SETUP_INTR() simply calls the
4010 * BUS_SETUP_INTR() method of the parent of @p dev.
4013 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4014 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4017 /* Propagate up the bus hierarchy until someone handles it. */
4019 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4020 filter, intr, arg, cookiep));
4025 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4027 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4028 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4031 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4034 /* Propagate up the bus hierarchy until someone handles it. */
4036 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4041 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4043 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4044 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4047 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4048 struct resource *r, rman_res_t start, rman_res_t end)
4050 /* Propagate up the bus hierarchy until someone handles it. */
4052 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4058 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4060 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4061 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4064 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4065 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4067 /* Propagate up the bus hierarchy until someone handles it. */
4069 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4070 start, end, count, flags));
4075 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4077 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4078 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4081 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4084 /* Propagate up the bus hierarchy until someone handles it. */
4086 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4092 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4094 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4095 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4098 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4101 /* Propagate up the bus hierarchy until someone handles it. */
4103 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4109 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4111 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4112 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4115 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4116 int rid, struct resource *r)
4118 /* Propagate up the bus hierarchy until someone handles it. */
4120 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4126 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4128 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4129 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4132 bus_generic_map_resource(device_t dev, device_t child, int type,
4133 struct resource *r, struct resource_map_request *args,
4134 struct resource_map *map)
4136 /* Propagate up the bus hierarchy until someone handles it. */
4138 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4144 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4146 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4147 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4150 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4151 struct resource *r, struct resource_map *map)
4153 /* Propagate up the bus hierarchy until someone handles it. */
4155 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4160 * @brief Helper function for implementing BUS_BIND_INTR().
4162 * This simple implementation of BUS_BIND_INTR() simply calls the
4163 * BUS_BIND_INTR() method of the parent of @p dev.
4166 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4170 /* Propagate up the bus hierarchy until someone handles it. */
4172 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4177 * @brief Helper function for implementing BUS_CONFIG_INTR().
4179 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4180 * BUS_CONFIG_INTR() method of the parent of @p dev.
4183 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4184 enum intr_polarity pol)
4187 /* Propagate up the bus hierarchy until someone handles it. */
4189 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4194 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4196 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4197 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4200 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4201 void *cookie, const char *descr)
4204 /* Propagate up the bus hierarchy until someone handles it. */
4206 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4212 * @brief Helper function for implementing BUS_GET_CPUS().
4214 * This simple implementation of BUS_GET_CPUS() simply calls the
4215 * BUS_GET_CPUS() method of the parent of @p dev.
4218 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4219 size_t setsize, cpuset_t *cpuset)
4222 /* Propagate up the bus hierarchy until someone handles it. */
4223 if (dev->parent != NULL)
4224 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4229 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4231 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4232 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4235 bus_generic_get_dma_tag(device_t dev, device_t child)
4238 /* Propagate up the bus hierarchy until someone handles it. */
4239 if (dev->parent != NULL)
4240 return (BUS_GET_DMA_TAG(dev->parent, child));
4245 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4247 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4248 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4251 bus_generic_get_bus_tag(device_t dev, device_t child)
4254 /* Propagate up the bus hierarchy until someone handles it. */
4255 if (dev->parent != NULL)
4256 return (BUS_GET_BUS_TAG(dev->parent, child));
4257 return ((bus_space_tag_t)0);
4261 * @brief Helper function for implementing BUS_GET_RESOURCE().
4263 * This implementation of BUS_GET_RESOURCE() uses the
4264 * resource_list_find() function to do most of the work. It calls
4265 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4269 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4270 rman_res_t *startp, rman_res_t *countp)
4272 struct resource_list * rl = NULL;
4273 struct resource_list_entry * rle = NULL;
4275 rl = BUS_GET_RESOURCE_LIST(dev, child);
4279 rle = resource_list_find(rl, type, rid);
4284 *startp = rle->start;
4286 *countp = rle->count;
4292 * @brief Helper function for implementing BUS_SET_RESOURCE().
4294 * This implementation of BUS_SET_RESOURCE() uses the
4295 * resource_list_add() function to do most of the work. It calls
4296 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4300 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4301 rman_res_t start, rman_res_t count)
4303 struct resource_list * rl = NULL;
4305 rl = BUS_GET_RESOURCE_LIST(dev, child);
4309 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4315 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4317 * This implementation of BUS_DELETE_RESOURCE() uses the
4318 * resource_list_delete() function to do most of the work. It calls
4319 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4323 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4325 struct resource_list * rl = NULL;
4327 rl = BUS_GET_RESOURCE_LIST(dev, child);
4331 resource_list_delete(rl, type, rid);
4337 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4339 * This implementation of BUS_RELEASE_RESOURCE() uses the
4340 * resource_list_release() function to do most of the work. It calls
4341 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4344 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4345 int rid, struct resource *r)
4347 struct resource_list * rl = NULL;
4349 if (device_get_parent(child) != dev)
4350 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4353 rl = BUS_GET_RESOURCE_LIST(dev, child);
4357 return (resource_list_release(rl, dev, child, type, rid, r));
4361 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4363 * This implementation of BUS_ALLOC_RESOURCE() uses the
4364 * resource_list_alloc() function to do most of the work. It calls
4365 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4368 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4369 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4371 struct resource_list * rl = NULL;
4373 if (device_get_parent(child) != dev)
4374 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4375 type, rid, start, end, count, flags));
4377 rl = BUS_GET_RESOURCE_LIST(dev, child);
4381 return (resource_list_alloc(rl, dev, child, type, rid,
4382 start, end, count, flags));
4386 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4388 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4389 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4392 bus_generic_child_present(device_t dev, device_t child)
4394 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4398 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4402 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4408 * @brief Helper function for implementing BUS_RESCAN().
4410 * This null implementation of BUS_RESCAN() always fails to indicate
4411 * the bus does not support rescanning.
4414 bus_null_rescan(device_t dev)
4421 * Some convenience functions to make it easier for drivers to use the
4422 * resource-management functions. All these really do is hide the
4423 * indirection through the parent's method table, making for slightly
4424 * less-wordy code. In the future, it might make sense for this code
4425 * to maintain some sort of a list of resources allocated by each device.
4429 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4430 struct resource **res)
4434 for (i = 0; rs[i].type != -1; i++)
4436 for (i = 0; rs[i].type != -1; i++) {
4437 res[i] = bus_alloc_resource_any(dev,
4438 rs[i].type, &rs[i].rid, rs[i].flags);
4439 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4440 bus_release_resources(dev, rs, res);
4448 bus_release_resources(device_t dev, const struct resource_spec *rs,
4449 struct resource **res)
4453 for (i = 0; rs[i].type != -1; i++)
4454 if (res[i] != NULL) {
4455 bus_release_resource(
4456 dev, rs[i].type, rs[i].rid, res[i]);
4462 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4464 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4468 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4469 rman_res_t end, rman_res_t count, u_int flags)
4471 struct resource *res;
4473 if (dev->parent == NULL)
4475 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4481 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4483 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4487 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4490 if (dev->parent == NULL)
4492 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4496 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4498 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4502 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4504 if (dev->parent == NULL)
4506 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4510 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4512 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4516 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4518 if (dev->parent == NULL)
4520 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4524 * @brief Wrapper function for BUS_MAP_RESOURCE().
4526 * This function simply calls the BUS_MAP_RESOURCE() method of the
4530 bus_map_resource(device_t dev, int type, struct resource *r,
4531 struct resource_map_request *args, struct resource_map *map)
4533 if (dev->parent == NULL)
4535 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4539 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4541 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4545 bus_unmap_resource(device_t dev, int type, struct resource *r,
4546 struct resource_map *map)
4548 if (dev->parent == NULL)
4550 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4554 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4556 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4560 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4564 if (dev->parent == NULL)
4566 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4571 * @brief Wrapper function for BUS_SETUP_INTR().
4573 * This function simply calls the BUS_SETUP_INTR() method of the
4577 bus_setup_intr(device_t dev, struct resource *r, int flags,
4578 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4582 if (dev->parent == NULL)
4584 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4588 if (handler != NULL && !(flags & INTR_MPSAFE))
4589 device_printf(dev, "[GIANT-LOCKED]\n");
4594 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4596 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4600 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4602 if (dev->parent == NULL)
4604 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4608 * @brief Wrapper function for BUS_BIND_INTR().
4610 * This function simply calls the BUS_BIND_INTR() method of the
4614 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4616 if (dev->parent == NULL)
4618 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4622 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4624 * This function first formats the requested description into a
4625 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4626 * the parent of @p dev.
4629 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4630 const char *fmt, ...)
4633 char descr[MAXCOMLEN + 1];
4635 if (dev->parent == NULL)
4638 vsnprintf(descr, sizeof(descr), fmt, ap);
4640 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4644 * @brief Wrapper function for BUS_SET_RESOURCE().
4646 * This function simply calls the BUS_SET_RESOURCE() method of the
4650 bus_set_resource(device_t dev, int type, int rid,
4651 rman_res_t start, rman_res_t count)
4653 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4658 * @brief Wrapper function for BUS_GET_RESOURCE().
4660 * This function simply calls the BUS_GET_RESOURCE() method of the
4664 bus_get_resource(device_t dev, int type, int rid,
4665 rman_res_t *startp, rman_res_t *countp)
4667 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4672 * @brief Wrapper function for BUS_GET_RESOURCE().
4674 * This function simply calls the BUS_GET_RESOURCE() method of the
4675 * parent of @p dev and returns the start value.
4678 bus_get_resource_start(device_t dev, int type, int rid)
4684 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4692 * @brief Wrapper function for BUS_GET_RESOURCE().
4694 * This function simply calls the BUS_GET_RESOURCE() method of the
4695 * parent of @p dev and returns the count value.
4698 bus_get_resource_count(device_t dev, int type, int rid)
4704 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4712 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4714 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4718 bus_delete_resource(device_t dev, int type, int rid)
4720 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4724 * @brief Wrapper function for BUS_CHILD_PRESENT().
4726 * This function simply calls the BUS_CHILD_PRESENT() method of the
4730 bus_child_present(device_t child)
4732 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4736 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4738 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4742 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4746 parent = device_get_parent(child);
4747 if (parent == NULL) {
4751 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4755 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4757 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4761 bus_child_location_str(device_t child, char *buf, size_t buflen)
4765 parent = device_get_parent(child);
4766 if (parent == NULL) {
4770 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4774 * @brief Wrapper function for BUS_GET_CPUS().
4776 * This function simply calls the BUS_GET_CPUS() method of the
4780 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4784 parent = device_get_parent(dev);
4787 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4791 * @brief Wrapper function for BUS_GET_DMA_TAG().
4793 * This function simply calls the BUS_GET_DMA_TAG() method of the
4797 bus_get_dma_tag(device_t dev)
4801 parent = device_get_parent(dev);
4804 return (BUS_GET_DMA_TAG(parent, dev));
4808 * @brief Wrapper function for BUS_GET_BUS_TAG().
4810 * This function simply calls the BUS_GET_BUS_TAG() method of the
4814 bus_get_bus_tag(device_t dev)
4818 parent = device_get_parent(dev);
4820 return ((bus_space_tag_t)0);
4821 return (BUS_GET_BUS_TAG(parent, dev));
4825 * @brief Wrapper function for BUS_GET_DOMAIN().
4827 * This function simply calls the BUS_GET_DOMAIN() method of the
4831 bus_get_domain(device_t dev, int *domain)
4833 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4836 /* Resume all devices and then notify userland that we're up again. */
4838 root_resume(device_t dev)
4842 error = bus_generic_resume(dev);
4844 devctl_notify("kern", "power", "resume", NULL);
4849 root_print_child(device_t dev, device_t child)
4853 retval += bus_print_child_header(dev, child);
4854 retval += printf("\n");
4860 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4861 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4864 * If an interrupt mapping gets to here something bad has happened.
4866 panic("root_setup_intr");
4870 * If we get here, assume that the device is permanent and really is
4871 * present in the system. Removable bus drivers are expected to intercept
4872 * this call long before it gets here. We return -1 so that drivers that
4873 * really care can check vs -1 or some ERRNO returned higher in the food
4877 root_child_present(device_t dev, device_t child)
4883 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4889 /* Default to returning the set of all CPUs. */
4890 if (setsize != sizeof(cpuset_t))
4899 static kobj_method_t root_methods[] = {
4900 /* Device interface */
4901 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4902 KOBJMETHOD(device_suspend, bus_generic_suspend),
4903 KOBJMETHOD(device_resume, root_resume),
4906 KOBJMETHOD(bus_print_child, root_print_child),
4907 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4908 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4909 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4910 KOBJMETHOD(bus_child_present, root_child_present),
4911 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4916 static driver_t root_driver = {
4923 devclass_t root_devclass;
4926 root_bus_module_handler(module_t mod, int what, void* arg)
4930 TAILQ_INIT(&bus_data_devices);
4931 kobj_class_compile((kobj_class_t) &root_driver);
4932 root_bus = make_device(NULL, "root", 0);
4933 root_bus->desc = "System root bus";
4934 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4935 root_bus->driver = &root_driver;
4936 root_bus->state = DS_ATTACHED;
4937 root_devclass = devclass_find_internal("root", NULL, FALSE);
4942 device_shutdown(root_bus);
4945 return (EOPNOTSUPP);
4951 static moduledata_t root_bus_mod = {
4953 root_bus_module_handler,
4956 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4959 * @brief Automatically configure devices
4961 * This function begins the autoconfiguration process by calling
4962 * device_probe_and_attach() for each child of the @c root0 device.
4965 root_bus_configure(void)
4970 /* Eventually this will be split up, but this is sufficient for now. */
4971 bus_set_pass(BUS_PASS_DEFAULT);
4975 * @brief Module handler for registering device drivers
4977 * This module handler is used to automatically register device
4978 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4979 * devclass_add_driver() for the driver described by the
4980 * driver_module_data structure pointed to by @p arg
4983 driver_module_handler(module_t mod, int what, void *arg)
4985 struct driver_module_data *dmd;
4986 devclass_t bus_devclass;
4987 kobj_class_t driver;
4990 dmd = (struct driver_module_data *)arg;
4991 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4996 if (dmd->dmd_chainevh)
4997 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4999 pass = dmd->dmd_pass;
5000 driver = dmd->dmd_driver;
5001 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5002 DRIVERNAME(driver), dmd->dmd_busname, pass));
5003 error = devclass_add_driver(bus_devclass, driver, pass,
5008 PDEBUG(("Unloading module: driver %s from bus %s",
5009 DRIVERNAME(dmd->dmd_driver),
5011 error = devclass_delete_driver(bus_devclass,
5014 if (!error && dmd->dmd_chainevh)
5015 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5018 PDEBUG(("Quiesce module: driver %s from bus %s",
5019 DRIVERNAME(dmd->dmd_driver),
5021 error = devclass_quiesce_driver(bus_devclass,
5024 if (!error && dmd->dmd_chainevh)
5025 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5036 * @brief Enumerate all hinted devices for this bus.
5038 * Walks through the hints for this bus and calls the bus_hinted_child
5039 * routine for each one it fines. It searches first for the specific
5040 * bus that's being probed for hinted children (eg isa0), and then for
5041 * generic children (eg isa).
5043 * @param dev bus device to enumerate
5046 bus_enumerate_hinted_children(device_t bus)
5049 const char *dname, *busname;
5053 * enumerate all devices on the specific bus
5055 busname = device_get_nameunit(bus);
5057 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5058 BUS_HINTED_CHILD(bus, dname, dunit);
5061 * and all the generic ones.
5063 busname = device_get_name(bus);
5065 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5066 BUS_HINTED_CHILD(bus, dname, dunit);
5071 /* the _short versions avoid iteration by not calling anything that prints
5072 * more than oneliners. I love oneliners.
5076 print_device_short(device_t dev, int indent)
5081 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5082 dev->unit, dev->desc,
5083 (dev->parent? "":"no "),
5084 (TAILQ_EMPTY(&dev->children)? "no ":""),
5085 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5086 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5087 (dev->flags&DF_WILDCARD? "wildcard,":""),
5088 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5089 (dev->flags&DF_REBID? "rebiddable,":""),
5090 (dev->flags&DF_SUSPENDED? "suspended,":""),
5091 (dev->ivars? "":"no "),
5092 (dev->softc? "":"no "),
5097 print_device(device_t dev, int indent)
5102 print_device_short(dev, indent);
5104 indentprintf(("Parent:\n"));
5105 print_device_short(dev->parent, indent+1);
5106 indentprintf(("Driver:\n"));
5107 print_driver_short(dev->driver, indent+1);
5108 indentprintf(("Devclass:\n"));
5109 print_devclass_short(dev->devclass, indent+1);
5113 print_device_tree_short(device_t dev, int indent)
5114 /* print the device and all its children (indented) */
5121 print_device_short(dev, indent);
5123 TAILQ_FOREACH(child, &dev->children, link) {
5124 print_device_tree_short(child, indent+1);
5129 print_device_tree(device_t dev, int indent)
5130 /* print the device and all its children (indented) */
5137 print_device(dev, indent);
5139 TAILQ_FOREACH(child, &dev->children, link) {
5140 print_device_tree(child, indent+1);
5145 print_driver_short(driver_t *driver, int indent)
5150 indentprintf(("driver %s: softc size = %zd\n",
5151 driver->name, driver->size));
5155 print_driver(driver_t *driver, int indent)
5160 print_driver_short(driver, indent);
5164 print_driver_list(driver_list_t drivers, int indent)
5166 driverlink_t driver;
5168 TAILQ_FOREACH(driver, &drivers, link) {
5169 print_driver(driver->driver, indent);
5174 print_devclass_short(devclass_t dc, int indent)
5179 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5183 print_devclass(devclass_t dc, int indent)
5190 print_devclass_short(dc, indent);
5191 indentprintf(("Drivers:\n"));
5192 print_driver_list(dc->drivers, indent+1);
5194 indentprintf(("Devices:\n"));
5195 for (i = 0; i < dc->maxunit; i++)
5197 print_device(dc->devices[i], indent+1);
5201 print_devclass_list_short(void)
5205 printf("Short listing of devclasses, drivers & devices:\n");
5206 TAILQ_FOREACH(dc, &devclasses, link) {
5207 print_devclass_short(dc, 0);
5212 print_devclass_list(void)
5216 printf("Full listing of devclasses, drivers & devices:\n");
5217 TAILQ_FOREACH(dc, &devclasses, link) {
5218 print_devclass(dc, 0);
5225 * User-space access to the device tree.
5227 * We implement a small set of nodes:
5229 * hw.bus Single integer read method to obtain the
5230 * current generation count.
5231 * hw.bus.devices Reads the entire device tree in flat space.
5232 * hw.bus.rman Resource manager interface
5234 * We might like to add the ability to scan devclasses and/or drivers to
5235 * determine what else is currently loaded/available.
5239 sysctl_bus(SYSCTL_HANDLER_ARGS)
5241 struct u_businfo ubus;
5243 ubus.ub_version = BUS_USER_VERSION;
5244 ubus.ub_generation = bus_data_generation;
5246 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5248 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5249 "bus-related data");
5252 sysctl_devices(SYSCTL_HANDLER_ARGS)
5254 int *name = (int *)arg1;
5255 u_int namelen = arg2;
5258 struct u_device *udev;
5265 if (bus_data_generation_check(name[0]))
5271 * Scan the list of devices, looking for the requested index.
5273 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5281 * Populate the return item, careful not to overflow the buffer.
5283 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5286 udev->dv_handle = (uintptr_t)dev;
5287 udev->dv_parent = (uintptr_t)dev->parent;
5288 udev->dv_devflags = dev->devflags;
5289 udev->dv_flags = dev->flags;
5290 udev->dv_state = dev->state;
5291 walker = udev->dv_fields;
5292 ep = walker + sizeof(udev->dv_fields);
5294 if ((src) == NULL) \
5297 strlcpy(walker, (src), ep - walker); \
5298 walker += strlen(walker) + 1; \
5306 CP(dev->driver != NULL ? dev->driver->name : NULL);
5307 bus_child_pnpinfo_str(dev, walker, ep - walker);
5308 walker += strlen(walker) + 1;
5311 bus_child_location_str(dev, walker, ep - walker);
5312 walker += strlen(walker) + 1;
5318 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5323 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5324 "system device tree");
5327 bus_data_generation_check(int generation)
5329 if (generation != bus_data_generation)
5332 /* XXX generate optimised lists here? */
5337 bus_data_generation_update(void)
5339 bus_data_generation++;
5343 bus_free_resource(device_t dev, int type, struct resource *r)
5347 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5351 device_lookup_by_name(const char *name)
5355 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5356 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5363 * /dev/devctl2 implementation. The existing /dev/devctl device has
5364 * implicit semantics on open, so it could not be reused for this.
5365 * Another option would be to call this /dev/bus?
5368 find_device(struct devreq *req, device_t *devp)
5373 * First, ensure that the name is nul terminated.
5375 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5379 * Second, try to find an attached device whose name matches
5382 dev = device_lookup_by_name(req->dr_name);
5388 /* Finally, give device enumerators a chance. */
5390 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5398 driver_exists(device_t bus, const char *driver)
5402 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5403 if (devclass_find_driver_internal(dc, driver) != NULL)
5410 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5417 /* Locate the device to control. */
5419 req = (struct devreq *)data;
5427 case DEV_SET_DRIVER:
5428 case DEV_CLEAR_DRIVER:
5431 error = priv_check(td, PRIV_DRIVER);
5433 error = find_device(req, &dev);
5444 /* Perform the requested operation. */
5447 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5449 else if (!device_is_enabled(dev))
5452 error = device_probe_and_attach(dev);
5455 if (!device_is_attached(dev)) {
5459 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5460 error = device_quiesce(dev);
5464 error = device_detach(dev);
5467 if (device_is_enabled(dev)) {
5473 * If the device has been probed but not attached (e.g.
5474 * when it has been disabled by a loader hint), just
5475 * attach the device rather than doing a full probe.
5478 if (device_is_alive(dev)) {
5480 * If the device was disabled via a hint, clear
5483 if (resource_disabled(dev->driver->name, dev->unit))
5484 resource_unset_value(dev->driver->name,
5485 dev->unit, "disabled");
5486 error = device_attach(dev);
5488 error = device_probe_and_attach(dev);
5491 if (!device_is_enabled(dev)) {
5496 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5497 error = device_quiesce(dev);
5503 * Force DF_FIXEDCLASS on around detach to preserve
5504 * the existing name.
5507 dev->flags |= DF_FIXEDCLASS;
5508 error = device_detach(dev);
5509 if (!(old & DF_FIXEDCLASS))
5510 dev->flags &= ~DF_FIXEDCLASS;
5512 device_disable(dev);
5515 if (device_is_suspended(dev)) {
5519 if (device_get_parent(dev) == NULL) {
5523 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5526 if (!device_is_suspended(dev)) {
5530 if (device_get_parent(dev) == NULL) {
5534 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5536 case DEV_SET_DRIVER: {
5540 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5543 if (driver[0] == '\0') {
5547 if (dev->devclass != NULL &&
5548 strcmp(driver, dev->devclass->name) == 0)
5549 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5553 * Scan drivers for this device's bus looking for at
5554 * least one matching driver.
5556 if (dev->parent == NULL) {
5560 if (!driver_exists(dev->parent, driver)) {
5564 dc = devclass_create(driver);
5570 /* Detach device if necessary. */
5571 if (device_is_attached(dev)) {
5572 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5573 error = device_detach(dev);
5580 /* Clear any previously-fixed device class and unit. */
5581 if (dev->flags & DF_FIXEDCLASS)
5582 devclass_delete_device(dev->devclass, dev);
5583 dev->flags |= DF_WILDCARD;
5586 /* Force the new device class. */
5587 error = devclass_add_device(dc, dev);
5590 dev->flags |= DF_FIXEDCLASS;
5591 error = device_probe_and_attach(dev);
5594 case DEV_CLEAR_DRIVER:
5595 if (!(dev->flags & DF_FIXEDCLASS)) {
5599 if (device_is_attached(dev)) {
5600 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5601 error = device_detach(dev);
5608 dev->flags &= ~DF_FIXEDCLASS;
5609 dev->flags |= DF_WILDCARD;
5610 devclass_delete_device(dev->devclass, dev);
5611 error = device_probe_and_attach(dev);
5614 if (!device_is_attached(dev)) {
5618 error = BUS_RESCAN(dev);
5623 parent = device_get_parent(dev);
5624 if (parent == NULL) {
5628 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5629 if (bus_child_present(dev) != 0) {
5635 error = device_delete_child(parent, dev);
5643 static struct cdevsw devctl2_cdevsw = {
5644 .d_version = D_VERSION,
5645 .d_ioctl = devctl2_ioctl,
5646 .d_name = "devctl2",
5653 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5654 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5658 * APIs to manage deprecation and obsolescence.
5660 static int obsolete_panic = 0;
5661 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5663 /* 0 - don't panic, 1 - panic if already obsolete, 2 - panic if deprecated */
5665 gone_panic(int major, int running, const char *msg)
5668 switch (obsolete_panic)
5673 if (running < major)
5682 _gone_in(int major, const char *msg)
5685 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5686 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5687 printf("Obsolete code will removed soon: %s\n", msg);
5688 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5689 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5694 _gone_in_dev(device_t dev, int major, const char *msg)
5697 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5698 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5700 "Obsolete code will removed soon: %s\n", msg);
5701 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5703 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5708 DB_SHOW_COMMAND(device, db_show_device)
5715 dev = (device_t)addr;
5717 db_printf("name: %s\n", device_get_nameunit(dev));
5718 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5719 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5720 db_printf(" addr: %p\n", dev);
5721 db_printf(" parent: %p\n", dev->parent);
5722 db_printf(" softc: %p\n", dev->softc);
5723 db_printf(" ivars: %p\n", dev->ivars);
5726 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5730 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5731 db_show_device((db_expr_t)dev, true, count, modif);