2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/eventhandler.h>
38 #include <sys/filio.h>
40 #include <sys/kernel.h>
42 #include <sys/limits.h>
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #include <sys/queue.h>
51 #include <machine/bus.h>
52 #include <sys/random.h>
55 #include <sys/selinfo.h>
56 #include <sys/signalvar.h>
58 #include <sys/sysctl.h>
59 #include <sys/systm.h>
62 #include <sys/cpuset.h>
66 #include <machine/cpu.h>
67 #include <machine/stdarg.h>
74 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
75 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
78 * Used to attach drivers to devclasses.
80 typedef struct driverlink *driverlink_t;
83 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
86 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
87 TAILQ_ENTRY(driverlink) passlink;
91 * Forward declarations
93 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
94 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
95 typedef TAILQ_HEAD(device_list, device) device_list_t;
98 TAILQ_ENTRY(devclass) link;
99 devclass_t parent; /* parent in devclass hierarchy */
100 driver_list_t drivers; /* bus devclasses store drivers for bus */
102 device_t *devices; /* array of devices indexed by unit */
103 int maxunit; /* size of devices array */
105 #define DC_HAS_CHILDREN 1
107 struct sysctl_ctx_list sysctl_ctx;
108 struct sysctl_oid *sysctl_tree;
112 * @brief Implementation of device.
116 * A device is a kernel object. The first field must be the
117 * current ops table for the object.
124 TAILQ_ENTRY(device) link; /**< list of devices in parent */
125 TAILQ_ENTRY(device) devlink; /**< global device list membership */
126 device_t parent; /**< parent of this device */
127 device_list_t children; /**< list of child devices */
130 * Details of this device.
132 driver_t *driver; /**< current driver */
133 devclass_t devclass; /**< current device class */
134 int unit; /**< current unit number */
135 char* nameunit; /**< name+unit e.g. foodev0 */
136 char* desc; /**< driver specific description */
137 int busy; /**< count of calls to device_busy() */
138 device_state_t state; /**< current device state */
139 uint32_t devflags; /**< api level flags for device_get_flags() */
140 u_int flags; /**< internal device flags */
141 u_int order; /**< order from device_add_child_ordered() */
142 void *ivars; /**< instance variables */
143 void *softc; /**< current driver's variables */
145 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
146 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
149 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
150 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
152 EVENTHANDLER_LIST_DEFINE(device_attach);
153 EVENTHANDLER_LIST_DEFINE(device_detach);
154 EVENTHANDLER_LIST_DEFINE(dev_lookup);
156 static void devctl2_init(void);
157 static bool device_frozen;
159 #define DRIVERNAME(d) ((d)? d->name : "no driver")
160 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
164 static int bus_debug = 1;
165 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
168 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
169 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
172 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
173 * prevent syslog from deleting initial spaces
175 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
177 static void print_device_short(device_t dev, int indent);
178 static void print_device(device_t dev, int indent);
179 void print_device_tree_short(device_t dev, int indent);
180 void print_device_tree(device_t dev, int indent);
181 static void print_driver_short(driver_t *driver, int indent);
182 static void print_driver(driver_t *driver, int indent);
183 static void print_driver_list(driver_list_t drivers, int indent);
184 static void print_devclass_short(devclass_t dc, int indent);
185 static void print_devclass(devclass_t dc, int indent);
186 void print_devclass_list_short(void);
187 void print_devclass_list(void);
190 /* Make the compiler ignore the function calls */
191 #define PDEBUG(a) /* nop */
192 #define DEVICENAME(d) /* nop */
194 #define print_device_short(d,i) /* nop */
195 #define print_device(d,i) /* nop */
196 #define print_device_tree_short(d,i) /* nop */
197 #define print_device_tree(d,i) /* nop */
198 #define print_driver_short(d,i) /* nop */
199 #define print_driver(d,i) /* nop */
200 #define print_driver_list(d,i) /* nop */
201 #define print_devclass_short(d,i) /* nop */
202 #define print_devclass(d,i) /* nop */
203 #define print_devclass_list_short() /* nop */
204 #define print_devclass_list() /* nop */
212 DEVCLASS_SYSCTL_PARENT,
216 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
218 devclass_t dc = (devclass_t)arg1;
222 case DEVCLASS_SYSCTL_PARENT:
223 value = dc->parent ? dc->parent->name : "";
228 return (SYSCTL_OUT_STR(req, value));
232 devclass_sysctl_init(devclass_t dc)
235 if (dc->sysctl_tree != NULL)
237 sysctl_ctx_init(&dc->sysctl_ctx);
238 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
239 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
240 CTLFLAG_RD, NULL, "");
241 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
242 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
243 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
249 DEVICE_SYSCTL_DRIVER,
250 DEVICE_SYSCTL_LOCATION,
251 DEVICE_SYSCTL_PNPINFO,
252 DEVICE_SYSCTL_PARENT,
256 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
258 device_t dev = (device_t)arg1;
265 case DEVICE_SYSCTL_DESC:
266 value = dev->desc ? dev->desc : "";
268 case DEVICE_SYSCTL_DRIVER:
269 value = dev->driver ? dev->driver->name : "";
271 case DEVICE_SYSCTL_LOCATION:
272 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
273 bus_child_location_str(dev, buf, 1024);
275 case DEVICE_SYSCTL_PNPINFO:
276 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
277 bus_child_pnpinfo_str(dev, buf, 1024);
279 case DEVICE_SYSCTL_PARENT:
280 value = dev->parent ? dev->parent->nameunit : "";
285 error = SYSCTL_OUT_STR(req, value);
292 device_sysctl_init(device_t dev)
294 devclass_t dc = dev->devclass;
297 if (dev->sysctl_tree != NULL)
299 devclass_sysctl_init(dc);
300 sysctl_ctx_init(&dev->sysctl_ctx);
301 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
302 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
303 dev->nameunit + strlen(dc->name),
304 CTLFLAG_RD, NULL, "", "device_index");
305 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
306 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
307 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
308 "device description");
309 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
310 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
311 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
312 "device driver name");
313 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
314 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
315 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
316 "device location relative to parent");
317 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
319 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
320 "device identification");
321 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
322 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
323 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
325 if (bus_get_domain(dev, &domain) == 0)
326 SYSCTL_ADD_INT(&dev->sysctl_ctx,
327 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
328 CTLFLAG_RD, NULL, domain, "NUMA domain");
332 device_sysctl_update(device_t dev)
334 devclass_t dc = dev->devclass;
336 if (dev->sysctl_tree == NULL)
338 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
342 device_sysctl_fini(device_t dev)
344 if (dev->sysctl_tree == NULL)
346 sysctl_ctx_free(&dev->sysctl_ctx);
347 dev->sysctl_tree = NULL;
351 * /dev/devctl implementation
355 * This design allows only one reader for /dev/devctl. This is not desirable
356 * in the long run, but will get a lot of hair out of this implementation.
357 * Maybe we should make this device a clonable device.
359 * Also note: we specifically do not attach a device to the device_t tree
360 * to avoid potential chicken and egg problems. One could argue that all
361 * of this belongs to the root node. One could also further argue that the
362 * sysctl interface that we have not might more properly be an ioctl
363 * interface, but at this stage of the game, I'm not inclined to rock that
366 * I'm also not sure that the SIGIO support is done correctly or not, as
367 * I copied it from a driver that had SIGIO support that likely hasn't been
368 * tested since 3.4 or 2.2.8!
371 /* Deprecated way to adjust queue length */
372 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
373 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
374 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
375 "devctl disable -- deprecated");
377 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
378 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
379 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
380 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
381 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
383 static d_open_t devopen;
384 static d_close_t devclose;
385 static d_read_t devread;
386 static d_ioctl_t devioctl;
387 static d_poll_t devpoll;
388 static d_kqfilter_t devkqfilter;
390 static struct cdevsw dev_cdevsw = {
391 .d_version = D_VERSION,
397 .d_kqfilter = devkqfilter,
401 struct dev_event_info
404 TAILQ_ENTRY(dev_event_info) dei_link;
407 TAILQ_HEAD(devq, dev_event_info);
409 static struct dev_softc
422 static void filt_devctl_detach(struct knote *kn);
423 static int filt_devctl_read(struct knote *kn, long hint);
425 struct filterops devctl_rfiltops = {
427 .f_detach = filt_devctl_detach,
428 .f_event = filt_devctl_read,
431 static struct cdev *devctl_dev;
436 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
437 UID_ROOT, GID_WHEEL, 0600, "devctl");
438 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
439 cv_init(&devsoftc.cv, "dev cv");
440 TAILQ_INIT(&devsoftc.devq);
441 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
446 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
449 mtx_lock(&devsoftc.mtx);
450 if (devsoftc.inuse) {
451 mtx_unlock(&devsoftc.mtx);
456 mtx_unlock(&devsoftc.mtx);
461 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
464 mtx_lock(&devsoftc.mtx);
466 devsoftc.nonblock = 0;
468 cv_broadcast(&devsoftc.cv);
469 funsetown(&devsoftc.sigio);
470 mtx_unlock(&devsoftc.mtx);
475 * The read channel for this device is used to report changes to
476 * userland in realtime. We are required to free the data as well as
477 * the n1 object because we allocate them separately. Also note that
478 * we return one record at a time. If you try to read this device a
479 * character at a time, you will lose the rest of the data. Listening
480 * programs are expected to cope.
483 devread(struct cdev *dev, struct uio *uio, int ioflag)
485 struct dev_event_info *n1;
488 mtx_lock(&devsoftc.mtx);
489 while (TAILQ_EMPTY(&devsoftc.devq)) {
490 if (devsoftc.nonblock) {
491 mtx_unlock(&devsoftc.mtx);
494 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
497 * Need to translate ERESTART to EINTR here? -- jake
499 mtx_unlock(&devsoftc.mtx);
503 n1 = TAILQ_FIRST(&devsoftc.devq);
504 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
506 mtx_unlock(&devsoftc.mtx);
507 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
508 free(n1->dei_data, M_BUS);
514 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
520 devsoftc.nonblock = 1;
522 devsoftc.nonblock = 0;
531 return fsetown(*(int *)data, &devsoftc.sigio);
533 *(int *)data = fgetown(&devsoftc.sigio);
536 /* (un)Support for other fcntl() calls. */
547 devpoll(struct cdev *dev, int events, struct thread *td)
551 mtx_lock(&devsoftc.mtx);
552 if (events & (POLLIN | POLLRDNORM)) {
553 if (!TAILQ_EMPTY(&devsoftc.devq))
554 revents = events & (POLLIN | POLLRDNORM);
556 selrecord(td, &devsoftc.sel);
558 mtx_unlock(&devsoftc.mtx);
564 devkqfilter(struct cdev *dev, struct knote *kn)
568 if (kn->kn_filter == EVFILT_READ) {
569 kn->kn_fop = &devctl_rfiltops;
570 knlist_add(&devsoftc.sel.si_note, kn, 0);
578 filt_devctl_detach(struct knote *kn)
581 knlist_remove(&devsoftc.sel.si_note, kn, 0);
585 filt_devctl_read(struct knote *kn, long hint)
587 kn->kn_data = devsoftc.queued;
588 return (kn->kn_data != 0);
592 * @brief Return whether the userland process is running
595 devctl_process_running(void)
597 return (devsoftc.inuse == 1);
601 * @brief Queue data to be read from the devctl device
603 * Generic interface to queue data to the devctl device. It is
604 * assumed that @p data is properly formatted. It is further assumed
605 * that @p data is allocated using the M_BUS malloc type.
608 devctl_queue_data_f(char *data, int flags)
610 struct dev_event_info *n1 = NULL, *n2 = NULL;
612 if (strlen(data) == 0)
614 if (devctl_queue_length == 0)
616 n1 = malloc(sizeof(*n1), M_BUS, flags);
620 mtx_lock(&devsoftc.mtx);
621 if (devctl_queue_length == 0) {
622 mtx_unlock(&devsoftc.mtx);
623 free(n1->dei_data, M_BUS);
627 /* Leave at least one spot in the queue... */
628 while (devsoftc.queued > devctl_queue_length - 1) {
629 n2 = TAILQ_FIRST(&devsoftc.devq);
630 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
631 free(n2->dei_data, M_BUS);
635 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
637 cv_broadcast(&devsoftc.cv);
638 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
639 mtx_unlock(&devsoftc.mtx);
640 selwakeup(&devsoftc.sel);
641 if (devsoftc.async && devsoftc.sigio != NULL)
642 pgsigio(&devsoftc.sigio, SIGIO, 0);
646 * We have to free data on all error paths since the caller
647 * assumes it will be free'd when this item is dequeued.
654 devctl_queue_data(char *data)
657 devctl_queue_data_f(data, M_NOWAIT);
661 * @brief Send a 'notification' to userland, using standard ways
664 devctl_notify_f(const char *system, const char *subsystem, const char *type,
665 const char *data, int flags)
671 return; /* BOGUS! Must specify system. */
672 if (subsystem == NULL)
673 return; /* BOGUS! Must specify subsystem. */
675 return; /* BOGUS! Must specify type. */
676 len += strlen(" system=") + strlen(system);
677 len += strlen(" subsystem=") + strlen(subsystem);
678 len += strlen(" type=") + strlen(type);
679 /* add in the data message plus newline. */
682 len += 3; /* '!', '\n', and NUL */
683 msg = malloc(len, M_BUS, flags);
685 return; /* Drop it on the floor */
687 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
688 system, subsystem, type, data);
690 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
691 system, subsystem, type);
692 devctl_queue_data_f(msg, flags);
696 devctl_notify(const char *system, const char *subsystem, const char *type,
700 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
704 * Common routine that tries to make sending messages as easy as possible.
705 * We allocate memory for the data, copy strings into that, but do not
706 * free it unless there's an error. The dequeue part of the driver should
707 * free the data. We don't send data when the device is disabled. We do
708 * send data, even when we have no listeners, because we wish to avoid
709 * races relating to startup and restart of listening applications.
711 * devaddq is designed to string together the type of event, with the
712 * object of that event, plus the plug and play info and location info
713 * for that event. This is likely most useful for devices, but less
714 * useful for other consumers of this interface. Those should use
715 * the devctl_queue_data() interface instead.
718 devaddq(const char *type, const char *what, device_t dev)
725 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
727 data = malloc(1024, M_BUS, M_NOWAIT);
731 /* get the bus specific location of this device */
732 loc = malloc(1024, M_BUS, M_NOWAIT);
736 bus_child_location_str(dev, loc, 1024);
738 /* Get the bus specific pnp info of this device */
739 pnp = malloc(1024, M_BUS, M_NOWAIT);
743 bus_child_pnpinfo_str(dev, pnp, 1024);
745 /* Get the parent of this device, or / if high enough in the tree. */
746 if (device_get_parent(dev) == NULL)
747 parstr = "."; /* Or '/' ? */
749 parstr = device_get_nameunit(device_get_parent(dev));
750 /* String it all together. */
751 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
755 devctl_queue_data(data);
765 * A device was added to the tree. We are called just after it successfully
766 * attaches (that is, probe and attach success for this device). No call
767 * is made if a device is merely parented into the tree. See devnomatch
768 * if probe fails. If attach fails, no notification is sent (but maybe
769 * we should have a different message for this).
772 devadded(device_t dev)
774 devaddq("+", device_get_nameunit(dev), dev);
778 * A device was removed from the tree. We are called just before this
782 devremoved(device_t dev)
784 devaddq("-", device_get_nameunit(dev), dev);
788 * Called when there's no match for this device. This is only called
789 * the first time that no match happens, so we don't keep getting this
790 * message. Should that prove to be undesirable, we can change it.
791 * This is called when all drivers that can attach to a given bus
792 * decline to accept this device. Other errors may not be detected.
795 devnomatch(device_t dev)
797 devaddq("?", "", dev);
801 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
803 struct dev_event_info *n1;
806 dis = (devctl_queue_length == 0);
807 error = sysctl_handle_int(oidp, &dis, 0, req);
808 if (error || !req->newptr)
810 if (mtx_initialized(&devsoftc.mtx))
811 mtx_lock(&devsoftc.mtx);
813 while (!TAILQ_EMPTY(&devsoftc.devq)) {
814 n1 = TAILQ_FIRST(&devsoftc.devq);
815 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
816 free(n1->dei_data, M_BUS);
820 devctl_queue_length = 0;
822 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
824 if (mtx_initialized(&devsoftc.mtx))
825 mtx_unlock(&devsoftc.mtx);
830 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
832 struct dev_event_info *n1;
835 q = devctl_queue_length;
836 error = sysctl_handle_int(oidp, &q, 0, req);
837 if (error || !req->newptr)
841 if (mtx_initialized(&devsoftc.mtx))
842 mtx_lock(&devsoftc.mtx);
843 devctl_queue_length = q;
844 while (devsoftc.queued > devctl_queue_length) {
845 n1 = TAILQ_FIRST(&devsoftc.devq);
846 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
847 free(n1->dei_data, M_BUS);
851 if (mtx_initialized(&devsoftc.mtx))
852 mtx_unlock(&devsoftc.mtx);
857 * @brief safely quotes strings that might have double quotes in them.
859 * The devctl protocol relies on quoted strings having matching quotes.
860 * This routine quotes any internal quotes so the resulting string
861 * is safe to pass to snprintf to construct, for example pnp info strings.
862 * Strings are always terminated with a NUL, but may be truncated if longer
863 * than @p len bytes after quotes.
865 * @param sb sbuf to place the characters into
866 * @param src Original buffer.
869 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
872 while (*src != '\0') {
873 if (*src == '"' || *src == '\\')
875 sbuf_putc(sb, *src++);
879 /* End of /dev/devctl code */
881 static TAILQ_HEAD(,device) bus_data_devices;
882 static int bus_data_generation = 1;
884 static kobj_method_t null_methods[] = {
888 DEFINE_CLASS(null, null_methods, 0);
891 * Bus pass implementation
894 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
895 int bus_current_pass = BUS_PASS_ROOT;
899 * @brief Register the pass level of a new driver attachment
901 * Register a new driver attachment's pass level. If no driver
902 * attachment with the same pass level has been added, then @p new
903 * will be added to the global passes list.
905 * @param new the new driver attachment
908 driver_register_pass(struct driverlink *new)
910 struct driverlink *dl;
912 /* We only consider pass numbers during boot. */
913 if (bus_current_pass == BUS_PASS_DEFAULT)
917 * Walk the passes list. If we already know about this pass
918 * then there is nothing to do. If we don't, then insert this
919 * driver link into the list.
921 TAILQ_FOREACH(dl, &passes, passlink) {
922 if (dl->pass < new->pass)
924 if (dl->pass == new->pass)
926 TAILQ_INSERT_BEFORE(dl, new, passlink);
929 TAILQ_INSERT_TAIL(&passes, new, passlink);
933 * @brief Raise the current bus pass
935 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
936 * method on the root bus to kick off a new device tree scan for each
937 * new pass level that has at least one driver.
940 bus_set_pass(int pass)
942 struct driverlink *dl;
944 if (bus_current_pass > pass)
945 panic("Attempt to lower bus pass level");
947 TAILQ_FOREACH(dl, &passes, passlink) {
948 /* Skip pass values below the current pass level. */
949 if (dl->pass <= bus_current_pass)
953 * Bail once we hit a driver with a pass level that is
960 * Raise the pass level to the next level and rescan
963 bus_current_pass = dl->pass;
964 BUS_NEW_PASS(root_bus);
968 * If there isn't a driver registered for the requested pass,
969 * then bus_current_pass might still be less than 'pass'. Set
970 * it to 'pass' in that case.
972 if (bus_current_pass < pass)
973 bus_current_pass = pass;
974 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
978 * Devclass implementation
981 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
985 * @brief Find or create a device class
987 * If a device class with the name @p classname exists, return it,
988 * otherwise if @p create is non-zero create and return a new device
991 * If @p parentname is non-NULL, the parent of the devclass is set to
992 * the devclass of that name.
994 * @param classname the devclass name to find or create
995 * @param parentname the parent devclass name or @c NULL
996 * @param create non-zero to create a devclass
999 devclass_find_internal(const char *classname, const char *parentname,
1004 PDEBUG(("looking for %s", classname));
1008 TAILQ_FOREACH(dc, &devclasses, link) {
1009 if (!strcmp(dc->name, classname))
1013 if (create && !dc) {
1014 PDEBUG(("creating %s", classname));
1015 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1016 M_BUS, M_NOWAIT | M_ZERO);
1020 dc->name = (char*) (dc + 1);
1021 strcpy(dc->name, classname);
1022 TAILQ_INIT(&dc->drivers);
1023 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1025 bus_data_generation_update();
1029 * If a parent class is specified, then set that as our parent so
1030 * that this devclass will support drivers for the parent class as
1031 * well. If the parent class has the same name don't do this though
1032 * as it creates a cycle that can trigger an infinite loop in
1033 * device_probe_child() if a device exists for which there is no
1036 if (parentname && dc && !dc->parent &&
1037 strcmp(classname, parentname) != 0) {
1038 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1039 dc->parent->flags |= DC_HAS_CHILDREN;
1046 * @brief Create a device class
1048 * If a device class with the name @p classname exists, return it,
1049 * otherwise create and return a new device class.
1051 * @param classname the devclass name to find or create
1054 devclass_create(const char *classname)
1056 return (devclass_find_internal(classname, NULL, TRUE));
1060 * @brief Find a device class
1062 * If a device class with the name @p classname exists, return it,
1063 * otherwise return @c NULL.
1065 * @param classname the devclass name to find
1068 devclass_find(const char *classname)
1070 return (devclass_find_internal(classname, NULL, FALSE));
1074 * @brief Register that a device driver has been added to a devclass
1076 * Register that a device driver has been added to a devclass. This
1077 * is called by devclass_add_driver to accomplish the recursive
1078 * notification of all the children classes of dc, as well as dc.
1079 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1082 * We do a full search here of the devclass list at each iteration
1083 * level to save storing children-lists in the devclass structure. If
1084 * we ever move beyond a few dozen devices doing this, we may need to
1087 * @param dc the devclass to edit
1088 * @param driver the driver that was just added
1091 devclass_driver_added(devclass_t dc, driver_t *driver)
1097 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1099 for (i = 0; i < dc->maxunit; i++)
1100 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1101 BUS_DRIVER_ADDED(dc->devices[i], driver);
1104 * Walk through the children classes. Since we only keep a
1105 * single parent pointer around, we walk the entire list of
1106 * devclasses looking for children. We set the
1107 * DC_HAS_CHILDREN flag when a child devclass is created on
1108 * the parent, so we only walk the list for those devclasses
1109 * that have children.
1111 if (!(dc->flags & DC_HAS_CHILDREN))
1114 TAILQ_FOREACH(dc, &devclasses, link) {
1115 if (dc->parent == parent)
1116 devclass_driver_added(dc, driver);
1121 * @brief Add a device driver to a device class
1123 * Add a device driver to a devclass. This is normally called
1124 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1125 * all devices in the devclass will be called to allow them to attempt
1126 * to re-probe any unmatched children.
1128 * @param dc the devclass to edit
1129 * @param driver the driver to register
1132 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1135 const char *parentname;
1137 PDEBUG(("%s", DRIVERNAME(driver)));
1139 /* Don't allow invalid pass values. */
1140 if (pass <= BUS_PASS_ROOT)
1143 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1148 * Compile the driver's methods. Also increase the reference count
1149 * so that the class doesn't get freed when the last instance
1150 * goes. This means we can safely use static methods and avoids a
1151 * double-free in devclass_delete_driver.
1153 kobj_class_compile((kobj_class_t) driver);
1156 * If the driver has any base classes, make the
1157 * devclass inherit from the devclass of the driver's
1158 * first base class. This will allow the system to
1159 * search for drivers in both devclasses for children
1160 * of a device using this driver.
1162 if (driver->baseclasses)
1163 parentname = driver->baseclasses[0]->name;
1166 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1168 dl->driver = driver;
1169 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1170 driver->refs++; /* XXX: kobj_mtx */
1172 driver_register_pass(dl);
1174 if (device_frozen) {
1175 dl->flags |= DL_DEFERRED_PROBE;
1177 devclass_driver_added(dc, driver);
1179 bus_data_generation_update();
1184 * @brief Register that a device driver has been deleted from a devclass
1186 * Register that a device driver has been removed from a devclass.
1187 * This is called by devclass_delete_driver to accomplish the
1188 * recursive notification of all the children classes of busclass, as
1189 * well as busclass. Each layer will attempt to detach the driver
1190 * from any devices that are children of the bus's devclass. The function
1191 * will return an error if a device fails to detach.
1193 * We do a full search here of the devclass list at each iteration
1194 * level to save storing children-lists in the devclass structure. If
1195 * we ever move beyond a few dozen devices doing this, we may need to
1198 * @param busclass the devclass of the parent bus
1199 * @param dc the devclass of the driver being deleted
1200 * @param driver the driver being deleted
1203 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1210 * Disassociate from any devices. We iterate through all the
1211 * devices in the devclass of the driver and detach any which are
1212 * using the driver and which have a parent in the devclass which
1213 * we are deleting from.
1215 * Note that since a driver can be in multiple devclasses, we
1216 * should not detach devices which are not children of devices in
1217 * the affected devclass.
1219 * If we're frozen, we don't generate NOMATCH events. Mark to
1222 for (i = 0; i < dc->maxunit; i++) {
1223 if (dc->devices[i]) {
1224 dev = dc->devices[i];
1225 if (dev->driver == driver && dev->parent &&
1226 dev->parent->devclass == busclass) {
1227 if ((error = device_detach(dev)) != 0)
1229 if (device_frozen) {
1230 dev->flags &= ~DF_DONENOMATCH;
1231 dev->flags |= DF_NEEDNOMATCH;
1233 BUS_PROBE_NOMATCH(dev->parent, dev);
1235 dev->flags |= DF_DONENOMATCH;
1242 * Walk through the children classes. Since we only keep a
1243 * single parent pointer around, we walk the entire list of
1244 * devclasses looking for children. We set the
1245 * DC_HAS_CHILDREN flag when a child devclass is created on
1246 * the parent, so we only walk the list for those devclasses
1247 * that have children.
1249 if (!(busclass->flags & DC_HAS_CHILDREN))
1252 TAILQ_FOREACH(busclass, &devclasses, link) {
1253 if (busclass->parent == parent) {
1254 error = devclass_driver_deleted(busclass, dc, driver);
1263 * @brief Delete a device driver from a device class
1265 * Delete a device driver from a devclass. This is normally called
1266 * automatically by DRIVER_MODULE().
1268 * If the driver is currently attached to any devices,
1269 * devclass_delete_driver() will first attempt to detach from each
1270 * device. If one of the detach calls fails, the driver will not be
1273 * @param dc the devclass to edit
1274 * @param driver the driver to unregister
1277 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1279 devclass_t dc = devclass_find(driver->name);
1283 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1289 * Find the link structure in the bus' list of drivers.
1291 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1292 if (dl->driver == driver)
1297 PDEBUG(("%s not found in %s list", driver->name,
1302 error = devclass_driver_deleted(busclass, dc, driver);
1306 TAILQ_REMOVE(&busclass->drivers, dl, link);
1311 if (driver->refs == 0)
1312 kobj_class_free((kobj_class_t) driver);
1314 bus_data_generation_update();
1319 * @brief Quiesces a set of device drivers from a device class
1321 * Quiesce a device driver from a devclass. This is normally called
1322 * automatically by DRIVER_MODULE().
1324 * If the driver is currently attached to any devices,
1325 * devclass_quiesece_driver() will first attempt to quiesce each
1328 * @param dc the devclass to edit
1329 * @param driver the driver to unregister
1332 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1334 devclass_t dc = devclass_find(driver->name);
1340 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1346 * Find the link structure in the bus' list of drivers.
1348 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1349 if (dl->driver == driver)
1354 PDEBUG(("%s not found in %s list", driver->name,
1360 * Quiesce all devices. We iterate through all the devices in
1361 * the devclass of the driver and quiesce any which are using
1362 * the driver and which have a parent in the devclass which we
1365 * Note that since a driver can be in multiple devclasses, we
1366 * should not quiesce devices which are not children of
1367 * devices in the affected devclass.
1369 for (i = 0; i < dc->maxunit; i++) {
1370 if (dc->devices[i]) {
1371 dev = dc->devices[i];
1372 if (dev->driver == driver && dev->parent &&
1373 dev->parent->devclass == busclass) {
1374 if ((error = device_quiesce(dev)) != 0)
1387 devclass_find_driver_internal(devclass_t dc, const char *classname)
1391 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1393 TAILQ_FOREACH(dl, &dc->drivers, link) {
1394 if (!strcmp(dl->driver->name, classname))
1398 PDEBUG(("not found"));
1403 * @brief Return the name of the devclass
1406 devclass_get_name(devclass_t dc)
1412 * @brief Find a device given a unit number
1414 * @param dc the devclass to search
1415 * @param unit the unit number to search for
1417 * @returns the device with the given unit number or @c
1418 * NULL if there is no such device
1421 devclass_get_device(devclass_t dc, int unit)
1423 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1425 return (dc->devices[unit]);
1429 * @brief Find the softc field of a device given a unit number
1431 * @param dc the devclass to search
1432 * @param unit the unit number to search for
1434 * @returns the softc field of the device with the given
1435 * unit number or @c NULL if there is no such
1439 devclass_get_softc(devclass_t dc, int unit)
1443 dev = devclass_get_device(dc, unit);
1447 return (device_get_softc(dev));
1451 * @brief Get a list of devices in the devclass
1453 * An array containing a list of all the devices in the given devclass
1454 * is allocated and returned in @p *devlistp. The number of devices
1455 * in the array is returned in @p *devcountp. The caller should free
1456 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1458 * @param dc the devclass to examine
1459 * @param devlistp points at location for array pointer return
1461 * @param devcountp points at location for array size return value
1464 * @retval ENOMEM the array allocation failed
1467 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1472 count = devclass_get_count(dc);
1473 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1478 for (i = 0; i < dc->maxunit; i++) {
1479 if (dc->devices[i]) {
1480 list[count] = dc->devices[i];
1492 * @brief Get a list of drivers in the devclass
1494 * An array containing a list of pointers to all the drivers in the
1495 * given devclass is allocated and returned in @p *listp. The number
1496 * of drivers in the array is returned in @p *countp. The caller should
1497 * free the array using @c free(p, M_TEMP).
1499 * @param dc the devclass to examine
1500 * @param listp gives location for array pointer return value
1501 * @param countp gives location for number of array elements
1505 * @retval ENOMEM the array allocation failed
1508 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1515 TAILQ_FOREACH(dl, &dc->drivers, link)
1517 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1522 TAILQ_FOREACH(dl, &dc->drivers, link) {
1523 list[count] = dl->driver;
1533 * @brief Get the number of devices in a devclass
1535 * @param dc the devclass to examine
1538 devclass_get_count(devclass_t dc)
1543 for (i = 0; i < dc->maxunit; i++)
1550 * @brief Get the maximum unit number used in a devclass
1552 * Note that this is one greater than the highest currently-allocated
1553 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1554 * that not even the devclass has been allocated yet.
1556 * @param dc the devclass to examine
1559 devclass_get_maxunit(devclass_t dc)
1563 return (dc->maxunit);
1567 * @brief Find a free unit number in a devclass
1569 * This function searches for the first unused unit number greater
1570 * that or equal to @p unit.
1572 * @param dc the devclass to examine
1573 * @param unit the first unit number to check
1576 devclass_find_free_unit(devclass_t dc, int unit)
1580 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1586 * @brief Set the parent of a devclass
1588 * The parent class is normally initialised automatically by
1591 * @param dc the devclass to edit
1592 * @param pdc the new parent devclass
1595 devclass_set_parent(devclass_t dc, devclass_t pdc)
1601 * @brief Get the parent of a devclass
1603 * @param dc the devclass to examine
1606 devclass_get_parent(devclass_t dc)
1608 return (dc->parent);
1611 struct sysctl_ctx_list *
1612 devclass_get_sysctl_ctx(devclass_t dc)
1614 return (&dc->sysctl_ctx);
1618 devclass_get_sysctl_tree(devclass_t dc)
1620 return (dc->sysctl_tree);
1625 * @brief Allocate a unit number
1627 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1628 * will do). The allocated unit number is returned in @p *unitp.
1630 * @param dc the devclass to allocate from
1631 * @param unitp points at the location for the allocated unit
1635 * @retval EEXIST the requested unit number is already allocated
1636 * @retval ENOMEM memory allocation failure
1639 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1644 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1646 /* Ask the parent bus if it wants to wire this device. */
1648 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1651 /* If we were given a wired unit number, check for existing device */
1654 if (unit >= 0 && unit < dc->maxunit &&
1655 dc->devices[unit] != NULL) {
1657 printf("%s: %s%d already exists; skipping it\n",
1658 dc->name, dc->name, *unitp);
1662 /* Unwired device, find the next available slot for it */
1664 for (unit = 0;; unit++) {
1665 /* If there is an "at" hint for a unit then skip it. */
1666 if (resource_string_value(dc->name, unit, "at", &s) ==
1670 /* If this device slot is already in use, skip it. */
1671 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1679 * We've selected a unit beyond the length of the table, so let's
1680 * extend the table to make room for all units up to and including
1683 if (unit >= dc->maxunit) {
1684 device_t *newlist, *oldlist;
1687 oldlist = dc->devices;
1688 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1689 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1692 if (oldlist != NULL)
1693 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1694 bzero(newlist + dc->maxunit,
1695 sizeof(device_t) * (newsize - dc->maxunit));
1696 dc->devices = newlist;
1697 dc->maxunit = newsize;
1698 if (oldlist != NULL)
1699 free(oldlist, M_BUS);
1701 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1709 * @brief Add a device to a devclass
1711 * A unit number is allocated for the device (using the device's
1712 * preferred unit number if any) and the device is registered in the
1713 * devclass. This allows the device to be looked up by its unit
1714 * number, e.g. by decoding a dev_t minor number.
1716 * @param dc the devclass to add to
1717 * @param dev the device to add
1720 * @retval EEXIST the requested unit number is already allocated
1721 * @retval ENOMEM memory allocation failure
1724 devclass_add_device(devclass_t dc, device_t dev)
1728 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1730 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1733 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1737 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1738 free(dev->nameunit, M_BUS);
1739 dev->nameunit = NULL;
1742 dc->devices[dev->unit] = dev;
1744 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1751 * @brief Delete a device from a devclass
1753 * The device is removed from the devclass's device list and its unit
1756 * @param dc the devclass to delete from
1757 * @param dev the device to delete
1762 devclass_delete_device(devclass_t dc, device_t dev)
1767 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1769 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1770 panic("devclass_delete_device: inconsistent device class");
1771 dc->devices[dev->unit] = NULL;
1772 if (dev->flags & DF_WILDCARD)
1774 dev->devclass = NULL;
1775 free(dev->nameunit, M_BUS);
1776 dev->nameunit = NULL;
1783 * @brief Make a new device and add it as a child of @p parent
1785 * @param parent the parent of the new device
1786 * @param name the devclass name of the new device or @c NULL
1787 * to leave the devclass unspecified
1788 * @parem unit the unit number of the new device of @c -1 to
1789 * leave the unit number unspecified
1791 * @returns the new device
1794 make_device(device_t parent, const char *name, int unit)
1799 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1802 dc = devclass_find_internal(name, NULL, TRUE);
1804 printf("make_device: can't find device class %s\n",
1812 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1816 dev->parent = parent;
1817 TAILQ_INIT(&dev->children);
1818 kobj_init((kobj_t) dev, &null_class);
1820 dev->devclass = NULL;
1822 dev->nameunit = NULL;
1826 dev->flags = DF_ENABLED;
1829 dev->flags |= DF_WILDCARD;
1831 dev->flags |= DF_FIXEDCLASS;
1832 if (devclass_add_device(dc, dev)) {
1833 kobj_delete((kobj_t) dev, M_BUS);
1837 if (parent != NULL && device_has_quiet_children(parent))
1838 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1842 dev->state = DS_NOTPRESENT;
1844 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1845 bus_data_generation_update();
1852 * @brief Print a description of a device.
1855 device_print_child(device_t dev, device_t child)
1859 if (device_is_alive(child))
1860 retval += BUS_PRINT_CHILD(dev, child);
1862 retval += device_printf(child, " not found\n");
1868 * @brief Create a new device
1870 * This creates a new device and adds it as a child of an existing
1871 * parent device. The new device will be added after the last existing
1872 * child with order zero.
1874 * @param dev the device which will be the parent of the
1876 * @param name devclass name for new device or @c NULL if not
1878 * @param unit unit number for new device or @c -1 if not
1881 * @returns the new device
1884 device_add_child(device_t dev, const char *name, int unit)
1886 return (device_add_child_ordered(dev, 0, name, unit));
1890 * @brief Create a new device
1892 * This creates a new device and adds it as a child of an existing
1893 * parent device. The new device will be added after the last existing
1894 * child with the same order.
1896 * @param dev the device which will be the parent of the
1898 * @param order a value which is used to partially sort the
1899 * children of @p dev - devices created using
1900 * lower values of @p order appear first in @p
1901 * dev's list of children
1902 * @param name devclass name for new device or @c NULL if not
1904 * @param unit unit number for new device or @c -1 if not
1907 * @returns the new device
1910 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1915 PDEBUG(("%s at %s with order %u as unit %d",
1916 name, DEVICENAME(dev), order, unit));
1917 KASSERT(name != NULL || unit == -1,
1918 ("child device with wildcard name and specific unit number"));
1920 child = make_device(dev, name, unit);
1923 child->order = order;
1925 TAILQ_FOREACH(place, &dev->children, link) {
1926 if (place->order > order)
1932 * The device 'place' is the first device whose order is
1933 * greater than the new child.
1935 TAILQ_INSERT_BEFORE(place, child, link);
1938 * The new child's order is greater or equal to the order of
1939 * any existing device. Add the child to the tail of the list.
1941 TAILQ_INSERT_TAIL(&dev->children, child, link);
1944 bus_data_generation_update();
1949 * @brief Delete a device
1951 * This function deletes a device along with all of its children. If
1952 * the device currently has a driver attached to it, the device is
1953 * detached first using device_detach().
1955 * @param dev the parent device
1956 * @param child the device to delete
1959 * @retval non-zero a unit error code describing the error
1962 device_delete_child(device_t dev, device_t child)
1965 device_t grandchild;
1967 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1969 /* detach parent before deleting children, if any */
1970 if ((error = device_detach(child)) != 0)
1973 /* remove children second */
1974 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1975 error = device_delete_child(child, grandchild);
1980 if (child->devclass)
1981 devclass_delete_device(child->devclass, child);
1983 BUS_CHILD_DELETED(dev, child);
1984 TAILQ_REMOVE(&dev->children, child, link);
1985 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1986 kobj_delete((kobj_t) child, M_BUS);
1988 bus_data_generation_update();
1993 * @brief Delete all children devices of the given device, if any.
1995 * This function deletes all children devices of the given device, if
1996 * any, using the device_delete_child() function for each device it
1997 * finds. If a child device cannot be deleted, this function will
1998 * return an error code.
2000 * @param dev the parent device
2003 * @retval non-zero a device would not detach
2006 device_delete_children(device_t dev)
2011 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2015 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2016 error = device_delete_child(dev, child);
2018 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2026 * @brief Find a device given a unit number
2028 * This is similar to devclass_get_devices() but only searches for
2029 * devices which have @p dev as a parent.
2031 * @param dev the parent device to search
2032 * @param unit the unit number to search for. If the unit is -1,
2033 * return the first child of @p dev which has name
2034 * @p classname (that is, the one with the lowest unit.)
2036 * @returns the device with the given unit number or @c
2037 * NULL if there is no such device
2040 device_find_child(device_t dev, const char *classname, int unit)
2045 dc = devclass_find(classname);
2050 child = devclass_get_device(dc, unit);
2051 if (child && child->parent == dev)
2054 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2055 child = devclass_get_device(dc, unit);
2056 if (child && child->parent == dev)
2067 first_matching_driver(devclass_t dc, device_t dev)
2070 return (devclass_find_driver_internal(dc, dev->devclass->name));
2071 return (TAILQ_FIRST(&dc->drivers));
2078 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2080 if (dev->devclass) {
2082 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2083 if (!strcmp(dev->devclass->name, dl->driver->name))
2087 return (TAILQ_NEXT(last, link));
2094 device_probe_child(device_t dev, device_t child)
2097 driverlink_t best = NULL;
2099 int result, pri = 0;
2100 int hasclass = (child->devclass != NULL);
2106 panic("device_probe_child: parent device has no devclass");
2109 * If the state is already probed, then return. However, don't
2110 * return if we can rebid this object.
2112 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2115 for (; dc; dc = dc->parent) {
2116 for (dl = first_matching_driver(dc, child);
2118 dl = next_matching_driver(dc, child, dl)) {
2119 /* If this driver's pass is too high, then ignore it. */
2120 if (dl->pass > bus_current_pass)
2123 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2124 result = device_set_driver(child, dl->driver);
2125 if (result == ENOMEM)
2127 else if (result != 0)
2130 if (device_set_devclass(child,
2131 dl->driver->name) != 0) {
2132 char const * devname =
2133 device_get_name(child);
2134 if (devname == NULL)
2135 devname = "(unknown)";
2136 printf("driver bug: Unable to set "
2137 "devclass (class: %s "
2141 (void)device_set_driver(child, NULL);
2146 /* Fetch any flags for the device before probing. */
2147 resource_int_value(dl->driver->name, child->unit,
2148 "flags", &child->devflags);
2150 result = DEVICE_PROBE(child);
2152 /* Reset flags and devclass before the next probe. */
2153 child->devflags = 0;
2155 (void)device_set_devclass(child, NULL);
2158 * If the driver returns SUCCESS, there can be
2159 * no higher match for this device.
2168 * Reset DF_QUIET in case this driver doesn't
2169 * end up as the best driver.
2171 device_verbose(child);
2174 * Probes that return BUS_PROBE_NOWILDCARD or lower
2175 * only match on devices whose driver was explicitly
2178 if (result <= BUS_PROBE_NOWILDCARD &&
2179 !(child->flags & DF_FIXEDCLASS)) {
2184 * The driver returned an error so it
2185 * certainly doesn't match.
2188 (void)device_set_driver(child, NULL);
2193 * A priority lower than SUCCESS, remember the
2194 * best matching driver. Initialise the value
2195 * of pri for the first match.
2197 if (best == NULL || result > pri) {
2204 * If we have an unambiguous match in this devclass,
2205 * don't look in the parent.
2207 if (best && pri == 0)
2212 * If we found a driver, change state and initialise the devclass.
2214 /* XXX What happens if we rebid and got no best? */
2217 * If this device was attached, and we were asked to
2218 * rescan, and it is a different driver, then we have
2219 * to detach the old driver and reattach this new one.
2220 * Note, we don't have to check for DF_REBID here
2221 * because if the state is > DS_ALIVE, we know it must
2224 * This assumes that all DF_REBID drivers can have
2225 * their probe routine called at any time and that
2226 * they are idempotent as well as completely benign in
2227 * normal operations.
2229 * We also have to make sure that the detach
2230 * succeeded, otherwise we fail the operation (or
2231 * maybe it should just fail silently? I'm torn).
2233 if (child->state > DS_ALIVE && best->driver != child->driver)
2234 if ((result = device_detach(dev)) != 0)
2237 /* Set the winning driver, devclass, and flags. */
2238 if (!child->devclass) {
2239 result = device_set_devclass(child, best->driver->name);
2243 result = device_set_driver(child, best->driver);
2246 resource_int_value(best->driver->name, child->unit,
2247 "flags", &child->devflags);
2251 * A bit bogus. Call the probe method again to make
2252 * sure that we have the right description.
2254 DEVICE_PROBE(child);
2256 child->flags |= DF_REBID;
2259 child->flags &= ~DF_REBID;
2260 child->state = DS_ALIVE;
2262 bus_data_generation_update();
2270 * @brief Return the parent of a device
2273 device_get_parent(device_t dev)
2275 return (dev->parent);
2279 * @brief Get a list of children of a device
2281 * An array containing a list of all the children of the given device
2282 * is allocated and returned in @p *devlistp. The number of devices
2283 * in the array is returned in @p *devcountp. The caller should free
2284 * the array using @c free(p, M_TEMP).
2286 * @param dev the device to examine
2287 * @param devlistp points at location for array pointer return
2289 * @param devcountp points at location for array size return value
2292 * @retval ENOMEM the array allocation failed
2295 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2302 TAILQ_FOREACH(child, &dev->children, link) {
2311 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2316 TAILQ_FOREACH(child, &dev->children, link) {
2317 list[count] = child;
2328 * @brief Return the current driver for the device or @c NULL if there
2329 * is no driver currently attached
2332 device_get_driver(device_t dev)
2334 return (dev->driver);
2338 * @brief Return the current devclass for the device or @c NULL if
2342 device_get_devclass(device_t dev)
2344 return (dev->devclass);
2348 * @brief Return the name of the device's devclass or @c NULL if there
2352 device_get_name(device_t dev)
2354 if (dev != NULL && dev->devclass)
2355 return (devclass_get_name(dev->devclass));
2360 * @brief Return a string containing the device's devclass name
2361 * followed by an ascii representation of the device's unit number
2365 device_get_nameunit(device_t dev)
2367 return (dev->nameunit);
2371 * @brief Return the device's unit number.
2374 device_get_unit(device_t dev)
2380 * @brief Return the device's description string
2383 device_get_desc(device_t dev)
2389 * @brief Return the device's flags
2392 device_get_flags(device_t dev)
2394 return (dev->devflags);
2397 struct sysctl_ctx_list *
2398 device_get_sysctl_ctx(device_t dev)
2400 return (&dev->sysctl_ctx);
2404 device_get_sysctl_tree(device_t dev)
2406 return (dev->sysctl_tree);
2410 * @brief Print the name of the device followed by a colon and a space
2412 * @returns the number of characters printed
2415 device_print_prettyname(device_t dev)
2417 const char *name = device_get_name(dev);
2420 return (printf("unknown: "));
2421 return (printf("%s%d: ", name, device_get_unit(dev)));
2425 * @brief Print the name of the device followed by a colon, a space
2426 * and the result of calling vprintf() with the value of @p fmt and
2427 * the following arguments.
2429 * @returns the number of characters printed
2432 device_printf(device_t dev, const char * fmt, ...)
2437 retval = device_print_prettyname(dev);
2439 retval += vprintf(fmt, ap);
2448 device_set_desc_internal(device_t dev, const char* desc, int copy)
2450 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2451 free(dev->desc, M_BUS);
2452 dev->flags &= ~DF_DESCMALLOCED;
2457 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2459 strcpy(dev->desc, desc);
2460 dev->flags |= DF_DESCMALLOCED;
2463 /* Avoid a -Wcast-qual warning */
2464 dev->desc = (char *)(uintptr_t) desc;
2467 bus_data_generation_update();
2471 * @brief Set the device's description
2473 * The value of @c desc should be a string constant that will not
2474 * change (at least until the description is changed in a subsequent
2475 * call to device_set_desc() or device_set_desc_copy()).
2478 device_set_desc(device_t dev, const char* desc)
2480 device_set_desc_internal(dev, desc, FALSE);
2484 * @brief Set the device's description
2486 * The string pointed to by @c desc is copied. Use this function if
2487 * the device description is generated, (e.g. with sprintf()).
2490 device_set_desc_copy(device_t dev, const char* desc)
2492 device_set_desc_internal(dev, desc, TRUE);
2496 * @brief Set the device's flags
2499 device_set_flags(device_t dev, uint32_t flags)
2501 dev->devflags = flags;
2505 * @brief Return the device's softc field
2507 * The softc is allocated and zeroed when a driver is attached, based
2508 * on the size field of the driver.
2511 device_get_softc(device_t dev)
2513 return (dev->softc);
2517 * @brief Set the device's softc field
2519 * Most drivers do not need to use this since the softc is allocated
2520 * automatically when the driver is attached.
2523 device_set_softc(device_t dev, void *softc)
2525 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2526 free(dev->softc, M_BUS_SC);
2529 dev->flags |= DF_EXTERNALSOFTC;
2531 dev->flags &= ~DF_EXTERNALSOFTC;
2535 * @brief Free claimed softc
2537 * Most drivers do not need to use this since the softc is freed
2538 * automatically when the driver is detached.
2541 device_free_softc(void *softc)
2543 free(softc, M_BUS_SC);
2547 * @brief Claim softc
2549 * This function can be used to let the driver free the automatically
2550 * allocated softc using "device_free_softc()". This function is
2551 * useful when the driver is refcounting the softc and the softc
2552 * cannot be freed when the "device_detach" method is called.
2555 device_claim_softc(device_t dev)
2558 dev->flags |= DF_EXTERNALSOFTC;
2560 dev->flags &= ~DF_EXTERNALSOFTC;
2564 * @brief Get the device's ivars field
2566 * The ivars field is used by the parent device to store per-device
2567 * state (e.g. the physical location of the device or a list of
2571 device_get_ivars(device_t dev)
2574 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2575 return (dev->ivars);
2579 * @brief Set the device's ivars field
2582 device_set_ivars(device_t dev, void * ivars)
2585 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2590 * @brief Return the device's state
2593 device_get_state(device_t dev)
2595 return (dev->state);
2599 * @brief Set the DF_ENABLED flag for the device
2602 device_enable(device_t dev)
2604 dev->flags |= DF_ENABLED;
2608 * @brief Clear the DF_ENABLED flag for the device
2611 device_disable(device_t dev)
2613 dev->flags &= ~DF_ENABLED;
2617 * @brief Increment the busy counter for the device
2620 device_busy(device_t dev)
2622 if (dev->state < DS_ATTACHING)
2623 panic("device_busy: called for unattached device");
2624 if (dev->busy == 0 && dev->parent)
2625 device_busy(dev->parent);
2627 if (dev->state == DS_ATTACHED)
2628 dev->state = DS_BUSY;
2632 * @brief Decrement the busy counter for the device
2635 device_unbusy(device_t dev)
2637 if (dev->busy != 0 && dev->state != DS_BUSY &&
2638 dev->state != DS_ATTACHING)
2639 panic("device_unbusy: called for non-busy device %s",
2640 device_get_nameunit(dev));
2642 if (dev->busy == 0) {
2644 device_unbusy(dev->parent);
2645 if (dev->state == DS_BUSY)
2646 dev->state = DS_ATTACHED;
2651 * @brief Set the DF_QUIET flag for the device
2654 device_quiet(device_t dev)
2656 dev->flags |= DF_QUIET;
2660 * @brief Set the DF_QUIET_CHILDREN flag for the device
2663 device_quiet_children(device_t dev)
2665 dev->flags |= DF_QUIET_CHILDREN;
2669 * @brief Clear the DF_QUIET flag for the device
2672 device_verbose(device_t dev)
2674 dev->flags &= ~DF_QUIET;
2678 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2681 device_has_quiet_children(device_t dev)
2683 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2687 * @brief Return non-zero if the DF_QUIET flag is set on the device
2690 device_is_quiet(device_t dev)
2692 return ((dev->flags & DF_QUIET) != 0);
2696 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2699 device_is_enabled(device_t dev)
2701 return ((dev->flags & DF_ENABLED) != 0);
2705 * @brief Return non-zero if the device was successfully probed
2708 device_is_alive(device_t dev)
2710 return (dev->state >= DS_ALIVE);
2714 * @brief Return non-zero if the device currently has a driver
2718 device_is_attached(device_t dev)
2720 return (dev->state >= DS_ATTACHED);
2724 * @brief Return non-zero if the device is currently suspended.
2727 device_is_suspended(device_t dev)
2729 return ((dev->flags & DF_SUSPENDED) != 0);
2733 * @brief Set the devclass of a device
2734 * @see devclass_add_device().
2737 device_set_devclass(device_t dev, const char *classname)
2744 devclass_delete_device(dev->devclass, dev);
2748 if (dev->devclass) {
2749 printf("device_set_devclass: device class already set\n");
2753 dc = devclass_find_internal(classname, NULL, TRUE);
2757 error = devclass_add_device(dc, dev);
2759 bus_data_generation_update();
2764 * @brief Set the devclass of a device and mark the devclass fixed.
2765 * @see device_set_devclass()
2768 device_set_devclass_fixed(device_t dev, const char *classname)
2772 if (classname == NULL)
2775 error = device_set_devclass(dev, classname);
2778 dev->flags |= DF_FIXEDCLASS;
2783 * @brief Set the driver of a device
2786 * @retval EBUSY the device already has a driver attached
2787 * @retval ENOMEM a memory allocation failure occurred
2790 device_set_driver(device_t dev, driver_t *driver)
2792 if (dev->state >= DS_ATTACHED)
2795 if (dev->driver == driver)
2798 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2799 free(dev->softc, M_BUS_SC);
2802 device_set_desc(dev, NULL);
2803 kobj_delete((kobj_t) dev, NULL);
2804 dev->driver = driver;
2806 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2807 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2808 dev->softc = malloc(driver->size, M_BUS_SC,
2811 kobj_delete((kobj_t) dev, NULL);
2812 kobj_init((kobj_t) dev, &null_class);
2818 kobj_init((kobj_t) dev, &null_class);
2821 bus_data_generation_update();
2826 * @brief Probe a device, and return this status.
2828 * This function is the core of the device autoconfiguration
2829 * system. Its purpose is to select a suitable driver for a device and
2830 * then call that driver to initialise the hardware appropriately. The
2831 * driver is selected by calling the DEVICE_PROBE() method of a set of
2832 * candidate drivers and then choosing the driver which returned the
2833 * best value. This driver is then attached to the device using
2836 * The set of suitable drivers is taken from the list of drivers in
2837 * the parent device's devclass. If the device was originally created
2838 * with a specific class name (see device_add_child()), only drivers
2839 * with that name are probed, otherwise all drivers in the devclass
2840 * are probed. If no drivers return successful probe values in the
2841 * parent devclass, the search continues in the parent of that
2842 * devclass (see devclass_get_parent()) if any.
2844 * @param dev the device to initialise
2847 * @retval ENXIO no driver was found
2848 * @retval ENOMEM memory allocation failure
2849 * @retval non-zero some other unix error code
2850 * @retval -1 Device already attached
2853 device_probe(device_t dev)
2859 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2862 if (!(dev->flags & DF_ENABLED)) {
2863 if (bootverbose && device_get_name(dev) != NULL) {
2864 device_print_prettyname(dev);
2865 printf("not probed (disabled)\n");
2869 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2870 if (bus_current_pass == BUS_PASS_DEFAULT &&
2871 !(dev->flags & DF_DONENOMATCH)) {
2872 BUS_PROBE_NOMATCH(dev->parent, dev);
2874 dev->flags |= DF_DONENOMATCH;
2882 * @brief Probe a device and attach a driver if possible
2884 * calls device_probe() and attaches if that was successful.
2887 device_probe_and_attach(device_t dev)
2893 error = device_probe(dev);
2896 else if (error != 0)
2899 CURVNET_SET_QUIET(vnet0);
2900 error = device_attach(dev);
2906 * @brief Attach a device driver to a device
2908 * This function is a wrapper around the DEVICE_ATTACH() driver
2909 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2910 * device's sysctl tree, optionally prints a description of the device
2911 * and queues a notification event for user-based device management
2914 * Normally this function is only called internally from
2915 * device_probe_and_attach().
2917 * @param dev the device to initialise
2920 * @retval ENXIO no driver was found
2921 * @retval ENOMEM memory allocation failure
2922 * @retval non-zero some other unix error code
2925 device_attach(device_t dev)
2927 uint64_t attachtime;
2928 uint16_t attachentropy;
2931 if (resource_disabled(dev->driver->name, dev->unit)) {
2932 device_disable(dev);
2934 device_printf(dev, "disabled via hints entry\n");
2938 device_sysctl_init(dev);
2939 if (!device_is_quiet(dev))
2940 device_print_child(dev->parent, dev);
2941 attachtime = get_cyclecount();
2942 dev->state = DS_ATTACHING;
2943 if ((error = DEVICE_ATTACH(dev)) != 0) {
2944 printf("device_attach: %s%d attach returned %d\n",
2945 dev->driver->name, dev->unit, error);
2946 if (!(dev->flags & DF_FIXEDCLASS))
2947 devclass_delete_device(dev->devclass, dev);
2948 (void)device_set_driver(dev, NULL);
2949 device_sysctl_fini(dev);
2950 KASSERT(dev->busy == 0, ("attach failed but busy"));
2951 dev->state = DS_NOTPRESENT;
2954 dev->flags |= DF_ATTACHED_ONCE;
2955 /* We only need the low bits of this time, but ranges from tens to thousands
2956 * have been seen, so keep 2 bytes' worth.
2958 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2959 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2960 device_sysctl_update(dev);
2962 dev->state = DS_BUSY;
2964 dev->state = DS_ATTACHED;
2965 dev->flags &= ~DF_DONENOMATCH;
2966 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2972 * @brief Detach a driver from a device
2974 * This function is a wrapper around the DEVICE_DETACH() driver
2975 * method. If the call to DEVICE_DETACH() succeeds, it calls
2976 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2977 * notification event for user-based device management services and
2978 * cleans up the device's sysctl tree.
2980 * @param dev the device to un-initialise
2983 * @retval ENXIO no driver was found
2984 * @retval ENOMEM memory allocation failure
2985 * @retval non-zero some other unix error code
2988 device_detach(device_t dev)
2994 PDEBUG(("%s", DEVICENAME(dev)));
2995 if (dev->state == DS_BUSY)
2997 if (dev->state == DS_ATTACHING) {
2998 device_printf(dev, "device in attaching state! Deferring detach.\n");
3001 if (dev->state != DS_ATTACHED)
3004 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3005 if ((error = DEVICE_DETACH(dev)) != 0) {
3006 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3007 EVHDEV_DETACH_FAILED);
3010 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3011 EVHDEV_DETACH_COMPLETE);
3014 if (!device_is_quiet(dev))
3015 device_printf(dev, "detached\n");
3017 BUS_CHILD_DETACHED(dev->parent, dev);
3019 if (!(dev->flags & DF_FIXEDCLASS))
3020 devclass_delete_device(dev->devclass, dev);
3022 device_verbose(dev);
3023 dev->state = DS_NOTPRESENT;
3024 (void)device_set_driver(dev, NULL);
3025 device_sysctl_fini(dev);
3031 * @brief Tells a driver to quiesce itself.
3033 * This function is a wrapper around the DEVICE_QUIESCE() driver
3034 * method. If the call to DEVICE_QUIESCE() succeeds.
3036 * @param dev the device to quiesce
3039 * @retval ENXIO no driver was found
3040 * @retval ENOMEM memory allocation failure
3041 * @retval non-zero some other unix error code
3044 device_quiesce(device_t dev)
3047 PDEBUG(("%s", DEVICENAME(dev)));
3048 if (dev->state == DS_BUSY)
3050 if (dev->state != DS_ATTACHED)
3053 return (DEVICE_QUIESCE(dev));
3057 * @brief Notify a device of system shutdown
3059 * This function calls the DEVICE_SHUTDOWN() driver method if the
3060 * device currently has an attached driver.
3062 * @returns the value returned by DEVICE_SHUTDOWN()
3065 device_shutdown(device_t dev)
3067 if (dev->state < DS_ATTACHED)
3069 return (DEVICE_SHUTDOWN(dev));
3073 * @brief Set the unit number of a device
3075 * This function can be used to override the unit number used for a
3076 * device (e.g. to wire a device to a pre-configured unit number).
3079 device_set_unit(device_t dev, int unit)
3084 dc = device_get_devclass(dev);
3085 if (unit < dc->maxunit && dc->devices[unit])
3087 err = devclass_delete_device(dc, dev);
3091 err = devclass_add_device(dc, dev);
3095 bus_data_generation_update();
3099 /*======================================*/
3101 * Some useful method implementations to make life easier for bus drivers.
3105 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3110 args->memattr = VM_MEMATTR_UNCACHEABLE;
3114 * @brief Initialise a resource list.
3116 * @param rl the resource list to initialise
3119 resource_list_init(struct resource_list *rl)
3125 * @brief Reclaim memory used by a resource list.
3127 * This function frees the memory for all resource entries on the list
3130 * @param rl the resource list to free
3133 resource_list_free(struct resource_list *rl)
3135 struct resource_list_entry *rle;
3137 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3139 panic("resource_list_free: resource entry is busy");
3140 STAILQ_REMOVE_HEAD(rl, link);
3146 * @brief Add a resource entry.
3148 * This function adds a resource entry using the given @p type, @p
3149 * start, @p end and @p count values. A rid value is chosen by
3150 * searching sequentially for the first unused rid starting at zero.
3152 * @param rl the resource list to edit
3153 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3154 * @param start the start address of the resource
3155 * @param end the end address of the resource
3156 * @param count XXX end-start+1
3159 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3160 rman_res_t end, rman_res_t count)
3165 while (resource_list_find(rl, type, rid) != NULL)
3167 resource_list_add(rl, type, rid, start, end, count);
3172 * @brief Add or modify a resource entry.
3174 * If an existing entry exists with the same type and rid, it will be
3175 * modified using the given values of @p start, @p end and @p
3176 * count. If no entry exists, a new one will be created using the
3177 * given values. The resource list entry that matches is then returned.
3179 * @param rl the resource list to edit
3180 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3181 * @param rid the resource identifier
3182 * @param start the start address of the resource
3183 * @param end the end address of the resource
3184 * @param count XXX end-start+1
3186 struct resource_list_entry *
3187 resource_list_add(struct resource_list *rl, int type, int rid,
3188 rman_res_t start, rman_res_t end, rman_res_t count)
3190 struct resource_list_entry *rle;
3192 rle = resource_list_find(rl, type, rid);
3194 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3197 panic("resource_list_add: can't record entry");
3198 STAILQ_INSERT_TAIL(rl, rle, link);
3206 panic("resource_list_add: resource entry is busy");
3215 * @brief Determine if a resource entry is busy.
3217 * Returns true if a resource entry is busy meaning that it has an
3218 * associated resource that is not an unallocated "reserved" resource.
3220 * @param rl the resource list to search
3221 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3222 * @param rid the resource identifier
3224 * @returns Non-zero if the entry is busy, zero otherwise.
3227 resource_list_busy(struct resource_list *rl, int type, int rid)
3229 struct resource_list_entry *rle;
3231 rle = resource_list_find(rl, type, rid);
3232 if (rle == NULL || rle->res == NULL)
3234 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3235 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3236 ("reserved resource is active"));
3243 * @brief Determine if a resource entry is reserved.
3245 * Returns true if a resource entry is reserved meaning that it has an
3246 * associated "reserved" resource. The resource can either be
3247 * allocated or unallocated.
3249 * @param rl the resource list to search
3250 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3251 * @param rid the resource identifier
3253 * @returns Non-zero if the entry is reserved, zero otherwise.
3256 resource_list_reserved(struct resource_list *rl, int type, int rid)
3258 struct resource_list_entry *rle;
3260 rle = resource_list_find(rl, type, rid);
3261 if (rle != NULL && rle->flags & RLE_RESERVED)
3267 * @brief Find a resource entry by type and rid.
3269 * @param rl the resource list to search
3270 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3271 * @param rid the resource identifier
3273 * @returns the resource entry pointer or NULL if there is no such
3276 struct resource_list_entry *
3277 resource_list_find(struct resource_list *rl, int type, int rid)
3279 struct resource_list_entry *rle;
3281 STAILQ_FOREACH(rle, rl, link) {
3282 if (rle->type == type && rle->rid == rid)
3289 * @brief Delete a resource entry.
3291 * @param rl the resource list to edit
3292 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3293 * @param rid the resource identifier
3296 resource_list_delete(struct resource_list *rl, int type, int rid)
3298 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3301 if (rle->res != NULL)
3302 panic("resource_list_delete: resource has not been released");
3303 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3309 * @brief Allocate a reserved resource
3311 * This can be used by buses to force the allocation of resources
3312 * that are always active in the system even if they are not allocated
3313 * by a driver (e.g. PCI BARs). This function is usually called when
3314 * adding a new child to the bus. The resource is allocated from the
3315 * parent bus when it is reserved. The resource list entry is marked
3316 * with RLE_RESERVED to note that it is a reserved resource.
3318 * Subsequent attempts to allocate the resource with
3319 * resource_list_alloc() will succeed the first time and will set
3320 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3321 * resource that has been allocated is released with
3322 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3323 * the actual resource remains allocated. The resource can be released to
3324 * the parent bus by calling resource_list_unreserve().
3326 * @param rl the resource list to allocate from
3327 * @param bus the parent device of @p child
3328 * @param child the device for which the resource is being reserved
3329 * @param type the type of resource to allocate
3330 * @param rid a pointer to the resource identifier
3331 * @param start hint at the start of the resource range - pass
3332 * @c 0 for any start address
3333 * @param end hint at the end of the resource range - pass
3334 * @c ~0 for any end address
3335 * @param count hint at the size of range required - pass @c 1
3337 * @param flags any extra flags to control the resource
3338 * allocation - see @c RF_XXX flags in
3339 * <sys/rman.h> for details
3341 * @returns the resource which was allocated or @c NULL if no
3342 * resource could be allocated
3345 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3346 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3348 struct resource_list_entry *rle = NULL;
3349 int passthrough = (device_get_parent(child) != bus);
3354 "resource_list_reserve() should only be called for direct children");
3355 if (flags & RF_ACTIVE)
3357 "resource_list_reserve() should only reserve inactive resources");
3359 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3362 rle = resource_list_find(rl, type, *rid);
3363 rle->flags |= RLE_RESERVED;
3369 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3371 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3372 * and passing the allocation up to the parent of @p bus. This assumes
3373 * that the first entry of @c device_get_ivars(child) is a struct
3374 * resource_list. This also handles 'passthrough' allocations where a
3375 * child is a remote descendant of bus by passing the allocation up to
3376 * the parent of bus.
3378 * Typically, a bus driver would store a list of child resources
3379 * somewhere in the child device's ivars (see device_get_ivars()) and
3380 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3381 * then call resource_list_alloc() to perform the allocation.
3383 * @param rl the resource list to allocate from
3384 * @param bus the parent device of @p child
3385 * @param child the device which is requesting an allocation
3386 * @param type the type of resource to allocate
3387 * @param rid a pointer to the resource identifier
3388 * @param start hint at the start of the resource range - pass
3389 * @c 0 for any start address
3390 * @param end hint at the end of the resource range - pass
3391 * @c ~0 for any end address
3392 * @param count hint at the size of range required - pass @c 1
3394 * @param flags any extra flags to control the resource
3395 * allocation - see @c RF_XXX flags in
3396 * <sys/rman.h> for details
3398 * @returns the resource which was allocated or @c NULL if no
3399 * resource could be allocated
3402 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3403 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3405 struct resource_list_entry *rle = NULL;
3406 int passthrough = (device_get_parent(child) != bus);
3407 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3410 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3411 type, rid, start, end, count, flags));
3414 rle = resource_list_find(rl, type, *rid);
3417 return (NULL); /* no resource of that type/rid */
3420 if (rle->flags & RLE_RESERVED) {
3421 if (rle->flags & RLE_ALLOCATED)
3423 if ((flags & RF_ACTIVE) &&
3424 bus_activate_resource(child, type, *rid,
3427 rle->flags |= RLE_ALLOCATED;
3431 "resource entry %#x type %d for child %s is busy\n", *rid,
3432 type, device_get_nameunit(child));
3438 count = ulmax(count, rle->count);
3439 end = ulmax(rle->end, start + count - 1);
3442 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3443 type, rid, start, end, count, flags);
3446 * Record the new range.
3449 rle->start = rman_get_start(rle->res);
3450 rle->end = rman_get_end(rle->res);
3458 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3460 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3461 * used with resource_list_alloc().
3463 * @param rl the resource list which was allocated from
3464 * @param bus the parent device of @p child
3465 * @param child the device which is requesting a release
3466 * @param type the type of resource to release
3467 * @param rid the resource identifier
3468 * @param res the resource to release
3471 * @retval non-zero a standard unix error code indicating what
3472 * error condition prevented the operation
3475 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3476 int type, int rid, struct resource *res)
3478 struct resource_list_entry *rle = NULL;
3479 int passthrough = (device_get_parent(child) != bus);
3483 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3487 rle = resource_list_find(rl, type, rid);
3490 panic("resource_list_release: can't find resource");
3492 panic("resource_list_release: resource entry is not busy");
3493 if (rle->flags & RLE_RESERVED) {
3494 if (rle->flags & RLE_ALLOCATED) {
3495 if (rman_get_flags(res) & RF_ACTIVE) {
3496 error = bus_deactivate_resource(child, type,
3501 rle->flags &= ~RLE_ALLOCATED;
3507 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3517 * @brief Release all active resources of a given type
3519 * Release all active resources of a specified type. This is intended
3520 * to be used to cleanup resources leaked by a driver after detach or
3523 * @param rl the resource list which was allocated from
3524 * @param bus the parent device of @p child
3525 * @param child the device whose active resources are being released
3526 * @param type the type of resources to release
3529 * @retval EBUSY at least one resource was active
3532 resource_list_release_active(struct resource_list *rl, device_t bus,
3533 device_t child, int type)
3535 struct resource_list_entry *rle;
3539 STAILQ_FOREACH(rle, rl, link) {
3540 if (rle->type != type)
3542 if (rle->res == NULL)
3544 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3548 error = resource_list_release(rl, bus, child, type,
3549 rman_get_rid(rle->res), rle->res);
3552 "Failed to release active resource: %d\n", error);
3559 * @brief Fully release a reserved resource
3561 * Fully releases a resource reserved via resource_list_reserve().
3563 * @param rl the resource list which was allocated from
3564 * @param bus the parent device of @p child
3565 * @param child the device whose reserved resource is being released
3566 * @param type the type of resource to release
3567 * @param rid the resource identifier
3568 * @param res the resource to release
3571 * @retval non-zero a standard unix error code indicating what
3572 * error condition prevented the operation
3575 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3578 struct resource_list_entry *rle = NULL;
3579 int passthrough = (device_get_parent(child) != bus);
3583 "resource_list_unreserve() should only be called for direct children");
3585 rle = resource_list_find(rl, type, rid);
3588 panic("resource_list_unreserve: can't find resource");
3589 if (!(rle->flags & RLE_RESERVED))
3591 if (rle->flags & RLE_ALLOCATED)
3593 rle->flags &= ~RLE_RESERVED;
3594 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3598 * @brief Print a description of resources in a resource list
3600 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3601 * The name is printed if at least one resource of the given type is available.
3602 * The format is used to print resource start and end.
3604 * @param rl the resource list to print
3605 * @param name the name of @p type, e.g. @c "memory"
3606 * @param type type type of resource entry to print
3607 * @param format printf(9) format string to print resource
3608 * start and end values
3610 * @returns the number of characters printed
3613 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3616 struct resource_list_entry *rle;
3617 int printed, retval;
3621 /* Yes, this is kinda cheating */
3622 STAILQ_FOREACH(rle, rl, link) {
3623 if (rle->type == type) {
3625 retval += printf(" %s ", name);
3627 retval += printf(",");
3629 retval += printf(format, rle->start);
3630 if (rle->count > 1) {
3631 retval += printf("-");
3632 retval += printf(format, rle->start +
3641 * @brief Releases all the resources in a list.
3643 * @param rl The resource list to purge.
3648 resource_list_purge(struct resource_list *rl)
3650 struct resource_list_entry *rle;
3652 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3654 bus_release_resource(rman_get_device(rle->res),
3655 rle->type, rle->rid, rle->res);
3656 STAILQ_REMOVE_HEAD(rl, link);
3662 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3665 return (device_add_child_ordered(dev, order, name, unit));
3669 * @brief Helper function for implementing DEVICE_PROBE()
3671 * This function can be used to help implement the DEVICE_PROBE() for
3672 * a bus (i.e. a device which has other devices attached to it). It
3673 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3677 bus_generic_probe(device_t dev)
3679 devclass_t dc = dev->devclass;
3682 TAILQ_FOREACH(dl, &dc->drivers, link) {
3684 * If this driver's pass is too high, then ignore it.
3685 * For most drivers in the default pass, this will
3686 * never be true. For early-pass drivers they will
3687 * only call the identify routines of eligible drivers
3688 * when this routine is called. Drivers for later
3689 * passes should have their identify routines called
3690 * on early-pass buses during BUS_NEW_PASS().
3692 if (dl->pass > bus_current_pass)
3694 DEVICE_IDENTIFY(dl->driver, dev);
3701 * @brief Helper function for implementing DEVICE_ATTACH()
3703 * This function can be used to help implement the DEVICE_ATTACH() for
3704 * a bus. It calls device_probe_and_attach() for each of the device's
3708 bus_generic_attach(device_t dev)
3712 TAILQ_FOREACH(child, &dev->children, link) {
3713 device_probe_and_attach(child);
3720 * @brief Helper function for implementing DEVICE_DETACH()
3722 * This function can be used to help implement the DEVICE_DETACH() for
3723 * a bus. It calls device_detach() for each of the device's
3727 bus_generic_detach(device_t dev)
3732 if (dev->state != DS_ATTACHED)
3736 * Detach children in the reverse order.
3737 * See bus_generic_suspend for details.
3739 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3740 if ((error = device_detach(child)) != 0)
3748 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3750 * This function can be used to help implement the DEVICE_SHUTDOWN()
3751 * for a bus. It calls device_shutdown() for each of the device's
3755 bus_generic_shutdown(device_t dev)
3760 * Shut down children in the reverse order.
3761 * See bus_generic_suspend for details.
3763 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3764 device_shutdown(child);
3771 * @brief Default function for suspending a child device.
3773 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3776 bus_generic_suspend_child(device_t dev, device_t child)
3780 error = DEVICE_SUSPEND(child);
3783 child->flags |= DF_SUSPENDED;
3789 * @brief Default function for resuming a child device.
3791 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3794 bus_generic_resume_child(device_t dev, device_t child)
3797 DEVICE_RESUME(child);
3798 child->flags &= ~DF_SUSPENDED;
3804 * @brief Helper function for implementing DEVICE_SUSPEND()
3806 * This function can be used to help implement the DEVICE_SUSPEND()
3807 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3808 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3809 * operation is aborted and any devices which were suspended are
3810 * resumed immediately by calling their DEVICE_RESUME() methods.
3813 bus_generic_suspend(device_t dev)
3819 * Suspend children in the reverse order.
3820 * For most buses all children are equal, so the order does not matter.
3821 * Other buses, such as acpi, carefully order their child devices to
3822 * express implicit dependencies between them. For such buses it is
3823 * safer to bring down devices in the reverse order.
3825 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3826 error = BUS_SUSPEND_CHILD(dev, child);
3828 child = TAILQ_NEXT(child, link);
3829 if (child != NULL) {
3830 TAILQ_FOREACH_FROM(child, &dev->children, link)
3831 BUS_RESUME_CHILD(dev, child);
3840 * @brief Helper function for implementing DEVICE_RESUME()
3842 * This function can be used to help implement the DEVICE_RESUME() for
3843 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3846 bus_generic_resume(device_t dev)
3850 TAILQ_FOREACH(child, &dev->children, link) {
3851 BUS_RESUME_CHILD(dev, child);
3852 /* if resume fails, there's nothing we can usefully do... */
3859 * @brief Helper function for implementing BUS_RESET_POST
3861 * Bus can use this function to implement common operations of
3862 * re-attaching or resuming the children after the bus itself was
3863 * reset, and after restoring bus-unique state of children.
3865 * @param dev The bus
3866 * #param flags DEVF_RESET_*
3869 bus_helper_reset_post(device_t dev, int flags)
3875 TAILQ_FOREACH(child, &dev->children,link) {
3876 BUS_RESET_POST(dev, child);
3877 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3878 device_probe_and_attach(child) :
3879 BUS_RESUME_CHILD(dev, child);
3880 if (error == 0 && error1 != 0)
3887 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3890 child = TAILQ_NEXT(child, link);
3893 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3894 BUS_RESET_POST(dev, child);
3895 if ((flags & DEVF_RESET_DETACH) != 0)
3896 device_probe_and_attach(child);
3898 BUS_RESUME_CHILD(dev, child);
3903 * @brief Helper function for implementing BUS_RESET_PREPARE
3905 * Bus can use this function to implement common operations of
3906 * detaching or suspending the children before the bus itself is
3907 * reset, and then save bus-unique state of children that must
3908 * persists around reset.
3910 * @param dev The bus
3911 * #param flags DEVF_RESET_*
3914 bus_helper_reset_prepare(device_t dev, int flags)
3919 if (dev->state != DS_ATTACHED)
3922 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3923 if ((flags & DEVF_RESET_DETACH) != 0) {
3924 error = device_get_state(child) == DS_ATTACHED ?
3925 device_detach(child) : 0;
3927 error = BUS_SUSPEND_CHILD(dev, child);
3930 error = BUS_RESET_PREPARE(dev, child);
3932 if ((flags & DEVF_RESET_DETACH) != 0)
3933 device_probe_and_attach(child);
3935 BUS_RESUME_CHILD(dev, child);
3939 bus_helper_reset_prepare_rollback(dev, child, flags);
3948 * @brief Helper function for implementing BUS_PRINT_CHILD().
3950 * This function prints the first part of the ascii representation of
3951 * @p child, including its name, unit and description (if any - see
3952 * device_set_desc()).
3954 * @returns the number of characters printed
3957 bus_print_child_header(device_t dev, device_t child)
3961 if (device_get_desc(child)) {
3962 retval += device_printf(child, "<%s>", device_get_desc(child));
3964 retval += printf("%s", device_get_nameunit(child));
3971 * @brief Helper function for implementing BUS_PRINT_CHILD().
3973 * This function prints the last part of the ascii representation of
3974 * @p child, which consists of the string @c " on " followed by the
3975 * name and unit of the @p dev.
3977 * @returns the number of characters printed
3980 bus_print_child_footer(device_t dev, device_t child)
3982 return (printf(" on %s\n", device_get_nameunit(dev)));
3986 * @brief Helper function for implementing BUS_PRINT_CHILD().
3988 * This function prints out the VM domain for the given device.
3990 * @returns the number of characters printed
3993 bus_print_child_domain(device_t dev, device_t child)
3997 /* No domain? Don't print anything */
3998 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4001 return (printf(" numa-domain %d", domain));
4005 * @brief Helper function for implementing BUS_PRINT_CHILD().
4007 * This function simply calls bus_print_child_header() followed by
4008 * bus_print_child_footer().
4010 * @returns the number of characters printed
4013 bus_generic_print_child(device_t dev, device_t child)
4017 retval += bus_print_child_header(dev, child);
4018 retval += bus_print_child_domain(dev, child);
4019 retval += bus_print_child_footer(dev, child);
4025 * @brief Stub function for implementing BUS_READ_IVAR().
4030 bus_generic_read_ivar(device_t dev, device_t child, int index,
4037 * @brief Stub function for implementing BUS_WRITE_IVAR().
4042 bus_generic_write_ivar(device_t dev, device_t child, int index,
4049 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4053 struct resource_list *
4054 bus_generic_get_resource_list(device_t dev, device_t child)
4060 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4062 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4063 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4064 * and then calls device_probe_and_attach() for each unattached child.
4067 bus_generic_driver_added(device_t dev, driver_t *driver)
4071 DEVICE_IDENTIFY(driver, dev);
4072 TAILQ_FOREACH(child, &dev->children, link) {
4073 if (child->state == DS_NOTPRESENT ||
4074 (child->flags & DF_REBID))
4075 device_probe_and_attach(child);
4080 * @brief Helper function for implementing BUS_NEW_PASS().
4082 * This implementing of BUS_NEW_PASS() first calls the identify
4083 * routines for any drivers that probe at the current pass. Then it
4084 * walks the list of devices for this bus. If a device is already
4085 * attached, then it calls BUS_NEW_PASS() on that device. If the
4086 * device is not already attached, it attempts to attach a driver to
4090 bus_generic_new_pass(device_t dev)
4097 TAILQ_FOREACH(dl, &dc->drivers, link) {
4098 if (dl->pass == bus_current_pass)
4099 DEVICE_IDENTIFY(dl->driver, dev);
4101 TAILQ_FOREACH(child, &dev->children, link) {
4102 if (child->state >= DS_ATTACHED)
4103 BUS_NEW_PASS(child);
4104 else if (child->state == DS_NOTPRESENT)
4105 device_probe_and_attach(child);
4110 * @brief Helper function for implementing BUS_SETUP_INTR().
4112 * This simple implementation of BUS_SETUP_INTR() simply calls the
4113 * BUS_SETUP_INTR() method of the parent of @p dev.
4116 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4117 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4120 /* Propagate up the bus hierarchy until someone handles it. */
4122 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4123 filter, intr, arg, cookiep));
4128 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4130 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4131 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4134 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4137 /* Propagate up the bus hierarchy until someone handles it. */
4139 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4144 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4146 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4147 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4150 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4152 /* Propagate up the bus hierarchy until someone handles it. */
4154 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4159 * @brief Helper function for implementing BUS_RESUME_INTR().
4161 * This simple implementation of BUS_RESUME_INTR() simply calls the
4162 * BUS_RESUME_INTR() method of the parent of @p dev.
4165 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4167 /* Propagate up the bus hierarchy until someone handles it. */
4169 return (BUS_RESUME_INTR(dev->parent, child, irq));
4174 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4176 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4177 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4180 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4181 struct resource *r, rman_res_t start, rman_res_t end)
4183 /* Propagate up the bus hierarchy until someone handles it. */
4185 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4191 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4193 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4194 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4197 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4198 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4200 /* Propagate up the bus hierarchy until someone handles it. */
4202 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4203 start, end, count, flags));
4208 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4210 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4211 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4214 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4217 /* Propagate up the bus hierarchy until someone handles it. */
4219 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4225 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4227 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4228 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4231 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4234 /* Propagate up the bus hierarchy until someone handles it. */
4236 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4242 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4244 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4245 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4248 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4249 int rid, struct resource *r)
4251 /* Propagate up the bus hierarchy until someone handles it. */
4253 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4259 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4261 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4262 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4265 bus_generic_map_resource(device_t dev, device_t child, int type,
4266 struct resource *r, struct resource_map_request *args,
4267 struct resource_map *map)
4269 /* Propagate up the bus hierarchy until someone handles it. */
4271 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4277 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4279 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4280 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4283 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4284 struct resource *r, struct resource_map *map)
4286 /* Propagate up the bus hierarchy until someone handles it. */
4288 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4293 * @brief Helper function for implementing BUS_BIND_INTR().
4295 * This simple implementation of BUS_BIND_INTR() simply calls the
4296 * BUS_BIND_INTR() method of the parent of @p dev.
4299 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4303 /* Propagate up the bus hierarchy until someone handles it. */
4305 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4310 * @brief Helper function for implementing BUS_CONFIG_INTR().
4312 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4313 * BUS_CONFIG_INTR() method of the parent of @p dev.
4316 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4317 enum intr_polarity pol)
4320 /* Propagate up the bus hierarchy until someone handles it. */
4322 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4327 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4329 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4330 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4333 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4334 void *cookie, const char *descr)
4337 /* Propagate up the bus hierarchy until someone handles it. */
4339 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4345 * @brief Helper function for implementing BUS_GET_CPUS().
4347 * This simple implementation of BUS_GET_CPUS() simply calls the
4348 * BUS_GET_CPUS() method of the parent of @p dev.
4351 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4352 size_t setsize, cpuset_t *cpuset)
4355 /* Propagate up the bus hierarchy until someone handles it. */
4356 if (dev->parent != NULL)
4357 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4362 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4364 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4365 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4368 bus_generic_get_dma_tag(device_t dev, device_t child)
4371 /* Propagate up the bus hierarchy until someone handles it. */
4372 if (dev->parent != NULL)
4373 return (BUS_GET_DMA_TAG(dev->parent, child));
4378 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4380 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4381 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4384 bus_generic_get_bus_tag(device_t dev, device_t child)
4387 /* Propagate up the bus hierarchy until someone handles it. */
4388 if (dev->parent != NULL)
4389 return (BUS_GET_BUS_TAG(dev->parent, child));
4390 return ((bus_space_tag_t)0);
4394 * @brief Helper function for implementing BUS_GET_RESOURCE().
4396 * This implementation of BUS_GET_RESOURCE() uses the
4397 * resource_list_find() function to do most of the work. It calls
4398 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4402 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4403 rman_res_t *startp, rman_res_t *countp)
4405 struct resource_list * rl = NULL;
4406 struct resource_list_entry * rle = NULL;
4408 rl = BUS_GET_RESOURCE_LIST(dev, child);
4412 rle = resource_list_find(rl, type, rid);
4417 *startp = rle->start;
4419 *countp = rle->count;
4425 * @brief Helper function for implementing BUS_SET_RESOURCE().
4427 * This implementation of BUS_SET_RESOURCE() uses the
4428 * resource_list_add() function to do most of the work. It calls
4429 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4433 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4434 rman_res_t start, rman_res_t count)
4436 struct resource_list * rl = NULL;
4438 rl = BUS_GET_RESOURCE_LIST(dev, child);
4442 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4448 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4450 * This implementation of BUS_DELETE_RESOURCE() uses the
4451 * resource_list_delete() function to do most of the work. It calls
4452 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4456 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4458 struct resource_list * rl = NULL;
4460 rl = BUS_GET_RESOURCE_LIST(dev, child);
4464 resource_list_delete(rl, type, rid);
4470 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4472 * This implementation of BUS_RELEASE_RESOURCE() uses the
4473 * resource_list_release() function to do most of the work. It calls
4474 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4477 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4478 int rid, struct resource *r)
4480 struct resource_list * rl = NULL;
4482 if (device_get_parent(child) != dev)
4483 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4486 rl = BUS_GET_RESOURCE_LIST(dev, child);
4490 return (resource_list_release(rl, dev, child, type, rid, r));
4494 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4496 * This implementation of BUS_ALLOC_RESOURCE() uses the
4497 * resource_list_alloc() function to do most of the work. It calls
4498 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4501 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4502 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4504 struct resource_list * rl = NULL;
4506 if (device_get_parent(child) != dev)
4507 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4508 type, rid, start, end, count, flags));
4510 rl = BUS_GET_RESOURCE_LIST(dev, child);
4514 return (resource_list_alloc(rl, dev, child, type, rid,
4515 start, end, count, flags));
4519 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4521 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4522 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4525 bus_generic_child_present(device_t dev, device_t child)
4527 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4531 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4535 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4541 * @brief Helper function for implementing BUS_RESCAN().
4543 * This null implementation of BUS_RESCAN() always fails to indicate
4544 * the bus does not support rescanning.
4547 bus_null_rescan(device_t dev)
4554 * Some convenience functions to make it easier for drivers to use the
4555 * resource-management functions. All these really do is hide the
4556 * indirection through the parent's method table, making for slightly
4557 * less-wordy code. In the future, it might make sense for this code
4558 * to maintain some sort of a list of resources allocated by each device.
4562 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4563 struct resource **res)
4567 for (i = 0; rs[i].type != -1; i++)
4569 for (i = 0; rs[i].type != -1; i++) {
4570 res[i] = bus_alloc_resource_any(dev,
4571 rs[i].type, &rs[i].rid, rs[i].flags);
4572 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4573 bus_release_resources(dev, rs, res);
4581 bus_release_resources(device_t dev, const struct resource_spec *rs,
4582 struct resource **res)
4586 for (i = 0; rs[i].type != -1; i++)
4587 if (res[i] != NULL) {
4588 bus_release_resource(
4589 dev, rs[i].type, rs[i].rid, res[i]);
4595 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4597 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4601 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4602 rman_res_t end, rman_res_t count, u_int flags)
4604 struct resource *res;
4606 if (dev->parent == NULL)
4608 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4614 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4616 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4620 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4623 if (dev->parent == NULL)
4625 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4629 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4631 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4635 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4637 if (dev->parent == NULL)
4639 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4643 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4645 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4649 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4651 if (dev->parent == NULL)
4653 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4657 * @brief Wrapper function for BUS_MAP_RESOURCE().
4659 * This function simply calls the BUS_MAP_RESOURCE() method of the
4663 bus_map_resource(device_t dev, int type, struct resource *r,
4664 struct resource_map_request *args, struct resource_map *map)
4666 if (dev->parent == NULL)
4668 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4672 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4674 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4678 bus_unmap_resource(device_t dev, int type, struct resource *r,
4679 struct resource_map *map)
4681 if (dev->parent == NULL)
4683 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4687 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4689 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4693 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4697 if (dev->parent == NULL)
4699 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4704 * @brief Wrapper function for BUS_SETUP_INTR().
4706 * This function simply calls the BUS_SETUP_INTR() method of the
4710 bus_setup_intr(device_t dev, struct resource *r, int flags,
4711 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4715 if (dev->parent == NULL)
4717 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4721 if (handler != NULL && !(flags & INTR_MPSAFE))
4722 device_printf(dev, "[GIANT-LOCKED]\n");
4727 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4729 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4733 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4735 if (dev->parent == NULL)
4737 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4741 * @brief Wrapper function for BUS_SUSPEND_INTR().
4743 * This function simply calls the BUS_SUSPEND_INTR() method of the
4747 bus_suspend_intr(device_t dev, struct resource *r)
4749 if (dev->parent == NULL)
4751 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4755 * @brief Wrapper function for BUS_RESUME_INTR().
4757 * This function simply calls the BUS_RESUME_INTR() method of the
4761 bus_resume_intr(device_t dev, struct resource *r)
4763 if (dev->parent == NULL)
4765 return (BUS_RESUME_INTR(dev->parent, dev, r));
4769 * @brief Wrapper function for BUS_BIND_INTR().
4771 * This function simply calls the BUS_BIND_INTR() method of the
4775 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4777 if (dev->parent == NULL)
4779 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4783 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4785 * This function first formats the requested description into a
4786 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4787 * the parent of @p dev.
4790 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4791 const char *fmt, ...)
4794 char descr[MAXCOMLEN + 1];
4796 if (dev->parent == NULL)
4799 vsnprintf(descr, sizeof(descr), fmt, ap);
4801 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4805 * @brief Wrapper function for BUS_SET_RESOURCE().
4807 * This function simply calls the BUS_SET_RESOURCE() method of the
4811 bus_set_resource(device_t dev, int type, int rid,
4812 rman_res_t start, rman_res_t count)
4814 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4819 * @brief Wrapper function for BUS_GET_RESOURCE().
4821 * This function simply calls the BUS_GET_RESOURCE() method of the
4825 bus_get_resource(device_t dev, int type, int rid,
4826 rman_res_t *startp, rman_res_t *countp)
4828 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4833 * @brief Wrapper function for BUS_GET_RESOURCE().
4835 * This function simply calls the BUS_GET_RESOURCE() method of the
4836 * parent of @p dev and returns the start value.
4839 bus_get_resource_start(device_t dev, int type, int rid)
4845 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4853 * @brief Wrapper function for BUS_GET_RESOURCE().
4855 * This function simply calls the BUS_GET_RESOURCE() method of the
4856 * parent of @p dev and returns the count value.
4859 bus_get_resource_count(device_t dev, int type, int rid)
4865 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4873 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4875 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4879 bus_delete_resource(device_t dev, int type, int rid)
4881 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4885 * @brief Wrapper function for BUS_CHILD_PRESENT().
4887 * This function simply calls the BUS_CHILD_PRESENT() method of the
4891 bus_child_present(device_t child)
4893 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4897 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4899 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4903 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4907 parent = device_get_parent(child);
4908 if (parent == NULL) {
4912 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4916 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4918 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4922 bus_child_location_str(device_t child, char *buf, size_t buflen)
4926 parent = device_get_parent(child);
4927 if (parent == NULL) {
4931 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4935 * @brief Wrapper function for BUS_GET_CPUS().
4937 * This function simply calls the BUS_GET_CPUS() method of the
4941 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4945 parent = device_get_parent(dev);
4948 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4952 * @brief Wrapper function for BUS_GET_DMA_TAG().
4954 * This function simply calls the BUS_GET_DMA_TAG() method of the
4958 bus_get_dma_tag(device_t dev)
4962 parent = device_get_parent(dev);
4965 return (BUS_GET_DMA_TAG(parent, dev));
4969 * @brief Wrapper function for BUS_GET_BUS_TAG().
4971 * This function simply calls the BUS_GET_BUS_TAG() method of the
4975 bus_get_bus_tag(device_t dev)
4979 parent = device_get_parent(dev);
4981 return ((bus_space_tag_t)0);
4982 return (BUS_GET_BUS_TAG(parent, dev));
4986 * @brief Wrapper function for BUS_GET_DOMAIN().
4988 * This function simply calls the BUS_GET_DOMAIN() method of the
4992 bus_get_domain(device_t dev, int *domain)
4994 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4997 /* Resume all devices and then notify userland that we're up again. */
4999 root_resume(device_t dev)
5003 error = bus_generic_resume(dev);
5005 devctl_notify("kern", "power", "resume", NULL);
5010 root_print_child(device_t dev, device_t child)
5014 retval += bus_print_child_header(dev, child);
5015 retval += printf("\n");
5021 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5022 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5025 * If an interrupt mapping gets to here something bad has happened.
5027 panic("root_setup_intr");
5031 * If we get here, assume that the device is permanent and really is
5032 * present in the system. Removable bus drivers are expected to intercept
5033 * this call long before it gets here. We return -1 so that drivers that
5034 * really care can check vs -1 or some ERRNO returned higher in the food
5038 root_child_present(device_t dev, device_t child)
5044 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5050 /* Default to returning the set of all CPUs. */
5051 if (setsize != sizeof(cpuset_t))
5060 static kobj_method_t root_methods[] = {
5061 /* Device interface */
5062 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5063 KOBJMETHOD(device_suspend, bus_generic_suspend),
5064 KOBJMETHOD(device_resume, root_resume),
5067 KOBJMETHOD(bus_print_child, root_print_child),
5068 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5069 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5070 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5071 KOBJMETHOD(bus_child_present, root_child_present),
5072 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5077 static driver_t root_driver = {
5084 devclass_t root_devclass;
5087 root_bus_module_handler(module_t mod, int what, void* arg)
5091 TAILQ_INIT(&bus_data_devices);
5092 kobj_class_compile((kobj_class_t) &root_driver);
5093 root_bus = make_device(NULL, "root", 0);
5094 root_bus->desc = "System root bus";
5095 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5096 root_bus->driver = &root_driver;
5097 root_bus->state = DS_ATTACHED;
5098 root_devclass = devclass_find_internal("root", NULL, FALSE);
5103 device_shutdown(root_bus);
5106 return (EOPNOTSUPP);
5112 static moduledata_t root_bus_mod = {
5114 root_bus_module_handler,
5117 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5120 * @brief Automatically configure devices
5122 * This function begins the autoconfiguration process by calling
5123 * device_probe_and_attach() for each child of the @c root0 device.
5126 root_bus_configure(void)
5131 /* Eventually this will be split up, but this is sufficient for now. */
5132 bus_set_pass(BUS_PASS_DEFAULT);
5136 * @brief Module handler for registering device drivers
5138 * This module handler is used to automatically register device
5139 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5140 * devclass_add_driver() for the driver described by the
5141 * driver_module_data structure pointed to by @p arg
5144 driver_module_handler(module_t mod, int what, void *arg)
5146 struct driver_module_data *dmd;
5147 devclass_t bus_devclass;
5148 kobj_class_t driver;
5151 dmd = (struct driver_module_data *)arg;
5152 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5157 if (dmd->dmd_chainevh)
5158 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5160 pass = dmd->dmd_pass;
5161 driver = dmd->dmd_driver;
5162 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5163 DRIVERNAME(driver), dmd->dmd_busname, pass));
5164 error = devclass_add_driver(bus_devclass, driver, pass,
5169 PDEBUG(("Unloading module: driver %s from bus %s",
5170 DRIVERNAME(dmd->dmd_driver),
5172 error = devclass_delete_driver(bus_devclass,
5175 if (!error && dmd->dmd_chainevh)
5176 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5179 PDEBUG(("Quiesce module: driver %s from bus %s",
5180 DRIVERNAME(dmd->dmd_driver),
5182 error = devclass_quiesce_driver(bus_devclass,
5185 if (!error && dmd->dmd_chainevh)
5186 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5197 * @brief Enumerate all hinted devices for this bus.
5199 * Walks through the hints for this bus and calls the bus_hinted_child
5200 * routine for each one it fines. It searches first for the specific
5201 * bus that's being probed for hinted children (eg isa0), and then for
5202 * generic children (eg isa).
5204 * @param dev bus device to enumerate
5207 bus_enumerate_hinted_children(device_t bus)
5210 const char *dname, *busname;
5214 * enumerate all devices on the specific bus
5216 busname = device_get_nameunit(bus);
5218 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5219 BUS_HINTED_CHILD(bus, dname, dunit);
5222 * and all the generic ones.
5224 busname = device_get_name(bus);
5226 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5227 BUS_HINTED_CHILD(bus, dname, dunit);
5232 /* the _short versions avoid iteration by not calling anything that prints
5233 * more than oneliners. I love oneliners.
5237 print_device_short(device_t dev, int indent)
5242 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5243 dev->unit, dev->desc,
5244 (dev->parent? "":"no "),
5245 (TAILQ_EMPTY(&dev->children)? "no ":""),
5246 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5247 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5248 (dev->flags&DF_WILDCARD? "wildcard,":""),
5249 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5250 (dev->flags&DF_REBID? "rebiddable,":""),
5251 (dev->flags&DF_SUSPENDED? "suspended,":""),
5252 (dev->ivars? "":"no "),
5253 (dev->softc? "":"no "),
5258 print_device(device_t dev, int indent)
5263 print_device_short(dev, indent);
5265 indentprintf(("Parent:\n"));
5266 print_device_short(dev->parent, indent+1);
5267 indentprintf(("Driver:\n"));
5268 print_driver_short(dev->driver, indent+1);
5269 indentprintf(("Devclass:\n"));
5270 print_devclass_short(dev->devclass, indent+1);
5274 print_device_tree_short(device_t dev, int indent)
5275 /* print the device and all its children (indented) */
5282 print_device_short(dev, indent);
5284 TAILQ_FOREACH(child, &dev->children, link) {
5285 print_device_tree_short(child, indent+1);
5290 print_device_tree(device_t dev, int indent)
5291 /* print the device and all its children (indented) */
5298 print_device(dev, indent);
5300 TAILQ_FOREACH(child, &dev->children, link) {
5301 print_device_tree(child, indent+1);
5306 print_driver_short(driver_t *driver, int indent)
5311 indentprintf(("driver %s: softc size = %zd\n",
5312 driver->name, driver->size));
5316 print_driver(driver_t *driver, int indent)
5321 print_driver_short(driver, indent);
5325 print_driver_list(driver_list_t drivers, int indent)
5327 driverlink_t driver;
5329 TAILQ_FOREACH(driver, &drivers, link) {
5330 print_driver(driver->driver, indent);
5335 print_devclass_short(devclass_t dc, int indent)
5340 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5344 print_devclass(devclass_t dc, int indent)
5351 print_devclass_short(dc, indent);
5352 indentprintf(("Drivers:\n"));
5353 print_driver_list(dc->drivers, indent+1);
5355 indentprintf(("Devices:\n"));
5356 for (i = 0; i < dc->maxunit; i++)
5358 print_device(dc->devices[i], indent+1);
5362 print_devclass_list_short(void)
5366 printf("Short listing of devclasses, drivers & devices:\n");
5367 TAILQ_FOREACH(dc, &devclasses, link) {
5368 print_devclass_short(dc, 0);
5373 print_devclass_list(void)
5377 printf("Full listing of devclasses, drivers & devices:\n");
5378 TAILQ_FOREACH(dc, &devclasses, link) {
5379 print_devclass(dc, 0);
5386 * User-space access to the device tree.
5388 * We implement a small set of nodes:
5390 * hw.bus Single integer read method to obtain the
5391 * current generation count.
5392 * hw.bus.devices Reads the entire device tree in flat space.
5393 * hw.bus.rman Resource manager interface
5395 * We might like to add the ability to scan devclasses and/or drivers to
5396 * determine what else is currently loaded/available.
5400 sysctl_bus(SYSCTL_HANDLER_ARGS)
5402 struct u_businfo ubus;
5404 ubus.ub_version = BUS_USER_VERSION;
5405 ubus.ub_generation = bus_data_generation;
5407 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5409 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5410 "bus-related data");
5413 sysctl_devices(SYSCTL_HANDLER_ARGS)
5415 int *name = (int *)arg1;
5416 u_int namelen = arg2;
5419 struct u_device *udev;
5426 if (bus_data_generation_check(name[0]))
5432 * Scan the list of devices, looking for the requested index.
5434 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5442 * Populate the return item, careful not to overflow the buffer.
5444 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5447 udev->dv_handle = (uintptr_t)dev;
5448 udev->dv_parent = (uintptr_t)dev->parent;
5449 udev->dv_devflags = dev->devflags;
5450 udev->dv_flags = dev->flags;
5451 udev->dv_state = dev->state;
5452 walker = udev->dv_fields;
5453 ep = walker + sizeof(udev->dv_fields);
5455 if ((src) == NULL) \
5458 strlcpy(walker, (src), ep - walker); \
5459 walker += strlen(walker) + 1; \
5467 CP(dev->driver != NULL ? dev->driver->name : NULL);
5468 bus_child_pnpinfo_str(dev, walker, ep - walker);
5469 walker += strlen(walker) + 1;
5472 bus_child_location_str(dev, walker, ep - walker);
5473 walker += strlen(walker) + 1;
5479 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5484 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5485 "system device tree");
5488 bus_data_generation_check(int generation)
5490 if (generation != bus_data_generation)
5493 /* XXX generate optimised lists here? */
5498 bus_data_generation_update(void)
5500 bus_data_generation++;
5504 bus_free_resource(device_t dev, int type, struct resource *r)
5508 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5512 device_lookup_by_name(const char *name)
5516 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5517 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5524 * /dev/devctl2 implementation. The existing /dev/devctl device has
5525 * implicit semantics on open, so it could not be reused for this.
5526 * Another option would be to call this /dev/bus?
5529 find_device(struct devreq *req, device_t *devp)
5534 * First, ensure that the name is nul terminated.
5536 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5540 * Second, try to find an attached device whose name matches
5543 dev = device_lookup_by_name(req->dr_name);
5549 /* Finally, give device enumerators a chance. */
5551 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5559 driver_exists(device_t bus, const char *driver)
5563 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5564 if (devclass_find_driver_internal(dc, driver) != NULL)
5571 device_gen_nomatch(device_t dev)
5575 if (dev->flags & DF_NEEDNOMATCH &&
5576 dev->state == DS_NOTPRESENT) {
5577 BUS_PROBE_NOMATCH(dev->parent, dev);
5579 dev->flags |= DF_DONENOMATCH;
5581 dev->flags &= ~DF_NEEDNOMATCH;
5582 TAILQ_FOREACH(child, &dev->children, link) {
5583 device_gen_nomatch(child);
5588 device_do_deferred_actions(void)
5594 * Walk through the devclasses to find all the drivers we've tagged as
5595 * deferred during the freeze and call the driver added routines. They
5596 * have already been added to the lists in the background, so the driver
5597 * added routines that trigger a probe will have all the right bidders
5598 * for the probe auction.
5600 TAILQ_FOREACH(dc, &devclasses, link) {
5601 TAILQ_FOREACH(dl, &dc->drivers, link) {
5602 if (dl->flags & DL_DEFERRED_PROBE) {
5603 devclass_driver_added(dc, dl->driver);
5604 dl->flags &= ~DL_DEFERRED_PROBE;
5610 * We also defer no-match events during a freeze. Walk the tree and
5611 * generate all the pent-up events that are still relevant.
5613 device_gen_nomatch(root_bus);
5614 bus_data_generation_update();
5618 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5625 /* Locate the device to control. */
5627 req = (struct devreq *)data;
5635 case DEV_SET_DRIVER:
5636 case DEV_CLEAR_DRIVER:
5640 error = priv_check(td, PRIV_DRIVER);
5642 error = find_device(req, &dev);
5646 error = priv_check(td, PRIV_DRIVER);
5657 /* Perform the requested operation. */
5660 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5662 else if (!device_is_enabled(dev))
5665 error = device_probe_and_attach(dev);
5668 if (!device_is_attached(dev)) {
5672 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5673 error = device_quiesce(dev);
5677 error = device_detach(dev);
5680 if (device_is_enabled(dev)) {
5686 * If the device has been probed but not attached (e.g.
5687 * when it has been disabled by a loader hint), just
5688 * attach the device rather than doing a full probe.
5691 if (device_is_alive(dev)) {
5693 * If the device was disabled via a hint, clear
5696 if (resource_disabled(dev->driver->name, dev->unit))
5697 resource_unset_value(dev->driver->name,
5698 dev->unit, "disabled");
5699 error = device_attach(dev);
5701 error = device_probe_and_attach(dev);
5704 if (!device_is_enabled(dev)) {
5709 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5710 error = device_quiesce(dev);
5716 * Force DF_FIXEDCLASS on around detach to preserve
5717 * the existing name.
5720 dev->flags |= DF_FIXEDCLASS;
5721 error = device_detach(dev);
5722 if (!(old & DF_FIXEDCLASS))
5723 dev->flags &= ~DF_FIXEDCLASS;
5725 device_disable(dev);
5728 if (device_is_suspended(dev)) {
5732 if (device_get_parent(dev) == NULL) {
5736 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5739 if (!device_is_suspended(dev)) {
5743 if (device_get_parent(dev) == NULL) {
5747 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5749 case DEV_SET_DRIVER: {
5753 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5756 if (driver[0] == '\0') {
5760 if (dev->devclass != NULL &&
5761 strcmp(driver, dev->devclass->name) == 0)
5762 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5766 * Scan drivers for this device's bus looking for at
5767 * least one matching driver.
5769 if (dev->parent == NULL) {
5773 if (!driver_exists(dev->parent, driver)) {
5777 dc = devclass_create(driver);
5783 /* Detach device if necessary. */
5784 if (device_is_attached(dev)) {
5785 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5786 error = device_detach(dev);
5793 /* Clear any previously-fixed device class and unit. */
5794 if (dev->flags & DF_FIXEDCLASS)
5795 devclass_delete_device(dev->devclass, dev);
5796 dev->flags |= DF_WILDCARD;
5799 /* Force the new device class. */
5800 error = devclass_add_device(dc, dev);
5803 dev->flags |= DF_FIXEDCLASS;
5804 error = device_probe_and_attach(dev);
5807 case DEV_CLEAR_DRIVER:
5808 if (!(dev->flags & DF_FIXEDCLASS)) {
5812 if (device_is_attached(dev)) {
5813 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5814 error = device_detach(dev);
5821 dev->flags &= ~DF_FIXEDCLASS;
5822 dev->flags |= DF_WILDCARD;
5823 devclass_delete_device(dev->devclass, dev);
5824 error = device_probe_and_attach(dev);
5827 if (!device_is_attached(dev)) {
5831 error = BUS_RESCAN(dev);
5836 parent = device_get_parent(dev);
5837 if (parent == NULL) {
5841 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5842 if (bus_child_present(dev) != 0) {
5848 error = device_delete_child(parent, dev);
5855 device_frozen = true;
5861 device_do_deferred_actions();
5862 device_frozen = false;
5866 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5870 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5878 static struct cdevsw devctl2_cdevsw = {
5879 .d_version = D_VERSION,
5880 .d_ioctl = devctl2_ioctl,
5881 .d_name = "devctl2",
5888 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5889 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5893 * APIs to manage deprecation and obsolescence.
5895 static int obsolete_panic = 0;
5896 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5897 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5898 "2 = if deprecated)");
5901 gone_panic(int major, int running, const char *msg)
5904 switch (obsolete_panic)
5909 if (running < major)
5918 _gone_in(int major, const char *msg)
5921 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5922 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5923 printf("Obsolete code will removed soon: %s\n", msg);
5925 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5930 _gone_in_dev(device_t dev, int major, const char *msg)
5933 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5934 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5936 "Obsolete code will removed soon: %s\n", msg);
5939 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5944 DB_SHOW_COMMAND(device, db_show_device)
5951 dev = (device_t)addr;
5953 db_printf("name: %s\n", device_get_nameunit(dev));
5954 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5955 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5956 db_printf(" addr: %p\n", dev);
5957 db_printf(" parent: %p\n", dev->parent);
5958 db_printf(" softc: %p\n", dev->softc);
5959 db_printf(" ivars: %p\n", dev->ivars);
5962 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5966 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5967 db_show_device((db_expr_t)dev, true, count, modif);