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$");
33 #include <sys/param.h>
35 #include <sys/filio.h>
37 #include <sys/kernel.h>
39 #include <sys/limits.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
46 #include <sys/condvar.h>
47 #include <sys/queue.h>
48 #include <machine/bus.h>
49 #include <sys/random.h>
51 #include <sys/selinfo.h>
52 #include <sys/signalvar.h>
54 #include <sys/sysctl.h>
55 #include <sys/systm.h>
58 #include <sys/interrupt.h>
59 #include <sys/cpuset.h>
63 #include <machine/cpu.h>
64 #include <machine/stdarg.h>
71 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
72 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
75 * Used to attach drivers to devclasses.
77 typedef struct driverlink *driverlink_t;
80 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
82 TAILQ_ENTRY(driverlink) passlink;
86 * Forward declarations
88 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
89 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
90 typedef TAILQ_HEAD(device_list, device) device_list_t;
93 TAILQ_ENTRY(devclass) link;
94 devclass_t parent; /* parent in devclass hierarchy */
95 driver_list_t drivers; /* bus devclasses store drivers for bus */
97 device_t *devices; /* array of devices indexed by unit */
98 int maxunit; /* size of devices array */
100 #define DC_HAS_CHILDREN 1
102 struct sysctl_ctx_list sysctl_ctx;
103 struct sysctl_oid *sysctl_tree;
107 * @brief Implementation of device.
111 * A device is a kernel object. The first field must be the
112 * current ops table for the object.
119 TAILQ_ENTRY(device) link; /**< list of devices in parent */
120 TAILQ_ENTRY(device) devlink; /**< global device list membership */
121 device_t parent; /**< parent of this device */
122 device_list_t children; /**< list of child devices */
125 * Details of this device.
127 driver_t *driver; /**< current driver */
128 devclass_t devclass; /**< current device class */
129 int unit; /**< current unit number */
130 char* nameunit; /**< name+unit e.g. foodev0 */
131 char* desc; /**< driver specific description */
132 int busy; /**< count of calls to device_busy() */
133 device_state_t state; /**< current device state */
134 uint32_t devflags; /**< api level flags for device_get_flags() */
135 u_int flags; /**< internal device flags */
136 u_int order; /**< order from device_add_child_ordered() */
137 void *ivars; /**< instance variables */
138 void *softc; /**< current driver's variables */
140 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
141 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
144 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
145 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
147 static void devctl2_init(void);
149 #define DRIVERNAME(d) ((d)? d->name : "no driver")
150 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
154 static int bus_debug = 1;
155 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
158 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
159 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
162 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
163 * prevent syslog from deleting initial spaces
165 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
167 static void print_device_short(device_t dev, int indent);
168 static void print_device(device_t dev, int indent);
169 void print_device_tree_short(device_t dev, int indent);
170 void print_device_tree(device_t dev, int indent);
171 static void print_driver_short(driver_t *driver, int indent);
172 static void print_driver(driver_t *driver, int indent);
173 static void print_driver_list(driver_list_t drivers, int indent);
174 static void print_devclass_short(devclass_t dc, int indent);
175 static void print_devclass(devclass_t dc, int indent);
176 void print_devclass_list_short(void);
177 void print_devclass_list(void);
180 /* Make the compiler ignore the function calls */
181 #define PDEBUG(a) /* nop */
182 #define DEVICENAME(d) /* nop */
184 #define print_device_short(d,i) /* nop */
185 #define print_device(d,i) /* nop */
186 #define print_device_tree_short(d,i) /* nop */
187 #define print_device_tree(d,i) /* nop */
188 #define print_driver_short(d,i) /* nop */
189 #define print_driver(d,i) /* nop */
190 #define print_driver_list(d,i) /* nop */
191 #define print_devclass_short(d,i) /* nop */
192 #define print_devclass(d,i) /* nop */
193 #define print_devclass_list_short() /* nop */
194 #define print_devclass_list() /* nop */
202 DEVCLASS_SYSCTL_PARENT,
206 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
208 devclass_t dc = (devclass_t)arg1;
212 case DEVCLASS_SYSCTL_PARENT:
213 value = dc->parent ? dc->parent->name : "";
218 return (SYSCTL_OUT_STR(req, value));
222 devclass_sysctl_init(devclass_t dc)
225 if (dc->sysctl_tree != NULL)
227 sysctl_ctx_init(&dc->sysctl_ctx);
228 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
229 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
230 CTLFLAG_RD, NULL, "");
231 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
232 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
233 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
239 DEVICE_SYSCTL_DRIVER,
240 DEVICE_SYSCTL_LOCATION,
241 DEVICE_SYSCTL_PNPINFO,
242 DEVICE_SYSCTL_PARENT,
246 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
248 device_t dev = (device_t)arg1;
255 case DEVICE_SYSCTL_DESC:
256 value = dev->desc ? dev->desc : "";
258 case DEVICE_SYSCTL_DRIVER:
259 value = dev->driver ? dev->driver->name : "";
261 case DEVICE_SYSCTL_LOCATION:
262 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
263 bus_child_location_str(dev, buf, 1024);
265 case DEVICE_SYSCTL_PNPINFO:
266 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
267 bus_child_pnpinfo_str(dev, buf, 1024);
269 case DEVICE_SYSCTL_PARENT:
270 value = dev->parent ? dev->parent->nameunit : "";
275 error = SYSCTL_OUT_STR(req, value);
282 device_sysctl_init(device_t dev)
284 devclass_t dc = dev->devclass;
287 if (dev->sysctl_tree != NULL)
289 devclass_sysctl_init(dc);
290 sysctl_ctx_init(&dev->sysctl_ctx);
291 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
292 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
293 dev->nameunit + strlen(dc->name),
294 CTLFLAG_RD, NULL, "", "device_index");
295 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
296 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
297 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
298 "device description");
299 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
300 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
301 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
302 "device driver name");
303 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
304 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
305 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
306 "device location relative to parent");
307 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
308 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
309 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
310 "device identification");
311 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
312 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
313 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
315 if (bus_get_domain(dev, &domain) == 0)
316 SYSCTL_ADD_INT(&dev->sysctl_ctx,
317 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
318 CTLFLAG_RD, NULL, domain, "NUMA domain");
322 device_sysctl_update(device_t dev)
324 devclass_t dc = dev->devclass;
326 if (dev->sysctl_tree == NULL)
328 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
332 device_sysctl_fini(device_t dev)
334 if (dev->sysctl_tree == NULL)
336 sysctl_ctx_free(&dev->sysctl_ctx);
337 dev->sysctl_tree = NULL;
341 * /dev/devctl implementation
345 * This design allows only one reader for /dev/devctl. This is not desirable
346 * in the long run, but will get a lot of hair out of this implementation.
347 * Maybe we should make this device a clonable device.
349 * Also note: we specifically do not attach a device to the device_t tree
350 * to avoid potential chicken and egg problems. One could argue that all
351 * of this belongs to the root node. One could also further argue that the
352 * sysctl interface that we have not might more properly be an ioctl
353 * interface, but at this stage of the game, I'm not inclined to rock that
356 * I'm also not sure that the SIGIO support is done correctly or not, as
357 * I copied it from a driver that had SIGIO support that likely hasn't been
358 * tested since 3.4 or 2.2.8!
361 /* Deprecated way to adjust queue length */
362 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
363 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
364 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
365 "devctl disable -- deprecated");
367 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
368 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
369 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
370 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
371 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
373 static d_open_t devopen;
374 static d_close_t devclose;
375 static d_read_t devread;
376 static d_ioctl_t devioctl;
377 static d_poll_t devpoll;
378 static d_kqfilter_t devkqfilter;
380 static struct cdevsw dev_cdevsw = {
381 .d_version = D_VERSION,
387 .d_kqfilter = devkqfilter,
391 struct dev_event_info
394 TAILQ_ENTRY(dev_event_info) dei_link;
397 TAILQ_HEAD(devq, dev_event_info);
399 static struct dev_softc
412 static void filt_devctl_detach(struct knote *kn);
413 static int filt_devctl_read(struct knote *kn, long hint);
415 struct filterops devctl_rfiltops = {
417 .f_detach = filt_devctl_detach,
418 .f_event = filt_devctl_read,
421 static struct cdev *devctl_dev;
426 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
427 UID_ROOT, GID_WHEEL, 0600, "devctl");
428 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
429 cv_init(&devsoftc.cv, "dev cv");
430 TAILQ_INIT(&devsoftc.devq);
431 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
436 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
439 mtx_lock(&devsoftc.mtx);
440 if (devsoftc.inuse) {
441 mtx_unlock(&devsoftc.mtx);
446 mtx_unlock(&devsoftc.mtx);
451 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
454 mtx_lock(&devsoftc.mtx);
456 devsoftc.nonblock = 0;
458 cv_broadcast(&devsoftc.cv);
459 funsetown(&devsoftc.sigio);
460 mtx_unlock(&devsoftc.mtx);
465 * The read channel for this device is used to report changes to
466 * userland in realtime. We are required to free the data as well as
467 * the n1 object because we allocate them separately. Also note that
468 * we return one record at a time. If you try to read this device a
469 * character at a time, you will lose the rest of the data. Listening
470 * programs are expected to cope.
473 devread(struct cdev *dev, struct uio *uio, int ioflag)
475 struct dev_event_info *n1;
478 mtx_lock(&devsoftc.mtx);
479 while (TAILQ_EMPTY(&devsoftc.devq)) {
480 if (devsoftc.nonblock) {
481 mtx_unlock(&devsoftc.mtx);
484 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
487 * Need to translate ERESTART to EINTR here? -- jake
489 mtx_unlock(&devsoftc.mtx);
493 n1 = TAILQ_FIRST(&devsoftc.devq);
494 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
496 mtx_unlock(&devsoftc.mtx);
497 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
498 free(n1->dei_data, M_BUS);
504 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
510 devsoftc.nonblock = 1;
512 devsoftc.nonblock = 0;
521 return fsetown(*(int *)data, &devsoftc.sigio);
523 *(int *)data = fgetown(&devsoftc.sigio);
526 /* (un)Support for other fcntl() calls. */
537 devpoll(struct cdev *dev, int events, struct thread *td)
541 mtx_lock(&devsoftc.mtx);
542 if (events & (POLLIN | POLLRDNORM)) {
543 if (!TAILQ_EMPTY(&devsoftc.devq))
544 revents = events & (POLLIN | POLLRDNORM);
546 selrecord(td, &devsoftc.sel);
548 mtx_unlock(&devsoftc.mtx);
554 devkqfilter(struct cdev *dev, struct knote *kn)
558 if (kn->kn_filter == EVFILT_READ) {
559 kn->kn_fop = &devctl_rfiltops;
560 knlist_add(&devsoftc.sel.si_note, kn, 0);
568 filt_devctl_detach(struct knote *kn)
571 knlist_remove(&devsoftc.sel.si_note, kn, 0);
575 filt_devctl_read(struct knote *kn, long hint)
577 kn->kn_data = devsoftc.queued;
578 return (kn->kn_data != 0);
582 * @brief Return whether the userland process is running
585 devctl_process_running(void)
587 return (devsoftc.inuse == 1);
591 * @brief Queue data to be read from the devctl device
593 * Generic interface to queue data to the devctl device. It is
594 * assumed that @p data is properly formatted. It is further assumed
595 * that @p data is allocated using the M_BUS malloc type.
598 devctl_queue_data_f(char *data, int flags)
600 struct dev_event_info *n1 = NULL, *n2 = NULL;
602 if (strlen(data) == 0)
604 if (devctl_queue_length == 0)
606 n1 = malloc(sizeof(*n1), M_BUS, flags);
610 mtx_lock(&devsoftc.mtx);
611 if (devctl_queue_length == 0) {
612 mtx_unlock(&devsoftc.mtx);
613 free(n1->dei_data, M_BUS);
617 /* Leave at least one spot in the queue... */
618 while (devsoftc.queued > devctl_queue_length - 1) {
619 n2 = TAILQ_FIRST(&devsoftc.devq);
620 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
621 free(n2->dei_data, M_BUS);
625 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
627 cv_broadcast(&devsoftc.cv);
628 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
629 mtx_unlock(&devsoftc.mtx);
630 selwakeup(&devsoftc.sel);
631 if (devsoftc.async && devsoftc.sigio != NULL)
632 pgsigio(&devsoftc.sigio, SIGIO, 0);
636 * We have to free data on all error paths since the caller
637 * assumes it will be free'd when this item is dequeued.
644 devctl_queue_data(char *data)
647 devctl_queue_data_f(data, M_NOWAIT);
651 * @brief Send a 'notification' to userland, using standard ways
654 devctl_notify_f(const char *system, const char *subsystem, const char *type,
655 const char *data, int flags)
661 return; /* BOGUS! Must specify system. */
662 if (subsystem == NULL)
663 return; /* BOGUS! Must specify subsystem. */
665 return; /* BOGUS! Must specify type. */
666 len += strlen(" system=") + strlen(system);
667 len += strlen(" subsystem=") + strlen(subsystem);
668 len += strlen(" type=") + strlen(type);
669 /* add in the data message plus newline. */
672 len += 3; /* '!', '\n', and NUL */
673 msg = malloc(len, M_BUS, flags);
675 return; /* Drop it on the floor */
677 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
678 system, subsystem, type, data);
680 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
681 system, subsystem, type);
682 devctl_queue_data_f(msg, flags);
686 devctl_notify(const char *system, const char *subsystem, const char *type,
690 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
694 * Common routine that tries to make sending messages as easy as possible.
695 * We allocate memory for the data, copy strings into that, but do not
696 * free it unless there's an error. The dequeue part of the driver should
697 * free the data. We don't send data when the device is disabled. We do
698 * send data, even when we have no listeners, because we wish to avoid
699 * races relating to startup and restart of listening applications.
701 * devaddq is designed to string together the type of event, with the
702 * object of that event, plus the plug and play info and location info
703 * for that event. This is likely most useful for devices, but less
704 * useful for other consumers of this interface. Those should use
705 * the devctl_queue_data() interface instead.
708 devaddq(const char *type, const char *what, device_t dev)
715 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
717 data = malloc(1024, M_BUS, M_NOWAIT);
721 /* get the bus specific location of this device */
722 loc = malloc(1024, M_BUS, M_NOWAIT);
726 bus_child_location_str(dev, loc, 1024);
728 /* Get the bus specific pnp info of this device */
729 pnp = malloc(1024, M_BUS, M_NOWAIT);
733 bus_child_pnpinfo_str(dev, pnp, 1024);
735 /* Get the parent of this device, or / if high enough in the tree. */
736 if (device_get_parent(dev) == NULL)
737 parstr = "."; /* Or '/' ? */
739 parstr = device_get_nameunit(device_get_parent(dev));
740 /* String it all together. */
741 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
745 devctl_queue_data(data);
755 * A device was added to the tree. We are called just after it successfully
756 * attaches (that is, probe and attach success for this device). No call
757 * is made if a device is merely parented into the tree. See devnomatch
758 * if probe fails. If attach fails, no notification is sent (but maybe
759 * we should have a different message for this).
762 devadded(device_t dev)
764 devaddq("+", device_get_nameunit(dev), dev);
768 * A device was removed from the tree. We are called just before this
772 devremoved(device_t dev)
774 devaddq("-", device_get_nameunit(dev), dev);
778 * Called when there's no match for this device. This is only called
779 * the first time that no match happens, so we don't keep getting this
780 * message. Should that prove to be undesirable, we can change it.
781 * This is called when all drivers that can attach to a given bus
782 * decline to accept this device. Other errors may not be detected.
785 devnomatch(device_t dev)
787 devaddq("?", "", dev);
791 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
793 struct dev_event_info *n1;
796 dis = (devctl_queue_length == 0);
797 error = sysctl_handle_int(oidp, &dis, 0, req);
798 if (error || !req->newptr)
800 if (mtx_initialized(&devsoftc.mtx))
801 mtx_lock(&devsoftc.mtx);
803 while (!TAILQ_EMPTY(&devsoftc.devq)) {
804 n1 = TAILQ_FIRST(&devsoftc.devq);
805 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
806 free(n1->dei_data, M_BUS);
810 devctl_queue_length = 0;
812 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
814 if (mtx_initialized(&devsoftc.mtx))
815 mtx_unlock(&devsoftc.mtx);
820 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
822 struct dev_event_info *n1;
825 q = devctl_queue_length;
826 error = sysctl_handle_int(oidp, &q, 0, req);
827 if (error || !req->newptr)
831 if (mtx_initialized(&devsoftc.mtx))
832 mtx_lock(&devsoftc.mtx);
833 devctl_queue_length = q;
834 while (devsoftc.queued > devctl_queue_length) {
835 n1 = TAILQ_FIRST(&devsoftc.devq);
836 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
837 free(n1->dei_data, M_BUS);
841 if (mtx_initialized(&devsoftc.mtx))
842 mtx_unlock(&devsoftc.mtx);
847 * @brief safely quotes strings that might have double quotes in them.
849 * The devctl protocol relies on quoted strings having matching quotes.
850 * This routine quotes any internal quotes so the resulting string
851 * is safe to pass to snprintf to construct, for example pnp info strings.
852 * Strings are always terminated with a NUL, but may be truncated if longer
853 * than @p len bytes after quotes.
855 * @param dst Buffer to hold the string. Must be at least @p len bytes long
856 * @param src Original buffer.
857 * @param len Length of buffer pointed to by @dst, including trailing NUL
860 devctl_safe_quote(char *dst, const char *src, size_t len)
862 char *walker = dst, *ep = dst + len - 1;
866 while (src != NULL && walker < ep)
868 if (*src == '"' || *src == '\\') {
878 /* End of /dev/devctl code */
880 static TAILQ_HEAD(,device) bus_data_devices;
881 static int bus_data_generation = 1;
883 static kobj_method_t null_methods[] = {
887 DEFINE_CLASS(null, null_methods, 0);
890 * Bus pass implementation
893 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
894 int bus_current_pass = BUS_PASS_ROOT;
898 * @brief Register the pass level of a new driver attachment
900 * Register a new driver attachment's pass level. If no driver
901 * attachment with the same pass level has been added, then @p new
902 * will be added to the global passes list.
904 * @param new the new driver attachment
907 driver_register_pass(struct driverlink *new)
909 struct driverlink *dl;
911 /* We only consider pass numbers during boot. */
912 if (bus_current_pass == BUS_PASS_DEFAULT)
916 * Walk the passes list. If we already know about this pass
917 * then there is nothing to do. If we don't, then insert this
918 * driver link into the list.
920 TAILQ_FOREACH(dl, &passes, passlink) {
921 if (dl->pass < new->pass)
923 if (dl->pass == new->pass)
925 TAILQ_INSERT_BEFORE(dl, new, passlink);
928 TAILQ_INSERT_TAIL(&passes, new, passlink);
932 * @brief Raise the current bus pass
934 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
935 * method on the root bus to kick off a new device tree scan for each
936 * new pass level that has at least one driver.
939 bus_set_pass(int pass)
941 struct driverlink *dl;
943 if (bus_current_pass > pass)
944 panic("Attempt to lower bus pass level");
946 TAILQ_FOREACH(dl, &passes, passlink) {
947 /* Skip pass values below the current pass level. */
948 if (dl->pass <= bus_current_pass)
952 * Bail once we hit a driver with a pass level that is
959 * Raise the pass level to the next level and rescan
962 bus_current_pass = dl->pass;
963 BUS_NEW_PASS(root_bus);
967 * If there isn't a driver registered for the requested pass,
968 * then bus_current_pass might still be less than 'pass'. Set
969 * it to 'pass' in that case.
971 if (bus_current_pass < pass)
972 bus_current_pass = pass;
973 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
977 * Devclass implementation
980 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
984 * @brief Find or create a device class
986 * If a device class with the name @p classname exists, return it,
987 * otherwise if @p create is non-zero create and return a new device
990 * If @p parentname is non-NULL, the parent of the devclass is set to
991 * the devclass of that name.
993 * @param classname the devclass name to find or create
994 * @param parentname the parent devclass name or @c NULL
995 * @param create non-zero to create a devclass
998 devclass_find_internal(const char *classname, const char *parentname,
1003 PDEBUG(("looking for %s", classname));
1007 TAILQ_FOREACH(dc, &devclasses, link) {
1008 if (!strcmp(dc->name, classname))
1012 if (create && !dc) {
1013 PDEBUG(("creating %s", classname));
1014 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1015 M_BUS, M_NOWAIT | M_ZERO);
1019 dc->name = (char*) (dc + 1);
1020 strcpy(dc->name, classname);
1021 TAILQ_INIT(&dc->drivers);
1022 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1024 bus_data_generation_update();
1028 * If a parent class is specified, then set that as our parent so
1029 * that this devclass will support drivers for the parent class as
1030 * well. If the parent class has the same name don't do this though
1031 * as it creates a cycle that can trigger an infinite loop in
1032 * device_probe_child() if a device exists for which there is no
1035 if (parentname && dc && !dc->parent &&
1036 strcmp(classname, parentname) != 0) {
1037 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1038 dc->parent->flags |= DC_HAS_CHILDREN;
1045 * @brief Create a device class
1047 * If a device class with the name @p classname exists, return it,
1048 * otherwise create and return a new device class.
1050 * @param classname the devclass name to find or create
1053 devclass_create(const char *classname)
1055 return (devclass_find_internal(classname, NULL, TRUE));
1059 * @brief Find a device class
1061 * If a device class with the name @p classname exists, return it,
1062 * otherwise return @c NULL.
1064 * @param classname the devclass name to find
1067 devclass_find(const char *classname)
1069 return (devclass_find_internal(classname, NULL, FALSE));
1073 * @brief Register that a device driver has been added to a devclass
1075 * Register that a device driver has been added to a devclass. This
1076 * is called by devclass_add_driver to accomplish the recursive
1077 * notification of all the children classes of dc, as well as dc.
1078 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1081 * We do a full search here of the devclass list at each iteration
1082 * level to save storing children-lists in the devclass structure. If
1083 * we ever move beyond a few dozen devices doing this, we may need to
1086 * @param dc the devclass to edit
1087 * @param driver the driver that was just added
1090 devclass_driver_added(devclass_t dc, driver_t *driver)
1096 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1098 for (i = 0; i < dc->maxunit; i++)
1099 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1100 BUS_DRIVER_ADDED(dc->devices[i], driver);
1103 * Walk through the children classes. Since we only keep a
1104 * single parent pointer around, we walk the entire list of
1105 * devclasses looking for children. We set the
1106 * DC_HAS_CHILDREN flag when a child devclass is created on
1107 * the parent, so we only walk the list for those devclasses
1108 * that have children.
1110 if (!(dc->flags & DC_HAS_CHILDREN))
1113 TAILQ_FOREACH(dc, &devclasses, link) {
1114 if (dc->parent == parent)
1115 devclass_driver_added(dc, driver);
1120 * @brief Add a device driver to a device class
1122 * Add a device driver to a devclass. This is normally called
1123 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1124 * all devices in the devclass will be called to allow them to attempt
1125 * to re-probe any unmatched children.
1127 * @param dc the devclass to edit
1128 * @param driver the driver to register
1131 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1134 const char *parentname;
1136 PDEBUG(("%s", DRIVERNAME(driver)));
1138 /* Don't allow invalid pass values. */
1139 if (pass <= BUS_PASS_ROOT)
1142 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1147 * Compile the driver's methods. Also increase the reference count
1148 * so that the class doesn't get freed when the last instance
1149 * goes. This means we can safely use static methods and avoids a
1150 * double-free in devclass_delete_driver.
1152 kobj_class_compile((kobj_class_t) driver);
1155 * If the driver has any base classes, make the
1156 * devclass inherit from the devclass of the driver's
1157 * first base class. This will allow the system to
1158 * search for drivers in both devclasses for children
1159 * of a device using this driver.
1161 if (driver->baseclasses)
1162 parentname = driver->baseclasses[0]->name;
1165 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1167 dl->driver = driver;
1168 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1169 driver->refs++; /* XXX: kobj_mtx */
1171 driver_register_pass(dl);
1173 devclass_driver_added(dc, driver);
1174 bus_data_generation_update();
1179 * @brief Register that a device driver has been deleted from a devclass
1181 * Register that a device driver has been removed from a devclass.
1182 * This is called by devclass_delete_driver to accomplish the
1183 * recursive notification of all the children classes of busclass, as
1184 * well as busclass. Each layer will attempt to detach the driver
1185 * from any devices that are children of the bus's devclass. The function
1186 * will return an error if a device fails to detach.
1188 * We do a full search here of the devclass list at each iteration
1189 * level to save storing children-lists in the devclass structure. If
1190 * we ever move beyond a few dozen devices doing this, we may need to
1193 * @param busclass the devclass of the parent bus
1194 * @param dc the devclass of the driver being deleted
1195 * @param driver the driver being deleted
1198 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1205 * Disassociate from any devices. We iterate through all the
1206 * devices in the devclass of the driver and detach any which are
1207 * using the driver and which have a parent in the devclass which
1208 * we are deleting from.
1210 * Note that since a driver can be in multiple devclasses, we
1211 * should not detach devices which are not children of devices in
1212 * the affected devclass.
1214 for (i = 0; i < dc->maxunit; i++) {
1215 if (dc->devices[i]) {
1216 dev = dc->devices[i];
1217 if (dev->driver == driver && dev->parent &&
1218 dev->parent->devclass == busclass) {
1219 if ((error = device_detach(dev)) != 0)
1221 BUS_PROBE_NOMATCH(dev->parent, dev);
1223 dev->flags |= DF_DONENOMATCH;
1229 * Walk through the children classes. Since we only keep a
1230 * single parent pointer around, we walk the entire list of
1231 * devclasses looking for children. We set the
1232 * DC_HAS_CHILDREN flag when a child devclass is created on
1233 * the parent, so we only walk the list for those devclasses
1234 * that have children.
1236 if (!(busclass->flags & DC_HAS_CHILDREN))
1239 TAILQ_FOREACH(busclass, &devclasses, link) {
1240 if (busclass->parent == parent) {
1241 error = devclass_driver_deleted(busclass, dc, driver);
1250 * @brief Delete a device driver from a device class
1252 * Delete a device driver from a devclass. This is normally called
1253 * automatically by DRIVER_MODULE().
1255 * If the driver is currently attached to any devices,
1256 * devclass_delete_driver() will first attempt to detach from each
1257 * device. If one of the detach calls fails, the driver will not be
1260 * @param dc the devclass to edit
1261 * @param driver the driver to unregister
1264 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1266 devclass_t dc = devclass_find(driver->name);
1270 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1276 * Find the link structure in the bus' list of drivers.
1278 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1279 if (dl->driver == driver)
1284 PDEBUG(("%s not found in %s list", driver->name,
1289 error = devclass_driver_deleted(busclass, dc, driver);
1293 TAILQ_REMOVE(&busclass->drivers, dl, link);
1298 if (driver->refs == 0)
1299 kobj_class_free((kobj_class_t) driver);
1301 bus_data_generation_update();
1306 * @brief Quiesces a set of device drivers from a device class
1308 * Quiesce a device driver from a devclass. This is normally called
1309 * automatically by DRIVER_MODULE().
1311 * If the driver is currently attached to any devices,
1312 * devclass_quiesece_driver() will first attempt to quiesce each
1315 * @param dc the devclass to edit
1316 * @param driver the driver to unregister
1319 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1321 devclass_t dc = devclass_find(driver->name);
1327 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1333 * Find the link structure in the bus' list of drivers.
1335 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1336 if (dl->driver == driver)
1341 PDEBUG(("%s not found in %s list", driver->name,
1347 * Quiesce all devices. We iterate through all the devices in
1348 * the devclass of the driver and quiesce any which are using
1349 * the driver and which have a parent in the devclass which we
1352 * Note that since a driver can be in multiple devclasses, we
1353 * should not quiesce devices which are not children of
1354 * devices in the affected devclass.
1356 for (i = 0; i < dc->maxunit; i++) {
1357 if (dc->devices[i]) {
1358 dev = dc->devices[i];
1359 if (dev->driver == driver && dev->parent &&
1360 dev->parent->devclass == busclass) {
1361 if ((error = device_quiesce(dev)) != 0)
1374 devclass_find_driver_internal(devclass_t dc, const char *classname)
1378 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1380 TAILQ_FOREACH(dl, &dc->drivers, link) {
1381 if (!strcmp(dl->driver->name, classname))
1385 PDEBUG(("not found"));
1390 * @brief Return the name of the devclass
1393 devclass_get_name(devclass_t dc)
1399 * @brief Find a device given a unit number
1401 * @param dc the devclass to search
1402 * @param unit the unit number to search for
1404 * @returns the device with the given unit number or @c
1405 * NULL if there is no such device
1408 devclass_get_device(devclass_t dc, int unit)
1410 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1412 return (dc->devices[unit]);
1416 * @brief Find the softc field of a device given a unit number
1418 * @param dc the devclass to search
1419 * @param unit the unit number to search for
1421 * @returns the softc field of the device with the given
1422 * unit number or @c NULL if there is no such
1426 devclass_get_softc(devclass_t dc, int unit)
1430 dev = devclass_get_device(dc, unit);
1434 return (device_get_softc(dev));
1438 * @brief Get a list of devices in the devclass
1440 * An array containing a list of all the devices in the given devclass
1441 * is allocated and returned in @p *devlistp. The number of devices
1442 * in the array is returned in @p *devcountp. The caller should free
1443 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1445 * @param dc the devclass to examine
1446 * @param devlistp points at location for array pointer return
1448 * @param devcountp points at location for array size return value
1451 * @retval ENOMEM the array allocation failed
1454 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1459 count = devclass_get_count(dc);
1460 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1465 for (i = 0; i < dc->maxunit; i++) {
1466 if (dc->devices[i]) {
1467 list[count] = dc->devices[i];
1479 * @brief Get a list of drivers in the devclass
1481 * An array containing a list of pointers to all the drivers in the
1482 * given devclass is allocated and returned in @p *listp. The number
1483 * of drivers in the array is returned in @p *countp. The caller should
1484 * free the array using @c free(p, M_TEMP).
1486 * @param dc the devclass to examine
1487 * @param listp gives location for array pointer return value
1488 * @param countp gives location for number of array elements
1492 * @retval ENOMEM the array allocation failed
1495 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1502 TAILQ_FOREACH(dl, &dc->drivers, link)
1504 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1509 TAILQ_FOREACH(dl, &dc->drivers, link) {
1510 list[count] = dl->driver;
1520 * @brief Get the number of devices in a devclass
1522 * @param dc the devclass to examine
1525 devclass_get_count(devclass_t dc)
1530 for (i = 0; i < dc->maxunit; i++)
1537 * @brief Get the maximum unit number used in a devclass
1539 * Note that this is one greater than the highest currently-allocated
1540 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1541 * that not even the devclass has been allocated yet.
1543 * @param dc the devclass to examine
1546 devclass_get_maxunit(devclass_t dc)
1550 return (dc->maxunit);
1554 * @brief Find a free unit number in a devclass
1556 * This function searches for the first unused unit number greater
1557 * that or equal to @p unit.
1559 * @param dc the devclass to examine
1560 * @param unit the first unit number to check
1563 devclass_find_free_unit(devclass_t dc, int unit)
1567 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1573 * @brief Set the parent of a devclass
1575 * The parent class is normally initialised automatically by
1578 * @param dc the devclass to edit
1579 * @param pdc the new parent devclass
1582 devclass_set_parent(devclass_t dc, devclass_t pdc)
1588 * @brief Get the parent of a devclass
1590 * @param dc the devclass to examine
1593 devclass_get_parent(devclass_t dc)
1595 return (dc->parent);
1598 struct sysctl_ctx_list *
1599 devclass_get_sysctl_ctx(devclass_t dc)
1601 return (&dc->sysctl_ctx);
1605 devclass_get_sysctl_tree(devclass_t dc)
1607 return (dc->sysctl_tree);
1612 * @brief Allocate a unit number
1614 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1615 * will do). The allocated unit number is returned in @p *unitp.
1617 * @param dc the devclass to allocate from
1618 * @param unitp points at the location for the allocated unit
1622 * @retval EEXIST the requested unit number is already allocated
1623 * @retval ENOMEM memory allocation failure
1626 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1631 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1633 /* Ask the parent bus if it wants to wire this device. */
1635 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1638 /* If we were given a wired unit number, check for existing device */
1641 if (unit >= 0 && unit < dc->maxunit &&
1642 dc->devices[unit] != NULL) {
1644 printf("%s: %s%d already exists; skipping it\n",
1645 dc->name, dc->name, *unitp);
1649 /* Unwired device, find the next available slot for it */
1651 for (unit = 0;; unit++) {
1652 /* If there is an "at" hint for a unit then skip it. */
1653 if (resource_string_value(dc->name, unit, "at", &s) ==
1657 /* If this device slot is already in use, skip it. */
1658 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1666 * We've selected a unit beyond the length of the table, so let's
1667 * extend the table to make room for all units up to and including
1670 if (unit >= dc->maxunit) {
1671 device_t *newlist, *oldlist;
1674 oldlist = dc->devices;
1675 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1676 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1679 if (oldlist != NULL)
1680 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1681 bzero(newlist + dc->maxunit,
1682 sizeof(device_t) * (newsize - dc->maxunit));
1683 dc->devices = newlist;
1684 dc->maxunit = newsize;
1685 if (oldlist != NULL)
1686 free(oldlist, M_BUS);
1688 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1696 * @brief Add a device to a devclass
1698 * A unit number is allocated for the device (using the device's
1699 * preferred unit number if any) and the device is registered in the
1700 * devclass. This allows the device to be looked up by its unit
1701 * number, e.g. by decoding a dev_t minor number.
1703 * @param dc the devclass to add to
1704 * @param dev the device to add
1707 * @retval EEXIST the requested unit number is already allocated
1708 * @retval ENOMEM memory allocation failure
1711 devclass_add_device(devclass_t dc, device_t dev)
1715 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1717 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1720 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1724 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1725 free(dev->nameunit, M_BUS);
1726 dev->nameunit = NULL;
1729 dc->devices[dev->unit] = dev;
1731 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1738 * @brief Delete a device from a devclass
1740 * The device is removed from the devclass's device list and its unit
1743 * @param dc the devclass to delete from
1744 * @param dev the device to delete
1749 devclass_delete_device(devclass_t dc, device_t dev)
1754 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1756 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1757 panic("devclass_delete_device: inconsistent device class");
1758 dc->devices[dev->unit] = NULL;
1759 if (dev->flags & DF_WILDCARD)
1761 dev->devclass = NULL;
1762 free(dev->nameunit, M_BUS);
1763 dev->nameunit = NULL;
1770 * @brief Make a new device and add it as a child of @p parent
1772 * @param parent the parent of the new device
1773 * @param name the devclass name of the new device or @c NULL
1774 * to leave the devclass unspecified
1775 * @parem unit the unit number of the new device of @c -1 to
1776 * leave the unit number unspecified
1778 * @returns the new device
1781 make_device(device_t parent, const char *name, int unit)
1786 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1789 dc = devclass_find_internal(name, NULL, TRUE);
1791 printf("make_device: can't find device class %s\n",
1799 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1803 dev->parent = parent;
1804 TAILQ_INIT(&dev->children);
1805 kobj_init((kobj_t) dev, &null_class);
1807 dev->devclass = NULL;
1809 dev->nameunit = NULL;
1813 dev->flags = DF_ENABLED;
1816 dev->flags |= DF_WILDCARD;
1818 dev->flags |= DF_FIXEDCLASS;
1819 if (devclass_add_device(dc, dev)) {
1820 kobj_delete((kobj_t) dev, M_BUS);
1827 dev->state = DS_NOTPRESENT;
1829 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1830 bus_data_generation_update();
1837 * @brief Print a description of a device.
1840 device_print_child(device_t dev, device_t child)
1844 if (device_is_alive(child))
1845 retval += BUS_PRINT_CHILD(dev, child);
1847 retval += device_printf(child, " not found\n");
1853 * @brief Create a new device
1855 * This creates a new device and adds it as a child of an existing
1856 * parent device. The new device will be added after the last existing
1857 * child with order zero.
1859 * @param dev the device which will be the parent of the
1861 * @param name devclass name for new device or @c NULL if not
1863 * @param unit unit number for new device or @c -1 if not
1866 * @returns the new device
1869 device_add_child(device_t dev, const char *name, int unit)
1871 return (device_add_child_ordered(dev, 0, name, unit));
1875 * @brief Create a new device
1877 * This creates a new device and adds it as a child of an existing
1878 * parent device. The new device will be added after the last existing
1879 * child with the same order.
1881 * @param dev the device which will be the parent of the
1883 * @param order a value which is used to partially sort the
1884 * children of @p dev - devices created using
1885 * lower values of @p order appear first in @p
1886 * dev's list of children
1887 * @param name devclass name for new device or @c NULL if not
1889 * @param unit unit number for new device or @c -1 if not
1892 * @returns the new device
1895 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1900 PDEBUG(("%s at %s with order %u as unit %d",
1901 name, DEVICENAME(dev), order, unit));
1902 KASSERT(name != NULL || unit == -1,
1903 ("child device with wildcard name and specific unit number"));
1905 child = make_device(dev, name, unit);
1908 child->order = order;
1910 TAILQ_FOREACH(place, &dev->children, link) {
1911 if (place->order > order)
1917 * The device 'place' is the first device whose order is
1918 * greater than the new child.
1920 TAILQ_INSERT_BEFORE(place, child, link);
1923 * The new child's order is greater or equal to the order of
1924 * any existing device. Add the child to the tail of the list.
1926 TAILQ_INSERT_TAIL(&dev->children, child, link);
1929 bus_data_generation_update();
1934 * @brief Delete a device
1936 * This function deletes a device along with all of its children. If
1937 * the device currently has a driver attached to it, the device is
1938 * detached first using device_detach().
1940 * @param dev the parent device
1941 * @param child the device to delete
1944 * @retval non-zero a unit error code describing the error
1947 device_delete_child(device_t dev, device_t child)
1950 device_t grandchild;
1952 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1954 /* detach parent before deleting children, if any */
1955 if ((error = device_detach(child)) != 0)
1958 /* remove children second */
1959 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1960 error = device_delete_child(child, grandchild);
1965 if (child->devclass)
1966 devclass_delete_device(child->devclass, child);
1968 BUS_CHILD_DELETED(dev, child);
1969 TAILQ_REMOVE(&dev->children, child, link);
1970 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1971 kobj_delete((kobj_t) child, M_BUS);
1973 bus_data_generation_update();
1978 * @brief Delete all children devices of the given device, if any.
1980 * This function deletes all children devices of the given device, if
1981 * any, using the device_delete_child() function for each device it
1982 * finds. If a child device cannot be deleted, this function will
1983 * return an error code.
1985 * @param dev the parent device
1988 * @retval non-zero a device would not detach
1991 device_delete_children(device_t dev)
1996 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2000 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2001 error = device_delete_child(dev, child);
2003 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2011 * @brief Find a device given a unit number
2013 * This is similar to devclass_get_devices() but only searches for
2014 * devices which have @p dev as a parent.
2016 * @param dev the parent device to search
2017 * @param unit the unit number to search for. If the unit is -1,
2018 * return the first child of @p dev which has name
2019 * @p classname (that is, the one with the lowest unit.)
2021 * @returns the device with the given unit number or @c
2022 * NULL if there is no such device
2025 device_find_child(device_t dev, const char *classname, int unit)
2030 dc = devclass_find(classname);
2035 child = devclass_get_device(dc, unit);
2036 if (child && child->parent == dev)
2039 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2040 child = devclass_get_device(dc, unit);
2041 if (child && child->parent == dev)
2052 first_matching_driver(devclass_t dc, device_t dev)
2055 return (devclass_find_driver_internal(dc, dev->devclass->name));
2056 return (TAILQ_FIRST(&dc->drivers));
2063 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2065 if (dev->devclass) {
2067 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2068 if (!strcmp(dev->devclass->name, dl->driver->name))
2072 return (TAILQ_NEXT(last, link));
2079 device_probe_child(device_t dev, device_t child)
2082 driverlink_t best = NULL;
2084 int result, pri = 0;
2085 int hasclass = (child->devclass != NULL);
2091 panic("device_probe_child: parent device has no devclass");
2094 * If the state is already probed, then return. However, don't
2095 * return if we can rebid this object.
2097 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2100 for (; dc; dc = dc->parent) {
2101 for (dl = first_matching_driver(dc, child);
2103 dl = next_matching_driver(dc, child, dl)) {
2104 /* If this driver's pass is too high, then ignore it. */
2105 if (dl->pass > bus_current_pass)
2108 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2109 result = device_set_driver(child, dl->driver);
2110 if (result == ENOMEM)
2112 else if (result != 0)
2115 if (device_set_devclass(child,
2116 dl->driver->name) != 0) {
2117 char const * devname =
2118 device_get_name(child);
2119 if (devname == NULL)
2120 devname = "(unknown)";
2121 printf("driver bug: Unable to set "
2122 "devclass (class: %s "
2126 (void)device_set_driver(child, NULL);
2131 /* Fetch any flags for the device before probing. */
2132 resource_int_value(dl->driver->name, child->unit,
2133 "flags", &child->devflags);
2135 result = DEVICE_PROBE(child);
2137 /* Reset flags and devclass before the next probe. */
2138 child->devflags = 0;
2140 (void)device_set_devclass(child, NULL);
2143 * If the driver returns SUCCESS, there can be
2144 * no higher match for this device.
2153 * Reset DF_QUIET in case this driver doesn't
2154 * end up as the best driver.
2156 device_verbose(child);
2159 * Probes that return BUS_PROBE_NOWILDCARD or lower
2160 * only match on devices whose driver was explicitly
2163 if (result <= BUS_PROBE_NOWILDCARD &&
2164 !(child->flags & DF_FIXEDCLASS)) {
2169 * The driver returned an error so it
2170 * certainly doesn't match.
2173 (void)device_set_driver(child, NULL);
2178 * A priority lower than SUCCESS, remember the
2179 * best matching driver. Initialise the value
2180 * of pri for the first match.
2182 if (best == NULL || result > pri) {
2189 * If we have an unambiguous match in this devclass,
2190 * don't look in the parent.
2192 if (best && pri == 0)
2197 * If we found a driver, change state and initialise the devclass.
2199 /* XXX What happens if we rebid and got no best? */
2202 * If this device was attached, and we were asked to
2203 * rescan, and it is a different driver, then we have
2204 * to detach the old driver and reattach this new one.
2205 * Note, we don't have to check for DF_REBID here
2206 * because if the state is > DS_ALIVE, we know it must
2209 * This assumes that all DF_REBID drivers can have
2210 * their probe routine called at any time and that
2211 * they are idempotent as well as completely benign in
2212 * normal operations.
2214 * We also have to make sure that the detach
2215 * succeeded, otherwise we fail the operation (or
2216 * maybe it should just fail silently? I'm torn).
2218 if (child->state > DS_ALIVE && best->driver != child->driver)
2219 if ((result = device_detach(dev)) != 0)
2222 /* Set the winning driver, devclass, and flags. */
2223 if (!child->devclass) {
2224 result = device_set_devclass(child, best->driver->name);
2228 result = device_set_driver(child, best->driver);
2231 resource_int_value(best->driver->name, child->unit,
2232 "flags", &child->devflags);
2236 * A bit bogus. Call the probe method again to make
2237 * sure that we have the right description.
2239 DEVICE_PROBE(child);
2241 child->flags |= DF_REBID;
2244 child->flags &= ~DF_REBID;
2245 child->state = DS_ALIVE;
2247 bus_data_generation_update();
2255 * @brief Return the parent of a device
2258 device_get_parent(device_t dev)
2260 return (dev->parent);
2264 * @brief Get a list of children of a device
2266 * An array containing a list of all the children of the given device
2267 * is allocated and returned in @p *devlistp. The number of devices
2268 * in the array is returned in @p *devcountp. The caller should free
2269 * the array using @c free(p, M_TEMP).
2271 * @param dev the device to examine
2272 * @param devlistp points at location for array pointer return
2274 * @param devcountp points at location for array size return value
2277 * @retval ENOMEM the array allocation failed
2280 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2287 TAILQ_FOREACH(child, &dev->children, link) {
2296 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2301 TAILQ_FOREACH(child, &dev->children, link) {
2302 list[count] = child;
2313 * @brief Return the current driver for the device or @c NULL if there
2314 * is no driver currently attached
2317 device_get_driver(device_t dev)
2319 return (dev->driver);
2323 * @brief Return the current devclass for the device or @c NULL if
2327 device_get_devclass(device_t dev)
2329 return (dev->devclass);
2333 * @brief Return the name of the device's devclass or @c NULL if there
2337 device_get_name(device_t dev)
2339 if (dev != NULL && dev->devclass)
2340 return (devclass_get_name(dev->devclass));
2345 * @brief Return a string containing the device's devclass name
2346 * followed by an ascii representation of the device's unit number
2350 device_get_nameunit(device_t dev)
2352 return (dev->nameunit);
2356 * @brief Return the device's unit number.
2359 device_get_unit(device_t dev)
2365 * @brief Return the device's description string
2368 device_get_desc(device_t dev)
2374 * @brief Return the device's flags
2377 device_get_flags(device_t dev)
2379 return (dev->devflags);
2382 struct sysctl_ctx_list *
2383 device_get_sysctl_ctx(device_t dev)
2385 return (&dev->sysctl_ctx);
2389 device_get_sysctl_tree(device_t dev)
2391 return (dev->sysctl_tree);
2395 * @brief Print the name of the device followed by a colon and a space
2397 * @returns the number of characters printed
2400 device_print_prettyname(device_t dev)
2402 const char *name = device_get_name(dev);
2405 return (printf("unknown: "));
2406 return (printf("%s%d: ", name, device_get_unit(dev)));
2410 * @brief Print the name of the device followed by a colon, a space
2411 * and the result of calling vprintf() with the value of @p fmt and
2412 * the following arguments.
2414 * @returns the number of characters printed
2417 device_printf(device_t dev, const char * fmt, ...)
2422 retval = device_print_prettyname(dev);
2424 retval += vprintf(fmt, ap);
2433 device_set_desc_internal(device_t dev, const char* desc, int copy)
2435 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2436 free(dev->desc, M_BUS);
2437 dev->flags &= ~DF_DESCMALLOCED;
2442 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2444 strcpy(dev->desc, desc);
2445 dev->flags |= DF_DESCMALLOCED;
2448 /* Avoid a -Wcast-qual warning */
2449 dev->desc = (char *)(uintptr_t) desc;
2452 bus_data_generation_update();
2456 * @brief Set the device's description
2458 * The value of @c desc should be a string constant that will not
2459 * change (at least until the description is changed in a subsequent
2460 * call to device_set_desc() or device_set_desc_copy()).
2463 device_set_desc(device_t dev, const char* desc)
2465 device_set_desc_internal(dev, desc, FALSE);
2469 * @brief Set the device's description
2471 * The string pointed to by @c desc is copied. Use this function if
2472 * the device description is generated, (e.g. with sprintf()).
2475 device_set_desc_copy(device_t dev, const char* desc)
2477 device_set_desc_internal(dev, desc, TRUE);
2481 * @brief Set the device's flags
2484 device_set_flags(device_t dev, uint32_t flags)
2486 dev->devflags = flags;
2490 * @brief Return the device's softc field
2492 * The softc is allocated and zeroed when a driver is attached, based
2493 * on the size field of the driver.
2496 device_get_softc(device_t dev)
2498 return (dev->softc);
2502 * @brief Set the device's softc field
2504 * Most drivers do not need to use this since the softc is allocated
2505 * automatically when the driver is attached.
2508 device_set_softc(device_t dev, void *softc)
2510 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2511 free(dev->softc, M_BUS_SC);
2514 dev->flags |= DF_EXTERNALSOFTC;
2516 dev->flags &= ~DF_EXTERNALSOFTC;
2520 * @brief Free claimed softc
2522 * Most drivers do not need to use this since the softc is freed
2523 * automatically when the driver is detached.
2526 device_free_softc(void *softc)
2528 free(softc, M_BUS_SC);
2532 * @brief Claim softc
2534 * This function can be used to let the driver free the automatically
2535 * allocated softc using "device_free_softc()". This function is
2536 * useful when the driver is refcounting the softc and the softc
2537 * cannot be freed when the "device_detach" method is called.
2540 device_claim_softc(device_t dev)
2543 dev->flags |= DF_EXTERNALSOFTC;
2545 dev->flags &= ~DF_EXTERNALSOFTC;
2549 * @brief Get the device's ivars field
2551 * The ivars field is used by the parent device to store per-device
2552 * state (e.g. the physical location of the device or a list of
2556 device_get_ivars(device_t dev)
2559 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2560 return (dev->ivars);
2564 * @brief Set the device's ivars field
2567 device_set_ivars(device_t dev, void * ivars)
2570 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2575 * @brief Return the device's state
2578 device_get_state(device_t dev)
2580 return (dev->state);
2584 * @brief Set the DF_ENABLED flag for the device
2587 device_enable(device_t dev)
2589 dev->flags |= DF_ENABLED;
2593 * @brief Clear the DF_ENABLED flag for the device
2596 device_disable(device_t dev)
2598 dev->flags &= ~DF_ENABLED;
2602 * @brief Increment the busy counter for the device
2605 device_busy(device_t dev)
2607 if (dev->state < DS_ATTACHING)
2608 panic("device_busy: called for unattached device");
2609 if (dev->busy == 0 && dev->parent)
2610 device_busy(dev->parent);
2612 if (dev->state == DS_ATTACHED)
2613 dev->state = DS_BUSY;
2617 * @brief Decrement the busy counter for the device
2620 device_unbusy(device_t dev)
2622 if (dev->busy != 0 && dev->state != DS_BUSY &&
2623 dev->state != DS_ATTACHING)
2624 panic("device_unbusy: called for non-busy device %s",
2625 device_get_nameunit(dev));
2627 if (dev->busy == 0) {
2629 device_unbusy(dev->parent);
2630 if (dev->state == DS_BUSY)
2631 dev->state = DS_ATTACHED;
2636 * @brief Set the DF_QUIET flag for the device
2639 device_quiet(device_t dev)
2641 dev->flags |= DF_QUIET;
2645 * @brief Clear the DF_QUIET flag for the device
2648 device_verbose(device_t dev)
2650 dev->flags &= ~DF_QUIET;
2654 * @brief Return non-zero if the DF_QUIET flag is set on the device
2657 device_is_quiet(device_t dev)
2659 return ((dev->flags & DF_QUIET) != 0);
2663 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2666 device_is_enabled(device_t dev)
2668 return ((dev->flags & DF_ENABLED) != 0);
2672 * @brief Return non-zero if the device was successfully probed
2675 device_is_alive(device_t dev)
2677 return (dev->state >= DS_ALIVE);
2681 * @brief Return non-zero if the device currently has a driver
2685 device_is_attached(device_t dev)
2687 return (dev->state >= DS_ATTACHED);
2691 * @brief Return non-zero if the device is currently suspended.
2694 device_is_suspended(device_t dev)
2696 return ((dev->flags & DF_SUSPENDED) != 0);
2700 * @brief Set the devclass of a device
2701 * @see devclass_add_device().
2704 device_set_devclass(device_t dev, const char *classname)
2711 devclass_delete_device(dev->devclass, dev);
2715 if (dev->devclass) {
2716 printf("device_set_devclass: device class already set\n");
2720 dc = devclass_find_internal(classname, NULL, TRUE);
2724 error = devclass_add_device(dc, dev);
2726 bus_data_generation_update();
2731 * @brief Set the devclass of a device and mark the devclass fixed.
2732 * @see device_set_devclass()
2735 device_set_devclass_fixed(device_t dev, const char *classname)
2739 if (classname == NULL)
2742 error = device_set_devclass(dev, classname);
2745 dev->flags |= DF_FIXEDCLASS;
2750 * @brief Set the driver of a device
2753 * @retval EBUSY the device already has a driver attached
2754 * @retval ENOMEM a memory allocation failure occurred
2757 device_set_driver(device_t dev, driver_t *driver)
2759 if (dev->state >= DS_ATTACHED)
2762 if (dev->driver == driver)
2765 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2766 free(dev->softc, M_BUS_SC);
2769 device_set_desc(dev, NULL);
2770 kobj_delete((kobj_t) dev, NULL);
2771 dev->driver = driver;
2773 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2774 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2775 dev->softc = malloc(driver->size, M_BUS_SC,
2778 kobj_delete((kobj_t) dev, NULL);
2779 kobj_init((kobj_t) dev, &null_class);
2785 kobj_init((kobj_t) dev, &null_class);
2788 bus_data_generation_update();
2793 * @brief Probe a device, and return this status.
2795 * This function is the core of the device autoconfiguration
2796 * system. Its purpose is to select a suitable driver for a device and
2797 * then call that driver to initialise the hardware appropriately. The
2798 * driver is selected by calling the DEVICE_PROBE() method of a set of
2799 * candidate drivers and then choosing the driver which returned the
2800 * best value. This driver is then attached to the device using
2803 * The set of suitable drivers is taken from the list of drivers in
2804 * the parent device's devclass. If the device was originally created
2805 * with a specific class name (see device_add_child()), only drivers
2806 * with that name are probed, otherwise all drivers in the devclass
2807 * are probed. If no drivers return successful probe values in the
2808 * parent devclass, the search continues in the parent of that
2809 * devclass (see devclass_get_parent()) if any.
2811 * @param dev the device to initialise
2814 * @retval ENXIO no driver was found
2815 * @retval ENOMEM memory allocation failure
2816 * @retval non-zero some other unix error code
2817 * @retval -1 Device already attached
2820 device_probe(device_t dev)
2826 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2829 if (!(dev->flags & DF_ENABLED)) {
2830 if (bootverbose && device_get_name(dev) != NULL) {
2831 device_print_prettyname(dev);
2832 printf("not probed (disabled)\n");
2836 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2837 if (bus_current_pass == BUS_PASS_DEFAULT &&
2838 !(dev->flags & DF_DONENOMATCH)) {
2839 BUS_PROBE_NOMATCH(dev->parent, dev);
2841 dev->flags |= DF_DONENOMATCH;
2849 * @brief Probe a device and attach a driver if possible
2851 * calls device_probe() and attaches if that was successful.
2854 device_probe_and_attach(device_t dev)
2860 error = device_probe(dev);
2863 else if (error != 0)
2866 CURVNET_SET_QUIET(vnet0);
2867 error = device_attach(dev);
2873 * @brief Attach a device driver to a device
2875 * This function is a wrapper around the DEVICE_ATTACH() driver
2876 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2877 * device's sysctl tree, optionally prints a description of the device
2878 * and queues a notification event for user-based device management
2881 * Normally this function is only called internally from
2882 * device_probe_and_attach().
2884 * @param dev the device to initialise
2887 * @retval ENXIO no driver was found
2888 * @retval ENOMEM memory allocation failure
2889 * @retval non-zero some other unix error code
2892 device_attach(device_t dev)
2894 uint64_t attachtime;
2897 if (resource_disabled(dev->driver->name, dev->unit)) {
2898 device_disable(dev);
2900 device_printf(dev, "disabled via hints entry\n");
2904 device_sysctl_init(dev);
2905 if (!device_is_quiet(dev))
2906 device_print_child(dev->parent, dev);
2907 attachtime = get_cyclecount();
2908 dev->state = DS_ATTACHING;
2909 if ((error = DEVICE_ATTACH(dev)) != 0) {
2910 printf("device_attach: %s%d attach returned %d\n",
2911 dev->driver->name, dev->unit, error);
2912 if (!(dev->flags & DF_FIXEDCLASS))
2913 devclass_delete_device(dev->devclass, dev);
2914 (void)device_set_driver(dev, NULL);
2915 device_sysctl_fini(dev);
2916 KASSERT(dev->busy == 0, ("attach failed but busy"));
2917 dev->state = DS_NOTPRESENT;
2920 attachtime = get_cyclecount() - attachtime;
2922 * 4 bits per device is a reasonable value for desktop and server
2923 * hardware with good get_cyclecount() implementations, but WILL
2924 * need to be adjusted on other platforms.
2926 #define RANDOM_PROBE_BIT_GUESS 4
2928 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2929 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2930 dev->driver->name, dev->unit);
2931 random_harvest_direct(&attachtime, sizeof(attachtime),
2932 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2933 device_sysctl_update(dev);
2935 dev->state = DS_BUSY;
2937 dev->state = DS_ATTACHED;
2938 dev->flags &= ~DF_DONENOMATCH;
2939 EVENTHANDLER_INVOKE(device_attach, dev);
2945 * @brief Detach a driver from a device
2947 * This function is a wrapper around the DEVICE_DETACH() driver
2948 * method. If the call to DEVICE_DETACH() succeeds, it calls
2949 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2950 * notification event for user-based device management services and
2951 * cleans up the device's sysctl tree.
2953 * @param dev the device to un-initialise
2956 * @retval ENXIO no driver was found
2957 * @retval ENOMEM memory allocation failure
2958 * @retval non-zero some other unix error code
2961 device_detach(device_t dev)
2967 PDEBUG(("%s", DEVICENAME(dev)));
2968 if (dev->state == DS_BUSY)
2970 if (dev->state != DS_ATTACHED)
2973 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2974 if ((error = DEVICE_DETACH(dev)) != 0) {
2975 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_FAILED);
2978 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_COMPLETE);
2981 if (!device_is_quiet(dev))
2982 device_printf(dev, "detached\n");
2984 BUS_CHILD_DETACHED(dev->parent, dev);
2986 if (!(dev->flags & DF_FIXEDCLASS))
2987 devclass_delete_device(dev->devclass, dev);
2989 device_verbose(dev);
2990 dev->state = DS_NOTPRESENT;
2991 (void)device_set_driver(dev, NULL);
2992 device_sysctl_fini(dev);
2998 * @brief Tells a driver to quiesce itself.
3000 * This function is a wrapper around the DEVICE_QUIESCE() driver
3001 * method. If the call to DEVICE_QUIESCE() succeeds.
3003 * @param dev the device to quiesce
3006 * @retval ENXIO no driver was found
3007 * @retval ENOMEM memory allocation failure
3008 * @retval non-zero some other unix error code
3011 device_quiesce(device_t dev)
3014 PDEBUG(("%s", DEVICENAME(dev)));
3015 if (dev->state == DS_BUSY)
3017 if (dev->state != DS_ATTACHED)
3020 return (DEVICE_QUIESCE(dev));
3024 * @brief Notify a device of system shutdown
3026 * This function calls the DEVICE_SHUTDOWN() driver method if the
3027 * device currently has an attached driver.
3029 * @returns the value returned by DEVICE_SHUTDOWN()
3032 device_shutdown(device_t dev)
3034 if (dev->state < DS_ATTACHED)
3036 return (DEVICE_SHUTDOWN(dev));
3040 * @brief Set the unit number of a device
3042 * This function can be used to override the unit number used for a
3043 * device (e.g. to wire a device to a pre-configured unit number).
3046 device_set_unit(device_t dev, int unit)
3051 dc = device_get_devclass(dev);
3052 if (unit < dc->maxunit && dc->devices[unit])
3054 err = devclass_delete_device(dc, dev);
3058 err = devclass_add_device(dc, dev);
3062 bus_data_generation_update();
3066 /*======================================*/
3068 * Some useful method implementations to make life easier for bus drivers.
3072 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3077 args->memattr = VM_MEMATTR_UNCACHEABLE;
3081 * @brief Initialise a resource list.
3083 * @param rl the resource list to initialise
3086 resource_list_init(struct resource_list *rl)
3092 * @brief Reclaim memory used by a resource list.
3094 * This function frees the memory for all resource entries on the list
3097 * @param rl the resource list to free
3100 resource_list_free(struct resource_list *rl)
3102 struct resource_list_entry *rle;
3104 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3106 panic("resource_list_free: resource entry is busy");
3107 STAILQ_REMOVE_HEAD(rl, link);
3113 * @brief Add a resource entry.
3115 * This function adds a resource entry using the given @p type, @p
3116 * start, @p end and @p count values. A rid value is chosen by
3117 * searching sequentially for the first unused rid starting at zero.
3119 * @param rl the resource list to edit
3120 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3121 * @param start the start address of the resource
3122 * @param end the end address of the resource
3123 * @param count XXX end-start+1
3126 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3127 rman_res_t end, rman_res_t count)
3132 while (resource_list_find(rl, type, rid) != NULL)
3134 resource_list_add(rl, type, rid, start, end, count);
3139 * @brief Add or modify a resource entry.
3141 * If an existing entry exists with the same type and rid, it will be
3142 * modified using the given values of @p start, @p end and @p
3143 * count. If no entry exists, a new one will be created using the
3144 * given values. The resource list entry that matches is then returned.
3146 * @param rl the resource list to edit
3147 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3148 * @param rid the resource identifier
3149 * @param start the start address of the resource
3150 * @param end the end address of the resource
3151 * @param count XXX end-start+1
3153 struct resource_list_entry *
3154 resource_list_add(struct resource_list *rl, int type, int rid,
3155 rman_res_t start, rman_res_t end, rman_res_t count)
3157 struct resource_list_entry *rle;
3159 rle = resource_list_find(rl, type, rid);
3161 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3164 panic("resource_list_add: can't record entry");
3165 STAILQ_INSERT_TAIL(rl, rle, link);
3173 panic("resource_list_add: resource entry is busy");
3182 * @brief Determine if a resource entry is busy.
3184 * Returns true if a resource entry is busy meaning that it has an
3185 * associated resource that is not an unallocated "reserved" resource.
3187 * @param rl the resource list to search
3188 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3189 * @param rid the resource identifier
3191 * @returns Non-zero if the entry is busy, zero otherwise.
3194 resource_list_busy(struct resource_list *rl, int type, int rid)
3196 struct resource_list_entry *rle;
3198 rle = resource_list_find(rl, type, rid);
3199 if (rle == NULL || rle->res == NULL)
3201 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3202 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3203 ("reserved resource is active"));
3210 * @brief Determine if a resource entry is reserved.
3212 * Returns true if a resource entry is reserved meaning that it has an
3213 * associated "reserved" resource. The resource can either be
3214 * allocated or unallocated.
3216 * @param rl the resource list to search
3217 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3218 * @param rid the resource identifier
3220 * @returns Non-zero if the entry is reserved, zero otherwise.
3223 resource_list_reserved(struct resource_list *rl, int type, int rid)
3225 struct resource_list_entry *rle;
3227 rle = resource_list_find(rl, type, rid);
3228 if (rle != NULL && rle->flags & RLE_RESERVED)
3234 * @brief Find a resource entry by type and rid.
3236 * @param rl the resource list to search
3237 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3238 * @param rid the resource identifier
3240 * @returns the resource entry pointer or NULL if there is no such
3243 struct resource_list_entry *
3244 resource_list_find(struct resource_list *rl, int type, int rid)
3246 struct resource_list_entry *rle;
3248 STAILQ_FOREACH(rle, rl, link) {
3249 if (rle->type == type && rle->rid == rid)
3256 * @brief Delete a resource entry.
3258 * @param rl the resource list to edit
3259 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3260 * @param rid the resource identifier
3263 resource_list_delete(struct resource_list *rl, int type, int rid)
3265 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3268 if (rle->res != NULL)
3269 panic("resource_list_delete: resource has not been released");
3270 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3276 * @brief Allocate a reserved resource
3278 * This can be used by buses to force the allocation of resources
3279 * that are always active in the system even if they are not allocated
3280 * by a driver (e.g. PCI BARs). This function is usually called when
3281 * adding a new child to the bus. The resource is allocated from the
3282 * parent bus when it is reserved. The resource list entry is marked
3283 * with RLE_RESERVED to note that it is a reserved resource.
3285 * Subsequent attempts to allocate the resource with
3286 * resource_list_alloc() will succeed the first time and will set
3287 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3288 * resource that has been allocated is released with
3289 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3290 * the actual resource remains allocated. The resource can be released to
3291 * the parent bus by calling resource_list_unreserve().
3293 * @param rl the resource list to allocate from
3294 * @param bus the parent device of @p child
3295 * @param child the device for which the resource is being reserved
3296 * @param type the type of resource to allocate
3297 * @param rid a pointer to the resource identifier
3298 * @param start hint at the start of the resource range - pass
3299 * @c 0 for any start address
3300 * @param end hint at the end of the resource range - pass
3301 * @c ~0 for any end address
3302 * @param count hint at the size of range required - pass @c 1
3304 * @param flags any extra flags to control the resource
3305 * allocation - see @c RF_XXX flags in
3306 * <sys/rman.h> for details
3308 * @returns the resource which was allocated or @c NULL if no
3309 * resource could be allocated
3312 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3313 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3315 struct resource_list_entry *rle = NULL;
3316 int passthrough = (device_get_parent(child) != bus);
3321 "resource_list_reserve() should only be called for direct children");
3322 if (flags & RF_ACTIVE)
3324 "resource_list_reserve() should only reserve inactive resources");
3326 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3329 rle = resource_list_find(rl, type, *rid);
3330 rle->flags |= RLE_RESERVED;
3336 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3338 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3339 * and passing the allocation up to the parent of @p bus. This assumes
3340 * that the first entry of @c device_get_ivars(child) is a struct
3341 * resource_list. This also handles 'passthrough' allocations where a
3342 * child is a remote descendant of bus by passing the allocation up to
3343 * the parent of bus.
3345 * Typically, a bus driver would store a list of child resources
3346 * somewhere in the child device's ivars (see device_get_ivars()) and
3347 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3348 * then call resource_list_alloc() to perform the allocation.
3350 * @param rl the resource list to allocate from
3351 * @param bus the parent device of @p child
3352 * @param child the device which is requesting an allocation
3353 * @param type the type of resource to allocate
3354 * @param rid a pointer to the resource identifier
3355 * @param start hint at the start of the resource range - pass
3356 * @c 0 for any start address
3357 * @param end hint at the end of the resource range - pass
3358 * @c ~0 for any end address
3359 * @param count hint at the size of range required - pass @c 1
3361 * @param flags any extra flags to control the resource
3362 * allocation - see @c RF_XXX flags in
3363 * <sys/rman.h> for details
3365 * @returns the resource which was allocated or @c NULL if no
3366 * resource could be allocated
3369 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3370 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3372 struct resource_list_entry *rle = NULL;
3373 int passthrough = (device_get_parent(child) != bus);
3374 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3377 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3378 type, rid, start, end, count, flags));
3381 rle = resource_list_find(rl, type, *rid);
3384 return (NULL); /* no resource of that type/rid */
3387 if (rle->flags & RLE_RESERVED) {
3388 if (rle->flags & RLE_ALLOCATED)
3390 if ((flags & RF_ACTIVE) &&
3391 bus_activate_resource(child, type, *rid,
3394 rle->flags |= RLE_ALLOCATED;
3398 "resource entry %#x type %d for child %s is busy\n", *rid,
3399 type, device_get_nameunit(child));
3405 count = ulmax(count, rle->count);
3406 end = ulmax(rle->end, start + count - 1);
3409 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3410 type, rid, start, end, count, flags);
3413 * Record the new range.
3416 rle->start = rman_get_start(rle->res);
3417 rle->end = rman_get_end(rle->res);
3425 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3427 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3428 * used with resource_list_alloc().
3430 * @param rl the resource list which was allocated from
3431 * @param bus the parent device of @p child
3432 * @param child the device which is requesting a release
3433 * @param type the type of resource to release
3434 * @param rid the resource identifier
3435 * @param res the resource to release
3438 * @retval non-zero a standard unix error code indicating what
3439 * error condition prevented the operation
3442 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3443 int type, int rid, struct resource *res)
3445 struct resource_list_entry *rle = NULL;
3446 int passthrough = (device_get_parent(child) != bus);
3450 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3454 rle = resource_list_find(rl, type, rid);
3457 panic("resource_list_release: can't find resource");
3459 panic("resource_list_release: resource entry is not busy");
3460 if (rle->flags & RLE_RESERVED) {
3461 if (rle->flags & RLE_ALLOCATED) {
3462 if (rman_get_flags(res) & RF_ACTIVE) {
3463 error = bus_deactivate_resource(child, type,
3468 rle->flags &= ~RLE_ALLOCATED;
3474 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3484 * @brief Release all active resources of a given type
3486 * Release all active resources of a specified type. This is intended
3487 * to be used to cleanup resources leaked by a driver after detach or
3490 * @param rl the resource list which was allocated from
3491 * @param bus the parent device of @p child
3492 * @param child the device whose active resources are being released
3493 * @param type the type of resources to release
3496 * @retval EBUSY at least one resource was active
3499 resource_list_release_active(struct resource_list *rl, device_t bus,
3500 device_t child, int type)
3502 struct resource_list_entry *rle;
3506 STAILQ_FOREACH(rle, rl, link) {
3507 if (rle->type != type)
3509 if (rle->res == NULL)
3511 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3515 error = resource_list_release(rl, bus, child, type,
3516 rman_get_rid(rle->res), rle->res);
3519 "Failed to release active resource: %d\n", error);
3526 * @brief Fully release a reserved resource
3528 * Fully releases a resource reserved via resource_list_reserve().
3530 * @param rl the resource list which was allocated from
3531 * @param bus the parent device of @p child
3532 * @param child the device whose reserved resource is being released
3533 * @param type the type of resource to release
3534 * @param rid the resource identifier
3535 * @param res the resource to release
3538 * @retval non-zero a standard unix error code indicating what
3539 * error condition prevented the operation
3542 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3545 struct resource_list_entry *rle = NULL;
3546 int passthrough = (device_get_parent(child) != bus);
3550 "resource_list_unreserve() should only be called for direct children");
3552 rle = resource_list_find(rl, type, rid);
3555 panic("resource_list_unreserve: can't find resource");
3556 if (!(rle->flags & RLE_RESERVED))
3558 if (rle->flags & RLE_ALLOCATED)
3560 rle->flags &= ~RLE_RESERVED;
3561 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3565 * @brief Print a description of resources in a resource list
3567 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3568 * The name is printed if at least one resource of the given type is available.
3569 * The format is used to print resource start and end.
3571 * @param rl the resource list to print
3572 * @param name the name of @p type, e.g. @c "memory"
3573 * @param type type type of resource entry to print
3574 * @param format printf(9) format string to print resource
3575 * start and end values
3577 * @returns the number of characters printed
3580 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3583 struct resource_list_entry *rle;
3584 int printed, retval;
3588 /* Yes, this is kinda cheating */
3589 STAILQ_FOREACH(rle, rl, link) {
3590 if (rle->type == type) {
3592 retval += printf(" %s ", name);
3594 retval += printf(",");
3596 retval += printf(format, rle->start);
3597 if (rle->count > 1) {
3598 retval += printf("-");
3599 retval += printf(format, rle->start +
3608 * @brief Releases all the resources in a list.
3610 * @param rl The resource list to purge.
3615 resource_list_purge(struct resource_list *rl)
3617 struct resource_list_entry *rle;
3619 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3621 bus_release_resource(rman_get_device(rle->res),
3622 rle->type, rle->rid, rle->res);
3623 STAILQ_REMOVE_HEAD(rl, link);
3629 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3632 return (device_add_child_ordered(dev, order, name, unit));
3636 * @brief Helper function for implementing DEVICE_PROBE()
3638 * This function can be used to help implement the DEVICE_PROBE() for
3639 * a bus (i.e. a device which has other devices attached to it). It
3640 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3644 bus_generic_probe(device_t dev)
3646 devclass_t dc = dev->devclass;
3649 TAILQ_FOREACH(dl, &dc->drivers, link) {
3651 * If this driver's pass is too high, then ignore it.
3652 * For most drivers in the default pass, this will
3653 * never be true. For early-pass drivers they will
3654 * only call the identify routines of eligible drivers
3655 * when this routine is called. Drivers for later
3656 * passes should have their identify routines called
3657 * on early-pass buses during BUS_NEW_PASS().
3659 if (dl->pass > bus_current_pass)
3661 DEVICE_IDENTIFY(dl->driver, dev);
3668 * @brief Helper function for implementing DEVICE_ATTACH()
3670 * This function can be used to help implement the DEVICE_ATTACH() for
3671 * a bus. It calls device_probe_and_attach() for each of the device's
3675 bus_generic_attach(device_t dev)
3679 TAILQ_FOREACH(child, &dev->children, link) {
3680 device_probe_and_attach(child);
3687 * @brief Helper function for implementing DEVICE_DETACH()
3689 * This function can be used to help implement the DEVICE_DETACH() for
3690 * a bus. It calls device_detach() for each of the device's
3694 bus_generic_detach(device_t dev)
3699 if (dev->state != DS_ATTACHED)
3702 TAILQ_FOREACH(child, &dev->children, link) {
3703 if ((error = device_detach(child)) != 0)
3711 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3713 * This function can be used to help implement the DEVICE_SHUTDOWN()
3714 * for a bus. It calls device_shutdown() for each of the device's
3718 bus_generic_shutdown(device_t dev)
3722 TAILQ_FOREACH(child, &dev->children, link) {
3723 device_shutdown(child);
3730 * @brief Default function for suspending a child device.
3732 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3735 bus_generic_suspend_child(device_t dev, device_t child)
3739 error = DEVICE_SUSPEND(child);
3742 child->flags |= DF_SUSPENDED;
3748 * @brief Default function for resuming a child device.
3750 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3753 bus_generic_resume_child(device_t dev, device_t child)
3756 DEVICE_RESUME(child);
3757 child->flags &= ~DF_SUSPENDED;
3763 * @brief Helper function for implementing DEVICE_SUSPEND()
3765 * This function can be used to help implement the DEVICE_SUSPEND()
3766 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3767 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3768 * operation is aborted and any devices which were suspended are
3769 * resumed immediately by calling their DEVICE_RESUME() methods.
3772 bus_generic_suspend(device_t dev)
3775 device_t child, child2;
3777 TAILQ_FOREACH(child, &dev->children, link) {
3778 error = BUS_SUSPEND_CHILD(dev, child);
3780 for (child2 = TAILQ_FIRST(&dev->children);
3781 child2 && child2 != child;
3782 child2 = TAILQ_NEXT(child2, link))
3783 BUS_RESUME_CHILD(dev, child2);
3791 * @brief Helper function for implementing DEVICE_RESUME()
3793 * This function can be used to help implement the DEVICE_RESUME() for
3794 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3797 bus_generic_resume(device_t dev)
3801 TAILQ_FOREACH(child, &dev->children, link) {
3802 BUS_RESUME_CHILD(dev, child);
3803 /* if resume fails, there's nothing we can usefully do... */
3809 * @brief Helper function for implementing BUS_PRINT_CHILD().
3811 * This function prints the first part of the ascii representation of
3812 * @p child, including its name, unit and description (if any - see
3813 * device_set_desc()).
3815 * @returns the number of characters printed
3818 bus_print_child_header(device_t dev, device_t child)
3822 if (device_get_desc(child)) {
3823 retval += device_printf(child, "<%s>", device_get_desc(child));
3825 retval += printf("%s", device_get_nameunit(child));
3832 * @brief Helper function for implementing BUS_PRINT_CHILD().
3834 * This function prints the last part of the ascii representation of
3835 * @p child, which consists of the string @c " on " followed by the
3836 * name and unit of the @p dev.
3838 * @returns the number of characters printed
3841 bus_print_child_footer(device_t dev, device_t child)
3843 return (printf(" on %s\n", device_get_nameunit(dev)));
3847 * @brief Helper function for implementing BUS_PRINT_CHILD().
3849 * This function prints out the VM domain for the given device.
3851 * @returns the number of characters printed
3854 bus_print_child_domain(device_t dev, device_t child)
3858 /* No domain? Don't print anything */
3859 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3862 return (printf(" numa-domain %d", domain));
3866 * @brief Helper function for implementing BUS_PRINT_CHILD().
3868 * This function simply calls bus_print_child_header() followed by
3869 * bus_print_child_footer().
3871 * @returns the number of characters printed
3874 bus_generic_print_child(device_t dev, device_t child)
3878 retval += bus_print_child_header(dev, child);
3879 retval += bus_print_child_domain(dev, child);
3880 retval += bus_print_child_footer(dev, child);
3886 * @brief Stub function for implementing BUS_READ_IVAR().
3891 bus_generic_read_ivar(device_t dev, device_t child, int index,
3898 * @brief Stub function for implementing BUS_WRITE_IVAR().
3903 bus_generic_write_ivar(device_t dev, device_t child, int index,
3910 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3914 struct resource_list *
3915 bus_generic_get_resource_list(device_t dev, device_t child)
3921 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3923 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3924 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3925 * and then calls device_probe_and_attach() for each unattached child.
3928 bus_generic_driver_added(device_t dev, driver_t *driver)
3932 DEVICE_IDENTIFY(driver, dev);
3933 TAILQ_FOREACH(child, &dev->children, link) {
3934 if (child->state == DS_NOTPRESENT ||
3935 (child->flags & DF_REBID))
3936 device_probe_and_attach(child);
3941 * @brief Helper function for implementing BUS_NEW_PASS().
3943 * This implementing of BUS_NEW_PASS() first calls the identify
3944 * routines for any drivers that probe at the current pass. Then it
3945 * walks the list of devices for this bus. If a device is already
3946 * attached, then it calls BUS_NEW_PASS() on that device. If the
3947 * device is not already attached, it attempts to attach a driver to
3951 bus_generic_new_pass(device_t dev)
3958 TAILQ_FOREACH(dl, &dc->drivers, link) {
3959 if (dl->pass == bus_current_pass)
3960 DEVICE_IDENTIFY(dl->driver, dev);
3962 TAILQ_FOREACH(child, &dev->children, link) {
3963 if (child->state >= DS_ATTACHED)
3964 BUS_NEW_PASS(child);
3965 else if (child->state == DS_NOTPRESENT)
3966 device_probe_and_attach(child);
3971 * @brief Helper function for implementing BUS_SETUP_INTR().
3973 * This simple implementation of BUS_SETUP_INTR() simply calls the
3974 * BUS_SETUP_INTR() method of the parent of @p dev.
3977 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3978 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3981 /* Propagate up the bus hierarchy until someone handles it. */
3983 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3984 filter, intr, arg, cookiep));
3989 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3991 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3992 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3995 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3998 /* Propagate up the bus hierarchy until someone handles it. */
4000 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4005 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4007 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4008 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4011 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4012 struct resource *r, rman_res_t start, rman_res_t end)
4014 /* Propagate up the bus hierarchy until someone handles it. */
4016 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4022 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4024 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4025 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4028 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4029 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4031 /* Propagate up the bus hierarchy until someone handles it. */
4033 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4034 start, end, count, flags));
4039 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4041 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4042 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4045 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4048 /* Propagate up the bus hierarchy until someone handles it. */
4050 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4056 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4058 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4059 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4062 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4065 /* Propagate up the bus hierarchy until someone handles it. */
4067 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4073 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4075 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4076 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4079 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4080 int rid, struct resource *r)
4082 /* Propagate up the bus hierarchy until someone handles it. */
4084 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4090 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4092 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4093 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4096 bus_generic_map_resource(device_t dev, device_t child, int type,
4097 struct resource *r, struct resource_map_request *args,
4098 struct resource_map *map)
4100 /* Propagate up the bus hierarchy until someone handles it. */
4102 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4108 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4110 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4111 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4114 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4115 struct resource *r, struct resource_map *map)
4117 /* Propagate up the bus hierarchy until someone handles it. */
4119 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4124 * @brief Helper function for implementing BUS_BIND_INTR().
4126 * This simple implementation of BUS_BIND_INTR() simply calls the
4127 * BUS_BIND_INTR() method of the parent of @p dev.
4130 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4134 /* Propagate up the bus hierarchy until someone handles it. */
4136 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4141 * @brief Helper function for implementing BUS_CONFIG_INTR().
4143 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4144 * BUS_CONFIG_INTR() method of the parent of @p dev.
4147 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4148 enum intr_polarity pol)
4151 /* Propagate up the bus hierarchy until someone handles it. */
4153 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4158 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4160 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4161 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4164 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4165 void *cookie, const char *descr)
4168 /* Propagate up the bus hierarchy until someone handles it. */
4170 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4176 * @brief Helper function for implementing BUS_GET_CPUS().
4178 * This simple implementation of BUS_GET_CPUS() simply calls the
4179 * BUS_GET_CPUS() method of the parent of @p dev.
4182 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4183 size_t setsize, cpuset_t *cpuset)
4186 /* Propagate up the bus hierarchy until someone handles it. */
4187 if (dev->parent != NULL)
4188 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4193 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4195 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4196 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4199 bus_generic_get_dma_tag(device_t dev, device_t child)
4202 /* Propagate up the bus hierarchy until someone handles it. */
4203 if (dev->parent != NULL)
4204 return (BUS_GET_DMA_TAG(dev->parent, child));
4209 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4211 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4212 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4215 bus_generic_get_bus_tag(device_t dev, device_t child)
4218 /* Propagate up the bus hierarchy until someone handles it. */
4219 if (dev->parent != NULL)
4220 return (BUS_GET_BUS_TAG(dev->parent, child));
4221 return ((bus_space_tag_t)0);
4225 * @brief Helper function for implementing BUS_GET_RESOURCE().
4227 * This implementation of BUS_GET_RESOURCE() uses the
4228 * resource_list_find() function to do most of the work. It calls
4229 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4233 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4234 rman_res_t *startp, rman_res_t *countp)
4236 struct resource_list * rl = NULL;
4237 struct resource_list_entry * rle = NULL;
4239 rl = BUS_GET_RESOURCE_LIST(dev, child);
4243 rle = resource_list_find(rl, type, rid);
4248 *startp = rle->start;
4250 *countp = rle->count;
4256 * @brief Helper function for implementing BUS_SET_RESOURCE().
4258 * This implementation of BUS_SET_RESOURCE() uses the
4259 * resource_list_add() function to do most of the work. It calls
4260 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4264 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4265 rman_res_t start, rman_res_t count)
4267 struct resource_list * rl = NULL;
4269 rl = BUS_GET_RESOURCE_LIST(dev, child);
4273 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4279 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4281 * This implementation of BUS_DELETE_RESOURCE() uses the
4282 * resource_list_delete() function to do most of the work. It calls
4283 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4287 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4289 struct resource_list * rl = NULL;
4291 rl = BUS_GET_RESOURCE_LIST(dev, child);
4295 resource_list_delete(rl, type, rid);
4301 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4303 * This implementation of BUS_RELEASE_RESOURCE() uses the
4304 * resource_list_release() function to do most of the work. It calls
4305 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4308 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4309 int rid, struct resource *r)
4311 struct resource_list * rl = NULL;
4313 if (device_get_parent(child) != dev)
4314 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4317 rl = BUS_GET_RESOURCE_LIST(dev, child);
4321 return (resource_list_release(rl, dev, child, type, rid, r));
4325 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4327 * This implementation of BUS_ALLOC_RESOURCE() uses the
4328 * resource_list_alloc() function to do most of the work. It calls
4329 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4332 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4333 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4335 struct resource_list * rl = NULL;
4337 if (device_get_parent(child) != dev)
4338 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4339 type, rid, start, end, count, flags));
4341 rl = BUS_GET_RESOURCE_LIST(dev, child);
4345 return (resource_list_alloc(rl, dev, child, type, rid,
4346 start, end, count, flags));
4350 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4352 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4353 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4356 bus_generic_child_present(device_t dev, device_t child)
4358 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4362 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4366 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4372 * @brief Helper function for implementing BUS_RESCAN().
4374 * This null implementation of BUS_RESCAN() always fails to indicate
4375 * the bus does not support rescanning.
4378 bus_null_rescan(device_t dev)
4385 * Some convenience functions to make it easier for drivers to use the
4386 * resource-management functions. All these really do is hide the
4387 * indirection through the parent's method table, making for slightly
4388 * less-wordy code. In the future, it might make sense for this code
4389 * to maintain some sort of a list of resources allocated by each device.
4393 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4394 struct resource **res)
4398 for (i = 0; rs[i].type != -1; i++)
4400 for (i = 0; rs[i].type != -1; i++) {
4401 res[i] = bus_alloc_resource_any(dev,
4402 rs[i].type, &rs[i].rid, rs[i].flags);
4403 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4404 bus_release_resources(dev, rs, res);
4412 bus_release_resources(device_t dev, const struct resource_spec *rs,
4413 struct resource **res)
4417 for (i = 0; rs[i].type != -1; i++)
4418 if (res[i] != NULL) {
4419 bus_release_resource(
4420 dev, rs[i].type, rs[i].rid, res[i]);
4426 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4428 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4432 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4433 rman_res_t end, rman_res_t count, u_int flags)
4435 struct resource *res;
4437 if (dev->parent == NULL)
4439 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4445 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4447 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4451 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4454 if (dev->parent == NULL)
4456 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4460 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4462 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4466 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4468 if (dev->parent == NULL)
4470 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4474 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4476 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4480 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4482 if (dev->parent == NULL)
4484 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4488 * @brief Wrapper function for BUS_MAP_RESOURCE().
4490 * This function simply calls the BUS_MAP_RESOURCE() method of the
4494 bus_map_resource(device_t dev, int type, struct resource *r,
4495 struct resource_map_request *args, struct resource_map *map)
4497 if (dev->parent == NULL)
4499 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4503 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4505 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4509 bus_unmap_resource(device_t dev, int type, struct resource *r,
4510 struct resource_map *map)
4512 if (dev->parent == NULL)
4514 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4518 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4520 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4524 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4528 if (dev->parent == NULL)
4530 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4535 * @brief Wrapper function for BUS_SETUP_INTR().
4537 * This function simply calls the BUS_SETUP_INTR() method of the
4541 bus_setup_intr(device_t dev, struct resource *r, int flags,
4542 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4546 if (dev->parent == NULL)
4548 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4552 if (handler != NULL && !(flags & INTR_MPSAFE))
4553 device_printf(dev, "[GIANT-LOCKED]\n");
4558 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4560 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4564 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4566 if (dev->parent == NULL)
4568 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4572 * @brief Wrapper function for BUS_BIND_INTR().
4574 * This function simply calls the BUS_BIND_INTR() method of the
4578 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4580 if (dev->parent == NULL)
4582 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4586 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4588 * This function first formats the requested description into a
4589 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4590 * the parent of @p dev.
4593 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4594 const char *fmt, ...)
4597 char descr[MAXCOMLEN + 1];
4599 if (dev->parent == NULL)
4602 vsnprintf(descr, sizeof(descr), fmt, ap);
4604 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4608 * @brief Wrapper function for BUS_SET_RESOURCE().
4610 * This function simply calls the BUS_SET_RESOURCE() method of the
4614 bus_set_resource(device_t dev, int type, int rid,
4615 rman_res_t start, rman_res_t count)
4617 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4622 * @brief Wrapper function for BUS_GET_RESOURCE().
4624 * This function simply calls the BUS_GET_RESOURCE() method of the
4628 bus_get_resource(device_t dev, int type, int rid,
4629 rman_res_t *startp, rman_res_t *countp)
4631 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4636 * @brief Wrapper function for BUS_GET_RESOURCE().
4638 * This function simply calls the BUS_GET_RESOURCE() method of the
4639 * parent of @p dev and returns the start value.
4642 bus_get_resource_start(device_t dev, int type, int rid)
4648 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4656 * @brief Wrapper function for BUS_GET_RESOURCE().
4658 * This function simply calls the BUS_GET_RESOURCE() method of the
4659 * parent of @p dev and returns the count value.
4662 bus_get_resource_count(device_t dev, int type, int rid)
4668 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4676 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4678 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4682 bus_delete_resource(device_t dev, int type, int rid)
4684 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4688 * @brief Wrapper function for BUS_CHILD_PRESENT().
4690 * This function simply calls the BUS_CHILD_PRESENT() method of the
4694 bus_child_present(device_t child)
4696 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4700 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4702 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4706 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4710 parent = device_get_parent(child);
4711 if (parent == NULL) {
4715 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4719 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4721 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4725 bus_child_location_str(device_t child, char *buf, size_t buflen)
4729 parent = device_get_parent(child);
4730 if (parent == NULL) {
4734 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4738 * @brief Wrapper function for BUS_GET_CPUS().
4740 * This function simply calls the BUS_GET_CPUS() method of the
4744 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4748 parent = device_get_parent(dev);
4751 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4755 * @brief Wrapper function for BUS_GET_DMA_TAG().
4757 * This function simply calls the BUS_GET_DMA_TAG() method of the
4761 bus_get_dma_tag(device_t dev)
4765 parent = device_get_parent(dev);
4768 return (BUS_GET_DMA_TAG(parent, dev));
4772 * @brief Wrapper function for BUS_GET_BUS_TAG().
4774 * This function simply calls the BUS_GET_BUS_TAG() method of the
4778 bus_get_bus_tag(device_t dev)
4782 parent = device_get_parent(dev);
4784 return ((bus_space_tag_t)0);
4785 return (BUS_GET_BUS_TAG(parent, dev));
4789 * @brief Wrapper function for BUS_GET_DOMAIN().
4791 * This function simply calls the BUS_GET_DOMAIN() method of the
4795 bus_get_domain(device_t dev, int *domain)
4797 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4800 /* Resume all devices and then notify userland that we're up again. */
4802 root_resume(device_t dev)
4806 error = bus_generic_resume(dev);
4808 devctl_notify("kern", "power", "resume", NULL);
4813 root_print_child(device_t dev, device_t child)
4817 retval += bus_print_child_header(dev, child);
4818 retval += printf("\n");
4824 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4825 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4828 * If an interrupt mapping gets to here something bad has happened.
4830 panic("root_setup_intr");
4834 * If we get here, assume that the device is permanent and really is
4835 * present in the system. Removable bus drivers are expected to intercept
4836 * this call long before it gets here. We return -1 so that drivers that
4837 * really care can check vs -1 or some ERRNO returned higher in the food
4841 root_child_present(device_t dev, device_t child)
4847 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4853 /* Default to returning the set of all CPUs. */
4854 if (setsize != sizeof(cpuset_t))
4863 static kobj_method_t root_methods[] = {
4864 /* Device interface */
4865 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4866 KOBJMETHOD(device_suspend, bus_generic_suspend),
4867 KOBJMETHOD(device_resume, root_resume),
4870 KOBJMETHOD(bus_print_child, root_print_child),
4871 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4872 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4873 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4874 KOBJMETHOD(bus_child_present, root_child_present),
4875 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4880 static driver_t root_driver = {
4887 devclass_t root_devclass;
4890 root_bus_module_handler(module_t mod, int what, void* arg)
4894 TAILQ_INIT(&bus_data_devices);
4895 kobj_class_compile((kobj_class_t) &root_driver);
4896 root_bus = make_device(NULL, "root", 0);
4897 root_bus->desc = "System root bus";
4898 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4899 root_bus->driver = &root_driver;
4900 root_bus->state = DS_ATTACHED;
4901 root_devclass = devclass_find_internal("root", NULL, FALSE);
4906 device_shutdown(root_bus);
4909 return (EOPNOTSUPP);
4915 static moduledata_t root_bus_mod = {
4917 root_bus_module_handler,
4920 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4923 * @brief Automatically configure devices
4925 * This function begins the autoconfiguration process by calling
4926 * device_probe_and_attach() for each child of the @c root0 device.
4929 root_bus_configure(void)
4934 /* Eventually this will be split up, but this is sufficient for now. */
4935 bus_set_pass(BUS_PASS_DEFAULT);
4939 * @brief Module handler for registering device drivers
4941 * This module handler is used to automatically register device
4942 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4943 * devclass_add_driver() for the driver described by the
4944 * driver_module_data structure pointed to by @p arg
4947 driver_module_handler(module_t mod, int what, void *arg)
4949 struct driver_module_data *dmd;
4950 devclass_t bus_devclass;
4951 kobj_class_t driver;
4954 dmd = (struct driver_module_data *)arg;
4955 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4960 if (dmd->dmd_chainevh)
4961 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4963 pass = dmd->dmd_pass;
4964 driver = dmd->dmd_driver;
4965 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4966 DRIVERNAME(driver), dmd->dmd_busname, pass));
4967 error = devclass_add_driver(bus_devclass, driver, pass,
4972 PDEBUG(("Unloading module: driver %s from bus %s",
4973 DRIVERNAME(dmd->dmd_driver),
4975 error = devclass_delete_driver(bus_devclass,
4978 if (!error && dmd->dmd_chainevh)
4979 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4982 PDEBUG(("Quiesce module: driver %s from bus %s",
4983 DRIVERNAME(dmd->dmd_driver),
4985 error = devclass_quiesce_driver(bus_devclass,
4988 if (!error && dmd->dmd_chainevh)
4989 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5000 * @brief Enumerate all hinted devices for this bus.
5002 * Walks through the hints for this bus and calls the bus_hinted_child
5003 * routine for each one it fines. It searches first for the specific
5004 * bus that's being probed for hinted children (eg isa0), and then for
5005 * generic children (eg isa).
5007 * @param dev bus device to enumerate
5010 bus_enumerate_hinted_children(device_t bus)
5013 const char *dname, *busname;
5017 * enumerate all devices on the specific bus
5019 busname = device_get_nameunit(bus);
5021 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5022 BUS_HINTED_CHILD(bus, dname, dunit);
5025 * and all the generic ones.
5027 busname = device_get_name(bus);
5029 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5030 BUS_HINTED_CHILD(bus, dname, dunit);
5035 /* the _short versions avoid iteration by not calling anything that prints
5036 * more than oneliners. I love oneliners.
5040 print_device_short(device_t dev, int indent)
5045 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5046 dev->unit, dev->desc,
5047 (dev->parent? "":"no "),
5048 (TAILQ_EMPTY(&dev->children)? "no ":""),
5049 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5050 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5051 (dev->flags&DF_WILDCARD? "wildcard,":""),
5052 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5053 (dev->flags&DF_REBID? "rebiddable,":""),
5054 (dev->ivars? "":"no "),
5055 (dev->softc? "":"no "),
5060 print_device(device_t dev, int indent)
5065 print_device_short(dev, indent);
5067 indentprintf(("Parent:\n"));
5068 print_device_short(dev->parent, indent+1);
5069 indentprintf(("Driver:\n"));
5070 print_driver_short(dev->driver, indent+1);
5071 indentprintf(("Devclass:\n"));
5072 print_devclass_short(dev->devclass, indent+1);
5076 print_device_tree_short(device_t dev, int indent)
5077 /* print the device and all its children (indented) */
5084 print_device_short(dev, indent);
5086 TAILQ_FOREACH(child, &dev->children, link) {
5087 print_device_tree_short(child, indent+1);
5092 print_device_tree(device_t dev, int indent)
5093 /* print the device and all its children (indented) */
5100 print_device(dev, indent);
5102 TAILQ_FOREACH(child, &dev->children, link) {
5103 print_device_tree(child, indent+1);
5108 print_driver_short(driver_t *driver, int indent)
5113 indentprintf(("driver %s: softc size = %zd\n",
5114 driver->name, driver->size));
5118 print_driver(driver_t *driver, int indent)
5123 print_driver_short(driver, indent);
5127 print_driver_list(driver_list_t drivers, int indent)
5129 driverlink_t driver;
5131 TAILQ_FOREACH(driver, &drivers, link) {
5132 print_driver(driver->driver, indent);
5137 print_devclass_short(devclass_t dc, int indent)
5142 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5146 print_devclass(devclass_t dc, int indent)
5153 print_devclass_short(dc, indent);
5154 indentprintf(("Drivers:\n"));
5155 print_driver_list(dc->drivers, indent+1);
5157 indentprintf(("Devices:\n"));
5158 for (i = 0; i < dc->maxunit; i++)
5160 print_device(dc->devices[i], indent+1);
5164 print_devclass_list_short(void)
5168 printf("Short listing of devclasses, drivers & devices:\n");
5169 TAILQ_FOREACH(dc, &devclasses, link) {
5170 print_devclass_short(dc, 0);
5175 print_devclass_list(void)
5179 printf("Full listing of devclasses, drivers & devices:\n");
5180 TAILQ_FOREACH(dc, &devclasses, link) {
5181 print_devclass(dc, 0);
5188 * User-space access to the device tree.
5190 * We implement a small set of nodes:
5192 * hw.bus Single integer read method to obtain the
5193 * current generation count.
5194 * hw.bus.devices Reads the entire device tree in flat space.
5195 * hw.bus.rman Resource manager interface
5197 * We might like to add the ability to scan devclasses and/or drivers to
5198 * determine what else is currently loaded/available.
5202 sysctl_bus(SYSCTL_HANDLER_ARGS)
5204 struct u_businfo ubus;
5206 ubus.ub_version = BUS_USER_VERSION;
5207 ubus.ub_generation = bus_data_generation;
5209 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5211 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5212 "bus-related data");
5215 sysctl_devices(SYSCTL_HANDLER_ARGS)
5217 int *name = (int *)arg1;
5218 u_int namelen = arg2;
5221 struct u_device udev; /* XXX this is a bit big */
5227 if (bus_data_generation_check(name[0]))
5233 * Scan the list of devices, looking for the requested index.
5235 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5243 * Populate the return array.
5245 bzero(&udev, sizeof(udev));
5246 udev.dv_handle = (uintptr_t)dev;
5247 udev.dv_parent = (uintptr_t)dev->parent;
5248 if (dev->nameunit != NULL)
5249 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
5250 if (dev->desc != NULL)
5251 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
5252 if (dev->driver != NULL && dev->driver->name != NULL)
5253 strlcpy(udev.dv_drivername, dev->driver->name,
5254 sizeof(udev.dv_drivername));
5255 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
5256 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
5257 udev.dv_devflags = dev->devflags;
5258 udev.dv_flags = dev->flags;
5259 udev.dv_state = dev->state;
5260 error = SYSCTL_OUT(req, &udev, sizeof(udev));
5264 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5265 "system device tree");
5268 bus_data_generation_check(int generation)
5270 if (generation != bus_data_generation)
5273 /* XXX generate optimised lists here? */
5278 bus_data_generation_update(void)
5280 bus_data_generation++;
5284 bus_free_resource(device_t dev, int type, struct resource *r)
5288 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5292 device_lookup_by_name(const char *name)
5296 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5297 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5304 * /dev/devctl2 implementation. The existing /dev/devctl device has
5305 * implicit semantics on open, so it could not be reused for this.
5306 * Another option would be to call this /dev/bus?
5309 find_device(struct devreq *req, device_t *devp)
5314 * First, ensure that the name is nul terminated.
5316 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5320 * Second, try to find an attached device whose name matches
5323 dev = device_lookup_by_name(req->dr_name);
5329 /* Finally, give device enumerators a chance. */
5331 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev);
5339 driver_exists(device_t bus, const char *driver)
5343 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5344 if (devclass_find_driver_internal(dc, driver) != NULL)
5351 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5358 /* Locate the device to control. */
5360 req = (struct devreq *)data;
5368 case DEV_SET_DRIVER:
5369 case DEV_CLEAR_DRIVER:
5372 error = priv_check(td, PRIV_DRIVER);
5374 error = find_device(req, &dev);
5385 /* Perform the requested operation. */
5388 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5390 else if (!device_is_enabled(dev))
5393 error = device_probe_and_attach(dev);
5396 if (!device_is_attached(dev)) {
5400 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5401 error = device_quiesce(dev);
5405 error = device_detach(dev);
5408 if (device_is_enabled(dev)) {
5414 * If the device has been probed but not attached (e.g.
5415 * when it has been disabled by a loader hint), just
5416 * attach the device rather than doing a full probe.
5419 if (device_is_alive(dev)) {
5421 * If the device was disabled via a hint, clear
5424 if (resource_disabled(dev->driver->name, dev->unit))
5425 resource_unset_value(dev->driver->name,
5426 dev->unit, "disabled");
5427 error = device_attach(dev);
5429 error = device_probe_and_attach(dev);
5432 if (!device_is_enabled(dev)) {
5437 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5438 error = device_quiesce(dev);
5444 * Force DF_FIXEDCLASS on around detach to preserve
5445 * the existing name.
5448 dev->flags |= DF_FIXEDCLASS;
5449 error = device_detach(dev);
5450 if (!(old & DF_FIXEDCLASS))
5451 dev->flags &= ~DF_FIXEDCLASS;
5453 device_disable(dev);
5456 if (device_is_suspended(dev)) {
5460 if (device_get_parent(dev) == NULL) {
5464 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5467 if (!device_is_suspended(dev)) {
5471 if (device_get_parent(dev) == NULL) {
5475 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5477 case DEV_SET_DRIVER: {
5481 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5484 if (driver[0] == '\0') {
5488 if (dev->devclass != NULL &&
5489 strcmp(driver, dev->devclass->name) == 0)
5490 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5494 * Scan drivers for this device's bus looking for at
5495 * least one matching driver.
5497 if (dev->parent == NULL) {
5501 if (!driver_exists(dev->parent, driver)) {
5505 dc = devclass_create(driver);
5511 /* Detach device if necessary. */
5512 if (device_is_attached(dev)) {
5513 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5514 error = device_detach(dev);
5521 /* Clear any previously-fixed device class and unit. */
5522 if (dev->flags & DF_FIXEDCLASS)
5523 devclass_delete_device(dev->devclass, dev);
5524 dev->flags |= DF_WILDCARD;
5527 /* Force the new device class. */
5528 error = devclass_add_device(dc, dev);
5531 dev->flags |= DF_FIXEDCLASS;
5532 error = device_probe_and_attach(dev);
5535 case DEV_CLEAR_DRIVER:
5536 if (!(dev->flags & DF_FIXEDCLASS)) {
5540 if (device_is_attached(dev)) {
5541 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5542 error = device_detach(dev);
5549 dev->flags &= ~DF_FIXEDCLASS;
5550 dev->flags |= DF_WILDCARD;
5551 devclass_delete_device(dev->devclass, dev);
5552 error = device_probe_and_attach(dev);
5555 if (!device_is_attached(dev)) {
5559 error = BUS_RESCAN(dev);
5564 parent = device_get_parent(dev);
5565 if (parent == NULL) {
5569 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5570 if (bus_child_present(dev) != 0) {
5576 error = device_delete_child(parent, dev);
5584 static struct cdevsw devctl2_cdevsw = {
5585 .d_version = D_VERSION,
5586 .d_ioctl = devctl2_ioctl,
5587 .d_name = "devctl2",
5594 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5595 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5599 DB_SHOW_COMMAND(device, db_show_device)
5606 dev = (device_t)addr;
5608 db_printf("name: %s\n", device_get_nameunit(dev));
5609 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5610 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5611 db_printf(" addr: %p\n", dev);
5612 db_printf(" parent: %p\n", dev->parent);
5613 db_printf(" softc: %p\n", dev->softc);
5614 db_printf(" ivars: %p\n", dev->ivars);
5617 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5621 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5622 db_show_device((db_expr_t)dev, true, count, modif);