2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
77 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
81 * Used to attach drivers to devclasses.
83 typedef struct driverlink *driverlink_t;
86 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
89 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
90 TAILQ_ENTRY(driverlink) passlink;
94 * Forward declarations
96 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
97 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
98 typedef TAILQ_HEAD(device_list, device) device_list_t;
101 TAILQ_ENTRY(devclass) link;
102 devclass_t parent; /* parent in devclass hierarchy */
103 driver_list_t drivers; /* bus devclasses store drivers for bus */
105 device_t *devices; /* array of devices indexed by unit */
106 int maxunit; /* size of devices array */
108 #define DC_HAS_CHILDREN 1
110 struct sysctl_ctx_list sysctl_ctx;
111 struct sysctl_oid *sysctl_tree;
115 * @brief Implementation of device.
119 * A device is a kernel object. The first field must be the
120 * current ops table for the object.
127 TAILQ_ENTRY(device) link; /**< list of devices in parent */
128 TAILQ_ENTRY(device) devlink; /**< global device list membership */
129 device_t parent; /**< parent of this device */
130 device_list_t children; /**< list of child devices */
133 * Details of this device.
135 driver_t *driver; /**< current driver */
136 devclass_t devclass; /**< current device class */
137 int unit; /**< current unit number */
138 char* nameunit; /**< name+unit e.g. foodev0 */
139 char* desc; /**< driver specific description */
140 int busy; /**< count of calls to device_busy() */
141 device_state_t state; /**< current device state */
142 uint32_t devflags; /**< api level flags for device_get_flags() */
143 u_int flags; /**< internal device flags */
144 u_int order; /**< order from device_add_child_ordered() */
145 void *ivars; /**< instance variables */
146 void *softc; /**< current driver's variables */
148 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
149 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
152 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
153 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
155 EVENTHANDLER_LIST_DEFINE(device_attach);
156 EVENTHANDLER_LIST_DEFINE(device_detach);
157 EVENTHANDLER_LIST_DEFINE(dev_lookup);
159 static void devctl2_init(void);
160 static bool device_frozen;
162 #define DRIVERNAME(d) ((d)? d->name : "no driver")
163 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
167 static int bus_debug = 1;
168 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
171 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
172 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
175 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
176 * prevent syslog from deleting initial spaces
178 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
180 static void print_device_short(device_t dev, int indent);
181 static void print_device(device_t dev, int indent);
182 void print_device_tree_short(device_t dev, int indent);
183 void print_device_tree(device_t dev, int indent);
184 static void print_driver_short(driver_t *driver, int indent);
185 static void print_driver(driver_t *driver, int indent);
186 static void print_driver_list(driver_list_t drivers, int indent);
187 static void print_devclass_short(devclass_t dc, int indent);
188 static void print_devclass(devclass_t dc, int indent);
189 void print_devclass_list_short(void);
190 void print_devclass_list(void);
193 /* Make the compiler ignore the function calls */
194 #define PDEBUG(a) /* nop */
195 #define DEVICENAME(d) /* nop */
197 #define print_device_short(d,i) /* nop */
198 #define print_device(d,i) /* nop */
199 #define print_device_tree_short(d,i) /* nop */
200 #define print_device_tree(d,i) /* nop */
201 #define print_driver_short(d,i) /* nop */
202 #define print_driver(d,i) /* nop */
203 #define print_driver_list(d,i) /* nop */
204 #define print_devclass_short(d,i) /* nop */
205 #define print_devclass(d,i) /* nop */
206 #define print_devclass_list_short() /* nop */
207 #define print_devclass_list() /* nop */
215 DEVCLASS_SYSCTL_PARENT,
219 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
221 devclass_t dc = (devclass_t)arg1;
225 case DEVCLASS_SYSCTL_PARENT:
226 value = dc->parent ? dc->parent->name : "";
231 return (SYSCTL_OUT_STR(req, value));
235 devclass_sysctl_init(devclass_t dc)
238 if (dc->sysctl_tree != NULL)
240 sysctl_ctx_init(&dc->sysctl_ctx);
241 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
242 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
243 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
244 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
246 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
247 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
253 DEVICE_SYSCTL_DRIVER,
254 DEVICE_SYSCTL_LOCATION,
255 DEVICE_SYSCTL_PNPINFO,
256 DEVICE_SYSCTL_PARENT,
260 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
262 device_t dev = (device_t)arg1;
269 case DEVICE_SYSCTL_DESC:
270 value = dev->desc ? dev->desc : "";
272 case DEVICE_SYSCTL_DRIVER:
273 value = dev->driver ? dev->driver->name : "";
275 case DEVICE_SYSCTL_LOCATION:
276 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
277 bus_child_location_str(dev, buf, 1024);
279 case DEVICE_SYSCTL_PNPINFO:
280 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
281 bus_child_pnpinfo_str(dev, buf, 1024);
283 case DEVICE_SYSCTL_PARENT:
284 value = dev->parent ? dev->parent->nameunit : "";
289 error = SYSCTL_OUT_STR(req, value);
296 device_sysctl_init(device_t dev)
298 devclass_t dc = dev->devclass;
301 if (dev->sysctl_tree != NULL)
303 devclass_sysctl_init(dc);
304 sysctl_ctx_init(&dev->sysctl_ctx);
305 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
306 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
307 dev->nameunit + strlen(dc->name),
308 CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "", "device_index");
309 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
310 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
311 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
312 "device description");
313 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
315 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
316 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
317 "device driver name");
318 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
319 OID_AUTO, "%location",
320 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
321 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
322 "device location relative to parent");
323 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
324 OID_AUTO, "%pnpinfo",
325 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
326 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
327 "device identification");
328 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
330 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
331 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
333 if (bus_get_domain(dev, &domain) == 0)
334 SYSCTL_ADD_INT(&dev->sysctl_ctx,
335 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
336 CTLFLAG_RD, NULL, domain, "NUMA domain");
340 device_sysctl_update(device_t dev)
342 devclass_t dc = dev->devclass;
344 if (dev->sysctl_tree == NULL)
346 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
350 device_sysctl_fini(device_t dev)
352 if (dev->sysctl_tree == NULL)
354 sysctl_ctx_free(&dev->sysctl_ctx);
355 dev->sysctl_tree = NULL;
359 * /dev/devctl implementation
363 * This design allows only one reader for /dev/devctl. This is not desirable
364 * in the long run, but will get a lot of hair out of this implementation.
365 * Maybe we should make this device a clonable device.
367 * Also note: we specifically do not attach a device to the device_t tree
368 * to avoid potential chicken and egg problems. One could argue that all
369 * of this belongs to the root node. One could also further argue that the
370 * sysctl interface that we have not might more properly be an ioctl
371 * interface, but at this stage of the game, I'm not inclined to rock that
374 * I'm also not sure that the SIGIO support is done correctly or not, as
375 * I copied it from a driver that had SIGIO support that likely hasn't been
376 * tested since 3.4 or 2.2.8!
379 /* Deprecated way to adjust queue length */
380 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
381 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
382 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
383 "devctl disable -- deprecated");
385 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
386 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
387 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
388 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
389 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
391 static d_open_t devopen;
392 static d_close_t devclose;
393 static d_read_t devread;
394 static d_ioctl_t devioctl;
395 static d_poll_t devpoll;
396 static d_kqfilter_t devkqfilter;
398 static struct cdevsw dev_cdevsw = {
399 .d_version = D_VERSION,
405 .d_kqfilter = devkqfilter,
409 struct dev_event_info
412 TAILQ_ENTRY(dev_event_info) dei_link;
415 TAILQ_HEAD(devq, dev_event_info);
417 static struct dev_softc
430 static void filt_devctl_detach(struct knote *kn);
431 static int filt_devctl_read(struct knote *kn, long hint);
433 struct filterops devctl_rfiltops = {
435 .f_detach = filt_devctl_detach,
436 .f_event = filt_devctl_read,
439 static struct cdev *devctl_dev;
444 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
445 UID_ROOT, GID_WHEEL, 0600, "devctl");
446 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
447 cv_init(&devsoftc.cv, "dev cv");
448 TAILQ_INIT(&devsoftc.devq);
449 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
454 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
457 mtx_lock(&devsoftc.mtx);
458 if (devsoftc.inuse) {
459 mtx_unlock(&devsoftc.mtx);
464 mtx_unlock(&devsoftc.mtx);
469 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
472 mtx_lock(&devsoftc.mtx);
474 devsoftc.nonblock = 0;
476 cv_broadcast(&devsoftc.cv);
477 funsetown(&devsoftc.sigio);
478 mtx_unlock(&devsoftc.mtx);
483 * The read channel for this device is used to report changes to
484 * userland in realtime. We are required to free the data as well as
485 * the n1 object because we allocate them separately. Also note that
486 * we return one record at a time. If you try to read this device a
487 * character at a time, you will lose the rest of the data. Listening
488 * programs are expected to cope.
491 devread(struct cdev *dev, struct uio *uio, int ioflag)
493 struct dev_event_info *n1;
496 mtx_lock(&devsoftc.mtx);
497 while (TAILQ_EMPTY(&devsoftc.devq)) {
498 if (devsoftc.nonblock) {
499 mtx_unlock(&devsoftc.mtx);
502 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
505 * Need to translate ERESTART to EINTR here? -- jake
507 mtx_unlock(&devsoftc.mtx);
511 n1 = TAILQ_FIRST(&devsoftc.devq);
512 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
514 mtx_unlock(&devsoftc.mtx);
515 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
516 free(n1->dei_data, M_BUS);
522 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
528 devsoftc.nonblock = 1;
530 devsoftc.nonblock = 0;
539 return fsetown(*(int *)data, &devsoftc.sigio);
541 *(int *)data = fgetown(&devsoftc.sigio);
544 /* (un)Support for other fcntl() calls. */
555 devpoll(struct cdev *dev, int events, struct thread *td)
559 mtx_lock(&devsoftc.mtx);
560 if (events & (POLLIN | POLLRDNORM)) {
561 if (!TAILQ_EMPTY(&devsoftc.devq))
562 revents = events & (POLLIN | POLLRDNORM);
564 selrecord(td, &devsoftc.sel);
566 mtx_unlock(&devsoftc.mtx);
572 devkqfilter(struct cdev *dev, struct knote *kn)
576 if (kn->kn_filter == EVFILT_READ) {
577 kn->kn_fop = &devctl_rfiltops;
578 knlist_add(&devsoftc.sel.si_note, kn, 0);
586 filt_devctl_detach(struct knote *kn)
589 knlist_remove(&devsoftc.sel.si_note, kn, 0);
593 filt_devctl_read(struct knote *kn, long hint)
595 kn->kn_data = devsoftc.queued;
596 return (kn->kn_data != 0);
600 * @brief Return whether the userland process is running
603 devctl_process_running(void)
605 return (devsoftc.inuse == 1);
609 * @brief Queue data to be read from the devctl device
611 * Generic interface to queue data to the devctl device. It is
612 * assumed that @p data is properly formatted. It is further assumed
613 * that @p data is allocated using the M_BUS malloc type.
616 devctl_queue_data_f(char *data, int flags)
618 struct dev_event_info *n1 = NULL, *n2 = NULL;
620 if (strlen(data) == 0)
622 if (devctl_queue_length == 0)
624 n1 = malloc(sizeof(*n1), M_BUS, flags);
628 mtx_lock(&devsoftc.mtx);
629 if (devctl_queue_length == 0) {
630 mtx_unlock(&devsoftc.mtx);
631 free(n1->dei_data, M_BUS);
635 /* Leave at least one spot in the queue... */
636 while (devsoftc.queued > devctl_queue_length - 1) {
637 n2 = TAILQ_FIRST(&devsoftc.devq);
638 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
639 free(n2->dei_data, M_BUS);
643 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
645 cv_broadcast(&devsoftc.cv);
646 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
647 mtx_unlock(&devsoftc.mtx);
648 selwakeup(&devsoftc.sel);
649 if (devsoftc.async && devsoftc.sigio != NULL)
650 pgsigio(&devsoftc.sigio, SIGIO, 0);
654 * We have to free data on all error paths since the caller
655 * assumes it will be free'd when this item is dequeued.
662 devctl_queue_data(char *data)
665 devctl_queue_data_f(data, M_NOWAIT);
669 * @brief Send a 'notification' to userland, using standard ways
672 devctl_notify_f(const char *system, const char *subsystem, const char *type,
673 const char *data, int flags)
679 return; /* BOGUS! Must specify system. */
680 if (subsystem == NULL)
681 return; /* BOGUS! Must specify subsystem. */
683 return; /* BOGUS! Must specify type. */
684 len += strlen(" system=") + strlen(system);
685 len += strlen(" subsystem=") + strlen(subsystem);
686 len += strlen(" type=") + strlen(type);
687 /* add in the data message plus newline. */
690 len += 3; /* '!', '\n', and NUL */
691 msg = malloc(len, M_BUS, flags);
693 return; /* Drop it on the floor */
695 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
696 system, subsystem, type, data);
698 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
699 system, subsystem, type);
700 devctl_queue_data_f(msg, flags);
704 devctl_notify(const char *system, const char *subsystem, const char *type,
708 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
712 * Common routine that tries to make sending messages as easy as possible.
713 * We allocate memory for the data, copy strings into that, but do not
714 * free it unless there's an error. The dequeue part of the driver should
715 * free the data. We don't send data when the device is disabled. We do
716 * send data, even when we have no listeners, because we wish to avoid
717 * races relating to startup and restart of listening applications.
719 * devaddq is designed to string together the type of event, with the
720 * object of that event, plus the plug and play info and location info
721 * for that event. This is likely most useful for devices, but less
722 * useful for other consumers of this interface. Those should use
723 * the devctl_queue_data() interface instead.
726 devaddq(const char *type, const char *what, device_t dev)
733 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
735 data = malloc(1024, M_BUS, M_NOWAIT);
739 /* get the bus specific location of this device */
740 loc = malloc(1024, M_BUS, M_NOWAIT);
744 bus_child_location_str(dev, loc, 1024);
746 /* Get the bus specific pnp info of this device */
747 pnp = malloc(1024, M_BUS, M_NOWAIT);
751 bus_child_pnpinfo_str(dev, pnp, 1024);
753 /* Get the parent of this device, or / if high enough in the tree. */
754 if (device_get_parent(dev) == NULL)
755 parstr = "."; /* Or '/' ? */
757 parstr = device_get_nameunit(device_get_parent(dev));
758 /* String it all together. */
759 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
763 devctl_queue_data(data);
773 * A device was added to the tree. We are called just after it successfully
774 * attaches (that is, probe and attach success for this device). No call
775 * is made if a device is merely parented into the tree. See devnomatch
776 * if probe fails. If attach fails, no notification is sent (but maybe
777 * we should have a different message for this).
780 devadded(device_t dev)
782 devaddq("+", device_get_nameunit(dev), dev);
786 * A device was removed from the tree. We are called just before this
790 devremoved(device_t dev)
792 devaddq("-", device_get_nameunit(dev), dev);
796 * Called when there's no match for this device. This is only called
797 * the first time that no match happens, so we don't keep getting this
798 * message. Should that prove to be undesirable, we can change it.
799 * This is called when all drivers that can attach to a given bus
800 * decline to accept this device. Other errors may not be detected.
803 devnomatch(device_t dev)
805 devaddq("?", "", dev);
809 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
811 struct dev_event_info *n1;
814 dis = (devctl_queue_length == 0);
815 error = sysctl_handle_int(oidp, &dis, 0, req);
816 if (error || !req->newptr)
818 if (mtx_initialized(&devsoftc.mtx))
819 mtx_lock(&devsoftc.mtx);
821 while (!TAILQ_EMPTY(&devsoftc.devq)) {
822 n1 = TAILQ_FIRST(&devsoftc.devq);
823 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
824 free(n1->dei_data, M_BUS);
828 devctl_queue_length = 0;
830 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
832 if (mtx_initialized(&devsoftc.mtx))
833 mtx_unlock(&devsoftc.mtx);
838 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
840 struct dev_event_info *n1;
843 q = devctl_queue_length;
844 error = sysctl_handle_int(oidp, &q, 0, req);
845 if (error || !req->newptr)
849 if (mtx_initialized(&devsoftc.mtx))
850 mtx_lock(&devsoftc.mtx);
851 devctl_queue_length = q;
852 while (devsoftc.queued > devctl_queue_length) {
853 n1 = TAILQ_FIRST(&devsoftc.devq);
854 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
855 free(n1->dei_data, M_BUS);
859 if (mtx_initialized(&devsoftc.mtx))
860 mtx_unlock(&devsoftc.mtx);
865 * @brief safely quotes strings that might have double quotes in them.
867 * The devctl protocol relies on quoted strings having matching quotes.
868 * This routine quotes any internal quotes so the resulting string
869 * is safe to pass to snprintf to construct, for example pnp info strings.
870 * Strings are always terminated with a NUL, but may be truncated if longer
871 * than @p len bytes after quotes.
873 * @param sb sbuf to place the characters into
874 * @param src Original buffer.
877 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
880 while (*src != '\0') {
881 if (*src == '"' || *src == '\\')
883 sbuf_putc(sb, *src++);
887 /* End of /dev/devctl code */
889 static TAILQ_HEAD(,device) bus_data_devices;
890 static int bus_data_generation = 1;
892 static kobj_method_t null_methods[] = {
896 DEFINE_CLASS(null, null_methods, 0);
899 * Bus pass implementation
902 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
903 int bus_current_pass = BUS_PASS_ROOT;
907 * @brief Register the pass level of a new driver attachment
909 * Register a new driver attachment's pass level. If no driver
910 * attachment with the same pass level has been added, then @p new
911 * will be added to the global passes list.
913 * @param new the new driver attachment
916 driver_register_pass(struct driverlink *new)
918 struct driverlink *dl;
920 /* We only consider pass numbers during boot. */
921 if (bus_current_pass == BUS_PASS_DEFAULT)
925 * Walk the passes list. If we already know about this pass
926 * then there is nothing to do. If we don't, then insert this
927 * driver link into the list.
929 TAILQ_FOREACH(dl, &passes, passlink) {
930 if (dl->pass < new->pass)
932 if (dl->pass == new->pass)
934 TAILQ_INSERT_BEFORE(dl, new, passlink);
937 TAILQ_INSERT_TAIL(&passes, new, passlink);
941 * @brief Raise the current bus pass
943 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
944 * method on the root bus to kick off a new device tree scan for each
945 * new pass level that has at least one driver.
948 bus_set_pass(int pass)
950 struct driverlink *dl;
952 if (bus_current_pass > pass)
953 panic("Attempt to lower bus pass level");
955 TAILQ_FOREACH(dl, &passes, passlink) {
956 /* Skip pass values below the current pass level. */
957 if (dl->pass <= bus_current_pass)
961 * Bail once we hit a driver with a pass level that is
968 * Raise the pass level to the next level and rescan
971 bus_current_pass = dl->pass;
972 BUS_NEW_PASS(root_bus);
976 * If there isn't a driver registered for the requested pass,
977 * then bus_current_pass might still be less than 'pass'. Set
978 * it to 'pass' in that case.
980 if (bus_current_pass < pass)
981 bus_current_pass = pass;
982 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
986 * Devclass implementation
989 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
993 * @brief Find or create a device class
995 * If a device class with the name @p classname exists, return it,
996 * otherwise if @p create is non-zero create and return a new device
999 * If @p parentname is non-NULL, the parent of the devclass is set to
1000 * the devclass of that name.
1002 * @param classname the devclass name to find or create
1003 * @param parentname the parent devclass name or @c NULL
1004 * @param create non-zero to create a devclass
1007 devclass_find_internal(const char *classname, const char *parentname,
1012 PDEBUG(("looking for %s", classname));
1016 TAILQ_FOREACH(dc, &devclasses, link) {
1017 if (!strcmp(dc->name, classname))
1021 if (create && !dc) {
1022 PDEBUG(("creating %s", classname));
1023 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1024 M_BUS, M_NOWAIT | M_ZERO);
1028 dc->name = (char*) (dc + 1);
1029 strcpy(dc->name, classname);
1030 TAILQ_INIT(&dc->drivers);
1031 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1033 bus_data_generation_update();
1037 * If a parent class is specified, then set that as our parent so
1038 * that this devclass will support drivers for the parent class as
1039 * well. If the parent class has the same name don't do this though
1040 * as it creates a cycle that can trigger an infinite loop in
1041 * device_probe_child() if a device exists for which there is no
1044 if (parentname && dc && !dc->parent &&
1045 strcmp(classname, parentname) != 0) {
1046 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1047 dc->parent->flags |= DC_HAS_CHILDREN;
1054 * @brief Create a device class
1056 * If a device class with the name @p classname exists, return it,
1057 * otherwise create and return a new device class.
1059 * @param classname the devclass name to find or create
1062 devclass_create(const char *classname)
1064 return (devclass_find_internal(classname, NULL, TRUE));
1068 * @brief Find a device class
1070 * If a device class with the name @p classname exists, return it,
1071 * otherwise return @c NULL.
1073 * @param classname the devclass name to find
1076 devclass_find(const char *classname)
1078 return (devclass_find_internal(classname, NULL, FALSE));
1082 * @brief Register that a device driver has been added to a devclass
1084 * Register that a device driver has been added to a devclass. This
1085 * is called by devclass_add_driver to accomplish the recursive
1086 * notification of all the children classes of dc, as well as dc.
1087 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1090 * We do a full search here of the devclass list at each iteration
1091 * level to save storing children-lists in the devclass structure. If
1092 * we ever move beyond a few dozen devices doing this, we may need to
1095 * @param dc the devclass to edit
1096 * @param driver the driver that was just added
1099 devclass_driver_added(devclass_t dc, driver_t *driver)
1105 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1107 for (i = 0; i < dc->maxunit; i++)
1108 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1109 BUS_DRIVER_ADDED(dc->devices[i], driver);
1112 * Walk through the children classes. Since we only keep a
1113 * single parent pointer around, we walk the entire list of
1114 * devclasses looking for children. We set the
1115 * DC_HAS_CHILDREN flag when a child devclass is created on
1116 * the parent, so we only walk the list for those devclasses
1117 * that have children.
1119 if (!(dc->flags & DC_HAS_CHILDREN))
1122 TAILQ_FOREACH(dc, &devclasses, link) {
1123 if (dc->parent == parent)
1124 devclass_driver_added(dc, driver);
1129 * @brief Add a device driver to a device class
1131 * Add a device driver to a devclass. This is normally called
1132 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1133 * all devices in the devclass will be called to allow them to attempt
1134 * to re-probe any unmatched children.
1136 * @param dc the devclass to edit
1137 * @param driver the driver to register
1140 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1143 const char *parentname;
1145 PDEBUG(("%s", DRIVERNAME(driver)));
1147 /* Don't allow invalid pass values. */
1148 if (pass <= BUS_PASS_ROOT)
1151 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1156 * Compile the driver's methods. Also increase the reference count
1157 * so that the class doesn't get freed when the last instance
1158 * goes. This means we can safely use static methods and avoids a
1159 * double-free in devclass_delete_driver.
1161 kobj_class_compile((kobj_class_t) driver);
1164 * If the driver has any base classes, make the
1165 * devclass inherit from the devclass of the driver's
1166 * first base class. This will allow the system to
1167 * search for drivers in both devclasses for children
1168 * of a device using this driver.
1170 if (driver->baseclasses)
1171 parentname = driver->baseclasses[0]->name;
1174 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1176 dl->driver = driver;
1177 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1178 driver->refs++; /* XXX: kobj_mtx */
1180 driver_register_pass(dl);
1182 if (device_frozen) {
1183 dl->flags |= DL_DEFERRED_PROBE;
1185 devclass_driver_added(dc, driver);
1187 bus_data_generation_update();
1192 * @brief Register that a device driver has been deleted from a devclass
1194 * Register that a device driver has been removed from a devclass.
1195 * This is called by devclass_delete_driver to accomplish the
1196 * recursive notification of all the children classes of busclass, as
1197 * well as busclass. Each layer will attempt to detach the driver
1198 * from any devices that are children of the bus's devclass. The function
1199 * will return an error if a device fails to detach.
1201 * We do a full search here of the devclass list at each iteration
1202 * level to save storing children-lists in the devclass structure. If
1203 * we ever move beyond a few dozen devices doing this, we may need to
1206 * @param busclass the devclass of the parent bus
1207 * @param dc the devclass of the driver being deleted
1208 * @param driver the driver being deleted
1211 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1218 * Disassociate from any devices. We iterate through all the
1219 * devices in the devclass of the driver and detach any which are
1220 * using the driver and which have a parent in the devclass which
1221 * we are deleting from.
1223 * Note that since a driver can be in multiple devclasses, we
1224 * should not detach devices which are not children of devices in
1225 * the affected devclass.
1227 * If we're frozen, we don't generate NOMATCH events. Mark to
1230 for (i = 0; i < dc->maxunit; i++) {
1231 if (dc->devices[i]) {
1232 dev = dc->devices[i];
1233 if (dev->driver == driver && dev->parent &&
1234 dev->parent->devclass == busclass) {
1235 if ((error = device_detach(dev)) != 0)
1237 if (device_frozen) {
1238 dev->flags &= ~DF_DONENOMATCH;
1239 dev->flags |= DF_NEEDNOMATCH;
1241 BUS_PROBE_NOMATCH(dev->parent, dev);
1243 dev->flags |= DF_DONENOMATCH;
1250 * Walk through the children classes. Since we only keep a
1251 * single parent pointer around, we walk the entire list of
1252 * devclasses looking for children. We set the
1253 * DC_HAS_CHILDREN flag when a child devclass is created on
1254 * the parent, so we only walk the list for those devclasses
1255 * that have children.
1257 if (!(busclass->flags & DC_HAS_CHILDREN))
1260 TAILQ_FOREACH(busclass, &devclasses, link) {
1261 if (busclass->parent == parent) {
1262 error = devclass_driver_deleted(busclass, dc, driver);
1271 * @brief Delete a device driver from a device class
1273 * Delete a device driver from a devclass. This is normally called
1274 * automatically by DRIVER_MODULE().
1276 * If the driver is currently attached to any devices,
1277 * devclass_delete_driver() will first attempt to detach from each
1278 * device. If one of the detach calls fails, the driver will not be
1281 * @param dc the devclass to edit
1282 * @param driver the driver to unregister
1285 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1287 devclass_t dc = devclass_find(driver->name);
1291 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1297 * Find the link structure in the bus' list of drivers.
1299 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1300 if (dl->driver == driver)
1305 PDEBUG(("%s not found in %s list", driver->name,
1310 error = devclass_driver_deleted(busclass, dc, driver);
1314 TAILQ_REMOVE(&busclass->drivers, dl, link);
1319 if (driver->refs == 0)
1320 kobj_class_free((kobj_class_t) driver);
1322 bus_data_generation_update();
1327 * @brief Quiesces a set of device drivers from a device class
1329 * Quiesce a device driver from a devclass. This is normally called
1330 * automatically by DRIVER_MODULE().
1332 * If the driver is currently attached to any devices,
1333 * devclass_quiesece_driver() will first attempt to quiesce each
1336 * @param dc the devclass to edit
1337 * @param driver the driver to unregister
1340 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1342 devclass_t dc = devclass_find(driver->name);
1348 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1354 * Find the link structure in the bus' list of drivers.
1356 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1357 if (dl->driver == driver)
1362 PDEBUG(("%s not found in %s list", driver->name,
1368 * Quiesce all devices. We iterate through all the devices in
1369 * the devclass of the driver and quiesce any which are using
1370 * the driver and which have a parent in the devclass which we
1373 * Note that since a driver can be in multiple devclasses, we
1374 * should not quiesce devices which are not children of
1375 * devices in the affected devclass.
1377 for (i = 0; i < dc->maxunit; i++) {
1378 if (dc->devices[i]) {
1379 dev = dc->devices[i];
1380 if (dev->driver == driver && dev->parent &&
1381 dev->parent->devclass == busclass) {
1382 if ((error = device_quiesce(dev)) != 0)
1395 devclass_find_driver_internal(devclass_t dc, const char *classname)
1399 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1401 TAILQ_FOREACH(dl, &dc->drivers, link) {
1402 if (!strcmp(dl->driver->name, classname))
1406 PDEBUG(("not found"));
1411 * @brief Return the name of the devclass
1414 devclass_get_name(devclass_t dc)
1420 * @brief Find a device given a unit number
1422 * @param dc the devclass to search
1423 * @param unit the unit number to search for
1425 * @returns the device with the given unit number or @c
1426 * NULL if there is no such device
1429 devclass_get_device(devclass_t dc, int unit)
1431 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1433 return (dc->devices[unit]);
1437 * @brief Find the softc field of a device given a unit number
1439 * @param dc the devclass to search
1440 * @param unit the unit number to search for
1442 * @returns the softc field of the device with the given
1443 * unit number or @c NULL if there is no such
1447 devclass_get_softc(devclass_t dc, int unit)
1451 dev = devclass_get_device(dc, unit);
1455 return (device_get_softc(dev));
1459 * @brief Get a list of devices in the devclass
1461 * An array containing a list of all the devices in the given devclass
1462 * is allocated and returned in @p *devlistp. The number of devices
1463 * in the array is returned in @p *devcountp. The caller should free
1464 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1466 * @param dc the devclass to examine
1467 * @param devlistp points at location for array pointer return
1469 * @param devcountp points at location for array size return value
1472 * @retval ENOMEM the array allocation failed
1475 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1480 count = devclass_get_count(dc);
1481 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1486 for (i = 0; i < dc->maxunit; i++) {
1487 if (dc->devices[i]) {
1488 list[count] = dc->devices[i];
1500 * @brief Get a list of drivers in the devclass
1502 * An array containing a list of pointers to all the drivers in the
1503 * given devclass is allocated and returned in @p *listp. The number
1504 * of drivers in the array is returned in @p *countp. The caller should
1505 * free the array using @c free(p, M_TEMP).
1507 * @param dc the devclass to examine
1508 * @param listp gives location for array pointer return value
1509 * @param countp gives location for number of array elements
1513 * @retval ENOMEM the array allocation failed
1516 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1523 TAILQ_FOREACH(dl, &dc->drivers, link)
1525 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1530 TAILQ_FOREACH(dl, &dc->drivers, link) {
1531 list[count] = dl->driver;
1541 * @brief Get the number of devices in a devclass
1543 * @param dc the devclass to examine
1546 devclass_get_count(devclass_t dc)
1551 for (i = 0; i < dc->maxunit; i++)
1558 * @brief Get the maximum unit number used in a devclass
1560 * Note that this is one greater than the highest currently-allocated
1561 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1562 * that not even the devclass has been allocated yet.
1564 * @param dc the devclass to examine
1567 devclass_get_maxunit(devclass_t dc)
1571 return (dc->maxunit);
1575 * @brief Find a free unit number in a devclass
1577 * This function searches for the first unused unit number greater
1578 * that or equal to @p unit.
1580 * @param dc the devclass to examine
1581 * @param unit the first unit number to check
1584 devclass_find_free_unit(devclass_t dc, int unit)
1588 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1594 * @brief Set the parent of a devclass
1596 * The parent class is normally initialised automatically by
1599 * @param dc the devclass to edit
1600 * @param pdc the new parent devclass
1603 devclass_set_parent(devclass_t dc, devclass_t pdc)
1609 * @brief Get the parent of a devclass
1611 * @param dc the devclass to examine
1614 devclass_get_parent(devclass_t dc)
1616 return (dc->parent);
1619 struct sysctl_ctx_list *
1620 devclass_get_sysctl_ctx(devclass_t dc)
1622 return (&dc->sysctl_ctx);
1626 devclass_get_sysctl_tree(devclass_t dc)
1628 return (dc->sysctl_tree);
1633 * @brief Allocate a unit number
1635 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1636 * will do). The allocated unit number is returned in @p *unitp.
1638 * @param dc the devclass to allocate from
1639 * @param unitp points at the location for the allocated unit
1643 * @retval EEXIST the requested unit number is already allocated
1644 * @retval ENOMEM memory allocation failure
1647 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1652 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1654 /* Ask the parent bus if it wants to wire this device. */
1656 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1659 /* If we were given a wired unit number, check for existing device */
1662 if (unit >= 0 && unit < dc->maxunit &&
1663 dc->devices[unit] != NULL) {
1665 printf("%s: %s%d already exists; skipping it\n",
1666 dc->name, dc->name, *unitp);
1670 /* Unwired device, find the next available slot for it */
1672 for (unit = 0;; unit++) {
1673 /* If there is an "at" hint for a unit then skip it. */
1674 if (resource_string_value(dc->name, unit, "at", &s) ==
1678 /* If this device slot is already in use, skip it. */
1679 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1687 * We've selected a unit beyond the length of the table, so let's
1688 * extend the table to make room for all units up to and including
1691 if (unit >= dc->maxunit) {
1692 device_t *newlist, *oldlist;
1695 oldlist = dc->devices;
1696 newsize = roundup((unit + 1),
1697 MAX(1, MINALLOCSIZE / sizeof(device_t)));
1698 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1701 if (oldlist != NULL)
1702 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1703 bzero(newlist + dc->maxunit,
1704 sizeof(device_t) * (newsize - dc->maxunit));
1705 dc->devices = newlist;
1706 dc->maxunit = newsize;
1707 if (oldlist != NULL)
1708 free(oldlist, M_BUS);
1710 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1718 * @brief Add a device to a devclass
1720 * A unit number is allocated for the device (using the device's
1721 * preferred unit number if any) and the device is registered in the
1722 * devclass. This allows the device to be looked up by its unit
1723 * number, e.g. by decoding a dev_t minor number.
1725 * @param dc the devclass to add to
1726 * @param dev the device to add
1729 * @retval EEXIST the requested unit number is already allocated
1730 * @retval ENOMEM memory allocation failure
1733 devclass_add_device(devclass_t dc, device_t dev)
1737 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1739 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1742 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1746 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1747 free(dev->nameunit, M_BUS);
1748 dev->nameunit = NULL;
1751 dc->devices[dev->unit] = dev;
1753 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1760 * @brief Delete a device from a devclass
1762 * The device is removed from the devclass's device list and its unit
1765 * @param dc the devclass to delete from
1766 * @param dev the device to delete
1771 devclass_delete_device(devclass_t dc, device_t dev)
1776 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1778 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1779 panic("devclass_delete_device: inconsistent device class");
1780 dc->devices[dev->unit] = NULL;
1781 if (dev->flags & DF_WILDCARD)
1783 dev->devclass = NULL;
1784 free(dev->nameunit, M_BUS);
1785 dev->nameunit = NULL;
1792 * @brief Make a new device and add it as a child of @p parent
1794 * @param parent the parent of the new device
1795 * @param name the devclass name of the new device or @c NULL
1796 * to leave the devclass unspecified
1797 * @parem unit the unit number of the new device of @c -1 to
1798 * leave the unit number unspecified
1800 * @returns the new device
1803 make_device(device_t parent, const char *name, int unit)
1808 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1811 dc = devclass_find_internal(name, NULL, TRUE);
1813 printf("make_device: can't find device class %s\n",
1821 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1825 dev->parent = parent;
1826 TAILQ_INIT(&dev->children);
1827 kobj_init((kobj_t) dev, &null_class);
1829 dev->devclass = NULL;
1831 dev->nameunit = NULL;
1835 dev->flags = DF_ENABLED;
1838 dev->flags |= DF_WILDCARD;
1840 dev->flags |= DF_FIXEDCLASS;
1841 if (devclass_add_device(dc, dev)) {
1842 kobj_delete((kobj_t) dev, M_BUS);
1846 if (parent != NULL && device_has_quiet_children(parent))
1847 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1851 dev->state = DS_NOTPRESENT;
1853 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1854 bus_data_generation_update();
1861 * @brief Print a description of a device.
1864 device_print_child(device_t dev, device_t child)
1868 if (device_is_alive(child))
1869 retval += BUS_PRINT_CHILD(dev, child);
1871 retval += device_printf(child, " not found\n");
1877 * @brief Create a new device
1879 * This creates a new device and adds it as a child of an existing
1880 * parent device. The new device will be added after the last existing
1881 * child with order zero.
1883 * @param dev the device which will be the parent of the
1885 * @param name devclass name for new device or @c NULL if not
1887 * @param unit unit number for new device or @c -1 if not
1890 * @returns the new device
1893 device_add_child(device_t dev, const char *name, int unit)
1895 return (device_add_child_ordered(dev, 0, name, unit));
1899 * @brief Create a new device
1901 * This creates a new device and adds it as a child of an existing
1902 * parent device. The new device will be added after the last existing
1903 * child with the same order.
1905 * @param dev the device which will be the parent of the
1907 * @param order a value which is used to partially sort the
1908 * children of @p dev - devices created using
1909 * lower values of @p order appear first in @p
1910 * dev's list of children
1911 * @param name devclass name for new device or @c NULL if not
1913 * @param unit unit number for new device or @c -1 if not
1916 * @returns the new device
1919 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1924 PDEBUG(("%s at %s with order %u as unit %d",
1925 name, DEVICENAME(dev), order, unit));
1926 KASSERT(name != NULL || unit == -1,
1927 ("child device with wildcard name and specific unit number"));
1929 child = make_device(dev, name, unit);
1932 child->order = order;
1934 TAILQ_FOREACH(place, &dev->children, link) {
1935 if (place->order > order)
1941 * The device 'place' is the first device whose order is
1942 * greater than the new child.
1944 TAILQ_INSERT_BEFORE(place, child, link);
1947 * The new child's order is greater or equal to the order of
1948 * any existing device. Add the child to the tail of the list.
1950 TAILQ_INSERT_TAIL(&dev->children, child, link);
1953 bus_data_generation_update();
1958 * @brief Delete a device
1960 * This function deletes a device along with all of its children. If
1961 * the device currently has a driver attached to it, the device is
1962 * detached first using device_detach().
1964 * @param dev the parent device
1965 * @param child the device to delete
1968 * @retval non-zero a unit error code describing the error
1971 device_delete_child(device_t dev, device_t child)
1974 device_t grandchild;
1976 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1978 /* detach parent before deleting children, if any */
1979 if ((error = device_detach(child)) != 0)
1982 /* remove children second */
1983 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1984 error = device_delete_child(child, grandchild);
1989 if (child->devclass)
1990 devclass_delete_device(child->devclass, child);
1992 BUS_CHILD_DELETED(dev, child);
1993 TAILQ_REMOVE(&dev->children, child, link);
1994 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1995 kobj_delete((kobj_t) child, M_BUS);
1997 bus_data_generation_update();
2002 * @brief Delete all children devices of the given device, if any.
2004 * This function deletes all children devices of the given device, if
2005 * any, using the device_delete_child() function for each device it
2006 * finds. If a child device cannot be deleted, this function will
2007 * return an error code.
2009 * @param dev the parent device
2012 * @retval non-zero a device would not detach
2015 device_delete_children(device_t dev)
2020 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2024 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2025 error = device_delete_child(dev, child);
2027 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2035 * @brief Find a device given a unit number
2037 * This is similar to devclass_get_devices() but only searches for
2038 * devices which have @p dev as a parent.
2040 * @param dev the parent device to search
2041 * @param unit the unit number to search for. If the unit is -1,
2042 * return the first child of @p dev which has name
2043 * @p classname (that is, the one with the lowest unit.)
2045 * @returns the device with the given unit number or @c
2046 * NULL if there is no such device
2049 device_find_child(device_t dev, const char *classname, int unit)
2054 dc = devclass_find(classname);
2059 child = devclass_get_device(dc, unit);
2060 if (child && child->parent == dev)
2063 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2064 child = devclass_get_device(dc, unit);
2065 if (child && child->parent == dev)
2076 first_matching_driver(devclass_t dc, device_t dev)
2079 return (devclass_find_driver_internal(dc, dev->devclass->name));
2080 return (TAILQ_FIRST(&dc->drivers));
2087 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2089 if (dev->devclass) {
2091 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2092 if (!strcmp(dev->devclass->name, dl->driver->name))
2096 return (TAILQ_NEXT(last, link));
2103 device_probe_child(device_t dev, device_t child)
2106 driverlink_t best = NULL;
2108 int result, pri = 0;
2109 int hasclass = (child->devclass != NULL);
2115 panic("device_probe_child: parent device has no devclass");
2118 * If the state is already probed, then return. However, don't
2119 * return if we can rebid this object.
2121 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2124 for (; dc; dc = dc->parent) {
2125 for (dl = first_matching_driver(dc, child);
2127 dl = next_matching_driver(dc, child, dl)) {
2128 /* If this driver's pass is too high, then ignore it. */
2129 if (dl->pass > bus_current_pass)
2132 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2133 result = device_set_driver(child, dl->driver);
2134 if (result == ENOMEM)
2136 else if (result != 0)
2139 if (device_set_devclass(child,
2140 dl->driver->name) != 0) {
2141 char const * devname =
2142 device_get_name(child);
2143 if (devname == NULL)
2144 devname = "(unknown)";
2145 printf("driver bug: Unable to set "
2146 "devclass (class: %s "
2150 (void)device_set_driver(child, NULL);
2155 /* Fetch any flags for the device before probing. */
2156 resource_int_value(dl->driver->name, child->unit,
2157 "flags", &child->devflags);
2159 result = DEVICE_PROBE(child);
2161 /* Reset flags and devclass before the next probe. */
2162 child->devflags = 0;
2164 (void)device_set_devclass(child, NULL);
2167 * If the driver returns SUCCESS, there can be
2168 * no higher match for this device.
2177 * Reset DF_QUIET in case this driver doesn't
2178 * end up as the best driver.
2180 device_verbose(child);
2183 * Probes that return BUS_PROBE_NOWILDCARD or lower
2184 * only match on devices whose driver was explicitly
2187 if (result <= BUS_PROBE_NOWILDCARD &&
2188 !(child->flags & DF_FIXEDCLASS)) {
2193 * The driver returned an error so it
2194 * certainly doesn't match.
2197 (void)device_set_driver(child, NULL);
2202 * A priority lower than SUCCESS, remember the
2203 * best matching driver. Initialise the value
2204 * of pri for the first match.
2206 if (best == NULL || result > pri) {
2213 * If we have an unambiguous match in this devclass,
2214 * don't look in the parent.
2216 if (best && pri == 0)
2221 * If we found a driver, change state and initialise the devclass.
2223 /* XXX What happens if we rebid and got no best? */
2226 * If this device was attached, and we were asked to
2227 * rescan, and it is a different driver, then we have
2228 * to detach the old driver and reattach this new one.
2229 * Note, we don't have to check for DF_REBID here
2230 * because if the state is > DS_ALIVE, we know it must
2233 * This assumes that all DF_REBID drivers can have
2234 * their probe routine called at any time and that
2235 * they are idempotent as well as completely benign in
2236 * normal operations.
2238 * We also have to make sure that the detach
2239 * succeeded, otherwise we fail the operation (or
2240 * maybe it should just fail silently? I'm torn).
2242 if (child->state > DS_ALIVE && best->driver != child->driver)
2243 if ((result = device_detach(dev)) != 0)
2246 /* Set the winning driver, devclass, and flags. */
2247 if (!child->devclass) {
2248 result = device_set_devclass(child, best->driver->name);
2252 result = device_set_driver(child, best->driver);
2255 resource_int_value(best->driver->name, child->unit,
2256 "flags", &child->devflags);
2260 * A bit bogus. Call the probe method again to make
2261 * sure that we have the right description.
2263 DEVICE_PROBE(child);
2265 child->flags |= DF_REBID;
2268 child->flags &= ~DF_REBID;
2269 child->state = DS_ALIVE;
2271 bus_data_generation_update();
2279 * @brief Return the parent of a device
2282 device_get_parent(device_t dev)
2284 return (dev->parent);
2288 * @brief Get a list of children of a device
2290 * An array containing a list of all the children of the given device
2291 * is allocated and returned in @p *devlistp. The number of devices
2292 * in the array is returned in @p *devcountp. The caller should free
2293 * the array using @c free(p, M_TEMP).
2295 * @param dev the device to examine
2296 * @param devlistp points at location for array pointer return
2298 * @param devcountp points at location for array size return value
2301 * @retval ENOMEM the array allocation failed
2304 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2311 TAILQ_FOREACH(child, &dev->children, link) {
2320 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2325 TAILQ_FOREACH(child, &dev->children, link) {
2326 list[count] = child;
2337 * @brief Return the current driver for the device or @c NULL if there
2338 * is no driver currently attached
2341 device_get_driver(device_t dev)
2343 return (dev->driver);
2347 * @brief Return the current devclass for the device or @c NULL if
2351 device_get_devclass(device_t dev)
2353 return (dev->devclass);
2357 * @brief Return the name of the device's devclass or @c NULL if there
2361 device_get_name(device_t dev)
2363 if (dev != NULL && dev->devclass)
2364 return (devclass_get_name(dev->devclass));
2369 * @brief Return a string containing the device's devclass name
2370 * followed by an ascii representation of the device's unit number
2374 device_get_nameunit(device_t dev)
2376 return (dev->nameunit);
2380 * @brief Return the device's unit number.
2383 device_get_unit(device_t dev)
2389 * @brief Return the device's description string
2392 device_get_desc(device_t dev)
2398 * @brief Return the device's flags
2401 device_get_flags(device_t dev)
2403 return (dev->devflags);
2406 struct sysctl_ctx_list *
2407 device_get_sysctl_ctx(device_t dev)
2409 return (&dev->sysctl_ctx);
2413 device_get_sysctl_tree(device_t dev)
2415 return (dev->sysctl_tree);
2419 * @brief Print the name of the device followed by a colon and a space
2421 * @returns the number of characters printed
2424 device_print_prettyname(device_t dev)
2426 const char *name = device_get_name(dev);
2429 return (printf("unknown: "));
2430 return (printf("%s%d: ", name, device_get_unit(dev)));
2434 * @brief Print the name of the device followed by a colon, a space
2435 * and the result of calling vprintf() with the value of @p fmt and
2436 * the following arguments.
2438 * @returns the number of characters printed
2441 device_printf(device_t dev, const char * fmt, ...)
2451 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
2452 sbuf_set_drain(&sb, sbuf_printf_drain, &retval);
2454 name = device_get_name(dev);
2457 sbuf_cat(&sb, "unknown: ");
2459 sbuf_printf(&sb, "%s%d: ", name, device_get_unit(dev));
2462 sbuf_vprintf(&sb, fmt, ap);
2475 device_set_desc_internal(device_t dev, const char* desc, int copy)
2477 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2478 free(dev->desc, M_BUS);
2479 dev->flags &= ~DF_DESCMALLOCED;
2484 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2486 strcpy(dev->desc, desc);
2487 dev->flags |= DF_DESCMALLOCED;
2490 /* Avoid a -Wcast-qual warning */
2491 dev->desc = (char *)(uintptr_t) desc;
2494 bus_data_generation_update();
2498 * @brief Set the device's description
2500 * The value of @c desc should be a string constant that will not
2501 * change (at least until the description is changed in a subsequent
2502 * call to device_set_desc() or device_set_desc_copy()).
2505 device_set_desc(device_t dev, const char* desc)
2507 device_set_desc_internal(dev, desc, FALSE);
2511 * @brief Set the device's description
2513 * The string pointed to by @c desc is copied. Use this function if
2514 * the device description is generated, (e.g. with sprintf()).
2517 device_set_desc_copy(device_t dev, const char* desc)
2519 device_set_desc_internal(dev, desc, TRUE);
2523 * @brief Set the device's flags
2526 device_set_flags(device_t dev, uint32_t flags)
2528 dev->devflags = flags;
2532 * @brief Return the device's softc field
2534 * The softc is allocated and zeroed when a driver is attached, based
2535 * on the size field of the driver.
2538 device_get_softc(device_t dev)
2540 return (dev->softc);
2544 * @brief Set the device's softc field
2546 * Most drivers do not need to use this since the softc is allocated
2547 * automatically when the driver is attached.
2550 device_set_softc(device_t dev, void *softc)
2552 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2553 free_domain(dev->softc, M_BUS_SC);
2556 dev->flags |= DF_EXTERNALSOFTC;
2558 dev->flags &= ~DF_EXTERNALSOFTC;
2562 * @brief Free claimed softc
2564 * Most drivers do not need to use this since the softc is freed
2565 * automatically when the driver is detached.
2568 device_free_softc(void *softc)
2570 free_domain(softc, M_BUS_SC);
2574 * @brief Claim softc
2576 * This function can be used to let the driver free the automatically
2577 * allocated softc using "device_free_softc()". This function is
2578 * useful when the driver is refcounting the softc and the softc
2579 * cannot be freed when the "device_detach" method is called.
2582 device_claim_softc(device_t dev)
2585 dev->flags |= DF_EXTERNALSOFTC;
2587 dev->flags &= ~DF_EXTERNALSOFTC;
2591 * @brief Get the device's ivars field
2593 * The ivars field is used by the parent device to store per-device
2594 * state (e.g. the physical location of the device or a list of
2598 device_get_ivars(device_t dev)
2601 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2602 return (dev->ivars);
2606 * @brief Set the device's ivars field
2609 device_set_ivars(device_t dev, void * ivars)
2612 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2617 * @brief Return the device's state
2620 device_get_state(device_t dev)
2622 return (dev->state);
2626 * @brief Set the DF_ENABLED flag for the device
2629 device_enable(device_t dev)
2631 dev->flags |= DF_ENABLED;
2635 * @brief Clear the DF_ENABLED flag for the device
2638 device_disable(device_t dev)
2640 dev->flags &= ~DF_ENABLED;
2644 * @brief Increment the busy counter for the device
2647 device_busy(device_t dev)
2649 if (dev->state < DS_ATTACHING)
2650 panic("device_busy: called for unattached device");
2651 if (dev->busy == 0 && dev->parent)
2652 device_busy(dev->parent);
2654 if (dev->state == DS_ATTACHED)
2655 dev->state = DS_BUSY;
2659 * @brief Decrement the busy counter for the device
2662 device_unbusy(device_t dev)
2664 if (dev->busy != 0 && dev->state != DS_BUSY &&
2665 dev->state != DS_ATTACHING)
2666 panic("device_unbusy: called for non-busy device %s",
2667 device_get_nameunit(dev));
2669 if (dev->busy == 0) {
2671 device_unbusy(dev->parent);
2672 if (dev->state == DS_BUSY)
2673 dev->state = DS_ATTACHED;
2678 * @brief Set the DF_QUIET flag for the device
2681 device_quiet(device_t dev)
2683 dev->flags |= DF_QUIET;
2687 * @brief Set the DF_QUIET_CHILDREN flag for the device
2690 device_quiet_children(device_t dev)
2692 dev->flags |= DF_QUIET_CHILDREN;
2696 * @brief Clear the DF_QUIET flag for the device
2699 device_verbose(device_t dev)
2701 dev->flags &= ~DF_QUIET;
2705 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2708 device_has_quiet_children(device_t dev)
2710 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2714 * @brief Return non-zero if the DF_QUIET flag is set on the device
2717 device_is_quiet(device_t dev)
2719 return ((dev->flags & DF_QUIET) != 0);
2723 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2726 device_is_enabled(device_t dev)
2728 return ((dev->flags & DF_ENABLED) != 0);
2732 * @brief Return non-zero if the device was successfully probed
2735 device_is_alive(device_t dev)
2737 return (dev->state >= DS_ALIVE);
2741 * @brief Return non-zero if the device currently has a driver
2745 device_is_attached(device_t dev)
2747 return (dev->state >= DS_ATTACHED);
2751 * @brief Return non-zero if the device is currently suspended.
2754 device_is_suspended(device_t dev)
2756 return ((dev->flags & DF_SUSPENDED) != 0);
2760 * @brief Set the devclass of a device
2761 * @see devclass_add_device().
2764 device_set_devclass(device_t dev, const char *classname)
2771 devclass_delete_device(dev->devclass, dev);
2775 if (dev->devclass) {
2776 printf("device_set_devclass: device class already set\n");
2780 dc = devclass_find_internal(classname, NULL, TRUE);
2784 error = devclass_add_device(dc, dev);
2786 bus_data_generation_update();
2791 * @brief Set the devclass of a device and mark the devclass fixed.
2792 * @see device_set_devclass()
2795 device_set_devclass_fixed(device_t dev, const char *classname)
2799 if (classname == NULL)
2802 error = device_set_devclass(dev, classname);
2805 dev->flags |= DF_FIXEDCLASS;
2810 * @brief Query the device to determine if it's of a fixed devclass
2811 * @see device_set_devclass_fixed()
2814 device_is_devclass_fixed(device_t dev)
2816 return ((dev->flags & DF_FIXEDCLASS) != 0);
2820 * @brief Set the driver of a device
2823 * @retval EBUSY the device already has a driver attached
2824 * @retval ENOMEM a memory allocation failure occurred
2827 device_set_driver(device_t dev, driver_t *driver)
2830 struct domainset *policy;
2832 if (dev->state >= DS_ATTACHED)
2835 if (dev->driver == driver)
2838 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2839 free_domain(dev->softc, M_BUS_SC);
2842 device_set_desc(dev, NULL);
2843 kobj_delete((kobj_t) dev, NULL);
2844 dev->driver = driver;
2846 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2847 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2848 if (bus_get_domain(dev, &domain) == 0)
2849 policy = DOMAINSET_PREF(domain);
2851 policy = DOMAINSET_RR();
2852 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2853 policy, M_NOWAIT | M_ZERO);
2855 kobj_delete((kobj_t) dev, NULL);
2856 kobj_init((kobj_t) dev, &null_class);
2862 kobj_init((kobj_t) dev, &null_class);
2865 bus_data_generation_update();
2870 * @brief Probe a device, and return this status.
2872 * This function is the core of the device autoconfiguration
2873 * system. Its purpose is to select a suitable driver for a device and
2874 * then call that driver to initialise the hardware appropriately. The
2875 * driver is selected by calling the DEVICE_PROBE() method of a set of
2876 * candidate drivers and then choosing the driver which returned the
2877 * best value. This driver is then attached to the device using
2880 * The set of suitable drivers is taken from the list of drivers in
2881 * the parent device's devclass. If the device was originally created
2882 * with a specific class name (see device_add_child()), only drivers
2883 * with that name are probed, otherwise all drivers in the devclass
2884 * are probed. If no drivers return successful probe values in the
2885 * parent devclass, the search continues in the parent of that
2886 * devclass (see devclass_get_parent()) if any.
2888 * @param dev the device to initialise
2891 * @retval ENXIO no driver was found
2892 * @retval ENOMEM memory allocation failure
2893 * @retval non-zero some other unix error code
2894 * @retval -1 Device already attached
2897 device_probe(device_t dev)
2903 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2906 if (!(dev->flags & DF_ENABLED)) {
2907 if (bootverbose && device_get_name(dev) != NULL) {
2908 device_print_prettyname(dev);
2909 printf("not probed (disabled)\n");
2913 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2914 if (bus_current_pass == BUS_PASS_DEFAULT &&
2915 !(dev->flags & DF_DONENOMATCH)) {
2916 BUS_PROBE_NOMATCH(dev->parent, dev);
2918 dev->flags |= DF_DONENOMATCH;
2926 * @brief Probe a device and attach a driver if possible
2928 * calls device_probe() and attaches if that was successful.
2931 device_probe_and_attach(device_t dev)
2937 error = device_probe(dev);
2940 else if (error != 0)
2943 CURVNET_SET_QUIET(vnet0);
2944 error = device_attach(dev);
2950 * @brief Attach a device driver to a device
2952 * This function is a wrapper around the DEVICE_ATTACH() driver
2953 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2954 * device's sysctl tree, optionally prints a description of the device
2955 * and queues a notification event for user-based device management
2958 * Normally this function is only called internally from
2959 * device_probe_and_attach().
2961 * @param dev the device to initialise
2964 * @retval ENXIO no driver was found
2965 * @retval ENOMEM memory allocation failure
2966 * @retval non-zero some other unix error code
2969 device_attach(device_t dev)
2971 uint64_t attachtime;
2972 uint16_t attachentropy;
2975 if (resource_disabled(dev->driver->name, dev->unit)) {
2976 device_disable(dev);
2978 device_printf(dev, "disabled via hints entry\n");
2982 device_sysctl_init(dev);
2983 if (!device_is_quiet(dev))
2984 device_print_child(dev->parent, dev);
2985 attachtime = get_cyclecount();
2986 dev->state = DS_ATTACHING;
2987 if ((error = DEVICE_ATTACH(dev)) != 0) {
2988 printf("device_attach: %s%d attach returned %d\n",
2989 dev->driver->name, dev->unit, error);
2990 if (!(dev->flags & DF_FIXEDCLASS))
2991 devclass_delete_device(dev->devclass, dev);
2992 (void)device_set_driver(dev, NULL);
2993 device_sysctl_fini(dev);
2994 KASSERT(dev->busy == 0, ("attach failed but busy"));
2995 dev->state = DS_NOTPRESENT;
2998 dev->flags |= DF_ATTACHED_ONCE;
2999 /* We only need the low bits of this time, but ranges from tens to thousands
3000 * have been seen, so keep 2 bytes' worth.
3002 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
3003 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
3004 device_sysctl_update(dev);
3006 dev->state = DS_BUSY;
3008 dev->state = DS_ATTACHED;
3009 dev->flags &= ~DF_DONENOMATCH;
3010 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
3016 * @brief Detach a driver from a device
3018 * This function is a wrapper around the DEVICE_DETACH() driver
3019 * method. If the call to DEVICE_DETACH() succeeds, it calls
3020 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3021 * notification event for user-based device management services and
3022 * cleans up the device's sysctl tree.
3024 * @param dev the device to un-initialise
3027 * @retval ENXIO no driver was found
3028 * @retval ENOMEM memory allocation failure
3029 * @retval non-zero some other unix error code
3032 device_detach(device_t dev)
3038 PDEBUG(("%s", DEVICENAME(dev)));
3039 if (dev->state == DS_BUSY)
3041 if (dev->state == DS_ATTACHING) {
3042 device_printf(dev, "device in attaching state! Deferring detach.\n");
3045 if (dev->state != DS_ATTACHED)
3048 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3049 if ((error = DEVICE_DETACH(dev)) != 0) {
3050 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3051 EVHDEV_DETACH_FAILED);
3054 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3055 EVHDEV_DETACH_COMPLETE);
3058 if (!device_is_quiet(dev))
3059 device_printf(dev, "detached\n");
3061 BUS_CHILD_DETACHED(dev->parent, dev);
3063 if (!(dev->flags & DF_FIXEDCLASS))
3064 devclass_delete_device(dev->devclass, dev);
3066 device_verbose(dev);
3067 dev->state = DS_NOTPRESENT;
3068 (void)device_set_driver(dev, NULL);
3069 device_sysctl_fini(dev);
3075 * @brief Tells a driver to quiesce itself.
3077 * This function is a wrapper around the DEVICE_QUIESCE() driver
3078 * method. If the call to DEVICE_QUIESCE() succeeds.
3080 * @param dev the device to quiesce
3083 * @retval ENXIO no driver was found
3084 * @retval ENOMEM memory allocation failure
3085 * @retval non-zero some other unix error code
3088 device_quiesce(device_t dev)
3091 PDEBUG(("%s", DEVICENAME(dev)));
3092 if (dev->state == DS_BUSY)
3094 if (dev->state != DS_ATTACHED)
3097 return (DEVICE_QUIESCE(dev));
3101 * @brief Notify a device of system shutdown
3103 * This function calls the DEVICE_SHUTDOWN() driver method if the
3104 * device currently has an attached driver.
3106 * @returns the value returned by DEVICE_SHUTDOWN()
3109 device_shutdown(device_t dev)
3111 if (dev->state < DS_ATTACHED)
3113 return (DEVICE_SHUTDOWN(dev));
3117 * @brief Set the unit number of a device
3119 * This function can be used to override the unit number used for a
3120 * device (e.g. to wire a device to a pre-configured unit number).
3123 device_set_unit(device_t dev, int unit)
3128 dc = device_get_devclass(dev);
3129 if (unit < dc->maxunit && dc->devices[unit])
3131 err = devclass_delete_device(dc, dev);
3135 err = devclass_add_device(dc, dev);
3139 bus_data_generation_update();
3143 /*======================================*/
3145 * Some useful method implementations to make life easier for bus drivers.
3149 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3154 args->memattr = VM_MEMATTR_UNCACHEABLE;
3158 * @brief Initialise a resource list.
3160 * @param rl the resource list to initialise
3163 resource_list_init(struct resource_list *rl)
3169 * @brief Reclaim memory used by a resource list.
3171 * This function frees the memory for all resource entries on the list
3174 * @param rl the resource list to free
3177 resource_list_free(struct resource_list *rl)
3179 struct resource_list_entry *rle;
3181 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3183 panic("resource_list_free: resource entry is busy");
3184 STAILQ_REMOVE_HEAD(rl, link);
3190 * @brief Add a resource entry.
3192 * This function adds a resource entry using the given @p type, @p
3193 * start, @p end and @p count values. A rid value is chosen by
3194 * searching sequentially for the first unused rid starting at zero.
3196 * @param rl the resource list to edit
3197 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3198 * @param start the start address of the resource
3199 * @param end the end address of the resource
3200 * @param count XXX end-start+1
3203 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3204 rman_res_t end, rman_res_t count)
3209 while (resource_list_find(rl, type, rid) != NULL)
3211 resource_list_add(rl, type, rid, start, end, count);
3216 * @brief Add or modify a resource entry.
3218 * If an existing entry exists with the same type and rid, it will be
3219 * modified using the given values of @p start, @p end and @p
3220 * count. If no entry exists, a new one will be created using the
3221 * given values. The resource list entry that matches is then returned.
3223 * @param rl the resource list to edit
3224 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3225 * @param rid the resource identifier
3226 * @param start the start address of the resource
3227 * @param end the end address of the resource
3228 * @param count XXX end-start+1
3230 struct resource_list_entry *
3231 resource_list_add(struct resource_list *rl, int type, int rid,
3232 rman_res_t start, rman_res_t end, rman_res_t count)
3234 struct resource_list_entry *rle;
3236 rle = resource_list_find(rl, type, rid);
3238 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3241 panic("resource_list_add: can't record entry");
3242 STAILQ_INSERT_TAIL(rl, rle, link);
3250 panic("resource_list_add: resource entry is busy");
3259 * @brief Determine if a resource entry is busy.
3261 * Returns true if a resource entry is busy meaning that it has an
3262 * associated resource that is not an unallocated "reserved" resource.
3264 * @param rl the resource list to search
3265 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3266 * @param rid the resource identifier
3268 * @returns Non-zero if the entry is busy, zero otherwise.
3271 resource_list_busy(struct resource_list *rl, int type, int rid)
3273 struct resource_list_entry *rle;
3275 rle = resource_list_find(rl, type, rid);
3276 if (rle == NULL || rle->res == NULL)
3278 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3279 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3280 ("reserved resource is active"));
3287 * @brief Determine if a resource entry is reserved.
3289 * Returns true if a resource entry is reserved meaning that it has an
3290 * associated "reserved" resource. The resource can either be
3291 * allocated or unallocated.
3293 * @param rl the resource list to search
3294 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3295 * @param rid the resource identifier
3297 * @returns Non-zero if the entry is reserved, zero otherwise.
3300 resource_list_reserved(struct resource_list *rl, int type, int rid)
3302 struct resource_list_entry *rle;
3304 rle = resource_list_find(rl, type, rid);
3305 if (rle != NULL && rle->flags & RLE_RESERVED)
3311 * @brief Find a resource entry by type and rid.
3313 * @param rl the resource list to search
3314 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3315 * @param rid the resource identifier
3317 * @returns the resource entry pointer or NULL if there is no such
3320 struct resource_list_entry *
3321 resource_list_find(struct resource_list *rl, int type, int rid)
3323 struct resource_list_entry *rle;
3325 STAILQ_FOREACH(rle, rl, link) {
3326 if (rle->type == type && rle->rid == rid)
3333 * @brief Delete a resource entry.
3335 * @param rl the resource list to edit
3336 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3337 * @param rid the resource identifier
3340 resource_list_delete(struct resource_list *rl, int type, int rid)
3342 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3345 if (rle->res != NULL)
3346 panic("resource_list_delete: resource has not been released");
3347 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3353 * @brief Allocate a reserved resource
3355 * This can be used by buses to force the allocation of resources
3356 * that are always active in the system even if they are not allocated
3357 * by a driver (e.g. PCI BARs). This function is usually called when
3358 * adding a new child to the bus. The resource is allocated from the
3359 * parent bus when it is reserved. The resource list entry is marked
3360 * with RLE_RESERVED to note that it is a reserved resource.
3362 * Subsequent attempts to allocate the resource with
3363 * resource_list_alloc() will succeed the first time and will set
3364 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3365 * resource that has been allocated is released with
3366 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3367 * the actual resource remains allocated. The resource can be released to
3368 * the parent bus by calling resource_list_unreserve().
3370 * @param rl the resource list to allocate from
3371 * @param bus the parent device of @p child
3372 * @param child the device for which the resource is being reserved
3373 * @param type the type of resource to allocate
3374 * @param rid a pointer to the resource identifier
3375 * @param start hint at the start of the resource range - pass
3376 * @c 0 for any start address
3377 * @param end hint at the end of the resource range - pass
3378 * @c ~0 for any end address
3379 * @param count hint at the size of range required - pass @c 1
3381 * @param flags any extra flags to control the resource
3382 * allocation - see @c RF_XXX flags in
3383 * <sys/rman.h> for details
3385 * @returns the resource which was allocated or @c NULL if no
3386 * resource could be allocated
3389 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3390 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3392 struct resource_list_entry *rle = NULL;
3393 int passthrough = (device_get_parent(child) != bus);
3398 "resource_list_reserve() should only be called for direct children");
3399 if (flags & RF_ACTIVE)
3401 "resource_list_reserve() should only reserve inactive resources");
3403 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3406 rle = resource_list_find(rl, type, *rid);
3407 rle->flags |= RLE_RESERVED;
3413 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3415 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3416 * and passing the allocation up to the parent of @p bus. This assumes
3417 * that the first entry of @c device_get_ivars(child) is a struct
3418 * resource_list. This also handles 'passthrough' allocations where a
3419 * child is a remote descendant of bus by passing the allocation up to
3420 * the parent of bus.
3422 * Typically, a bus driver would store a list of child resources
3423 * somewhere in the child device's ivars (see device_get_ivars()) and
3424 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3425 * then call resource_list_alloc() to perform the allocation.
3427 * @param rl the resource list to allocate from
3428 * @param bus the parent device of @p child
3429 * @param child the device which is requesting an allocation
3430 * @param type the type of resource to allocate
3431 * @param rid a pointer to the resource identifier
3432 * @param start hint at the start of the resource range - pass
3433 * @c 0 for any start address
3434 * @param end hint at the end of the resource range - pass
3435 * @c ~0 for any end address
3436 * @param count hint at the size of range required - pass @c 1
3438 * @param flags any extra flags to control the resource
3439 * allocation - see @c RF_XXX flags in
3440 * <sys/rman.h> for details
3442 * @returns the resource which was allocated or @c NULL if no
3443 * resource could be allocated
3446 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3447 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3449 struct resource_list_entry *rle = NULL;
3450 int passthrough = (device_get_parent(child) != bus);
3451 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3454 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3455 type, rid, start, end, count, flags));
3458 rle = resource_list_find(rl, type, *rid);
3461 return (NULL); /* no resource of that type/rid */
3464 if (rle->flags & RLE_RESERVED) {
3465 if (rle->flags & RLE_ALLOCATED)
3467 if ((flags & RF_ACTIVE) &&
3468 bus_activate_resource(child, type, *rid,
3471 rle->flags |= RLE_ALLOCATED;
3475 "resource entry %#x type %d for child %s is busy\n", *rid,
3476 type, device_get_nameunit(child));
3482 count = ulmax(count, rle->count);
3483 end = ulmax(rle->end, start + count - 1);
3486 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3487 type, rid, start, end, count, flags);
3490 * Record the new range.
3493 rle->start = rman_get_start(rle->res);
3494 rle->end = rman_get_end(rle->res);
3502 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3504 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3505 * used with resource_list_alloc().
3507 * @param rl the resource list which was allocated from
3508 * @param bus the parent device of @p child
3509 * @param child the device which is requesting a release
3510 * @param type the type of resource to release
3511 * @param rid the resource identifier
3512 * @param res the resource to release
3515 * @retval non-zero a standard unix error code indicating what
3516 * error condition prevented the operation
3519 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3520 int type, int rid, struct resource *res)
3522 struct resource_list_entry *rle = NULL;
3523 int passthrough = (device_get_parent(child) != bus);
3527 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3531 rle = resource_list_find(rl, type, rid);
3534 panic("resource_list_release: can't find resource");
3536 panic("resource_list_release: resource entry is not busy");
3537 if (rle->flags & RLE_RESERVED) {
3538 if (rle->flags & RLE_ALLOCATED) {
3539 if (rman_get_flags(res) & RF_ACTIVE) {
3540 error = bus_deactivate_resource(child, type,
3545 rle->flags &= ~RLE_ALLOCATED;
3551 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3561 * @brief Release all active resources of a given type
3563 * Release all active resources of a specified type. This is intended
3564 * to be used to cleanup resources leaked by a driver after detach or
3567 * @param rl the resource list which was allocated from
3568 * @param bus the parent device of @p child
3569 * @param child the device whose active resources are being released
3570 * @param type the type of resources to release
3573 * @retval EBUSY at least one resource was active
3576 resource_list_release_active(struct resource_list *rl, device_t bus,
3577 device_t child, int type)
3579 struct resource_list_entry *rle;
3583 STAILQ_FOREACH(rle, rl, link) {
3584 if (rle->type != type)
3586 if (rle->res == NULL)
3588 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3592 error = resource_list_release(rl, bus, child, type,
3593 rman_get_rid(rle->res), rle->res);
3596 "Failed to release active resource: %d\n", error);
3602 * @brief Fully release a reserved resource
3604 * Fully releases a resource reserved via resource_list_reserve().
3606 * @param rl the resource list which was allocated from
3607 * @param bus the parent device of @p child
3608 * @param child the device whose reserved resource is being released
3609 * @param type the type of resource to release
3610 * @param rid the resource identifier
3611 * @param res the resource to release
3614 * @retval non-zero a standard unix error code indicating what
3615 * error condition prevented the operation
3618 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3621 struct resource_list_entry *rle = NULL;
3622 int passthrough = (device_get_parent(child) != bus);
3626 "resource_list_unreserve() should only be called for direct children");
3628 rle = resource_list_find(rl, type, rid);
3631 panic("resource_list_unreserve: can't find resource");
3632 if (!(rle->flags & RLE_RESERVED))
3634 if (rle->flags & RLE_ALLOCATED)
3636 rle->flags &= ~RLE_RESERVED;
3637 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3641 * @brief Print a description of resources in a resource list
3643 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3644 * The name is printed if at least one resource of the given type is available.
3645 * The format is used to print resource start and end.
3647 * @param rl the resource list to print
3648 * @param name the name of @p type, e.g. @c "memory"
3649 * @param type type type of resource entry to print
3650 * @param format printf(9) format string to print resource
3651 * start and end values
3653 * @returns the number of characters printed
3656 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3659 struct resource_list_entry *rle;
3660 int printed, retval;
3664 /* Yes, this is kinda cheating */
3665 STAILQ_FOREACH(rle, rl, link) {
3666 if (rle->type == type) {
3668 retval += printf(" %s ", name);
3670 retval += printf(",");
3672 retval += printf(format, rle->start);
3673 if (rle->count > 1) {
3674 retval += printf("-");
3675 retval += printf(format, rle->start +
3684 * @brief Releases all the resources in a list.
3686 * @param rl The resource list to purge.
3691 resource_list_purge(struct resource_list *rl)
3693 struct resource_list_entry *rle;
3695 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3697 bus_release_resource(rman_get_device(rle->res),
3698 rle->type, rle->rid, rle->res);
3699 STAILQ_REMOVE_HEAD(rl, link);
3705 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3708 return (device_add_child_ordered(dev, order, name, unit));
3712 * @brief Helper function for implementing DEVICE_PROBE()
3714 * This function can be used to help implement the DEVICE_PROBE() for
3715 * a bus (i.e. a device which has other devices attached to it). It
3716 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3720 bus_generic_probe(device_t dev)
3722 devclass_t dc = dev->devclass;
3725 TAILQ_FOREACH(dl, &dc->drivers, link) {
3727 * If this driver's pass is too high, then ignore it.
3728 * For most drivers in the default pass, this will
3729 * never be true. For early-pass drivers they will
3730 * only call the identify routines of eligible drivers
3731 * when this routine is called. Drivers for later
3732 * passes should have their identify routines called
3733 * on early-pass buses during BUS_NEW_PASS().
3735 if (dl->pass > bus_current_pass)
3737 DEVICE_IDENTIFY(dl->driver, dev);
3744 * @brief Helper function for implementing DEVICE_ATTACH()
3746 * This function can be used to help implement the DEVICE_ATTACH() for
3747 * a bus. It calls device_probe_and_attach() for each of the device's
3751 bus_generic_attach(device_t dev)
3755 TAILQ_FOREACH(child, &dev->children, link) {
3756 device_probe_and_attach(child);
3763 * @brief Helper function for delaying attaching children
3765 * Many buses can't run transactions on the bus which children need to probe and
3766 * attach until after interrupts and/or timers are running. This function
3767 * delays their attach until interrupts and timers are enabled.
3770 bus_delayed_attach_children(device_t dev)
3772 /* Probe and attach the bus children when interrupts are available */
3773 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3779 * @brief Helper function for implementing DEVICE_DETACH()
3781 * This function can be used to help implement the DEVICE_DETACH() for
3782 * a bus. It calls device_detach() for each of the device's
3786 bus_generic_detach(device_t dev)
3791 if (dev->state != DS_ATTACHED)
3795 * Detach children in the reverse order.
3796 * See bus_generic_suspend for details.
3798 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3799 if ((error = device_detach(child)) != 0)
3807 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3809 * This function can be used to help implement the DEVICE_SHUTDOWN()
3810 * for a bus. It calls device_shutdown() for each of the device's
3814 bus_generic_shutdown(device_t dev)
3819 * Shut down children in the reverse order.
3820 * See bus_generic_suspend for details.
3822 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3823 device_shutdown(child);
3830 * @brief Default function for suspending a child device.
3832 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3835 bus_generic_suspend_child(device_t dev, device_t child)
3839 error = DEVICE_SUSPEND(child);
3842 child->flags |= DF_SUSPENDED;
3848 * @brief Default function for resuming a child device.
3850 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3853 bus_generic_resume_child(device_t dev, device_t child)
3856 DEVICE_RESUME(child);
3857 child->flags &= ~DF_SUSPENDED;
3863 * @brief Helper function for implementing DEVICE_SUSPEND()
3865 * This function can be used to help implement the DEVICE_SUSPEND()
3866 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3867 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3868 * operation is aborted and any devices which were suspended are
3869 * resumed immediately by calling their DEVICE_RESUME() methods.
3872 bus_generic_suspend(device_t dev)
3878 * Suspend children in the reverse order.
3879 * For most buses all children are equal, so the order does not matter.
3880 * Other buses, such as acpi, carefully order their child devices to
3881 * express implicit dependencies between them. For such buses it is
3882 * safer to bring down devices in the reverse order.
3884 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3885 error = BUS_SUSPEND_CHILD(dev, child);
3887 child = TAILQ_NEXT(child, link);
3888 if (child != NULL) {
3889 TAILQ_FOREACH_FROM(child, &dev->children, link)
3890 BUS_RESUME_CHILD(dev, child);
3899 * @brief Helper function for implementing DEVICE_RESUME()
3901 * This function can be used to help implement the DEVICE_RESUME() for
3902 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3905 bus_generic_resume(device_t dev)
3909 TAILQ_FOREACH(child, &dev->children, link) {
3910 BUS_RESUME_CHILD(dev, child);
3911 /* if resume fails, there's nothing we can usefully do... */
3917 * @brief Helper function for implementing BUS_RESET_POST
3919 * Bus can use this function to implement common operations of
3920 * re-attaching or resuming the children after the bus itself was
3921 * reset, and after restoring bus-unique state of children.
3923 * @param dev The bus
3924 * #param flags DEVF_RESET_*
3927 bus_helper_reset_post(device_t dev, int flags)
3933 TAILQ_FOREACH(child, &dev->children,link) {
3934 BUS_RESET_POST(dev, child);
3935 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3936 device_probe_and_attach(child) :
3937 BUS_RESUME_CHILD(dev, child);
3938 if (error == 0 && error1 != 0)
3945 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3948 child = TAILQ_NEXT(child, link);
3951 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3952 BUS_RESET_POST(dev, child);
3953 if ((flags & DEVF_RESET_DETACH) != 0)
3954 device_probe_and_attach(child);
3956 BUS_RESUME_CHILD(dev, child);
3961 * @brief Helper function for implementing BUS_RESET_PREPARE
3963 * Bus can use this function to implement common operations of
3964 * detaching or suspending the children before the bus itself is
3965 * reset, and then save bus-unique state of children that must
3966 * persists around reset.
3968 * @param dev The bus
3969 * #param flags DEVF_RESET_*
3972 bus_helper_reset_prepare(device_t dev, int flags)
3977 if (dev->state != DS_ATTACHED)
3980 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3981 if ((flags & DEVF_RESET_DETACH) != 0) {
3982 error = device_get_state(child) == DS_ATTACHED ?
3983 device_detach(child) : 0;
3985 error = BUS_SUSPEND_CHILD(dev, child);
3988 error = BUS_RESET_PREPARE(dev, child);
3990 if ((flags & DEVF_RESET_DETACH) != 0)
3991 device_probe_and_attach(child);
3993 BUS_RESUME_CHILD(dev, child);
3997 bus_helper_reset_prepare_rollback(dev, child, flags);
4005 * @brief Helper function for implementing BUS_PRINT_CHILD().
4007 * This function prints the first part of the ascii representation of
4008 * @p child, including its name, unit and description (if any - see
4009 * device_set_desc()).
4011 * @returns the number of characters printed
4014 bus_print_child_header(device_t dev, device_t child)
4018 if (device_get_desc(child)) {
4019 retval += device_printf(child, "<%s>", device_get_desc(child));
4021 retval += printf("%s", device_get_nameunit(child));
4028 * @brief Helper function for implementing BUS_PRINT_CHILD().
4030 * This function prints the last part of the ascii representation of
4031 * @p child, which consists of the string @c " on " followed by the
4032 * name and unit of the @p dev.
4034 * @returns the number of characters printed
4037 bus_print_child_footer(device_t dev, device_t child)
4039 return (printf(" on %s\n", device_get_nameunit(dev)));
4043 * @brief Helper function for implementing BUS_PRINT_CHILD().
4045 * This function prints out the VM domain for the given device.
4047 * @returns the number of characters printed
4050 bus_print_child_domain(device_t dev, device_t child)
4054 /* No domain? Don't print anything */
4055 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4058 return (printf(" numa-domain %d", domain));
4062 * @brief Helper function for implementing BUS_PRINT_CHILD().
4064 * This function simply calls bus_print_child_header() followed by
4065 * bus_print_child_footer().
4067 * @returns the number of characters printed
4070 bus_generic_print_child(device_t dev, device_t child)
4074 retval += bus_print_child_header(dev, child);
4075 retval += bus_print_child_domain(dev, child);
4076 retval += bus_print_child_footer(dev, child);
4082 * @brief Stub function for implementing BUS_READ_IVAR().
4087 bus_generic_read_ivar(device_t dev, device_t child, int index,
4094 * @brief Stub function for implementing BUS_WRITE_IVAR().
4099 bus_generic_write_ivar(device_t dev, device_t child, int index,
4106 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4110 struct resource_list *
4111 bus_generic_get_resource_list(device_t dev, device_t child)
4117 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4119 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4120 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4121 * and then calls device_probe_and_attach() for each unattached child.
4124 bus_generic_driver_added(device_t dev, driver_t *driver)
4128 DEVICE_IDENTIFY(driver, dev);
4129 TAILQ_FOREACH(child, &dev->children, link) {
4130 if (child->state == DS_NOTPRESENT ||
4131 (child->flags & DF_REBID))
4132 device_probe_and_attach(child);
4137 * @brief Helper function for implementing BUS_NEW_PASS().
4139 * This implementing of BUS_NEW_PASS() first calls the identify
4140 * routines for any drivers that probe at the current pass. Then it
4141 * walks the list of devices for this bus. If a device is already
4142 * attached, then it calls BUS_NEW_PASS() on that device. If the
4143 * device is not already attached, it attempts to attach a driver to
4147 bus_generic_new_pass(device_t dev)
4154 TAILQ_FOREACH(dl, &dc->drivers, link) {
4155 if (dl->pass == bus_current_pass)
4156 DEVICE_IDENTIFY(dl->driver, dev);
4158 TAILQ_FOREACH(child, &dev->children, link) {
4159 if (child->state >= DS_ATTACHED)
4160 BUS_NEW_PASS(child);
4161 else if (child->state == DS_NOTPRESENT)
4162 device_probe_and_attach(child);
4167 * @brief Helper function for implementing BUS_SETUP_INTR().
4169 * This simple implementation of BUS_SETUP_INTR() simply calls the
4170 * BUS_SETUP_INTR() method of the parent of @p dev.
4173 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4174 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4177 /* Propagate up the bus hierarchy until someone handles it. */
4179 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4180 filter, intr, arg, cookiep));
4185 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4187 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4188 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4191 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4194 /* Propagate up the bus hierarchy until someone handles it. */
4196 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4201 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4203 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4204 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4207 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4209 /* Propagate up the bus hierarchy until someone handles it. */
4211 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4216 * @brief Helper function for implementing BUS_RESUME_INTR().
4218 * This simple implementation of BUS_RESUME_INTR() simply calls the
4219 * BUS_RESUME_INTR() method of the parent of @p dev.
4222 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4224 /* Propagate up the bus hierarchy until someone handles it. */
4226 return (BUS_RESUME_INTR(dev->parent, child, irq));
4231 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4233 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4234 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4237 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4238 struct resource *r, rman_res_t start, rman_res_t end)
4240 /* Propagate up the bus hierarchy until someone handles it. */
4242 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4248 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4250 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4251 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4254 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4255 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4257 /* Propagate up the bus hierarchy until someone handles it. */
4259 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4260 start, end, count, flags));
4265 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4267 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4268 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4271 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4274 /* Propagate up the bus hierarchy until someone handles it. */
4276 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4282 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4284 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4285 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4288 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4291 /* Propagate up the bus hierarchy until someone handles it. */
4293 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4299 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4301 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4302 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4305 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4306 int rid, struct resource *r)
4308 /* Propagate up the bus hierarchy until someone handles it. */
4310 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4316 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4318 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4319 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4322 bus_generic_map_resource(device_t dev, device_t child, int type,
4323 struct resource *r, struct resource_map_request *args,
4324 struct resource_map *map)
4326 /* Propagate up the bus hierarchy until someone handles it. */
4328 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4334 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4336 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4337 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4340 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4341 struct resource *r, struct resource_map *map)
4343 /* Propagate up the bus hierarchy until someone handles it. */
4345 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4350 * @brief Helper function for implementing BUS_BIND_INTR().
4352 * This simple implementation of BUS_BIND_INTR() simply calls the
4353 * BUS_BIND_INTR() method of the parent of @p dev.
4356 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4360 /* Propagate up the bus hierarchy until someone handles it. */
4362 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4367 * @brief Helper function for implementing BUS_CONFIG_INTR().
4369 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4370 * BUS_CONFIG_INTR() method of the parent of @p dev.
4373 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4374 enum intr_polarity pol)
4377 /* Propagate up the bus hierarchy until someone handles it. */
4379 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4384 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4386 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4387 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4390 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4391 void *cookie, const char *descr)
4394 /* Propagate up the bus hierarchy until someone handles it. */
4396 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4402 * @brief Helper function for implementing BUS_GET_CPUS().
4404 * This simple implementation of BUS_GET_CPUS() simply calls the
4405 * BUS_GET_CPUS() method of the parent of @p dev.
4408 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4409 size_t setsize, cpuset_t *cpuset)
4412 /* Propagate up the bus hierarchy until someone handles it. */
4413 if (dev->parent != NULL)
4414 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4419 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4421 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4422 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4425 bus_generic_get_dma_tag(device_t dev, device_t child)
4428 /* Propagate up the bus hierarchy until someone handles it. */
4429 if (dev->parent != NULL)
4430 return (BUS_GET_DMA_TAG(dev->parent, child));
4435 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4437 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4438 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4441 bus_generic_get_bus_tag(device_t dev, device_t child)
4444 /* Propagate up the bus hierarchy until someone handles it. */
4445 if (dev->parent != NULL)
4446 return (BUS_GET_BUS_TAG(dev->parent, child));
4447 return ((bus_space_tag_t)0);
4451 * @brief Helper function for implementing BUS_GET_RESOURCE().
4453 * This implementation of BUS_GET_RESOURCE() uses the
4454 * resource_list_find() function to do most of the work. It calls
4455 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4459 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4460 rman_res_t *startp, rman_res_t *countp)
4462 struct resource_list * rl = NULL;
4463 struct resource_list_entry * rle = NULL;
4465 rl = BUS_GET_RESOURCE_LIST(dev, child);
4469 rle = resource_list_find(rl, type, rid);
4474 *startp = rle->start;
4476 *countp = rle->count;
4482 * @brief Helper function for implementing BUS_SET_RESOURCE().
4484 * This implementation of BUS_SET_RESOURCE() uses the
4485 * resource_list_add() function to do most of the work. It calls
4486 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4490 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4491 rman_res_t start, rman_res_t count)
4493 struct resource_list * rl = NULL;
4495 rl = BUS_GET_RESOURCE_LIST(dev, child);
4499 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4505 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4507 * This implementation of BUS_DELETE_RESOURCE() uses the
4508 * resource_list_delete() function to do most of the work. It calls
4509 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4513 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4515 struct resource_list * rl = NULL;
4517 rl = BUS_GET_RESOURCE_LIST(dev, child);
4521 resource_list_delete(rl, type, rid);
4527 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4529 * This implementation of BUS_RELEASE_RESOURCE() uses the
4530 * resource_list_release() function to do most of the work. It calls
4531 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4534 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4535 int rid, struct resource *r)
4537 struct resource_list * rl = NULL;
4539 if (device_get_parent(child) != dev)
4540 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4543 rl = BUS_GET_RESOURCE_LIST(dev, child);
4547 return (resource_list_release(rl, dev, child, type, rid, r));
4551 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4553 * This implementation of BUS_ALLOC_RESOURCE() uses the
4554 * resource_list_alloc() function to do most of the work. It calls
4555 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4558 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4559 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4561 struct resource_list * rl = NULL;
4563 if (device_get_parent(child) != dev)
4564 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4565 type, rid, start, end, count, flags));
4567 rl = BUS_GET_RESOURCE_LIST(dev, child);
4571 return (resource_list_alloc(rl, dev, child, type, rid,
4572 start, end, count, flags));
4576 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4578 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4579 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4582 bus_generic_child_present(device_t dev, device_t child)
4584 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4588 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4592 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4598 * @brief Helper function for implementing BUS_RESCAN().
4600 * This null implementation of BUS_RESCAN() always fails to indicate
4601 * the bus does not support rescanning.
4604 bus_null_rescan(device_t dev)
4611 * Some convenience functions to make it easier for drivers to use the
4612 * resource-management functions. All these really do is hide the
4613 * indirection through the parent's method table, making for slightly
4614 * less-wordy code. In the future, it might make sense for this code
4615 * to maintain some sort of a list of resources allocated by each device.
4619 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4620 struct resource **res)
4624 for (i = 0; rs[i].type != -1; i++)
4626 for (i = 0; rs[i].type != -1; i++) {
4627 res[i] = bus_alloc_resource_any(dev,
4628 rs[i].type, &rs[i].rid, rs[i].flags);
4629 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4630 bus_release_resources(dev, rs, res);
4638 bus_release_resources(device_t dev, const struct resource_spec *rs,
4639 struct resource **res)
4643 for (i = 0; rs[i].type != -1; i++)
4644 if (res[i] != NULL) {
4645 bus_release_resource(
4646 dev, rs[i].type, rs[i].rid, res[i]);
4652 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4654 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4658 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4659 rman_res_t end, rman_res_t count, u_int flags)
4661 struct resource *res;
4663 if (dev->parent == NULL)
4665 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4671 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4673 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4677 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4680 if (dev->parent == NULL)
4682 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4686 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4688 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4692 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4694 if (dev->parent == NULL)
4696 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4700 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4702 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4706 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4708 if (dev->parent == NULL)
4710 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4714 * @brief Wrapper function for BUS_MAP_RESOURCE().
4716 * This function simply calls the BUS_MAP_RESOURCE() method of the
4720 bus_map_resource(device_t dev, int type, struct resource *r,
4721 struct resource_map_request *args, struct resource_map *map)
4723 if (dev->parent == NULL)
4725 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4729 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4731 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4735 bus_unmap_resource(device_t dev, int type, struct resource *r,
4736 struct resource_map *map)
4738 if (dev->parent == NULL)
4740 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4744 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4746 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4750 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4754 if (dev->parent == NULL)
4756 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4761 * @brief Wrapper function for BUS_SETUP_INTR().
4763 * This function simply calls the BUS_SETUP_INTR() method of the
4767 bus_setup_intr(device_t dev, struct resource *r, int flags,
4768 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4772 if (dev->parent == NULL)
4774 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4778 if (handler != NULL && !(flags & INTR_MPSAFE))
4779 device_printf(dev, "[GIANT-LOCKED]\n");
4784 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4786 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4790 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4792 if (dev->parent == NULL)
4794 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4798 * @brief Wrapper function for BUS_SUSPEND_INTR().
4800 * This function simply calls the BUS_SUSPEND_INTR() method of the
4804 bus_suspend_intr(device_t dev, struct resource *r)
4806 if (dev->parent == NULL)
4808 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4812 * @brief Wrapper function for BUS_RESUME_INTR().
4814 * This function simply calls the BUS_RESUME_INTR() method of the
4818 bus_resume_intr(device_t dev, struct resource *r)
4820 if (dev->parent == NULL)
4822 return (BUS_RESUME_INTR(dev->parent, dev, r));
4826 * @brief Wrapper function for BUS_BIND_INTR().
4828 * This function simply calls the BUS_BIND_INTR() method of the
4832 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4834 if (dev->parent == NULL)
4836 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4840 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4842 * This function first formats the requested description into a
4843 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4844 * the parent of @p dev.
4847 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4848 const char *fmt, ...)
4851 char descr[MAXCOMLEN + 1];
4853 if (dev->parent == NULL)
4856 vsnprintf(descr, sizeof(descr), fmt, ap);
4858 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4862 * @brief Wrapper function for BUS_SET_RESOURCE().
4864 * This function simply calls the BUS_SET_RESOURCE() method of the
4868 bus_set_resource(device_t dev, int type, int rid,
4869 rman_res_t start, rman_res_t count)
4871 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4876 * @brief Wrapper function for BUS_GET_RESOURCE().
4878 * This function simply calls the BUS_GET_RESOURCE() method of the
4882 bus_get_resource(device_t dev, int type, int rid,
4883 rman_res_t *startp, rman_res_t *countp)
4885 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4890 * @brief Wrapper function for BUS_GET_RESOURCE().
4892 * This function simply calls the BUS_GET_RESOURCE() method of the
4893 * parent of @p dev and returns the start value.
4896 bus_get_resource_start(device_t dev, int type, int rid)
4902 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4910 * @brief Wrapper function for BUS_GET_RESOURCE().
4912 * This function simply calls the BUS_GET_RESOURCE() method of the
4913 * parent of @p dev and returns the count value.
4916 bus_get_resource_count(device_t dev, int type, int rid)
4922 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4930 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4932 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4936 bus_delete_resource(device_t dev, int type, int rid)
4938 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4942 * @brief Wrapper function for BUS_CHILD_PRESENT().
4944 * This function simply calls the BUS_CHILD_PRESENT() method of the
4948 bus_child_present(device_t child)
4950 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4954 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4956 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4960 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4964 parent = device_get_parent(child);
4965 if (parent == NULL) {
4969 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4973 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4975 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4979 bus_child_location_str(device_t child, char *buf, size_t buflen)
4983 parent = device_get_parent(child);
4984 if (parent == NULL) {
4988 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4992 * @brief Wrapper function for BUS_GET_CPUS().
4994 * This function simply calls the BUS_GET_CPUS() method of the
4998 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
5002 parent = device_get_parent(dev);
5005 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
5009 * @brief Wrapper function for BUS_GET_DMA_TAG().
5011 * This function simply calls the BUS_GET_DMA_TAG() method of the
5015 bus_get_dma_tag(device_t dev)
5019 parent = device_get_parent(dev);
5022 return (BUS_GET_DMA_TAG(parent, dev));
5026 * @brief Wrapper function for BUS_GET_BUS_TAG().
5028 * This function simply calls the BUS_GET_BUS_TAG() method of the
5032 bus_get_bus_tag(device_t dev)
5036 parent = device_get_parent(dev);
5038 return ((bus_space_tag_t)0);
5039 return (BUS_GET_BUS_TAG(parent, dev));
5043 * @brief Wrapper function for BUS_GET_DOMAIN().
5045 * This function simply calls the BUS_GET_DOMAIN() method of the
5049 bus_get_domain(device_t dev, int *domain)
5051 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5054 /* Resume all devices and then notify userland that we're up again. */
5056 root_resume(device_t dev)
5060 error = bus_generic_resume(dev);
5062 devctl_notify("kern", "power", "resume", NULL);
5067 root_print_child(device_t dev, device_t child)
5071 retval += bus_print_child_header(dev, child);
5072 retval += printf("\n");
5078 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5079 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5082 * If an interrupt mapping gets to here something bad has happened.
5084 panic("root_setup_intr");
5088 * If we get here, assume that the device is permanent and really is
5089 * present in the system. Removable bus drivers are expected to intercept
5090 * this call long before it gets here. We return -1 so that drivers that
5091 * really care can check vs -1 or some ERRNO returned higher in the food
5095 root_child_present(device_t dev, device_t child)
5101 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5107 /* Default to returning the set of all CPUs. */
5108 if (setsize != sizeof(cpuset_t))
5117 static kobj_method_t root_methods[] = {
5118 /* Device interface */
5119 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5120 KOBJMETHOD(device_suspend, bus_generic_suspend),
5121 KOBJMETHOD(device_resume, root_resume),
5124 KOBJMETHOD(bus_print_child, root_print_child),
5125 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5126 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5127 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5128 KOBJMETHOD(bus_child_present, root_child_present),
5129 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5134 static driver_t root_driver = {
5141 devclass_t root_devclass;
5144 root_bus_module_handler(module_t mod, int what, void* arg)
5148 TAILQ_INIT(&bus_data_devices);
5149 kobj_class_compile((kobj_class_t) &root_driver);
5150 root_bus = make_device(NULL, "root", 0);
5151 root_bus->desc = "System root bus";
5152 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5153 root_bus->driver = &root_driver;
5154 root_bus->state = DS_ATTACHED;
5155 root_devclass = devclass_find_internal("root", NULL, FALSE);
5160 device_shutdown(root_bus);
5163 return (EOPNOTSUPP);
5169 static moduledata_t root_bus_mod = {
5171 root_bus_module_handler,
5174 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5177 * @brief Automatically configure devices
5179 * This function begins the autoconfiguration process by calling
5180 * device_probe_and_attach() for each child of the @c root0 device.
5183 root_bus_configure(void)
5188 /* Eventually this will be split up, but this is sufficient for now. */
5189 bus_set_pass(BUS_PASS_DEFAULT);
5193 * @brief Module handler for registering device drivers
5195 * This module handler is used to automatically register device
5196 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5197 * devclass_add_driver() for the driver described by the
5198 * driver_module_data structure pointed to by @p arg
5201 driver_module_handler(module_t mod, int what, void *arg)
5203 struct driver_module_data *dmd;
5204 devclass_t bus_devclass;
5205 kobj_class_t driver;
5208 dmd = (struct driver_module_data *)arg;
5209 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5214 if (dmd->dmd_chainevh)
5215 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5217 pass = dmd->dmd_pass;
5218 driver = dmd->dmd_driver;
5219 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5220 DRIVERNAME(driver), dmd->dmd_busname, pass));
5221 error = devclass_add_driver(bus_devclass, driver, pass,
5226 PDEBUG(("Unloading module: driver %s from bus %s",
5227 DRIVERNAME(dmd->dmd_driver),
5229 error = devclass_delete_driver(bus_devclass,
5232 if (!error && dmd->dmd_chainevh)
5233 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5236 PDEBUG(("Quiesce module: driver %s from bus %s",
5237 DRIVERNAME(dmd->dmd_driver),
5239 error = devclass_quiesce_driver(bus_devclass,
5242 if (!error && dmd->dmd_chainevh)
5243 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5254 * @brief Enumerate all hinted devices for this bus.
5256 * Walks through the hints for this bus and calls the bus_hinted_child
5257 * routine for each one it fines. It searches first for the specific
5258 * bus that's being probed for hinted children (eg isa0), and then for
5259 * generic children (eg isa).
5261 * @param dev bus device to enumerate
5264 bus_enumerate_hinted_children(device_t bus)
5267 const char *dname, *busname;
5271 * enumerate all devices on the specific bus
5273 busname = device_get_nameunit(bus);
5275 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5276 BUS_HINTED_CHILD(bus, dname, dunit);
5279 * and all the generic ones.
5281 busname = device_get_name(bus);
5283 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5284 BUS_HINTED_CHILD(bus, dname, dunit);
5289 /* the _short versions avoid iteration by not calling anything that prints
5290 * more than oneliners. I love oneliners.
5294 print_device_short(device_t dev, int indent)
5299 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5300 dev->unit, dev->desc,
5301 (dev->parent? "":"no "),
5302 (TAILQ_EMPTY(&dev->children)? "no ":""),
5303 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5304 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5305 (dev->flags&DF_WILDCARD? "wildcard,":""),
5306 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5307 (dev->flags&DF_REBID? "rebiddable,":""),
5308 (dev->flags&DF_SUSPENDED? "suspended,":""),
5309 (dev->ivars? "":"no "),
5310 (dev->softc? "":"no "),
5315 print_device(device_t dev, int indent)
5320 print_device_short(dev, indent);
5322 indentprintf(("Parent:\n"));
5323 print_device_short(dev->parent, indent+1);
5324 indentprintf(("Driver:\n"));
5325 print_driver_short(dev->driver, indent+1);
5326 indentprintf(("Devclass:\n"));
5327 print_devclass_short(dev->devclass, indent+1);
5331 print_device_tree_short(device_t dev, int indent)
5332 /* print the device and all its children (indented) */
5339 print_device_short(dev, indent);
5341 TAILQ_FOREACH(child, &dev->children, link) {
5342 print_device_tree_short(child, indent+1);
5347 print_device_tree(device_t dev, int indent)
5348 /* print the device and all its children (indented) */
5355 print_device(dev, indent);
5357 TAILQ_FOREACH(child, &dev->children, link) {
5358 print_device_tree(child, indent+1);
5363 print_driver_short(driver_t *driver, int indent)
5368 indentprintf(("driver %s: softc size = %zd\n",
5369 driver->name, driver->size));
5373 print_driver(driver_t *driver, int indent)
5378 print_driver_short(driver, indent);
5382 print_driver_list(driver_list_t drivers, int indent)
5384 driverlink_t driver;
5386 TAILQ_FOREACH(driver, &drivers, link) {
5387 print_driver(driver->driver, indent);
5392 print_devclass_short(devclass_t dc, int indent)
5397 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5401 print_devclass(devclass_t dc, int indent)
5408 print_devclass_short(dc, indent);
5409 indentprintf(("Drivers:\n"));
5410 print_driver_list(dc->drivers, indent+1);
5412 indentprintf(("Devices:\n"));
5413 for (i = 0; i < dc->maxunit; i++)
5415 print_device(dc->devices[i], indent+1);
5419 print_devclass_list_short(void)
5423 printf("Short listing of devclasses, drivers & devices:\n");
5424 TAILQ_FOREACH(dc, &devclasses, link) {
5425 print_devclass_short(dc, 0);
5430 print_devclass_list(void)
5434 printf("Full listing of devclasses, drivers & devices:\n");
5435 TAILQ_FOREACH(dc, &devclasses, link) {
5436 print_devclass(dc, 0);
5443 * User-space access to the device tree.
5445 * We implement a small set of nodes:
5447 * hw.bus Single integer read method to obtain the
5448 * current generation count.
5449 * hw.bus.devices Reads the entire device tree in flat space.
5450 * hw.bus.rman Resource manager interface
5452 * We might like to add the ability to scan devclasses and/or drivers to
5453 * determine what else is currently loaded/available.
5457 sysctl_bus(SYSCTL_HANDLER_ARGS)
5459 struct u_businfo ubus;
5461 ubus.ub_version = BUS_USER_VERSION;
5462 ubus.ub_generation = bus_data_generation;
5464 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5466 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW | CTLFLAG_NEEDGIANT, sysctl_bus,
5467 "bus-related data");
5470 sysctl_devices(SYSCTL_HANDLER_ARGS)
5472 int *name = (int *)arg1;
5473 u_int namelen = arg2;
5476 struct u_device *udev;
5483 if (bus_data_generation_check(name[0]))
5489 * Scan the list of devices, looking for the requested index.
5491 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5499 * Populate the return item, careful not to overflow the buffer.
5501 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5504 udev->dv_handle = (uintptr_t)dev;
5505 udev->dv_parent = (uintptr_t)dev->parent;
5506 udev->dv_devflags = dev->devflags;
5507 udev->dv_flags = dev->flags;
5508 udev->dv_state = dev->state;
5509 walker = udev->dv_fields;
5510 ep = walker + sizeof(udev->dv_fields);
5512 if ((src) == NULL) \
5515 strlcpy(walker, (src), ep - walker); \
5516 walker += strlen(walker) + 1; \
5524 CP(dev->driver != NULL ? dev->driver->name : NULL);
5525 bus_child_pnpinfo_str(dev, walker, ep - walker);
5526 walker += strlen(walker) + 1;
5529 bus_child_location_str(dev, walker, ep - walker);
5530 walker += strlen(walker) + 1;
5536 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5541 SYSCTL_NODE(_hw_bus, OID_AUTO, devices,
5542 CTLFLAG_RD | CTLFLAG_NEEDGIANT, sysctl_devices,
5543 "system device tree");
5546 bus_data_generation_check(int generation)
5548 if (generation != bus_data_generation)
5551 /* XXX generate optimised lists here? */
5556 bus_data_generation_update(void)
5558 bus_data_generation++;
5562 bus_free_resource(device_t dev, int type, struct resource *r)
5566 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5570 device_lookup_by_name(const char *name)
5574 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5575 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5582 * /dev/devctl2 implementation. The existing /dev/devctl device has
5583 * implicit semantics on open, so it could not be reused for this.
5584 * Another option would be to call this /dev/bus?
5587 find_device(struct devreq *req, device_t *devp)
5592 * First, ensure that the name is nul terminated.
5594 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5598 * Second, try to find an attached device whose name matches
5601 dev = device_lookup_by_name(req->dr_name);
5607 /* Finally, give device enumerators a chance. */
5609 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5617 driver_exists(device_t bus, const char *driver)
5621 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5622 if (devclass_find_driver_internal(dc, driver) != NULL)
5629 device_gen_nomatch(device_t dev)
5633 if (dev->flags & DF_NEEDNOMATCH &&
5634 dev->state == DS_NOTPRESENT) {
5635 BUS_PROBE_NOMATCH(dev->parent, dev);
5637 dev->flags |= DF_DONENOMATCH;
5639 dev->flags &= ~DF_NEEDNOMATCH;
5640 TAILQ_FOREACH(child, &dev->children, link) {
5641 device_gen_nomatch(child);
5646 device_do_deferred_actions(void)
5652 * Walk through the devclasses to find all the drivers we've tagged as
5653 * deferred during the freeze and call the driver added routines. They
5654 * have already been added to the lists in the background, so the driver
5655 * added routines that trigger a probe will have all the right bidders
5656 * for the probe auction.
5658 TAILQ_FOREACH(dc, &devclasses, link) {
5659 TAILQ_FOREACH(dl, &dc->drivers, link) {
5660 if (dl->flags & DL_DEFERRED_PROBE) {
5661 devclass_driver_added(dc, dl->driver);
5662 dl->flags &= ~DL_DEFERRED_PROBE;
5668 * We also defer no-match events during a freeze. Walk the tree and
5669 * generate all the pent-up events that are still relevant.
5671 device_gen_nomatch(root_bus);
5672 bus_data_generation_update();
5676 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5683 /* Locate the device to control. */
5685 req = (struct devreq *)data;
5693 case DEV_SET_DRIVER:
5694 case DEV_CLEAR_DRIVER:
5698 error = priv_check(td, PRIV_DRIVER);
5700 error = find_device(req, &dev);
5704 error = priv_check(td, PRIV_DRIVER);
5715 /* Perform the requested operation. */
5718 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5720 else if (!device_is_enabled(dev))
5723 error = device_probe_and_attach(dev);
5726 if (!device_is_attached(dev)) {
5730 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5731 error = device_quiesce(dev);
5735 error = device_detach(dev);
5738 if (device_is_enabled(dev)) {
5744 * If the device has been probed but not attached (e.g.
5745 * when it has been disabled by a loader hint), just
5746 * attach the device rather than doing a full probe.
5749 if (device_is_alive(dev)) {
5751 * If the device was disabled via a hint, clear
5754 if (resource_disabled(dev->driver->name, dev->unit))
5755 resource_unset_value(dev->driver->name,
5756 dev->unit, "disabled");
5757 error = device_attach(dev);
5759 error = device_probe_and_attach(dev);
5762 if (!device_is_enabled(dev)) {
5767 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5768 error = device_quiesce(dev);
5774 * Force DF_FIXEDCLASS on around detach to preserve
5775 * the existing name.
5778 dev->flags |= DF_FIXEDCLASS;
5779 error = device_detach(dev);
5780 if (!(old & DF_FIXEDCLASS))
5781 dev->flags &= ~DF_FIXEDCLASS;
5783 device_disable(dev);
5786 if (device_is_suspended(dev)) {
5790 if (device_get_parent(dev) == NULL) {
5794 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5797 if (!device_is_suspended(dev)) {
5801 if (device_get_parent(dev) == NULL) {
5805 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5807 case DEV_SET_DRIVER: {
5811 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5814 if (driver[0] == '\0') {
5818 if (dev->devclass != NULL &&
5819 strcmp(driver, dev->devclass->name) == 0)
5820 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5824 * Scan drivers for this device's bus looking for at
5825 * least one matching driver.
5827 if (dev->parent == NULL) {
5831 if (!driver_exists(dev->parent, driver)) {
5835 dc = devclass_create(driver);
5841 /* Detach device if necessary. */
5842 if (device_is_attached(dev)) {
5843 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5844 error = device_detach(dev);
5851 /* Clear any previously-fixed device class and unit. */
5852 if (dev->flags & DF_FIXEDCLASS)
5853 devclass_delete_device(dev->devclass, dev);
5854 dev->flags |= DF_WILDCARD;
5857 /* Force the new device class. */
5858 error = devclass_add_device(dc, dev);
5861 dev->flags |= DF_FIXEDCLASS;
5862 error = device_probe_and_attach(dev);
5865 case DEV_CLEAR_DRIVER:
5866 if (!(dev->flags & DF_FIXEDCLASS)) {
5870 if (device_is_attached(dev)) {
5871 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5872 error = device_detach(dev);
5879 dev->flags &= ~DF_FIXEDCLASS;
5880 dev->flags |= DF_WILDCARD;
5881 devclass_delete_device(dev->devclass, dev);
5882 error = device_probe_and_attach(dev);
5885 if (!device_is_attached(dev)) {
5889 error = BUS_RESCAN(dev);
5894 parent = device_get_parent(dev);
5895 if (parent == NULL) {
5899 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5900 if (bus_child_present(dev) != 0) {
5906 error = device_delete_child(parent, dev);
5913 device_frozen = true;
5919 device_do_deferred_actions();
5920 device_frozen = false;
5924 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5928 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5936 static struct cdevsw devctl2_cdevsw = {
5937 .d_version = D_VERSION,
5938 .d_ioctl = devctl2_ioctl,
5939 .d_name = "devctl2",
5946 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5947 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5951 * APIs to manage deprecation and obsolescence.
5953 static int obsolete_panic = 0;
5954 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5955 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5956 "2 = if deprecated)");
5959 gone_panic(int major, int running, const char *msg)
5962 switch (obsolete_panic)
5967 if (running < major)
5976 _gone_in(int major, const char *msg)
5979 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5980 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5981 printf("Obsolete code will be removed soon: %s\n", msg);
5983 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5988 _gone_in_dev(device_t dev, int major, const char *msg)
5991 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5992 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5994 "Obsolete code will be removed soon: %s\n", msg);
5997 "Deprecated code (to be removed in FreeBSD %d): %s\n",
6002 DB_SHOW_COMMAND(device, db_show_device)
6009 dev = (device_t)addr;
6011 db_printf("name: %s\n", device_get_nameunit(dev));
6012 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
6013 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
6014 db_printf(" addr: %p\n", dev);
6015 db_printf(" parent: %p\n", dev->parent);
6016 db_printf(" softc: %p\n", dev->softc);
6017 db_printf(" ivars: %p\n", dev->ivars);
6020 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
6024 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
6025 db_show_device((db_expr_t)dev, true, count, modif);