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, ...)
2442 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2443 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2445 name = device_get_name(dev);
2448 sbuf_cat(&sb, "unknown: ");
2450 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2453 sbuf_vprintf(&sb, fmt, ap);
2466 device_set_desc_internal(device_t dev, const char* desc, int copy)
2468 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2469 free(dev->desc, M_BUS);
2470 dev->flags &= ~DF_DESCMALLOCED;
2475 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2477 strcpy(dev->desc, desc);
2478 dev->flags |= DF_DESCMALLOCED;
2481 /* Avoid a -Wcast-qual warning */
2482 dev->desc = (char *)(uintptr_t) desc;
2485 bus_data_generation_update();
2489 * @brief Set the device's description
2491 * The value of @c desc should be a string constant that will not
2492 * change (at least until the description is changed in a subsequent
2493 * call to device_set_desc() or device_set_desc_copy()).
2496 device_set_desc(device_t dev, const char* desc)
2498 device_set_desc_internal(dev, desc, FALSE);
2502 * @brief Set the device's description
2504 * The string pointed to by @c desc is copied. Use this function if
2505 * the device description is generated, (e.g. with sprintf()).
2508 device_set_desc_copy(device_t dev, const char* desc)
2510 device_set_desc_internal(dev, desc, TRUE);
2514 * @brief Set the device's flags
2517 device_set_flags(device_t dev, uint32_t flags)
2519 dev->devflags = flags;
2523 * @brief Return the device's softc field
2525 * The softc is allocated and zeroed when a driver is attached, based
2526 * on the size field of the driver.
2529 device_get_softc(device_t dev)
2531 return (dev->softc);
2535 * @brief Set the device's softc field
2537 * Most drivers do not need to use this since the softc is allocated
2538 * automatically when the driver is attached.
2541 device_set_softc(device_t dev, void *softc)
2543 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2544 free(dev->softc, M_BUS_SC);
2547 dev->flags |= DF_EXTERNALSOFTC;
2549 dev->flags &= ~DF_EXTERNALSOFTC;
2553 * @brief Free claimed softc
2555 * Most drivers do not need to use this since the softc is freed
2556 * automatically when the driver is detached.
2559 device_free_softc(void *softc)
2561 free(softc, M_BUS_SC);
2565 * @brief Claim softc
2567 * This function can be used to let the driver free the automatically
2568 * allocated softc using "device_free_softc()". This function is
2569 * useful when the driver is refcounting the softc and the softc
2570 * cannot be freed when the "device_detach" method is called.
2573 device_claim_softc(device_t dev)
2576 dev->flags |= DF_EXTERNALSOFTC;
2578 dev->flags &= ~DF_EXTERNALSOFTC;
2582 * @brief Get the device's ivars field
2584 * The ivars field is used by the parent device to store per-device
2585 * state (e.g. the physical location of the device or a list of
2589 device_get_ivars(device_t dev)
2592 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2593 return (dev->ivars);
2597 * @brief Set the device's ivars field
2600 device_set_ivars(device_t dev, void * ivars)
2603 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2608 * @brief Return the device's state
2611 device_get_state(device_t dev)
2613 return (dev->state);
2617 * @brief Set the DF_ENABLED flag for the device
2620 device_enable(device_t dev)
2622 dev->flags |= DF_ENABLED;
2626 * @brief Clear the DF_ENABLED flag for the device
2629 device_disable(device_t dev)
2631 dev->flags &= ~DF_ENABLED;
2635 * @brief Increment the busy counter for the device
2638 device_busy(device_t dev)
2640 if (dev->state < DS_ATTACHING)
2641 panic("device_busy: called for unattached device");
2642 if (dev->busy == 0 && dev->parent)
2643 device_busy(dev->parent);
2645 if (dev->state == DS_ATTACHED)
2646 dev->state = DS_BUSY;
2650 * @brief Decrement the busy counter for the device
2653 device_unbusy(device_t dev)
2655 if (dev->busy != 0 && dev->state != DS_BUSY &&
2656 dev->state != DS_ATTACHING)
2657 panic("device_unbusy: called for non-busy device %s",
2658 device_get_nameunit(dev));
2660 if (dev->busy == 0) {
2662 device_unbusy(dev->parent);
2663 if (dev->state == DS_BUSY)
2664 dev->state = DS_ATTACHED;
2669 * @brief Set the DF_QUIET flag for the device
2672 device_quiet(device_t dev)
2674 dev->flags |= DF_QUIET;
2678 * @brief Set the DF_QUIET_CHILDREN flag for the device
2681 device_quiet_children(device_t dev)
2683 dev->flags |= DF_QUIET_CHILDREN;
2687 * @brief Clear the DF_QUIET flag for the device
2690 device_verbose(device_t dev)
2692 dev->flags &= ~DF_QUIET;
2696 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2699 device_has_quiet_children(device_t dev)
2701 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2705 * @brief Return non-zero if the DF_QUIET flag is set on the device
2708 device_is_quiet(device_t dev)
2710 return ((dev->flags & DF_QUIET) != 0);
2714 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2717 device_is_enabled(device_t dev)
2719 return ((dev->flags & DF_ENABLED) != 0);
2723 * @brief Return non-zero if the device was successfully probed
2726 device_is_alive(device_t dev)
2728 return (dev->state >= DS_ALIVE);
2732 * @brief Return non-zero if the device currently has a driver
2736 device_is_attached(device_t dev)
2738 return (dev->state >= DS_ATTACHED);
2742 * @brief Return non-zero if the device is currently suspended.
2745 device_is_suspended(device_t dev)
2747 return ((dev->flags & DF_SUSPENDED) != 0);
2751 * @brief Set the devclass of a device
2752 * @see devclass_add_device().
2755 device_set_devclass(device_t dev, const char *classname)
2762 devclass_delete_device(dev->devclass, dev);
2766 if (dev->devclass) {
2767 printf("device_set_devclass: device class already set\n");
2771 dc = devclass_find_internal(classname, NULL, TRUE);
2775 error = devclass_add_device(dc, dev);
2777 bus_data_generation_update();
2782 * @brief Set the devclass of a device and mark the devclass fixed.
2783 * @see device_set_devclass()
2786 device_set_devclass_fixed(device_t dev, const char *classname)
2790 if (classname == NULL)
2793 error = device_set_devclass(dev, classname);
2796 dev->flags |= DF_FIXEDCLASS;
2801 * @brief Query the device to determine if it's of a fixed devclass
2802 * @see device_set_devclass_fixed()
2805 device_is_devclass_fixed(device_t dev)
2807 return ((dev->flags & DF_FIXEDCLASS) != 0);
2811 * @brief Set the driver of a device
2814 * @retval EBUSY the device already has a driver attached
2815 * @retval ENOMEM a memory allocation failure occurred
2818 device_set_driver(device_t dev, driver_t *driver)
2820 if (dev->state >= DS_ATTACHED)
2823 if (dev->driver == driver)
2826 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2827 free(dev->softc, M_BUS_SC);
2830 device_set_desc(dev, NULL);
2831 kobj_delete((kobj_t) dev, NULL);
2832 dev->driver = driver;
2834 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2835 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2836 dev->softc = malloc(driver->size, M_BUS_SC,
2839 kobj_delete((kobj_t) dev, NULL);
2840 kobj_init((kobj_t) dev, &null_class);
2846 kobj_init((kobj_t) dev, &null_class);
2849 bus_data_generation_update();
2854 * @brief Probe a device, and return this status.
2856 * This function is the core of the device autoconfiguration
2857 * system. Its purpose is to select a suitable driver for a device and
2858 * then call that driver to initialise the hardware appropriately. The
2859 * driver is selected by calling the DEVICE_PROBE() method of a set of
2860 * candidate drivers and then choosing the driver which returned the
2861 * best value. This driver is then attached to the device using
2864 * The set of suitable drivers is taken from the list of drivers in
2865 * the parent device's devclass. If the device was originally created
2866 * with a specific class name (see device_add_child()), only drivers
2867 * with that name are probed, otherwise all drivers in the devclass
2868 * are probed. If no drivers return successful probe values in the
2869 * parent devclass, the search continues in the parent of that
2870 * devclass (see devclass_get_parent()) if any.
2872 * @param dev the device to initialise
2875 * @retval ENXIO no driver was found
2876 * @retval ENOMEM memory allocation failure
2877 * @retval non-zero some other unix error code
2878 * @retval -1 Device already attached
2881 device_probe(device_t dev)
2887 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2890 if (!(dev->flags & DF_ENABLED)) {
2891 if (bootverbose && device_get_name(dev) != NULL) {
2892 device_print_prettyname(dev);
2893 printf("not probed (disabled)\n");
2897 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2898 if (bus_current_pass == BUS_PASS_DEFAULT &&
2899 !(dev->flags & DF_DONENOMATCH)) {
2900 BUS_PROBE_NOMATCH(dev->parent, dev);
2902 dev->flags |= DF_DONENOMATCH;
2910 * @brief Probe a device and attach a driver if possible
2912 * calls device_probe() and attaches if that was successful.
2915 device_probe_and_attach(device_t dev)
2921 error = device_probe(dev);
2924 else if (error != 0)
2927 CURVNET_SET_QUIET(vnet0);
2928 error = device_attach(dev);
2934 * @brief Attach a device driver to a device
2936 * This function is a wrapper around the DEVICE_ATTACH() driver
2937 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2938 * device's sysctl tree, optionally prints a description of the device
2939 * and queues a notification event for user-based device management
2942 * Normally this function is only called internally from
2943 * device_probe_and_attach().
2945 * @param dev the device to initialise
2948 * @retval ENXIO no driver was found
2949 * @retval ENOMEM memory allocation failure
2950 * @retval non-zero some other unix error code
2953 device_attach(device_t dev)
2955 uint64_t attachtime;
2956 uint16_t attachentropy;
2959 if (resource_disabled(dev->driver->name, dev->unit)) {
2960 device_disable(dev);
2962 device_printf(dev, "disabled via hints entry\n");
2966 device_sysctl_init(dev);
2967 if (!device_is_quiet(dev))
2968 device_print_child(dev->parent, dev);
2969 attachtime = get_cyclecount();
2970 dev->state = DS_ATTACHING;
2971 if ((error = DEVICE_ATTACH(dev)) != 0) {
2972 printf("device_attach: %s%d attach returned %d\n",
2973 dev->driver->name, dev->unit, error);
2974 if (!(dev->flags & DF_FIXEDCLASS))
2975 devclass_delete_device(dev->devclass, dev);
2976 (void)device_set_driver(dev, NULL);
2977 device_sysctl_fini(dev);
2978 KASSERT(dev->busy == 0, ("attach failed but busy"));
2979 dev->state = DS_NOTPRESENT;
2982 dev->flags |= DF_ATTACHED_ONCE;
2983 /* We only need the low bits of this time, but ranges from tens to thousands
2984 * have been seen, so keep 2 bytes' worth.
2986 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2987 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2988 device_sysctl_update(dev);
2990 dev->state = DS_BUSY;
2992 dev->state = DS_ATTACHED;
2993 dev->flags &= ~DF_DONENOMATCH;
2994 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3000 * @brief Detach a driver from a device
3002 * This function is a wrapper around the DEVICE_DETACH() driver
3003 * method. If the call to DEVICE_DETACH() succeeds, it calls
3004 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3005 * notification event for user-based device management services and
3006 * cleans up the device's sysctl tree.
3008 * @param dev the device to un-initialise
3011 * @retval ENXIO no driver was found
3012 * @retval ENOMEM memory allocation failure
3013 * @retval non-zero some other unix error code
3016 device_detach(device_t dev)
3022 PDEBUG(("%s", DEVICENAME(dev)));
3023 if (dev->state == DS_BUSY)
3025 if (dev->state == DS_ATTACHING) {
3026 device_printf(dev, "device in attaching state! Deferring detach.\n");
3029 if (dev->state != DS_ATTACHED)
3032 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3033 if ((error = DEVICE_DETACH(dev)) != 0) {
3034 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3035 EVHDEV_DETACH_FAILED);
3038 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3039 EVHDEV_DETACH_COMPLETE);
3042 if (!device_is_quiet(dev))
3043 device_printf(dev, "detached\n");
3045 BUS_CHILD_DETACHED(dev->parent, dev);
3047 if (!(dev->flags & DF_FIXEDCLASS))
3048 devclass_delete_device(dev->devclass, dev);
3050 device_verbose(dev);
3051 dev->state = DS_NOTPRESENT;
3052 (void)device_set_driver(dev, NULL);
3053 device_sysctl_fini(dev);
3059 * @brief Tells a driver to quiesce itself.
3061 * This function is a wrapper around the DEVICE_QUIESCE() driver
3062 * method. If the call to DEVICE_QUIESCE() succeeds.
3064 * @param dev the device to quiesce
3067 * @retval ENXIO no driver was found
3068 * @retval ENOMEM memory allocation failure
3069 * @retval non-zero some other unix error code
3072 device_quiesce(device_t dev)
3075 PDEBUG(("%s", DEVICENAME(dev)));
3076 if (dev->state == DS_BUSY)
3078 if (dev->state != DS_ATTACHED)
3081 return (DEVICE_QUIESCE(dev));
3085 * @brief Notify a device of system shutdown
3087 * This function calls the DEVICE_SHUTDOWN() driver method if the
3088 * device currently has an attached driver.
3090 * @returns the value returned by DEVICE_SHUTDOWN()
3093 device_shutdown(device_t dev)
3095 if (dev->state < DS_ATTACHED)
3097 return (DEVICE_SHUTDOWN(dev));
3101 * @brief Set the unit number of a device
3103 * This function can be used to override the unit number used for a
3104 * device (e.g. to wire a device to a pre-configured unit number).
3107 device_set_unit(device_t dev, int unit)
3112 dc = device_get_devclass(dev);
3113 if (unit < dc->maxunit && dc->devices[unit])
3115 err = devclass_delete_device(dc, dev);
3119 err = devclass_add_device(dc, dev);
3123 bus_data_generation_update();
3127 /*======================================*/
3129 * Some useful method implementations to make life easier for bus drivers.
3133 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3138 args->memattr = VM_MEMATTR_UNCACHEABLE;
3142 * @brief Initialise a resource list.
3144 * @param rl the resource list to initialise
3147 resource_list_init(struct resource_list *rl)
3153 * @brief Reclaim memory used by a resource list.
3155 * This function frees the memory for all resource entries on the list
3158 * @param rl the resource list to free
3161 resource_list_free(struct resource_list *rl)
3163 struct resource_list_entry *rle;
3165 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3167 panic("resource_list_free: resource entry is busy");
3168 STAILQ_REMOVE_HEAD(rl, link);
3174 * @brief Add a resource entry.
3176 * This function adds a resource entry using the given @p type, @p
3177 * start, @p end and @p count values. A rid value is chosen by
3178 * searching sequentially for the first unused rid starting at zero.
3180 * @param rl the resource list to edit
3181 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
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
3187 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3188 rman_res_t end, rman_res_t count)
3193 while (resource_list_find(rl, type, rid) != NULL)
3195 resource_list_add(rl, type, rid, start, end, count);
3200 * @brief Add or modify a resource entry.
3202 * If an existing entry exists with the same type and rid, it will be
3203 * modified using the given values of @p start, @p end and @p
3204 * count. If no entry exists, a new one will be created using the
3205 * given values. The resource list entry that matches is then returned.
3207 * @param rl the resource list to edit
3208 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3209 * @param rid the resource identifier
3210 * @param start the start address of the resource
3211 * @param end the end address of the resource
3212 * @param count XXX end-start+1
3214 struct resource_list_entry *
3215 resource_list_add(struct resource_list *rl, int type, int rid,
3216 rman_res_t start, rman_res_t end, rman_res_t count)
3218 struct resource_list_entry *rle;
3220 rle = resource_list_find(rl, type, rid);
3222 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3225 panic("resource_list_add: can't record entry");
3226 STAILQ_INSERT_TAIL(rl, rle, link);
3234 panic("resource_list_add: resource entry is busy");
3243 * @brief Determine if a resource entry is busy.
3245 * Returns true if a resource entry is busy meaning that it has an
3246 * associated resource that is not an unallocated "reserved" resource.
3248 * @param rl the resource list to search
3249 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3250 * @param rid the resource identifier
3252 * @returns Non-zero if the entry is busy, zero otherwise.
3255 resource_list_busy(struct resource_list *rl, int type, int rid)
3257 struct resource_list_entry *rle;
3259 rle = resource_list_find(rl, type, rid);
3260 if (rle == NULL || rle->res == NULL)
3262 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3263 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3264 ("reserved resource is active"));
3271 * @brief Determine if a resource entry is reserved.
3273 * Returns true if a resource entry is reserved meaning that it has an
3274 * associated "reserved" resource. The resource can either be
3275 * allocated or unallocated.
3277 * @param rl the resource list to search
3278 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3279 * @param rid the resource identifier
3281 * @returns Non-zero if the entry is reserved, zero otherwise.
3284 resource_list_reserved(struct resource_list *rl, int type, int rid)
3286 struct resource_list_entry *rle;
3288 rle = resource_list_find(rl, type, rid);
3289 if (rle != NULL && rle->flags & RLE_RESERVED)
3295 * @brief Find a resource entry by type and rid.
3297 * @param rl the resource list to search
3298 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3299 * @param rid the resource identifier
3301 * @returns the resource entry pointer or NULL if there is no such
3304 struct resource_list_entry *
3305 resource_list_find(struct resource_list *rl, int type, int rid)
3307 struct resource_list_entry *rle;
3309 STAILQ_FOREACH(rle, rl, link) {
3310 if (rle->type == type && rle->rid == rid)
3317 * @brief Delete a resource entry.
3319 * @param rl the resource list to edit
3320 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3321 * @param rid the resource identifier
3324 resource_list_delete(struct resource_list *rl, int type, int rid)
3326 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3329 if (rle->res != NULL)
3330 panic("resource_list_delete: resource has not been released");
3331 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3337 * @brief Allocate a reserved resource
3339 * This can be used by buses to force the allocation of resources
3340 * that are always active in the system even if they are not allocated
3341 * by a driver (e.g. PCI BARs). This function is usually called when
3342 * adding a new child to the bus. The resource is allocated from the
3343 * parent bus when it is reserved. The resource list entry is marked
3344 * with RLE_RESERVED to note that it is a reserved resource.
3346 * Subsequent attempts to allocate the resource with
3347 * resource_list_alloc() will succeed the first time and will set
3348 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3349 * resource that has been allocated is released with
3350 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3351 * the actual resource remains allocated. The resource can be released to
3352 * the parent bus by calling resource_list_unreserve().
3354 * @param rl the resource list to allocate from
3355 * @param bus the parent device of @p child
3356 * @param child the device for which the resource is being reserved
3357 * @param type the type of resource to allocate
3358 * @param rid a pointer to the resource identifier
3359 * @param start hint at the start of the resource range - pass
3360 * @c 0 for any start address
3361 * @param end hint at the end of the resource range - pass
3362 * @c ~0 for any end address
3363 * @param count hint at the size of range required - pass @c 1
3365 * @param flags any extra flags to control the resource
3366 * allocation - see @c RF_XXX flags in
3367 * <sys/rman.h> for details
3369 * @returns the resource which was allocated or @c NULL if no
3370 * resource could be allocated
3373 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3374 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3376 struct resource_list_entry *rle = NULL;
3377 int passthrough = (device_get_parent(child) != bus);
3382 "resource_list_reserve() should only be called for direct children");
3383 if (flags & RF_ACTIVE)
3385 "resource_list_reserve() should only reserve inactive resources");
3387 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3390 rle = resource_list_find(rl, type, *rid);
3391 rle->flags |= RLE_RESERVED;
3397 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3399 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3400 * and passing the allocation up to the parent of @p bus. This assumes
3401 * that the first entry of @c device_get_ivars(child) is a struct
3402 * resource_list. This also handles 'passthrough' allocations where a
3403 * child is a remote descendant of bus by passing the allocation up to
3404 * the parent of bus.
3406 * Typically, a bus driver would store a list of child resources
3407 * somewhere in the child device's ivars (see device_get_ivars()) and
3408 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3409 * then call resource_list_alloc() to perform the allocation.
3411 * @param rl the resource list to allocate from
3412 * @param bus the parent device of @p child
3413 * @param child the device which is requesting an allocation
3414 * @param type the type of resource to allocate
3415 * @param rid a pointer to the resource identifier
3416 * @param start hint at the start of the resource range - pass
3417 * @c 0 for any start address
3418 * @param end hint at the end of the resource range - pass
3419 * @c ~0 for any end address
3420 * @param count hint at the size of range required - pass @c 1
3422 * @param flags any extra flags to control the resource
3423 * allocation - see @c RF_XXX flags in
3424 * <sys/rman.h> for details
3426 * @returns the resource which was allocated or @c NULL if no
3427 * resource could be allocated
3430 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3431 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3433 struct resource_list_entry *rle = NULL;
3434 int passthrough = (device_get_parent(child) != bus);
3435 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3438 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3439 type, rid, start, end, count, flags));
3442 rle = resource_list_find(rl, type, *rid);
3445 return (NULL); /* no resource of that type/rid */
3448 if (rle->flags & RLE_RESERVED) {
3449 if (rle->flags & RLE_ALLOCATED)
3451 if ((flags & RF_ACTIVE) &&
3452 bus_activate_resource(child, type, *rid,
3455 rle->flags |= RLE_ALLOCATED;
3459 "resource entry %#x type %d for child %s is busy\n", *rid,
3460 type, device_get_nameunit(child));
3466 count = ulmax(count, rle->count);
3467 end = ulmax(rle->end, start + count - 1);
3470 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3471 type, rid, start, end, count, flags);
3474 * Record the new range.
3477 rle->start = rman_get_start(rle->res);
3478 rle->end = rman_get_end(rle->res);
3486 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3488 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3489 * used with resource_list_alloc().
3491 * @param rl the resource list which was allocated from
3492 * @param bus the parent device of @p child
3493 * @param child the device which is requesting a release
3494 * @param type the type of resource to release
3495 * @param rid the resource identifier
3496 * @param res the resource to release
3499 * @retval non-zero a standard unix error code indicating what
3500 * error condition prevented the operation
3503 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3504 int type, int rid, struct resource *res)
3506 struct resource_list_entry *rle = NULL;
3507 int passthrough = (device_get_parent(child) != bus);
3511 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3515 rle = resource_list_find(rl, type, rid);
3518 panic("resource_list_release: can't find resource");
3520 panic("resource_list_release: resource entry is not busy");
3521 if (rle->flags & RLE_RESERVED) {
3522 if (rle->flags & RLE_ALLOCATED) {
3523 if (rman_get_flags(res) & RF_ACTIVE) {
3524 error = bus_deactivate_resource(child, type,
3529 rle->flags &= ~RLE_ALLOCATED;
3535 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3545 * @brief Release all active resources of a given type
3547 * Release all active resources of a specified type. This is intended
3548 * to be used to cleanup resources leaked by a driver after detach or
3551 * @param rl the resource list which was allocated from
3552 * @param bus the parent device of @p child
3553 * @param child the device whose active resources are being released
3554 * @param type the type of resources to release
3557 * @retval EBUSY at least one resource was active
3560 resource_list_release_active(struct resource_list *rl, device_t bus,
3561 device_t child, int type)
3563 struct resource_list_entry *rle;
3567 STAILQ_FOREACH(rle, rl, link) {
3568 if (rle->type != type)
3570 if (rle->res == NULL)
3572 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3576 error = resource_list_release(rl, bus, child, type,
3577 rman_get_rid(rle->res), rle->res);
3580 "Failed to release active resource: %d\n", error);
3587 * @brief Fully release a reserved resource
3589 * Fully releases a resource reserved via resource_list_reserve().
3591 * @param rl the resource list which was allocated from
3592 * @param bus the parent device of @p child
3593 * @param child the device whose reserved resource is being released
3594 * @param type the type of resource to release
3595 * @param rid the resource identifier
3596 * @param res the resource to release
3599 * @retval non-zero a standard unix error code indicating what
3600 * error condition prevented the operation
3603 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3606 struct resource_list_entry *rle = NULL;
3607 int passthrough = (device_get_parent(child) != bus);
3611 "resource_list_unreserve() should only be called for direct children");
3613 rle = resource_list_find(rl, type, rid);
3616 panic("resource_list_unreserve: can't find resource");
3617 if (!(rle->flags & RLE_RESERVED))
3619 if (rle->flags & RLE_ALLOCATED)
3621 rle->flags &= ~RLE_RESERVED;
3622 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3626 * @brief Print a description of resources in a resource list
3628 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3629 * The name is printed if at least one resource of the given type is available.
3630 * The format is used to print resource start and end.
3632 * @param rl the resource list to print
3633 * @param name the name of @p type, e.g. @c "memory"
3634 * @param type type type of resource entry to print
3635 * @param format printf(9) format string to print resource
3636 * start and end values
3638 * @returns the number of characters printed
3641 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3644 struct resource_list_entry *rle;
3645 int printed, retval;
3649 /* Yes, this is kinda cheating */
3650 STAILQ_FOREACH(rle, rl, link) {
3651 if (rle->type == type) {
3653 retval += printf(" %s ", name);
3655 retval += printf(",");
3657 retval += printf(format, rle->start);
3658 if (rle->count > 1) {
3659 retval += printf("-");
3660 retval += printf(format, rle->start +
3669 * @brief Releases all the resources in a list.
3671 * @param rl The resource list to purge.
3676 resource_list_purge(struct resource_list *rl)
3678 struct resource_list_entry *rle;
3680 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3682 bus_release_resource(rman_get_device(rle->res),
3683 rle->type, rle->rid, rle->res);
3684 STAILQ_REMOVE_HEAD(rl, link);
3690 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3693 return (device_add_child_ordered(dev, order, name, unit));
3697 * @brief Helper function for implementing DEVICE_PROBE()
3699 * This function can be used to help implement the DEVICE_PROBE() for
3700 * a bus (i.e. a device which has other devices attached to it). It
3701 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3705 bus_generic_probe(device_t dev)
3707 devclass_t dc = dev->devclass;
3710 TAILQ_FOREACH(dl, &dc->drivers, link) {
3712 * If this driver's pass is too high, then ignore it.
3713 * For most drivers in the default pass, this will
3714 * never be true. For early-pass drivers they will
3715 * only call the identify routines of eligible drivers
3716 * when this routine is called. Drivers for later
3717 * passes should have their identify routines called
3718 * on early-pass buses during BUS_NEW_PASS().
3720 if (dl->pass > bus_current_pass)
3722 DEVICE_IDENTIFY(dl->driver, dev);
3729 * @brief Helper function for implementing DEVICE_ATTACH()
3731 * This function can be used to help implement the DEVICE_ATTACH() for
3732 * a bus. It calls device_probe_and_attach() for each of the device's
3736 bus_generic_attach(device_t dev)
3740 TAILQ_FOREACH(child, &dev->children, link) {
3741 device_probe_and_attach(child);
3748 * @brief Helper function for implementing DEVICE_DETACH()
3750 * This function can be used to help implement the DEVICE_DETACH() for
3751 * a bus. It calls device_detach() for each of the device's
3755 bus_generic_detach(device_t dev)
3760 if (dev->state != DS_ATTACHED)
3764 * Detach children in the reverse order.
3765 * See bus_generic_suspend for details.
3767 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3768 if ((error = device_detach(child)) != 0)
3776 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3778 * This function can be used to help implement the DEVICE_SHUTDOWN()
3779 * for a bus. It calls device_shutdown() for each of the device's
3783 bus_generic_shutdown(device_t dev)
3788 * Shut down children in the reverse order.
3789 * See bus_generic_suspend for details.
3791 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3792 device_shutdown(child);
3799 * @brief Default function for suspending a child device.
3801 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3804 bus_generic_suspend_child(device_t dev, device_t child)
3808 error = DEVICE_SUSPEND(child);
3811 child->flags |= DF_SUSPENDED;
3817 * @brief Default function for resuming a child device.
3819 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3822 bus_generic_resume_child(device_t dev, device_t child)
3825 DEVICE_RESUME(child);
3826 child->flags &= ~DF_SUSPENDED;
3832 * @brief Helper function for implementing DEVICE_SUSPEND()
3834 * This function can be used to help implement the DEVICE_SUSPEND()
3835 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3836 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3837 * operation is aborted and any devices which were suspended are
3838 * resumed immediately by calling their DEVICE_RESUME() methods.
3841 bus_generic_suspend(device_t dev)
3847 * Suspend children in the reverse order.
3848 * For most buses all children are equal, so the order does not matter.
3849 * Other buses, such as acpi, carefully order their child devices to
3850 * express implicit dependencies between them. For such buses it is
3851 * safer to bring down devices in the reverse order.
3853 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3854 error = BUS_SUSPEND_CHILD(dev, child);
3856 child = TAILQ_NEXT(child, link);
3857 if (child != NULL) {
3858 TAILQ_FOREACH_FROM(child, &dev->children, link)
3859 BUS_RESUME_CHILD(dev, child);
3868 * @brief Helper function for implementing DEVICE_RESUME()
3870 * This function can be used to help implement the DEVICE_RESUME() for
3871 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3874 bus_generic_resume(device_t dev)
3878 TAILQ_FOREACH(child, &dev->children, link) {
3879 BUS_RESUME_CHILD(dev, child);
3880 /* if resume fails, there's nothing we can usefully do... */
3887 * @brief Helper function for implementing BUS_RESET_POST
3889 * Bus can use this function to implement common operations of
3890 * re-attaching or resuming the children after the bus itself was
3891 * reset, and after restoring bus-unique state of children.
3893 * @param dev The bus
3894 * #param flags DEVF_RESET_*
3897 bus_helper_reset_post(device_t dev, int flags)
3903 TAILQ_FOREACH(child, &dev->children,link) {
3904 BUS_RESET_POST(dev, child);
3905 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3906 device_probe_and_attach(child) :
3907 BUS_RESUME_CHILD(dev, child);
3908 if (error == 0 && error1 != 0)
3915 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3918 child = TAILQ_NEXT(child, link);
3921 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3922 BUS_RESET_POST(dev, child);
3923 if ((flags & DEVF_RESET_DETACH) != 0)
3924 device_probe_and_attach(child);
3926 BUS_RESUME_CHILD(dev, child);
3931 * @brief Helper function for implementing BUS_RESET_PREPARE
3933 * Bus can use this function to implement common operations of
3934 * detaching or suspending the children before the bus itself is
3935 * reset, and then save bus-unique state of children that must
3936 * persists around reset.
3938 * @param dev The bus
3939 * #param flags DEVF_RESET_*
3942 bus_helper_reset_prepare(device_t dev, int flags)
3947 if (dev->state != DS_ATTACHED)
3950 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3951 if ((flags & DEVF_RESET_DETACH) != 0) {
3952 error = device_get_state(child) == DS_ATTACHED ?
3953 device_detach(child) : 0;
3955 error = BUS_SUSPEND_CHILD(dev, child);
3958 error = BUS_RESET_PREPARE(dev, child);
3960 if ((flags & DEVF_RESET_DETACH) != 0)
3961 device_probe_and_attach(child);
3963 BUS_RESUME_CHILD(dev, child);
3967 bus_helper_reset_prepare_rollback(dev, child, flags);
3975 * @brief Helper function for implementing BUS_PRINT_CHILD().
3977 * This function prints the first part of the ascii representation of
3978 * @p child, including its name, unit and description (if any - see
3979 * device_set_desc()).
3981 * @returns the number of characters printed
3984 bus_print_child_header(device_t dev, device_t child)
3988 if (device_get_desc(child)) {
3989 retval += device_printf(child, "<%s>", device_get_desc(child));
3991 retval += printf("%s", device_get_nameunit(child));
3998 * @brief Helper function for implementing BUS_PRINT_CHILD().
4000 * This function prints the last part of the ascii representation of
4001 * @p child, which consists of the string @c " on " followed by the
4002 * name and unit of the @p dev.
4004 * @returns the number of characters printed
4007 bus_print_child_footer(device_t dev, device_t child)
4009 return (printf(" on %s\n", device_get_nameunit(dev)));
4013 * @brief Helper function for implementing BUS_PRINT_CHILD().
4015 * This function prints out the VM domain for the given device.
4017 * @returns the number of characters printed
4020 bus_print_child_domain(device_t dev, device_t child)
4024 /* No domain? Don't print anything */
4025 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4028 return (printf(" numa-domain %d", domain));
4032 * @brief Helper function for implementing BUS_PRINT_CHILD().
4034 * This function simply calls bus_print_child_header() followed by
4035 * bus_print_child_footer().
4037 * @returns the number of characters printed
4040 bus_generic_print_child(device_t dev, device_t child)
4044 retval += bus_print_child_header(dev, child);
4045 retval += bus_print_child_domain(dev, child);
4046 retval += bus_print_child_footer(dev, child);
4052 * @brief Stub function for implementing BUS_READ_IVAR().
4057 bus_generic_read_ivar(device_t dev, device_t child, int index,
4064 * @brief Stub function for implementing BUS_WRITE_IVAR().
4069 bus_generic_write_ivar(device_t dev, device_t child, int index,
4076 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4080 struct resource_list *
4081 bus_generic_get_resource_list(device_t dev, device_t child)
4087 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4089 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4090 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4091 * and then calls device_probe_and_attach() for each unattached child.
4094 bus_generic_driver_added(device_t dev, driver_t *driver)
4098 DEVICE_IDENTIFY(driver, dev);
4099 TAILQ_FOREACH(child, &dev->children, link) {
4100 if (child->state == DS_NOTPRESENT ||
4101 (child->flags & DF_REBID))
4102 device_probe_and_attach(child);
4107 * @brief Helper function for implementing BUS_NEW_PASS().
4109 * This implementing of BUS_NEW_PASS() first calls the identify
4110 * routines for any drivers that probe at the current pass. Then it
4111 * walks the list of devices for this bus. If a device is already
4112 * attached, then it calls BUS_NEW_PASS() on that device. If the
4113 * device is not already attached, it attempts to attach a driver to
4117 bus_generic_new_pass(device_t dev)
4124 TAILQ_FOREACH(dl, &dc->drivers, link) {
4125 if (dl->pass == bus_current_pass)
4126 DEVICE_IDENTIFY(dl->driver, dev);
4128 TAILQ_FOREACH(child, &dev->children, link) {
4129 if (child->state >= DS_ATTACHED)
4130 BUS_NEW_PASS(child);
4131 else if (child->state == DS_NOTPRESENT)
4132 device_probe_and_attach(child);
4137 * @brief Helper function for implementing BUS_SETUP_INTR().
4139 * This simple implementation of BUS_SETUP_INTR() simply calls the
4140 * BUS_SETUP_INTR() method of the parent of @p dev.
4143 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4144 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4147 /* Propagate up the bus hierarchy until someone handles it. */
4149 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4150 filter, intr, arg, cookiep));
4155 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4157 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4158 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4161 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4164 /* Propagate up the bus hierarchy until someone handles it. */
4166 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4171 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4173 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4174 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4177 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4179 /* Propagate up the bus hierarchy until someone handles it. */
4181 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4186 * @brief Helper function for implementing BUS_RESUME_INTR().
4188 * This simple implementation of BUS_RESUME_INTR() simply calls the
4189 * BUS_RESUME_INTR() method of the parent of @p dev.
4192 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4194 /* Propagate up the bus hierarchy until someone handles it. */
4196 return (BUS_RESUME_INTR(dev->parent, child, irq));
4201 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4203 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4204 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4207 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4208 struct resource *r, rman_res_t start, rman_res_t end)
4210 /* Propagate up the bus hierarchy until someone handles it. */
4212 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4218 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4220 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4221 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4224 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4225 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4227 /* Propagate up the bus hierarchy until someone handles it. */
4229 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4230 start, end, count, flags));
4235 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4237 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4238 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4241 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4244 /* Propagate up the bus hierarchy until someone handles it. */
4246 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4252 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4254 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4255 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4258 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4261 /* Propagate up the bus hierarchy until someone handles it. */
4263 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4269 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4271 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4272 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4275 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4276 int rid, struct resource *r)
4278 /* Propagate up the bus hierarchy until someone handles it. */
4280 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4286 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4288 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4289 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4292 bus_generic_map_resource(device_t dev, device_t child, int type,
4293 struct resource *r, struct resource_map_request *args,
4294 struct resource_map *map)
4296 /* Propagate up the bus hierarchy until someone handles it. */
4298 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4304 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4306 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4307 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4310 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4311 struct resource *r, struct resource_map *map)
4313 /* Propagate up the bus hierarchy until someone handles it. */
4315 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4320 * @brief Helper function for implementing BUS_BIND_INTR().
4322 * This simple implementation of BUS_BIND_INTR() simply calls the
4323 * BUS_BIND_INTR() method of the parent of @p dev.
4326 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4330 /* Propagate up the bus hierarchy until someone handles it. */
4332 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4337 * @brief Helper function for implementing BUS_CONFIG_INTR().
4339 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4340 * BUS_CONFIG_INTR() method of the parent of @p dev.
4343 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4344 enum intr_polarity pol)
4347 /* Propagate up the bus hierarchy until someone handles it. */
4349 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4354 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4356 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4357 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4360 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4361 void *cookie, const char *descr)
4364 /* Propagate up the bus hierarchy until someone handles it. */
4366 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4372 * @brief Helper function for implementing BUS_GET_CPUS().
4374 * This simple implementation of BUS_GET_CPUS() simply calls the
4375 * BUS_GET_CPUS() method of the parent of @p dev.
4378 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4379 size_t setsize, cpuset_t *cpuset)
4382 /* Propagate up the bus hierarchy until someone handles it. */
4383 if (dev->parent != NULL)
4384 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4389 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4391 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4392 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4395 bus_generic_get_dma_tag(device_t dev, device_t child)
4398 /* Propagate up the bus hierarchy until someone handles it. */
4399 if (dev->parent != NULL)
4400 return (BUS_GET_DMA_TAG(dev->parent, child));
4405 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4407 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4408 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4411 bus_generic_get_bus_tag(device_t dev, device_t child)
4414 /* Propagate up the bus hierarchy until someone handles it. */
4415 if (dev->parent != NULL)
4416 return (BUS_GET_BUS_TAG(dev->parent, child));
4417 return ((bus_space_tag_t)0);
4421 * @brief Helper function for implementing BUS_GET_RESOURCE().
4423 * This implementation of BUS_GET_RESOURCE() uses the
4424 * resource_list_find() function to do most of the work. It calls
4425 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4429 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4430 rman_res_t *startp, rman_res_t *countp)
4432 struct resource_list * rl = NULL;
4433 struct resource_list_entry * rle = NULL;
4435 rl = BUS_GET_RESOURCE_LIST(dev, child);
4439 rle = resource_list_find(rl, type, rid);
4444 *startp = rle->start;
4446 *countp = rle->count;
4452 * @brief Helper function for implementing BUS_SET_RESOURCE().
4454 * This implementation of BUS_SET_RESOURCE() uses the
4455 * resource_list_add() function to do most of the work. It calls
4456 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4460 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4461 rman_res_t start, rman_res_t count)
4463 struct resource_list * rl = NULL;
4465 rl = BUS_GET_RESOURCE_LIST(dev, child);
4469 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4475 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4477 * This implementation of BUS_DELETE_RESOURCE() uses the
4478 * resource_list_delete() function to do most of the work. It calls
4479 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4483 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4485 struct resource_list * rl = NULL;
4487 rl = BUS_GET_RESOURCE_LIST(dev, child);
4491 resource_list_delete(rl, type, rid);
4497 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4499 * This implementation of BUS_RELEASE_RESOURCE() uses the
4500 * resource_list_release() function to do most of the work. It calls
4501 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4504 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4505 int rid, struct resource *r)
4507 struct resource_list * rl = NULL;
4509 if (device_get_parent(child) != dev)
4510 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4513 rl = BUS_GET_RESOURCE_LIST(dev, child);
4517 return (resource_list_release(rl, dev, child, type, rid, r));
4521 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4523 * This implementation of BUS_ALLOC_RESOURCE() uses the
4524 * resource_list_alloc() function to do most of the work. It calls
4525 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4528 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4529 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4531 struct resource_list * rl = NULL;
4533 if (device_get_parent(child) != dev)
4534 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4535 type, rid, start, end, count, flags));
4537 rl = BUS_GET_RESOURCE_LIST(dev, child);
4541 return (resource_list_alloc(rl, dev, child, type, rid,
4542 start, end, count, flags));
4546 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4548 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4549 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4552 bus_generic_child_present(device_t dev, device_t child)
4554 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4558 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4562 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4568 * @brief Helper function for implementing BUS_RESCAN().
4570 * This null implementation of BUS_RESCAN() always fails to indicate
4571 * the bus does not support rescanning.
4574 bus_null_rescan(device_t dev)
4581 * Some convenience functions to make it easier for drivers to use the
4582 * resource-management functions. All these really do is hide the
4583 * indirection through the parent's method table, making for slightly
4584 * less-wordy code. In the future, it might make sense for this code
4585 * to maintain some sort of a list of resources allocated by each device.
4589 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4590 struct resource **res)
4594 for (i = 0; rs[i].type != -1; i++)
4596 for (i = 0; rs[i].type != -1; i++) {
4597 res[i] = bus_alloc_resource_any(dev,
4598 rs[i].type, &rs[i].rid, rs[i].flags);
4599 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4600 bus_release_resources(dev, rs, res);
4608 bus_release_resources(device_t dev, const struct resource_spec *rs,
4609 struct resource **res)
4613 for (i = 0; rs[i].type != -1; i++)
4614 if (res[i] != NULL) {
4615 bus_release_resource(
4616 dev, rs[i].type, rs[i].rid, res[i]);
4622 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4624 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4628 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4629 rman_res_t end, rman_res_t count, u_int flags)
4631 struct resource *res;
4633 if (dev->parent == NULL)
4635 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4641 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4643 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4647 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4650 if (dev->parent == NULL)
4652 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4656 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4658 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4662 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4664 if (dev->parent == NULL)
4666 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4670 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4672 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4676 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4678 if (dev->parent == NULL)
4680 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4684 * @brief Wrapper function for BUS_MAP_RESOURCE().
4686 * This function simply calls the BUS_MAP_RESOURCE() method of the
4690 bus_map_resource(device_t dev, int type, struct resource *r,
4691 struct resource_map_request *args, struct resource_map *map)
4693 if (dev->parent == NULL)
4695 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4699 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4701 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4705 bus_unmap_resource(device_t dev, int type, struct resource *r,
4706 struct resource_map *map)
4708 if (dev->parent == NULL)
4710 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4714 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4716 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4720 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4724 if (dev->parent == NULL)
4726 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4731 * @brief Wrapper function for BUS_SETUP_INTR().
4733 * This function simply calls the BUS_SETUP_INTR() method of the
4737 bus_setup_intr(device_t dev, struct resource *r, int flags,
4738 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4742 if (dev->parent == NULL)
4744 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4748 if (handler != NULL && !(flags & INTR_MPSAFE))
4749 device_printf(dev, "[GIANT-LOCKED]\n");
4754 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4756 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4760 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4762 if (dev->parent == NULL)
4764 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4768 * @brief Wrapper function for BUS_SUSPEND_INTR().
4770 * This function simply calls the BUS_SUSPEND_INTR() method of the
4774 bus_suspend_intr(device_t dev, struct resource *r)
4776 if (dev->parent == NULL)
4778 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4782 * @brief Wrapper function for BUS_RESUME_INTR().
4784 * This function simply calls the BUS_RESUME_INTR() method of the
4788 bus_resume_intr(device_t dev, struct resource *r)
4790 if (dev->parent == NULL)
4792 return (BUS_RESUME_INTR(dev->parent, dev, r));
4796 * @brief Wrapper function for BUS_BIND_INTR().
4798 * This function simply calls the BUS_BIND_INTR() method of the
4802 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4804 if (dev->parent == NULL)
4806 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4810 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4812 * This function first formats the requested description into a
4813 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4814 * the parent of @p dev.
4817 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4818 const char *fmt, ...)
4821 char descr[MAXCOMLEN + 1];
4823 if (dev->parent == NULL)
4826 vsnprintf(descr, sizeof(descr), fmt, ap);
4828 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4832 * @brief Wrapper function for BUS_SET_RESOURCE().
4834 * This function simply calls the BUS_SET_RESOURCE() method of the
4838 bus_set_resource(device_t dev, int type, int rid,
4839 rman_res_t start, rman_res_t count)
4841 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4846 * @brief Wrapper function for BUS_GET_RESOURCE().
4848 * This function simply calls the BUS_GET_RESOURCE() method of the
4852 bus_get_resource(device_t dev, int type, int rid,
4853 rman_res_t *startp, rman_res_t *countp)
4855 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4860 * @brief Wrapper function for BUS_GET_RESOURCE().
4862 * This function simply calls the BUS_GET_RESOURCE() method of the
4863 * parent of @p dev and returns the start value.
4866 bus_get_resource_start(device_t dev, int type, int rid)
4872 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4880 * @brief Wrapper function for BUS_GET_RESOURCE().
4882 * This function simply calls the BUS_GET_RESOURCE() method of the
4883 * parent of @p dev and returns the count value.
4886 bus_get_resource_count(device_t dev, int type, int rid)
4892 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4900 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4902 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4906 bus_delete_resource(device_t dev, int type, int rid)
4908 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4912 * @brief Wrapper function for BUS_CHILD_PRESENT().
4914 * This function simply calls the BUS_CHILD_PRESENT() method of the
4918 bus_child_present(device_t child)
4920 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4924 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4926 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4930 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4934 parent = device_get_parent(child);
4935 if (parent == NULL) {
4939 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4943 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4945 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4949 bus_child_location_str(device_t child, char *buf, size_t buflen)
4953 parent = device_get_parent(child);
4954 if (parent == NULL) {
4958 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4962 * @brief Wrapper function for BUS_GET_CPUS().
4964 * This function simply calls the BUS_GET_CPUS() method of the
4968 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4972 parent = device_get_parent(dev);
4975 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4979 * @brief Wrapper function for BUS_GET_DMA_TAG().
4981 * This function simply calls the BUS_GET_DMA_TAG() method of the
4985 bus_get_dma_tag(device_t dev)
4989 parent = device_get_parent(dev);
4992 return (BUS_GET_DMA_TAG(parent, dev));
4996 * @brief Wrapper function for BUS_GET_BUS_TAG().
4998 * This function simply calls the BUS_GET_BUS_TAG() method of the
5002 bus_get_bus_tag(device_t dev)
5006 parent = device_get_parent(dev);
5008 return ((bus_space_tag_t)0);
5009 return (BUS_GET_BUS_TAG(parent, dev));
5013 * @brief Wrapper function for BUS_GET_DOMAIN().
5015 * This function simply calls the BUS_GET_DOMAIN() method of the
5019 bus_get_domain(device_t dev, int *domain)
5021 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5024 /* Resume all devices and then notify userland that we're up again. */
5026 root_resume(device_t dev)
5030 error = bus_generic_resume(dev);
5032 devctl_notify("kern", "power", "resume", NULL);
5037 root_print_child(device_t dev, device_t child)
5041 retval += bus_print_child_header(dev, child);
5042 retval += printf("\n");
5048 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5049 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5052 * If an interrupt mapping gets to here something bad has happened.
5054 panic("root_setup_intr");
5058 * If we get here, assume that the device is permanent and really is
5059 * present in the system. Removable bus drivers are expected to intercept
5060 * this call long before it gets here. We return -1 so that drivers that
5061 * really care can check vs -1 or some ERRNO returned higher in the food
5065 root_child_present(device_t dev, device_t child)
5071 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5077 /* Default to returning the set of all CPUs. */
5078 if (setsize != sizeof(cpuset_t))
5087 static kobj_method_t root_methods[] = {
5088 /* Device interface */
5089 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5090 KOBJMETHOD(device_suspend, bus_generic_suspend),
5091 KOBJMETHOD(device_resume, root_resume),
5094 KOBJMETHOD(bus_print_child, root_print_child),
5095 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5096 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5097 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5098 KOBJMETHOD(bus_child_present, root_child_present),
5099 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5104 static driver_t root_driver = {
5111 devclass_t root_devclass;
5114 root_bus_module_handler(module_t mod, int what, void* arg)
5118 TAILQ_INIT(&bus_data_devices);
5119 kobj_class_compile((kobj_class_t) &root_driver);
5120 root_bus = make_device(NULL, "root", 0);
5121 root_bus->desc = "System root bus";
5122 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5123 root_bus->driver = &root_driver;
5124 root_bus->state = DS_ATTACHED;
5125 root_devclass = devclass_find_internal("root", NULL, FALSE);
5130 device_shutdown(root_bus);
5133 return (EOPNOTSUPP);
5139 static moduledata_t root_bus_mod = {
5141 root_bus_module_handler,
5144 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5147 * @brief Automatically configure devices
5149 * This function begins the autoconfiguration process by calling
5150 * device_probe_and_attach() for each child of the @c root0 device.
5153 root_bus_configure(void)
5158 /* Eventually this will be split up, but this is sufficient for now. */
5159 bus_set_pass(BUS_PASS_DEFAULT);
5163 * @brief Module handler for registering device drivers
5165 * This module handler is used to automatically register device
5166 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5167 * devclass_add_driver() for the driver described by the
5168 * driver_module_data structure pointed to by @p arg
5171 driver_module_handler(module_t mod, int what, void *arg)
5173 struct driver_module_data *dmd;
5174 devclass_t bus_devclass;
5175 kobj_class_t driver;
5178 dmd = (struct driver_module_data *)arg;
5179 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5184 if (dmd->dmd_chainevh)
5185 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5187 pass = dmd->dmd_pass;
5188 driver = dmd->dmd_driver;
5189 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5190 DRIVERNAME(driver), dmd->dmd_busname, pass));
5191 error = devclass_add_driver(bus_devclass, driver, pass,
5196 PDEBUG(("Unloading module: driver %s from bus %s",
5197 DRIVERNAME(dmd->dmd_driver),
5199 error = devclass_delete_driver(bus_devclass,
5202 if (!error && dmd->dmd_chainevh)
5203 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5206 PDEBUG(("Quiesce module: driver %s from bus %s",
5207 DRIVERNAME(dmd->dmd_driver),
5209 error = devclass_quiesce_driver(bus_devclass,
5212 if (!error && dmd->dmd_chainevh)
5213 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5224 * @brief Enumerate all hinted devices for this bus.
5226 * Walks through the hints for this bus and calls the bus_hinted_child
5227 * routine for each one it fines. It searches first for the specific
5228 * bus that's being probed for hinted children (eg isa0), and then for
5229 * generic children (eg isa).
5231 * @param dev bus device to enumerate
5234 bus_enumerate_hinted_children(device_t bus)
5237 const char *dname, *busname;
5241 * enumerate all devices on the specific bus
5243 busname = device_get_nameunit(bus);
5245 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5246 BUS_HINTED_CHILD(bus, dname, dunit);
5249 * and all the generic ones.
5251 busname = device_get_name(bus);
5253 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5254 BUS_HINTED_CHILD(bus, dname, dunit);
5259 /* the _short versions avoid iteration by not calling anything that prints
5260 * more than oneliners. I love oneliners.
5264 print_device_short(device_t dev, int indent)
5269 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5270 dev->unit, dev->desc,
5271 (dev->parent? "":"no "),
5272 (TAILQ_EMPTY(&dev->children)? "no ":""),
5273 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5274 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5275 (dev->flags&DF_WILDCARD? "wildcard,":""),
5276 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5277 (dev->flags&DF_REBID? "rebiddable,":""),
5278 (dev->flags&DF_SUSPENDED? "suspended,":""),
5279 (dev->ivars? "":"no "),
5280 (dev->softc? "":"no "),
5285 print_device(device_t dev, int indent)
5290 print_device_short(dev, indent);
5292 indentprintf(("Parent:\n"));
5293 print_device_short(dev->parent, indent+1);
5294 indentprintf(("Driver:\n"));
5295 print_driver_short(dev->driver, indent+1);
5296 indentprintf(("Devclass:\n"));
5297 print_devclass_short(dev->devclass, indent+1);
5301 print_device_tree_short(device_t dev, int indent)
5302 /* print the device and all its children (indented) */
5309 print_device_short(dev, indent);
5311 TAILQ_FOREACH(child, &dev->children, link) {
5312 print_device_tree_short(child, indent+1);
5317 print_device_tree(device_t dev, int indent)
5318 /* print the device and all its children (indented) */
5325 print_device(dev, indent);
5327 TAILQ_FOREACH(child, &dev->children, link) {
5328 print_device_tree(child, indent+1);
5333 print_driver_short(driver_t *driver, int indent)
5338 indentprintf(("driver %s: softc size = %zd\n",
5339 driver->name, driver->size));
5343 print_driver(driver_t *driver, int indent)
5348 print_driver_short(driver, indent);
5352 print_driver_list(driver_list_t drivers, int indent)
5354 driverlink_t driver;
5356 TAILQ_FOREACH(driver, &drivers, link) {
5357 print_driver(driver->driver, indent);
5362 print_devclass_short(devclass_t dc, int indent)
5367 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5371 print_devclass(devclass_t dc, int indent)
5378 print_devclass_short(dc, indent);
5379 indentprintf(("Drivers:\n"));
5380 print_driver_list(dc->drivers, indent+1);
5382 indentprintf(("Devices:\n"));
5383 for (i = 0; i < dc->maxunit; i++)
5385 print_device(dc->devices[i], indent+1);
5389 print_devclass_list_short(void)
5393 printf("Short listing of devclasses, drivers & devices:\n");
5394 TAILQ_FOREACH(dc, &devclasses, link) {
5395 print_devclass_short(dc, 0);
5400 print_devclass_list(void)
5404 printf("Full listing of devclasses, drivers & devices:\n");
5405 TAILQ_FOREACH(dc, &devclasses, link) {
5406 print_devclass(dc, 0);
5413 * User-space access to the device tree.
5415 * We implement a small set of nodes:
5417 * hw.bus Single integer read method to obtain the
5418 * current generation count.
5419 * hw.bus.devices Reads the entire device tree in flat space.
5420 * hw.bus.rman Resource manager interface
5422 * We might like to add the ability to scan devclasses and/or drivers to
5423 * determine what else is currently loaded/available.
5427 sysctl_bus(SYSCTL_HANDLER_ARGS)
5429 struct u_businfo ubus;
5431 ubus.ub_version = BUS_USER_VERSION;
5432 ubus.ub_generation = bus_data_generation;
5434 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5436 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5437 "bus-related data");
5440 sysctl_devices(SYSCTL_HANDLER_ARGS)
5442 int *name = (int *)arg1;
5443 u_int namelen = arg2;
5446 struct u_device *udev;
5453 if (bus_data_generation_check(name[0]))
5459 * Scan the list of devices, looking for the requested index.
5461 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5469 * Populate the return item, careful not to overflow the buffer.
5471 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5474 udev->dv_handle = (uintptr_t)dev;
5475 udev->dv_parent = (uintptr_t)dev->parent;
5476 udev->dv_devflags = dev->devflags;
5477 udev->dv_flags = dev->flags;
5478 udev->dv_state = dev->state;
5479 walker = udev->dv_fields;
5480 ep = walker + sizeof(udev->dv_fields);
5482 if ((src) == NULL) \
5485 strlcpy(walker, (src), ep - walker); \
5486 walker += strlen(walker) + 1; \
5494 CP(dev->driver != NULL ? dev->driver->name : NULL);
5495 bus_child_pnpinfo_str(dev, walker, ep - walker);
5496 walker += strlen(walker) + 1;
5499 bus_child_location_str(dev, walker, ep - walker);
5500 walker += strlen(walker) + 1;
5506 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5511 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5512 "system device tree");
5515 bus_data_generation_check(int generation)
5517 if (generation != bus_data_generation)
5520 /* XXX generate optimised lists here? */
5525 bus_data_generation_update(void)
5527 bus_data_generation++;
5531 bus_free_resource(device_t dev, int type, struct resource *r)
5535 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5539 device_lookup_by_name(const char *name)
5543 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5544 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5551 * /dev/devctl2 implementation. The existing /dev/devctl device has
5552 * implicit semantics on open, so it could not be reused for this.
5553 * Another option would be to call this /dev/bus?
5556 find_device(struct devreq *req, device_t *devp)
5561 * First, ensure that the name is nul terminated.
5563 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5567 * Second, try to find an attached device whose name matches
5570 dev = device_lookup_by_name(req->dr_name);
5576 /* Finally, give device enumerators a chance. */
5578 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5586 driver_exists(device_t bus, const char *driver)
5590 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5591 if (devclass_find_driver_internal(dc, driver) != NULL)
5598 device_gen_nomatch(device_t dev)
5602 if (dev->flags & DF_NEEDNOMATCH &&
5603 dev->state == DS_NOTPRESENT) {
5604 BUS_PROBE_NOMATCH(dev->parent, dev);
5606 dev->flags |= DF_DONENOMATCH;
5608 dev->flags &= ~DF_NEEDNOMATCH;
5609 TAILQ_FOREACH(child, &dev->children, link) {
5610 device_gen_nomatch(child);
5615 device_do_deferred_actions(void)
5621 * Walk through the devclasses to find all the drivers we've tagged as
5622 * deferred during the freeze and call the driver added routines. They
5623 * have already been added to the lists in the background, so the driver
5624 * added routines that trigger a probe will have all the right bidders
5625 * for the probe auction.
5627 TAILQ_FOREACH(dc, &devclasses, link) {
5628 TAILQ_FOREACH(dl, &dc->drivers, link) {
5629 if (dl->flags & DL_DEFERRED_PROBE) {
5630 devclass_driver_added(dc, dl->driver);
5631 dl->flags &= ~DL_DEFERRED_PROBE;
5637 * We also defer no-match events during a freeze. Walk the tree and
5638 * generate all the pent-up events that are still relevant.
5640 device_gen_nomatch(root_bus);
5641 bus_data_generation_update();
5645 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5652 /* Locate the device to control. */
5654 req = (struct devreq *)data;
5662 case DEV_SET_DRIVER:
5663 case DEV_CLEAR_DRIVER:
5667 error = priv_check(td, PRIV_DRIVER);
5669 error = find_device(req, &dev);
5673 error = priv_check(td, PRIV_DRIVER);
5684 /* Perform the requested operation. */
5687 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5689 else if (!device_is_enabled(dev))
5692 error = device_probe_and_attach(dev);
5695 if (!device_is_attached(dev)) {
5699 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5700 error = device_quiesce(dev);
5704 error = device_detach(dev);
5707 if (device_is_enabled(dev)) {
5713 * If the device has been probed but not attached (e.g.
5714 * when it has been disabled by a loader hint), just
5715 * attach the device rather than doing a full probe.
5718 if (device_is_alive(dev)) {
5720 * If the device was disabled via a hint, clear
5723 if (resource_disabled(dev->driver->name, dev->unit))
5724 resource_unset_value(dev->driver->name,
5725 dev->unit, "disabled");
5726 error = device_attach(dev);
5728 error = device_probe_and_attach(dev);
5731 if (!device_is_enabled(dev)) {
5736 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5737 error = device_quiesce(dev);
5743 * Force DF_FIXEDCLASS on around detach to preserve
5744 * the existing name.
5747 dev->flags |= DF_FIXEDCLASS;
5748 error = device_detach(dev);
5749 if (!(old & DF_FIXEDCLASS))
5750 dev->flags &= ~DF_FIXEDCLASS;
5752 device_disable(dev);
5755 if (device_is_suspended(dev)) {
5759 if (device_get_parent(dev) == NULL) {
5763 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5766 if (!device_is_suspended(dev)) {
5770 if (device_get_parent(dev) == NULL) {
5774 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5776 case DEV_SET_DRIVER: {
5780 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5783 if (driver[0] == '\0') {
5787 if (dev->devclass != NULL &&
5788 strcmp(driver, dev->devclass->name) == 0)
5789 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5793 * Scan drivers for this device's bus looking for at
5794 * least one matching driver.
5796 if (dev->parent == NULL) {
5800 if (!driver_exists(dev->parent, driver)) {
5804 dc = devclass_create(driver);
5810 /* Detach device if necessary. */
5811 if (device_is_attached(dev)) {
5812 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5813 error = device_detach(dev);
5820 /* Clear any previously-fixed device class and unit. */
5821 if (dev->flags & DF_FIXEDCLASS)
5822 devclass_delete_device(dev->devclass, dev);
5823 dev->flags |= DF_WILDCARD;
5826 /* Force the new device class. */
5827 error = devclass_add_device(dc, dev);
5830 dev->flags |= DF_FIXEDCLASS;
5831 error = device_probe_and_attach(dev);
5834 case DEV_CLEAR_DRIVER:
5835 if (!(dev->flags & DF_FIXEDCLASS)) {
5839 if (device_is_attached(dev)) {
5840 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5841 error = device_detach(dev);
5848 dev->flags &= ~DF_FIXEDCLASS;
5849 dev->flags |= DF_WILDCARD;
5850 devclass_delete_device(dev->devclass, dev);
5851 error = device_probe_and_attach(dev);
5854 if (!device_is_attached(dev)) {
5858 error = BUS_RESCAN(dev);
5863 parent = device_get_parent(dev);
5864 if (parent == NULL) {
5868 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5869 if (bus_child_present(dev) != 0) {
5875 error = device_delete_child(parent, dev);
5882 device_frozen = true;
5888 device_do_deferred_actions();
5889 device_frozen = false;
5893 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5897 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5905 static struct cdevsw devctl2_cdevsw = {
5906 .d_version = D_VERSION,
5907 .d_ioctl = devctl2_ioctl,
5908 .d_name = "devctl2",
5915 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5916 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5920 * APIs to manage deprecation and obsolescence.
5922 static int obsolete_panic = 0;
5923 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5924 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5925 "2 = if deprecated)");
5928 gone_panic(int major, int running, const char *msg)
5931 switch (obsolete_panic)
5936 if (running < major)
5945 _gone_in(int major, const char *msg)
5948 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5949 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5950 printf("Obsolete code will removed soon: %s\n", msg);
5952 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5957 _gone_in_dev(device_t dev, int major, const char *msg)
5960 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5961 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5963 "Obsolete code will removed soon: %s\n", msg);
5966 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5971 DB_SHOW_COMMAND(device, db_show_device)
5978 dev = (device_t)addr;
5980 db_printf("name: %s\n", device_get_nameunit(dev));
5981 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5982 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5983 db_printf(" addr: %p\n", dev);
5984 db_printf(" parent: %p\n", dev->parent);
5985 db_printf(" softc: %p\n", dev->softc);
5986 db_printf(" ivars: %p\n", dev->ivars);
5989 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5993 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5994 db_show_device((db_expr_t)dev, true, count, modif);