2 * Copyright (c) 1997,1998,2003 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/filio.h>
36 #include <sys/kernel.h>
38 #include <sys/limits.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
45 #include <sys/condvar.h>
46 #include <sys/queue.h>
47 #include <machine/bus.h>
48 #include <sys/random.h>
50 #include <sys/selinfo.h>
51 #include <sys/signalvar.h>
53 #include <sys/sysctl.h>
54 #include <sys/systm.h>
57 #include <sys/interrupt.h>
58 #include <sys/cpuset.h>
62 #include <machine/cpu.h>
63 #include <machine/stdarg.h>
68 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
69 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
72 * Used to attach drivers to devclasses.
74 typedef struct driverlink *driverlink_t;
77 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
79 TAILQ_ENTRY(driverlink) passlink;
83 * Forward declarations
85 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
86 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
87 typedef TAILQ_HEAD(device_list, device) device_list_t;
90 TAILQ_ENTRY(devclass) link;
91 devclass_t parent; /* parent in devclass hierarchy */
92 driver_list_t drivers; /* bus devclasses store drivers for bus */
94 device_t *devices; /* array of devices indexed by unit */
95 int maxunit; /* size of devices array */
97 #define DC_HAS_CHILDREN 1
99 struct sysctl_ctx_list sysctl_ctx;
100 struct sysctl_oid *sysctl_tree;
104 * @brief Implementation of device.
108 * A device is a kernel object. The first field must be the
109 * current ops table for the object.
116 TAILQ_ENTRY(device) link; /**< list of devices in parent */
117 TAILQ_ENTRY(device) devlink; /**< global device list membership */
118 device_t parent; /**< parent of this device */
119 device_list_t children; /**< list of child devices */
122 * Details of this device.
124 driver_t *driver; /**< current driver */
125 devclass_t devclass; /**< current device class */
126 int unit; /**< current unit number */
127 char* nameunit; /**< name+unit e.g. foodev0 */
128 char* desc; /**< driver specific description */
129 int busy; /**< count of calls to device_busy() */
130 device_state_t state; /**< current device state */
131 uint32_t devflags; /**< api level flags for device_get_flags() */
132 u_int flags; /**< internal device flags */
133 u_int order; /**< order from device_add_child_ordered() */
134 void *ivars; /**< instance variables */
135 void *softc; /**< current driver's variables */
137 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
138 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
141 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
142 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
144 static void devctl2_init(void);
148 static int bus_debug = 1;
149 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
152 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
153 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
154 #define DRIVERNAME(d) ((d)? d->name : "no driver")
155 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
158 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
159 * prevent syslog from deleting initial spaces
161 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
163 static void print_device_short(device_t dev, int indent);
164 static void print_device(device_t dev, int indent);
165 void print_device_tree_short(device_t dev, int indent);
166 void print_device_tree(device_t dev, int indent);
167 static void print_driver_short(driver_t *driver, int indent);
168 static void print_driver(driver_t *driver, int indent);
169 static void print_driver_list(driver_list_t drivers, int indent);
170 static void print_devclass_short(devclass_t dc, int indent);
171 static void print_devclass(devclass_t dc, int indent);
172 void print_devclass_list_short(void);
173 void print_devclass_list(void);
176 /* Make the compiler ignore the function calls */
177 #define PDEBUG(a) /* nop */
178 #define DEVICENAME(d) /* nop */
179 #define DRIVERNAME(d) /* nop */
180 #define DEVCLANAME(d) /* nop */
182 #define print_device_short(d,i) /* nop */
183 #define print_device(d,i) /* nop */
184 #define print_device_tree_short(d,i) /* nop */
185 #define print_device_tree(d,i) /* nop */
186 #define print_driver_short(d,i) /* nop */
187 #define print_driver(d,i) /* nop */
188 #define print_driver_list(d,i) /* nop */
189 #define print_devclass_short(d,i) /* nop */
190 #define print_devclass(d,i) /* nop */
191 #define print_devclass_list_short() /* nop */
192 #define print_devclass_list() /* nop */
200 DEVCLASS_SYSCTL_PARENT,
204 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
206 devclass_t dc = (devclass_t)arg1;
210 case DEVCLASS_SYSCTL_PARENT:
211 value = dc->parent ? dc->parent->name : "";
216 return (SYSCTL_OUT_STR(req, value));
220 devclass_sysctl_init(devclass_t dc)
223 if (dc->sysctl_tree != NULL)
225 sysctl_ctx_init(&dc->sysctl_ctx);
226 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
227 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
228 CTLFLAG_RD, NULL, "");
229 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
230 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
231 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
237 DEVICE_SYSCTL_DRIVER,
238 DEVICE_SYSCTL_LOCATION,
239 DEVICE_SYSCTL_PNPINFO,
240 DEVICE_SYSCTL_PARENT,
244 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
246 device_t dev = (device_t)arg1;
253 case DEVICE_SYSCTL_DESC:
254 value = dev->desc ? dev->desc : "";
256 case DEVICE_SYSCTL_DRIVER:
257 value = dev->driver ? dev->driver->name : "";
259 case DEVICE_SYSCTL_LOCATION:
260 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
261 bus_child_location_str(dev, buf, 1024);
263 case DEVICE_SYSCTL_PNPINFO:
264 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
265 bus_child_pnpinfo_str(dev, buf, 1024);
267 case DEVICE_SYSCTL_PARENT:
268 value = dev->parent ? dev->parent->nameunit : "";
273 error = SYSCTL_OUT_STR(req, value);
280 device_sysctl_init(device_t dev)
282 devclass_t dc = dev->devclass;
285 if (dev->sysctl_tree != NULL)
287 devclass_sysctl_init(dc);
288 sysctl_ctx_init(&dev->sysctl_ctx);
289 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx,
290 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
291 dev->nameunit + strlen(dc->name),
292 CTLFLAG_RD, NULL, "");
293 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
294 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
295 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
296 "device description");
297 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
298 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
299 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
300 "device driver name");
301 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
302 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
303 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
304 "device location relative to parent");
305 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
306 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
307 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
308 "device identification");
309 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
310 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
311 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
313 if (bus_get_domain(dev, &domain) == 0)
314 SYSCTL_ADD_INT(&dev->sysctl_ctx,
315 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
316 CTLFLAG_RD, NULL, domain, "NUMA domain");
320 device_sysctl_update(device_t dev)
322 devclass_t dc = dev->devclass;
324 if (dev->sysctl_tree == NULL)
326 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
330 device_sysctl_fini(device_t dev)
332 if (dev->sysctl_tree == NULL)
334 sysctl_ctx_free(&dev->sysctl_ctx);
335 dev->sysctl_tree = NULL;
339 * /dev/devctl implementation
343 * This design allows only one reader for /dev/devctl. This is not desirable
344 * in the long run, but will get a lot of hair out of this implementation.
345 * Maybe we should make this device a clonable device.
347 * Also note: we specifically do not attach a device to the device_t tree
348 * to avoid potential chicken and egg problems. One could argue that all
349 * of this belongs to the root node. One could also further argue that the
350 * sysctl interface that we have not might more properly be an ioctl
351 * interface, but at this stage of the game, I'm not inclined to rock that
354 * I'm also not sure that the SIGIO support is done correctly or not, as
355 * I copied it from a driver that had SIGIO support that likely hasn't been
356 * tested since 3.4 or 2.2.8!
359 /* Deprecated way to adjust queue length */
360 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
361 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
362 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
363 "devctl disable -- deprecated");
365 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
366 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
367 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
368 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
369 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
371 static d_open_t devopen;
372 static d_close_t devclose;
373 static d_read_t devread;
374 static d_ioctl_t devioctl;
375 static d_poll_t devpoll;
376 static d_kqfilter_t devkqfilter;
378 static struct cdevsw dev_cdevsw = {
379 .d_version = D_VERSION,
385 .d_kqfilter = devkqfilter,
389 struct dev_event_info
392 TAILQ_ENTRY(dev_event_info) dei_link;
395 TAILQ_HEAD(devq, dev_event_info);
397 static struct dev_softc
410 static void filt_devctl_detach(struct knote *kn);
411 static int filt_devctl_read(struct knote *kn, long hint);
413 struct filterops devctl_rfiltops = {
415 .f_detach = filt_devctl_detach,
416 .f_event = filt_devctl_read,
419 static struct cdev *devctl_dev;
424 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
425 UID_ROOT, GID_WHEEL, 0600, "devctl");
426 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
427 cv_init(&devsoftc.cv, "dev cv");
428 TAILQ_INIT(&devsoftc.devq);
429 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
434 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
437 mtx_lock(&devsoftc.mtx);
438 if (devsoftc.inuse) {
439 mtx_unlock(&devsoftc.mtx);
444 mtx_unlock(&devsoftc.mtx);
449 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
452 mtx_lock(&devsoftc.mtx);
454 devsoftc.nonblock = 0;
456 cv_broadcast(&devsoftc.cv);
457 funsetown(&devsoftc.sigio);
458 mtx_unlock(&devsoftc.mtx);
463 * The read channel for this device is used to report changes to
464 * userland in realtime. We are required to free the data as well as
465 * the n1 object because we allocate them separately. Also note that
466 * we return one record at a time. If you try to read this device a
467 * character at a time, you will lose the rest of the data. Listening
468 * programs are expected to cope.
471 devread(struct cdev *dev, struct uio *uio, int ioflag)
473 struct dev_event_info *n1;
476 mtx_lock(&devsoftc.mtx);
477 while (TAILQ_EMPTY(&devsoftc.devq)) {
478 if (devsoftc.nonblock) {
479 mtx_unlock(&devsoftc.mtx);
482 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
485 * Need to translate ERESTART to EINTR here? -- jake
487 mtx_unlock(&devsoftc.mtx);
491 n1 = TAILQ_FIRST(&devsoftc.devq);
492 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
494 mtx_unlock(&devsoftc.mtx);
495 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
496 free(n1->dei_data, M_BUS);
502 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
508 devsoftc.nonblock = 1;
510 devsoftc.nonblock = 0;
519 return fsetown(*(int *)data, &devsoftc.sigio);
521 *(int *)data = fgetown(&devsoftc.sigio);
524 /* (un)Support for other fcntl() calls. */
535 devpoll(struct cdev *dev, int events, struct thread *td)
539 mtx_lock(&devsoftc.mtx);
540 if (events & (POLLIN | POLLRDNORM)) {
541 if (!TAILQ_EMPTY(&devsoftc.devq))
542 revents = events & (POLLIN | POLLRDNORM);
544 selrecord(td, &devsoftc.sel);
546 mtx_unlock(&devsoftc.mtx);
552 devkqfilter(struct cdev *dev, struct knote *kn)
556 if (kn->kn_filter == EVFILT_READ) {
557 kn->kn_fop = &devctl_rfiltops;
558 knlist_add(&devsoftc.sel.si_note, kn, 0);
566 filt_devctl_detach(struct knote *kn)
569 knlist_remove(&devsoftc.sel.si_note, kn, 0);
573 filt_devctl_read(struct knote *kn, long hint)
575 kn->kn_data = devsoftc.queued;
576 return (kn->kn_data != 0);
580 * @brief Return whether the userland process is running
583 devctl_process_running(void)
585 return (devsoftc.inuse == 1);
589 * @brief Queue data to be read from the devctl device
591 * Generic interface to queue data to the devctl device. It is
592 * assumed that @p data is properly formatted. It is further assumed
593 * that @p data is allocated using the M_BUS malloc type.
596 devctl_queue_data_f(char *data, int flags)
598 struct dev_event_info *n1 = NULL, *n2 = NULL;
600 if (strlen(data) == 0)
602 if (devctl_queue_length == 0)
604 n1 = malloc(sizeof(*n1), M_BUS, flags);
608 mtx_lock(&devsoftc.mtx);
609 if (devctl_queue_length == 0) {
610 mtx_unlock(&devsoftc.mtx);
611 free(n1->dei_data, M_BUS);
615 /* Leave at least one spot in the queue... */
616 while (devsoftc.queued > devctl_queue_length - 1) {
617 n2 = TAILQ_FIRST(&devsoftc.devq);
618 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
619 free(n2->dei_data, M_BUS);
623 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
625 cv_broadcast(&devsoftc.cv);
626 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
627 mtx_unlock(&devsoftc.mtx);
628 selwakeup(&devsoftc.sel);
629 if (devsoftc.async && devsoftc.sigio != NULL)
630 pgsigio(&devsoftc.sigio, SIGIO, 0);
634 * We have to free data on all error paths since the caller
635 * assumes it will be free'd when this item is dequeued.
642 devctl_queue_data(char *data)
645 devctl_queue_data_f(data, M_NOWAIT);
649 * @brief Send a 'notification' to userland, using standard ways
652 devctl_notify_f(const char *system, const char *subsystem, const char *type,
653 const char *data, int flags)
659 return; /* BOGUS! Must specify system. */
660 if (subsystem == NULL)
661 return; /* BOGUS! Must specify subsystem. */
663 return; /* BOGUS! Must specify type. */
664 len += strlen(" system=") + strlen(system);
665 len += strlen(" subsystem=") + strlen(subsystem);
666 len += strlen(" type=") + strlen(type);
667 /* add in the data message plus newline. */
670 len += 3; /* '!', '\n', and NUL */
671 msg = malloc(len, M_BUS, flags);
673 return; /* Drop it on the floor */
675 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
676 system, subsystem, type, data);
678 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
679 system, subsystem, type);
680 devctl_queue_data_f(msg, flags);
684 devctl_notify(const char *system, const char *subsystem, const char *type,
688 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
692 * Common routine that tries to make sending messages as easy as possible.
693 * We allocate memory for the data, copy strings into that, but do not
694 * free it unless there's an error. The dequeue part of the driver should
695 * free the data. We don't send data when the device is disabled. We do
696 * send data, even when we have no listeners, because we wish to avoid
697 * races relating to startup and restart of listening applications.
699 * devaddq is designed to string together the type of event, with the
700 * object of that event, plus the plug and play info and location info
701 * for that event. This is likely most useful for devices, but less
702 * useful for other consumers of this interface. Those should use
703 * the devctl_queue_data() interface instead.
706 devaddq(const char *type, const char *what, device_t dev)
713 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
715 data = malloc(1024, M_BUS, M_NOWAIT);
719 /* get the bus specific location of this device */
720 loc = malloc(1024, M_BUS, M_NOWAIT);
724 bus_child_location_str(dev, loc, 1024);
726 /* Get the bus specific pnp info of this device */
727 pnp = malloc(1024, M_BUS, M_NOWAIT);
731 bus_child_pnpinfo_str(dev, pnp, 1024);
733 /* Get the parent of this device, or / if high enough in the tree. */
734 if (device_get_parent(dev) == NULL)
735 parstr = "."; /* Or '/' ? */
737 parstr = device_get_nameunit(device_get_parent(dev));
738 /* String it all together. */
739 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
743 devctl_queue_data(data);
753 * A device was added to the tree. We are called just after it successfully
754 * attaches (that is, probe and attach success for this device). No call
755 * is made if a device is merely parented into the tree. See devnomatch
756 * if probe fails. If attach fails, no notification is sent (but maybe
757 * we should have a different message for this).
760 devadded(device_t dev)
762 devaddq("+", device_get_nameunit(dev), dev);
766 * A device was removed from the tree. We are called just before this
770 devremoved(device_t dev)
772 devaddq("-", device_get_nameunit(dev), dev);
776 * Called when there's no match for this device. This is only called
777 * the first time that no match happens, so we don't keep getting this
778 * message. Should that prove to be undesirable, we can change it.
779 * This is called when all drivers that can attach to a given bus
780 * decline to accept this device. Other errors may not be detected.
783 devnomatch(device_t dev)
785 devaddq("?", "", dev);
789 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
791 struct dev_event_info *n1;
794 dis = (devctl_queue_length == 0);
795 error = sysctl_handle_int(oidp, &dis, 0, req);
796 if (error || !req->newptr)
798 if (mtx_initialized(&devsoftc.mtx))
799 mtx_lock(&devsoftc.mtx);
801 while (!TAILQ_EMPTY(&devsoftc.devq)) {
802 n1 = TAILQ_FIRST(&devsoftc.devq);
803 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
804 free(n1->dei_data, M_BUS);
808 devctl_queue_length = 0;
810 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
812 if (mtx_initialized(&devsoftc.mtx))
813 mtx_unlock(&devsoftc.mtx);
818 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
820 struct dev_event_info *n1;
823 q = devctl_queue_length;
824 error = sysctl_handle_int(oidp, &q, 0, req);
825 if (error || !req->newptr)
829 if (mtx_initialized(&devsoftc.mtx))
830 mtx_lock(&devsoftc.mtx);
831 devctl_queue_length = q;
832 while (devsoftc.queued > devctl_queue_length) {
833 n1 = TAILQ_FIRST(&devsoftc.devq);
834 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
835 free(n1->dei_data, M_BUS);
839 if (mtx_initialized(&devsoftc.mtx))
840 mtx_unlock(&devsoftc.mtx);
845 * @brief safely quotes strings that might have double quotes in them.
847 * The devctl protocol relies on quoted strings having matching quotes.
848 * This routine quotes any internal quotes so the resulting string
849 * is safe to pass to snprintf to construct, for example pnp info strings.
850 * Strings are always terminated with a NUL, but may be truncated if longer
851 * than @p len bytes after quotes.
853 * @param dst Buffer to hold the string. Must be at least @p len bytes long
854 * @param src Original buffer.
855 * @param len Length of buffer pointed to by @dst, including trailing NUL
858 devctl_safe_quote(char *dst, const char *src, size_t len)
860 char *walker = dst, *ep = dst + len - 1;
864 while (src != NULL && walker < ep)
866 if (*src == '"' || *src == '\\') {
876 /* End of /dev/devctl code */
878 static TAILQ_HEAD(,device) bus_data_devices;
879 static int bus_data_generation = 1;
881 static kobj_method_t null_methods[] = {
885 DEFINE_CLASS(null, null_methods, 0);
888 * Bus pass implementation
891 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
892 int bus_current_pass = BUS_PASS_ROOT;
896 * @brief Register the pass level of a new driver attachment
898 * Register a new driver attachment's pass level. If no driver
899 * attachment with the same pass level has been added, then @p new
900 * will be added to the global passes list.
902 * @param new the new driver attachment
905 driver_register_pass(struct driverlink *new)
907 struct driverlink *dl;
909 /* We only consider pass numbers during boot. */
910 if (bus_current_pass == BUS_PASS_DEFAULT)
914 * Walk the passes list. If we already know about this pass
915 * then there is nothing to do. If we don't, then insert this
916 * driver link into the list.
918 TAILQ_FOREACH(dl, &passes, passlink) {
919 if (dl->pass < new->pass)
921 if (dl->pass == new->pass)
923 TAILQ_INSERT_BEFORE(dl, new, passlink);
926 TAILQ_INSERT_TAIL(&passes, new, passlink);
930 * @brief Raise the current bus pass
932 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
933 * method on the root bus to kick off a new device tree scan for each
934 * new pass level that has at least one driver.
937 bus_set_pass(int pass)
939 struct driverlink *dl;
941 if (bus_current_pass > pass)
942 panic("Attempt to lower bus pass level");
944 TAILQ_FOREACH(dl, &passes, passlink) {
945 /* Skip pass values below the current pass level. */
946 if (dl->pass <= bus_current_pass)
950 * Bail once we hit a driver with a pass level that is
957 * Raise the pass level to the next level and rescan
960 bus_current_pass = dl->pass;
961 BUS_NEW_PASS(root_bus);
965 * If there isn't a driver registered for the requested pass,
966 * then bus_current_pass might still be less than 'pass'. Set
967 * it to 'pass' in that case.
969 if (bus_current_pass < pass)
970 bus_current_pass = pass;
971 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
975 * Devclass implementation
978 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
982 * @brief Find or create a device class
984 * If a device class with the name @p classname exists, return it,
985 * otherwise if @p create is non-zero create and return a new device
988 * If @p parentname is non-NULL, the parent of the devclass is set to
989 * the devclass of that name.
991 * @param classname the devclass name to find or create
992 * @param parentname the parent devclass name or @c NULL
993 * @param create non-zero to create a devclass
996 devclass_find_internal(const char *classname, const char *parentname,
1001 PDEBUG(("looking for %s", classname));
1005 TAILQ_FOREACH(dc, &devclasses, link) {
1006 if (!strcmp(dc->name, classname))
1010 if (create && !dc) {
1011 PDEBUG(("creating %s", classname));
1012 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1013 M_BUS, M_NOWAIT | M_ZERO);
1017 dc->name = (char*) (dc + 1);
1018 strcpy(dc->name, classname);
1019 TAILQ_INIT(&dc->drivers);
1020 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1022 bus_data_generation_update();
1026 * If a parent class is specified, then set that as our parent so
1027 * that this devclass will support drivers for the parent class as
1028 * well. If the parent class has the same name don't do this though
1029 * as it creates a cycle that can trigger an infinite loop in
1030 * device_probe_child() if a device exists for which there is no
1033 if (parentname && dc && !dc->parent &&
1034 strcmp(classname, parentname) != 0) {
1035 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1036 dc->parent->flags |= DC_HAS_CHILDREN;
1043 * @brief Create a device class
1045 * If a device class with the name @p classname exists, return it,
1046 * otherwise create and return a new device class.
1048 * @param classname the devclass name to find or create
1051 devclass_create(const char *classname)
1053 return (devclass_find_internal(classname, NULL, TRUE));
1057 * @brief Find a device class
1059 * If a device class with the name @p classname exists, return it,
1060 * otherwise return @c NULL.
1062 * @param classname the devclass name to find
1065 devclass_find(const char *classname)
1067 return (devclass_find_internal(classname, NULL, FALSE));
1071 * @brief Register that a device driver has been added to a devclass
1073 * Register that a device driver has been added to a devclass. This
1074 * is called by devclass_add_driver to accomplish the recursive
1075 * notification of all the children classes of dc, as well as dc.
1076 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1079 * We do a full search here of the devclass list at each iteration
1080 * level to save storing children-lists in the devclass structure. If
1081 * we ever move beyond a few dozen devices doing this, we may need to
1084 * @param dc the devclass to edit
1085 * @param driver the driver that was just added
1088 devclass_driver_added(devclass_t dc, driver_t *driver)
1094 * Call BUS_DRIVER_ADDED for any existing busses in this class.
1096 for (i = 0; i < dc->maxunit; i++)
1097 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1098 BUS_DRIVER_ADDED(dc->devices[i], driver);
1101 * Walk through the children classes. Since we only keep a
1102 * single parent pointer around, we walk the entire list of
1103 * devclasses looking for children. We set the
1104 * DC_HAS_CHILDREN flag when a child devclass is created on
1105 * the parent, so we only walk the list for those devclasses
1106 * that have children.
1108 if (!(dc->flags & DC_HAS_CHILDREN))
1111 TAILQ_FOREACH(dc, &devclasses, link) {
1112 if (dc->parent == parent)
1113 devclass_driver_added(dc, driver);
1118 * @brief Add a device driver to a device class
1120 * Add a device driver to a devclass. This is normally called
1121 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1122 * all devices in the devclass will be called to allow them to attempt
1123 * to re-probe any unmatched children.
1125 * @param dc the devclass to edit
1126 * @param driver the driver to register
1129 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1132 const char *parentname;
1134 PDEBUG(("%s", DRIVERNAME(driver)));
1136 /* Don't allow invalid pass values. */
1137 if (pass <= BUS_PASS_ROOT)
1140 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1145 * Compile the driver's methods. Also increase the reference count
1146 * so that the class doesn't get freed when the last instance
1147 * goes. This means we can safely use static methods and avoids a
1148 * double-free in devclass_delete_driver.
1150 kobj_class_compile((kobj_class_t) driver);
1153 * If the driver has any base classes, make the
1154 * devclass inherit from the devclass of the driver's
1155 * first base class. This will allow the system to
1156 * search for drivers in both devclasses for children
1157 * of a device using this driver.
1159 if (driver->baseclasses)
1160 parentname = driver->baseclasses[0]->name;
1163 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1165 dl->driver = driver;
1166 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1167 driver->refs++; /* XXX: kobj_mtx */
1169 driver_register_pass(dl);
1171 devclass_driver_added(dc, driver);
1172 bus_data_generation_update();
1177 * @brief Register that a device driver has been deleted from a devclass
1179 * Register that a device driver has been removed from a devclass.
1180 * This is called by devclass_delete_driver to accomplish the
1181 * recursive notification of all the children classes of busclass, as
1182 * well as busclass. Each layer will attempt to detach the driver
1183 * from any devices that are children of the bus's devclass. The function
1184 * will return an error if a device fails to detach.
1186 * We do a full search here of the devclass list at each iteration
1187 * level to save storing children-lists in the devclass structure. If
1188 * we ever move beyond a few dozen devices doing this, we may need to
1191 * @param busclass the devclass of the parent bus
1192 * @param dc the devclass of the driver being deleted
1193 * @param driver the driver being deleted
1196 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1203 * Disassociate from any devices. We iterate through all the
1204 * devices in the devclass of the driver and detach any which are
1205 * using the driver and which have a parent in the devclass which
1206 * we are deleting from.
1208 * Note that since a driver can be in multiple devclasses, we
1209 * should not detach devices which are not children of devices in
1210 * the affected devclass.
1212 for (i = 0; i < dc->maxunit; i++) {
1213 if (dc->devices[i]) {
1214 dev = dc->devices[i];
1215 if (dev->driver == driver && dev->parent &&
1216 dev->parent->devclass == busclass) {
1217 if ((error = device_detach(dev)) != 0)
1219 BUS_PROBE_NOMATCH(dev->parent, dev);
1221 dev->flags |= DF_DONENOMATCH;
1227 * Walk through the children classes. Since we only keep a
1228 * single parent pointer around, we walk the entire list of
1229 * devclasses looking for children. We set the
1230 * DC_HAS_CHILDREN flag when a child devclass is created on
1231 * the parent, so we only walk the list for those devclasses
1232 * that have children.
1234 if (!(busclass->flags & DC_HAS_CHILDREN))
1237 TAILQ_FOREACH(busclass, &devclasses, link) {
1238 if (busclass->parent == parent) {
1239 error = devclass_driver_deleted(busclass, dc, driver);
1248 * @brief Delete a device driver from a device class
1250 * Delete a device driver from a devclass. This is normally called
1251 * automatically by DRIVER_MODULE().
1253 * If the driver is currently attached to any devices,
1254 * devclass_delete_driver() will first attempt to detach from each
1255 * device. If one of the detach calls fails, the driver will not be
1258 * @param dc the devclass to edit
1259 * @param driver the driver to unregister
1262 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1264 devclass_t dc = devclass_find(driver->name);
1268 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1274 * Find the link structure in the bus' list of drivers.
1276 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1277 if (dl->driver == driver)
1282 PDEBUG(("%s not found in %s list", driver->name,
1287 error = devclass_driver_deleted(busclass, dc, driver);
1291 TAILQ_REMOVE(&busclass->drivers, dl, link);
1296 if (driver->refs == 0)
1297 kobj_class_free((kobj_class_t) driver);
1299 bus_data_generation_update();
1304 * @brief Quiesces a set of device drivers from a device class
1306 * Quiesce a device driver from a devclass. This is normally called
1307 * automatically by DRIVER_MODULE().
1309 * If the driver is currently attached to any devices,
1310 * devclass_quiesece_driver() will first attempt to quiesce each
1313 * @param dc the devclass to edit
1314 * @param driver the driver to unregister
1317 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1319 devclass_t dc = devclass_find(driver->name);
1325 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1331 * Find the link structure in the bus' list of drivers.
1333 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1334 if (dl->driver == driver)
1339 PDEBUG(("%s not found in %s list", driver->name,
1345 * Quiesce all devices. We iterate through all the devices in
1346 * the devclass of the driver and quiesce any which are using
1347 * the driver and which have a parent in the devclass which we
1350 * Note that since a driver can be in multiple devclasses, we
1351 * should not quiesce devices which are not children of
1352 * devices in the affected devclass.
1354 for (i = 0; i < dc->maxunit; i++) {
1355 if (dc->devices[i]) {
1356 dev = dc->devices[i];
1357 if (dev->driver == driver && dev->parent &&
1358 dev->parent->devclass == busclass) {
1359 if ((error = device_quiesce(dev)) != 0)
1372 devclass_find_driver_internal(devclass_t dc, const char *classname)
1376 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1378 TAILQ_FOREACH(dl, &dc->drivers, link) {
1379 if (!strcmp(dl->driver->name, classname))
1383 PDEBUG(("not found"));
1388 * @brief Return the name of the devclass
1391 devclass_get_name(devclass_t dc)
1397 * @brief Find a device given a unit number
1399 * @param dc the devclass to search
1400 * @param unit the unit number to search for
1402 * @returns the device with the given unit number or @c
1403 * NULL if there is no such device
1406 devclass_get_device(devclass_t dc, int unit)
1408 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1410 return (dc->devices[unit]);
1414 * @brief Find the softc field of a device given a unit number
1416 * @param dc the devclass to search
1417 * @param unit the unit number to search for
1419 * @returns the softc field of the device with the given
1420 * unit number or @c NULL if there is no such
1424 devclass_get_softc(devclass_t dc, int unit)
1428 dev = devclass_get_device(dc, unit);
1432 return (device_get_softc(dev));
1436 * @brief Get a list of devices in the devclass
1438 * An array containing a list of all the devices in the given devclass
1439 * is allocated and returned in @p *devlistp. The number of devices
1440 * in the array is returned in @p *devcountp. The caller should free
1441 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1443 * @param dc the devclass to examine
1444 * @param devlistp points at location for array pointer return
1446 * @param devcountp points at location for array size return value
1449 * @retval ENOMEM the array allocation failed
1452 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1457 count = devclass_get_count(dc);
1458 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1463 for (i = 0; i < dc->maxunit; i++) {
1464 if (dc->devices[i]) {
1465 list[count] = dc->devices[i];
1477 * @brief Get a list of drivers in the devclass
1479 * An array containing a list of pointers to all the drivers in the
1480 * given devclass is allocated and returned in @p *listp. The number
1481 * of drivers in the array is returned in @p *countp. The caller should
1482 * free the array using @c free(p, M_TEMP).
1484 * @param dc the devclass to examine
1485 * @param listp gives location for array pointer return value
1486 * @param countp gives location for number of array elements
1490 * @retval ENOMEM the array allocation failed
1493 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1500 TAILQ_FOREACH(dl, &dc->drivers, link)
1502 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1507 TAILQ_FOREACH(dl, &dc->drivers, link) {
1508 list[count] = dl->driver;
1518 * @brief Get the number of devices in a devclass
1520 * @param dc the devclass to examine
1523 devclass_get_count(devclass_t dc)
1528 for (i = 0; i < dc->maxunit; i++)
1535 * @brief Get the maximum unit number used in a devclass
1537 * Note that this is one greater than the highest currently-allocated
1538 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1539 * that not even the devclass has been allocated yet.
1541 * @param dc the devclass to examine
1544 devclass_get_maxunit(devclass_t dc)
1548 return (dc->maxunit);
1552 * @brief Find a free unit number in a devclass
1554 * This function searches for the first unused unit number greater
1555 * that or equal to @p unit.
1557 * @param dc the devclass to examine
1558 * @param unit the first unit number to check
1561 devclass_find_free_unit(devclass_t dc, int unit)
1565 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1571 * @brief Set the parent of a devclass
1573 * The parent class is normally initialised automatically by
1576 * @param dc the devclass to edit
1577 * @param pdc the new parent devclass
1580 devclass_set_parent(devclass_t dc, devclass_t pdc)
1586 * @brief Get the parent of a devclass
1588 * @param dc the devclass to examine
1591 devclass_get_parent(devclass_t dc)
1593 return (dc->parent);
1596 struct sysctl_ctx_list *
1597 devclass_get_sysctl_ctx(devclass_t dc)
1599 return (&dc->sysctl_ctx);
1603 devclass_get_sysctl_tree(devclass_t dc)
1605 return (dc->sysctl_tree);
1610 * @brief Allocate a unit number
1612 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1613 * will do). The allocated unit number is returned in @p *unitp.
1615 * @param dc the devclass to allocate from
1616 * @param unitp points at the location for the allocated unit
1620 * @retval EEXIST the requested unit number is already allocated
1621 * @retval ENOMEM memory allocation failure
1624 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1629 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1631 /* Ask the parent bus if it wants to wire this device. */
1633 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1636 /* If we were given a wired unit number, check for existing device */
1639 if (unit >= 0 && unit < dc->maxunit &&
1640 dc->devices[unit] != NULL) {
1642 printf("%s: %s%d already exists; skipping it\n",
1643 dc->name, dc->name, *unitp);
1647 /* Unwired device, find the next available slot for it */
1649 for (unit = 0;; unit++) {
1650 /* If there is an "at" hint for a unit then skip it. */
1651 if (resource_string_value(dc->name, unit, "at", &s) ==
1655 /* If this device slot is already in use, skip it. */
1656 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1664 * We've selected a unit beyond the length of the table, so let's
1665 * extend the table to make room for all units up to and including
1668 if (unit >= dc->maxunit) {
1669 device_t *newlist, *oldlist;
1672 oldlist = dc->devices;
1673 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1674 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1677 if (oldlist != NULL)
1678 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1679 bzero(newlist + dc->maxunit,
1680 sizeof(device_t) * (newsize - dc->maxunit));
1681 dc->devices = newlist;
1682 dc->maxunit = newsize;
1683 if (oldlist != NULL)
1684 free(oldlist, M_BUS);
1686 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1694 * @brief Add a device to a devclass
1696 * A unit number is allocated for the device (using the device's
1697 * preferred unit number if any) and the device is registered in the
1698 * devclass. This allows the device to be looked up by its unit
1699 * number, e.g. by decoding a dev_t minor number.
1701 * @param dc the devclass to add to
1702 * @param dev the device to add
1705 * @retval EEXIST the requested unit number is already allocated
1706 * @retval ENOMEM memory allocation failure
1709 devclass_add_device(devclass_t dc, device_t dev)
1713 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1715 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1718 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1722 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1723 free(dev->nameunit, M_BUS);
1724 dev->nameunit = NULL;
1727 dc->devices[dev->unit] = dev;
1729 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1736 * @brief Delete a device from a devclass
1738 * The device is removed from the devclass's device list and its unit
1741 * @param dc the devclass to delete from
1742 * @param dev the device to delete
1747 devclass_delete_device(devclass_t dc, device_t dev)
1752 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1754 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1755 panic("devclass_delete_device: inconsistent device class");
1756 dc->devices[dev->unit] = NULL;
1757 if (dev->flags & DF_WILDCARD)
1759 dev->devclass = NULL;
1760 free(dev->nameunit, M_BUS);
1761 dev->nameunit = NULL;
1768 * @brief Make a new device and add it as a child of @p parent
1770 * @param parent the parent of the new device
1771 * @param name the devclass name of the new device or @c NULL
1772 * to leave the devclass unspecified
1773 * @parem unit the unit number of the new device of @c -1 to
1774 * leave the unit number unspecified
1776 * @returns the new device
1779 make_device(device_t parent, const char *name, int unit)
1784 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1787 dc = devclass_find_internal(name, NULL, TRUE);
1789 printf("make_device: can't find device class %s\n",
1797 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1801 dev->parent = parent;
1802 TAILQ_INIT(&dev->children);
1803 kobj_init((kobj_t) dev, &null_class);
1805 dev->devclass = NULL;
1807 dev->nameunit = NULL;
1811 dev->flags = DF_ENABLED;
1814 dev->flags |= DF_WILDCARD;
1816 dev->flags |= DF_FIXEDCLASS;
1817 if (devclass_add_device(dc, dev)) {
1818 kobj_delete((kobj_t) dev, M_BUS);
1825 dev->state = DS_NOTPRESENT;
1827 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1828 bus_data_generation_update();
1835 * @brief Print a description of a device.
1838 device_print_child(device_t dev, device_t child)
1842 if (device_is_alive(child))
1843 retval += BUS_PRINT_CHILD(dev, child);
1845 retval += device_printf(child, " not found\n");
1851 * @brief Create a new device
1853 * This creates a new device and adds it as a child of an existing
1854 * parent device. The new device will be added after the last existing
1855 * child with order zero.
1857 * @param dev the device which will be the parent of the
1859 * @param name devclass name for new device or @c NULL if not
1861 * @param unit unit number for new device or @c -1 if not
1864 * @returns the new device
1867 device_add_child(device_t dev, const char *name, int unit)
1869 return (device_add_child_ordered(dev, 0, name, unit));
1873 * @brief Create a new device
1875 * This creates a new device and adds it as a child of an existing
1876 * parent device. The new device will be added after the last existing
1877 * child with the same order.
1879 * @param dev the device which will be the parent of the
1881 * @param order a value which is used to partially sort the
1882 * children of @p dev - devices created using
1883 * lower values of @p order appear first in @p
1884 * dev's list of children
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_ordered(device_t dev, u_int order, const char *name, int unit)
1898 PDEBUG(("%s at %s with order %u as unit %d",
1899 name, DEVICENAME(dev), order, unit));
1900 KASSERT(name != NULL || unit == -1,
1901 ("child device with wildcard name and specific unit number"));
1903 child = make_device(dev, name, unit);
1906 child->order = order;
1908 TAILQ_FOREACH(place, &dev->children, link) {
1909 if (place->order > order)
1915 * The device 'place' is the first device whose order is
1916 * greater than the new child.
1918 TAILQ_INSERT_BEFORE(place, child, link);
1921 * The new child's order is greater or equal to the order of
1922 * any existing device. Add the child to the tail of the list.
1924 TAILQ_INSERT_TAIL(&dev->children, child, link);
1927 bus_data_generation_update();
1932 * @brief Delete a device
1934 * This function deletes a device along with all of its children. If
1935 * the device currently has a driver attached to it, the device is
1936 * detached first using device_detach().
1938 * @param dev the parent device
1939 * @param child the device to delete
1942 * @retval non-zero a unit error code describing the error
1945 device_delete_child(device_t dev, device_t child)
1948 device_t grandchild;
1950 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1952 /* remove children first */
1953 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1954 error = device_delete_child(child, grandchild);
1959 if ((error = device_detach(child)) != 0)
1961 if (child->devclass)
1962 devclass_delete_device(child->devclass, child);
1964 BUS_CHILD_DELETED(dev, child);
1965 TAILQ_REMOVE(&dev->children, child, link);
1966 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1967 kobj_delete((kobj_t) child, M_BUS);
1969 bus_data_generation_update();
1974 * @brief Delete all children devices of the given device, if any.
1976 * This function deletes all children devices of the given device, if
1977 * any, using the device_delete_child() function for each device it
1978 * finds. If a child device cannot be deleted, this function will
1979 * return an error code.
1981 * @param dev the parent device
1984 * @retval non-zero a device would not detach
1987 device_delete_children(device_t dev)
1992 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1996 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1997 error = device_delete_child(dev, child);
1999 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2007 * @brief Find a device given a unit number
2009 * This is similar to devclass_get_devices() but only searches for
2010 * devices which have @p dev as a parent.
2012 * @param dev the parent device to search
2013 * @param unit the unit number to search for. If the unit is -1,
2014 * return the first child of @p dev which has name
2015 * @p classname (that is, the one with the lowest unit.)
2017 * @returns the device with the given unit number or @c
2018 * NULL if there is no such device
2021 device_find_child(device_t dev, const char *classname, int unit)
2026 dc = devclass_find(classname);
2031 child = devclass_get_device(dc, unit);
2032 if (child && child->parent == dev)
2035 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2036 child = devclass_get_device(dc, unit);
2037 if (child && child->parent == dev)
2048 first_matching_driver(devclass_t dc, device_t dev)
2051 return (devclass_find_driver_internal(dc, dev->devclass->name));
2052 return (TAILQ_FIRST(&dc->drivers));
2059 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2061 if (dev->devclass) {
2063 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2064 if (!strcmp(dev->devclass->name, dl->driver->name))
2068 return (TAILQ_NEXT(last, link));
2075 device_probe_child(device_t dev, device_t child)
2078 driverlink_t best = NULL;
2080 int result, pri = 0;
2081 int hasclass = (child->devclass != NULL);
2087 panic("device_probe_child: parent device has no devclass");
2090 * If the state is already probed, then return. However, don't
2091 * return if we can rebid this object.
2093 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2096 for (; dc; dc = dc->parent) {
2097 for (dl = first_matching_driver(dc, child);
2099 dl = next_matching_driver(dc, child, dl)) {
2100 /* If this driver's pass is too high, then ignore it. */
2101 if (dl->pass > bus_current_pass)
2104 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2105 result = device_set_driver(child, dl->driver);
2106 if (result == ENOMEM)
2108 else if (result != 0)
2111 if (device_set_devclass(child,
2112 dl->driver->name) != 0) {
2113 char const * devname =
2114 device_get_name(child);
2115 if (devname == NULL)
2116 devname = "(unknown)";
2117 printf("driver bug: Unable to set "
2118 "devclass (class: %s "
2122 (void)device_set_driver(child, NULL);
2127 /* Fetch any flags for the device before probing. */
2128 resource_int_value(dl->driver->name, child->unit,
2129 "flags", &child->devflags);
2131 result = DEVICE_PROBE(child);
2133 /* Reset flags and devclass before the next probe. */
2134 child->devflags = 0;
2136 (void)device_set_devclass(child, NULL);
2139 * If the driver returns SUCCESS, there can be
2140 * no higher match for this device.
2149 * Probes that return BUS_PROBE_NOWILDCARD or lower
2150 * only match on devices whose driver was explicitly
2153 if (result <= BUS_PROBE_NOWILDCARD &&
2154 !(child->flags & DF_FIXEDCLASS)) {
2159 * The driver returned an error so it
2160 * certainly doesn't match.
2163 (void)device_set_driver(child, NULL);
2168 * A priority lower than SUCCESS, remember the
2169 * best matching driver. Initialise the value
2170 * of pri for the first match.
2172 if (best == NULL || result > pri) {
2179 * If we have an unambiguous match in this devclass,
2180 * don't look in the parent.
2182 if (best && pri == 0)
2187 * If we found a driver, change state and initialise the devclass.
2189 /* XXX What happens if we rebid and got no best? */
2192 * If this device was attached, and we were asked to
2193 * rescan, and it is a different driver, then we have
2194 * to detach the old driver and reattach this new one.
2195 * Note, we don't have to check for DF_REBID here
2196 * because if the state is > DS_ALIVE, we know it must
2199 * This assumes that all DF_REBID drivers can have
2200 * their probe routine called at any time and that
2201 * they are idempotent as well as completely benign in
2202 * normal operations.
2204 * We also have to make sure that the detach
2205 * succeeded, otherwise we fail the operation (or
2206 * maybe it should just fail silently? I'm torn).
2208 if (child->state > DS_ALIVE && best->driver != child->driver)
2209 if ((result = device_detach(dev)) != 0)
2212 /* Set the winning driver, devclass, and flags. */
2213 if (!child->devclass) {
2214 result = device_set_devclass(child, best->driver->name);
2218 result = device_set_driver(child, best->driver);
2221 resource_int_value(best->driver->name, child->unit,
2222 "flags", &child->devflags);
2226 * A bit bogus. Call the probe method again to make
2227 * sure that we have the right description.
2229 DEVICE_PROBE(child);
2231 child->flags |= DF_REBID;
2234 child->flags &= ~DF_REBID;
2235 child->state = DS_ALIVE;
2237 bus_data_generation_update();
2245 * @brief Return the parent of a device
2248 device_get_parent(device_t dev)
2250 return (dev->parent);
2254 * @brief Get a list of children of a device
2256 * An array containing a list of all the children of the given device
2257 * is allocated and returned in @p *devlistp. The number of devices
2258 * in the array is returned in @p *devcountp. The caller should free
2259 * the array using @c free(p, M_TEMP).
2261 * @param dev the device to examine
2262 * @param devlistp points at location for array pointer return
2264 * @param devcountp points at location for array size return value
2267 * @retval ENOMEM the array allocation failed
2270 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2277 TAILQ_FOREACH(child, &dev->children, link) {
2286 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2291 TAILQ_FOREACH(child, &dev->children, link) {
2292 list[count] = child;
2303 * @brief Return the current driver for the device or @c NULL if there
2304 * is no driver currently attached
2307 device_get_driver(device_t dev)
2309 return (dev->driver);
2313 * @brief Return the current devclass for the device or @c NULL if
2317 device_get_devclass(device_t dev)
2319 return (dev->devclass);
2323 * @brief Return the name of the device's devclass or @c NULL if there
2327 device_get_name(device_t dev)
2329 if (dev != NULL && dev->devclass)
2330 return (devclass_get_name(dev->devclass));
2335 * @brief Return a string containing the device's devclass name
2336 * followed by an ascii representation of the device's unit number
2340 device_get_nameunit(device_t dev)
2342 return (dev->nameunit);
2346 * @brief Return the device's unit number.
2349 device_get_unit(device_t dev)
2355 * @brief Return the device's description string
2358 device_get_desc(device_t dev)
2364 * @brief Return the device's flags
2367 device_get_flags(device_t dev)
2369 return (dev->devflags);
2372 struct sysctl_ctx_list *
2373 device_get_sysctl_ctx(device_t dev)
2375 return (&dev->sysctl_ctx);
2379 device_get_sysctl_tree(device_t dev)
2381 return (dev->sysctl_tree);
2385 * @brief Print the name of the device followed by a colon and a space
2387 * @returns the number of characters printed
2390 device_print_prettyname(device_t dev)
2392 const char *name = device_get_name(dev);
2395 return (printf("unknown: "));
2396 return (printf("%s%d: ", name, device_get_unit(dev)));
2400 * @brief Print the name of the device followed by a colon, a space
2401 * and the result of calling vprintf() with the value of @p fmt and
2402 * the following arguments.
2404 * @returns the number of characters printed
2407 device_printf(device_t dev, const char * fmt, ...)
2412 retval = device_print_prettyname(dev);
2414 retval += vprintf(fmt, ap);
2423 device_set_desc_internal(device_t dev, const char* desc, int copy)
2425 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2426 free(dev->desc, M_BUS);
2427 dev->flags &= ~DF_DESCMALLOCED;
2432 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2434 strcpy(dev->desc, desc);
2435 dev->flags |= DF_DESCMALLOCED;
2438 /* Avoid a -Wcast-qual warning */
2439 dev->desc = (char *)(uintptr_t) desc;
2442 bus_data_generation_update();
2446 * @brief Set the device's description
2448 * The value of @c desc should be a string constant that will not
2449 * change (at least until the description is changed in a subsequent
2450 * call to device_set_desc() or device_set_desc_copy()).
2453 device_set_desc(device_t dev, const char* desc)
2455 device_set_desc_internal(dev, desc, FALSE);
2459 * @brief Set the device's description
2461 * The string pointed to by @c desc is copied. Use this function if
2462 * the device description is generated, (e.g. with sprintf()).
2465 device_set_desc_copy(device_t dev, const char* desc)
2467 device_set_desc_internal(dev, desc, TRUE);
2471 * @brief Set the device's flags
2474 device_set_flags(device_t dev, uint32_t flags)
2476 dev->devflags = flags;
2480 * @brief Return the device's softc field
2482 * The softc is allocated and zeroed when a driver is attached, based
2483 * on the size field of the driver.
2486 device_get_softc(device_t dev)
2488 return (dev->softc);
2492 * @brief Set the device's softc field
2494 * Most drivers do not need to use this since the softc is allocated
2495 * automatically when the driver is attached.
2498 device_set_softc(device_t dev, void *softc)
2500 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2501 free(dev->softc, M_BUS_SC);
2504 dev->flags |= DF_EXTERNALSOFTC;
2506 dev->flags &= ~DF_EXTERNALSOFTC;
2510 * @brief Free claimed softc
2512 * Most drivers do not need to use this since the softc is freed
2513 * automatically when the driver is detached.
2516 device_free_softc(void *softc)
2518 free(softc, M_BUS_SC);
2522 * @brief Claim softc
2524 * This function can be used to let the driver free the automatically
2525 * allocated softc using "device_free_softc()". This function is
2526 * useful when the driver is refcounting the softc and the softc
2527 * cannot be freed when the "device_detach" method is called.
2530 device_claim_softc(device_t dev)
2533 dev->flags |= DF_EXTERNALSOFTC;
2535 dev->flags &= ~DF_EXTERNALSOFTC;
2539 * @brief Get the device's ivars field
2541 * The ivars field is used by the parent device to store per-device
2542 * state (e.g. the physical location of the device or a list of
2546 device_get_ivars(device_t dev)
2549 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2550 return (dev->ivars);
2554 * @brief Set the device's ivars field
2557 device_set_ivars(device_t dev, void * ivars)
2560 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2565 * @brief Return the device's state
2568 device_get_state(device_t dev)
2570 return (dev->state);
2574 * @brief Set the DF_ENABLED flag for the device
2577 device_enable(device_t dev)
2579 dev->flags |= DF_ENABLED;
2583 * @brief Clear the DF_ENABLED flag for the device
2586 device_disable(device_t dev)
2588 dev->flags &= ~DF_ENABLED;
2592 * @brief Increment the busy counter for the device
2595 device_busy(device_t dev)
2597 if (dev->state < DS_ATTACHING)
2598 panic("device_busy: called for unattached device");
2599 if (dev->busy == 0 && dev->parent)
2600 device_busy(dev->parent);
2602 if (dev->state == DS_ATTACHED)
2603 dev->state = DS_BUSY;
2607 * @brief Decrement the busy counter for the device
2610 device_unbusy(device_t dev)
2612 if (dev->busy != 0 && dev->state != DS_BUSY &&
2613 dev->state != DS_ATTACHING)
2614 panic("device_unbusy: called for non-busy device %s",
2615 device_get_nameunit(dev));
2617 if (dev->busy == 0) {
2619 device_unbusy(dev->parent);
2620 if (dev->state == DS_BUSY)
2621 dev->state = DS_ATTACHED;
2626 * @brief Set the DF_QUIET flag for the device
2629 device_quiet(device_t dev)
2631 dev->flags |= DF_QUIET;
2635 * @brief Clear the DF_QUIET flag for the device
2638 device_verbose(device_t dev)
2640 dev->flags &= ~DF_QUIET;
2644 * @brief Return non-zero if the DF_QUIET flag is set on the device
2647 device_is_quiet(device_t dev)
2649 return ((dev->flags & DF_QUIET) != 0);
2653 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2656 device_is_enabled(device_t dev)
2658 return ((dev->flags & DF_ENABLED) != 0);
2662 * @brief Return non-zero if the device was successfully probed
2665 device_is_alive(device_t dev)
2667 return (dev->state >= DS_ALIVE);
2671 * @brief Return non-zero if the device currently has a driver
2675 device_is_attached(device_t dev)
2677 return (dev->state >= DS_ATTACHED);
2681 * @brief Return non-zero if the device is currently suspended.
2684 device_is_suspended(device_t dev)
2686 return ((dev->flags & DF_SUSPENDED) != 0);
2690 * @brief Set the devclass of a device
2691 * @see devclass_add_device().
2694 device_set_devclass(device_t dev, const char *classname)
2701 devclass_delete_device(dev->devclass, dev);
2705 if (dev->devclass) {
2706 printf("device_set_devclass: device class already set\n");
2710 dc = devclass_find_internal(classname, NULL, TRUE);
2714 error = devclass_add_device(dc, dev);
2716 bus_data_generation_update();
2721 * @brief Set the devclass of a device and mark the devclass fixed.
2722 * @see device_set_devclass()
2725 device_set_devclass_fixed(device_t dev, const char *classname)
2729 if (classname == NULL)
2732 error = device_set_devclass(dev, classname);
2735 dev->flags |= DF_FIXEDCLASS;
2740 * @brief Set the driver of a device
2743 * @retval EBUSY the device already has a driver attached
2744 * @retval ENOMEM a memory allocation failure occurred
2747 device_set_driver(device_t dev, driver_t *driver)
2749 if (dev->state >= DS_ATTACHED)
2752 if (dev->driver == driver)
2755 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2756 free(dev->softc, M_BUS_SC);
2759 device_set_desc(dev, NULL);
2760 kobj_delete((kobj_t) dev, NULL);
2761 dev->driver = driver;
2763 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2764 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2765 dev->softc = malloc(driver->size, M_BUS_SC,
2768 kobj_delete((kobj_t) dev, NULL);
2769 kobj_init((kobj_t) dev, &null_class);
2775 kobj_init((kobj_t) dev, &null_class);
2778 bus_data_generation_update();
2783 * @brief Probe a device, and return this status.
2785 * This function is the core of the device autoconfiguration
2786 * system. Its purpose is to select a suitable driver for a device and
2787 * then call that driver to initialise the hardware appropriately. The
2788 * driver is selected by calling the DEVICE_PROBE() method of a set of
2789 * candidate drivers and then choosing the driver which returned the
2790 * best value. This driver is then attached to the device using
2793 * The set of suitable drivers is taken from the list of drivers in
2794 * the parent device's devclass. If the device was originally created
2795 * with a specific class name (see device_add_child()), only drivers
2796 * with that name are probed, otherwise all drivers in the devclass
2797 * are probed. If no drivers return successful probe values in the
2798 * parent devclass, the search continues in the parent of that
2799 * devclass (see devclass_get_parent()) if any.
2801 * @param dev the device to initialise
2804 * @retval ENXIO no driver was found
2805 * @retval ENOMEM memory allocation failure
2806 * @retval non-zero some other unix error code
2807 * @retval -1 Device already attached
2810 device_probe(device_t dev)
2816 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2819 if (!(dev->flags & DF_ENABLED)) {
2820 if (bootverbose && device_get_name(dev) != NULL) {
2821 device_print_prettyname(dev);
2822 printf("not probed (disabled)\n");
2826 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2827 if (bus_current_pass == BUS_PASS_DEFAULT &&
2828 !(dev->flags & DF_DONENOMATCH)) {
2829 BUS_PROBE_NOMATCH(dev->parent, dev);
2831 dev->flags |= DF_DONENOMATCH;
2839 * @brief Probe a device and attach a driver if possible
2841 * calls device_probe() and attaches if that was successful.
2844 device_probe_and_attach(device_t dev)
2850 error = device_probe(dev);
2853 else if (error != 0)
2856 CURVNET_SET_QUIET(vnet0);
2857 error = device_attach(dev);
2863 * @brief Attach a device driver to a device
2865 * This function is a wrapper around the DEVICE_ATTACH() driver
2866 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2867 * device's sysctl tree, optionally prints a description of the device
2868 * and queues a notification event for user-based device management
2871 * Normally this function is only called internally from
2872 * device_probe_and_attach().
2874 * @param dev the device to initialise
2877 * @retval ENXIO no driver was found
2878 * @retval ENOMEM memory allocation failure
2879 * @retval non-zero some other unix error code
2882 device_attach(device_t dev)
2884 uint64_t attachtime;
2887 if (resource_disabled(dev->driver->name, dev->unit)) {
2888 device_disable(dev);
2890 device_printf(dev, "disabled via hints entry\n");
2894 device_sysctl_init(dev);
2895 if (!device_is_quiet(dev))
2896 device_print_child(dev->parent, dev);
2897 attachtime = get_cyclecount();
2898 dev->state = DS_ATTACHING;
2899 if ((error = DEVICE_ATTACH(dev)) != 0) {
2900 printf("device_attach: %s%d attach returned %d\n",
2901 dev->driver->name, dev->unit, error);
2902 if (!(dev->flags & DF_FIXEDCLASS))
2903 devclass_delete_device(dev->devclass, dev);
2904 (void)device_set_driver(dev, NULL);
2905 device_sysctl_fini(dev);
2906 KASSERT(dev->busy == 0, ("attach failed but busy"));
2907 dev->state = DS_NOTPRESENT;
2910 attachtime = get_cyclecount() - attachtime;
2912 * 4 bits per device is a reasonable value for desktop and server
2913 * hardware with good get_cyclecount() implementations, but WILL
2914 * need to be adjusted on other platforms.
2916 #define RANDOM_PROBE_BIT_GUESS 4
2918 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2919 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2920 dev->driver->name, dev->unit);
2921 random_harvest_direct(&attachtime, sizeof(attachtime),
2922 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2923 device_sysctl_update(dev);
2925 dev->state = DS_BUSY;
2927 dev->state = DS_ATTACHED;
2928 dev->flags &= ~DF_DONENOMATCH;
2934 * @brief Detach a driver from a device
2936 * This function is a wrapper around the DEVICE_DETACH() driver
2937 * method. If the call to DEVICE_DETACH() succeeds, it calls
2938 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2939 * notification event for user-based device management services and
2940 * cleans up the device's sysctl tree.
2942 * @param dev the device to un-initialise
2945 * @retval ENXIO no driver was found
2946 * @retval ENOMEM memory allocation failure
2947 * @retval non-zero some other unix error code
2950 device_detach(device_t dev)
2956 PDEBUG(("%s", DEVICENAME(dev)));
2957 if (dev->state == DS_BUSY)
2959 if (dev->state != DS_ATTACHED)
2962 if ((error = DEVICE_DETACH(dev)) != 0)
2965 if (!device_is_quiet(dev))
2966 device_printf(dev, "detached\n");
2968 BUS_CHILD_DETACHED(dev->parent, dev);
2970 if (!(dev->flags & DF_FIXEDCLASS))
2971 devclass_delete_device(dev->devclass, dev);
2973 dev->state = DS_NOTPRESENT;
2974 (void)device_set_driver(dev, NULL);
2975 device_sysctl_fini(dev);
2981 * @brief Tells a driver to quiesce itself.
2983 * This function is a wrapper around the DEVICE_QUIESCE() driver
2984 * method. If the call to DEVICE_QUIESCE() succeeds.
2986 * @param dev the device to quiesce
2989 * @retval ENXIO no driver was found
2990 * @retval ENOMEM memory allocation failure
2991 * @retval non-zero some other unix error code
2994 device_quiesce(device_t dev)
2997 PDEBUG(("%s", DEVICENAME(dev)));
2998 if (dev->state == DS_BUSY)
3000 if (dev->state != DS_ATTACHED)
3003 return (DEVICE_QUIESCE(dev));
3007 * @brief Notify a device of system shutdown
3009 * This function calls the DEVICE_SHUTDOWN() driver method if the
3010 * device currently has an attached driver.
3012 * @returns the value returned by DEVICE_SHUTDOWN()
3015 device_shutdown(device_t dev)
3017 if (dev->state < DS_ATTACHED)
3019 return (DEVICE_SHUTDOWN(dev));
3023 * @brief Set the unit number of a device
3025 * This function can be used to override the unit number used for a
3026 * device (e.g. to wire a device to a pre-configured unit number).
3029 device_set_unit(device_t dev, int unit)
3034 dc = device_get_devclass(dev);
3035 if (unit < dc->maxunit && dc->devices[unit])
3037 err = devclass_delete_device(dc, dev);
3041 err = devclass_add_device(dc, dev);
3045 bus_data_generation_update();
3049 /*======================================*/
3051 * Some useful method implementations to make life easier for bus drivers.
3055 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3060 args->memattr = VM_MEMATTR_UNCACHEABLE;
3064 * @brief Initialise a resource list.
3066 * @param rl the resource list to initialise
3069 resource_list_init(struct resource_list *rl)
3075 * @brief Reclaim memory used by a resource list.
3077 * This function frees the memory for all resource entries on the list
3080 * @param rl the resource list to free
3083 resource_list_free(struct resource_list *rl)
3085 struct resource_list_entry *rle;
3087 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3089 panic("resource_list_free: resource entry is busy");
3090 STAILQ_REMOVE_HEAD(rl, link);
3096 * @brief Add a resource entry.
3098 * This function adds a resource entry using the given @p type, @p
3099 * start, @p end and @p count values. A rid value is chosen by
3100 * searching sequentially for the first unused rid starting at zero.
3102 * @param rl the resource list to edit
3103 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3104 * @param start the start address of the resource
3105 * @param end the end address of the resource
3106 * @param count XXX end-start+1
3109 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3110 rman_res_t end, rman_res_t count)
3115 while (resource_list_find(rl, type, rid) != NULL)
3117 resource_list_add(rl, type, rid, start, end, count);
3122 * @brief Add or modify a resource entry.
3124 * If an existing entry exists with the same type and rid, it will be
3125 * modified using the given values of @p start, @p end and @p
3126 * count. If no entry exists, a new one will be created using the
3127 * given values. The resource list entry that matches is then returned.
3129 * @param rl the resource list to edit
3130 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3131 * @param rid the resource identifier
3132 * @param start the start address of the resource
3133 * @param end the end address of the resource
3134 * @param count XXX end-start+1
3136 struct resource_list_entry *
3137 resource_list_add(struct resource_list *rl, int type, int rid,
3138 rman_res_t start, rman_res_t end, rman_res_t count)
3140 struct resource_list_entry *rle;
3142 rle = resource_list_find(rl, type, rid);
3144 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3147 panic("resource_list_add: can't record entry");
3148 STAILQ_INSERT_TAIL(rl, rle, link);
3156 panic("resource_list_add: resource entry is busy");
3165 * @brief Determine if a resource entry is busy.
3167 * Returns true if a resource entry is busy meaning that it has an
3168 * associated resource that is not an unallocated "reserved" resource.
3170 * @param rl the resource list to search
3171 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3172 * @param rid the resource identifier
3174 * @returns Non-zero if the entry is busy, zero otherwise.
3177 resource_list_busy(struct resource_list *rl, int type, int rid)
3179 struct resource_list_entry *rle;
3181 rle = resource_list_find(rl, type, rid);
3182 if (rle == NULL || rle->res == NULL)
3184 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3185 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3186 ("reserved resource is active"));
3193 * @brief Determine if a resource entry is reserved.
3195 * Returns true if a resource entry is reserved meaning that it has an
3196 * associated "reserved" resource. The resource can either be
3197 * allocated or unallocated.
3199 * @param rl the resource list to search
3200 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3201 * @param rid the resource identifier
3203 * @returns Non-zero if the entry is reserved, zero otherwise.
3206 resource_list_reserved(struct resource_list *rl, int type, int rid)
3208 struct resource_list_entry *rle;
3210 rle = resource_list_find(rl, type, rid);
3211 if (rle != NULL && rle->flags & RLE_RESERVED)
3217 * @brief Find a resource entry by type and rid.
3219 * @param rl the resource list to search
3220 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3221 * @param rid the resource identifier
3223 * @returns the resource entry pointer or NULL if there is no such
3226 struct resource_list_entry *
3227 resource_list_find(struct resource_list *rl, int type, int rid)
3229 struct resource_list_entry *rle;
3231 STAILQ_FOREACH(rle, rl, link) {
3232 if (rle->type == type && rle->rid == rid)
3239 * @brief Delete a resource entry.
3241 * @param rl the resource list to edit
3242 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3243 * @param rid the resource identifier
3246 resource_list_delete(struct resource_list *rl, int type, int rid)
3248 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3251 if (rle->res != NULL)
3252 panic("resource_list_delete: resource has not been released");
3253 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3259 * @brief Allocate a reserved resource
3261 * This can be used by busses to force the allocation of resources
3262 * that are always active in the system even if they are not allocated
3263 * by a driver (e.g. PCI BARs). This function is usually called when
3264 * adding a new child to the bus. The resource is allocated from the
3265 * parent bus when it is reserved. The resource list entry is marked
3266 * with RLE_RESERVED to note that it is a reserved resource.
3268 * Subsequent attempts to allocate the resource with
3269 * resource_list_alloc() will succeed the first time and will set
3270 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3271 * resource that has been allocated is released with
3272 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3273 * the actual resource remains allocated. The resource can be released to
3274 * the parent bus by calling resource_list_unreserve().
3276 * @param rl the resource list to allocate from
3277 * @param bus the parent device of @p child
3278 * @param child the device for which the resource is being reserved
3279 * @param type the type of resource to allocate
3280 * @param rid a pointer to the resource identifier
3281 * @param start hint at the start of the resource range - pass
3282 * @c 0 for any start address
3283 * @param end hint at the end of the resource range - pass
3284 * @c ~0 for any end address
3285 * @param count hint at the size of range required - pass @c 1
3287 * @param flags any extra flags to control the resource
3288 * allocation - see @c RF_XXX flags in
3289 * <sys/rman.h> for details
3291 * @returns the resource which was allocated or @c NULL if no
3292 * resource could be allocated
3295 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3296 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3298 struct resource_list_entry *rle = NULL;
3299 int passthrough = (device_get_parent(child) != bus);
3304 "resource_list_reserve() should only be called for direct children");
3305 if (flags & RF_ACTIVE)
3307 "resource_list_reserve() should only reserve inactive resources");
3309 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3312 rle = resource_list_find(rl, type, *rid);
3313 rle->flags |= RLE_RESERVED;
3319 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3321 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3322 * and passing the allocation up to the parent of @p bus. This assumes
3323 * that the first entry of @c device_get_ivars(child) is a struct
3324 * resource_list. This also handles 'passthrough' allocations where a
3325 * child is a remote descendant of bus by passing the allocation up to
3326 * the parent of bus.
3328 * Typically, a bus driver would store a list of child resources
3329 * somewhere in the child device's ivars (see device_get_ivars()) and
3330 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3331 * then call resource_list_alloc() to perform the allocation.
3333 * @param rl the resource list to allocate from
3334 * @param bus the parent device of @p child
3335 * @param child the device which is requesting an allocation
3336 * @param type the type of resource to allocate
3337 * @param rid a pointer to the resource identifier
3338 * @param start hint at the start of the resource range - pass
3339 * @c 0 for any start address
3340 * @param end hint at the end of the resource range - pass
3341 * @c ~0 for any end address
3342 * @param count hint at the size of range required - pass @c 1
3344 * @param flags any extra flags to control the resource
3345 * allocation - see @c RF_XXX flags in
3346 * <sys/rman.h> for details
3348 * @returns the resource which was allocated or @c NULL if no
3349 * resource could be allocated
3352 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3353 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3355 struct resource_list_entry *rle = NULL;
3356 int passthrough = (device_get_parent(child) != bus);
3357 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3360 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3361 type, rid, start, end, count, flags));
3364 rle = resource_list_find(rl, type, *rid);
3367 return (NULL); /* no resource of that type/rid */
3370 if (rle->flags & RLE_RESERVED) {
3371 if (rle->flags & RLE_ALLOCATED)
3373 if ((flags & RF_ACTIVE) &&
3374 bus_activate_resource(child, type, *rid,
3377 rle->flags |= RLE_ALLOCATED;
3381 "resource entry %#x type %d for child %s is busy\n", *rid,
3382 type, device_get_nameunit(child));
3388 count = ulmax(count, rle->count);
3389 end = ulmax(rle->end, start + count - 1);
3392 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3393 type, rid, start, end, count, flags);
3396 * Record the new range.
3399 rle->start = rman_get_start(rle->res);
3400 rle->end = rman_get_end(rle->res);
3408 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3410 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3411 * used with resource_list_alloc().
3413 * @param rl the resource list which was allocated from
3414 * @param bus the parent device of @p child
3415 * @param child the device which is requesting a release
3416 * @param type the type of resource to release
3417 * @param rid the resource identifier
3418 * @param res the resource to release
3421 * @retval non-zero a standard unix error code indicating what
3422 * error condition prevented the operation
3425 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3426 int type, int rid, struct resource *res)
3428 struct resource_list_entry *rle = NULL;
3429 int passthrough = (device_get_parent(child) != bus);
3433 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3437 rle = resource_list_find(rl, type, rid);
3440 panic("resource_list_release: can't find resource");
3442 panic("resource_list_release: resource entry is not busy");
3443 if (rle->flags & RLE_RESERVED) {
3444 if (rle->flags & RLE_ALLOCATED) {
3445 if (rman_get_flags(res) & RF_ACTIVE) {
3446 error = bus_deactivate_resource(child, type,
3451 rle->flags &= ~RLE_ALLOCATED;
3457 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3467 * @brief Release all active resources of a given type
3469 * Release all active resources of a specified type. This is intended
3470 * to be used to cleanup resources leaked by a driver after detach or
3473 * @param rl the resource list which was allocated from
3474 * @param bus the parent device of @p child
3475 * @param child the device whose active resources are being released
3476 * @param type the type of resources to release
3479 * @retval EBUSY at least one resource was active
3482 resource_list_release_active(struct resource_list *rl, device_t bus,
3483 device_t child, int type)
3485 struct resource_list_entry *rle;
3489 STAILQ_FOREACH(rle, rl, link) {
3490 if (rle->type != type)
3492 if (rle->res == NULL)
3494 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3498 error = resource_list_release(rl, bus, child, type,
3499 rman_get_rid(rle->res), rle->res);
3502 "Failed to release active resource: %d\n", error);
3509 * @brief Fully release a reserved resource
3511 * Fully releases a resource reserved via resource_list_reserve().
3513 * @param rl the resource list which was allocated from
3514 * @param bus the parent device of @p child
3515 * @param child the device whose reserved resource is being released
3516 * @param type the type of resource to release
3517 * @param rid the resource identifier
3518 * @param res the resource to release
3521 * @retval non-zero a standard unix error code indicating what
3522 * error condition prevented the operation
3525 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3528 struct resource_list_entry *rle = NULL;
3529 int passthrough = (device_get_parent(child) != bus);
3533 "resource_list_unreserve() should only be called for direct children");
3535 rle = resource_list_find(rl, type, rid);
3538 panic("resource_list_unreserve: can't find resource");
3539 if (!(rle->flags & RLE_RESERVED))
3541 if (rle->flags & RLE_ALLOCATED)
3543 rle->flags &= ~RLE_RESERVED;
3544 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3548 * @brief Print a description of resources in a resource list
3550 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3551 * The name is printed if at least one resource of the given type is available.
3552 * The format is used to print resource start and end.
3554 * @param rl the resource list to print
3555 * @param name the name of @p type, e.g. @c "memory"
3556 * @param type type type of resource entry to print
3557 * @param format printf(9) format string to print resource
3558 * start and end values
3560 * @returns the number of characters printed
3563 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3566 struct resource_list_entry *rle;
3567 int printed, retval;
3571 /* Yes, this is kinda cheating */
3572 STAILQ_FOREACH(rle, rl, link) {
3573 if (rle->type == type) {
3575 retval += printf(" %s ", name);
3577 retval += printf(",");
3579 retval += printf(format, rle->start);
3580 if (rle->count > 1) {
3581 retval += printf("-");
3582 retval += printf(format, rle->start +
3591 * @brief Releases all the resources in a list.
3593 * @param rl The resource list to purge.
3598 resource_list_purge(struct resource_list *rl)
3600 struct resource_list_entry *rle;
3602 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3604 bus_release_resource(rman_get_device(rle->res),
3605 rle->type, rle->rid, rle->res);
3606 STAILQ_REMOVE_HEAD(rl, link);
3612 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3615 return (device_add_child_ordered(dev, order, name, unit));
3619 * @brief Helper function for implementing DEVICE_PROBE()
3621 * This function can be used to help implement the DEVICE_PROBE() for
3622 * a bus (i.e. a device which has other devices attached to it). It
3623 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3627 bus_generic_probe(device_t dev)
3629 devclass_t dc = dev->devclass;
3632 TAILQ_FOREACH(dl, &dc->drivers, link) {
3634 * If this driver's pass is too high, then ignore it.
3635 * For most drivers in the default pass, this will
3636 * never be true. For early-pass drivers they will
3637 * only call the identify routines of eligible drivers
3638 * when this routine is called. Drivers for later
3639 * passes should have their identify routines called
3640 * on early-pass busses during BUS_NEW_PASS().
3642 if (dl->pass > bus_current_pass)
3644 DEVICE_IDENTIFY(dl->driver, dev);
3651 * @brief Helper function for implementing DEVICE_ATTACH()
3653 * This function can be used to help implement the DEVICE_ATTACH() for
3654 * a bus. It calls device_probe_and_attach() for each of the device's
3658 bus_generic_attach(device_t dev)
3662 TAILQ_FOREACH(child, &dev->children, link) {
3663 device_probe_and_attach(child);
3670 * @brief Helper function for implementing DEVICE_DETACH()
3672 * This function can be used to help implement the DEVICE_DETACH() for
3673 * a bus. It calls device_detach() for each of the device's
3677 bus_generic_detach(device_t dev)
3682 if (dev->state != DS_ATTACHED)
3685 TAILQ_FOREACH(child, &dev->children, link) {
3686 if ((error = device_detach(child)) != 0)
3694 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3696 * This function can be used to help implement the DEVICE_SHUTDOWN()
3697 * for a bus. It calls device_shutdown() for each of the device's
3701 bus_generic_shutdown(device_t dev)
3705 TAILQ_FOREACH(child, &dev->children, link) {
3706 device_shutdown(child);
3713 * @brief Default function for suspending a child device.
3715 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3718 bus_generic_suspend_child(device_t dev, device_t child)
3722 error = DEVICE_SUSPEND(child);
3725 child->flags |= DF_SUSPENDED;
3731 * @brief Default function for resuming a child device.
3733 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3736 bus_generic_resume_child(device_t dev, device_t child)
3739 DEVICE_RESUME(child);
3740 child->flags &= ~DF_SUSPENDED;
3746 * @brief Helper function for implementing DEVICE_SUSPEND()
3748 * This function can be used to help implement the DEVICE_SUSPEND()
3749 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3750 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3751 * operation is aborted and any devices which were suspended are
3752 * resumed immediately by calling their DEVICE_RESUME() methods.
3755 bus_generic_suspend(device_t dev)
3758 device_t child, child2;
3760 TAILQ_FOREACH(child, &dev->children, link) {
3761 error = BUS_SUSPEND_CHILD(dev, child);
3763 for (child2 = TAILQ_FIRST(&dev->children);
3764 child2 && child2 != child;
3765 child2 = TAILQ_NEXT(child2, link))
3766 BUS_RESUME_CHILD(dev, child2);
3774 * @brief Helper function for implementing DEVICE_RESUME()
3776 * This function can be used to help implement the DEVICE_RESUME() for
3777 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3780 bus_generic_resume(device_t dev)
3784 TAILQ_FOREACH(child, &dev->children, link) {
3785 BUS_RESUME_CHILD(dev, child);
3786 /* if resume fails, there's nothing we can usefully do... */
3792 * @brief Helper function for implementing BUS_PRINT_CHILD().
3794 * This function prints the first part of the ascii representation of
3795 * @p child, including its name, unit and description (if any - see
3796 * device_set_desc()).
3798 * @returns the number of characters printed
3801 bus_print_child_header(device_t dev, device_t child)
3805 if (device_get_desc(child)) {
3806 retval += device_printf(child, "<%s>", device_get_desc(child));
3808 retval += printf("%s", device_get_nameunit(child));
3815 * @brief Helper function for implementing BUS_PRINT_CHILD().
3817 * This function prints the last part of the ascii representation of
3818 * @p child, which consists of the string @c " on " followed by the
3819 * name and unit of the @p dev.
3821 * @returns the number of characters printed
3824 bus_print_child_footer(device_t dev, device_t child)
3826 return (printf(" on %s\n", device_get_nameunit(dev)));
3830 * @brief Helper function for implementing BUS_PRINT_CHILD().
3832 * This function prints out the VM domain for the given device.
3834 * @returns the number of characters printed
3837 bus_print_child_domain(device_t dev, device_t child)
3841 /* No domain? Don't print anything */
3842 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3845 return (printf(" numa-domain %d", domain));
3849 * @brief Helper function for implementing BUS_PRINT_CHILD().
3851 * This function simply calls bus_print_child_header() followed by
3852 * bus_print_child_footer().
3854 * @returns the number of characters printed
3857 bus_generic_print_child(device_t dev, device_t child)
3861 retval += bus_print_child_header(dev, child);
3862 retval += bus_print_child_domain(dev, child);
3863 retval += bus_print_child_footer(dev, child);
3869 * @brief Stub function for implementing BUS_READ_IVAR().
3874 bus_generic_read_ivar(device_t dev, device_t child, int index,
3881 * @brief Stub function for implementing BUS_WRITE_IVAR().
3886 bus_generic_write_ivar(device_t dev, device_t child, int index,
3893 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3897 struct resource_list *
3898 bus_generic_get_resource_list(device_t dev, device_t child)
3904 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3906 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3907 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3908 * and then calls device_probe_and_attach() for each unattached child.
3911 bus_generic_driver_added(device_t dev, driver_t *driver)
3915 DEVICE_IDENTIFY(driver, dev);
3916 TAILQ_FOREACH(child, &dev->children, link) {
3917 if (child->state == DS_NOTPRESENT ||
3918 (child->flags & DF_REBID))
3919 device_probe_and_attach(child);
3924 * @brief Helper function for implementing BUS_NEW_PASS().
3926 * This implementing of BUS_NEW_PASS() first calls the identify
3927 * routines for any drivers that probe at the current pass. Then it
3928 * walks the list of devices for this bus. If a device is already
3929 * attached, then it calls BUS_NEW_PASS() on that device. If the
3930 * device is not already attached, it attempts to attach a driver to
3934 bus_generic_new_pass(device_t dev)
3941 TAILQ_FOREACH(dl, &dc->drivers, link) {
3942 if (dl->pass == bus_current_pass)
3943 DEVICE_IDENTIFY(dl->driver, dev);
3945 TAILQ_FOREACH(child, &dev->children, link) {
3946 if (child->state >= DS_ATTACHED)
3947 BUS_NEW_PASS(child);
3948 else if (child->state == DS_NOTPRESENT)
3949 device_probe_and_attach(child);
3954 * @brief Helper function for implementing BUS_SETUP_INTR().
3956 * This simple implementation of BUS_SETUP_INTR() simply calls the
3957 * BUS_SETUP_INTR() method of the parent of @p dev.
3960 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3961 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3964 /* Propagate up the bus hierarchy until someone handles it. */
3966 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3967 filter, intr, arg, cookiep));
3972 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3974 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3975 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3978 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3981 /* Propagate up the bus hierarchy until someone handles it. */
3983 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
3988 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
3990 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
3991 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
3994 bus_generic_adjust_resource(device_t dev, device_t child, int type,
3995 struct resource *r, rman_res_t start, rman_res_t end)
3997 /* Propagate up the bus hierarchy until someone handles it. */
3999 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4005 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4007 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4008 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4011 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4012 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4014 /* Propagate up the bus hierarchy until someone handles it. */
4016 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4017 start, end, count, flags));
4022 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4024 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4025 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4028 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4031 /* Propagate up the bus hierarchy until someone handles it. */
4033 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4039 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4041 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4042 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4045 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4048 /* Propagate up the bus hierarchy until someone handles it. */
4050 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4056 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4058 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4059 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4062 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4063 int rid, struct resource *r)
4065 /* Propagate up the bus hierarchy until someone handles it. */
4067 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4073 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4075 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4076 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4079 bus_generic_map_resource(device_t dev, device_t child, int type,
4080 struct resource *r, struct resource_map_request *args,
4081 struct resource_map *map)
4083 /* Propagate up the bus hierarchy until someone handles it. */
4085 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4091 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4093 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4094 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4097 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4098 struct resource *r, struct resource_map *map)
4100 /* Propagate up the bus hierarchy until someone handles it. */
4102 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4107 * @brief Helper function for implementing BUS_BIND_INTR().
4109 * This simple implementation of BUS_BIND_INTR() simply calls the
4110 * BUS_BIND_INTR() method of the parent of @p dev.
4113 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4117 /* Propagate up the bus hierarchy until someone handles it. */
4119 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4124 * @brief Helper function for implementing BUS_CONFIG_INTR().
4126 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4127 * BUS_CONFIG_INTR() method of the parent of @p dev.
4130 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4131 enum intr_polarity pol)
4134 /* Propagate up the bus hierarchy until someone handles it. */
4136 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4141 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4143 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4144 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4147 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4148 void *cookie, const char *descr)
4151 /* Propagate up the bus hierarchy until someone handles it. */
4153 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4159 * @brief Helper function for implementing BUS_GET_CPUS().
4161 * This simple implementation of BUS_GET_CPUS() simply calls the
4162 * BUS_GET_CPUS() method of the parent of @p dev.
4165 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4166 size_t setsize, cpuset_t *cpuset)
4169 /* Propagate up the bus hierarchy until someone handles it. */
4170 if (dev->parent != NULL)
4171 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4176 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4178 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4179 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4182 bus_generic_get_dma_tag(device_t dev, device_t child)
4185 /* Propagate up the bus hierarchy until someone handles it. */
4186 if (dev->parent != NULL)
4187 return (BUS_GET_DMA_TAG(dev->parent, child));
4192 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4194 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4195 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4198 bus_generic_get_bus_tag(device_t dev, device_t child)
4201 /* Propagate up the bus hierarchy until someone handles it. */
4202 if (dev->parent != NULL)
4203 return (BUS_GET_BUS_TAG(dev->parent, child));
4204 return ((bus_space_tag_t)0);
4208 * @brief Helper function for implementing BUS_GET_RESOURCE().
4210 * This implementation of BUS_GET_RESOURCE() uses the
4211 * resource_list_find() function to do most of the work. It calls
4212 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4216 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4217 rman_res_t *startp, rman_res_t *countp)
4219 struct resource_list * rl = NULL;
4220 struct resource_list_entry * rle = NULL;
4222 rl = BUS_GET_RESOURCE_LIST(dev, child);
4226 rle = resource_list_find(rl, type, rid);
4231 *startp = rle->start;
4233 *countp = rle->count;
4239 * @brief Helper function for implementing BUS_SET_RESOURCE().
4241 * This implementation of BUS_SET_RESOURCE() uses the
4242 * resource_list_add() function to do most of the work. It calls
4243 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4247 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4248 rman_res_t start, rman_res_t count)
4250 struct resource_list * rl = NULL;
4252 rl = BUS_GET_RESOURCE_LIST(dev, child);
4256 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4262 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4264 * This implementation of BUS_DELETE_RESOURCE() uses the
4265 * resource_list_delete() function to do most of the work. It calls
4266 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4270 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4272 struct resource_list * rl = NULL;
4274 rl = BUS_GET_RESOURCE_LIST(dev, child);
4278 resource_list_delete(rl, type, rid);
4284 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4286 * This implementation of BUS_RELEASE_RESOURCE() uses the
4287 * resource_list_release() function to do most of the work. It calls
4288 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4291 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4292 int rid, struct resource *r)
4294 struct resource_list * rl = NULL;
4296 if (device_get_parent(child) != dev)
4297 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4300 rl = BUS_GET_RESOURCE_LIST(dev, child);
4304 return (resource_list_release(rl, dev, child, type, rid, r));
4308 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4310 * This implementation of BUS_ALLOC_RESOURCE() uses the
4311 * resource_list_alloc() function to do most of the work. It calls
4312 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4315 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4316 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4318 struct resource_list * rl = NULL;
4320 if (device_get_parent(child) != dev)
4321 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4322 type, rid, start, end, count, flags));
4324 rl = BUS_GET_RESOURCE_LIST(dev, child);
4328 return (resource_list_alloc(rl, dev, child, type, rid,
4329 start, end, count, flags));
4333 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4335 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4336 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4339 bus_generic_child_present(device_t dev, device_t child)
4341 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4345 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4349 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4355 * @brief Helper function for implementing BUS_RESCAN().
4357 * This null implementation of BUS_RESCAN() always fails to indicate
4358 * the bus does not support rescanning.
4361 bus_null_rescan(device_t dev)
4368 * Some convenience functions to make it easier for drivers to use the
4369 * resource-management functions. All these really do is hide the
4370 * indirection through the parent's method table, making for slightly
4371 * less-wordy code. In the future, it might make sense for this code
4372 * to maintain some sort of a list of resources allocated by each device.
4376 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4377 struct resource **res)
4381 for (i = 0; rs[i].type != -1; i++)
4383 for (i = 0; rs[i].type != -1; i++) {
4384 res[i] = bus_alloc_resource_any(dev,
4385 rs[i].type, &rs[i].rid, rs[i].flags);
4386 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4387 bus_release_resources(dev, rs, res);
4395 bus_release_resources(device_t dev, const struct resource_spec *rs,
4396 struct resource **res)
4400 for (i = 0; rs[i].type != -1; i++)
4401 if (res[i] != NULL) {
4402 bus_release_resource(
4403 dev, rs[i].type, rs[i].rid, res[i]);
4409 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4411 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4415 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4416 rman_res_t end, rman_res_t count, u_int flags)
4418 struct resource *res;
4420 if (dev->parent == NULL)
4422 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4428 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4430 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4434 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4437 if (dev->parent == NULL)
4439 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4443 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4445 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4449 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4451 if (dev->parent == NULL)
4453 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4457 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4459 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4463 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4465 if (dev->parent == NULL)
4467 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4471 * @brief Wrapper function for BUS_MAP_RESOURCE().
4473 * This function simply calls the BUS_MAP_RESOURCE() method of the
4477 bus_map_resource(device_t dev, int type, struct resource *r,
4478 struct resource_map_request *args, struct resource_map *map)
4480 if (dev->parent == NULL)
4482 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4486 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4488 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4492 bus_unmap_resource(device_t dev, int type, struct resource *r,
4493 struct resource_map *map)
4495 if (dev->parent == NULL)
4497 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4501 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4503 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4507 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4511 if (dev->parent == NULL)
4513 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4518 * @brief Wrapper function for BUS_SETUP_INTR().
4520 * This function simply calls the BUS_SETUP_INTR() method of the
4524 bus_setup_intr(device_t dev, struct resource *r, int flags,
4525 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4529 if (dev->parent == NULL)
4531 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4535 if (handler != NULL && !(flags & INTR_MPSAFE))
4536 device_printf(dev, "[GIANT-LOCKED]\n");
4541 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4543 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4547 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4549 if (dev->parent == NULL)
4551 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4555 * @brief Wrapper function for BUS_BIND_INTR().
4557 * This function simply calls the BUS_BIND_INTR() method of the
4561 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4563 if (dev->parent == NULL)
4565 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4569 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4571 * This function first formats the requested description into a
4572 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4573 * the parent of @p dev.
4576 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4577 const char *fmt, ...)
4580 char descr[MAXCOMLEN + 1];
4582 if (dev->parent == NULL)
4585 vsnprintf(descr, sizeof(descr), fmt, ap);
4587 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4591 * @brief Wrapper function for BUS_SET_RESOURCE().
4593 * This function simply calls the BUS_SET_RESOURCE() method of the
4597 bus_set_resource(device_t dev, int type, int rid,
4598 rman_res_t start, rman_res_t count)
4600 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4605 * @brief Wrapper function for BUS_GET_RESOURCE().
4607 * This function simply calls the BUS_GET_RESOURCE() method of the
4611 bus_get_resource(device_t dev, int type, int rid,
4612 rman_res_t *startp, rman_res_t *countp)
4614 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4619 * @brief Wrapper function for BUS_GET_RESOURCE().
4621 * This function simply calls the BUS_GET_RESOURCE() method of the
4622 * parent of @p dev and returns the start value.
4625 bus_get_resource_start(device_t dev, int type, int rid)
4631 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4639 * @brief Wrapper function for BUS_GET_RESOURCE().
4641 * This function simply calls the BUS_GET_RESOURCE() method of the
4642 * parent of @p dev and returns the count value.
4645 bus_get_resource_count(device_t dev, int type, int rid)
4651 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4659 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4661 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4665 bus_delete_resource(device_t dev, int type, int rid)
4667 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4671 * @brief Wrapper function for BUS_CHILD_PRESENT().
4673 * This function simply calls the BUS_CHILD_PRESENT() method of the
4677 bus_child_present(device_t child)
4679 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4683 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4685 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4689 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4693 parent = device_get_parent(child);
4694 if (parent == NULL) {
4698 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4702 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4704 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4708 bus_child_location_str(device_t child, char *buf, size_t buflen)
4712 parent = device_get_parent(child);
4713 if (parent == NULL) {
4717 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4721 * @brief Wrapper function for BUS_GET_CPUS().
4723 * This function simply calls the BUS_GET_CPUS() method of the
4727 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4731 parent = device_get_parent(dev);
4734 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4738 * @brief Wrapper function for BUS_GET_DMA_TAG().
4740 * This function simply calls the BUS_GET_DMA_TAG() method of the
4744 bus_get_dma_tag(device_t dev)
4748 parent = device_get_parent(dev);
4751 return (BUS_GET_DMA_TAG(parent, dev));
4755 * @brief Wrapper function for BUS_GET_BUS_TAG().
4757 * This function simply calls the BUS_GET_BUS_TAG() method of the
4761 bus_get_bus_tag(device_t dev)
4765 parent = device_get_parent(dev);
4767 return ((bus_space_tag_t)0);
4768 return (BUS_GET_BUS_TAG(parent, dev));
4772 * @brief Wrapper function for BUS_GET_DOMAIN().
4774 * This function simply calls the BUS_GET_DOMAIN() method of the
4778 bus_get_domain(device_t dev, int *domain)
4780 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4783 /* Resume all devices and then notify userland that we're up again. */
4785 root_resume(device_t dev)
4789 error = bus_generic_resume(dev);
4791 devctl_notify("kern", "power", "resume", NULL);
4796 root_print_child(device_t dev, device_t child)
4800 retval += bus_print_child_header(dev, child);
4801 retval += printf("\n");
4807 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4808 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4811 * If an interrupt mapping gets to here something bad has happened.
4813 panic("root_setup_intr");
4817 * If we get here, assume that the device is permanent and really is
4818 * present in the system. Removable bus drivers are expected to intercept
4819 * this call long before it gets here. We return -1 so that drivers that
4820 * really care can check vs -1 or some ERRNO returned higher in the food
4824 root_child_present(device_t dev, device_t child)
4830 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4836 /* Default to returning the set of all CPUs. */
4837 if (setsize != sizeof(cpuset_t))
4846 static kobj_method_t root_methods[] = {
4847 /* Device interface */
4848 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4849 KOBJMETHOD(device_suspend, bus_generic_suspend),
4850 KOBJMETHOD(device_resume, root_resume),
4853 KOBJMETHOD(bus_print_child, root_print_child),
4854 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4855 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4856 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4857 KOBJMETHOD(bus_child_present, root_child_present),
4858 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4863 static driver_t root_driver = {
4870 devclass_t root_devclass;
4873 root_bus_module_handler(module_t mod, int what, void* arg)
4877 TAILQ_INIT(&bus_data_devices);
4878 kobj_class_compile((kobj_class_t) &root_driver);
4879 root_bus = make_device(NULL, "root", 0);
4880 root_bus->desc = "System root bus";
4881 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4882 root_bus->driver = &root_driver;
4883 root_bus->state = DS_ATTACHED;
4884 root_devclass = devclass_find_internal("root", NULL, FALSE);
4889 device_shutdown(root_bus);
4892 return (EOPNOTSUPP);
4898 static moduledata_t root_bus_mod = {
4900 root_bus_module_handler,
4903 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4906 * @brief Automatically configure devices
4908 * This function begins the autoconfiguration process by calling
4909 * device_probe_and_attach() for each child of the @c root0 device.
4912 root_bus_configure(void)
4917 /* Eventually this will be split up, but this is sufficient for now. */
4918 bus_set_pass(BUS_PASS_DEFAULT);
4922 * @brief Module handler for registering device drivers
4924 * This module handler is used to automatically register device
4925 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4926 * devclass_add_driver() for the driver described by the
4927 * driver_module_data structure pointed to by @p arg
4930 driver_module_handler(module_t mod, int what, void *arg)
4932 struct driver_module_data *dmd;
4933 devclass_t bus_devclass;
4934 kobj_class_t driver;
4937 dmd = (struct driver_module_data *)arg;
4938 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4943 if (dmd->dmd_chainevh)
4944 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4946 pass = dmd->dmd_pass;
4947 driver = dmd->dmd_driver;
4948 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4949 DRIVERNAME(driver), dmd->dmd_busname, pass));
4950 error = devclass_add_driver(bus_devclass, driver, pass,
4955 PDEBUG(("Unloading module: driver %s from bus %s",
4956 DRIVERNAME(dmd->dmd_driver),
4958 error = devclass_delete_driver(bus_devclass,
4961 if (!error && dmd->dmd_chainevh)
4962 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4965 PDEBUG(("Quiesce module: driver %s from bus %s",
4966 DRIVERNAME(dmd->dmd_driver),
4968 error = devclass_quiesce_driver(bus_devclass,
4971 if (!error && dmd->dmd_chainevh)
4972 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4983 * @brief Enumerate all hinted devices for this bus.
4985 * Walks through the hints for this bus and calls the bus_hinted_child
4986 * routine for each one it fines. It searches first for the specific
4987 * bus that's being probed for hinted children (eg isa0), and then for
4988 * generic children (eg isa).
4990 * @param dev bus device to enumerate
4993 bus_enumerate_hinted_children(device_t bus)
4996 const char *dname, *busname;
5000 * enumerate all devices on the specific bus
5002 busname = device_get_nameunit(bus);
5004 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5005 BUS_HINTED_CHILD(bus, dname, dunit);
5008 * and all the generic ones.
5010 busname = device_get_name(bus);
5012 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5013 BUS_HINTED_CHILD(bus, dname, dunit);
5018 /* the _short versions avoid iteration by not calling anything that prints
5019 * more than oneliners. I love oneliners.
5023 print_device_short(device_t dev, int indent)
5028 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5029 dev->unit, dev->desc,
5030 (dev->parent? "":"no "),
5031 (TAILQ_EMPTY(&dev->children)? "no ":""),
5032 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5033 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5034 (dev->flags&DF_WILDCARD? "wildcard,":""),
5035 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5036 (dev->flags&DF_REBID? "rebiddable,":""),
5037 (dev->ivars? "":"no "),
5038 (dev->softc? "":"no "),
5043 print_device(device_t dev, int indent)
5048 print_device_short(dev, indent);
5050 indentprintf(("Parent:\n"));
5051 print_device_short(dev->parent, indent+1);
5052 indentprintf(("Driver:\n"));
5053 print_driver_short(dev->driver, indent+1);
5054 indentprintf(("Devclass:\n"));
5055 print_devclass_short(dev->devclass, indent+1);
5059 print_device_tree_short(device_t dev, int indent)
5060 /* print the device and all its children (indented) */
5067 print_device_short(dev, indent);
5069 TAILQ_FOREACH(child, &dev->children, link) {
5070 print_device_tree_short(child, indent+1);
5075 print_device_tree(device_t dev, int indent)
5076 /* print the device and all its children (indented) */
5083 print_device(dev, indent);
5085 TAILQ_FOREACH(child, &dev->children, link) {
5086 print_device_tree(child, indent+1);
5091 print_driver_short(driver_t *driver, int indent)
5096 indentprintf(("driver %s: softc size = %zd\n",
5097 driver->name, driver->size));
5101 print_driver(driver_t *driver, int indent)
5106 print_driver_short(driver, indent);
5110 print_driver_list(driver_list_t drivers, int indent)
5112 driverlink_t driver;
5114 TAILQ_FOREACH(driver, &drivers, link) {
5115 print_driver(driver->driver, indent);
5120 print_devclass_short(devclass_t dc, int indent)
5125 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5129 print_devclass(devclass_t dc, int indent)
5136 print_devclass_short(dc, indent);
5137 indentprintf(("Drivers:\n"));
5138 print_driver_list(dc->drivers, indent+1);
5140 indentprintf(("Devices:\n"));
5141 for (i = 0; i < dc->maxunit; i++)
5143 print_device(dc->devices[i], indent+1);
5147 print_devclass_list_short(void)
5151 printf("Short listing of devclasses, drivers & devices:\n");
5152 TAILQ_FOREACH(dc, &devclasses, link) {
5153 print_devclass_short(dc, 0);
5158 print_devclass_list(void)
5162 printf("Full listing of devclasses, drivers & devices:\n");
5163 TAILQ_FOREACH(dc, &devclasses, link) {
5164 print_devclass(dc, 0);
5171 * User-space access to the device tree.
5173 * We implement a small set of nodes:
5175 * hw.bus Single integer read method to obtain the
5176 * current generation count.
5177 * hw.bus.devices Reads the entire device tree in flat space.
5178 * hw.bus.rman Resource manager interface
5180 * We might like to add the ability to scan devclasses and/or drivers to
5181 * determine what else is currently loaded/available.
5185 sysctl_bus(SYSCTL_HANDLER_ARGS)
5187 struct u_businfo ubus;
5189 ubus.ub_version = BUS_USER_VERSION;
5190 ubus.ub_generation = bus_data_generation;
5192 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5194 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5195 "bus-related data");
5198 sysctl_devices(SYSCTL_HANDLER_ARGS)
5200 int *name = (int *)arg1;
5201 u_int namelen = arg2;
5204 struct u_device udev; /* XXX this is a bit big */
5210 if (bus_data_generation_check(name[0]))
5216 * Scan the list of devices, looking for the requested index.
5218 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5226 * Populate the return array.
5228 bzero(&udev, sizeof(udev));
5229 udev.dv_handle = (uintptr_t)dev;
5230 udev.dv_parent = (uintptr_t)dev->parent;
5231 if (dev->nameunit != NULL)
5232 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
5233 if (dev->desc != NULL)
5234 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
5235 if (dev->driver != NULL && dev->driver->name != NULL)
5236 strlcpy(udev.dv_drivername, dev->driver->name,
5237 sizeof(udev.dv_drivername));
5238 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
5239 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
5240 udev.dv_devflags = dev->devflags;
5241 udev.dv_flags = dev->flags;
5242 udev.dv_state = dev->state;
5243 error = SYSCTL_OUT(req, &udev, sizeof(udev));
5247 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5248 "system device tree");
5251 bus_data_generation_check(int generation)
5253 if (generation != bus_data_generation)
5256 /* XXX generate optimised lists here? */
5261 bus_data_generation_update(void)
5263 bus_data_generation++;
5267 bus_free_resource(device_t dev, int type, struct resource *r)
5271 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5275 device_lookup_by_name(const char *name)
5279 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5280 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5287 * /dev/devctl2 implementation. The existing /dev/devctl device has
5288 * implicit semantics on open, so it could not be reused for this.
5289 * Another option would be to call this /dev/bus?
5292 find_device(struct devreq *req, device_t *devp)
5297 * First, ensure that the name is nul terminated.
5299 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5303 * Second, try to find an attached device whose name matches
5306 dev = device_lookup_by_name(req->dr_name);
5312 /* Finally, give device enumerators a chance. */
5314 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev);
5322 driver_exists(device_t bus, const char *driver)
5326 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5327 if (devclass_find_driver_internal(dc, driver) != NULL)
5334 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5341 /* Locate the device to control. */
5343 req = (struct devreq *)data;
5351 case DEV_SET_DRIVER:
5352 case DEV_CLEAR_DRIVER:
5355 error = priv_check(td, PRIV_DRIVER);
5357 error = find_device(req, &dev);
5368 /* Perform the requested operation. */
5371 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5373 else if (!device_is_enabled(dev))
5376 error = device_probe_and_attach(dev);
5379 if (!device_is_attached(dev)) {
5383 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5384 error = device_quiesce(dev);
5388 error = device_detach(dev);
5391 if (device_is_enabled(dev)) {
5397 * If the device has been probed but not attached (e.g.
5398 * when it has been disabled by a loader hint), just
5399 * attach the device rather than doing a full probe.
5402 if (device_is_alive(dev)) {
5404 * If the device was disabled via a hint, clear
5407 if (resource_disabled(dev->driver->name, dev->unit))
5408 resource_unset_value(dev->driver->name,
5409 dev->unit, "disabled");
5410 error = device_attach(dev);
5412 error = device_probe_and_attach(dev);
5415 if (!device_is_enabled(dev)) {
5420 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5421 error = device_quiesce(dev);
5427 * Force DF_FIXEDCLASS on around detach to preserve
5428 * the existing name.
5431 dev->flags |= DF_FIXEDCLASS;
5432 error = device_detach(dev);
5433 if (!(old & DF_FIXEDCLASS))
5434 dev->flags &= ~DF_FIXEDCLASS;
5436 device_disable(dev);
5439 if (device_is_suspended(dev)) {
5443 if (device_get_parent(dev) == NULL) {
5447 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5450 if (!device_is_suspended(dev)) {
5454 if (device_get_parent(dev) == NULL) {
5458 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5460 case DEV_SET_DRIVER: {
5464 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5467 if (driver[0] == '\0') {
5471 if (dev->devclass != NULL &&
5472 strcmp(driver, dev->devclass->name) == 0)
5473 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5477 * Scan drivers for this device's bus looking for at
5478 * least one matching driver.
5480 if (dev->parent == NULL) {
5484 if (!driver_exists(dev->parent, driver)) {
5488 dc = devclass_create(driver);
5494 /* Detach device if necessary. */
5495 if (device_is_attached(dev)) {
5496 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5497 error = device_detach(dev);
5504 /* Clear any previously-fixed device class and unit. */
5505 if (dev->flags & DF_FIXEDCLASS)
5506 devclass_delete_device(dev->devclass, dev);
5507 dev->flags |= DF_WILDCARD;
5510 /* Force the new device class. */
5511 error = devclass_add_device(dc, dev);
5514 dev->flags |= DF_FIXEDCLASS;
5515 error = device_probe_and_attach(dev);
5518 case DEV_CLEAR_DRIVER:
5519 if (!(dev->flags & DF_FIXEDCLASS)) {
5523 if (device_is_attached(dev)) {
5524 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5525 error = device_detach(dev);
5532 dev->flags &= ~DF_FIXEDCLASS;
5533 dev->flags |= DF_WILDCARD;
5534 devclass_delete_device(dev->devclass, dev);
5535 error = device_probe_and_attach(dev);
5538 if (!device_is_attached(dev)) {
5542 error = BUS_RESCAN(dev);
5547 parent = device_get_parent(dev);
5548 if (parent == NULL) {
5552 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5553 if (bus_child_present(dev) != 0) {
5559 error = device_delete_child(parent, dev);
5567 static struct cdevsw devctl2_cdevsw = {
5568 .d_version = D_VERSION,
5569 .d_ioctl = devctl2_ioctl,
5570 .d_name = "devctl2",
5577 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5578 UID_ROOT, GID_WHEEL, 0600, "devctl2");