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>
54 #include <sys/selinfo.h>
55 #include <sys/signalvar.h>
57 #include <sys/sysctl.h>
58 #include <sys/systm.h>
61 #include <sys/interrupt.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 dst Buffer to hold the string. Must be at least @p len bytes long
863 * @param src Original buffer.
864 * @param len Length of buffer pointed to by @dst, including trailing NUL
867 devctl_safe_quote(char *dst, const char *src, size_t len)
869 char *walker = dst, *ep = dst + len - 1;
873 while (src != NULL && walker < ep)
875 if (*src == '"' || *src == '\\') {
885 /* End of /dev/devctl code */
887 static TAILQ_HEAD(,device) bus_data_devices;
888 static int bus_data_generation = 1;
890 static kobj_method_t null_methods[] = {
894 DEFINE_CLASS(null, null_methods, 0);
897 * Bus pass implementation
900 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
901 int bus_current_pass = BUS_PASS_ROOT;
905 * @brief Register the pass level of a new driver attachment
907 * Register a new driver attachment's pass level. If no driver
908 * attachment with the same pass level has been added, then @p new
909 * will be added to the global passes list.
911 * @param new the new driver attachment
914 driver_register_pass(struct driverlink *new)
916 struct driverlink *dl;
918 /* We only consider pass numbers during boot. */
919 if (bus_current_pass == BUS_PASS_DEFAULT)
923 * Walk the passes list. If we already know about this pass
924 * then there is nothing to do. If we don't, then insert this
925 * driver link into the list.
927 TAILQ_FOREACH(dl, &passes, passlink) {
928 if (dl->pass < new->pass)
930 if (dl->pass == new->pass)
932 TAILQ_INSERT_BEFORE(dl, new, passlink);
935 TAILQ_INSERT_TAIL(&passes, new, passlink);
939 * @brief Raise the current bus pass
941 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
942 * method on the root bus to kick off a new device tree scan for each
943 * new pass level that has at least one driver.
946 bus_set_pass(int pass)
948 struct driverlink *dl;
950 if (bus_current_pass > pass)
951 panic("Attempt to lower bus pass level");
953 TAILQ_FOREACH(dl, &passes, passlink) {
954 /* Skip pass values below the current pass level. */
955 if (dl->pass <= bus_current_pass)
959 * Bail once we hit a driver with a pass level that is
966 * Raise the pass level to the next level and rescan
969 bus_current_pass = dl->pass;
970 BUS_NEW_PASS(root_bus);
974 * If there isn't a driver registered for the requested pass,
975 * then bus_current_pass might still be less than 'pass'. Set
976 * it to 'pass' in that case.
978 if (bus_current_pass < pass)
979 bus_current_pass = pass;
980 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
984 * Devclass implementation
987 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
991 * @brief Find or create a device class
993 * If a device class with the name @p classname exists, return it,
994 * otherwise if @p create is non-zero create and return a new device
997 * If @p parentname is non-NULL, the parent of the devclass is set to
998 * the devclass of that name.
1000 * @param classname the devclass name to find or create
1001 * @param parentname the parent devclass name or @c NULL
1002 * @param create non-zero to create a devclass
1005 devclass_find_internal(const char *classname, const char *parentname,
1010 PDEBUG(("looking for %s", classname));
1014 TAILQ_FOREACH(dc, &devclasses, link) {
1015 if (!strcmp(dc->name, classname))
1019 if (create && !dc) {
1020 PDEBUG(("creating %s", classname));
1021 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1022 M_BUS, M_NOWAIT | M_ZERO);
1026 dc->name = (char*) (dc + 1);
1027 strcpy(dc->name, classname);
1028 TAILQ_INIT(&dc->drivers);
1029 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1031 bus_data_generation_update();
1035 * If a parent class is specified, then set that as our parent so
1036 * that this devclass will support drivers for the parent class as
1037 * well. If the parent class has the same name don't do this though
1038 * as it creates a cycle that can trigger an infinite loop in
1039 * device_probe_child() if a device exists for which there is no
1042 if (parentname && dc && !dc->parent &&
1043 strcmp(classname, parentname) != 0) {
1044 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1045 dc->parent->flags |= DC_HAS_CHILDREN;
1052 * @brief Create a device class
1054 * If a device class with the name @p classname exists, return it,
1055 * otherwise create and return a new device class.
1057 * @param classname the devclass name to find or create
1060 devclass_create(const char *classname)
1062 return (devclass_find_internal(classname, NULL, TRUE));
1066 * @brief Find a device class
1068 * If a device class with the name @p classname exists, return it,
1069 * otherwise return @c NULL.
1071 * @param classname the devclass name to find
1074 devclass_find(const char *classname)
1076 return (devclass_find_internal(classname, NULL, FALSE));
1080 * @brief Register that a device driver has been added to a devclass
1082 * Register that a device driver has been added to a devclass. This
1083 * is called by devclass_add_driver to accomplish the recursive
1084 * notification of all the children classes of dc, as well as dc.
1085 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1088 * We do a full search here of the devclass list at each iteration
1089 * level to save storing children-lists in the devclass structure. If
1090 * we ever move beyond a few dozen devices doing this, we may need to
1093 * @param dc the devclass to edit
1094 * @param driver the driver that was just added
1097 devclass_driver_added(devclass_t dc, driver_t *driver)
1103 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1105 for (i = 0; i < dc->maxunit; i++)
1106 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1107 BUS_DRIVER_ADDED(dc->devices[i], driver);
1110 * Walk through the children classes. Since we only keep a
1111 * single parent pointer around, we walk the entire list of
1112 * devclasses looking for children. We set the
1113 * DC_HAS_CHILDREN flag when a child devclass is created on
1114 * the parent, so we only walk the list for those devclasses
1115 * that have children.
1117 if (!(dc->flags & DC_HAS_CHILDREN))
1120 TAILQ_FOREACH(dc, &devclasses, link) {
1121 if (dc->parent == parent)
1122 devclass_driver_added(dc, driver);
1127 * @brief Add a device driver to a device class
1129 * Add a device driver to a devclass. This is normally called
1130 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1131 * all devices in the devclass will be called to allow them to attempt
1132 * to re-probe any unmatched children.
1134 * @param dc the devclass to edit
1135 * @param driver the driver to register
1138 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1141 const char *parentname;
1143 PDEBUG(("%s", DRIVERNAME(driver)));
1145 /* Don't allow invalid pass values. */
1146 if (pass <= BUS_PASS_ROOT)
1149 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1154 * Compile the driver's methods. Also increase the reference count
1155 * so that the class doesn't get freed when the last instance
1156 * goes. This means we can safely use static methods and avoids a
1157 * double-free in devclass_delete_driver.
1159 kobj_class_compile((kobj_class_t) driver);
1162 * If the driver has any base classes, make the
1163 * devclass inherit from the devclass of the driver's
1164 * first base class. This will allow the system to
1165 * search for drivers in both devclasses for children
1166 * of a device using this driver.
1168 if (driver->baseclasses)
1169 parentname = driver->baseclasses[0]->name;
1172 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1174 dl->driver = driver;
1175 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1176 driver->refs++; /* XXX: kobj_mtx */
1178 driver_register_pass(dl);
1180 devclass_driver_added(dc, driver);
1181 bus_data_generation_update();
1186 * @brief Register that a device driver has been deleted from a devclass
1188 * Register that a device driver has been removed from a devclass.
1189 * This is called by devclass_delete_driver to accomplish the
1190 * recursive notification of all the children classes of busclass, as
1191 * well as busclass. Each layer will attempt to detach the driver
1192 * from any devices that are children of the bus's devclass. The function
1193 * will return an error if a device fails to detach.
1195 * We do a full search here of the devclass list at each iteration
1196 * level to save storing children-lists in the devclass structure. If
1197 * we ever move beyond a few dozen devices doing this, we may need to
1200 * @param busclass the devclass of the parent bus
1201 * @param dc the devclass of the driver being deleted
1202 * @param driver the driver being deleted
1205 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1212 * Disassociate from any devices. We iterate through all the
1213 * devices in the devclass of the driver and detach any which are
1214 * using the driver and which have a parent in the devclass which
1215 * we are deleting from.
1217 * Note that since a driver can be in multiple devclasses, we
1218 * should not detach devices which are not children of devices in
1219 * the affected devclass.
1221 for (i = 0; i < dc->maxunit; i++) {
1222 if (dc->devices[i]) {
1223 dev = dc->devices[i];
1224 if (dev->driver == driver && dev->parent &&
1225 dev->parent->devclass == busclass) {
1226 if ((error = device_detach(dev)) != 0)
1228 BUS_PROBE_NOMATCH(dev->parent, dev);
1230 dev->flags |= DF_DONENOMATCH;
1236 * Walk through the children classes. Since we only keep a
1237 * single parent pointer around, we walk the entire list of
1238 * devclasses looking for children. We set the
1239 * DC_HAS_CHILDREN flag when a child devclass is created on
1240 * the parent, so we only walk the list for those devclasses
1241 * that have children.
1243 if (!(busclass->flags & DC_HAS_CHILDREN))
1246 TAILQ_FOREACH(busclass, &devclasses, link) {
1247 if (busclass->parent == parent) {
1248 error = devclass_driver_deleted(busclass, dc, driver);
1257 * @brief Delete a device driver from a device class
1259 * Delete a device driver from a devclass. This is normally called
1260 * automatically by DRIVER_MODULE().
1262 * If the driver is currently attached to any devices,
1263 * devclass_delete_driver() will first attempt to detach from each
1264 * device. If one of the detach calls fails, the driver will not be
1267 * @param dc the devclass to edit
1268 * @param driver the driver to unregister
1271 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1273 devclass_t dc = devclass_find(driver->name);
1277 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1283 * Find the link structure in the bus' list of drivers.
1285 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1286 if (dl->driver == driver)
1291 PDEBUG(("%s not found in %s list", driver->name,
1296 error = devclass_driver_deleted(busclass, dc, driver);
1300 TAILQ_REMOVE(&busclass->drivers, dl, link);
1305 if (driver->refs == 0)
1306 kobj_class_free((kobj_class_t) driver);
1308 bus_data_generation_update();
1313 * @brief Quiesces a set of device drivers from a device class
1315 * Quiesce a device driver from a devclass. This is normally called
1316 * automatically by DRIVER_MODULE().
1318 * If the driver is currently attached to any devices,
1319 * devclass_quiesece_driver() will first attempt to quiesce each
1322 * @param dc the devclass to edit
1323 * @param driver the driver to unregister
1326 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1328 devclass_t dc = devclass_find(driver->name);
1334 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1340 * Find the link structure in the bus' list of drivers.
1342 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1343 if (dl->driver == driver)
1348 PDEBUG(("%s not found in %s list", driver->name,
1354 * Quiesce all devices. We iterate through all the devices in
1355 * the devclass of the driver and quiesce any which are using
1356 * the driver and which have a parent in the devclass which we
1359 * Note that since a driver can be in multiple devclasses, we
1360 * should not quiesce devices which are not children of
1361 * devices in the affected devclass.
1363 for (i = 0; i < dc->maxunit; i++) {
1364 if (dc->devices[i]) {
1365 dev = dc->devices[i];
1366 if (dev->driver == driver && dev->parent &&
1367 dev->parent->devclass == busclass) {
1368 if ((error = device_quiesce(dev)) != 0)
1381 devclass_find_driver_internal(devclass_t dc, const char *classname)
1385 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1387 TAILQ_FOREACH(dl, &dc->drivers, link) {
1388 if (!strcmp(dl->driver->name, classname))
1392 PDEBUG(("not found"));
1397 * @brief Return the name of the devclass
1400 devclass_get_name(devclass_t dc)
1406 * @brief Find a device given a unit number
1408 * @param dc the devclass to search
1409 * @param unit the unit number to search for
1411 * @returns the device with the given unit number or @c
1412 * NULL if there is no such device
1415 devclass_get_device(devclass_t dc, int unit)
1417 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1419 return (dc->devices[unit]);
1423 * @brief Find the softc field of a device given a unit number
1425 * @param dc the devclass to search
1426 * @param unit the unit number to search for
1428 * @returns the softc field of the device with the given
1429 * unit number or @c NULL if there is no such
1433 devclass_get_softc(devclass_t dc, int unit)
1437 dev = devclass_get_device(dc, unit);
1441 return (device_get_softc(dev));
1445 * @brief Get a list of devices in the devclass
1447 * An array containing a list of all the devices in the given devclass
1448 * is allocated and returned in @p *devlistp. The number of devices
1449 * in the array is returned in @p *devcountp. The caller should free
1450 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1452 * @param dc the devclass to examine
1453 * @param devlistp points at location for array pointer return
1455 * @param devcountp points at location for array size return value
1458 * @retval ENOMEM the array allocation failed
1461 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1466 count = devclass_get_count(dc);
1467 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1472 for (i = 0; i < dc->maxunit; i++) {
1473 if (dc->devices[i]) {
1474 list[count] = dc->devices[i];
1486 * @brief Get a list of drivers in the devclass
1488 * An array containing a list of pointers to all the drivers in the
1489 * given devclass is allocated and returned in @p *listp. The number
1490 * of drivers in the array is returned in @p *countp. The caller should
1491 * free the array using @c free(p, M_TEMP).
1493 * @param dc the devclass to examine
1494 * @param listp gives location for array pointer return value
1495 * @param countp gives location for number of array elements
1499 * @retval ENOMEM the array allocation failed
1502 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1509 TAILQ_FOREACH(dl, &dc->drivers, link)
1511 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1516 TAILQ_FOREACH(dl, &dc->drivers, link) {
1517 list[count] = dl->driver;
1527 * @brief Get the number of devices in a devclass
1529 * @param dc the devclass to examine
1532 devclass_get_count(devclass_t dc)
1537 for (i = 0; i < dc->maxunit; i++)
1544 * @brief Get the maximum unit number used in a devclass
1546 * Note that this is one greater than the highest currently-allocated
1547 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1548 * that not even the devclass has been allocated yet.
1550 * @param dc the devclass to examine
1553 devclass_get_maxunit(devclass_t dc)
1557 return (dc->maxunit);
1561 * @brief Find a free unit number in a devclass
1563 * This function searches for the first unused unit number greater
1564 * that or equal to @p unit.
1566 * @param dc the devclass to examine
1567 * @param unit the first unit number to check
1570 devclass_find_free_unit(devclass_t dc, int unit)
1574 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1580 * @brief Set the parent of a devclass
1582 * The parent class is normally initialised automatically by
1585 * @param dc the devclass to edit
1586 * @param pdc the new parent devclass
1589 devclass_set_parent(devclass_t dc, devclass_t pdc)
1595 * @brief Get the parent of a devclass
1597 * @param dc the devclass to examine
1600 devclass_get_parent(devclass_t dc)
1602 return (dc->parent);
1605 struct sysctl_ctx_list *
1606 devclass_get_sysctl_ctx(devclass_t dc)
1608 return (&dc->sysctl_ctx);
1612 devclass_get_sysctl_tree(devclass_t dc)
1614 return (dc->sysctl_tree);
1619 * @brief Allocate a unit number
1621 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1622 * will do). The allocated unit number is returned in @p *unitp.
1624 * @param dc the devclass to allocate from
1625 * @param unitp points at the location for the allocated unit
1629 * @retval EEXIST the requested unit number is already allocated
1630 * @retval ENOMEM memory allocation failure
1633 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1638 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1640 /* Ask the parent bus if it wants to wire this device. */
1642 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1645 /* If we were given a wired unit number, check for existing device */
1648 if (unit >= 0 && unit < dc->maxunit &&
1649 dc->devices[unit] != NULL) {
1651 printf("%s: %s%d already exists; skipping it\n",
1652 dc->name, dc->name, *unitp);
1656 /* Unwired device, find the next available slot for it */
1658 for (unit = 0;; unit++) {
1659 /* If there is an "at" hint for a unit then skip it. */
1660 if (resource_string_value(dc->name, unit, "at", &s) ==
1664 /* If this device slot is already in use, skip it. */
1665 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1673 * We've selected a unit beyond the length of the table, so let's
1674 * extend the table to make room for all units up to and including
1677 if (unit >= dc->maxunit) {
1678 device_t *newlist, *oldlist;
1681 oldlist = dc->devices;
1682 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1683 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1686 if (oldlist != NULL)
1687 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1688 bzero(newlist + dc->maxunit,
1689 sizeof(device_t) * (newsize - dc->maxunit));
1690 dc->devices = newlist;
1691 dc->maxunit = newsize;
1692 if (oldlist != NULL)
1693 free(oldlist, M_BUS);
1695 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1703 * @brief Add a device to a devclass
1705 * A unit number is allocated for the device (using the device's
1706 * preferred unit number if any) and the device is registered in the
1707 * devclass. This allows the device to be looked up by its unit
1708 * number, e.g. by decoding a dev_t minor number.
1710 * @param dc the devclass to add to
1711 * @param dev the device to add
1714 * @retval EEXIST the requested unit number is already allocated
1715 * @retval ENOMEM memory allocation failure
1718 devclass_add_device(devclass_t dc, device_t dev)
1722 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1724 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1727 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1731 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1732 free(dev->nameunit, M_BUS);
1733 dev->nameunit = NULL;
1736 dc->devices[dev->unit] = dev;
1738 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1745 * @brief Delete a device from a devclass
1747 * The device is removed from the devclass's device list and its unit
1750 * @param dc the devclass to delete from
1751 * @param dev the device to delete
1756 devclass_delete_device(devclass_t dc, device_t dev)
1761 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1763 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1764 panic("devclass_delete_device: inconsistent device class");
1765 dc->devices[dev->unit] = NULL;
1766 if (dev->flags & DF_WILDCARD)
1768 dev->devclass = NULL;
1769 free(dev->nameunit, M_BUS);
1770 dev->nameunit = NULL;
1777 * @brief Make a new device and add it as a child of @p parent
1779 * @param parent the parent of the new device
1780 * @param name the devclass name of the new device or @c NULL
1781 * to leave the devclass unspecified
1782 * @parem unit the unit number of the new device of @c -1 to
1783 * leave the unit number unspecified
1785 * @returns the new device
1788 make_device(device_t parent, const char *name, int unit)
1793 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1796 dc = devclass_find_internal(name, NULL, TRUE);
1798 printf("make_device: can't find device class %s\n",
1806 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1810 dev->parent = parent;
1811 TAILQ_INIT(&dev->children);
1812 kobj_init((kobj_t) dev, &null_class);
1814 dev->devclass = NULL;
1816 dev->nameunit = NULL;
1820 dev->flags = DF_ENABLED;
1823 dev->flags |= DF_WILDCARD;
1825 dev->flags |= DF_FIXEDCLASS;
1826 if (devclass_add_device(dc, dev)) {
1827 kobj_delete((kobj_t) dev, M_BUS);
1834 dev->state = DS_NOTPRESENT;
1836 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1837 bus_data_generation_update();
1844 * @brief Print a description of a device.
1847 device_print_child(device_t dev, device_t child)
1851 if (device_is_alive(child))
1852 retval += BUS_PRINT_CHILD(dev, child);
1854 retval += device_printf(child, " not found\n");
1860 * @brief Create a new device
1862 * This creates a new device and adds it as a child of an existing
1863 * parent device. The new device will be added after the last existing
1864 * child with order zero.
1866 * @param dev the device which will be the parent of the
1868 * @param name devclass name for new device or @c NULL if not
1870 * @param unit unit number for new device or @c -1 if not
1873 * @returns the new device
1876 device_add_child(device_t dev, const char *name, int unit)
1878 return (device_add_child_ordered(dev, 0, name, unit));
1882 * @brief Create a new device
1884 * This creates a new device and adds it as a child of an existing
1885 * parent device. The new device will be added after the last existing
1886 * child with the same order.
1888 * @param dev the device which will be the parent of the
1890 * @param order a value which is used to partially sort the
1891 * children of @p dev - devices created using
1892 * lower values of @p order appear first in @p
1893 * dev's list of children
1894 * @param name devclass name for new device or @c NULL if not
1896 * @param unit unit number for new device or @c -1 if not
1899 * @returns the new device
1902 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1907 PDEBUG(("%s at %s with order %u as unit %d",
1908 name, DEVICENAME(dev), order, unit));
1909 KASSERT(name != NULL || unit == -1,
1910 ("child device with wildcard name and specific unit number"));
1912 child = make_device(dev, name, unit);
1915 child->order = order;
1917 TAILQ_FOREACH(place, &dev->children, link) {
1918 if (place->order > order)
1924 * The device 'place' is the first device whose order is
1925 * greater than the new child.
1927 TAILQ_INSERT_BEFORE(place, child, link);
1930 * The new child's order is greater or equal to the order of
1931 * any existing device. Add the child to the tail of the list.
1933 TAILQ_INSERT_TAIL(&dev->children, child, link);
1936 bus_data_generation_update();
1941 * @brief Delete a device
1943 * This function deletes a device along with all of its children. If
1944 * the device currently has a driver attached to it, the device is
1945 * detached first using device_detach().
1947 * @param dev the parent device
1948 * @param child the device to delete
1951 * @retval non-zero a unit error code describing the error
1954 device_delete_child(device_t dev, device_t child)
1957 device_t grandchild;
1959 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1961 /* detach parent before deleting children, if any */
1962 if ((error = device_detach(child)) != 0)
1965 /* remove children second */
1966 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1967 error = device_delete_child(child, grandchild);
1972 if (child->devclass)
1973 devclass_delete_device(child->devclass, child);
1975 BUS_CHILD_DELETED(dev, child);
1976 TAILQ_REMOVE(&dev->children, child, link);
1977 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1978 kobj_delete((kobj_t) child, M_BUS);
1980 bus_data_generation_update();
1985 * @brief Delete all children devices of the given device, if any.
1987 * This function deletes all children devices of the given device, if
1988 * any, using the device_delete_child() function for each device it
1989 * finds. If a child device cannot be deleted, this function will
1990 * return an error code.
1992 * @param dev the parent device
1995 * @retval non-zero a device would not detach
1998 device_delete_children(device_t dev)
2003 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2007 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2008 error = device_delete_child(dev, child);
2010 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2018 * @brief Find a device given a unit number
2020 * This is similar to devclass_get_devices() but only searches for
2021 * devices which have @p dev as a parent.
2023 * @param dev the parent device to search
2024 * @param unit the unit number to search for. If the unit is -1,
2025 * return the first child of @p dev which has name
2026 * @p classname (that is, the one with the lowest unit.)
2028 * @returns the device with the given unit number or @c
2029 * NULL if there is no such device
2032 device_find_child(device_t dev, const char *classname, int unit)
2037 dc = devclass_find(classname);
2042 child = devclass_get_device(dc, unit);
2043 if (child && child->parent == dev)
2046 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2047 child = devclass_get_device(dc, unit);
2048 if (child && child->parent == dev)
2059 first_matching_driver(devclass_t dc, device_t dev)
2062 return (devclass_find_driver_internal(dc, dev->devclass->name));
2063 return (TAILQ_FIRST(&dc->drivers));
2070 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2072 if (dev->devclass) {
2074 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2075 if (!strcmp(dev->devclass->name, dl->driver->name))
2079 return (TAILQ_NEXT(last, link));
2086 device_probe_child(device_t dev, device_t child)
2089 driverlink_t best = NULL;
2091 int result, pri = 0;
2092 int hasclass = (child->devclass != NULL);
2098 panic("device_probe_child: parent device has no devclass");
2101 * If the state is already probed, then return. However, don't
2102 * return if we can rebid this object.
2104 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2107 for (; dc; dc = dc->parent) {
2108 for (dl = first_matching_driver(dc, child);
2110 dl = next_matching_driver(dc, child, dl)) {
2111 /* If this driver's pass is too high, then ignore it. */
2112 if (dl->pass > bus_current_pass)
2115 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2116 result = device_set_driver(child, dl->driver);
2117 if (result == ENOMEM)
2119 else if (result != 0)
2122 if (device_set_devclass(child,
2123 dl->driver->name) != 0) {
2124 char const * devname =
2125 device_get_name(child);
2126 if (devname == NULL)
2127 devname = "(unknown)";
2128 printf("driver bug: Unable to set "
2129 "devclass (class: %s "
2133 (void)device_set_driver(child, NULL);
2138 /* Fetch any flags for the device before probing. */
2139 resource_int_value(dl->driver->name, child->unit,
2140 "flags", &child->devflags);
2142 result = DEVICE_PROBE(child);
2144 /* Reset flags and devclass before the next probe. */
2145 child->devflags = 0;
2147 (void)device_set_devclass(child, NULL);
2150 * If the driver returns SUCCESS, there can be
2151 * no higher match for this device.
2160 * Reset DF_QUIET in case this driver doesn't
2161 * end up as the best driver.
2163 device_verbose(child);
2166 * Probes that return BUS_PROBE_NOWILDCARD or lower
2167 * only match on devices whose driver was explicitly
2170 if (result <= BUS_PROBE_NOWILDCARD &&
2171 !(child->flags & DF_FIXEDCLASS)) {
2176 * The driver returned an error so it
2177 * certainly doesn't match.
2180 (void)device_set_driver(child, NULL);
2185 * A priority lower than SUCCESS, remember the
2186 * best matching driver. Initialise the value
2187 * of pri for the first match.
2189 if (best == NULL || result > pri) {
2196 * If we have an unambiguous match in this devclass,
2197 * don't look in the parent.
2199 if (best && pri == 0)
2204 * If we found a driver, change state and initialise the devclass.
2206 /* XXX What happens if we rebid and got no best? */
2209 * If this device was attached, and we were asked to
2210 * rescan, and it is a different driver, then we have
2211 * to detach the old driver and reattach this new one.
2212 * Note, we don't have to check for DF_REBID here
2213 * because if the state is > DS_ALIVE, we know it must
2216 * This assumes that all DF_REBID drivers can have
2217 * their probe routine called at any time and that
2218 * they are idempotent as well as completely benign in
2219 * normal operations.
2221 * We also have to make sure that the detach
2222 * succeeded, otherwise we fail the operation (or
2223 * maybe it should just fail silently? I'm torn).
2225 if (child->state > DS_ALIVE && best->driver != child->driver)
2226 if ((result = device_detach(dev)) != 0)
2229 /* Set the winning driver, devclass, and flags. */
2230 if (!child->devclass) {
2231 result = device_set_devclass(child, best->driver->name);
2235 result = device_set_driver(child, best->driver);
2238 resource_int_value(best->driver->name, child->unit,
2239 "flags", &child->devflags);
2243 * A bit bogus. Call the probe method again to make
2244 * sure that we have the right description.
2246 DEVICE_PROBE(child);
2248 child->flags |= DF_REBID;
2251 child->flags &= ~DF_REBID;
2252 child->state = DS_ALIVE;
2254 bus_data_generation_update();
2262 * @brief Return the parent of a device
2265 device_get_parent(device_t dev)
2267 return (dev->parent);
2271 * @brief Get a list of children of a device
2273 * An array containing a list of all the children of the given device
2274 * is allocated and returned in @p *devlistp. The number of devices
2275 * in the array is returned in @p *devcountp. The caller should free
2276 * the array using @c free(p, M_TEMP).
2278 * @param dev the device to examine
2279 * @param devlistp points at location for array pointer return
2281 * @param devcountp points at location for array size return value
2284 * @retval ENOMEM the array allocation failed
2287 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2294 TAILQ_FOREACH(child, &dev->children, link) {
2303 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2308 TAILQ_FOREACH(child, &dev->children, link) {
2309 list[count] = child;
2320 * @brief Return the current driver for the device or @c NULL if there
2321 * is no driver currently attached
2324 device_get_driver(device_t dev)
2326 return (dev->driver);
2330 * @brief Return the current devclass for the device or @c NULL if
2334 device_get_devclass(device_t dev)
2336 return (dev->devclass);
2340 * @brief Return the name of the device's devclass or @c NULL if there
2344 device_get_name(device_t dev)
2346 if (dev != NULL && dev->devclass)
2347 return (devclass_get_name(dev->devclass));
2352 * @brief Return a string containing the device's devclass name
2353 * followed by an ascii representation of the device's unit number
2357 device_get_nameunit(device_t dev)
2359 return (dev->nameunit);
2363 * @brief Return the device's unit number.
2366 device_get_unit(device_t dev)
2372 * @brief Return the device's description string
2375 device_get_desc(device_t dev)
2381 * @brief Return the device's flags
2384 device_get_flags(device_t dev)
2386 return (dev->devflags);
2389 struct sysctl_ctx_list *
2390 device_get_sysctl_ctx(device_t dev)
2392 return (&dev->sysctl_ctx);
2396 device_get_sysctl_tree(device_t dev)
2398 return (dev->sysctl_tree);
2402 * @brief Print the name of the device followed by a colon and a space
2404 * @returns the number of characters printed
2407 device_print_prettyname(device_t dev)
2409 const char *name = device_get_name(dev);
2412 return (printf("unknown: "));
2413 return (printf("%s%d: ", name, device_get_unit(dev)));
2417 * @brief Print the name of the device followed by a colon, a space
2418 * and the result of calling vprintf() with the value of @p fmt and
2419 * the following arguments.
2421 * @returns the number of characters printed
2424 device_printf(device_t dev, const char * fmt, ...)
2429 retval = device_print_prettyname(dev);
2431 retval += vprintf(fmt, ap);
2440 device_set_desc_internal(device_t dev, const char* desc, int copy)
2442 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2443 free(dev->desc, M_BUS);
2444 dev->flags &= ~DF_DESCMALLOCED;
2449 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2451 strcpy(dev->desc, desc);
2452 dev->flags |= DF_DESCMALLOCED;
2455 /* Avoid a -Wcast-qual warning */
2456 dev->desc = (char *)(uintptr_t) desc;
2459 bus_data_generation_update();
2463 * @brief Set the device's description
2465 * The value of @c desc should be a string constant that will not
2466 * change (at least until the description is changed in a subsequent
2467 * call to device_set_desc() or device_set_desc_copy()).
2470 device_set_desc(device_t dev, const char* desc)
2472 device_set_desc_internal(dev, desc, FALSE);
2476 * @brief Set the device's description
2478 * The string pointed to by @c desc is copied. Use this function if
2479 * the device description is generated, (e.g. with sprintf()).
2482 device_set_desc_copy(device_t dev, const char* desc)
2484 device_set_desc_internal(dev, desc, TRUE);
2488 * @brief Set the device's flags
2491 device_set_flags(device_t dev, uint32_t flags)
2493 dev->devflags = flags;
2497 * @brief Return the device's softc field
2499 * The softc is allocated and zeroed when a driver is attached, based
2500 * on the size field of the driver.
2503 device_get_softc(device_t dev)
2505 return (dev->softc);
2509 * @brief Set the device's softc field
2511 * Most drivers do not need to use this since the softc is allocated
2512 * automatically when the driver is attached.
2515 device_set_softc(device_t dev, void *softc)
2517 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2518 free(dev->softc, M_BUS_SC);
2521 dev->flags |= DF_EXTERNALSOFTC;
2523 dev->flags &= ~DF_EXTERNALSOFTC;
2527 * @brief Free claimed softc
2529 * Most drivers do not need to use this since the softc is freed
2530 * automatically when the driver is detached.
2533 device_free_softc(void *softc)
2535 free(softc, M_BUS_SC);
2539 * @brief Claim softc
2541 * This function can be used to let the driver free the automatically
2542 * allocated softc using "device_free_softc()". This function is
2543 * useful when the driver is refcounting the softc and the softc
2544 * cannot be freed when the "device_detach" method is called.
2547 device_claim_softc(device_t dev)
2550 dev->flags |= DF_EXTERNALSOFTC;
2552 dev->flags &= ~DF_EXTERNALSOFTC;
2556 * @brief Get the device's ivars field
2558 * The ivars field is used by the parent device to store per-device
2559 * state (e.g. the physical location of the device or a list of
2563 device_get_ivars(device_t dev)
2566 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2567 return (dev->ivars);
2571 * @brief Set the device's ivars field
2574 device_set_ivars(device_t dev, void * ivars)
2577 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2582 * @brief Return the device's state
2585 device_get_state(device_t dev)
2587 return (dev->state);
2591 * @brief Set the DF_ENABLED flag for the device
2594 device_enable(device_t dev)
2596 dev->flags |= DF_ENABLED;
2600 * @brief Clear the DF_ENABLED flag for the device
2603 device_disable(device_t dev)
2605 dev->flags &= ~DF_ENABLED;
2609 * @brief Increment the busy counter for the device
2612 device_busy(device_t dev)
2614 if (dev->state < DS_ATTACHING)
2615 panic("device_busy: called for unattached device");
2616 if (dev->busy == 0 && dev->parent)
2617 device_busy(dev->parent);
2619 if (dev->state == DS_ATTACHED)
2620 dev->state = DS_BUSY;
2624 * @brief Decrement the busy counter for the device
2627 device_unbusy(device_t dev)
2629 if (dev->busy != 0 && dev->state != DS_BUSY &&
2630 dev->state != DS_ATTACHING)
2631 panic("device_unbusy: called for non-busy device %s",
2632 device_get_nameunit(dev));
2634 if (dev->busy == 0) {
2636 device_unbusy(dev->parent);
2637 if (dev->state == DS_BUSY)
2638 dev->state = DS_ATTACHED;
2643 * @brief Set the DF_QUIET flag for the device
2646 device_quiet(device_t dev)
2648 dev->flags |= DF_QUIET;
2652 * @brief Clear the DF_QUIET flag for the device
2655 device_verbose(device_t dev)
2657 dev->flags &= ~DF_QUIET;
2661 * @brief Return non-zero if the DF_QUIET flag is set on the device
2664 device_is_quiet(device_t dev)
2666 return ((dev->flags & DF_QUIET) != 0);
2670 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2673 device_is_enabled(device_t dev)
2675 return ((dev->flags & DF_ENABLED) != 0);
2679 * @brief Return non-zero if the device was successfully probed
2682 device_is_alive(device_t dev)
2684 return (dev->state >= DS_ALIVE);
2688 * @brief Return non-zero if the device currently has a driver
2692 device_is_attached(device_t dev)
2694 return (dev->state >= DS_ATTACHED);
2698 * @brief Return non-zero if the device is currently suspended.
2701 device_is_suspended(device_t dev)
2703 return ((dev->flags & DF_SUSPENDED) != 0);
2707 * @brief Set the devclass of a device
2708 * @see devclass_add_device().
2711 device_set_devclass(device_t dev, const char *classname)
2718 devclass_delete_device(dev->devclass, dev);
2722 if (dev->devclass) {
2723 printf("device_set_devclass: device class already set\n");
2727 dc = devclass_find_internal(classname, NULL, TRUE);
2731 error = devclass_add_device(dc, dev);
2733 bus_data_generation_update();
2738 * @brief Set the devclass of a device and mark the devclass fixed.
2739 * @see device_set_devclass()
2742 device_set_devclass_fixed(device_t dev, const char *classname)
2746 if (classname == NULL)
2749 error = device_set_devclass(dev, classname);
2752 dev->flags |= DF_FIXEDCLASS;
2757 * @brief Set the driver of a device
2760 * @retval EBUSY the device already has a driver attached
2761 * @retval ENOMEM a memory allocation failure occurred
2764 device_set_driver(device_t dev, driver_t *driver)
2766 if (dev->state >= DS_ATTACHED)
2769 if (dev->driver == driver)
2772 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2773 free(dev->softc, M_BUS_SC);
2776 device_set_desc(dev, NULL);
2777 kobj_delete((kobj_t) dev, NULL);
2778 dev->driver = driver;
2780 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2781 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2782 dev->softc = malloc(driver->size, M_BUS_SC,
2785 kobj_delete((kobj_t) dev, NULL);
2786 kobj_init((kobj_t) dev, &null_class);
2792 kobj_init((kobj_t) dev, &null_class);
2795 bus_data_generation_update();
2800 * @brief Probe a device, and return this status.
2802 * This function is the core of the device autoconfiguration
2803 * system. Its purpose is to select a suitable driver for a device and
2804 * then call that driver to initialise the hardware appropriately. The
2805 * driver is selected by calling the DEVICE_PROBE() method of a set of
2806 * candidate drivers and then choosing the driver which returned the
2807 * best value. This driver is then attached to the device using
2810 * The set of suitable drivers is taken from the list of drivers in
2811 * the parent device's devclass. If the device was originally created
2812 * with a specific class name (see device_add_child()), only drivers
2813 * with that name are probed, otherwise all drivers in the devclass
2814 * are probed. If no drivers return successful probe values in the
2815 * parent devclass, the search continues in the parent of that
2816 * devclass (see devclass_get_parent()) if any.
2818 * @param dev the device to initialise
2821 * @retval ENXIO no driver was found
2822 * @retval ENOMEM memory allocation failure
2823 * @retval non-zero some other unix error code
2824 * @retval -1 Device already attached
2827 device_probe(device_t dev)
2833 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2836 if (!(dev->flags & DF_ENABLED)) {
2837 if (bootverbose && device_get_name(dev) != NULL) {
2838 device_print_prettyname(dev);
2839 printf("not probed (disabled)\n");
2843 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2844 if (bus_current_pass == BUS_PASS_DEFAULT &&
2845 !(dev->flags & DF_DONENOMATCH)) {
2846 BUS_PROBE_NOMATCH(dev->parent, dev);
2848 dev->flags |= DF_DONENOMATCH;
2856 * @brief Probe a device and attach a driver if possible
2858 * calls device_probe() and attaches if that was successful.
2861 device_probe_and_attach(device_t dev)
2867 error = device_probe(dev);
2870 else if (error != 0)
2873 CURVNET_SET_QUIET(vnet0);
2874 error = device_attach(dev);
2880 * @brief Attach a device driver to a device
2882 * This function is a wrapper around the DEVICE_ATTACH() driver
2883 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2884 * device's sysctl tree, optionally prints a description of the device
2885 * and queues a notification event for user-based device management
2888 * Normally this function is only called internally from
2889 * device_probe_and_attach().
2891 * @param dev the device to initialise
2894 * @retval ENXIO no driver was found
2895 * @retval ENOMEM memory allocation failure
2896 * @retval non-zero some other unix error code
2899 device_attach(device_t dev)
2901 uint64_t attachtime;
2904 if (resource_disabled(dev->driver->name, dev->unit)) {
2905 device_disable(dev);
2907 device_printf(dev, "disabled via hints entry\n");
2911 device_sysctl_init(dev);
2912 if (!device_is_quiet(dev))
2913 device_print_child(dev->parent, dev);
2914 attachtime = get_cyclecount();
2915 dev->state = DS_ATTACHING;
2916 if ((error = DEVICE_ATTACH(dev)) != 0) {
2917 printf("device_attach: %s%d attach returned %d\n",
2918 dev->driver->name, dev->unit, error);
2919 if (!(dev->flags & DF_FIXEDCLASS))
2920 devclass_delete_device(dev->devclass, dev);
2921 (void)device_set_driver(dev, NULL);
2922 device_sysctl_fini(dev);
2923 KASSERT(dev->busy == 0, ("attach failed but busy"));
2924 dev->state = DS_NOTPRESENT;
2927 attachtime = get_cyclecount() - attachtime;
2929 * 4 bits per device is a reasonable value for desktop and server
2930 * hardware with good get_cyclecount() implementations, but WILL
2931 * need to be adjusted on other platforms.
2933 #define RANDOM_PROBE_BIT_GUESS 4
2935 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2936 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2937 dev->driver->name, dev->unit);
2938 random_harvest_direct(&attachtime, sizeof(attachtime),
2939 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2940 device_sysctl_update(dev);
2942 dev->state = DS_BUSY;
2944 dev->state = DS_ATTACHED;
2945 dev->flags &= ~DF_DONENOMATCH;
2946 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2952 * @brief Detach a driver from a device
2954 * This function is a wrapper around the DEVICE_DETACH() driver
2955 * method. If the call to DEVICE_DETACH() succeeds, it calls
2956 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2957 * notification event for user-based device management services and
2958 * cleans up the device's sysctl tree.
2960 * @param dev the device to un-initialise
2963 * @retval ENXIO no driver was found
2964 * @retval ENOMEM memory allocation failure
2965 * @retval non-zero some other unix error code
2968 device_detach(device_t dev)
2974 PDEBUG(("%s", DEVICENAME(dev)));
2975 if (dev->state == DS_BUSY)
2977 if (dev->state != DS_ATTACHED)
2980 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2981 if ((error = DEVICE_DETACH(dev)) != 0) {
2982 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2983 EVHDEV_DETACH_FAILED);
2986 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
2987 EVHDEV_DETACH_COMPLETE);
2990 if (!device_is_quiet(dev))
2991 device_printf(dev, "detached\n");
2993 BUS_CHILD_DETACHED(dev->parent, dev);
2995 if (!(dev->flags & DF_FIXEDCLASS))
2996 devclass_delete_device(dev->devclass, dev);
2998 device_verbose(dev);
2999 dev->state = DS_NOTPRESENT;
3000 (void)device_set_driver(dev, NULL);
3001 device_sysctl_fini(dev);
3007 * @brief Tells a driver to quiesce itself.
3009 * This function is a wrapper around the DEVICE_QUIESCE() driver
3010 * method. If the call to DEVICE_QUIESCE() succeeds.
3012 * @param dev the device to quiesce
3015 * @retval ENXIO no driver was found
3016 * @retval ENOMEM memory allocation failure
3017 * @retval non-zero some other unix error code
3020 device_quiesce(device_t dev)
3023 PDEBUG(("%s", DEVICENAME(dev)));
3024 if (dev->state == DS_BUSY)
3026 if (dev->state != DS_ATTACHED)
3029 return (DEVICE_QUIESCE(dev));
3033 * @brief Notify a device of system shutdown
3035 * This function calls the DEVICE_SHUTDOWN() driver method if the
3036 * device currently has an attached driver.
3038 * @returns the value returned by DEVICE_SHUTDOWN()
3041 device_shutdown(device_t dev)
3043 if (dev->state < DS_ATTACHED)
3045 return (DEVICE_SHUTDOWN(dev));
3049 * @brief Set the unit number of a device
3051 * This function can be used to override the unit number used for a
3052 * device (e.g. to wire a device to a pre-configured unit number).
3055 device_set_unit(device_t dev, int unit)
3060 dc = device_get_devclass(dev);
3061 if (unit < dc->maxunit && dc->devices[unit])
3063 err = devclass_delete_device(dc, dev);
3067 err = devclass_add_device(dc, dev);
3071 bus_data_generation_update();
3075 /*======================================*/
3077 * Some useful method implementations to make life easier for bus drivers.
3081 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3086 args->memattr = VM_MEMATTR_UNCACHEABLE;
3090 * @brief Initialise a resource list.
3092 * @param rl the resource list to initialise
3095 resource_list_init(struct resource_list *rl)
3101 * @brief Reclaim memory used by a resource list.
3103 * This function frees the memory for all resource entries on the list
3106 * @param rl the resource list to free
3109 resource_list_free(struct resource_list *rl)
3111 struct resource_list_entry *rle;
3113 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3115 panic("resource_list_free: resource entry is busy");
3116 STAILQ_REMOVE_HEAD(rl, link);
3122 * @brief Add a resource entry.
3124 * This function adds a resource entry using the given @p type, @p
3125 * start, @p end and @p count values. A rid value is chosen by
3126 * searching sequentially for the first unused rid starting at zero.
3128 * @param rl the resource list to edit
3129 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3130 * @param start the start address of the resource
3131 * @param end the end address of the resource
3132 * @param count XXX end-start+1
3135 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3136 rman_res_t end, rman_res_t count)
3141 while (resource_list_find(rl, type, rid) != NULL)
3143 resource_list_add(rl, type, rid, start, end, count);
3148 * @brief Add or modify a resource entry.
3150 * If an existing entry exists with the same type and rid, it will be
3151 * modified using the given values of @p start, @p end and @p
3152 * count. If no entry exists, a new one will be created using the
3153 * given values. The resource list entry that matches is then returned.
3155 * @param rl the resource list to edit
3156 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3157 * @param rid the resource identifier
3158 * @param start the start address of the resource
3159 * @param end the end address of the resource
3160 * @param count XXX end-start+1
3162 struct resource_list_entry *
3163 resource_list_add(struct resource_list *rl, int type, int rid,
3164 rman_res_t start, rman_res_t end, rman_res_t count)
3166 struct resource_list_entry *rle;
3168 rle = resource_list_find(rl, type, rid);
3170 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3173 panic("resource_list_add: can't record entry");
3174 STAILQ_INSERT_TAIL(rl, rle, link);
3182 panic("resource_list_add: resource entry is busy");
3191 * @brief Determine if a resource entry is busy.
3193 * Returns true if a resource entry is busy meaning that it has an
3194 * associated resource that is not an unallocated "reserved" resource.
3196 * @param rl the resource list to search
3197 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3198 * @param rid the resource identifier
3200 * @returns Non-zero if the entry is busy, zero otherwise.
3203 resource_list_busy(struct resource_list *rl, int type, int rid)
3205 struct resource_list_entry *rle;
3207 rle = resource_list_find(rl, type, rid);
3208 if (rle == NULL || rle->res == NULL)
3210 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3211 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3212 ("reserved resource is active"));
3219 * @brief Determine if a resource entry is reserved.
3221 * Returns true if a resource entry is reserved meaning that it has an
3222 * associated "reserved" resource. The resource can either be
3223 * allocated or unallocated.
3225 * @param rl the resource list to search
3226 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3227 * @param rid the resource identifier
3229 * @returns Non-zero if the entry is reserved, zero otherwise.
3232 resource_list_reserved(struct resource_list *rl, int type, int rid)
3234 struct resource_list_entry *rle;
3236 rle = resource_list_find(rl, type, rid);
3237 if (rle != NULL && rle->flags & RLE_RESERVED)
3243 * @brief Find a resource entry by type and rid.
3245 * @param rl the resource list to search
3246 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3247 * @param rid the resource identifier
3249 * @returns the resource entry pointer or NULL if there is no such
3252 struct resource_list_entry *
3253 resource_list_find(struct resource_list *rl, int type, int rid)
3255 struct resource_list_entry *rle;
3257 STAILQ_FOREACH(rle, rl, link) {
3258 if (rle->type == type && rle->rid == rid)
3265 * @brief Delete a resource entry.
3267 * @param rl the resource list to edit
3268 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3269 * @param rid the resource identifier
3272 resource_list_delete(struct resource_list *rl, int type, int rid)
3274 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3277 if (rle->res != NULL)
3278 panic("resource_list_delete: resource has not been released");
3279 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3285 * @brief Allocate a reserved resource
3287 * This can be used by buses to force the allocation of resources
3288 * that are always active in the system even if they are not allocated
3289 * by a driver (e.g. PCI BARs). This function is usually called when
3290 * adding a new child to the bus. The resource is allocated from the
3291 * parent bus when it is reserved. The resource list entry is marked
3292 * with RLE_RESERVED to note that it is a reserved resource.
3294 * Subsequent attempts to allocate the resource with
3295 * resource_list_alloc() will succeed the first time and will set
3296 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3297 * resource that has been allocated is released with
3298 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3299 * the actual resource remains allocated. The resource can be released to
3300 * the parent bus by calling resource_list_unreserve().
3302 * @param rl the resource list to allocate from
3303 * @param bus the parent device of @p child
3304 * @param child the device for which the resource is being reserved
3305 * @param type the type of resource to allocate
3306 * @param rid a pointer to the resource identifier
3307 * @param start hint at the start of the resource range - pass
3308 * @c 0 for any start address
3309 * @param end hint at the end of the resource range - pass
3310 * @c ~0 for any end address
3311 * @param count hint at the size of range required - pass @c 1
3313 * @param flags any extra flags to control the resource
3314 * allocation - see @c RF_XXX flags in
3315 * <sys/rman.h> for details
3317 * @returns the resource which was allocated or @c NULL if no
3318 * resource could be allocated
3321 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3322 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3324 struct resource_list_entry *rle = NULL;
3325 int passthrough = (device_get_parent(child) != bus);
3330 "resource_list_reserve() should only be called for direct children");
3331 if (flags & RF_ACTIVE)
3333 "resource_list_reserve() should only reserve inactive resources");
3335 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3338 rle = resource_list_find(rl, type, *rid);
3339 rle->flags |= RLE_RESERVED;
3345 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3347 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3348 * and passing the allocation up to the parent of @p bus. This assumes
3349 * that the first entry of @c device_get_ivars(child) is a struct
3350 * resource_list. This also handles 'passthrough' allocations where a
3351 * child is a remote descendant of bus by passing the allocation up to
3352 * the parent of bus.
3354 * Typically, a bus driver would store a list of child resources
3355 * somewhere in the child device's ivars (see device_get_ivars()) and
3356 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3357 * then call resource_list_alloc() to perform the allocation.
3359 * @param rl the resource list to allocate from
3360 * @param bus the parent device of @p child
3361 * @param child the device which is requesting an allocation
3362 * @param type the type of resource to allocate
3363 * @param rid a pointer to the resource identifier
3364 * @param start hint at the start of the resource range - pass
3365 * @c 0 for any start address
3366 * @param end hint at the end of the resource range - pass
3367 * @c ~0 for any end address
3368 * @param count hint at the size of range required - pass @c 1
3370 * @param flags any extra flags to control the resource
3371 * allocation - see @c RF_XXX flags in
3372 * <sys/rman.h> for details
3374 * @returns the resource which was allocated or @c NULL if no
3375 * resource could be allocated
3378 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3379 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3381 struct resource_list_entry *rle = NULL;
3382 int passthrough = (device_get_parent(child) != bus);
3383 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3386 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3387 type, rid, start, end, count, flags));
3390 rle = resource_list_find(rl, type, *rid);
3393 return (NULL); /* no resource of that type/rid */
3396 if (rle->flags & RLE_RESERVED) {
3397 if (rle->flags & RLE_ALLOCATED)
3399 if ((flags & RF_ACTIVE) &&
3400 bus_activate_resource(child, type, *rid,
3403 rle->flags |= RLE_ALLOCATED;
3407 "resource entry %#x type %d for child %s is busy\n", *rid,
3408 type, device_get_nameunit(child));
3414 count = ulmax(count, rle->count);
3415 end = ulmax(rle->end, start + count - 1);
3418 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3419 type, rid, start, end, count, flags);
3422 * Record the new range.
3425 rle->start = rman_get_start(rle->res);
3426 rle->end = rman_get_end(rle->res);
3434 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3436 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3437 * used with resource_list_alloc().
3439 * @param rl the resource list which was allocated from
3440 * @param bus the parent device of @p child
3441 * @param child the device which is requesting a release
3442 * @param type the type of resource to release
3443 * @param rid the resource identifier
3444 * @param res the resource to release
3447 * @retval non-zero a standard unix error code indicating what
3448 * error condition prevented the operation
3451 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3452 int type, int rid, struct resource *res)
3454 struct resource_list_entry *rle = NULL;
3455 int passthrough = (device_get_parent(child) != bus);
3459 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3463 rle = resource_list_find(rl, type, rid);
3466 panic("resource_list_release: can't find resource");
3468 panic("resource_list_release: resource entry is not busy");
3469 if (rle->flags & RLE_RESERVED) {
3470 if (rle->flags & RLE_ALLOCATED) {
3471 if (rman_get_flags(res) & RF_ACTIVE) {
3472 error = bus_deactivate_resource(child, type,
3477 rle->flags &= ~RLE_ALLOCATED;
3483 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3493 * @brief Release all active resources of a given type
3495 * Release all active resources of a specified type. This is intended
3496 * to be used to cleanup resources leaked by a driver after detach or
3499 * @param rl the resource list which was allocated from
3500 * @param bus the parent device of @p child
3501 * @param child the device whose active resources are being released
3502 * @param type the type of resources to release
3505 * @retval EBUSY at least one resource was active
3508 resource_list_release_active(struct resource_list *rl, device_t bus,
3509 device_t child, int type)
3511 struct resource_list_entry *rle;
3515 STAILQ_FOREACH(rle, rl, link) {
3516 if (rle->type != type)
3518 if (rle->res == NULL)
3520 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3524 error = resource_list_release(rl, bus, child, type,
3525 rman_get_rid(rle->res), rle->res);
3528 "Failed to release active resource: %d\n", error);
3535 * @brief Fully release a reserved resource
3537 * Fully releases a resource reserved via resource_list_reserve().
3539 * @param rl the resource list which was allocated from
3540 * @param bus the parent device of @p child
3541 * @param child the device whose reserved resource is being released
3542 * @param type the type of resource to release
3543 * @param rid the resource identifier
3544 * @param res the resource to release
3547 * @retval non-zero a standard unix error code indicating what
3548 * error condition prevented the operation
3551 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3554 struct resource_list_entry *rle = NULL;
3555 int passthrough = (device_get_parent(child) != bus);
3559 "resource_list_unreserve() should only be called for direct children");
3561 rle = resource_list_find(rl, type, rid);
3564 panic("resource_list_unreserve: can't find resource");
3565 if (!(rle->flags & RLE_RESERVED))
3567 if (rle->flags & RLE_ALLOCATED)
3569 rle->flags &= ~RLE_RESERVED;
3570 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3574 * @brief Print a description of resources in a resource list
3576 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3577 * The name is printed if at least one resource of the given type is available.
3578 * The format is used to print resource start and end.
3580 * @param rl the resource list to print
3581 * @param name the name of @p type, e.g. @c "memory"
3582 * @param type type type of resource entry to print
3583 * @param format printf(9) format string to print resource
3584 * start and end values
3586 * @returns the number of characters printed
3589 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3592 struct resource_list_entry *rle;
3593 int printed, retval;
3597 /* Yes, this is kinda cheating */
3598 STAILQ_FOREACH(rle, rl, link) {
3599 if (rle->type == type) {
3601 retval += printf(" %s ", name);
3603 retval += printf(",");
3605 retval += printf(format, rle->start);
3606 if (rle->count > 1) {
3607 retval += printf("-");
3608 retval += printf(format, rle->start +
3617 * @brief Releases all the resources in a list.
3619 * @param rl The resource list to purge.
3624 resource_list_purge(struct resource_list *rl)
3626 struct resource_list_entry *rle;
3628 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3630 bus_release_resource(rman_get_device(rle->res),
3631 rle->type, rle->rid, rle->res);
3632 STAILQ_REMOVE_HEAD(rl, link);
3638 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3641 return (device_add_child_ordered(dev, order, name, unit));
3645 * @brief Helper function for implementing DEVICE_PROBE()
3647 * This function can be used to help implement the DEVICE_PROBE() for
3648 * a bus (i.e. a device which has other devices attached to it). It
3649 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3653 bus_generic_probe(device_t dev)
3655 devclass_t dc = dev->devclass;
3658 TAILQ_FOREACH(dl, &dc->drivers, link) {
3660 * If this driver's pass is too high, then ignore it.
3661 * For most drivers in the default pass, this will
3662 * never be true. For early-pass drivers they will
3663 * only call the identify routines of eligible drivers
3664 * when this routine is called. Drivers for later
3665 * passes should have their identify routines called
3666 * on early-pass buses during BUS_NEW_PASS().
3668 if (dl->pass > bus_current_pass)
3670 DEVICE_IDENTIFY(dl->driver, dev);
3677 * @brief Helper function for implementing DEVICE_ATTACH()
3679 * This function can be used to help implement the DEVICE_ATTACH() for
3680 * a bus. It calls device_probe_and_attach() for each of the device's
3684 bus_generic_attach(device_t dev)
3688 TAILQ_FOREACH(child, &dev->children, link) {
3689 device_probe_and_attach(child);
3696 * @brief Helper function for implementing DEVICE_DETACH()
3698 * This function can be used to help implement the DEVICE_DETACH() for
3699 * a bus. It calls device_detach() for each of the device's
3703 bus_generic_detach(device_t dev)
3708 if (dev->state != DS_ATTACHED)
3712 * Detach children in the reverse order.
3713 * See bus_generic_suspend for details.
3715 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3716 if ((error = device_detach(child)) != 0)
3724 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3726 * This function can be used to help implement the DEVICE_SHUTDOWN()
3727 * for a bus. It calls device_shutdown() for each of the device's
3731 bus_generic_shutdown(device_t dev)
3736 * Shut down children in the reverse order.
3737 * See bus_generic_suspend for details.
3739 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3740 device_shutdown(child);
3747 * @brief Default function for suspending a child device.
3749 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3752 bus_generic_suspend_child(device_t dev, device_t child)
3756 error = DEVICE_SUSPEND(child);
3759 child->flags |= DF_SUSPENDED;
3765 * @brief Default function for resuming a child device.
3767 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3770 bus_generic_resume_child(device_t dev, device_t child)
3773 DEVICE_RESUME(child);
3774 child->flags &= ~DF_SUSPENDED;
3780 * @brief Helper function for implementing DEVICE_SUSPEND()
3782 * This function can be used to help implement the DEVICE_SUSPEND()
3783 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3784 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3785 * operation is aborted and any devices which were suspended are
3786 * resumed immediately by calling their DEVICE_RESUME() methods.
3789 bus_generic_suspend(device_t dev)
3795 * Suspend children in the reverse order.
3796 * For most buses all children are equal, so the order does not matter.
3797 * Other buses, such as acpi, carefully order their child devices to
3798 * express implicit dependencies between them. For such buses it is
3799 * safer to bring down devices in the reverse order.
3801 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3802 error = BUS_SUSPEND_CHILD(dev, child);
3804 child = TAILQ_NEXT(child, link);
3805 if (child != NULL) {
3806 TAILQ_FOREACH_FROM(child, &dev->children, link)
3807 BUS_RESUME_CHILD(dev, child);
3816 * @brief Helper function for implementing DEVICE_RESUME()
3818 * This function can be used to help implement the DEVICE_RESUME() for
3819 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3822 bus_generic_resume(device_t dev)
3826 TAILQ_FOREACH(child, &dev->children, link) {
3827 BUS_RESUME_CHILD(dev, child);
3828 /* if resume fails, there's nothing we can usefully do... */
3834 * @brief Helper function for implementing BUS_PRINT_CHILD().
3836 * This function prints the first part of the ascii representation of
3837 * @p child, including its name, unit and description (if any - see
3838 * device_set_desc()).
3840 * @returns the number of characters printed
3843 bus_print_child_header(device_t dev, device_t child)
3847 if (device_get_desc(child)) {
3848 retval += device_printf(child, "<%s>", device_get_desc(child));
3850 retval += printf("%s", device_get_nameunit(child));
3857 * @brief Helper function for implementing BUS_PRINT_CHILD().
3859 * This function prints the last part of the ascii representation of
3860 * @p child, which consists of the string @c " on " followed by the
3861 * name and unit of the @p dev.
3863 * @returns the number of characters printed
3866 bus_print_child_footer(device_t dev, device_t child)
3868 return (printf(" on %s\n", device_get_nameunit(dev)));
3872 * @brief Helper function for implementing BUS_PRINT_CHILD().
3874 * This function prints out the VM domain for the given device.
3876 * @returns the number of characters printed
3879 bus_print_child_domain(device_t dev, device_t child)
3883 /* No domain? Don't print anything */
3884 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3887 return (printf(" numa-domain %d", domain));
3891 * @brief Helper function for implementing BUS_PRINT_CHILD().
3893 * This function simply calls bus_print_child_header() followed by
3894 * bus_print_child_footer().
3896 * @returns the number of characters printed
3899 bus_generic_print_child(device_t dev, device_t child)
3903 retval += bus_print_child_header(dev, child);
3904 retval += bus_print_child_domain(dev, child);
3905 retval += bus_print_child_footer(dev, child);
3911 * @brief Stub function for implementing BUS_READ_IVAR().
3916 bus_generic_read_ivar(device_t dev, device_t child, int index,
3923 * @brief Stub function for implementing BUS_WRITE_IVAR().
3928 bus_generic_write_ivar(device_t dev, device_t child, int index,
3935 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3939 struct resource_list *
3940 bus_generic_get_resource_list(device_t dev, device_t child)
3946 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3948 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3949 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3950 * and then calls device_probe_and_attach() for each unattached child.
3953 bus_generic_driver_added(device_t dev, driver_t *driver)
3957 DEVICE_IDENTIFY(driver, dev);
3958 TAILQ_FOREACH(child, &dev->children, link) {
3959 if (child->state == DS_NOTPRESENT ||
3960 (child->flags & DF_REBID))
3961 device_probe_and_attach(child);
3966 * @brief Helper function for implementing BUS_NEW_PASS().
3968 * This implementing of BUS_NEW_PASS() first calls the identify
3969 * routines for any drivers that probe at the current pass. Then it
3970 * walks the list of devices for this bus. If a device is already
3971 * attached, then it calls BUS_NEW_PASS() on that device. If the
3972 * device is not already attached, it attempts to attach a driver to
3976 bus_generic_new_pass(device_t dev)
3983 TAILQ_FOREACH(dl, &dc->drivers, link) {
3984 if (dl->pass == bus_current_pass)
3985 DEVICE_IDENTIFY(dl->driver, dev);
3987 TAILQ_FOREACH(child, &dev->children, link) {
3988 if (child->state >= DS_ATTACHED)
3989 BUS_NEW_PASS(child);
3990 else if (child->state == DS_NOTPRESENT)
3991 device_probe_and_attach(child);
3996 * @brief Helper function for implementing BUS_SETUP_INTR().
3998 * This simple implementation of BUS_SETUP_INTR() simply calls the
3999 * BUS_SETUP_INTR() method of the parent of @p dev.
4002 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4003 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4006 /* Propagate up the bus hierarchy until someone handles it. */
4008 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4009 filter, intr, arg, cookiep));
4014 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4016 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4017 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4020 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4023 /* Propagate up the bus hierarchy until someone handles it. */
4025 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4030 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4032 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4033 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4036 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4037 struct resource *r, rman_res_t start, rman_res_t end)
4039 /* Propagate up the bus hierarchy until someone handles it. */
4041 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4047 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4049 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4050 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4053 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4054 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4056 /* Propagate up the bus hierarchy until someone handles it. */
4058 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4059 start, end, count, flags));
4064 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4066 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4067 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4070 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4073 /* Propagate up the bus hierarchy until someone handles it. */
4075 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4081 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4083 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4084 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4087 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4090 /* Propagate up the bus hierarchy until someone handles it. */
4092 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4098 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4100 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4101 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4104 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4105 int rid, struct resource *r)
4107 /* Propagate up the bus hierarchy until someone handles it. */
4109 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4115 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4117 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4118 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4121 bus_generic_map_resource(device_t dev, device_t child, int type,
4122 struct resource *r, struct resource_map_request *args,
4123 struct resource_map *map)
4125 /* Propagate up the bus hierarchy until someone handles it. */
4127 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4133 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4135 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4136 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4139 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4140 struct resource *r, struct resource_map *map)
4142 /* Propagate up the bus hierarchy until someone handles it. */
4144 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4149 * @brief Helper function for implementing BUS_BIND_INTR().
4151 * This simple implementation of BUS_BIND_INTR() simply calls the
4152 * BUS_BIND_INTR() method of the parent of @p dev.
4155 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4159 /* Propagate up the bus hierarchy until someone handles it. */
4161 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4166 * @brief Helper function for implementing BUS_CONFIG_INTR().
4168 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4169 * BUS_CONFIG_INTR() method of the parent of @p dev.
4172 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4173 enum intr_polarity pol)
4176 /* Propagate up the bus hierarchy until someone handles it. */
4178 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4183 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4185 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4186 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4189 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4190 void *cookie, const char *descr)
4193 /* Propagate up the bus hierarchy until someone handles it. */
4195 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4201 * @brief Helper function for implementing BUS_GET_CPUS().
4203 * This simple implementation of BUS_GET_CPUS() simply calls the
4204 * BUS_GET_CPUS() method of the parent of @p dev.
4207 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4208 size_t setsize, cpuset_t *cpuset)
4211 /* Propagate up the bus hierarchy until someone handles it. */
4212 if (dev->parent != NULL)
4213 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4218 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4220 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4221 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4224 bus_generic_get_dma_tag(device_t dev, device_t child)
4227 /* Propagate up the bus hierarchy until someone handles it. */
4228 if (dev->parent != NULL)
4229 return (BUS_GET_DMA_TAG(dev->parent, child));
4234 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4236 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4237 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4240 bus_generic_get_bus_tag(device_t dev, device_t child)
4243 /* Propagate up the bus hierarchy until someone handles it. */
4244 if (dev->parent != NULL)
4245 return (BUS_GET_BUS_TAG(dev->parent, child));
4246 return ((bus_space_tag_t)0);
4250 * @brief Helper function for implementing BUS_GET_RESOURCE().
4252 * This implementation of BUS_GET_RESOURCE() uses the
4253 * resource_list_find() function to do most of the work. It calls
4254 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4258 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4259 rman_res_t *startp, rman_res_t *countp)
4261 struct resource_list * rl = NULL;
4262 struct resource_list_entry * rle = NULL;
4264 rl = BUS_GET_RESOURCE_LIST(dev, child);
4268 rle = resource_list_find(rl, type, rid);
4273 *startp = rle->start;
4275 *countp = rle->count;
4281 * @brief Helper function for implementing BUS_SET_RESOURCE().
4283 * This implementation of BUS_SET_RESOURCE() uses the
4284 * resource_list_add() function to do most of the work. It calls
4285 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4289 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4290 rman_res_t start, rman_res_t count)
4292 struct resource_list * rl = NULL;
4294 rl = BUS_GET_RESOURCE_LIST(dev, child);
4298 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4304 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4306 * This implementation of BUS_DELETE_RESOURCE() uses the
4307 * resource_list_delete() function to do most of the work. It calls
4308 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4312 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4314 struct resource_list * rl = NULL;
4316 rl = BUS_GET_RESOURCE_LIST(dev, child);
4320 resource_list_delete(rl, type, rid);
4326 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4328 * This implementation of BUS_RELEASE_RESOURCE() uses the
4329 * resource_list_release() function to do most of the work. It calls
4330 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4333 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4334 int rid, struct resource *r)
4336 struct resource_list * rl = NULL;
4338 if (device_get_parent(child) != dev)
4339 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4342 rl = BUS_GET_RESOURCE_LIST(dev, child);
4346 return (resource_list_release(rl, dev, child, type, rid, r));
4350 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4352 * This implementation of BUS_ALLOC_RESOURCE() uses the
4353 * resource_list_alloc() function to do most of the work. It calls
4354 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4357 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4358 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4360 struct resource_list * rl = NULL;
4362 if (device_get_parent(child) != dev)
4363 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4364 type, rid, start, end, count, flags));
4366 rl = BUS_GET_RESOURCE_LIST(dev, child);
4370 return (resource_list_alloc(rl, dev, child, type, rid,
4371 start, end, count, flags));
4375 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4377 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4378 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4381 bus_generic_child_present(device_t dev, device_t child)
4383 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4387 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4391 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4397 * @brief Helper function for implementing BUS_RESCAN().
4399 * This null implementation of BUS_RESCAN() always fails to indicate
4400 * the bus does not support rescanning.
4403 bus_null_rescan(device_t dev)
4410 * Some convenience functions to make it easier for drivers to use the
4411 * resource-management functions. All these really do is hide the
4412 * indirection through the parent's method table, making for slightly
4413 * less-wordy code. In the future, it might make sense for this code
4414 * to maintain some sort of a list of resources allocated by each device.
4418 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4419 struct resource **res)
4423 for (i = 0; rs[i].type != -1; i++)
4425 for (i = 0; rs[i].type != -1; i++) {
4426 res[i] = bus_alloc_resource_any(dev,
4427 rs[i].type, &rs[i].rid, rs[i].flags);
4428 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4429 bus_release_resources(dev, rs, res);
4437 bus_release_resources(device_t dev, const struct resource_spec *rs,
4438 struct resource **res)
4442 for (i = 0; rs[i].type != -1; i++)
4443 if (res[i] != NULL) {
4444 bus_release_resource(
4445 dev, rs[i].type, rs[i].rid, res[i]);
4451 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4453 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4457 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4458 rman_res_t end, rman_res_t count, u_int flags)
4460 struct resource *res;
4462 if (dev->parent == NULL)
4464 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4470 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4472 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4476 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4479 if (dev->parent == NULL)
4481 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4485 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4487 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4491 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4493 if (dev->parent == NULL)
4495 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4499 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4501 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4505 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4507 if (dev->parent == NULL)
4509 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4513 * @brief Wrapper function for BUS_MAP_RESOURCE().
4515 * This function simply calls the BUS_MAP_RESOURCE() method of the
4519 bus_map_resource(device_t dev, int type, struct resource *r,
4520 struct resource_map_request *args, struct resource_map *map)
4522 if (dev->parent == NULL)
4524 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4528 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4530 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4534 bus_unmap_resource(device_t dev, int type, struct resource *r,
4535 struct resource_map *map)
4537 if (dev->parent == NULL)
4539 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4543 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4545 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4549 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4553 if (dev->parent == NULL)
4555 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4560 * @brief Wrapper function for BUS_SETUP_INTR().
4562 * This function simply calls the BUS_SETUP_INTR() method of the
4566 bus_setup_intr(device_t dev, struct resource *r, int flags,
4567 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4571 if (dev->parent == NULL)
4573 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4577 if (handler != NULL && !(flags & INTR_MPSAFE))
4578 device_printf(dev, "[GIANT-LOCKED]\n");
4583 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4585 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4589 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4591 if (dev->parent == NULL)
4593 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4597 * @brief Wrapper function for BUS_BIND_INTR().
4599 * This function simply calls the BUS_BIND_INTR() method of the
4603 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4605 if (dev->parent == NULL)
4607 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4611 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4613 * This function first formats the requested description into a
4614 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4615 * the parent of @p dev.
4618 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4619 const char *fmt, ...)
4622 char descr[MAXCOMLEN + 1];
4624 if (dev->parent == NULL)
4627 vsnprintf(descr, sizeof(descr), fmt, ap);
4629 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4633 * @brief Wrapper function for BUS_SET_RESOURCE().
4635 * This function simply calls the BUS_SET_RESOURCE() method of the
4639 bus_set_resource(device_t dev, int type, int rid,
4640 rman_res_t start, rman_res_t count)
4642 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4647 * @brief Wrapper function for BUS_GET_RESOURCE().
4649 * This function simply calls the BUS_GET_RESOURCE() method of the
4653 bus_get_resource(device_t dev, int type, int rid,
4654 rman_res_t *startp, rman_res_t *countp)
4656 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4661 * @brief Wrapper function for BUS_GET_RESOURCE().
4663 * This function simply calls the BUS_GET_RESOURCE() method of the
4664 * parent of @p dev and returns the start value.
4667 bus_get_resource_start(device_t dev, int type, int rid)
4673 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4681 * @brief Wrapper function for BUS_GET_RESOURCE().
4683 * This function simply calls the BUS_GET_RESOURCE() method of the
4684 * parent of @p dev and returns the count value.
4687 bus_get_resource_count(device_t dev, int type, int rid)
4693 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4701 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4703 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4707 bus_delete_resource(device_t dev, int type, int rid)
4709 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4713 * @brief Wrapper function for BUS_CHILD_PRESENT().
4715 * This function simply calls the BUS_CHILD_PRESENT() method of the
4719 bus_child_present(device_t child)
4721 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4725 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4727 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4731 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4735 parent = device_get_parent(child);
4736 if (parent == NULL) {
4740 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4744 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4746 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4750 bus_child_location_str(device_t child, char *buf, size_t buflen)
4754 parent = device_get_parent(child);
4755 if (parent == NULL) {
4759 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4763 * @brief Wrapper function for BUS_GET_CPUS().
4765 * This function simply calls the BUS_GET_CPUS() method of the
4769 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4773 parent = device_get_parent(dev);
4776 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4780 * @brief Wrapper function for BUS_GET_DMA_TAG().
4782 * This function simply calls the BUS_GET_DMA_TAG() method of the
4786 bus_get_dma_tag(device_t dev)
4790 parent = device_get_parent(dev);
4793 return (BUS_GET_DMA_TAG(parent, dev));
4797 * @brief Wrapper function for BUS_GET_BUS_TAG().
4799 * This function simply calls the BUS_GET_BUS_TAG() method of the
4803 bus_get_bus_tag(device_t dev)
4807 parent = device_get_parent(dev);
4809 return ((bus_space_tag_t)0);
4810 return (BUS_GET_BUS_TAG(parent, dev));
4814 * @brief Wrapper function for BUS_GET_DOMAIN().
4816 * This function simply calls the BUS_GET_DOMAIN() method of the
4820 bus_get_domain(device_t dev, int *domain)
4822 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4825 /* Resume all devices and then notify userland that we're up again. */
4827 root_resume(device_t dev)
4831 error = bus_generic_resume(dev);
4833 devctl_notify("kern", "power", "resume", NULL);
4838 root_print_child(device_t dev, device_t child)
4842 retval += bus_print_child_header(dev, child);
4843 retval += printf("\n");
4849 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4850 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4853 * If an interrupt mapping gets to here something bad has happened.
4855 panic("root_setup_intr");
4859 * If we get here, assume that the device is permanent and really is
4860 * present in the system. Removable bus drivers are expected to intercept
4861 * this call long before it gets here. We return -1 so that drivers that
4862 * really care can check vs -1 or some ERRNO returned higher in the food
4866 root_child_present(device_t dev, device_t child)
4872 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4878 /* Default to returning the set of all CPUs. */
4879 if (setsize != sizeof(cpuset_t))
4888 static kobj_method_t root_methods[] = {
4889 /* Device interface */
4890 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4891 KOBJMETHOD(device_suspend, bus_generic_suspend),
4892 KOBJMETHOD(device_resume, root_resume),
4895 KOBJMETHOD(bus_print_child, root_print_child),
4896 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4897 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4898 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4899 KOBJMETHOD(bus_child_present, root_child_present),
4900 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4905 static driver_t root_driver = {
4912 devclass_t root_devclass;
4915 root_bus_module_handler(module_t mod, int what, void* arg)
4919 TAILQ_INIT(&bus_data_devices);
4920 kobj_class_compile((kobj_class_t) &root_driver);
4921 root_bus = make_device(NULL, "root", 0);
4922 root_bus->desc = "System root bus";
4923 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4924 root_bus->driver = &root_driver;
4925 root_bus->state = DS_ATTACHED;
4926 root_devclass = devclass_find_internal("root", NULL, FALSE);
4931 device_shutdown(root_bus);
4934 return (EOPNOTSUPP);
4940 static moduledata_t root_bus_mod = {
4942 root_bus_module_handler,
4945 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4948 * @brief Automatically configure devices
4950 * This function begins the autoconfiguration process by calling
4951 * device_probe_and_attach() for each child of the @c root0 device.
4954 root_bus_configure(void)
4959 /* Eventually this will be split up, but this is sufficient for now. */
4960 bus_set_pass(BUS_PASS_DEFAULT);
4964 * @brief Module handler for registering device drivers
4966 * This module handler is used to automatically register device
4967 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4968 * devclass_add_driver() for the driver described by the
4969 * driver_module_data structure pointed to by @p arg
4972 driver_module_handler(module_t mod, int what, void *arg)
4974 struct driver_module_data *dmd;
4975 devclass_t bus_devclass;
4976 kobj_class_t driver;
4979 dmd = (struct driver_module_data *)arg;
4980 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4985 if (dmd->dmd_chainevh)
4986 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4988 pass = dmd->dmd_pass;
4989 driver = dmd->dmd_driver;
4990 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4991 DRIVERNAME(driver), dmd->dmd_busname, pass));
4992 error = devclass_add_driver(bus_devclass, driver, pass,
4997 PDEBUG(("Unloading module: driver %s from bus %s",
4998 DRIVERNAME(dmd->dmd_driver),
5000 error = devclass_delete_driver(bus_devclass,
5003 if (!error && dmd->dmd_chainevh)
5004 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5007 PDEBUG(("Quiesce module: driver %s from bus %s",
5008 DRIVERNAME(dmd->dmd_driver),
5010 error = devclass_quiesce_driver(bus_devclass,
5013 if (!error && dmd->dmd_chainevh)
5014 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5025 * @brief Enumerate all hinted devices for this bus.
5027 * Walks through the hints for this bus and calls the bus_hinted_child
5028 * routine for each one it fines. It searches first for the specific
5029 * bus that's being probed for hinted children (eg isa0), and then for
5030 * generic children (eg isa).
5032 * @param dev bus device to enumerate
5035 bus_enumerate_hinted_children(device_t bus)
5038 const char *dname, *busname;
5042 * enumerate all devices on the specific bus
5044 busname = device_get_nameunit(bus);
5046 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5047 BUS_HINTED_CHILD(bus, dname, dunit);
5050 * and all the generic ones.
5052 busname = device_get_name(bus);
5054 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5055 BUS_HINTED_CHILD(bus, dname, dunit);
5060 /* the _short versions avoid iteration by not calling anything that prints
5061 * more than oneliners. I love oneliners.
5065 print_device_short(device_t dev, int indent)
5070 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5071 dev->unit, dev->desc,
5072 (dev->parent? "":"no "),
5073 (TAILQ_EMPTY(&dev->children)? "no ":""),
5074 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5075 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5076 (dev->flags&DF_WILDCARD? "wildcard,":""),
5077 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5078 (dev->flags&DF_REBID? "rebiddable,":""),
5079 (dev->flags&DF_SUSPENDED? "suspended,":""),
5080 (dev->ivars? "":"no "),
5081 (dev->softc? "":"no "),
5086 print_device(device_t dev, int indent)
5091 print_device_short(dev, indent);
5093 indentprintf(("Parent:\n"));
5094 print_device_short(dev->parent, indent+1);
5095 indentprintf(("Driver:\n"));
5096 print_driver_short(dev->driver, indent+1);
5097 indentprintf(("Devclass:\n"));
5098 print_devclass_short(dev->devclass, indent+1);
5102 print_device_tree_short(device_t dev, int indent)
5103 /* print the device and all its children (indented) */
5110 print_device_short(dev, indent);
5112 TAILQ_FOREACH(child, &dev->children, link) {
5113 print_device_tree_short(child, indent+1);
5118 print_device_tree(device_t dev, int indent)
5119 /* print the device and all its children (indented) */
5126 print_device(dev, indent);
5128 TAILQ_FOREACH(child, &dev->children, link) {
5129 print_device_tree(child, indent+1);
5134 print_driver_short(driver_t *driver, int indent)
5139 indentprintf(("driver %s: softc size = %zd\n",
5140 driver->name, driver->size));
5144 print_driver(driver_t *driver, int indent)
5149 print_driver_short(driver, indent);
5153 print_driver_list(driver_list_t drivers, int indent)
5155 driverlink_t driver;
5157 TAILQ_FOREACH(driver, &drivers, link) {
5158 print_driver(driver->driver, indent);
5163 print_devclass_short(devclass_t dc, int indent)
5168 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5172 print_devclass(devclass_t dc, int indent)
5179 print_devclass_short(dc, indent);
5180 indentprintf(("Drivers:\n"));
5181 print_driver_list(dc->drivers, indent+1);
5183 indentprintf(("Devices:\n"));
5184 for (i = 0; i < dc->maxunit; i++)
5186 print_device(dc->devices[i], indent+1);
5190 print_devclass_list_short(void)
5194 printf("Short listing of devclasses, drivers & devices:\n");
5195 TAILQ_FOREACH(dc, &devclasses, link) {
5196 print_devclass_short(dc, 0);
5201 print_devclass_list(void)
5205 printf("Full listing of devclasses, drivers & devices:\n");
5206 TAILQ_FOREACH(dc, &devclasses, link) {
5207 print_devclass(dc, 0);
5214 * User-space access to the device tree.
5216 * We implement a small set of nodes:
5218 * hw.bus Single integer read method to obtain the
5219 * current generation count.
5220 * hw.bus.devices Reads the entire device tree in flat space.
5221 * hw.bus.rman Resource manager interface
5223 * We might like to add the ability to scan devclasses and/or drivers to
5224 * determine what else is currently loaded/available.
5228 sysctl_bus(SYSCTL_HANDLER_ARGS)
5230 struct u_businfo ubus;
5232 ubus.ub_version = BUS_USER_VERSION;
5233 ubus.ub_generation = bus_data_generation;
5235 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5237 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5238 "bus-related data");
5241 sysctl_devices(SYSCTL_HANDLER_ARGS)
5243 int *name = (int *)arg1;
5244 u_int namelen = arg2;
5247 struct u_device udev; /* XXX this is a bit big */
5253 if (bus_data_generation_check(name[0]))
5259 * Scan the list of devices, looking for the requested index.
5261 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5269 * Populate the return array.
5271 bzero(&udev, sizeof(udev));
5272 udev.dv_handle = (uintptr_t)dev;
5273 udev.dv_parent = (uintptr_t)dev->parent;
5274 if (dev->nameunit != NULL)
5275 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
5276 if (dev->desc != NULL)
5277 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
5278 if (dev->driver != NULL && dev->driver->name != NULL)
5279 strlcpy(udev.dv_drivername, dev->driver->name,
5280 sizeof(udev.dv_drivername));
5281 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
5282 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
5283 udev.dv_devflags = dev->devflags;
5284 udev.dv_flags = dev->flags;
5285 udev.dv_state = dev->state;
5286 error = SYSCTL_OUT(req, &udev, sizeof(udev));
5290 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5291 "system device tree");
5294 bus_data_generation_check(int generation)
5296 if (generation != bus_data_generation)
5299 /* XXX generate optimised lists here? */
5304 bus_data_generation_update(void)
5306 bus_data_generation++;
5310 bus_free_resource(device_t dev, int type, struct resource *r)
5314 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5318 device_lookup_by_name(const char *name)
5322 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5323 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5330 * /dev/devctl2 implementation. The existing /dev/devctl device has
5331 * implicit semantics on open, so it could not be reused for this.
5332 * Another option would be to call this /dev/bus?
5335 find_device(struct devreq *req, device_t *devp)
5340 * First, ensure that the name is nul terminated.
5342 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5346 * Second, try to find an attached device whose name matches
5349 dev = device_lookup_by_name(req->dr_name);
5355 /* Finally, give device enumerators a chance. */
5357 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5365 driver_exists(device_t bus, const char *driver)
5369 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5370 if (devclass_find_driver_internal(dc, driver) != NULL)
5377 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5384 /* Locate the device to control. */
5386 req = (struct devreq *)data;
5394 case DEV_SET_DRIVER:
5395 case DEV_CLEAR_DRIVER:
5398 error = priv_check(td, PRIV_DRIVER);
5400 error = find_device(req, &dev);
5411 /* Perform the requested operation. */
5414 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5416 else if (!device_is_enabled(dev))
5419 error = device_probe_and_attach(dev);
5422 if (!device_is_attached(dev)) {
5426 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5427 error = device_quiesce(dev);
5431 error = device_detach(dev);
5434 if (device_is_enabled(dev)) {
5440 * If the device has been probed but not attached (e.g.
5441 * when it has been disabled by a loader hint), just
5442 * attach the device rather than doing a full probe.
5445 if (device_is_alive(dev)) {
5447 * If the device was disabled via a hint, clear
5450 if (resource_disabled(dev->driver->name, dev->unit))
5451 resource_unset_value(dev->driver->name,
5452 dev->unit, "disabled");
5453 error = device_attach(dev);
5455 error = device_probe_and_attach(dev);
5458 if (!device_is_enabled(dev)) {
5463 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5464 error = device_quiesce(dev);
5470 * Force DF_FIXEDCLASS on around detach to preserve
5471 * the existing name.
5474 dev->flags |= DF_FIXEDCLASS;
5475 error = device_detach(dev);
5476 if (!(old & DF_FIXEDCLASS))
5477 dev->flags &= ~DF_FIXEDCLASS;
5479 device_disable(dev);
5482 if (device_is_suspended(dev)) {
5486 if (device_get_parent(dev) == NULL) {
5490 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5493 if (!device_is_suspended(dev)) {
5497 if (device_get_parent(dev) == NULL) {
5501 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5503 case DEV_SET_DRIVER: {
5507 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5510 if (driver[0] == '\0') {
5514 if (dev->devclass != NULL &&
5515 strcmp(driver, dev->devclass->name) == 0)
5516 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5520 * Scan drivers for this device's bus looking for at
5521 * least one matching driver.
5523 if (dev->parent == NULL) {
5527 if (!driver_exists(dev->parent, driver)) {
5531 dc = devclass_create(driver);
5537 /* Detach device if necessary. */
5538 if (device_is_attached(dev)) {
5539 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5540 error = device_detach(dev);
5547 /* Clear any previously-fixed device class and unit. */
5548 if (dev->flags & DF_FIXEDCLASS)
5549 devclass_delete_device(dev->devclass, dev);
5550 dev->flags |= DF_WILDCARD;
5553 /* Force the new device class. */
5554 error = devclass_add_device(dc, dev);
5557 dev->flags |= DF_FIXEDCLASS;
5558 error = device_probe_and_attach(dev);
5561 case DEV_CLEAR_DRIVER:
5562 if (!(dev->flags & DF_FIXEDCLASS)) {
5566 if (device_is_attached(dev)) {
5567 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5568 error = device_detach(dev);
5575 dev->flags &= ~DF_FIXEDCLASS;
5576 dev->flags |= DF_WILDCARD;
5577 devclass_delete_device(dev->devclass, dev);
5578 error = device_probe_and_attach(dev);
5581 if (!device_is_attached(dev)) {
5585 error = BUS_RESCAN(dev);
5590 parent = device_get_parent(dev);
5591 if (parent == NULL) {
5595 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5596 if (bus_child_present(dev) != 0) {
5602 error = device_delete_child(parent, dev);
5610 static struct cdevsw devctl2_cdevsw = {
5611 .d_version = D_VERSION,
5612 .d_ioctl = devctl2_ioctl,
5613 .d_name = "devctl2",
5620 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5621 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5625 * APIs to manage deprecation and obsolescence.
5627 static int obsolete_panic = 0;
5628 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5630 /* 0 - don't panic, 1 - panic if already obsolete, 2 - panic if deprecated */
5632 gone_panic(int major, int running, const char *msg)
5635 switch (obsolete_panic)
5640 if (running < major)
5649 _gone_in(int major, const char *msg)
5652 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5653 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5654 printf("Obsolete code will removed soon: %s\n", msg);
5655 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5656 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5661 _gone_in_dev(device_t dev, int major, const char *msg)
5664 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5665 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5667 "Obsolete code will removed soon: %s\n", msg);
5668 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5670 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5675 DB_SHOW_COMMAND(device, db_show_device)
5682 dev = (device_t)addr;
5684 db_printf("name: %s\n", device_get_nameunit(dev));
5685 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5686 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5687 db_printf(" addr: %p\n", dev);
5688 db_printf(" parent: %p\n", dev->parent);
5689 db_printf(" softc: %p\n", dev->softc);
5690 db_printf(" ivars: %p\n", dev->ivars);
5693 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5697 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5698 db_show_device((db_expr_t)dev, true, count, modif);