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/cpuset.h>
61 #include <machine/cpu.h>
62 #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)
865 if (*src == '"' || *src == '\\') {
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 /* detach parent before deleting children, if any */
1952 if ((error = device_detach(child)) != 0)
1955 /* remove children second */
1956 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1957 error = device_delete_child(child, grandchild);
1962 if (child->devclass)
1963 devclass_delete_device(child->devclass, child);
1965 BUS_CHILD_DELETED(dev, child);
1966 TAILQ_REMOVE(&dev->children, child, link);
1967 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1968 kobj_delete((kobj_t) child, M_BUS);
1970 bus_data_generation_update();
1975 * @brief Delete all children devices of the given device, if any.
1977 * This function deletes all children devices of the given device, if
1978 * any, using the device_delete_child() function for each device it
1979 * finds. If a child device cannot be deleted, this function will
1980 * return an error code.
1982 * @param dev the parent device
1985 * @retval non-zero a device would not detach
1988 device_delete_children(device_t dev)
1993 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1997 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1998 error = device_delete_child(dev, child);
2000 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2008 * @brief Find a device given a unit number
2010 * This is similar to devclass_get_devices() but only searches for
2011 * devices which have @p dev as a parent.
2013 * @param dev the parent device to search
2014 * @param unit the unit number to search for. If the unit is -1,
2015 * return the first child of @p dev which has name
2016 * @p classname (that is, the one with the lowest unit.)
2018 * @returns the device with the given unit number or @c
2019 * NULL if there is no such device
2022 device_find_child(device_t dev, const char *classname, int unit)
2027 dc = devclass_find(classname);
2032 child = devclass_get_device(dc, unit);
2033 if (child && child->parent == dev)
2036 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2037 child = devclass_get_device(dc, unit);
2038 if (child && child->parent == dev)
2049 first_matching_driver(devclass_t dc, device_t dev)
2052 return (devclass_find_driver_internal(dc, dev->devclass->name));
2053 return (TAILQ_FIRST(&dc->drivers));
2060 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2062 if (dev->devclass) {
2064 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2065 if (!strcmp(dev->devclass->name, dl->driver->name))
2069 return (TAILQ_NEXT(last, link));
2076 device_probe_child(device_t dev, device_t child)
2079 driverlink_t best = NULL;
2081 int result, pri = 0;
2082 int hasclass = (child->devclass != NULL);
2088 panic("device_probe_child: parent device has no devclass");
2091 * If the state is already probed, then return. However, don't
2092 * return if we can rebid this object.
2094 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2097 for (; dc; dc = dc->parent) {
2098 for (dl = first_matching_driver(dc, child);
2100 dl = next_matching_driver(dc, child, dl)) {
2101 /* If this driver's pass is too high, then ignore it. */
2102 if (dl->pass > bus_current_pass)
2105 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2106 result = device_set_driver(child, dl->driver);
2107 if (result == ENOMEM)
2109 else if (result != 0)
2112 if (device_set_devclass(child,
2113 dl->driver->name) != 0) {
2114 char const * devname =
2115 device_get_name(child);
2116 if (devname == NULL)
2117 devname = "(unknown)";
2118 printf("driver bug: Unable to set "
2119 "devclass (class: %s "
2123 (void)device_set_driver(child, NULL);
2128 /* Fetch any flags for the device before probing. */
2129 resource_int_value(dl->driver->name, child->unit,
2130 "flags", &child->devflags);
2132 result = DEVICE_PROBE(child);
2134 /* Reset flags and devclass before the next probe. */
2135 child->devflags = 0;
2137 (void)device_set_devclass(child, NULL);
2140 * If the driver returns SUCCESS, there can be
2141 * no higher match for this device.
2150 * Reset DF_QUIET in case this driver doesn't
2151 * end up as the best driver.
2153 device_verbose(child);
2156 * Probes that return BUS_PROBE_NOWILDCARD or lower
2157 * only match on devices whose driver was explicitly
2160 if (result <= BUS_PROBE_NOWILDCARD &&
2161 !(child->flags & DF_FIXEDCLASS)) {
2166 * The driver returned an error so it
2167 * certainly doesn't match.
2170 (void)device_set_driver(child, NULL);
2175 * A priority lower than SUCCESS, remember the
2176 * best matching driver. Initialise the value
2177 * of pri for the first match.
2179 if (best == NULL || result > pri) {
2186 * If we have an unambiguous match in this devclass,
2187 * don't look in the parent.
2189 if (best && pri == 0)
2194 * If we found a driver, change state and initialise the devclass.
2196 /* XXX What happens if we rebid and got no best? */
2199 * If this device was attached, and we were asked to
2200 * rescan, and it is a different driver, then we have
2201 * to detach the old driver and reattach this new one.
2202 * Note, we don't have to check for DF_REBID here
2203 * because if the state is > DS_ALIVE, we know it must
2206 * This assumes that all DF_REBID drivers can have
2207 * their probe routine called at any time and that
2208 * they are idempotent as well as completely benign in
2209 * normal operations.
2211 * We also have to make sure that the detach
2212 * succeeded, otherwise we fail the operation (or
2213 * maybe it should just fail silently? I'm torn).
2215 if (child->state > DS_ALIVE && best->driver != child->driver)
2216 if ((result = device_detach(dev)) != 0)
2219 /* Set the winning driver, devclass, and flags. */
2220 if (!child->devclass) {
2221 result = device_set_devclass(child, best->driver->name);
2225 result = device_set_driver(child, best->driver);
2228 resource_int_value(best->driver->name, child->unit,
2229 "flags", &child->devflags);
2233 * A bit bogus. Call the probe method again to make
2234 * sure that we have the right description.
2236 DEVICE_PROBE(child);
2238 child->flags |= DF_REBID;
2241 child->flags &= ~DF_REBID;
2242 child->state = DS_ALIVE;
2244 bus_data_generation_update();
2252 * @brief Return the parent of a device
2255 device_get_parent(device_t dev)
2257 return (dev->parent);
2261 * @brief Get a list of children of a device
2263 * An array containing a list of all the children of the given device
2264 * is allocated and returned in @p *devlistp. The number of devices
2265 * in the array is returned in @p *devcountp. The caller should free
2266 * the array using @c free(p, M_TEMP).
2268 * @param dev the device to examine
2269 * @param devlistp points at location for array pointer return
2271 * @param devcountp points at location for array size return value
2274 * @retval ENOMEM the array allocation failed
2277 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2284 TAILQ_FOREACH(child, &dev->children, link) {
2293 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2298 TAILQ_FOREACH(child, &dev->children, link) {
2299 list[count] = child;
2310 * @brief Return the current driver for the device or @c NULL if there
2311 * is no driver currently attached
2314 device_get_driver(device_t dev)
2316 return (dev->driver);
2320 * @brief Return the current devclass for the device or @c NULL if
2324 device_get_devclass(device_t dev)
2326 return (dev->devclass);
2330 * @brief Return the name of the device's devclass or @c NULL if there
2334 device_get_name(device_t dev)
2336 if (dev != NULL && dev->devclass)
2337 return (devclass_get_name(dev->devclass));
2342 * @brief Return a string containing the device's devclass name
2343 * followed by an ascii representation of the device's unit number
2347 device_get_nameunit(device_t dev)
2349 return (dev->nameunit);
2353 * @brief Return the device's unit number.
2356 device_get_unit(device_t dev)
2362 * @brief Return the device's description string
2365 device_get_desc(device_t dev)
2371 * @brief Return the device's flags
2374 device_get_flags(device_t dev)
2376 return (dev->devflags);
2379 struct sysctl_ctx_list *
2380 device_get_sysctl_ctx(device_t dev)
2382 return (&dev->sysctl_ctx);
2386 device_get_sysctl_tree(device_t dev)
2388 return (dev->sysctl_tree);
2392 * @brief Print the name of the device followed by a colon and a space
2394 * @returns the number of characters printed
2397 device_print_prettyname(device_t dev)
2399 const char *name = device_get_name(dev);
2402 return (printf("unknown: "));
2403 return (printf("%s%d: ", name, device_get_unit(dev)));
2407 * @brief Print the name of the device followed by a colon, a space
2408 * and the result of calling vprintf() with the value of @p fmt and
2409 * the following arguments.
2411 * @returns the number of characters printed
2414 device_printf(device_t dev, const char * fmt, ...)
2419 retval = device_print_prettyname(dev);
2421 retval += vprintf(fmt, ap);
2430 device_set_desc_internal(device_t dev, const char* desc, int copy)
2432 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2433 free(dev->desc, M_BUS);
2434 dev->flags &= ~DF_DESCMALLOCED;
2439 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2441 strcpy(dev->desc, desc);
2442 dev->flags |= DF_DESCMALLOCED;
2445 /* Avoid a -Wcast-qual warning */
2446 dev->desc = (char *)(uintptr_t) desc;
2449 bus_data_generation_update();
2453 * @brief Set the device's description
2455 * The value of @c desc should be a string constant that will not
2456 * change (at least until the description is changed in a subsequent
2457 * call to device_set_desc() or device_set_desc_copy()).
2460 device_set_desc(device_t dev, const char* desc)
2462 device_set_desc_internal(dev, desc, FALSE);
2466 * @brief Set the device's description
2468 * The string pointed to by @c desc is copied. Use this function if
2469 * the device description is generated, (e.g. with sprintf()).
2472 device_set_desc_copy(device_t dev, const char* desc)
2474 device_set_desc_internal(dev, desc, TRUE);
2478 * @brief Set the device's flags
2481 device_set_flags(device_t dev, uint32_t flags)
2483 dev->devflags = flags;
2487 * @brief Return the device's softc field
2489 * The softc is allocated and zeroed when a driver is attached, based
2490 * on the size field of the driver.
2493 device_get_softc(device_t dev)
2495 return (dev->softc);
2499 * @brief Set the device's softc field
2501 * Most drivers do not need to use this since the softc is allocated
2502 * automatically when the driver is attached.
2505 device_set_softc(device_t dev, void *softc)
2507 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2508 free(dev->softc, M_BUS_SC);
2511 dev->flags |= DF_EXTERNALSOFTC;
2513 dev->flags &= ~DF_EXTERNALSOFTC;
2517 * @brief Free claimed softc
2519 * Most drivers do not need to use this since the softc is freed
2520 * automatically when the driver is detached.
2523 device_free_softc(void *softc)
2525 free(softc, M_BUS_SC);
2529 * @brief Claim softc
2531 * This function can be used to let the driver free the automatically
2532 * allocated softc using "device_free_softc()". This function is
2533 * useful when the driver is refcounting the softc and the softc
2534 * cannot be freed when the "device_detach" method is called.
2537 device_claim_softc(device_t dev)
2540 dev->flags |= DF_EXTERNALSOFTC;
2542 dev->flags &= ~DF_EXTERNALSOFTC;
2546 * @brief Get the device's ivars field
2548 * The ivars field is used by the parent device to store per-device
2549 * state (e.g. the physical location of the device or a list of
2553 device_get_ivars(device_t dev)
2556 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2557 return (dev->ivars);
2561 * @brief Set the device's ivars field
2564 device_set_ivars(device_t dev, void * ivars)
2567 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2572 * @brief Return the device's state
2575 device_get_state(device_t dev)
2577 return (dev->state);
2581 * @brief Set the DF_ENABLED flag for the device
2584 device_enable(device_t dev)
2586 dev->flags |= DF_ENABLED;
2590 * @brief Clear the DF_ENABLED flag for the device
2593 device_disable(device_t dev)
2595 dev->flags &= ~DF_ENABLED;
2599 * @brief Increment the busy counter for the device
2602 device_busy(device_t dev)
2604 if (dev->state < DS_ATTACHING)
2605 panic("device_busy: called for unattached device");
2606 if (dev->busy == 0 && dev->parent)
2607 device_busy(dev->parent);
2609 if (dev->state == DS_ATTACHED)
2610 dev->state = DS_BUSY;
2614 * @brief Decrement the busy counter for the device
2617 device_unbusy(device_t dev)
2619 if (dev->busy != 0 && dev->state != DS_BUSY &&
2620 dev->state != DS_ATTACHING)
2621 panic("device_unbusy: called for non-busy device %s",
2622 device_get_nameunit(dev));
2624 if (dev->busy == 0) {
2626 device_unbusy(dev->parent);
2627 if (dev->state == DS_BUSY)
2628 dev->state = DS_ATTACHED;
2633 * @brief Set the DF_QUIET flag for the device
2636 device_quiet(device_t dev)
2638 dev->flags |= DF_QUIET;
2642 * @brief Clear the DF_QUIET flag for the device
2645 device_verbose(device_t dev)
2647 dev->flags &= ~DF_QUIET;
2651 * @brief Return non-zero if the DF_QUIET flag is set on the device
2654 device_is_quiet(device_t dev)
2656 return ((dev->flags & DF_QUIET) != 0);
2660 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2663 device_is_enabled(device_t dev)
2665 return ((dev->flags & DF_ENABLED) != 0);
2669 * @brief Return non-zero if the device was successfully probed
2672 device_is_alive(device_t dev)
2674 return (dev->state >= DS_ALIVE);
2678 * @brief Return non-zero if the device currently has a driver
2682 device_is_attached(device_t dev)
2684 return (dev->state >= DS_ATTACHED);
2688 * @brief Return non-zero if the device is currently suspended.
2691 device_is_suspended(device_t dev)
2693 return ((dev->flags & DF_SUSPENDED) != 0);
2697 * @brief Set the devclass of a device
2698 * @see devclass_add_device().
2701 device_set_devclass(device_t dev, const char *classname)
2708 devclass_delete_device(dev->devclass, dev);
2712 if (dev->devclass) {
2713 printf("device_set_devclass: device class already set\n");
2717 dc = devclass_find_internal(classname, NULL, TRUE);
2721 error = devclass_add_device(dc, dev);
2723 bus_data_generation_update();
2728 * @brief Set the devclass of a device and mark the devclass fixed.
2729 * @see device_set_devclass()
2732 device_set_devclass_fixed(device_t dev, const char *classname)
2736 if (classname == NULL)
2739 error = device_set_devclass(dev, classname);
2742 dev->flags |= DF_FIXEDCLASS;
2747 * @brief Set the driver of a device
2750 * @retval EBUSY the device already has a driver attached
2751 * @retval ENOMEM a memory allocation failure occurred
2754 device_set_driver(device_t dev, driver_t *driver)
2756 if (dev->state >= DS_ATTACHED)
2759 if (dev->driver == driver)
2762 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2763 free(dev->softc, M_BUS_SC);
2766 device_set_desc(dev, NULL);
2767 kobj_delete((kobj_t) dev, NULL);
2768 dev->driver = driver;
2770 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2771 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2772 dev->softc = malloc(driver->size, M_BUS_SC,
2775 kobj_delete((kobj_t) dev, NULL);
2776 kobj_init((kobj_t) dev, &null_class);
2782 kobj_init((kobj_t) dev, &null_class);
2785 bus_data_generation_update();
2790 * @brief Probe a device, and return this status.
2792 * This function is the core of the device autoconfiguration
2793 * system. Its purpose is to select a suitable driver for a device and
2794 * then call that driver to initialise the hardware appropriately. The
2795 * driver is selected by calling the DEVICE_PROBE() method of a set of
2796 * candidate drivers and then choosing the driver which returned the
2797 * best value. This driver is then attached to the device using
2800 * The set of suitable drivers is taken from the list of drivers in
2801 * the parent device's devclass. If the device was originally created
2802 * with a specific class name (see device_add_child()), only drivers
2803 * with that name are probed, otherwise all drivers in the devclass
2804 * are probed. If no drivers return successful probe values in the
2805 * parent devclass, the search continues in the parent of that
2806 * devclass (see devclass_get_parent()) if any.
2808 * @param dev the device to initialise
2811 * @retval ENXIO no driver was found
2812 * @retval ENOMEM memory allocation failure
2813 * @retval non-zero some other unix error code
2814 * @retval -1 Device already attached
2817 device_probe(device_t dev)
2823 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2826 if (!(dev->flags & DF_ENABLED)) {
2827 if (bootverbose && device_get_name(dev) != NULL) {
2828 device_print_prettyname(dev);
2829 printf("not probed (disabled)\n");
2833 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2834 if (bus_current_pass == BUS_PASS_DEFAULT &&
2835 !(dev->flags & DF_DONENOMATCH)) {
2836 BUS_PROBE_NOMATCH(dev->parent, dev);
2838 dev->flags |= DF_DONENOMATCH;
2846 * @brief Probe a device and attach a driver if possible
2848 * calls device_probe() and attaches if that was successful.
2851 device_probe_and_attach(device_t dev)
2857 error = device_probe(dev);
2860 else if (error != 0)
2863 CURVNET_SET_QUIET(vnet0);
2864 error = device_attach(dev);
2870 * @brief Attach a device driver to a device
2872 * This function is a wrapper around the DEVICE_ATTACH() driver
2873 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2874 * device's sysctl tree, optionally prints a description of the device
2875 * and queues a notification event for user-based device management
2878 * Normally this function is only called internally from
2879 * device_probe_and_attach().
2881 * @param dev the device to initialise
2884 * @retval ENXIO no driver was found
2885 * @retval ENOMEM memory allocation failure
2886 * @retval non-zero some other unix error code
2889 device_attach(device_t dev)
2891 uint64_t attachtime;
2894 if (resource_disabled(dev->driver->name, dev->unit)) {
2895 device_disable(dev);
2897 device_printf(dev, "disabled via hints entry\n");
2901 device_sysctl_init(dev);
2902 if (!device_is_quiet(dev))
2903 device_print_child(dev->parent, dev);
2904 attachtime = get_cyclecount();
2905 dev->state = DS_ATTACHING;
2906 if ((error = DEVICE_ATTACH(dev)) != 0) {
2907 printf("device_attach: %s%d attach returned %d\n",
2908 dev->driver->name, dev->unit, error);
2909 if (!(dev->flags & DF_FIXEDCLASS))
2910 devclass_delete_device(dev->devclass, dev);
2911 (void)device_set_driver(dev, NULL);
2912 device_sysctl_fini(dev);
2913 KASSERT(dev->busy == 0, ("attach failed but busy"));
2914 dev->state = DS_NOTPRESENT;
2917 attachtime = get_cyclecount() - attachtime;
2919 * 4 bits per device is a reasonable value for desktop and server
2920 * hardware with good get_cyclecount() implementations, but WILL
2921 * need to be adjusted on other platforms.
2923 #define RANDOM_PROBE_BIT_GUESS 4
2925 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2926 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2927 dev->driver->name, dev->unit);
2928 random_harvest_direct(&attachtime, sizeof(attachtime),
2929 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2930 device_sysctl_update(dev);
2932 dev->state = DS_BUSY;
2934 dev->state = DS_ATTACHED;
2935 dev->flags &= ~DF_DONENOMATCH;
2936 EVENTHANDLER_INVOKE(device_attach, dev);
2942 * @brief Detach a driver from a device
2944 * This function is a wrapper around the DEVICE_DETACH() driver
2945 * method. If the call to DEVICE_DETACH() succeeds, it calls
2946 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2947 * notification event for user-based device management services and
2948 * cleans up the device's sysctl tree.
2950 * @param dev the device to un-initialise
2953 * @retval ENXIO no driver was found
2954 * @retval ENOMEM memory allocation failure
2955 * @retval non-zero some other unix error code
2958 device_detach(device_t dev)
2964 PDEBUG(("%s", DEVICENAME(dev)));
2965 if (dev->state == DS_BUSY)
2967 if (dev->state == DS_ATTACHING) {
2968 device_printf(dev, "device in attaching state! Deferring detach.\n");
2971 if (dev->state != DS_ATTACHED)
2974 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
2975 if ((error = DEVICE_DETACH(dev)) != 0) {
2976 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_FAILED);
2979 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_COMPLETE);
2982 if (!device_is_quiet(dev))
2983 device_printf(dev, "detached\n");
2985 BUS_CHILD_DETACHED(dev->parent, dev);
2987 if (!(dev->flags & DF_FIXEDCLASS))
2988 devclass_delete_device(dev->devclass, dev);
2990 device_verbose(dev);
2991 dev->state = DS_NOTPRESENT;
2992 (void)device_set_driver(dev, NULL);
2993 device_sysctl_fini(dev);
2999 * @brief Tells a driver to quiesce itself.
3001 * This function is a wrapper around the DEVICE_QUIESCE() driver
3002 * method. If the call to DEVICE_QUIESCE() succeeds.
3004 * @param dev the device to quiesce
3007 * @retval ENXIO no driver was found
3008 * @retval ENOMEM memory allocation failure
3009 * @retval non-zero some other unix error code
3012 device_quiesce(device_t dev)
3015 PDEBUG(("%s", DEVICENAME(dev)));
3016 if (dev->state == DS_BUSY)
3018 if (dev->state != DS_ATTACHED)
3021 return (DEVICE_QUIESCE(dev));
3025 * @brief Notify a device of system shutdown
3027 * This function calls the DEVICE_SHUTDOWN() driver method if the
3028 * device currently has an attached driver.
3030 * @returns the value returned by DEVICE_SHUTDOWN()
3033 device_shutdown(device_t dev)
3035 if (dev->state < DS_ATTACHED)
3037 return (DEVICE_SHUTDOWN(dev));
3041 * @brief Set the unit number of a device
3043 * This function can be used to override the unit number used for a
3044 * device (e.g. to wire a device to a pre-configured unit number).
3047 device_set_unit(device_t dev, int unit)
3052 dc = device_get_devclass(dev);
3053 if (unit < dc->maxunit && dc->devices[unit])
3055 err = devclass_delete_device(dc, dev);
3059 err = devclass_add_device(dc, dev);
3063 bus_data_generation_update();
3067 /*======================================*/
3069 * Some useful method implementations to make life easier for bus drivers.
3073 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3078 args->memattr = VM_MEMATTR_UNCACHEABLE;
3082 * @brief Initialise a resource list.
3084 * @param rl the resource list to initialise
3087 resource_list_init(struct resource_list *rl)
3093 * @brief Reclaim memory used by a resource list.
3095 * This function frees the memory for all resource entries on the list
3098 * @param rl the resource list to free
3101 resource_list_free(struct resource_list *rl)
3103 struct resource_list_entry *rle;
3105 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3107 panic("resource_list_free: resource entry is busy");
3108 STAILQ_REMOVE_HEAD(rl, link);
3114 * @brief Add a resource entry.
3116 * This function adds a resource entry using the given @p type, @p
3117 * start, @p end and @p count values. A rid value is chosen by
3118 * searching sequentially for the first unused rid starting at zero.
3120 * @param rl the resource list to edit
3121 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
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
3127 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3128 rman_res_t end, rman_res_t count)
3133 while (resource_list_find(rl, type, rid) != NULL)
3135 resource_list_add(rl, type, rid, start, end, count);
3140 * @brief Add or modify a resource entry.
3142 * If an existing entry exists with the same type and rid, it will be
3143 * modified using the given values of @p start, @p end and @p
3144 * count. If no entry exists, a new one will be created using the
3145 * given values. The resource list entry that matches is then returned.
3147 * @param rl the resource list to edit
3148 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3149 * @param rid the resource identifier
3150 * @param start the start address of the resource
3151 * @param end the end address of the resource
3152 * @param count XXX end-start+1
3154 struct resource_list_entry *
3155 resource_list_add(struct resource_list *rl, int type, int rid,
3156 rman_res_t start, rman_res_t end, rman_res_t count)
3158 struct resource_list_entry *rle;
3160 rle = resource_list_find(rl, type, rid);
3162 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3165 panic("resource_list_add: can't record entry");
3166 STAILQ_INSERT_TAIL(rl, rle, link);
3174 panic("resource_list_add: resource entry is busy");
3183 * @brief Determine if a resource entry is busy.
3185 * Returns true if a resource entry is busy meaning that it has an
3186 * associated resource that is not an unallocated "reserved" resource.
3188 * @param rl the resource list to search
3189 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3190 * @param rid the resource identifier
3192 * @returns Non-zero if the entry is busy, zero otherwise.
3195 resource_list_busy(struct resource_list *rl, int type, int rid)
3197 struct resource_list_entry *rle;
3199 rle = resource_list_find(rl, type, rid);
3200 if (rle == NULL || rle->res == NULL)
3202 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3203 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3204 ("reserved resource is active"));
3211 * @brief Determine if a resource entry is reserved.
3213 * Returns true if a resource entry is reserved meaning that it has an
3214 * associated "reserved" resource. The resource can either be
3215 * allocated or unallocated.
3217 * @param rl the resource list to search
3218 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3219 * @param rid the resource identifier
3221 * @returns Non-zero if the entry is reserved, zero otherwise.
3224 resource_list_reserved(struct resource_list *rl, int type, int rid)
3226 struct resource_list_entry *rle;
3228 rle = resource_list_find(rl, type, rid);
3229 if (rle != NULL && rle->flags & RLE_RESERVED)
3235 * @brief Find a resource entry by type and rid.
3237 * @param rl the resource list to search
3238 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3239 * @param rid the resource identifier
3241 * @returns the resource entry pointer or NULL if there is no such
3244 struct resource_list_entry *
3245 resource_list_find(struct resource_list *rl, int type, int rid)
3247 struct resource_list_entry *rle;
3249 STAILQ_FOREACH(rle, rl, link) {
3250 if (rle->type == type && rle->rid == rid)
3257 * @brief Delete a resource entry.
3259 * @param rl the resource list to edit
3260 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3261 * @param rid the resource identifier
3264 resource_list_delete(struct resource_list *rl, int type, int rid)
3266 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3269 if (rle->res != NULL)
3270 panic("resource_list_delete: resource has not been released");
3271 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3277 * @brief Allocate a reserved resource
3279 * This can be used by busses to force the allocation of resources
3280 * that are always active in the system even if they are not allocated
3281 * by a driver (e.g. PCI BARs). This function is usually called when
3282 * adding a new child to the bus. The resource is allocated from the
3283 * parent bus when it is reserved. The resource list entry is marked
3284 * with RLE_RESERVED to note that it is a reserved resource.
3286 * Subsequent attempts to allocate the resource with
3287 * resource_list_alloc() will succeed the first time and will set
3288 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3289 * resource that has been allocated is released with
3290 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3291 * the actual resource remains allocated. The resource can be released to
3292 * the parent bus by calling resource_list_unreserve().
3294 * @param rl the resource list to allocate from
3295 * @param bus the parent device of @p child
3296 * @param child the device for which the resource is being reserved
3297 * @param type the type of resource to allocate
3298 * @param rid a pointer to the resource identifier
3299 * @param start hint at the start of the resource range - pass
3300 * @c 0 for any start address
3301 * @param end hint at the end of the resource range - pass
3302 * @c ~0 for any end address
3303 * @param count hint at the size of range required - pass @c 1
3305 * @param flags any extra flags to control the resource
3306 * allocation - see @c RF_XXX flags in
3307 * <sys/rman.h> for details
3309 * @returns the resource which was allocated or @c NULL if no
3310 * resource could be allocated
3313 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3314 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3316 struct resource_list_entry *rle = NULL;
3317 int passthrough = (device_get_parent(child) != bus);
3322 "resource_list_reserve() should only be called for direct children");
3323 if (flags & RF_ACTIVE)
3325 "resource_list_reserve() should only reserve inactive resources");
3327 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3330 rle = resource_list_find(rl, type, *rid);
3331 rle->flags |= RLE_RESERVED;
3337 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3339 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3340 * and passing the allocation up to the parent of @p bus. This assumes
3341 * that the first entry of @c device_get_ivars(child) is a struct
3342 * resource_list. This also handles 'passthrough' allocations where a
3343 * child is a remote descendant of bus by passing the allocation up to
3344 * the parent of bus.
3346 * Typically, a bus driver would store a list of child resources
3347 * somewhere in the child device's ivars (see device_get_ivars()) and
3348 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3349 * then call resource_list_alloc() to perform the allocation.
3351 * @param rl the resource list to allocate from
3352 * @param bus the parent device of @p child
3353 * @param child the device which is requesting an allocation
3354 * @param type the type of resource to allocate
3355 * @param rid a pointer to the resource identifier
3356 * @param start hint at the start of the resource range - pass
3357 * @c 0 for any start address
3358 * @param end hint at the end of the resource range - pass
3359 * @c ~0 for any end address
3360 * @param count hint at the size of range required - pass @c 1
3362 * @param flags any extra flags to control the resource
3363 * allocation - see @c RF_XXX flags in
3364 * <sys/rman.h> for details
3366 * @returns the resource which was allocated or @c NULL if no
3367 * resource could be allocated
3370 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3371 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3373 struct resource_list_entry *rle = NULL;
3374 int passthrough = (device_get_parent(child) != bus);
3375 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3378 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3379 type, rid, start, end, count, flags));
3382 rle = resource_list_find(rl, type, *rid);
3385 return (NULL); /* no resource of that type/rid */
3388 if (rle->flags & RLE_RESERVED) {
3389 if (rle->flags & RLE_ALLOCATED)
3391 if ((flags & RF_ACTIVE) &&
3392 bus_activate_resource(child, type, *rid,
3395 rle->flags |= RLE_ALLOCATED;
3399 "resource entry %#x type %d for child %s is busy\n", *rid,
3400 type, device_get_nameunit(child));
3406 count = ulmax(count, rle->count);
3407 end = ulmax(rle->end, start + count - 1);
3410 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3411 type, rid, start, end, count, flags);
3414 * Record the new range.
3417 rle->start = rman_get_start(rle->res);
3418 rle->end = rman_get_end(rle->res);
3426 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3428 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3429 * used with resource_list_alloc().
3431 * @param rl the resource list which was allocated from
3432 * @param bus the parent device of @p child
3433 * @param child the device which is requesting a release
3434 * @param type the type of resource to release
3435 * @param rid the resource identifier
3436 * @param res the resource to release
3439 * @retval non-zero a standard unix error code indicating what
3440 * error condition prevented the operation
3443 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3444 int type, int rid, struct resource *res)
3446 struct resource_list_entry *rle = NULL;
3447 int passthrough = (device_get_parent(child) != bus);
3451 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3455 rle = resource_list_find(rl, type, rid);
3458 panic("resource_list_release: can't find resource");
3460 panic("resource_list_release: resource entry is not busy");
3461 if (rle->flags & RLE_RESERVED) {
3462 if (rle->flags & RLE_ALLOCATED) {
3463 if (rman_get_flags(res) & RF_ACTIVE) {
3464 error = bus_deactivate_resource(child, type,
3469 rle->flags &= ~RLE_ALLOCATED;
3475 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3485 * @brief Release all active resources of a given type
3487 * Release all active resources of a specified type. This is intended
3488 * to be used to cleanup resources leaked by a driver after detach or
3491 * @param rl the resource list which was allocated from
3492 * @param bus the parent device of @p child
3493 * @param child the device whose active resources are being released
3494 * @param type the type of resources to release
3497 * @retval EBUSY at least one resource was active
3500 resource_list_release_active(struct resource_list *rl, device_t bus,
3501 device_t child, int type)
3503 struct resource_list_entry *rle;
3507 STAILQ_FOREACH(rle, rl, link) {
3508 if (rle->type != type)
3510 if (rle->res == NULL)
3512 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3516 error = resource_list_release(rl, bus, child, type,
3517 rman_get_rid(rle->res), rle->res);
3520 "Failed to release active resource: %d\n", error);
3527 * @brief Fully release a reserved resource
3529 * Fully releases a resource reserved via resource_list_reserve().
3531 * @param rl the resource list which was allocated from
3532 * @param bus the parent device of @p child
3533 * @param child the device whose reserved resource is being released
3534 * @param type the type of resource to release
3535 * @param rid the resource identifier
3536 * @param res the resource to release
3539 * @retval non-zero a standard unix error code indicating what
3540 * error condition prevented the operation
3543 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3546 struct resource_list_entry *rle = NULL;
3547 int passthrough = (device_get_parent(child) != bus);
3551 "resource_list_unreserve() should only be called for direct children");
3553 rle = resource_list_find(rl, type, rid);
3556 panic("resource_list_unreserve: can't find resource");
3557 if (!(rle->flags & RLE_RESERVED))
3559 if (rle->flags & RLE_ALLOCATED)
3561 rle->flags &= ~RLE_RESERVED;
3562 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3566 * @brief Print a description of resources in a resource list
3568 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3569 * The name is printed if at least one resource of the given type is available.
3570 * The format is used to print resource start and end.
3572 * @param rl the resource list to print
3573 * @param name the name of @p type, e.g. @c "memory"
3574 * @param type type type of resource entry to print
3575 * @param format printf(9) format string to print resource
3576 * start and end values
3578 * @returns the number of characters printed
3581 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3584 struct resource_list_entry *rle;
3585 int printed, retval;
3589 /* Yes, this is kinda cheating */
3590 STAILQ_FOREACH(rle, rl, link) {
3591 if (rle->type == type) {
3593 retval += printf(" %s ", name);
3595 retval += printf(",");
3597 retval += printf(format, rle->start);
3598 if (rle->count > 1) {
3599 retval += printf("-");
3600 retval += printf(format, rle->start +
3609 * @brief Releases all the resources in a list.
3611 * @param rl The resource list to purge.
3616 resource_list_purge(struct resource_list *rl)
3618 struct resource_list_entry *rle;
3620 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3622 bus_release_resource(rman_get_device(rle->res),
3623 rle->type, rle->rid, rle->res);
3624 STAILQ_REMOVE_HEAD(rl, link);
3630 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3633 return (device_add_child_ordered(dev, order, name, unit));
3637 * @brief Helper function for implementing DEVICE_PROBE()
3639 * This function can be used to help implement the DEVICE_PROBE() for
3640 * a bus (i.e. a device which has other devices attached to it). It
3641 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3645 bus_generic_probe(device_t dev)
3647 devclass_t dc = dev->devclass;
3650 TAILQ_FOREACH(dl, &dc->drivers, link) {
3652 * If this driver's pass is too high, then ignore it.
3653 * For most drivers in the default pass, this will
3654 * never be true. For early-pass drivers they will
3655 * only call the identify routines of eligible drivers
3656 * when this routine is called. Drivers for later
3657 * passes should have their identify routines called
3658 * on early-pass busses during BUS_NEW_PASS().
3660 if (dl->pass > bus_current_pass)
3662 DEVICE_IDENTIFY(dl->driver, dev);
3669 * @brief Helper function for implementing DEVICE_ATTACH()
3671 * This function can be used to help implement the DEVICE_ATTACH() for
3672 * a bus. It calls device_probe_and_attach() for each of the device's
3676 bus_generic_attach(device_t dev)
3680 TAILQ_FOREACH(child, &dev->children, link) {
3681 device_probe_and_attach(child);
3688 * @brief Helper function for implementing DEVICE_DETACH()
3690 * This function can be used to help implement the DEVICE_DETACH() for
3691 * a bus. It calls device_detach() for each of the device's
3695 bus_generic_detach(device_t dev)
3700 if (dev->state != DS_ATTACHED)
3704 * Detach children in the reverse order.
3705 * See bus_generic_suspend for details.
3707 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3708 if ((error = device_detach(child)) != 0)
3716 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3718 * This function can be used to help implement the DEVICE_SHUTDOWN()
3719 * for a bus. It calls device_shutdown() for each of the device's
3723 bus_generic_shutdown(device_t dev)
3728 * Shut down children in the reverse order.
3729 * See bus_generic_suspend for details.
3731 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3732 device_shutdown(child);
3739 * @brief Default function for suspending a child device.
3741 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3744 bus_generic_suspend_child(device_t dev, device_t child)
3748 error = DEVICE_SUSPEND(child);
3751 child->flags |= DF_SUSPENDED;
3757 * @brief Default function for resuming a child device.
3759 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3762 bus_generic_resume_child(device_t dev, device_t child)
3765 DEVICE_RESUME(child);
3766 child->flags &= ~DF_SUSPENDED;
3772 * @brief Helper function for implementing DEVICE_SUSPEND()
3774 * This function can be used to help implement the DEVICE_SUSPEND()
3775 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3776 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3777 * operation is aborted and any devices which were suspended are
3778 * resumed immediately by calling their DEVICE_RESUME() methods.
3781 bus_generic_suspend(device_t dev)
3787 * Suspend children in the reverse order.
3788 * For most buses all children are equal, so the order does not matter.
3789 * Other buses, such as acpi, carefully order their child devices to
3790 * express implicit dependencies between them. For such buses it is
3791 * safer to bring down devices in the reverse order.
3793 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3794 error = BUS_SUSPEND_CHILD(dev, child);
3796 child = TAILQ_NEXT(child, link);
3797 if (child != NULL) {
3798 TAILQ_FOREACH_FROM(child, &dev->children, link)
3799 BUS_RESUME_CHILD(dev, child);
3808 * @brief Helper function for implementing DEVICE_RESUME()
3810 * This function can be used to help implement the DEVICE_RESUME() for
3811 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3814 bus_generic_resume(device_t dev)
3818 TAILQ_FOREACH(child, &dev->children, link) {
3819 BUS_RESUME_CHILD(dev, child);
3820 /* if resume fails, there's nothing we can usefully do... */
3827 * @brief Helper function for implementing BUS_RESET_POST
3829 * Bus can use this function to implement common operations of
3830 * re-attaching or resuming the children after the bus itself was
3831 * reset, and after restoring bus-unique state of children.
3833 * @param dev The bus
3834 * #param flags DEVF_RESET_*
3837 bus_helper_reset_post(device_t dev, int flags)
3843 TAILQ_FOREACH(child, &dev->children,link) {
3844 BUS_RESET_POST(dev, child);
3845 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3846 device_probe_and_attach(child) :
3847 BUS_RESUME_CHILD(dev, child);
3848 if (error == 0 && error1 != 0)
3855 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3858 child = TAILQ_NEXT(child, link);
3861 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3862 BUS_RESET_POST(dev, child);
3863 if ((flags & DEVF_RESET_DETACH) != 0)
3864 device_probe_and_attach(child);
3866 BUS_RESUME_CHILD(dev, child);
3871 * @brief Helper function for implementing BUS_RESET_PREPARE
3873 * Bus can use this function to implement common operations of
3874 * detaching or suspending the children before the bus itself is
3875 * reset, and then save bus-unique state of children that must
3876 * persists around reset.
3878 * @param dev The bus
3879 * #param flags DEVF_RESET_*
3882 bus_helper_reset_prepare(device_t dev, int flags)
3887 if (dev->state != DS_ATTACHED)
3890 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3891 if ((flags & DEVF_RESET_DETACH) != 0) {
3892 error = device_get_state(child) == DS_ATTACHED ?
3893 device_detach(child) : 0;
3895 error = BUS_SUSPEND_CHILD(dev, child);
3898 error = BUS_RESET_PREPARE(dev, child);
3900 if ((flags & DEVF_RESET_DETACH) != 0)
3901 device_probe_and_attach(child);
3903 BUS_RESUME_CHILD(dev, child);
3907 bus_helper_reset_prepare_rollback(dev, child, flags);
3916 * @brief Helper function for implementing BUS_PRINT_CHILD().
3918 * This function prints the first part of the ascii representation of
3919 * @p child, including its name, unit and description (if any - see
3920 * device_set_desc()).
3922 * @returns the number of characters printed
3925 bus_print_child_header(device_t dev, device_t child)
3929 if (device_get_desc(child)) {
3930 retval += device_printf(child, "<%s>", device_get_desc(child));
3932 retval += printf("%s", device_get_nameunit(child));
3939 * @brief Helper function for implementing BUS_PRINT_CHILD().
3941 * This function prints the last part of the ascii representation of
3942 * @p child, which consists of the string @c " on " followed by the
3943 * name and unit of the @p dev.
3945 * @returns the number of characters printed
3948 bus_print_child_footer(device_t dev, device_t child)
3950 return (printf(" on %s\n", device_get_nameunit(dev)));
3954 * @brief Helper function for implementing BUS_PRINT_CHILD().
3956 * This function prints out the VM domain for the given device.
3958 * @returns the number of characters printed
3961 bus_print_child_domain(device_t dev, device_t child)
3965 /* No domain? Don't print anything */
3966 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3969 return (printf(" numa-domain %d", domain));
3973 * @brief Helper function for implementing BUS_PRINT_CHILD().
3975 * This function simply calls bus_print_child_header() followed by
3976 * bus_print_child_footer().
3978 * @returns the number of characters printed
3981 bus_generic_print_child(device_t dev, device_t child)
3985 retval += bus_print_child_header(dev, child);
3986 retval += bus_print_child_domain(dev, child);
3987 retval += bus_print_child_footer(dev, child);
3993 * @brief Stub function for implementing BUS_READ_IVAR().
3998 bus_generic_read_ivar(device_t dev, device_t child, int index,
4005 * @brief Stub function for implementing BUS_WRITE_IVAR().
4010 bus_generic_write_ivar(device_t dev, device_t child, int index,
4017 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4021 struct resource_list *
4022 bus_generic_get_resource_list(device_t dev, device_t child)
4028 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4030 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4031 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4032 * and then calls device_probe_and_attach() for each unattached child.
4035 bus_generic_driver_added(device_t dev, driver_t *driver)
4039 DEVICE_IDENTIFY(driver, dev);
4040 TAILQ_FOREACH(child, &dev->children, link) {
4041 if (child->state == DS_NOTPRESENT ||
4042 (child->flags & DF_REBID))
4043 device_probe_and_attach(child);
4048 * @brief Helper function for implementing BUS_NEW_PASS().
4050 * This implementing of BUS_NEW_PASS() first calls the identify
4051 * routines for any drivers that probe at the current pass. Then it
4052 * walks the list of devices for this bus. If a device is already
4053 * attached, then it calls BUS_NEW_PASS() on that device. If the
4054 * device is not already attached, it attempts to attach a driver to
4058 bus_generic_new_pass(device_t dev)
4065 TAILQ_FOREACH(dl, &dc->drivers, link) {
4066 if (dl->pass == bus_current_pass)
4067 DEVICE_IDENTIFY(dl->driver, dev);
4069 TAILQ_FOREACH(child, &dev->children, link) {
4070 if (child->state >= DS_ATTACHED)
4071 BUS_NEW_PASS(child);
4072 else if (child->state == DS_NOTPRESENT)
4073 device_probe_and_attach(child);
4078 * @brief Helper function for implementing BUS_SETUP_INTR().
4080 * This simple implementation of BUS_SETUP_INTR() simply calls the
4081 * BUS_SETUP_INTR() method of the parent of @p dev.
4084 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4085 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4088 /* Propagate up the bus hierarchy until someone handles it. */
4090 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4091 filter, intr, arg, cookiep));
4096 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4098 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4099 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4102 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4105 /* Propagate up the bus hierarchy until someone handles it. */
4107 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4112 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4114 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4115 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4118 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4119 struct resource *r, rman_res_t start, rman_res_t end)
4121 /* Propagate up the bus hierarchy until someone handles it. */
4123 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4129 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4131 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4132 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4135 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4136 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4138 /* Propagate up the bus hierarchy until someone handles it. */
4140 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4141 start, end, count, flags));
4146 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4148 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4149 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4152 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4155 /* Propagate up the bus hierarchy until someone handles it. */
4157 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4163 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4165 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4166 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4169 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4172 /* Propagate up the bus hierarchy until someone handles it. */
4174 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4180 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4182 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4183 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4186 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4187 int rid, struct resource *r)
4189 /* Propagate up the bus hierarchy until someone handles it. */
4191 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4197 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4199 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4200 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4203 bus_generic_map_resource(device_t dev, device_t child, int type,
4204 struct resource *r, struct resource_map_request *args,
4205 struct resource_map *map)
4207 /* Propagate up the bus hierarchy until someone handles it. */
4209 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4215 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4217 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4218 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4221 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4222 struct resource *r, struct resource_map *map)
4224 /* Propagate up the bus hierarchy until someone handles it. */
4226 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4231 * @brief Helper function for implementing BUS_BIND_INTR().
4233 * This simple implementation of BUS_BIND_INTR() simply calls the
4234 * BUS_BIND_INTR() method of the parent of @p dev.
4237 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4241 /* Propagate up the bus hierarchy until someone handles it. */
4243 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4248 * @brief Helper function for implementing BUS_CONFIG_INTR().
4250 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4251 * BUS_CONFIG_INTR() method of the parent of @p dev.
4254 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4255 enum intr_polarity pol)
4258 /* Propagate up the bus hierarchy until someone handles it. */
4260 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4265 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4267 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4268 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4271 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4272 void *cookie, const char *descr)
4275 /* Propagate up the bus hierarchy until someone handles it. */
4277 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4283 * @brief Helper function for implementing BUS_GET_CPUS().
4285 * This simple implementation of BUS_GET_CPUS() simply calls the
4286 * BUS_GET_CPUS() method of the parent of @p dev.
4289 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4290 size_t setsize, cpuset_t *cpuset)
4293 /* Propagate up the bus hierarchy until someone handles it. */
4294 if (dev->parent != NULL)
4295 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4300 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4302 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4303 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4306 bus_generic_get_dma_tag(device_t dev, device_t child)
4309 /* Propagate up the bus hierarchy until someone handles it. */
4310 if (dev->parent != NULL)
4311 return (BUS_GET_DMA_TAG(dev->parent, child));
4316 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4318 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4319 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4322 bus_generic_get_bus_tag(device_t dev, device_t child)
4325 /* Propagate up the bus hierarchy until someone handles it. */
4326 if (dev->parent != NULL)
4327 return (BUS_GET_BUS_TAG(dev->parent, child));
4328 return ((bus_space_tag_t)0);
4332 * @brief Helper function for implementing BUS_GET_RESOURCE().
4334 * This implementation of BUS_GET_RESOURCE() uses the
4335 * resource_list_find() function to do most of the work. It calls
4336 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4340 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4341 rman_res_t *startp, rman_res_t *countp)
4343 struct resource_list * rl = NULL;
4344 struct resource_list_entry * rle = NULL;
4346 rl = BUS_GET_RESOURCE_LIST(dev, child);
4350 rle = resource_list_find(rl, type, rid);
4355 *startp = rle->start;
4357 *countp = rle->count;
4363 * @brief Helper function for implementing BUS_SET_RESOURCE().
4365 * This implementation of BUS_SET_RESOURCE() uses the
4366 * resource_list_add() function to do most of the work. It calls
4367 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4371 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4372 rman_res_t start, rman_res_t count)
4374 struct resource_list * rl = NULL;
4376 rl = BUS_GET_RESOURCE_LIST(dev, child);
4380 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4386 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4388 * This implementation of BUS_DELETE_RESOURCE() uses the
4389 * resource_list_delete() function to do most of the work. It calls
4390 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4394 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4396 struct resource_list * rl = NULL;
4398 rl = BUS_GET_RESOURCE_LIST(dev, child);
4402 resource_list_delete(rl, type, rid);
4408 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4410 * This implementation of BUS_RELEASE_RESOURCE() uses the
4411 * resource_list_release() function to do most of the work. It calls
4412 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4415 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4416 int rid, struct resource *r)
4418 struct resource_list * rl = NULL;
4420 if (device_get_parent(child) != dev)
4421 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4424 rl = BUS_GET_RESOURCE_LIST(dev, child);
4428 return (resource_list_release(rl, dev, child, type, rid, r));
4432 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4434 * This implementation of BUS_ALLOC_RESOURCE() uses the
4435 * resource_list_alloc() function to do most of the work. It calls
4436 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4439 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4440 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4442 struct resource_list * rl = NULL;
4444 if (device_get_parent(child) != dev)
4445 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4446 type, rid, start, end, count, flags));
4448 rl = BUS_GET_RESOURCE_LIST(dev, child);
4452 return (resource_list_alloc(rl, dev, child, type, rid,
4453 start, end, count, flags));
4457 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4459 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4460 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4463 bus_generic_child_present(device_t dev, device_t child)
4465 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4469 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4473 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4479 * @brief Helper function for implementing BUS_RESCAN().
4481 * This null implementation of BUS_RESCAN() always fails to indicate
4482 * the bus does not support rescanning.
4485 bus_null_rescan(device_t dev)
4492 * Some convenience functions to make it easier for drivers to use the
4493 * resource-management functions. All these really do is hide the
4494 * indirection through the parent's method table, making for slightly
4495 * less-wordy code. In the future, it might make sense for this code
4496 * to maintain some sort of a list of resources allocated by each device.
4500 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4501 struct resource **res)
4505 for (i = 0; rs[i].type != -1; i++)
4507 for (i = 0; rs[i].type != -1; i++) {
4508 res[i] = bus_alloc_resource_any(dev,
4509 rs[i].type, &rs[i].rid, rs[i].flags);
4510 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4511 bus_release_resources(dev, rs, res);
4519 bus_release_resources(device_t dev, const struct resource_spec *rs,
4520 struct resource **res)
4524 for (i = 0; rs[i].type != -1; i++)
4525 if (res[i] != NULL) {
4526 bus_release_resource(
4527 dev, rs[i].type, rs[i].rid, res[i]);
4533 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4535 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4539 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4540 rman_res_t end, rman_res_t count, u_int flags)
4542 struct resource *res;
4544 if (dev->parent == NULL)
4546 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4552 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4554 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4558 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4561 if (dev->parent == NULL)
4563 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4567 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4569 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4573 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4575 if (dev->parent == NULL)
4577 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4581 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4583 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4587 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4589 if (dev->parent == NULL)
4591 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4595 * @brief Wrapper function for BUS_MAP_RESOURCE().
4597 * This function simply calls the BUS_MAP_RESOURCE() method of the
4601 bus_map_resource(device_t dev, int type, struct resource *r,
4602 struct resource_map_request *args, struct resource_map *map)
4604 if (dev->parent == NULL)
4606 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4610 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4612 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4616 bus_unmap_resource(device_t dev, int type, struct resource *r,
4617 struct resource_map *map)
4619 if (dev->parent == NULL)
4621 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4625 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4627 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4631 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4635 if (dev->parent == NULL)
4637 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4642 * @brief Wrapper function for BUS_SETUP_INTR().
4644 * This function simply calls the BUS_SETUP_INTR() method of the
4648 bus_setup_intr(device_t dev, struct resource *r, int flags,
4649 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4653 if (dev->parent == NULL)
4655 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4659 if (handler != NULL && !(flags & INTR_MPSAFE))
4660 device_printf(dev, "[GIANT-LOCKED]\n");
4665 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4667 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4671 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4673 if (dev->parent == NULL)
4675 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4679 * @brief Wrapper function for BUS_BIND_INTR().
4681 * This function simply calls the BUS_BIND_INTR() method of the
4685 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4687 if (dev->parent == NULL)
4689 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4693 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4695 * This function first formats the requested description into a
4696 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4697 * the parent of @p dev.
4700 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4701 const char *fmt, ...)
4704 char descr[MAXCOMLEN + 1];
4706 if (dev->parent == NULL)
4709 vsnprintf(descr, sizeof(descr), fmt, ap);
4711 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4715 * @brief Wrapper function for BUS_SET_RESOURCE().
4717 * This function simply calls the BUS_SET_RESOURCE() method of the
4721 bus_set_resource(device_t dev, int type, int rid,
4722 rman_res_t start, rman_res_t count)
4724 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4729 * @brief Wrapper function for BUS_GET_RESOURCE().
4731 * This function simply calls the BUS_GET_RESOURCE() method of the
4735 bus_get_resource(device_t dev, int type, int rid,
4736 rman_res_t *startp, rman_res_t *countp)
4738 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4743 * @brief Wrapper function for BUS_GET_RESOURCE().
4745 * This function simply calls the BUS_GET_RESOURCE() method of the
4746 * parent of @p dev and returns the start value.
4749 bus_get_resource_start(device_t dev, int type, int rid)
4755 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4763 * @brief Wrapper function for BUS_GET_RESOURCE().
4765 * This function simply calls the BUS_GET_RESOURCE() method of the
4766 * parent of @p dev and returns the count value.
4769 bus_get_resource_count(device_t dev, int type, int rid)
4775 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4783 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4785 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4789 bus_delete_resource(device_t dev, int type, int rid)
4791 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4795 * @brief Wrapper function for BUS_CHILD_PRESENT().
4797 * This function simply calls the BUS_CHILD_PRESENT() method of the
4801 bus_child_present(device_t child)
4803 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4807 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4809 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4813 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4817 parent = device_get_parent(child);
4818 if (parent == NULL) {
4822 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4826 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4828 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4832 bus_child_location_str(device_t child, char *buf, size_t buflen)
4836 parent = device_get_parent(child);
4837 if (parent == NULL) {
4841 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4845 * @brief Wrapper function for BUS_GET_CPUS().
4847 * This function simply calls the BUS_GET_CPUS() method of the
4851 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4855 parent = device_get_parent(dev);
4858 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4862 * @brief Wrapper function for BUS_GET_DMA_TAG().
4864 * This function simply calls the BUS_GET_DMA_TAG() method of the
4868 bus_get_dma_tag(device_t dev)
4872 parent = device_get_parent(dev);
4875 return (BUS_GET_DMA_TAG(parent, dev));
4879 * @brief Wrapper function for BUS_GET_BUS_TAG().
4881 * This function simply calls the BUS_GET_BUS_TAG() method of the
4885 bus_get_bus_tag(device_t dev)
4889 parent = device_get_parent(dev);
4891 return ((bus_space_tag_t)0);
4892 return (BUS_GET_BUS_TAG(parent, dev));
4896 * @brief Wrapper function for BUS_GET_DOMAIN().
4898 * This function simply calls the BUS_GET_DOMAIN() method of the
4902 bus_get_domain(device_t dev, int *domain)
4904 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4907 /* Resume all devices and then notify userland that we're up again. */
4909 root_resume(device_t dev)
4913 error = bus_generic_resume(dev);
4915 devctl_notify("kern", "power", "resume", NULL);
4920 root_print_child(device_t dev, device_t child)
4924 retval += bus_print_child_header(dev, child);
4925 retval += printf("\n");
4931 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4932 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4935 * If an interrupt mapping gets to here something bad has happened.
4937 panic("root_setup_intr");
4941 * If we get here, assume that the device is permanent and really is
4942 * present in the system. Removable bus drivers are expected to intercept
4943 * this call long before it gets here. We return -1 so that drivers that
4944 * really care can check vs -1 or some ERRNO returned higher in the food
4948 root_child_present(device_t dev, device_t child)
4954 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4960 /* Default to returning the set of all CPUs. */
4961 if (setsize != sizeof(cpuset_t))
4970 static kobj_method_t root_methods[] = {
4971 /* Device interface */
4972 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4973 KOBJMETHOD(device_suspend, bus_generic_suspend),
4974 KOBJMETHOD(device_resume, root_resume),
4977 KOBJMETHOD(bus_print_child, root_print_child),
4978 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4979 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4980 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4981 KOBJMETHOD(bus_child_present, root_child_present),
4982 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4987 static driver_t root_driver = {
4994 devclass_t root_devclass;
4997 root_bus_module_handler(module_t mod, int what, void* arg)
5001 TAILQ_INIT(&bus_data_devices);
5002 kobj_class_compile((kobj_class_t) &root_driver);
5003 root_bus = make_device(NULL, "root", 0);
5004 root_bus->desc = "System root bus";
5005 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5006 root_bus->driver = &root_driver;
5007 root_bus->state = DS_ATTACHED;
5008 root_devclass = devclass_find_internal("root", NULL, FALSE);
5013 device_shutdown(root_bus);
5016 return (EOPNOTSUPP);
5022 static moduledata_t root_bus_mod = {
5024 root_bus_module_handler,
5027 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5030 * @brief Automatically configure devices
5032 * This function begins the autoconfiguration process by calling
5033 * device_probe_and_attach() for each child of the @c root0 device.
5036 root_bus_configure(void)
5041 /* Eventually this will be split up, but this is sufficient for now. */
5042 bus_set_pass(BUS_PASS_DEFAULT);
5046 * @brief Module handler for registering device drivers
5048 * This module handler is used to automatically register device
5049 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5050 * devclass_add_driver() for the driver described by the
5051 * driver_module_data structure pointed to by @p arg
5054 driver_module_handler(module_t mod, int what, void *arg)
5056 struct driver_module_data *dmd;
5057 devclass_t bus_devclass;
5058 kobj_class_t driver;
5061 dmd = (struct driver_module_data *)arg;
5062 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5067 if (dmd->dmd_chainevh)
5068 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5070 pass = dmd->dmd_pass;
5071 driver = dmd->dmd_driver;
5072 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5073 DRIVERNAME(driver), dmd->dmd_busname, pass));
5074 error = devclass_add_driver(bus_devclass, driver, pass,
5079 PDEBUG(("Unloading module: driver %s from bus %s",
5080 DRIVERNAME(dmd->dmd_driver),
5082 error = devclass_delete_driver(bus_devclass,
5085 if (!error && dmd->dmd_chainevh)
5086 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5089 PDEBUG(("Quiesce module: driver %s from bus %s",
5090 DRIVERNAME(dmd->dmd_driver),
5092 error = devclass_quiesce_driver(bus_devclass,
5095 if (!error && dmd->dmd_chainevh)
5096 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5107 * @brief Enumerate all hinted devices for this bus.
5109 * Walks through the hints for this bus and calls the bus_hinted_child
5110 * routine for each one it fines. It searches first for the specific
5111 * bus that's being probed for hinted children (eg isa0), and then for
5112 * generic children (eg isa).
5114 * @param dev bus device to enumerate
5117 bus_enumerate_hinted_children(device_t bus)
5120 const char *dname, *busname;
5124 * enumerate all devices on the specific bus
5126 busname = device_get_nameunit(bus);
5128 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5129 BUS_HINTED_CHILD(bus, dname, dunit);
5132 * and all the generic ones.
5134 busname = device_get_name(bus);
5136 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5137 BUS_HINTED_CHILD(bus, dname, dunit);
5142 /* the _short versions avoid iteration by not calling anything that prints
5143 * more than oneliners. I love oneliners.
5147 print_device_short(device_t dev, int indent)
5152 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5153 dev->unit, dev->desc,
5154 (dev->parent? "":"no "),
5155 (TAILQ_EMPTY(&dev->children)? "no ":""),
5156 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5157 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5158 (dev->flags&DF_WILDCARD? "wildcard,":""),
5159 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5160 (dev->flags&DF_REBID? "rebiddable,":""),
5161 (dev->ivars? "":"no "),
5162 (dev->softc? "":"no "),
5167 print_device(device_t dev, int indent)
5172 print_device_short(dev, indent);
5174 indentprintf(("Parent:\n"));
5175 print_device_short(dev->parent, indent+1);
5176 indentprintf(("Driver:\n"));
5177 print_driver_short(dev->driver, indent+1);
5178 indentprintf(("Devclass:\n"));
5179 print_devclass_short(dev->devclass, indent+1);
5183 print_device_tree_short(device_t dev, int indent)
5184 /* print the device and all its children (indented) */
5191 print_device_short(dev, indent);
5193 TAILQ_FOREACH(child, &dev->children, link) {
5194 print_device_tree_short(child, indent+1);
5199 print_device_tree(device_t dev, int indent)
5200 /* print the device and all its children (indented) */
5207 print_device(dev, indent);
5209 TAILQ_FOREACH(child, &dev->children, link) {
5210 print_device_tree(child, indent+1);
5215 print_driver_short(driver_t *driver, int indent)
5220 indentprintf(("driver %s: softc size = %zd\n",
5221 driver->name, driver->size));
5225 print_driver(driver_t *driver, int indent)
5230 print_driver_short(driver, indent);
5234 print_driver_list(driver_list_t drivers, int indent)
5236 driverlink_t driver;
5238 TAILQ_FOREACH(driver, &drivers, link) {
5239 print_driver(driver->driver, indent);
5244 print_devclass_short(devclass_t dc, int indent)
5249 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5253 print_devclass(devclass_t dc, int indent)
5260 print_devclass_short(dc, indent);
5261 indentprintf(("Drivers:\n"));
5262 print_driver_list(dc->drivers, indent+1);
5264 indentprintf(("Devices:\n"));
5265 for (i = 0; i < dc->maxunit; i++)
5267 print_device(dc->devices[i], indent+1);
5271 print_devclass_list_short(void)
5275 printf("Short listing of devclasses, drivers & devices:\n");
5276 TAILQ_FOREACH(dc, &devclasses, link) {
5277 print_devclass_short(dc, 0);
5282 print_devclass_list(void)
5286 printf("Full listing of devclasses, drivers & devices:\n");
5287 TAILQ_FOREACH(dc, &devclasses, link) {
5288 print_devclass(dc, 0);
5295 * User-space access to the device tree.
5297 * We implement a small set of nodes:
5299 * hw.bus Single integer read method to obtain the
5300 * current generation count.
5301 * hw.bus.devices Reads the entire device tree in flat space.
5302 * hw.bus.rman Resource manager interface
5304 * We might like to add the ability to scan devclasses and/or drivers to
5305 * determine what else is currently loaded/available.
5309 sysctl_bus(SYSCTL_HANDLER_ARGS)
5311 struct u_businfo ubus;
5313 ubus.ub_version = BUS_USER_VERSION;
5314 ubus.ub_generation = bus_data_generation;
5316 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5318 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5319 "bus-related data");
5322 sysctl_devices(SYSCTL_HANDLER_ARGS)
5324 int *name = (int *)arg1;
5325 u_int namelen = arg2;
5328 struct u_device udev; /* XXX this is a bit big */
5334 if (bus_data_generation_check(name[0]))
5340 * Scan the list of devices, looking for the requested index.
5342 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5350 * Populate the return array.
5352 bzero(&udev, sizeof(udev));
5353 udev.dv_handle = (uintptr_t)dev;
5354 udev.dv_parent = (uintptr_t)dev->parent;
5355 if (dev->nameunit != NULL)
5356 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
5357 if (dev->desc != NULL)
5358 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
5359 if (dev->driver != NULL && dev->driver->name != NULL)
5360 strlcpy(udev.dv_drivername, dev->driver->name,
5361 sizeof(udev.dv_drivername));
5362 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
5363 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
5364 udev.dv_devflags = dev->devflags;
5365 udev.dv_flags = dev->flags;
5366 udev.dv_state = dev->state;
5367 error = SYSCTL_OUT(req, &udev, sizeof(udev));
5371 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5372 "system device tree");
5375 bus_data_generation_check(int generation)
5377 if (generation != bus_data_generation)
5380 /* XXX generate optimised lists here? */
5385 bus_data_generation_update(void)
5387 bus_data_generation++;
5391 bus_free_resource(device_t dev, int type, struct resource *r)
5395 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5399 device_lookup_by_name(const char *name)
5403 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5404 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5411 * /dev/devctl2 implementation. The existing /dev/devctl device has
5412 * implicit semantics on open, so it could not be reused for this.
5413 * Another option would be to call this /dev/bus?
5416 find_device(struct devreq *req, device_t *devp)
5421 * First, ensure that the name is nul terminated.
5423 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5427 * Second, try to find an attached device whose name matches
5430 dev = device_lookup_by_name(req->dr_name);
5436 /* Finally, give device enumerators a chance. */
5438 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev);
5446 driver_exists(device_t bus, const char *driver)
5450 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5451 if (devclass_find_driver_internal(dc, driver) != NULL)
5458 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5465 /* Locate the device to control. */
5467 req = (struct devreq *)data;
5475 case DEV_SET_DRIVER:
5476 case DEV_CLEAR_DRIVER:
5480 error = priv_check(td, PRIV_DRIVER);
5482 error = find_device(req, &dev);
5493 /* Perform the requested operation. */
5496 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5498 else if (!device_is_enabled(dev))
5501 error = device_probe_and_attach(dev);
5504 if (!device_is_attached(dev)) {
5508 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5509 error = device_quiesce(dev);
5513 error = device_detach(dev);
5516 if (device_is_enabled(dev)) {
5522 * If the device has been probed but not attached (e.g.
5523 * when it has been disabled by a loader hint), just
5524 * attach the device rather than doing a full probe.
5527 if (device_is_alive(dev)) {
5529 * If the device was disabled via a hint, clear
5532 if (resource_disabled(dev->driver->name, dev->unit))
5533 resource_unset_value(dev->driver->name,
5534 dev->unit, "disabled");
5535 error = device_attach(dev);
5537 error = device_probe_and_attach(dev);
5540 if (!device_is_enabled(dev)) {
5545 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5546 error = device_quiesce(dev);
5552 * Force DF_FIXEDCLASS on around detach to preserve
5553 * the existing name.
5556 dev->flags |= DF_FIXEDCLASS;
5557 error = device_detach(dev);
5558 if (!(old & DF_FIXEDCLASS))
5559 dev->flags &= ~DF_FIXEDCLASS;
5561 device_disable(dev);
5564 if (device_is_suspended(dev)) {
5568 if (device_get_parent(dev) == NULL) {
5572 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5575 if (!device_is_suspended(dev)) {
5579 if (device_get_parent(dev) == NULL) {
5583 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5585 case DEV_SET_DRIVER: {
5589 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5592 if (driver[0] == '\0') {
5596 if (dev->devclass != NULL &&
5597 strcmp(driver, dev->devclass->name) == 0)
5598 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5602 * Scan drivers for this device's bus looking for at
5603 * least one matching driver.
5605 if (dev->parent == NULL) {
5609 if (!driver_exists(dev->parent, driver)) {
5613 dc = devclass_create(driver);
5619 /* Detach device if necessary. */
5620 if (device_is_attached(dev)) {
5621 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5622 error = device_detach(dev);
5629 /* Clear any previously-fixed device class and unit. */
5630 if (dev->flags & DF_FIXEDCLASS)
5631 devclass_delete_device(dev->devclass, dev);
5632 dev->flags |= DF_WILDCARD;
5635 /* Force the new device class. */
5636 error = devclass_add_device(dc, dev);
5639 dev->flags |= DF_FIXEDCLASS;
5640 error = device_probe_and_attach(dev);
5643 case DEV_CLEAR_DRIVER:
5644 if (!(dev->flags & DF_FIXEDCLASS)) {
5648 if (device_is_attached(dev)) {
5649 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5650 error = device_detach(dev);
5657 dev->flags &= ~DF_FIXEDCLASS;
5658 dev->flags |= DF_WILDCARD;
5659 devclass_delete_device(dev->devclass, dev);
5660 error = device_probe_and_attach(dev);
5663 if (!device_is_attached(dev)) {
5667 error = BUS_RESCAN(dev);
5672 parent = device_get_parent(dev);
5673 if (parent == NULL) {
5677 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5678 if (bus_child_present(dev) != 0) {
5684 error = device_delete_child(parent, dev);
5688 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5692 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5700 static struct cdevsw devctl2_cdevsw = {
5701 .d_version = D_VERSION,
5702 .d_ioctl = devctl2_ioctl,
5703 .d_name = "devctl2",
5710 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5711 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5715 * APIs to manage deprecation and obsolescence.
5717 static int obsolete_panic = 0;
5718 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5720 /* 0 - don't panic, 1 - panic if already obsolete, 2 - panic if deprecated */
5722 gone_panic(int major, int running, const char *msg)
5725 switch (obsolete_panic)
5730 if (running < major)
5739 _gone_in(int major, const char *msg)
5742 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5743 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5744 printf("Obsolete code will removed soon: %s\n", msg);
5746 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5751 _gone_in_dev(device_t dev, int major, const char *msg)
5754 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5755 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5757 "Obsolete code will removed soon: %s\n", msg);
5760 "Deprecated code (to be removed in FreeBSD %d): %s\n",