2 * Copyright (c) 1997,1998,2003 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/filio.h>
36 #include <sys/kernel.h>
38 #include <sys/limits.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
45 #include <sys/condvar.h>
46 #include <sys/queue.h>
47 #include <machine/bus.h>
48 #include <sys/random.h>
50 #include <sys/selinfo.h>
51 #include <sys/signalvar.h>
53 #include <sys/sysctl.h>
54 #include <sys/systm.h>
57 #include <sys/interrupt.h>
58 #include <sys/cpuset.h>
62 #include <machine/cpu.h>
63 #include <machine/stdarg.h>
67 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
68 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
71 * Used to attach drivers to devclasses.
73 typedef struct driverlink *driverlink_t;
76 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
78 TAILQ_ENTRY(driverlink) passlink;
82 * Forward declarations
84 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
85 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
86 typedef TAILQ_HEAD(device_list, device) device_list_t;
89 TAILQ_ENTRY(devclass) link;
90 devclass_t parent; /* parent in devclass hierarchy */
91 driver_list_t drivers; /* bus devclasses store drivers for bus */
93 device_t *devices; /* array of devices indexed by unit */
94 int maxunit; /* size of devices array */
96 #define DC_HAS_CHILDREN 1
98 struct sysctl_ctx_list sysctl_ctx;
99 struct sysctl_oid *sysctl_tree;
103 * @brief Implementation of device.
107 * A device is a kernel object. The first field must be the
108 * current ops table for the object.
115 TAILQ_ENTRY(device) link; /**< list of devices in parent */
116 TAILQ_ENTRY(device) devlink; /**< global device list membership */
117 device_t parent; /**< parent of this device */
118 device_list_t children; /**< list of child devices */
121 * Details of this device.
123 driver_t *driver; /**< current driver */
124 devclass_t devclass; /**< current device class */
125 int unit; /**< current unit number */
126 char* nameunit; /**< name+unit e.g. foodev0 */
127 char* desc; /**< driver specific description */
128 int busy; /**< count of calls to device_busy() */
129 device_state_t state; /**< current device state */
130 uint32_t devflags; /**< api level flags for device_get_flags() */
131 u_int flags; /**< internal device flags */
132 u_int order; /**< order from device_add_child_ordered() */
133 void *ivars; /**< instance variables */
134 void *softc; /**< current driver's variables */
136 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
137 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
140 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
141 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
143 static void devctl2_init(void);
147 static int bus_debug = 1;
148 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
151 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
152 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
153 #define DRIVERNAME(d) ((d)? d->name : "no driver")
154 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
157 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
158 * prevent syslog from deleting initial spaces
160 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
162 static void print_device_short(device_t dev, int indent);
163 static void print_device(device_t dev, int indent);
164 void print_device_tree_short(device_t dev, int indent);
165 void print_device_tree(device_t dev, int indent);
166 static void print_driver_short(driver_t *driver, int indent);
167 static void print_driver(driver_t *driver, int indent);
168 static void print_driver_list(driver_list_t drivers, int indent);
169 static void print_devclass_short(devclass_t dc, int indent);
170 static void print_devclass(devclass_t dc, int indent);
171 void print_devclass_list_short(void);
172 void print_devclass_list(void);
175 /* Make the compiler ignore the function calls */
176 #define PDEBUG(a) /* nop */
177 #define DEVICENAME(d) /* nop */
178 #define DRIVERNAME(d) /* nop */
179 #define DEVCLANAME(d) /* nop */
181 #define print_device_short(d,i) /* nop */
182 #define print_device(d,i) /* nop */
183 #define print_device_tree_short(d,i) /* nop */
184 #define print_device_tree(d,i) /* nop */
185 #define print_driver_short(d,i) /* nop */
186 #define print_driver(d,i) /* nop */
187 #define print_driver_list(d,i) /* nop */
188 #define print_devclass_short(d,i) /* nop */
189 #define print_devclass(d,i) /* nop */
190 #define print_devclass_list_short() /* nop */
191 #define print_devclass_list() /* nop */
199 DEVCLASS_SYSCTL_PARENT,
203 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
205 devclass_t dc = (devclass_t)arg1;
209 case DEVCLASS_SYSCTL_PARENT:
210 value = dc->parent ? dc->parent->name : "";
215 return (SYSCTL_OUT_STR(req, value));
219 devclass_sysctl_init(devclass_t dc)
222 if (dc->sysctl_tree != NULL)
224 sysctl_ctx_init(&dc->sysctl_ctx);
225 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
226 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
227 CTLFLAG_RD, NULL, "");
228 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
229 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
230 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
236 DEVICE_SYSCTL_DRIVER,
237 DEVICE_SYSCTL_LOCATION,
238 DEVICE_SYSCTL_PNPINFO,
239 DEVICE_SYSCTL_PARENT,
243 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
245 device_t dev = (device_t)arg1;
252 case DEVICE_SYSCTL_DESC:
253 value = dev->desc ? dev->desc : "";
255 case DEVICE_SYSCTL_DRIVER:
256 value = dev->driver ? dev->driver->name : "";
258 case DEVICE_SYSCTL_LOCATION:
259 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
260 bus_child_location_str(dev, buf, 1024);
262 case DEVICE_SYSCTL_PNPINFO:
263 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
264 bus_child_pnpinfo_str(dev, buf, 1024);
266 case DEVICE_SYSCTL_PARENT:
267 value = dev->parent ? dev->parent->nameunit : "";
272 error = SYSCTL_OUT_STR(req, value);
279 device_sysctl_init(device_t dev)
281 devclass_t dc = dev->devclass;
284 if (dev->sysctl_tree != NULL)
286 devclass_sysctl_init(dc);
287 sysctl_ctx_init(&dev->sysctl_ctx);
288 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx,
289 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
290 dev->nameunit + strlen(dc->name),
291 CTLFLAG_RD, NULL, "");
292 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
293 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
294 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
295 "device description");
296 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
297 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
298 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
299 "device driver name");
300 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
301 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
302 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
303 "device location relative to parent");
304 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
305 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
306 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
307 "device identification");
308 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
309 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
310 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
312 if (bus_get_domain(dev, &domain) == 0)
313 SYSCTL_ADD_INT(&dev->sysctl_ctx,
314 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
315 CTLFLAG_RD, NULL, domain, "NUMA domain");
319 device_sysctl_update(device_t dev)
321 devclass_t dc = dev->devclass;
323 if (dev->sysctl_tree == NULL)
325 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
329 device_sysctl_fini(device_t dev)
331 if (dev->sysctl_tree == NULL)
333 sysctl_ctx_free(&dev->sysctl_ctx);
334 dev->sysctl_tree = NULL;
338 * /dev/devctl implementation
342 * This design allows only one reader for /dev/devctl. This is not desirable
343 * in the long run, but will get a lot of hair out of this implementation.
344 * Maybe we should make this device a clonable device.
346 * Also note: we specifically do not attach a device to the device_t tree
347 * to avoid potential chicken and egg problems. One could argue that all
348 * of this belongs to the root node. One could also further argue that the
349 * sysctl interface that we have not might more properly be an ioctl
350 * interface, but at this stage of the game, I'm not inclined to rock that
353 * I'm also not sure that the SIGIO support is done correctly or not, as
354 * I copied it from a driver that had SIGIO support that likely hasn't been
355 * tested since 3.4 or 2.2.8!
358 /* Deprecated way to adjust queue length */
359 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
360 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
361 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
362 "devctl disable -- deprecated");
364 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
365 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
366 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
367 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
368 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
370 static d_open_t devopen;
371 static d_close_t devclose;
372 static d_read_t devread;
373 static d_ioctl_t devioctl;
374 static d_poll_t devpoll;
375 static d_kqfilter_t devkqfilter;
377 static struct cdevsw dev_cdevsw = {
378 .d_version = D_VERSION,
384 .d_kqfilter = devkqfilter,
388 struct dev_event_info
391 TAILQ_ENTRY(dev_event_info) dei_link;
394 TAILQ_HEAD(devq, dev_event_info);
396 static struct dev_softc
409 static void filt_devctl_detach(struct knote *kn);
410 static int filt_devctl_read(struct knote *kn, long hint);
412 struct filterops devctl_rfiltops = {
414 .f_detach = filt_devctl_detach,
415 .f_event = filt_devctl_read,
418 static struct cdev *devctl_dev;
423 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
424 UID_ROOT, GID_WHEEL, 0600, "devctl");
425 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
426 cv_init(&devsoftc.cv, "dev cv");
427 TAILQ_INIT(&devsoftc.devq);
428 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
433 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
436 mtx_lock(&devsoftc.mtx);
437 if (devsoftc.inuse) {
438 mtx_unlock(&devsoftc.mtx);
443 mtx_unlock(&devsoftc.mtx);
448 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
451 mtx_lock(&devsoftc.mtx);
453 devsoftc.nonblock = 0;
455 cv_broadcast(&devsoftc.cv);
456 funsetown(&devsoftc.sigio);
457 mtx_unlock(&devsoftc.mtx);
462 * The read channel for this device is used to report changes to
463 * userland in realtime. We are required to free the data as well as
464 * the n1 object because we allocate them separately. Also note that
465 * we return one record at a time. If you try to read this device a
466 * character at a time, you will lose the rest of the data. Listening
467 * programs are expected to cope.
470 devread(struct cdev *dev, struct uio *uio, int ioflag)
472 struct dev_event_info *n1;
475 mtx_lock(&devsoftc.mtx);
476 while (TAILQ_EMPTY(&devsoftc.devq)) {
477 if (devsoftc.nonblock) {
478 mtx_unlock(&devsoftc.mtx);
481 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
484 * Need to translate ERESTART to EINTR here? -- jake
486 mtx_unlock(&devsoftc.mtx);
490 n1 = TAILQ_FIRST(&devsoftc.devq);
491 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
493 mtx_unlock(&devsoftc.mtx);
494 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
495 free(n1->dei_data, M_BUS);
501 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
507 devsoftc.nonblock = 1;
509 devsoftc.nonblock = 0;
518 return fsetown(*(int *)data, &devsoftc.sigio);
520 *(int *)data = fgetown(&devsoftc.sigio);
523 /* (un)Support for other fcntl() calls. */
534 devpoll(struct cdev *dev, int events, struct thread *td)
538 mtx_lock(&devsoftc.mtx);
539 if (events & (POLLIN | POLLRDNORM)) {
540 if (!TAILQ_EMPTY(&devsoftc.devq))
541 revents = events & (POLLIN | POLLRDNORM);
543 selrecord(td, &devsoftc.sel);
545 mtx_unlock(&devsoftc.mtx);
551 devkqfilter(struct cdev *dev, struct knote *kn)
555 if (kn->kn_filter == EVFILT_READ) {
556 kn->kn_fop = &devctl_rfiltops;
557 knlist_add(&devsoftc.sel.si_note, kn, 0);
565 filt_devctl_detach(struct knote *kn)
568 knlist_remove(&devsoftc.sel.si_note, kn, 0);
572 filt_devctl_read(struct knote *kn, long hint)
574 kn->kn_data = devsoftc.queued;
575 return (kn->kn_data != 0);
579 * @brief Return whether the userland process is running
582 devctl_process_running(void)
584 return (devsoftc.inuse == 1);
588 * @brief Queue data to be read from the devctl device
590 * Generic interface to queue data to the devctl device. It is
591 * assumed that @p data is properly formatted. It is further assumed
592 * that @p data is allocated using the M_BUS malloc type.
595 devctl_queue_data_f(char *data, int flags)
597 struct dev_event_info *n1 = NULL, *n2 = NULL;
599 if (strlen(data) == 0)
601 if (devctl_queue_length == 0)
603 n1 = malloc(sizeof(*n1), M_BUS, flags);
607 mtx_lock(&devsoftc.mtx);
608 if (devctl_queue_length == 0) {
609 mtx_unlock(&devsoftc.mtx);
610 free(n1->dei_data, M_BUS);
614 /* Leave at least one spot in the queue... */
615 while (devsoftc.queued > devctl_queue_length - 1) {
616 n2 = TAILQ_FIRST(&devsoftc.devq);
617 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
618 free(n2->dei_data, M_BUS);
622 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
624 cv_broadcast(&devsoftc.cv);
625 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
626 mtx_unlock(&devsoftc.mtx);
627 selwakeup(&devsoftc.sel);
628 if (devsoftc.async && devsoftc.sigio != NULL)
629 pgsigio(&devsoftc.sigio, SIGIO, 0);
633 * We have to free data on all error paths since the caller
634 * assumes it will be free'd when this item is dequeued.
641 devctl_queue_data(char *data)
644 devctl_queue_data_f(data, M_NOWAIT);
648 * @brief Send a 'notification' to userland, using standard ways
651 devctl_notify_f(const char *system, const char *subsystem, const char *type,
652 const char *data, int flags)
658 return; /* BOGUS! Must specify system. */
659 if (subsystem == NULL)
660 return; /* BOGUS! Must specify subsystem. */
662 return; /* BOGUS! Must specify type. */
663 len += strlen(" system=") + strlen(system);
664 len += strlen(" subsystem=") + strlen(subsystem);
665 len += strlen(" type=") + strlen(type);
666 /* add in the data message plus newline. */
669 len += 3; /* '!', '\n', and NUL */
670 msg = malloc(len, M_BUS, flags);
672 return; /* Drop it on the floor */
674 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
675 system, subsystem, type, data);
677 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
678 system, subsystem, type);
679 devctl_queue_data_f(msg, flags);
683 devctl_notify(const char *system, const char *subsystem, const char *type,
687 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
691 * Common routine that tries to make sending messages as easy as possible.
692 * We allocate memory for the data, copy strings into that, but do not
693 * free it unless there's an error. The dequeue part of the driver should
694 * free the data. We don't send data when the device is disabled. We do
695 * send data, even when we have no listeners, because we wish to avoid
696 * races relating to startup and restart of listening applications.
698 * devaddq is designed to string together the type of event, with the
699 * object of that event, plus the plug and play info and location info
700 * for that event. This is likely most useful for devices, but less
701 * useful for other consumers of this interface. Those should use
702 * the devctl_queue_data() interface instead.
705 devaddq(const char *type, const char *what, device_t dev)
712 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
714 data = malloc(1024, M_BUS, M_NOWAIT);
718 /* get the bus specific location of this device */
719 loc = malloc(1024, M_BUS, M_NOWAIT);
723 bus_child_location_str(dev, loc, 1024);
725 /* Get the bus specific pnp info of this device */
726 pnp = malloc(1024, M_BUS, M_NOWAIT);
730 bus_child_pnpinfo_str(dev, pnp, 1024);
732 /* Get the parent of this device, or / if high enough in the tree. */
733 if (device_get_parent(dev) == NULL)
734 parstr = "."; /* Or '/' ? */
736 parstr = device_get_nameunit(device_get_parent(dev));
737 /* String it all together. */
738 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
742 devctl_queue_data(data);
752 * A device was added to the tree. We are called just after it successfully
753 * attaches (that is, probe and attach success for this device). No call
754 * is made if a device is merely parented into the tree. See devnomatch
755 * if probe fails. If attach fails, no notification is sent (but maybe
756 * we should have a different message for this).
759 devadded(device_t dev)
761 devaddq("+", device_get_nameunit(dev), dev);
765 * A device was removed from the tree. We are called just before this
769 devremoved(device_t dev)
771 devaddq("-", device_get_nameunit(dev), dev);
775 * Called when there's no match for this device. This is only called
776 * the first time that no match happens, so we don't keep getting this
777 * message. Should that prove to be undesirable, we can change it.
778 * This is called when all drivers that can attach to a given bus
779 * decline to accept this device. Other errors may not be detected.
782 devnomatch(device_t dev)
784 devaddq("?", "", dev);
788 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
790 struct dev_event_info *n1;
793 dis = (devctl_queue_length == 0);
794 error = sysctl_handle_int(oidp, &dis, 0, req);
795 if (error || !req->newptr)
797 if (mtx_initialized(&devsoftc.mtx))
798 mtx_lock(&devsoftc.mtx);
800 while (!TAILQ_EMPTY(&devsoftc.devq)) {
801 n1 = TAILQ_FIRST(&devsoftc.devq);
802 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
803 free(n1->dei_data, M_BUS);
807 devctl_queue_length = 0;
809 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
811 if (mtx_initialized(&devsoftc.mtx))
812 mtx_unlock(&devsoftc.mtx);
817 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
819 struct dev_event_info *n1;
822 q = devctl_queue_length;
823 error = sysctl_handle_int(oidp, &q, 0, req);
824 if (error || !req->newptr)
828 if (mtx_initialized(&devsoftc.mtx))
829 mtx_lock(&devsoftc.mtx);
830 devctl_queue_length = q;
831 while (devsoftc.queued > devctl_queue_length) {
832 n1 = TAILQ_FIRST(&devsoftc.devq);
833 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
834 free(n1->dei_data, M_BUS);
838 if (mtx_initialized(&devsoftc.mtx))
839 mtx_unlock(&devsoftc.mtx);
844 * @brief safely quotes strings that might have double quotes in them.
846 * The devctl protocol relies on quoted strings having matching quotes.
847 * This routine quotes any internal quotes so the resulting string
848 * is safe to pass to snprintf to construct, for example pnp info strings.
849 * Strings are always terminated with a NUL, but may be truncated if longer
850 * than @p len bytes after quotes.
852 * @param dst Buffer to hold the string. Must be at least @p len bytes long
853 * @param src Original buffer.
854 * @param len Length of buffer pointed to by @dst, including trailing NUL
857 devctl_safe_quote(char *dst, const char *src, size_t len)
859 char *walker = dst, *ep = dst + len - 1;
863 while (src != NULL && walker < ep)
875 /* End of /dev/devctl code */
877 static TAILQ_HEAD(,device) bus_data_devices;
878 static int bus_data_generation = 1;
880 static kobj_method_t null_methods[] = {
884 DEFINE_CLASS(null, null_methods, 0);
887 * Bus pass implementation
890 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
891 int bus_current_pass = BUS_PASS_ROOT;
895 * @brief Register the pass level of a new driver attachment
897 * Register a new driver attachment's pass level. If no driver
898 * attachment with the same pass level has been added, then @p new
899 * will be added to the global passes list.
901 * @param new the new driver attachment
904 driver_register_pass(struct driverlink *new)
906 struct driverlink *dl;
908 /* We only consider pass numbers during boot. */
909 if (bus_current_pass == BUS_PASS_DEFAULT)
913 * Walk the passes list. If we already know about this pass
914 * then there is nothing to do. If we don't, then insert this
915 * driver link into the list.
917 TAILQ_FOREACH(dl, &passes, passlink) {
918 if (dl->pass < new->pass)
920 if (dl->pass == new->pass)
922 TAILQ_INSERT_BEFORE(dl, new, passlink);
925 TAILQ_INSERT_TAIL(&passes, new, passlink);
929 * @brief Raise the current bus pass
931 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
932 * method on the root bus to kick off a new device tree scan for each
933 * new pass level that has at least one driver.
936 bus_set_pass(int pass)
938 struct driverlink *dl;
940 if (bus_current_pass > pass)
941 panic("Attempt to lower bus pass level");
943 TAILQ_FOREACH(dl, &passes, passlink) {
944 /* Skip pass values below the current pass level. */
945 if (dl->pass <= bus_current_pass)
949 * Bail once we hit a driver with a pass level that is
956 * Raise the pass level to the next level and rescan
959 bus_current_pass = dl->pass;
960 BUS_NEW_PASS(root_bus);
964 * If there isn't a driver registered for the requested pass,
965 * then bus_current_pass might still be less than 'pass'. Set
966 * it to 'pass' in that case.
968 if (bus_current_pass < pass)
969 bus_current_pass = pass;
970 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
974 * Devclass implementation
977 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
981 * @brief Find or create a device class
983 * If a device class with the name @p classname exists, return it,
984 * otherwise if @p create is non-zero create and return a new device
987 * If @p parentname is non-NULL, the parent of the devclass is set to
988 * the devclass of that name.
990 * @param classname the devclass name to find or create
991 * @param parentname the parent devclass name or @c NULL
992 * @param create non-zero to create a devclass
995 devclass_find_internal(const char *classname, const char *parentname,
1000 PDEBUG(("looking for %s", classname));
1004 TAILQ_FOREACH(dc, &devclasses, link) {
1005 if (!strcmp(dc->name, classname))
1009 if (create && !dc) {
1010 PDEBUG(("creating %s", classname));
1011 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1012 M_BUS, M_NOWAIT | M_ZERO);
1016 dc->name = (char*) (dc + 1);
1017 strcpy(dc->name, classname);
1018 TAILQ_INIT(&dc->drivers);
1019 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1021 bus_data_generation_update();
1025 * If a parent class is specified, then set that as our parent so
1026 * that this devclass will support drivers for the parent class as
1027 * well. If the parent class has the same name don't do this though
1028 * as it creates a cycle that can trigger an infinite loop in
1029 * device_probe_child() if a device exists for which there is no
1032 if (parentname && dc && !dc->parent &&
1033 strcmp(classname, parentname) != 0) {
1034 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1035 dc->parent->flags |= DC_HAS_CHILDREN;
1042 * @brief Create a device class
1044 * If a device class with the name @p classname exists, return it,
1045 * otherwise create and return a new device class.
1047 * @param classname the devclass name to find or create
1050 devclass_create(const char *classname)
1052 return (devclass_find_internal(classname, NULL, TRUE));
1056 * @brief Find a device class
1058 * If a device class with the name @p classname exists, return it,
1059 * otherwise return @c NULL.
1061 * @param classname the devclass name to find
1064 devclass_find(const char *classname)
1066 return (devclass_find_internal(classname, NULL, FALSE));
1070 * @brief Register that a device driver has been added to a devclass
1072 * Register that a device driver has been added to a devclass. This
1073 * is called by devclass_add_driver to accomplish the recursive
1074 * notification of all the children classes of dc, as well as dc.
1075 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1078 * We do a full search here of the devclass list at each iteration
1079 * level to save storing children-lists in the devclass structure. If
1080 * we ever move beyond a few dozen devices doing this, we may need to
1083 * @param dc the devclass to edit
1084 * @param driver the driver that was just added
1087 devclass_driver_added(devclass_t dc, driver_t *driver)
1093 * Call BUS_DRIVER_ADDED for any existing busses in this class.
1095 for (i = 0; i < dc->maxunit; i++)
1096 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1097 BUS_DRIVER_ADDED(dc->devices[i], driver);
1100 * Walk through the children classes. Since we only keep a
1101 * single parent pointer around, we walk the entire list of
1102 * devclasses looking for children. We set the
1103 * DC_HAS_CHILDREN flag when a child devclass is created on
1104 * the parent, so we only walk the list for those devclasses
1105 * that have children.
1107 if (!(dc->flags & DC_HAS_CHILDREN))
1110 TAILQ_FOREACH(dc, &devclasses, link) {
1111 if (dc->parent == parent)
1112 devclass_driver_added(dc, driver);
1117 * @brief Add a device driver to a device class
1119 * Add a device driver to a devclass. This is normally called
1120 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1121 * all devices in the devclass will be called to allow them to attempt
1122 * to re-probe any unmatched children.
1124 * @param dc the devclass to edit
1125 * @param driver the driver to register
1128 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1131 const char *parentname;
1133 PDEBUG(("%s", DRIVERNAME(driver)));
1135 /* Don't allow invalid pass values. */
1136 if (pass <= BUS_PASS_ROOT)
1139 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1144 * Compile the driver's methods. Also increase the reference count
1145 * so that the class doesn't get freed when the last instance
1146 * goes. This means we can safely use static methods and avoids a
1147 * double-free in devclass_delete_driver.
1149 kobj_class_compile((kobj_class_t) driver);
1152 * If the driver has any base classes, make the
1153 * devclass inherit from the devclass of the driver's
1154 * first base class. This will allow the system to
1155 * search for drivers in both devclasses for children
1156 * of a device using this driver.
1158 if (driver->baseclasses)
1159 parentname = driver->baseclasses[0]->name;
1162 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1164 dl->driver = driver;
1165 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1166 driver->refs++; /* XXX: kobj_mtx */
1168 driver_register_pass(dl);
1170 devclass_driver_added(dc, driver);
1171 bus_data_generation_update();
1176 * @brief Register that a device driver has been deleted from a devclass
1178 * Register that a device driver has been removed from a devclass.
1179 * This is called by devclass_delete_driver to accomplish the
1180 * recursive notification of all the children classes of busclass, as
1181 * well as busclass. Each layer will attempt to detach the driver
1182 * from any devices that are children of the bus's devclass. The function
1183 * will return an error if a device fails to detach.
1185 * We do a full search here of the devclass list at each iteration
1186 * level to save storing children-lists in the devclass structure. If
1187 * we ever move beyond a few dozen devices doing this, we may need to
1190 * @param busclass the devclass of the parent bus
1191 * @param dc the devclass of the driver being deleted
1192 * @param driver the driver being deleted
1195 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1202 * Disassociate from any devices. We iterate through all the
1203 * devices in the devclass of the driver and detach any which are
1204 * using the driver and which have a parent in the devclass which
1205 * we are deleting from.
1207 * Note that since a driver can be in multiple devclasses, we
1208 * should not detach devices which are not children of devices in
1209 * the affected devclass.
1211 for (i = 0; i < dc->maxunit; i++) {
1212 if (dc->devices[i]) {
1213 dev = dc->devices[i];
1214 if (dev->driver == driver && dev->parent &&
1215 dev->parent->devclass == busclass) {
1216 if ((error = device_detach(dev)) != 0)
1218 BUS_PROBE_NOMATCH(dev->parent, dev);
1220 dev->flags |= DF_DONENOMATCH;
1226 * Walk through the children classes. Since we only keep a
1227 * single parent pointer around, we walk the entire list of
1228 * devclasses looking for children. We set the
1229 * DC_HAS_CHILDREN flag when a child devclass is created on
1230 * the parent, so we only walk the list for those devclasses
1231 * that have children.
1233 if (!(busclass->flags & DC_HAS_CHILDREN))
1236 TAILQ_FOREACH(busclass, &devclasses, link) {
1237 if (busclass->parent == parent) {
1238 error = devclass_driver_deleted(busclass, dc, driver);
1247 * @brief Delete a device driver from a device class
1249 * Delete a device driver from a devclass. This is normally called
1250 * automatically by DRIVER_MODULE().
1252 * If the driver is currently attached to any devices,
1253 * devclass_delete_driver() will first attempt to detach from each
1254 * device. If one of the detach calls fails, the driver will not be
1257 * @param dc the devclass to edit
1258 * @param driver the driver to unregister
1261 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1263 devclass_t dc = devclass_find(driver->name);
1267 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1273 * Find the link structure in the bus' list of drivers.
1275 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1276 if (dl->driver == driver)
1281 PDEBUG(("%s not found in %s list", driver->name,
1286 error = devclass_driver_deleted(busclass, dc, driver);
1290 TAILQ_REMOVE(&busclass->drivers, dl, link);
1295 if (driver->refs == 0)
1296 kobj_class_free((kobj_class_t) driver);
1298 bus_data_generation_update();
1303 * @brief Quiesces a set of device drivers from a device class
1305 * Quiesce a device driver from a devclass. This is normally called
1306 * automatically by DRIVER_MODULE().
1308 * If the driver is currently attached to any devices,
1309 * devclass_quiesece_driver() will first attempt to quiesce each
1312 * @param dc the devclass to edit
1313 * @param driver the driver to unregister
1316 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1318 devclass_t dc = devclass_find(driver->name);
1324 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1330 * Find the link structure in the bus' list of drivers.
1332 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1333 if (dl->driver == driver)
1338 PDEBUG(("%s not found in %s list", driver->name,
1344 * Quiesce all devices. We iterate through all the devices in
1345 * the devclass of the driver and quiesce any which are using
1346 * the driver and which have a parent in the devclass which we
1349 * Note that since a driver can be in multiple devclasses, we
1350 * should not quiesce devices which are not children of
1351 * devices in the affected devclass.
1353 for (i = 0; i < dc->maxunit; i++) {
1354 if (dc->devices[i]) {
1355 dev = dc->devices[i];
1356 if (dev->driver == driver && dev->parent &&
1357 dev->parent->devclass == busclass) {
1358 if ((error = device_quiesce(dev)) != 0)
1371 devclass_find_driver_internal(devclass_t dc, const char *classname)
1375 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1377 TAILQ_FOREACH(dl, &dc->drivers, link) {
1378 if (!strcmp(dl->driver->name, classname))
1382 PDEBUG(("not found"));
1387 * @brief Return the name of the devclass
1390 devclass_get_name(devclass_t dc)
1396 * @brief Find a device given a unit number
1398 * @param dc the devclass to search
1399 * @param unit the unit number to search for
1401 * @returns the device with the given unit number or @c
1402 * NULL if there is no such device
1405 devclass_get_device(devclass_t dc, int unit)
1407 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1409 return (dc->devices[unit]);
1413 * @brief Find the softc field of a device given a unit number
1415 * @param dc the devclass to search
1416 * @param unit the unit number to search for
1418 * @returns the softc field of the device with the given
1419 * unit number or @c NULL if there is no such
1423 devclass_get_softc(devclass_t dc, int unit)
1427 dev = devclass_get_device(dc, unit);
1431 return (device_get_softc(dev));
1435 * @brief Get a list of devices in the devclass
1437 * An array containing a list of all the devices in the given devclass
1438 * is allocated and returned in @p *devlistp. The number of devices
1439 * in the array is returned in @p *devcountp. The caller should free
1440 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1442 * @param dc the devclass to examine
1443 * @param devlistp points at location for array pointer return
1445 * @param devcountp points at location for array size return value
1448 * @retval ENOMEM the array allocation failed
1451 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1456 count = devclass_get_count(dc);
1457 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1462 for (i = 0; i < dc->maxunit; i++) {
1463 if (dc->devices[i]) {
1464 list[count] = dc->devices[i];
1476 * @brief Get a list of drivers in the devclass
1478 * An array containing a list of pointers to all the drivers in the
1479 * given devclass is allocated and returned in @p *listp. The number
1480 * of drivers in the array is returned in @p *countp. The caller should
1481 * free the array using @c free(p, M_TEMP).
1483 * @param dc the devclass to examine
1484 * @param listp gives location for array pointer return value
1485 * @param countp gives location for number of array elements
1489 * @retval ENOMEM the array allocation failed
1492 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1499 TAILQ_FOREACH(dl, &dc->drivers, link)
1501 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1506 TAILQ_FOREACH(dl, &dc->drivers, link) {
1507 list[count] = dl->driver;
1517 * @brief Get the number of devices in a devclass
1519 * @param dc the devclass to examine
1522 devclass_get_count(devclass_t dc)
1527 for (i = 0; i < dc->maxunit; i++)
1534 * @brief Get the maximum unit number used in a devclass
1536 * Note that this is one greater than the highest currently-allocated
1537 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1538 * that not even the devclass has been allocated yet.
1540 * @param dc the devclass to examine
1543 devclass_get_maxunit(devclass_t dc)
1547 return (dc->maxunit);
1551 * @brief Find a free unit number in a devclass
1553 * This function searches for the first unused unit number greater
1554 * that or equal to @p unit.
1556 * @param dc the devclass to examine
1557 * @param unit the first unit number to check
1560 devclass_find_free_unit(devclass_t dc, int unit)
1564 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1570 * @brief Set the parent of a devclass
1572 * The parent class is normally initialised automatically by
1575 * @param dc the devclass to edit
1576 * @param pdc the new parent devclass
1579 devclass_set_parent(devclass_t dc, devclass_t pdc)
1585 * @brief Get the parent of a devclass
1587 * @param dc the devclass to examine
1590 devclass_get_parent(devclass_t dc)
1592 return (dc->parent);
1595 struct sysctl_ctx_list *
1596 devclass_get_sysctl_ctx(devclass_t dc)
1598 return (&dc->sysctl_ctx);
1602 devclass_get_sysctl_tree(devclass_t dc)
1604 return (dc->sysctl_tree);
1609 * @brief Allocate a unit number
1611 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1612 * will do). The allocated unit number is returned in @p *unitp.
1614 * @param dc the devclass to allocate from
1615 * @param unitp points at the location for the allocated unit
1619 * @retval EEXIST the requested unit number is already allocated
1620 * @retval ENOMEM memory allocation failure
1623 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1628 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1630 /* Ask the parent bus if it wants to wire this device. */
1632 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1635 /* If we were given a wired unit number, check for existing device */
1638 if (unit >= 0 && unit < dc->maxunit &&
1639 dc->devices[unit] != NULL) {
1641 printf("%s: %s%d already exists; skipping it\n",
1642 dc->name, dc->name, *unitp);
1646 /* Unwired device, find the next available slot for it */
1648 for (unit = 0;; unit++) {
1649 /* If there is an "at" hint for a unit then skip it. */
1650 if (resource_string_value(dc->name, unit, "at", &s) ==
1654 /* If this device slot is already in use, skip it. */
1655 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1663 * We've selected a unit beyond the length of the table, so let's
1664 * extend the table to make room for all units up to and including
1667 if (unit >= dc->maxunit) {
1668 device_t *newlist, *oldlist;
1671 oldlist = dc->devices;
1672 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1673 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1676 if (oldlist != NULL)
1677 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1678 bzero(newlist + dc->maxunit,
1679 sizeof(device_t) * (newsize - dc->maxunit));
1680 dc->devices = newlist;
1681 dc->maxunit = newsize;
1682 if (oldlist != NULL)
1683 free(oldlist, M_BUS);
1685 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1693 * @brief Add a device to a devclass
1695 * A unit number is allocated for the device (using the device's
1696 * preferred unit number if any) and the device is registered in the
1697 * devclass. This allows the device to be looked up by its unit
1698 * number, e.g. by decoding a dev_t minor number.
1700 * @param dc the devclass to add to
1701 * @param dev the device to add
1704 * @retval EEXIST the requested unit number is already allocated
1705 * @retval ENOMEM memory allocation failure
1708 devclass_add_device(devclass_t dc, device_t dev)
1712 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1714 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1717 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1721 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1722 free(dev->nameunit, M_BUS);
1723 dev->nameunit = NULL;
1726 dc->devices[dev->unit] = dev;
1728 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1735 * @brief Delete a device from a devclass
1737 * The device is removed from the devclass's device list and its unit
1740 * @param dc the devclass to delete from
1741 * @param dev the device to delete
1746 devclass_delete_device(devclass_t dc, device_t dev)
1751 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1753 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1754 panic("devclass_delete_device: inconsistent device class");
1755 dc->devices[dev->unit] = NULL;
1756 if (dev->flags & DF_WILDCARD)
1758 dev->devclass = NULL;
1759 free(dev->nameunit, M_BUS);
1760 dev->nameunit = NULL;
1767 * @brief Make a new device and add it as a child of @p parent
1769 * @param parent the parent of the new device
1770 * @param name the devclass name of the new device or @c NULL
1771 * to leave the devclass unspecified
1772 * @parem unit the unit number of the new device of @c -1 to
1773 * leave the unit number unspecified
1775 * @returns the new device
1778 make_device(device_t parent, const char *name, int unit)
1783 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1786 dc = devclass_find_internal(name, NULL, TRUE);
1788 printf("make_device: can't find device class %s\n",
1796 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
1800 dev->parent = parent;
1801 TAILQ_INIT(&dev->children);
1802 kobj_init((kobj_t) dev, &null_class);
1804 dev->devclass = NULL;
1806 dev->nameunit = NULL;
1810 dev->flags = DF_ENABLED;
1813 dev->flags |= DF_WILDCARD;
1815 dev->flags |= DF_FIXEDCLASS;
1816 if (devclass_add_device(dc, dev)) {
1817 kobj_delete((kobj_t) dev, M_BUS);
1824 dev->state = DS_NOTPRESENT;
1826 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1827 bus_data_generation_update();
1834 * @brief Print a description of a device.
1837 device_print_child(device_t dev, device_t child)
1841 if (device_is_alive(child))
1842 retval += BUS_PRINT_CHILD(dev, child);
1844 retval += device_printf(child, " not found\n");
1850 * @brief Create a new device
1852 * This creates a new device and adds it as a child of an existing
1853 * parent device. The new device will be added after the last existing
1854 * child with order zero.
1856 * @param dev the device which will be the parent of the
1858 * @param name devclass name for new device or @c NULL if not
1860 * @param unit unit number for new device or @c -1 if not
1863 * @returns the new device
1866 device_add_child(device_t dev, const char *name, int unit)
1868 return (device_add_child_ordered(dev, 0, name, unit));
1872 * @brief Create a new device
1874 * This creates a new device and adds it as a child of an existing
1875 * parent device. The new device will be added after the last existing
1876 * child with the same order.
1878 * @param dev the device which will be the parent of the
1880 * @param order a value which is used to partially sort the
1881 * children of @p dev - devices created using
1882 * lower values of @p order appear first in @p
1883 * dev's list of children
1884 * @param name devclass name for new device or @c NULL if not
1886 * @param unit unit number for new device or @c -1 if not
1889 * @returns the new device
1892 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1897 PDEBUG(("%s at %s with order %u as unit %d",
1898 name, DEVICENAME(dev), order, unit));
1899 KASSERT(name != NULL || unit == -1,
1900 ("child device with wildcard name and specific unit number"));
1902 child = make_device(dev, name, unit);
1905 child->order = order;
1907 TAILQ_FOREACH(place, &dev->children, link) {
1908 if (place->order > order)
1914 * The device 'place' is the first device whose order is
1915 * greater than the new child.
1917 TAILQ_INSERT_BEFORE(place, child, link);
1920 * The new child's order is greater or equal to the order of
1921 * any existing device. Add the child to the tail of the list.
1923 TAILQ_INSERT_TAIL(&dev->children, child, link);
1926 bus_data_generation_update();
1931 * @brief Delete a device
1933 * This function deletes a device along with all of its children. If
1934 * the device currently has a driver attached to it, the device is
1935 * detached first using device_detach().
1937 * @param dev the parent device
1938 * @param child the device to delete
1941 * @retval non-zero a unit error code describing the error
1944 device_delete_child(device_t dev, device_t child)
1947 device_t grandchild;
1949 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1951 /* remove children first */
1952 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1953 error = device_delete_child(child, grandchild);
1958 if ((error = device_detach(child)) != 0)
1960 if (child->devclass)
1961 devclass_delete_device(child->devclass, child);
1963 BUS_CHILD_DELETED(dev, child);
1964 TAILQ_REMOVE(&dev->children, child, link);
1965 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1966 kobj_delete((kobj_t) child, M_BUS);
1968 bus_data_generation_update();
1973 * @brief Delete all children devices of the given device, if any.
1975 * This function deletes all children devices of the given device, if
1976 * any, using the device_delete_child() function for each device it
1977 * finds. If a child device cannot be deleted, this function will
1978 * return an error code.
1980 * @param dev the parent device
1983 * @retval non-zero a device would not detach
1986 device_delete_children(device_t dev)
1991 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1995 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1996 error = device_delete_child(dev, child);
1998 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2006 * @brief Find a device given a unit number
2008 * This is similar to devclass_get_devices() but only searches for
2009 * devices which have @p dev as a parent.
2011 * @param dev the parent device to search
2012 * @param unit the unit number to search for. If the unit is -1,
2013 * return the first child of @p dev which has name
2014 * @p classname (that is, the one with the lowest unit.)
2016 * @returns the device with the given unit number or @c
2017 * NULL if there is no such device
2020 device_find_child(device_t dev, const char *classname, int unit)
2025 dc = devclass_find(classname);
2030 child = devclass_get_device(dc, unit);
2031 if (child && child->parent == dev)
2034 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2035 child = devclass_get_device(dc, unit);
2036 if (child && child->parent == dev)
2047 first_matching_driver(devclass_t dc, device_t dev)
2050 return (devclass_find_driver_internal(dc, dev->devclass->name));
2051 return (TAILQ_FIRST(&dc->drivers));
2058 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2060 if (dev->devclass) {
2062 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2063 if (!strcmp(dev->devclass->name, dl->driver->name))
2067 return (TAILQ_NEXT(last, link));
2074 device_probe_child(device_t dev, device_t child)
2077 driverlink_t best = NULL;
2079 int result, pri = 0;
2080 int hasclass = (child->devclass != NULL);
2086 panic("device_probe_child: parent device has no devclass");
2089 * If the state is already probed, then return. However, don't
2090 * return if we can rebid this object.
2092 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2095 for (; dc; dc = dc->parent) {
2096 for (dl = first_matching_driver(dc, child);
2098 dl = next_matching_driver(dc, child, dl)) {
2099 /* If this driver's pass is too high, then ignore it. */
2100 if (dl->pass > bus_current_pass)
2103 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2104 result = device_set_driver(child, dl->driver);
2105 if (result == ENOMEM)
2107 else if (result != 0)
2110 if (device_set_devclass(child,
2111 dl->driver->name) != 0) {
2112 char const * devname =
2113 device_get_name(child);
2114 if (devname == NULL)
2115 devname = "(unknown)";
2116 printf("driver bug: Unable to set "
2117 "devclass (class: %s "
2121 (void)device_set_driver(child, NULL);
2126 /* Fetch any flags for the device before probing. */
2127 resource_int_value(dl->driver->name, child->unit,
2128 "flags", &child->devflags);
2130 result = DEVICE_PROBE(child);
2132 /* Reset flags and devclass before the next probe. */
2133 child->devflags = 0;
2135 (void)device_set_devclass(child, NULL);
2138 * If the driver returns SUCCESS, there can be
2139 * no higher match for this device.
2148 * Probes that return BUS_PROBE_NOWILDCARD or lower
2149 * only match on devices whose driver was explicitly
2152 if (result <= BUS_PROBE_NOWILDCARD &&
2153 !(child->flags & DF_FIXEDCLASS)) {
2158 * The driver returned an error so it
2159 * certainly doesn't match.
2162 (void)device_set_driver(child, NULL);
2167 * A priority lower than SUCCESS, remember the
2168 * best matching driver. Initialise the value
2169 * of pri for the first match.
2171 if (best == NULL || result > pri) {
2178 * If we have an unambiguous match in this devclass,
2179 * don't look in the parent.
2181 if (best && pri == 0)
2186 * If we found a driver, change state and initialise the devclass.
2188 /* XXX What happens if we rebid and got no best? */
2191 * If this device was attached, and we were asked to
2192 * rescan, and it is a different driver, then we have
2193 * to detach the old driver and reattach this new one.
2194 * Note, we don't have to check for DF_REBID here
2195 * because if the state is > DS_ALIVE, we know it must
2198 * This assumes that all DF_REBID drivers can have
2199 * their probe routine called at any time and that
2200 * they are idempotent as well as completely benign in
2201 * normal operations.
2203 * We also have to make sure that the detach
2204 * succeeded, otherwise we fail the operation (or
2205 * maybe it should just fail silently? I'm torn).
2207 if (child->state > DS_ALIVE && best->driver != child->driver)
2208 if ((result = device_detach(dev)) != 0)
2211 /* Set the winning driver, devclass, and flags. */
2212 if (!child->devclass) {
2213 result = device_set_devclass(child, best->driver->name);
2217 result = device_set_driver(child, best->driver);
2220 resource_int_value(best->driver->name, child->unit,
2221 "flags", &child->devflags);
2225 * A bit bogus. Call the probe method again to make
2226 * sure that we have the right description.
2228 DEVICE_PROBE(child);
2230 child->flags |= DF_REBID;
2233 child->flags &= ~DF_REBID;
2234 child->state = DS_ALIVE;
2236 bus_data_generation_update();
2244 * @brief Return the parent of a device
2247 device_get_parent(device_t dev)
2249 return (dev->parent);
2253 * @brief Get a list of children of a device
2255 * An array containing a list of all the children of the given device
2256 * is allocated and returned in @p *devlistp. The number of devices
2257 * in the array is returned in @p *devcountp. The caller should free
2258 * the array using @c free(p, M_TEMP).
2260 * @param dev the device to examine
2261 * @param devlistp points at location for array pointer return
2263 * @param devcountp points at location for array size return value
2266 * @retval ENOMEM the array allocation failed
2269 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2276 TAILQ_FOREACH(child, &dev->children, link) {
2285 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2290 TAILQ_FOREACH(child, &dev->children, link) {
2291 list[count] = child;
2302 * @brief Return the current driver for the device or @c NULL if there
2303 * is no driver currently attached
2306 device_get_driver(device_t dev)
2308 return (dev->driver);
2312 * @brief Return the current devclass for the device or @c NULL if
2316 device_get_devclass(device_t dev)
2318 return (dev->devclass);
2322 * @brief Return the name of the device's devclass or @c NULL if there
2326 device_get_name(device_t dev)
2328 if (dev != NULL && dev->devclass)
2329 return (devclass_get_name(dev->devclass));
2334 * @brief Return a string containing the device's devclass name
2335 * followed by an ascii representation of the device's unit number
2339 device_get_nameunit(device_t dev)
2341 return (dev->nameunit);
2345 * @brief Return the device's unit number.
2348 device_get_unit(device_t dev)
2354 * @brief Return the device's description string
2357 device_get_desc(device_t dev)
2363 * @brief Return the device's flags
2366 device_get_flags(device_t dev)
2368 return (dev->devflags);
2371 struct sysctl_ctx_list *
2372 device_get_sysctl_ctx(device_t dev)
2374 return (&dev->sysctl_ctx);
2378 device_get_sysctl_tree(device_t dev)
2380 return (dev->sysctl_tree);
2384 * @brief Print the name of the device followed by a colon and a space
2386 * @returns the number of characters printed
2389 device_print_prettyname(device_t dev)
2391 const char *name = device_get_name(dev);
2394 return (printf("unknown: "));
2395 return (printf("%s%d: ", name, device_get_unit(dev)));
2399 * @brief Print the name of the device followed by a colon, a space
2400 * and the result of calling vprintf() with the value of @p fmt and
2401 * the following arguments.
2403 * @returns the number of characters printed
2406 device_printf(device_t dev, const char * fmt, ...)
2411 retval = device_print_prettyname(dev);
2413 retval += vprintf(fmt, ap);
2422 device_set_desc_internal(device_t dev, const char* desc, int copy)
2424 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2425 free(dev->desc, M_BUS);
2426 dev->flags &= ~DF_DESCMALLOCED;
2431 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2433 strcpy(dev->desc, desc);
2434 dev->flags |= DF_DESCMALLOCED;
2437 /* Avoid a -Wcast-qual warning */
2438 dev->desc = (char *)(uintptr_t) desc;
2441 bus_data_generation_update();
2445 * @brief Set the device's description
2447 * The value of @c desc should be a string constant that will not
2448 * change (at least until the description is changed in a subsequent
2449 * call to device_set_desc() or device_set_desc_copy()).
2452 device_set_desc(device_t dev, const char* desc)
2454 device_set_desc_internal(dev, desc, FALSE);
2458 * @brief Set the device's description
2460 * The string pointed to by @c desc is copied. Use this function if
2461 * the device description is generated, (e.g. with sprintf()).
2464 device_set_desc_copy(device_t dev, const char* desc)
2466 device_set_desc_internal(dev, desc, TRUE);
2470 * @brief Set the device's flags
2473 device_set_flags(device_t dev, uint32_t flags)
2475 dev->devflags = flags;
2479 * @brief Return the device's softc field
2481 * The softc is allocated and zeroed when a driver is attached, based
2482 * on the size field of the driver.
2485 device_get_softc(device_t dev)
2487 return (dev->softc);
2491 * @brief Set the device's softc field
2493 * Most drivers do not need to use this since the softc is allocated
2494 * automatically when the driver is attached.
2497 device_set_softc(device_t dev, void *softc)
2499 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2500 free(dev->softc, M_BUS_SC);
2503 dev->flags |= DF_EXTERNALSOFTC;
2505 dev->flags &= ~DF_EXTERNALSOFTC;
2509 * @brief Free claimed softc
2511 * Most drivers do not need to use this since the softc is freed
2512 * automatically when the driver is detached.
2515 device_free_softc(void *softc)
2517 free(softc, M_BUS_SC);
2521 * @brief Claim softc
2523 * This function can be used to let the driver free the automatically
2524 * allocated softc using "device_free_softc()". This function is
2525 * useful when the driver is refcounting the softc and the softc
2526 * cannot be freed when the "device_detach" method is called.
2529 device_claim_softc(device_t dev)
2532 dev->flags |= DF_EXTERNALSOFTC;
2534 dev->flags &= ~DF_EXTERNALSOFTC;
2538 * @brief Get the device's ivars field
2540 * The ivars field is used by the parent device to store per-device
2541 * state (e.g. the physical location of the device or a list of
2545 device_get_ivars(device_t dev)
2548 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2549 return (dev->ivars);
2553 * @brief Set the device's ivars field
2556 device_set_ivars(device_t dev, void * ivars)
2559 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2564 * @brief Return the device's state
2567 device_get_state(device_t dev)
2569 return (dev->state);
2573 * @brief Set the DF_ENABLED flag for the device
2576 device_enable(device_t dev)
2578 dev->flags |= DF_ENABLED;
2582 * @brief Clear the DF_ENABLED flag for the device
2585 device_disable(device_t dev)
2587 dev->flags &= ~DF_ENABLED;
2591 * @brief Increment the busy counter for the device
2594 device_busy(device_t dev)
2596 if (dev->state < DS_ATTACHING)
2597 panic("device_busy: called for unattached device");
2598 if (dev->busy == 0 && dev->parent)
2599 device_busy(dev->parent);
2601 if (dev->state == DS_ATTACHED)
2602 dev->state = DS_BUSY;
2606 * @brief Decrement the busy counter for the device
2609 device_unbusy(device_t dev)
2611 if (dev->busy != 0 && dev->state != DS_BUSY &&
2612 dev->state != DS_ATTACHING)
2613 panic("device_unbusy: called for non-busy device %s",
2614 device_get_nameunit(dev));
2616 if (dev->busy == 0) {
2618 device_unbusy(dev->parent);
2619 if (dev->state == DS_BUSY)
2620 dev->state = DS_ATTACHED;
2625 * @brief Set the DF_QUIET flag for the device
2628 device_quiet(device_t dev)
2630 dev->flags |= DF_QUIET;
2634 * @brief Clear the DF_QUIET flag for the device
2637 device_verbose(device_t dev)
2639 dev->flags &= ~DF_QUIET;
2643 * @brief Return non-zero if the DF_QUIET flag is set on the device
2646 device_is_quiet(device_t dev)
2648 return ((dev->flags & DF_QUIET) != 0);
2652 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2655 device_is_enabled(device_t dev)
2657 return ((dev->flags & DF_ENABLED) != 0);
2661 * @brief Return non-zero if the device was successfully probed
2664 device_is_alive(device_t dev)
2666 return (dev->state >= DS_ALIVE);
2670 * @brief Return non-zero if the device currently has a driver
2674 device_is_attached(device_t dev)
2676 return (dev->state >= DS_ATTACHED);
2680 * @brief Return non-zero if the device is currently suspended.
2683 device_is_suspended(device_t dev)
2685 return ((dev->flags & DF_SUSPENDED) != 0);
2689 * @brief Set the devclass of a device
2690 * @see devclass_add_device().
2693 device_set_devclass(device_t dev, const char *classname)
2700 devclass_delete_device(dev->devclass, dev);
2704 if (dev->devclass) {
2705 printf("device_set_devclass: device class already set\n");
2709 dc = devclass_find_internal(classname, NULL, TRUE);
2713 error = devclass_add_device(dc, dev);
2715 bus_data_generation_update();
2720 * @brief Set the devclass of a device and mark the devclass fixed.
2721 * @see device_set_devclass()
2724 device_set_devclass_fixed(device_t dev, const char *classname)
2728 if (classname == NULL)
2731 error = device_set_devclass(dev, classname);
2734 dev->flags |= DF_FIXEDCLASS;
2739 * @brief Set the driver of a device
2742 * @retval EBUSY the device already has a driver attached
2743 * @retval ENOMEM a memory allocation failure occurred
2746 device_set_driver(device_t dev, driver_t *driver)
2748 if (dev->state >= DS_ATTACHED)
2751 if (dev->driver == driver)
2754 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2755 free(dev->softc, M_BUS_SC);
2758 device_set_desc(dev, NULL);
2759 kobj_delete((kobj_t) dev, NULL);
2760 dev->driver = driver;
2762 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2763 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2764 dev->softc = malloc(driver->size, M_BUS_SC,
2767 kobj_delete((kobj_t) dev, NULL);
2768 kobj_init((kobj_t) dev, &null_class);
2774 kobj_init((kobj_t) dev, &null_class);
2777 bus_data_generation_update();
2782 * @brief Probe a device, and return this status.
2784 * This function is the core of the device autoconfiguration
2785 * system. Its purpose is to select a suitable driver for a device and
2786 * then call that driver to initialise the hardware appropriately. The
2787 * driver is selected by calling the DEVICE_PROBE() method of a set of
2788 * candidate drivers and then choosing the driver which returned the
2789 * best value. This driver is then attached to the device using
2792 * The set of suitable drivers is taken from the list of drivers in
2793 * the parent device's devclass. If the device was originally created
2794 * with a specific class name (see device_add_child()), only drivers
2795 * with that name are probed, otherwise all drivers in the devclass
2796 * are probed. If no drivers return successful probe values in the
2797 * parent devclass, the search continues in the parent of that
2798 * devclass (see devclass_get_parent()) if any.
2800 * @param dev the device to initialise
2803 * @retval ENXIO no driver was found
2804 * @retval ENOMEM memory allocation failure
2805 * @retval non-zero some other unix error code
2806 * @retval -1 Device already attached
2809 device_probe(device_t dev)
2815 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2818 if (!(dev->flags & DF_ENABLED)) {
2819 if (bootverbose && device_get_name(dev) != NULL) {
2820 device_print_prettyname(dev);
2821 printf("not probed (disabled)\n");
2825 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2826 if (bus_current_pass == BUS_PASS_DEFAULT &&
2827 !(dev->flags & DF_DONENOMATCH)) {
2828 BUS_PROBE_NOMATCH(dev->parent, dev);
2830 dev->flags |= DF_DONENOMATCH;
2838 * @brief Probe a device and attach a driver if possible
2840 * calls device_probe() and attaches if that was successful.
2843 device_probe_and_attach(device_t dev)
2849 error = device_probe(dev);
2852 else if (error != 0)
2855 CURVNET_SET_QUIET(vnet0);
2856 error = device_attach(dev);
2862 * @brief Attach a device driver to a device
2864 * This function is a wrapper around the DEVICE_ATTACH() driver
2865 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2866 * device's sysctl tree, optionally prints a description of the device
2867 * and queues a notification event for user-based device management
2870 * Normally this function is only called internally from
2871 * device_probe_and_attach().
2873 * @param dev the device to initialise
2876 * @retval ENXIO no driver was found
2877 * @retval ENOMEM memory allocation failure
2878 * @retval non-zero some other unix error code
2881 device_attach(device_t dev)
2883 uint64_t attachtime;
2886 if (resource_disabled(dev->driver->name, dev->unit)) {
2887 device_disable(dev);
2889 device_printf(dev, "disabled via hints entry\n");
2893 device_sysctl_init(dev);
2894 if (!device_is_quiet(dev))
2895 device_print_child(dev->parent, dev);
2896 attachtime = get_cyclecount();
2897 dev->state = DS_ATTACHING;
2898 if ((error = DEVICE_ATTACH(dev)) != 0) {
2899 printf("device_attach: %s%d attach returned %d\n",
2900 dev->driver->name, dev->unit, error);
2901 if (!(dev->flags & DF_FIXEDCLASS))
2902 devclass_delete_device(dev->devclass, dev);
2903 (void)device_set_driver(dev, NULL);
2904 device_sysctl_fini(dev);
2905 KASSERT(dev->busy == 0, ("attach failed but busy"));
2906 dev->state = DS_NOTPRESENT;
2909 attachtime = get_cyclecount() - attachtime;
2911 * 4 bits per device is a reasonable value for desktop and server
2912 * hardware with good get_cyclecount() implementations, but WILL
2913 * need to be adjusted on other platforms.
2915 #define RANDOM_PROBE_BIT_GUESS 4
2917 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2918 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2919 dev->driver->name, dev->unit);
2920 random_harvest_direct(&attachtime, sizeof(attachtime),
2921 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2922 device_sysctl_update(dev);
2924 dev->state = DS_BUSY;
2926 dev->state = DS_ATTACHED;
2927 dev->flags &= ~DF_DONENOMATCH;
2933 * @brief Detach a driver from a device
2935 * This function is a wrapper around the DEVICE_DETACH() driver
2936 * method. If the call to DEVICE_DETACH() succeeds, it calls
2937 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2938 * notification event for user-based device management services and
2939 * cleans up the device's sysctl tree.
2941 * @param dev the device to un-initialise
2944 * @retval ENXIO no driver was found
2945 * @retval ENOMEM memory allocation failure
2946 * @retval non-zero some other unix error code
2949 device_detach(device_t dev)
2955 PDEBUG(("%s", DEVICENAME(dev)));
2956 if (dev->state == DS_BUSY)
2958 if (dev->state != DS_ATTACHED)
2961 if ((error = DEVICE_DETACH(dev)) != 0)
2964 if (!device_is_quiet(dev))
2965 device_printf(dev, "detached\n");
2967 BUS_CHILD_DETACHED(dev->parent, dev);
2969 if (!(dev->flags & DF_FIXEDCLASS))
2970 devclass_delete_device(dev->devclass, dev);
2972 dev->state = DS_NOTPRESENT;
2973 (void)device_set_driver(dev, NULL);
2974 device_sysctl_fini(dev);
2980 * @brief Tells a driver to quiesce itself.
2982 * This function is a wrapper around the DEVICE_QUIESCE() driver
2983 * method. If the call to DEVICE_QUIESCE() succeeds.
2985 * @param dev the device to quiesce
2988 * @retval ENXIO no driver was found
2989 * @retval ENOMEM memory allocation failure
2990 * @retval non-zero some other unix error code
2993 device_quiesce(device_t dev)
2996 PDEBUG(("%s", DEVICENAME(dev)));
2997 if (dev->state == DS_BUSY)
2999 if (dev->state != DS_ATTACHED)
3002 return (DEVICE_QUIESCE(dev));
3006 * @brief Notify a device of system shutdown
3008 * This function calls the DEVICE_SHUTDOWN() driver method if the
3009 * device currently has an attached driver.
3011 * @returns the value returned by DEVICE_SHUTDOWN()
3014 device_shutdown(device_t dev)
3016 if (dev->state < DS_ATTACHED)
3018 return (DEVICE_SHUTDOWN(dev));
3022 * @brief Set the unit number of a device
3024 * This function can be used to override the unit number used for a
3025 * device (e.g. to wire a device to a pre-configured unit number).
3028 device_set_unit(device_t dev, int unit)
3033 dc = device_get_devclass(dev);
3034 if (unit < dc->maxunit && dc->devices[unit])
3036 err = devclass_delete_device(dc, dev);
3040 err = devclass_add_device(dc, dev);
3044 bus_data_generation_update();
3048 /*======================================*/
3050 * Some useful method implementations to make life easier for bus drivers.
3054 * @brief Initialise a resource list.
3056 * @param rl the resource list to initialise
3059 resource_list_init(struct resource_list *rl)
3065 * @brief Reclaim memory used by a resource list.
3067 * This function frees the memory for all resource entries on the list
3070 * @param rl the resource list to free
3073 resource_list_free(struct resource_list *rl)
3075 struct resource_list_entry *rle;
3077 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3079 panic("resource_list_free: resource entry is busy");
3080 STAILQ_REMOVE_HEAD(rl, link);
3086 * @brief Add a resource entry.
3088 * This function adds a resource entry using the given @p type, @p
3089 * start, @p end and @p count values. A rid value is chosen by
3090 * searching sequentially for the first unused rid starting at zero.
3092 * @param rl the resource list to edit
3093 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3094 * @param start the start address of the resource
3095 * @param end the end address of the resource
3096 * @param count XXX end-start+1
3099 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3100 rman_res_t end, rman_res_t count)
3105 while (resource_list_find(rl, type, rid) != NULL)
3107 resource_list_add(rl, type, rid, start, end, count);
3112 * @brief Add or modify a resource entry.
3114 * If an existing entry exists with the same type and rid, it will be
3115 * modified using the given values of @p start, @p end and @p
3116 * count. If no entry exists, a new one will be created using the
3117 * given values. The resource list entry that matches is then returned.
3119 * @param rl the resource list to edit
3120 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3121 * @param rid the resource identifier
3122 * @param start the start address of the resource
3123 * @param end the end address of the resource
3124 * @param count XXX end-start+1
3126 struct resource_list_entry *
3127 resource_list_add(struct resource_list *rl, int type, int rid,
3128 rman_res_t start, rman_res_t end, rman_res_t count)
3130 struct resource_list_entry *rle;
3132 rle = resource_list_find(rl, type, rid);
3134 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3137 panic("resource_list_add: can't record entry");
3138 STAILQ_INSERT_TAIL(rl, rle, link);
3146 panic("resource_list_add: resource entry is busy");
3155 * @brief Determine if a resource entry is busy.
3157 * Returns true if a resource entry is busy meaning that it has an
3158 * associated resource that is not an unallocated "reserved" resource.
3160 * @param rl the resource list to search
3161 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3162 * @param rid the resource identifier
3164 * @returns Non-zero if the entry is busy, zero otherwise.
3167 resource_list_busy(struct resource_list *rl, int type, int rid)
3169 struct resource_list_entry *rle;
3171 rle = resource_list_find(rl, type, rid);
3172 if (rle == NULL || rle->res == NULL)
3174 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3175 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3176 ("reserved resource is active"));
3183 * @brief Determine if a resource entry is reserved.
3185 * Returns true if a resource entry is reserved meaning that it has an
3186 * associated "reserved" resource. The resource can either be
3187 * allocated or unallocated.
3189 * @param rl the resource list to search
3190 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3191 * @param rid the resource identifier
3193 * @returns Non-zero if the entry is reserved, zero otherwise.
3196 resource_list_reserved(struct resource_list *rl, int type, int rid)
3198 struct resource_list_entry *rle;
3200 rle = resource_list_find(rl, type, rid);
3201 if (rle != NULL && rle->flags & RLE_RESERVED)
3207 * @brief Find a resource entry by type and rid.
3209 * @param rl the resource list to search
3210 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3211 * @param rid the resource identifier
3213 * @returns the resource entry pointer or NULL if there is no such
3216 struct resource_list_entry *
3217 resource_list_find(struct resource_list *rl, int type, int rid)
3219 struct resource_list_entry *rle;
3221 STAILQ_FOREACH(rle, rl, link) {
3222 if (rle->type == type && rle->rid == rid)
3229 * @brief Delete a resource entry.
3231 * @param rl the resource list to edit
3232 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3233 * @param rid the resource identifier
3236 resource_list_delete(struct resource_list *rl, int type, int rid)
3238 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3241 if (rle->res != NULL)
3242 panic("resource_list_delete: resource has not been released");
3243 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3249 * @brief Allocate a reserved resource
3251 * This can be used by busses to force the allocation of resources
3252 * that are always active in the system even if they are not allocated
3253 * by a driver (e.g. PCI BARs). This function is usually called when
3254 * adding a new child to the bus. The resource is allocated from the
3255 * parent bus when it is reserved. The resource list entry is marked
3256 * with RLE_RESERVED to note that it is a reserved resource.
3258 * Subsequent attempts to allocate the resource with
3259 * resource_list_alloc() will succeed the first time and will set
3260 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3261 * resource that has been allocated is released with
3262 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3263 * the actual resource remains allocated. The resource can be released to
3264 * the parent bus by calling resource_list_unreserve().
3266 * @param rl the resource list to allocate from
3267 * @param bus the parent device of @p child
3268 * @param child the device for which the resource is being reserved
3269 * @param type the type of resource to allocate
3270 * @param rid a pointer to the resource identifier
3271 * @param start hint at the start of the resource range - pass
3272 * @c 0 for any start address
3273 * @param end hint at the end of the resource range - pass
3274 * @c ~0 for any end address
3275 * @param count hint at the size of range required - pass @c 1
3277 * @param flags any extra flags to control the resource
3278 * allocation - see @c RF_XXX flags in
3279 * <sys/rman.h> for details
3281 * @returns the resource which was allocated or @c NULL if no
3282 * resource could be allocated
3285 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3286 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3288 struct resource_list_entry *rle = NULL;
3289 int passthrough = (device_get_parent(child) != bus);
3294 "resource_list_reserve() should only be called for direct children");
3295 if (flags & RF_ACTIVE)
3297 "resource_list_reserve() should only reserve inactive resources");
3299 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3302 rle = resource_list_find(rl, type, *rid);
3303 rle->flags |= RLE_RESERVED;
3309 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3311 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3312 * and passing the allocation up to the parent of @p bus. This assumes
3313 * that the first entry of @c device_get_ivars(child) is a struct
3314 * resource_list. This also handles 'passthrough' allocations where a
3315 * child is a remote descendant of bus by passing the allocation up to
3316 * the parent of bus.
3318 * Typically, a bus driver would store a list of child resources
3319 * somewhere in the child device's ivars (see device_get_ivars()) and
3320 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3321 * then call resource_list_alloc() to perform the allocation.
3323 * @param rl the resource list to allocate from
3324 * @param bus the parent device of @p child
3325 * @param child the device which is requesting an allocation
3326 * @param type the type of resource to allocate
3327 * @param rid a pointer to the resource identifier
3328 * @param start hint at the start of the resource range - pass
3329 * @c 0 for any start address
3330 * @param end hint at the end of the resource range - pass
3331 * @c ~0 for any end address
3332 * @param count hint at the size of range required - pass @c 1
3334 * @param flags any extra flags to control the resource
3335 * allocation - see @c RF_XXX flags in
3336 * <sys/rman.h> for details
3338 * @returns the resource which was allocated or @c NULL if no
3339 * resource could be allocated
3342 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3343 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3345 struct resource_list_entry *rle = NULL;
3346 int passthrough = (device_get_parent(child) != bus);
3347 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3350 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3351 type, rid, start, end, count, flags));
3354 rle = resource_list_find(rl, type, *rid);
3357 return (NULL); /* no resource of that type/rid */
3360 if (rle->flags & RLE_RESERVED) {
3361 if (rle->flags & RLE_ALLOCATED)
3363 if ((flags & RF_ACTIVE) &&
3364 bus_activate_resource(child, type, *rid,
3367 rle->flags |= RLE_ALLOCATED;
3371 "resource entry %#x type %d for child %s is busy\n", *rid,
3372 type, device_get_nameunit(child));
3378 count = ulmax(count, rle->count);
3379 end = ulmax(rle->end, start + count - 1);
3382 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3383 type, rid, start, end, count, flags);
3386 * Record the new range.
3389 rle->start = rman_get_start(rle->res);
3390 rle->end = rman_get_end(rle->res);
3398 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3400 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3401 * used with resource_list_alloc().
3403 * @param rl the resource list which was allocated from
3404 * @param bus the parent device of @p child
3405 * @param child the device which is requesting a release
3406 * @param type the type of resource to release
3407 * @param rid the resource identifier
3408 * @param res the resource to release
3411 * @retval non-zero a standard unix error code indicating what
3412 * error condition prevented the operation
3415 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3416 int type, int rid, struct resource *res)
3418 struct resource_list_entry *rle = NULL;
3419 int passthrough = (device_get_parent(child) != bus);
3423 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3427 rle = resource_list_find(rl, type, rid);
3430 panic("resource_list_release: can't find resource");
3432 panic("resource_list_release: resource entry is not busy");
3433 if (rle->flags & RLE_RESERVED) {
3434 if (rle->flags & RLE_ALLOCATED) {
3435 if (rman_get_flags(res) & RF_ACTIVE) {
3436 error = bus_deactivate_resource(child, type,
3441 rle->flags &= ~RLE_ALLOCATED;
3447 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3457 * @brief Release all active resources of a given type
3459 * Release all active resources of a specified type. This is intended
3460 * to be used to cleanup resources leaked by a driver after detach or
3463 * @param rl the resource list which was allocated from
3464 * @param bus the parent device of @p child
3465 * @param child the device whose active resources are being released
3466 * @param type the type of resources to release
3469 * @retval EBUSY at least one resource was active
3472 resource_list_release_active(struct resource_list *rl, device_t bus,
3473 device_t child, int type)
3475 struct resource_list_entry *rle;
3479 STAILQ_FOREACH(rle, rl, link) {
3480 if (rle->type != type)
3482 if (rle->res == NULL)
3484 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3488 error = resource_list_release(rl, bus, child, type,
3489 rman_get_rid(rle->res), rle->res);
3492 "Failed to release active resource: %d\n", error);
3499 * @brief Fully release a reserved resource
3501 * Fully releases a resource reserved via resource_list_reserve().
3503 * @param rl the resource list which was allocated from
3504 * @param bus the parent device of @p child
3505 * @param child the device whose reserved resource is being released
3506 * @param type the type of resource to release
3507 * @param rid the resource identifier
3508 * @param res the resource to release
3511 * @retval non-zero a standard unix error code indicating what
3512 * error condition prevented the operation
3515 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3518 struct resource_list_entry *rle = NULL;
3519 int passthrough = (device_get_parent(child) != bus);
3523 "resource_list_unreserve() should only be called for direct children");
3525 rle = resource_list_find(rl, type, rid);
3528 panic("resource_list_unreserve: can't find resource");
3529 if (!(rle->flags & RLE_RESERVED))
3531 if (rle->flags & RLE_ALLOCATED)
3533 rle->flags &= ~RLE_RESERVED;
3534 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3538 * @brief Print a description of resources in a resource list
3540 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3541 * The name is printed if at least one resource of the given type is available.
3542 * The format is used to print resource start and end.
3544 * @param rl the resource list to print
3545 * @param name the name of @p type, e.g. @c "memory"
3546 * @param type type type of resource entry to print
3547 * @param format printf(9) format string to print resource
3548 * start and end values
3550 * @returns the number of characters printed
3553 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3556 struct resource_list_entry *rle;
3557 int printed, retval;
3561 /* Yes, this is kinda cheating */
3562 STAILQ_FOREACH(rle, rl, link) {
3563 if (rle->type == type) {
3565 retval += printf(" %s ", name);
3567 retval += printf(",");
3569 retval += printf(format, rle->start);
3570 if (rle->count > 1) {
3571 retval += printf("-");
3572 retval += printf(format, rle->start +
3581 * @brief Releases all the resources in a list.
3583 * @param rl The resource list to purge.
3588 resource_list_purge(struct resource_list *rl)
3590 struct resource_list_entry *rle;
3592 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3594 bus_release_resource(rman_get_device(rle->res),
3595 rle->type, rle->rid, rle->res);
3596 STAILQ_REMOVE_HEAD(rl, link);
3602 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3605 return (device_add_child_ordered(dev, order, name, unit));
3609 * @brief Helper function for implementing DEVICE_PROBE()
3611 * This function can be used to help implement the DEVICE_PROBE() for
3612 * a bus (i.e. a device which has other devices attached to it). It
3613 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3617 bus_generic_probe(device_t dev)
3619 devclass_t dc = dev->devclass;
3622 TAILQ_FOREACH(dl, &dc->drivers, link) {
3624 * If this driver's pass is too high, then ignore it.
3625 * For most drivers in the default pass, this will
3626 * never be true. For early-pass drivers they will
3627 * only call the identify routines of eligible drivers
3628 * when this routine is called. Drivers for later
3629 * passes should have their identify routines called
3630 * on early-pass busses during BUS_NEW_PASS().
3632 if (dl->pass > bus_current_pass)
3634 DEVICE_IDENTIFY(dl->driver, dev);
3641 * @brief Helper function for implementing DEVICE_ATTACH()
3643 * This function can be used to help implement the DEVICE_ATTACH() for
3644 * a bus. It calls device_probe_and_attach() for each of the device's
3648 bus_generic_attach(device_t dev)
3652 TAILQ_FOREACH(child, &dev->children, link) {
3653 device_probe_and_attach(child);
3660 * @brief Helper function for implementing DEVICE_DETACH()
3662 * This function can be used to help implement the DEVICE_DETACH() for
3663 * a bus. It calls device_detach() for each of the device's
3667 bus_generic_detach(device_t dev)
3672 if (dev->state != DS_ATTACHED)
3675 TAILQ_FOREACH(child, &dev->children, link) {
3676 if ((error = device_detach(child)) != 0)
3684 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3686 * This function can be used to help implement the DEVICE_SHUTDOWN()
3687 * for a bus. It calls device_shutdown() for each of the device's
3691 bus_generic_shutdown(device_t dev)
3695 TAILQ_FOREACH(child, &dev->children, link) {
3696 device_shutdown(child);
3703 * @brief Default function for suspending a child device.
3705 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3708 bus_generic_suspend_child(device_t dev, device_t child)
3712 error = DEVICE_SUSPEND(child);
3715 child->flags |= DF_SUSPENDED;
3721 * @brief Default function for resuming a child device.
3723 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3726 bus_generic_resume_child(device_t dev, device_t child)
3729 DEVICE_RESUME(child);
3730 child->flags &= ~DF_SUSPENDED;
3736 * @brief Helper function for implementing DEVICE_SUSPEND()
3738 * This function can be used to help implement the DEVICE_SUSPEND()
3739 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3740 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3741 * operation is aborted and any devices which were suspended are
3742 * resumed immediately by calling their DEVICE_RESUME() methods.
3745 bus_generic_suspend(device_t dev)
3748 device_t child, child2;
3750 TAILQ_FOREACH(child, &dev->children, link) {
3751 error = BUS_SUSPEND_CHILD(dev, child);
3753 for (child2 = TAILQ_FIRST(&dev->children);
3754 child2 && child2 != child;
3755 child2 = TAILQ_NEXT(child2, link))
3756 BUS_RESUME_CHILD(dev, child2);
3764 * @brief Helper function for implementing DEVICE_RESUME()
3766 * This function can be used to help implement the DEVICE_RESUME() for
3767 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3770 bus_generic_resume(device_t dev)
3774 TAILQ_FOREACH(child, &dev->children, link) {
3775 BUS_RESUME_CHILD(dev, child);
3776 /* if resume fails, there's nothing we can usefully do... */
3782 * @brief Helper function for implementing BUS_PRINT_CHILD().
3784 * This function prints the first part of the ascii representation of
3785 * @p child, including its name, unit and description (if any - see
3786 * device_set_desc()).
3788 * @returns the number of characters printed
3791 bus_print_child_header(device_t dev, device_t child)
3795 if (device_get_desc(child)) {
3796 retval += device_printf(child, "<%s>", device_get_desc(child));
3798 retval += printf("%s", device_get_nameunit(child));
3805 * @brief Helper function for implementing BUS_PRINT_CHILD().
3807 * This function prints the last part of the ascii representation of
3808 * @p child, which consists of the string @c " on " followed by the
3809 * name and unit of the @p dev.
3811 * @returns the number of characters printed
3814 bus_print_child_footer(device_t dev, device_t child)
3816 return (printf(" on %s\n", device_get_nameunit(dev)));
3820 * @brief Helper function for implementing BUS_PRINT_CHILD().
3822 * This function prints out the VM domain for the given device.
3824 * @returns the number of characters printed
3827 bus_print_child_domain(device_t dev, device_t child)
3831 /* No domain? Don't print anything */
3832 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3835 return (printf(" numa-domain %d", domain));
3839 * @brief Helper function for implementing BUS_PRINT_CHILD().
3841 * This function simply calls bus_print_child_header() followed by
3842 * bus_print_child_footer().
3844 * @returns the number of characters printed
3847 bus_generic_print_child(device_t dev, device_t child)
3851 retval += bus_print_child_header(dev, child);
3852 retval += bus_print_child_domain(dev, child);
3853 retval += bus_print_child_footer(dev, child);
3859 * @brief Stub function for implementing BUS_READ_IVAR().
3864 bus_generic_read_ivar(device_t dev, device_t child, int index,
3871 * @brief Stub function for implementing BUS_WRITE_IVAR().
3876 bus_generic_write_ivar(device_t dev, device_t child, int index,
3883 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3887 struct resource_list *
3888 bus_generic_get_resource_list(device_t dev, device_t child)
3894 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3896 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3897 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3898 * and then calls device_probe_and_attach() for each unattached child.
3901 bus_generic_driver_added(device_t dev, driver_t *driver)
3905 DEVICE_IDENTIFY(driver, dev);
3906 TAILQ_FOREACH(child, &dev->children, link) {
3907 if (child->state == DS_NOTPRESENT ||
3908 (child->flags & DF_REBID))
3909 device_probe_and_attach(child);
3914 * @brief Helper function for implementing BUS_NEW_PASS().
3916 * This implementing of BUS_NEW_PASS() first calls the identify
3917 * routines for any drivers that probe at the current pass. Then it
3918 * walks the list of devices for this bus. If a device is already
3919 * attached, then it calls BUS_NEW_PASS() on that device. If the
3920 * device is not already attached, it attempts to attach a driver to
3924 bus_generic_new_pass(device_t dev)
3931 TAILQ_FOREACH(dl, &dc->drivers, link) {
3932 if (dl->pass == bus_current_pass)
3933 DEVICE_IDENTIFY(dl->driver, dev);
3935 TAILQ_FOREACH(child, &dev->children, link) {
3936 if (child->state >= DS_ATTACHED)
3937 BUS_NEW_PASS(child);
3938 else if (child->state == DS_NOTPRESENT)
3939 device_probe_and_attach(child);
3944 * @brief Helper function for implementing BUS_SETUP_INTR().
3946 * This simple implementation of BUS_SETUP_INTR() simply calls the
3947 * BUS_SETUP_INTR() method of the parent of @p dev.
3950 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3951 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3954 /* Propagate up the bus hierarchy until someone handles it. */
3956 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3957 filter, intr, arg, cookiep));
3962 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3964 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3965 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3968 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3971 /* Propagate up the bus hierarchy until someone handles it. */
3973 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
3978 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
3980 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
3981 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
3984 bus_generic_adjust_resource(device_t dev, device_t child, int type,
3985 struct resource *r, rman_res_t start, rman_res_t end)
3987 /* Propagate up the bus hierarchy until someone handles it. */
3989 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
3995 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
3997 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
3998 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4001 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4002 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4004 /* Propagate up the bus hierarchy until someone handles it. */
4006 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4007 start, end, count, flags));
4012 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4014 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4015 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4018 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4021 /* Propagate up the bus hierarchy until someone handles it. */
4023 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4029 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4031 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4032 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4035 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4038 /* Propagate up the bus hierarchy until someone handles it. */
4040 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4046 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4048 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4049 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4052 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4053 int rid, struct resource *r)
4055 /* Propagate up the bus hierarchy until someone handles it. */
4057 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4063 * @brief Helper function for implementing BUS_BIND_INTR().
4065 * This simple implementation of BUS_BIND_INTR() simply calls the
4066 * BUS_BIND_INTR() method of the parent of @p dev.
4069 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4073 /* Propagate up the bus hierarchy until someone handles it. */
4075 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4080 * @brief Helper function for implementing BUS_CONFIG_INTR().
4082 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4083 * BUS_CONFIG_INTR() method of the parent of @p dev.
4086 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4087 enum intr_polarity pol)
4090 /* Propagate up the bus hierarchy until someone handles it. */
4092 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4097 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4099 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4100 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4103 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4104 void *cookie, const char *descr)
4107 /* Propagate up the bus hierarchy until someone handles it. */
4109 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4115 * @brief Helper function for implementing BUS_GET_CPUS().
4117 * This simple implementation of BUS_GET_CPUS() simply calls the
4118 * BUS_GET_CPUS() method of the parent of @p dev.
4121 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4122 size_t setsize, cpuset_t *cpuset)
4125 /* Propagate up the bus hierarchy until someone handles it. */
4126 if (dev->parent != NULL)
4127 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4132 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4134 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4135 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4138 bus_generic_get_dma_tag(device_t dev, device_t child)
4141 /* Propagate up the bus hierarchy until someone handles it. */
4142 if (dev->parent != NULL)
4143 return (BUS_GET_DMA_TAG(dev->parent, child));
4148 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4150 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4151 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4154 bus_generic_get_bus_tag(device_t dev, device_t child)
4157 /* Propagate up the bus hierarchy until someone handles it. */
4158 if (dev->parent != NULL)
4159 return (BUS_GET_BUS_TAG(dev->parent, child));
4160 return ((bus_space_tag_t)0);
4164 * @brief Helper function for implementing BUS_GET_RESOURCE().
4166 * This implementation of BUS_GET_RESOURCE() uses the
4167 * resource_list_find() function to do most of the work. It calls
4168 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4172 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4173 rman_res_t *startp, rman_res_t *countp)
4175 struct resource_list * rl = NULL;
4176 struct resource_list_entry * rle = NULL;
4178 rl = BUS_GET_RESOURCE_LIST(dev, child);
4182 rle = resource_list_find(rl, type, rid);
4187 *startp = rle->start;
4189 *countp = rle->count;
4195 * @brief Helper function for implementing BUS_SET_RESOURCE().
4197 * This implementation of BUS_SET_RESOURCE() uses the
4198 * resource_list_add() function to do most of the work. It calls
4199 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4203 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4204 rman_res_t start, rman_res_t count)
4206 struct resource_list * rl = NULL;
4208 rl = BUS_GET_RESOURCE_LIST(dev, child);
4212 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4218 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4220 * This implementation of BUS_DELETE_RESOURCE() uses the
4221 * resource_list_delete() function to do most of the work. It calls
4222 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4226 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4228 struct resource_list * rl = NULL;
4230 rl = BUS_GET_RESOURCE_LIST(dev, child);
4234 resource_list_delete(rl, type, rid);
4240 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4242 * This implementation of BUS_RELEASE_RESOURCE() uses the
4243 * resource_list_release() function to do most of the work. It calls
4244 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4247 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4248 int rid, struct resource *r)
4250 struct resource_list * rl = NULL;
4252 if (device_get_parent(child) != dev)
4253 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4256 rl = BUS_GET_RESOURCE_LIST(dev, child);
4260 return (resource_list_release(rl, dev, child, type, rid, r));
4264 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4266 * This implementation of BUS_ALLOC_RESOURCE() uses the
4267 * resource_list_alloc() function to do most of the work. It calls
4268 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4271 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4272 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4274 struct resource_list * rl = NULL;
4276 if (device_get_parent(child) != dev)
4277 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4278 type, rid, start, end, count, flags));
4280 rl = BUS_GET_RESOURCE_LIST(dev, child);
4284 return (resource_list_alloc(rl, dev, child, type, rid,
4285 start, end, count, flags));
4289 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4291 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4292 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4295 bus_generic_child_present(device_t dev, device_t child)
4297 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4301 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4305 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4311 * @brief Helper function for implementing BUS_RESCAN().
4313 * This null implementation of BUS_RESCAN() always fails to indicate
4314 * the bus does not support rescanning.
4317 bus_null_rescan(device_t dev)
4324 * Some convenience functions to make it easier for drivers to use the
4325 * resource-management functions. All these really do is hide the
4326 * indirection through the parent's method table, making for slightly
4327 * less-wordy code. In the future, it might make sense for this code
4328 * to maintain some sort of a list of resources allocated by each device.
4332 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4333 struct resource **res)
4337 for (i = 0; rs[i].type != -1; i++)
4339 for (i = 0; rs[i].type != -1; i++) {
4340 res[i] = bus_alloc_resource_any(dev,
4341 rs[i].type, &rs[i].rid, rs[i].flags);
4342 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4343 bus_release_resources(dev, rs, res);
4351 bus_release_resources(device_t dev, const struct resource_spec *rs,
4352 struct resource **res)
4356 for (i = 0; rs[i].type != -1; i++)
4357 if (res[i] != NULL) {
4358 bus_release_resource(
4359 dev, rs[i].type, rs[i].rid, res[i]);
4365 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4367 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4371 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start, rman_res_t end,
4372 rman_res_t count, u_int flags)
4374 if (dev->parent == NULL)
4376 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4381 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4383 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4387 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4390 if (dev->parent == NULL)
4392 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4396 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4398 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4402 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4404 if (dev->parent == NULL)
4406 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4410 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4412 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4416 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4418 if (dev->parent == NULL)
4420 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4424 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4426 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4430 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4432 if (dev->parent == NULL)
4434 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
4438 * @brief Wrapper function for BUS_SETUP_INTR().
4440 * This function simply calls the BUS_SETUP_INTR() method of the
4444 bus_setup_intr(device_t dev, struct resource *r, int flags,
4445 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4449 if (dev->parent == NULL)
4451 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4455 if (handler != NULL && !(flags & INTR_MPSAFE))
4456 device_printf(dev, "[GIANT-LOCKED]\n");
4461 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4463 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4467 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4469 if (dev->parent == NULL)
4471 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4475 * @brief Wrapper function for BUS_BIND_INTR().
4477 * This function simply calls the BUS_BIND_INTR() method of the
4481 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4483 if (dev->parent == NULL)
4485 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4489 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4491 * This function first formats the requested description into a
4492 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4493 * the parent of @p dev.
4496 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4497 const char *fmt, ...)
4500 char descr[MAXCOMLEN + 1];
4502 if (dev->parent == NULL)
4505 vsnprintf(descr, sizeof(descr), fmt, ap);
4507 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4511 * @brief Wrapper function for BUS_SET_RESOURCE().
4513 * This function simply calls the BUS_SET_RESOURCE() method of the
4517 bus_set_resource(device_t dev, int type, int rid,
4518 rman_res_t start, rman_res_t count)
4520 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4525 * @brief Wrapper function for BUS_GET_RESOURCE().
4527 * This function simply calls the BUS_GET_RESOURCE() method of the
4531 bus_get_resource(device_t dev, int type, int rid,
4532 rman_res_t *startp, rman_res_t *countp)
4534 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4539 * @brief Wrapper function for BUS_GET_RESOURCE().
4541 * This function simply calls the BUS_GET_RESOURCE() method of the
4542 * parent of @p dev and returns the start value.
4545 bus_get_resource_start(device_t dev, int type, int rid)
4551 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4559 * @brief Wrapper function for BUS_GET_RESOURCE().
4561 * This function simply calls the BUS_GET_RESOURCE() method of the
4562 * parent of @p dev and returns the count value.
4565 bus_get_resource_count(device_t dev, int type, int rid)
4571 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4579 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4581 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4585 bus_delete_resource(device_t dev, int type, int rid)
4587 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4591 * @brief Wrapper function for BUS_CHILD_PRESENT().
4593 * This function simply calls the BUS_CHILD_PRESENT() method of the
4597 bus_child_present(device_t child)
4599 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4603 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4605 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4609 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4613 parent = device_get_parent(child);
4614 if (parent == NULL) {
4618 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4622 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4624 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4628 bus_child_location_str(device_t child, char *buf, size_t buflen)
4632 parent = device_get_parent(child);
4633 if (parent == NULL) {
4637 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4641 * @brief Wrapper function for BUS_GET_CPUS().
4643 * This function simply calls the BUS_GET_CPUS() method of the
4647 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4651 parent = device_get_parent(dev);
4654 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4658 * @brief Wrapper function for BUS_GET_DMA_TAG().
4660 * This function simply calls the BUS_GET_DMA_TAG() method of the
4664 bus_get_dma_tag(device_t dev)
4668 parent = device_get_parent(dev);
4671 return (BUS_GET_DMA_TAG(parent, dev));
4675 * @brief Wrapper function for BUS_GET_BUS_TAG().
4677 * This function simply calls the BUS_GET_BUS_TAG() method of the
4681 bus_get_bus_tag(device_t dev)
4685 parent = device_get_parent(dev);
4687 return ((bus_space_tag_t)0);
4688 return (BUS_GET_BUS_TAG(parent, dev));
4692 * @brief Wrapper function for BUS_GET_DOMAIN().
4694 * This function simply calls the BUS_GET_DOMAIN() method of the
4698 bus_get_domain(device_t dev, int *domain)
4700 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4703 /* Resume all devices and then notify userland that we're up again. */
4705 root_resume(device_t dev)
4709 error = bus_generic_resume(dev);
4711 devctl_notify("kern", "power", "resume", NULL);
4716 root_print_child(device_t dev, device_t child)
4720 retval += bus_print_child_header(dev, child);
4721 retval += printf("\n");
4727 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4728 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4731 * If an interrupt mapping gets to here something bad has happened.
4733 panic("root_setup_intr");
4737 * If we get here, assume that the device is permanent and really is
4738 * present in the system. Removable bus drivers are expected to intercept
4739 * this call long before it gets here. We return -1 so that drivers that
4740 * really care can check vs -1 or some ERRNO returned higher in the food
4744 root_child_present(device_t dev, device_t child)
4750 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4756 /* Default to returning the set of all CPUs. */
4757 if (setsize != sizeof(cpuset_t))
4766 static kobj_method_t root_methods[] = {
4767 /* Device interface */
4768 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4769 KOBJMETHOD(device_suspend, bus_generic_suspend),
4770 KOBJMETHOD(device_resume, root_resume),
4773 KOBJMETHOD(bus_print_child, root_print_child),
4774 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4775 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4776 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4777 KOBJMETHOD(bus_child_present, root_child_present),
4778 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4783 static driver_t root_driver = {
4790 devclass_t root_devclass;
4793 root_bus_module_handler(module_t mod, int what, void* arg)
4797 TAILQ_INIT(&bus_data_devices);
4798 kobj_class_compile((kobj_class_t) &root_driver);
4799 root_bus = make_device(NULL, "root", 0);
4800 root_bus->desc = "System root bus";
4801 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4802 root_bus->driver = &root_driver;
4803 root_bus->state = DS_ATTACHED;
4804 root_devclass = devclass_find_internal("root", NULL, FALSE);
4809 device_shutdown(root_bus);
4812 return (EOPNOTSUPP);
4818 static moduledata_t root_bus_mod = {
4820 root_bus_module_handler,
4823 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4826 * @brief Automatically configure devices
4828 * This function begins the autoconfiguration process by calling
4829 * device_probe_and_attach() for each child of the @c root0 device.
4832 root_bus_configure(void)
4837 /* Eventually this will be split up, but this is sufficient for now. */
4838 bus_set_pass(BUS_PASS_DEFAULT);
4842 * @brief Module handler for registering device drivers
4844 * This module handler is used to automatically register device
4845 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4846 * devclass_add_driver() for the driver described by the
4847 * driver_module_data structure pointed to by @p arg
4850 driver_module_handler(module_t mod, int what, void *arg)
4852 struct driver_module_data *dmd;
4853 devclass_t bus_devclass;
4854 kobj_class_t driver;
4857 dmd = (struct driver_module_data *)arg;
4858 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4863 if (dmd->dmd_chainevh)
4864 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4866 pass = dmd->dmd_pass;
4867 driver = dmd->dmd_driver;
4868 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4869 DRIVERNAME(driver), dmd->dmd_busname, pass));
4870 error = devclass_add_driver(bus_devclass, driver, pass,
4875 PDEBUG(("Unloading module: driver %s from bus %s",
4876 DRIVERNAME(dmd->dmd_driver),
4878 error = devclass_delete_driver(bus_devclass,
4881 if (!error && dmd->dmd_chainevh)
4882 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4885 PDEBUG(("Quiesce module: driver %s from bus %s",
4886 DRIVERNAME(dmd->dmd_driver),
4888 error = devclass_quiesce_driver(bus_devclass,
4891 if (!error && dmd->dmd_chainevh)
4892 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4903 * @brief Enumerate all hinted devices for this bus.
4905 * Walks through the hints for this bus and calls the bus_hinted_child
4906 * routine for each one it fines. It searches first for the specific
4907 * bus that's being probed for hinted children (eg isa0), and then for
4908 * generic children (eg isa).
4910 * @param dev bus device to enumerate
4913 bus_enumerate_hinted_children(device_t bus)
4916 const char *dname, *busname;
4920 * enumerate all devices on the specific bus
4922 busname = device_get_nameunit(bus);
4924 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4925 BUS_HINTED_CHILD(bus, dname, dunit);
4928 * and all the generic ones.
4930 busname = device_get_name(bus);
4932 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4933 BUS_HINTED_CHILD(bus, dname, dunit);
4938 /* the _short versions avoid iteration by not calling anything that prints
4939 * more than oneliners. I love oneliners.
4943 print_device_short(device_t dev, int indent)
4948 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
4949 dev->unit, dev->desc,
4950 (dev->parent? "":"no "),
4951 (TAILQ_EMPTY(&dev->children)? "no ":""),
4952 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
4953 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
4954 (dev->flags&DF_WILDCARD? "wildcard,":""),
4955 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
4956 (dev->flags&DF_REBID? "rebiddable,":""),
4957 (dev->ivars? "":"no "),
4958 (dev->softc? "":"no "),
4963 print_device(device_t dev, int indent)
4968 print_device_short(dev, indent);
4970 indentprintf(("Parent:\n"));
4971 print_device_short(dev->parent, indent+1);
4972 indentprintf(("Driver:\n"));
4973 print_driver_short(dev->driver, indent+1);
4974 indentprintf(("Devclass:\n"));
4975 print_devclass_short(dev->devclass, indent+1);
4979 print_device_tree_short(device_t dev, int indent)
4980 /* print the device and all its children (indented) */
4987 print_device_short(dev, indent);
4989 TAILQ_FOREACH(child, &dev->children, link) {
4990 print_device_tree_short(child, indent+1);
4995 print_device_tree(device_t dev, int indent)
4996 /* print the device and all its children (indented) */
5003 print_device(dev, indent);
5005 TAILQ_FOREACH(child, &dev->children, link) {
5006 print_device_tree(child, indent+1);
5011 print_driver_short(driver_t *driver, int indent)
5016 indentprintf(("driver %s: softc size = %zd\n",
5017 driver->name, driver->size));
5021 print_driver(driver_t *driver, int indent)
5026 print_driver_short(driver, indent);
5030 print_driver_list(driver_list_t drivers, int indent)
5032 driverlink_t driver;
5034 TAILQ_FOREACH(driver, &drivers, link) {
5035 print_driver(driver->driver, indent);
5040 print_devclass_short(devclass_t dc, int indent)
5045 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5049 print_devclass(devclass_t dc, int indent)
5056 print_devclass_short(dc, indent);
5057 indentprintf(("Drivers:\n"));
5058 print_driver_list(dc->drivers, indent+1);
5060 indentprintf(("Devices:\n"));
5061 for (i = 0; i < dc->maxunit; i++)
5063 print_device(dc->devices[i], indent+1);
5067 print_devclass_list_short(void)
5071 printf("Short listing of devclasses, drivers & devices:\n");
5072 TAILQ_FOREACH(dc, &devclasses, link) {
5073 print_devclass_short(dc, 0);
5078 print_devclass_list(void)
5082 printf("Full listing of devclasses, drivers & devices:\n");
5083 TAILQ_FOREACH(dc, &devclasses, link) {
5084 print_devclass(dc, 0);
5091 * User-space access to the device tree.
5093 * We implement a small set of nodes:
5095 * hw.bus Single integer read method to obtain the
5096 * current generation count.
5097 * hw.bus.devices Reads the entire device tree in flat space.
5098 * hw.bus.rman Resource manager interface
5100 * We might like to add the ability to scan devclasses and/or drivers to
5101 * determine what else is currently loaded/available.
5105 sysctl_bus(SYSCTL_HANDLER_ARGS)
5107 struct u_businfo ubus;
5109 ubus.ub_version = BUS_USER_VERSION;
5110 ubus.ub_generation = bus_data_generation;
5112 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5114 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5115 "bus-related data");
5118 sysctl_devices(SYSCTL_HANDLER_ARGS)
5120 int *name = (int *)arg1;
5121 u_int namelen = arg2;
5124 struct u_device udev; /* XXX this is a bit big */
5130 if (bus_data_generation_check(name[0]))
5136 * Scan the list of devices, looking for the requested index.
5138 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5146 * Populate the return array.
5148 bzero(&udev, sizeof(udev));
5149 udev.dv_handle = (uintptr_t)dev;
5150 udev.dv_parent = (uintptr_t)dev->parent;
5151 if (dev->nameunit != NULL)
5152 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
5153 if (dev->desc != NULL)
5154 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
5155 if (dev->driver != NULL && dev->driver->name != NULL)
5156 strlcpy(udev.dv_drivername, dev->driver->name,
5157 sizeof(udev.dv_drivername));
5158 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
5159 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
5160 udev.dv_devflags = dev->devflags;
5161 udev.dv_flags = dev->flags;
5162 udev.dv_state = dev->state;
5163 error = SYSCTL_OUT(req, &udev, sizeof(udev));
5167 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5168 "system device tree");
5171 bus_data_generation_check(int generation)
5173 if (generation != bus_data_generation)
5176 /* XXX generate optimised lists here? */
5181 bus_data_generation_update(void)
5183 bus_data_generation++;
5187 bus_free_resource(device_t dev, int type, struct resource *r)
5191 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5195 device_lookup_by_name(const char *name)
5199 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5200 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5207 * /dev/devctl2 implementation. The existing /dev/devctl device has
5208 * implicit semantics on open, so it could not be reused for this.
5209 * Another option would be to call this /dev/bus?
5212 find_device(struct devreq *req, device_t *devp)
5217 * First, ensure that the name is nul terminated.
5219 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5223 * Second, try to find an attached device whose name matches
5226 dev = device_lookup_by_name(req->dr_name);
5232 /* Finally, give device enumerators a chance. */
5234 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev);
5242 driver_exists(device_t bus, const char *driver)
5246 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5247 if (devclass_find_driver_internal(dc, driver) != NULL)
5254 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5261 /* Locate the device to control. */
5263 req = (struct devreq *)data;
5271 case DEV_SET_DRIVER:
5274 error = priv_check(td, PRIV_DRIVER);
5276 error = find_device(req, &dev);
5287 /* Perform the requested operation. */
5290 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5292 else if (!device_is_enabled(dev))
5295 error = device_probe_and_attach(dev);
5298 if (!device_is_attached(dev)) {
5302 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5303 error = device_quiesce(dev);
5307 error = device_detach(dev);
5310 if (device_is_enabled(dev)) {
5316 * If the device has been probed but not attached (e.g.
5317 * when it has been disabled by a loader hint), just
5318 * attach the device rather than doing a full probe.
5321 if (device_is_alive(dev)) {
5323 * If the device was disabled via a hint, clear
5326 if (resource_disabled(dev->driver->name, dev->unit))
5327 resource_unset_value(dev->driver->name,
5328 dev->unit, "disabled");
5329 error = device_attach(dev);
5331 error = device_probe_and_attach(dev);
5334 if (!device_is_enabled(dev)) {
5339 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5340 error = device_quiesce(dev);
5346 * Force DF_FIXEDCLASS on around detach to preserve
5347 * the existing name.
5350 dev->flags |= DF_FIXEDCLASS;
5351 error = device_detach(dev);
5352 if (!(old & DF_FIXEDCLASS))
5353 dev->flags &= ~DF_FIXEDCLASS;
5355 device_disable(dev);
5358 if (device_is_suspended(dev)) {
5362 if (device_get_parent(dev) == NULL) {
5366 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5369 if (!device_is_suspended(dev)) {
5373 if (device_get_parent(dev) == NULL) {
5377 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5379 case DEV_SET_DRIVER: {
5383 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5386 if (driver[0] == '\0') {
5390 if (dev->devclass != NULL &&
5391 strcmp(driver, dev->devclass->name) == 0)
5392 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5396 * Scan drivers for this device's bus looking for at
5397 * least one matching driver.
5399 if (dev->parent == NULL) {
5403 if (!driver_exists(dev->parent, driver)) {
5407 dc = devclass_create(driver);
5413 /* Detach device if necessary. */
5414 if (device_is_attached(dev)) {
5415 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5416 error = device_detach(dev);
5423 /* Clear any previously-fixed device class and unit. */
5424 if (dev->flags & DF_FIXEDCLASS)
5425 devclass_delete_device(dev->devclass, dev);
5426 dev->flags |= DF_WILDCARD;
5429 /* Force the new device class. */
5430 error = devclass_add_device(dc, dev);
5433 dev->flags |= DF_FIXEDCLASS;
5434 error = device_probe_and_attach(dev);
5438 if (!device_is_attached(dev)) {
5442 error = BUS_RESCAN(dev);
5447 parent = device_get_parent(dev);
5448 if (parent == NULL) {
5452 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5453 if (bus_child_present(dev) != 0) {
5459 error = device_delete_child(parent, dev);
5467 static struct cdevsw devctl2_cdevsw = {
5468 .d_version = D_VERSION,
5469 .d_ioctl = devctl2_ioctl,
5470 .d_name = "devctl2",
5477 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5478 UID_ROOT, GID_WHEEL, 0600, "devctl2");