2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/eventhandler.h>
38 #include <sys/filio.h>
40 #include <sys/kernel.h>
42 #include <sys/limits.h>
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #include <sys/queue.h>
51 #include <machine/bus.h>
52 #include <sys/random.h>
55 #include <sys/selinfo.h>
56 #include <sys/signalvar.h>
58 #include <sys/sysctl.h>
59 #include <sys/systm.h>
62 #include <sys/interrupt.h>
63 #include <sys/cpuset.h>
67 #include <machine/cpu.h>
68 #include <machine/stdarg.h>
75 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
76 SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
79 * Used to attach drivers to devclasses.
81 typedef struct driverlink *driverlink_t;
84 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
86 TAILQ_ENTRY(driverlink) passlink;
90 * Forward declarations
92 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
93 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
94 typedef TAILQ_HEAD(device_list, device) device_list_t;
97 TAILQ_ENTRY(devclass) link;
98 devclass_t parent; /* parent in devclass hierarchy */
99 driver_list_t drivers; /* bus devclasses store drivers for bus */
101 device_t *devices; /* array of devices indexed by unit */
102 int maxunit; /* size of devices array */
104 #define DC_HAS_CHILDREN 1
106 struct sysctl_ctx_list sysctl_ctx;
107 struct sysctl_oid *sysctl_tree;
111 * @brief Implementation of device.
115 * A device is a kernel object. The first field must be the
116 * current ops table for the object.
123 TAILQ_ENTRY(device) link; /**< list of devices in parent */
124 TAILQ_ENTRY(device) devlink; /**< global device list membership */
125 device_t parent; /**< parent of this device */
126 device_list_t children; /**< list of child devices */
129 * Details of this device.
131 driver_t *driver; /**< current driver */
132 devclass_t devclass; /**< current device class */
133 int unit; /**< current unit number */
134 char* nameunit; /**< name+unit e.g. foodev0 */
135 char* desc; /**< driver specific description */
136 int busy; /**< count of calls to device_busy() */
137 device_state_t state; /**< current device state */
138 uint32_t devflags; /**< api level flags for device_get_flags() */
139 u_int flags; /**< internal device flags */
140 u_int order; /**< order from device_add_child_ordered() */
141 void *ivars; /**< instance variables */
142 void *softc; /**< current driver's variables */
144 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
145 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
148 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
149 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
151 EVENTHANDLER_LIST_DEFINE(device_attach);
152 EVENTHANDLER_LIST_DEFINE(device_detach);
153 EVENTHANDLER_LIST_DEFINE(dev_lookup);
155 static void devctl2_init(void);
157 #define DRIVERNAME(d) ((d)? d->name : "no driver")
158 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
162 static int bus_debug = 1;
163 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
166 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
167 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
170 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
171 * prevent syslog from deleting initial spaces
173 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
175 static void print_device_short(device_t dev, int indent);
176 static void print_device(device_t dev, int indent);
177 void print_device_tree_short(device_t dev, int indent);
178 void print_device_tree(device_t dev, int indent);
179 static void print_driver_short(driver_t *driver, int indent);
180 static void print_driver(driver_t *driver, int indent);
181 static void print_driver_list(driver_list_t drivers, int indent);
182 static void print_devclass_short(devclass_t dc, int indent);
183 static void print_devclass(devclass_t dc, int indent);
184 void print_devclass_list_short(void);
185 void print_devclass_list(void);
188 /* Make the compiler ignore the function calls */
189 #define PDEBUG(a) /* nop */
190 #define DEVICENAME(d) /* nop */
192 #define print_device_short(d,i) /* nop */
193 #define print_device(d,i) /* nop */
194 #define print_device_tree_short(d,i) /* nop */
195 #define print_device_tree(d,i) /* nop */
196 #define print_driver_short(d,i) /* nop */
197 #define print_driver(d,i) /* nop */
198 #define print_driver_list(d,i) /* nop */
199 #define print_devclass_short(d,i) /* nop */
200 #define print_devclass(d,i) /* nop */
201 #define print_devclass_list_short() /* nop */
202 #define print_devclass_list() /* nop */
210 DEVCLASS_SYSCTL_PARENT,
214 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
216 devclass_t dc = (devclass_t)arg1;
220 case DEVCLASS_SYSCTL_PARENT:
221 value = dc->parent ? dc->parent->name : "";
226 return (SYSCTL_OUT_STR(req, value));
230 devclass_sysctl_init(devclass_t dc)
233 if (dc->sysctl_tree != NULL)
235 sysctl_ctx_init(&dc->sysctl_ctx);
236 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
237 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
238 CTLFLAG_RD, NULL, "");
239 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
240 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
241 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
247 DEVICE_SYSCTL_DRIVER,
248 DEVICE_SYSCTL_LOCATION,
249 DEVICE_SYSCTL_PNPINFO,
250 DEVICE_SYSCTL_PARENT,
254 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
256 device_t dev = (device_t)arg1;
263 case DEVICE_SYSCTL_DESC:
264 value = dev->desc ? dev->desc : "";
266 case DEVICE_SYSCTL_DRIVER:
267 value = dev->driver ? dev->driver->name : "";
269 case DEVICE_SYSCTL_LOCATION:
270 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
271 bus_child_location_str(dev, buf, 1024);
273 case DEVICE_SYSCTL_PNPINFO:
274 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
275 bus_child_pnpinfo_str(dev, buf, 1024);
277 case DEVICE_SYSCTL_PARENT:
278 value = dev->parent ? dev->parent->nameunit : "";
283 error = SYSCTL_OUT_STR(req, value);
290 device_sysctl_init(device_t dev)
292 devclass_t dc = dev->devclass;
295 if (dev->sysctl_tree != NULL)
297 devclass_sysctl_init(dc);
298 sysctl_ctx_init(&dev->sysctl_ctx);
299 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
300 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
301 dev->nameunit + strlen(dc->name),
302 CTLFLAG_RD, NULL, "", "device_index");
303 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
304 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
305 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
306 "device description");
307 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
308 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
309 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
310 "device driver name");
311 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
312 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
313 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
314 "device location relative to parent");
315 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
316 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
317 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
318 "device identification");
319 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
320 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
321 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
323 if (bus_get_domain(dev, &domain) == 0)
324 SYSCTL_ADD_INT(&dev->sysctl_ctx,
325 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
326 CTLFLAG_RD, NULL, domain, "NUMA domain");
330 device_sysctl_update(device_t dev)
332 devclass_t dc = dev->devclass;
334 if (dev->sysctl_tree == NULL)
336 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
340 device_sysctl_fini(device_t dev)
342 if (dev->sysctl_tree == NULL)
344 sysctl_ctx_free(&dev->sysctl_ctx);
345 dev->sysctl_tree = NULL;
349 * /dev/devctl implementation
353 * This design allows only one reader for /dev/devctl. This is not desirable
354 * in the long run, but will get a lot of hair out of this implementation.
355 * Maybe we should make this device a clonable device.
357 * Also note: we specifically do not attach a device to the device_t tree
358 * to avoid potential chicken and egg problems. One could argue that all
359 * of this belongs to the root node. One could also further argue that the
360 * sysctl interface that we have not might more properly be an ioctl
361 * interface, but at this stage of the game, I'm not inclined to rock that
364 * I'm also not sure that the SIGIO support is done correctly or not, as
365 * I copied it from a driver that had SIGIO support that likely hasn't been
366 * tested since 3.4 or 2.2.8!
369 /* Deprecated way to adjust queue length */
370 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
371 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
372 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
373 "devctl disable -- deprecated");
375 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
376 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
377 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
378 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
379 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
381 static d_open_t devopen;
382 static d_close_t devclose;
383 static d_read_t devread;
384 static d_ioctl_t devioctl;
385 static d_poll_t devpoll;
386 static d_kqfilter_t devkqfilter;
388 static struct cdevsw dev_cdevsw = {
389 .d_version = D_VERSION,
395 .d_kqfilter = devkqfilter,
399 struct dev_event_info
402 TAILQ_ENTRY(dev_event_info) dei_link;
405 TAILQ_HEAD(devq, dev_event_info);
407 static struct dev_softc
420 static void filt_devctl_detach(struct knote *kn);
421 static int filt_devctl_read(struct knote *kn, long hint);
423 struct filterops devctl_rfiltops = {
425 .f_detach = filt_devctl_detach,
426 .f_event = filt_devctl_read,
429 static struct cdev *devctl_dev;
434 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
435 UID_ROOT, GID_WHEEL, 0600, "devctl");
436 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
437 cv_init(&devsoftc.cv, "dev cv");
438 TAILQ_INIT(&devsoftc.devq);
439 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
444 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
447 mtx_lock(&devsoftc.mtx);
448 if (devsoftc.inuse) {
449 mtx_unlock(&devsoftc.mtx);
454 mtx_unlock(&devsoftc.mtx);
459 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
462 mtx_lock(&devsoftc.mtx);
464 devsoftc.nonblock = 0;
466 cv_broadcast(&devsoftc.cv);
467 funsetown(&devsoftc.sigio);
468 mtx_unlock(&devsoftc.mtx);
473 * The read channel for this device is used to report changes to
474 * userland in realtime. We are required to free the data as well as
475 * the n1 object because we allocate them separately. Also note that
476 * we return one record at a time. If you try to read this device a
477 * character at a time, you will lose the rest of the data. Listening
478 * programs are expected to cope.
481 devread(struct cdev *dev, struct uio *uio, int ioflag)
483 struct dev_event_info *n1;
486 mtx_lock(&devsoftc.mtx);
487 while (TAILQ_EMPTY(&devsoftc.devq)) {
488 if (devsoftc.nonblock) {
489 mtx_unlock(&devsoftc.mtx);
492 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
495 * Need to translate ERESTART to EINTR here? -- jake
497 mtx_unlock(&devsoftc.mtx);
501 n1 = TAILQ_FIRST(&devsoftc.devq);
502 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
504 mtx_unlock(&devsoftc.mtx);
505 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
506 free(n1->dei_data, M_BUS);
512 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
518 devsoftc.nonblock = 1;
520 devsoftc.nonblock = 0;
529 return fsetown(*(int *)data, &devsoftc.sigio);
531 *(int *)data = fgetown(&devsoftc.sigio);
534 /* (un)Support for other fcntl() calls. */
545 devpoll(struct cdev *dev, int events, struct thread *td)
549 mtx_lock(&devsoftc.mtx);
550 if (events & (POLLIN | POLLRDNORM)) {
551 if (!TAILQ_EMPTY(&devsoftc.devq))
552 revents = events & (POLLIN | POLLRDNORM);
554 selrecord(td, &devsoftc.sel);
556 mtx_unlock(&devsoftc.mtx);
562 devkqfilter(struct cdev *dev, struct knote *kn)
566 if (kn->kn_filter == EVFILT_READ) {
567 kn->kn_fop = &devctl_rfiltops;
568 knlist_add(&devsoftc.sel.si_note, kn, 0);
576 filt_devctl_detach(struct knote *kn)
579 knlist_remove(&devsoftc.sel.si_note, kn, 0);
583 filt_devctl_read(struct knote *kn, long hint)
585 kn->kn_data = devsoftc.queued;
586 return (kn->kn_data != 0);
590 * @brief Return whether the userland process is running
593 devctl_process_running(void)
595 return (devsoftc.inuse == 1);
599 * @brief Queue data to be read from the devctl device
601 * Generic interface to queue data to the devctl device. It is
602 * assumed that @p data is properly formatted. It is further assumed
603 * that @p data is allocated using the M_BUS malloc type.
606 devctl_queue_data_f(char *data, int flags)
608 struct dev_event_info *n1 = NULL, *n2 = NULL;
610 if (strlen(data) == 0)
612 if (devctl_queue_length == 0)
614 n1 = malloc(sizeof(*n1), M_BUS, flags);
618 mtx_lock(&devsoftc.mtx);
619 if (devctl_queue_length == 0) {
620 mtx_unlock(&devsoftc.mtx);
621 free(n1->dei_data, M_BUS);
625 /* Leave at least one spot in the queue... */
626 while (devsoftc.queued > devctl_queue_length - 1) {
627 n2 = TAILQ_FIRST(&devsoftc.devq);
628 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
629 free(n2->dei_data, M_BUS);
633 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
635 cv_broadcast(&devsoftc.cv);
636 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
637 mtx_unlock(&devsoftc.mtx);
638 selwakeup(&devsoftc.sel);
639 if (devsoftc.async && devsoftc.sigio != NULL)
640 pgsigio(&devsoftc.sigio, SIGIO, 0);
644 * We have to free data on all error paths since the caller
645 * assumes it will be free'd when this item is dequeued.
652 devctl_queue_data(char *data)
655 devctl_queue_data_f(data, M_NOWAIT);
659 * @brief Send a 'notification' to userland, using standard ways
662 devctl_notify_f(const char *system, const char *subsystem, const char *type,
663 const char *data, int flags)
669 return; /* BOGUS! Must specify system. */
670 if (subsystem == NULL)
671 return; /* BOGUS! Must specify subsystem. */
673 return; /* BOGUS! Must specify type. */
674 len += strlen(" system=") + strlen(system);
675 len += strlen(" subsystem=") + strlen(subsystem);
676 len += strlen(" type=") + strlen(type);
677 /* add in the data message plus newline. */
680 len += 3; /* '!', '\n', and NUL */
681 msg = malloc(len, M_BUS, flags);
683 return; /* Drop it on the floor */
685 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
686 system, subsystem, type, data);
688 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
689 system, subsystem, type);
690 devctl_queue_data_f(msg, flags);
694 devctl_notify(const char *system, const char *subsystem, const char *type,
698 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
702 * Common routine that tries to make sending messages as easy as possible.
703 * We allocate memory for the data, copy strings into that, but do not
704 * free it unless there's an error. The dequeue part of the driver should
705 * free the data. We don't send data when the device is disabled. We do
706 * send data, even when we have no listeners, because we wish to avoid
707 * races relating to startup and restart of listening applications.
709 * devaddq is designed to string together the type of event, with the
710 * object of that event, plus the plug and play info and location info
711 * for that event. This is likely most useful for devices, but less
712 * useful for other consumers of this interface. Those should use
713 * the devctl_queue_data() interface instead.
716 devaddq(const char *type, const char *what, device_t dev)
723 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
725 data = malloc(1024, M_BUS, M_NOWAIT);
729 /* get the bus specific location of this device */
730 loc = malloc(1024, M_BUS, M_NOWAIT);
734 bus_child_location_str(dev, loc, 1024);
736 /* Get the bus specific pnp info of this device */
737 pnp = malloc(1024, M_BUS, M_NOWAIT);
741 bus_child_pnpinfo_str(dev, pnp, 1024);
743 /* Get the parent of this device, or / if high enough in the tree. */
744 if (device_get_parent(dev) == NULL)
745 parstr = "."; /* Or '/' ? */
747 parstr = device_get_nameunit(device_get_parent(dev));
748 /* String it all together. */
749 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
753 devctl_queue_data(data);
763 * A device was added to the tree. We are called just after it successfully
764 * attaches (that is, probe and attach success for this device). No call
765 * is made if a device is merely parented into the tree. See devnomatch
766 * if probe fails. If attach fails, no notification is sent (but maybe
767 * we should have a different message for this).
770 devadded(device_t dev)
772 devaddq("+", device_get_nameunit(dev), dev);
776 * A device was removed from the tree. We are called just before this
780 devremoved(device_t dev)
782 devaddq("-", device_get_nameunit(dev), dev);
786 * Called when there's no match for this device. This is only called
787 * the first time that no match happens, so we don't keep getting this
788 * message. Should that prove to be undesirable, we can change it.
789 * This is called when all drivers that can attach to a given bus
790 * decline to accept this device. Other errors may not be detected.
793 devnomatch(device_t dev)
795 devaddq("?", "", dev);
799 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
801 struct dev_event_info *n1;
804 dis = (devctl_queue_length == 0);
805 error = sysctl_handle_int(oidp, &dis, 0, req);
806 if (error || !req->newptr)
808 if (mtx_initialized(&devsoftc.mtx))
809 mtx_lock(&devsoftc.mtx);
811 while (!TAILQ_EMPTY(&devsoftc.devq)) {
812 n1 = TAILQ_FIRST(&devsoftc.devq);
813 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
814 free(n1->dei_data, M_BUS);
818 devctl_queue_length = 0;
820 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
822 if (mtx_initialized(&devsoftc.mtx))
823 mtx_unlock(&devsoftc.mtx);
828 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
830 struct dev_event_info *n1;
833 q = devctl_queue_length;
834 error = sysctl_handle_int(oidp, &q, 0, req);
835 if (error || !req->newptr)
839 if (mtx_initialized(&devsoftc.mtx))
840 mtx_lock(&devsoftc.mtx);
841 devctl_queue_length = q;
842 while (devsoftc.queued > devctl_queue_length) {
843 n1 = TAILQ_FIRST(&devsoftc.devq);
844 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
845 free(n1->dei_data, M_BUS);
849 if (mtx_initialized(&devsoftc.mtx))
850 mtx_unlock(&devsoftc.mtx);
855 * @brief safely quotes strings that might have double quotes in them.
857 * The devctl protocol relies on quoted strings having matching quotes.
858 * This routine quotes any internal quotes so the resulting string
859 * is safe to pass to snprintf to construct, for example pnp info strings.
860 * Strings are always terminated with a NUL, but may be truncated if longer
861 * than @p len bytes after quotes.
863 * @param dst Buffer to hold the string. Must be at least @p len bytes long
864 * @param src Original buffer.
865 * @param len Length of buffer pointed to by @dst, including trailing NUL
868 devctl_safe_quote(char *dst, const char *src, size_t len)
870 char *walker = dst, *ep = dst + len - 1;
874 while (src != NULL && walker < ep)
876 if (*src == '"' || *src == '\\') {
887 * @brief safely quotes strings that might have double quotes in them.
889 * The devctl protocol relies on quoted strings having matching quotes.
890 * This routine quotes any internal quotes so the resulting string
891 * is safe to pass to snprintf to construct, for example pnp info strings.
892 * Strings are always terminated with a NUL, but may be truncated if longer
893 * than @p len bytes after quotes.
895 * @param sb sbuf to place the characters into
896 * @param src Original buffer.
899 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
902 while (*src != '\0') {
903 if (*src == '"' || *src == '\\')
905 sbuf_putc(sb, *src++);
909 /* End of /dev/devctl code */
911 static TAILQ_HEAD(,device) bus_data_devices;
912 static int bus_data_generation = 1;
914 static kobj_method_t null_methods[] = {
918 DEFINE_CLASS(null, null_methods, 0);
921 * Bus pass implementation
924 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
925 int bus_current_pass = BUS_PASS_ROOT;
929 * @brief Register the pass level of a new driver attachment
931 * Register a new driver attachment's pass level. If no driver
932 * attachment with the same pass level has been added, then @p new
933 * will be added to the global passes list.
935 * @param new the new driver attachment
938 driver_register_pass(struct driverlink *new)
940 struct driverlink *dl;
942 /* We only consider pass numbers during boot. */
943 if (bus_current_pass == BUS_PASS_DEFAULT)
947 * Walk the passes list. If we already know about this pass
948 * then there is nothing to do. If we don't, then insert this
949 * driver link into the list.
951 TAILQ_FOREACH(dl, &passes, passlink) {
952 if (dl->pass < new->pass)
954 if (dl->pass == new->pass)
956 TAILQ_INSERT_BEFORE(dl, new, passlink);
959 TAILQ_INSERT_TAIL(&passes, new, passlink);
963 * @brief Raise the current bus pass
965 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
966 * method on the root bus to kick off a new device tree scan for each
967 * new pass level that has at least one driver.
970 bus_set_pass(int pass)
972 struct driverlink *dl;
974 if (bus_current_pass > pass)
975 panic("Attempt to lower bus pass level");
977 TAILQ_FOREACH(dl, &passes, passlink) {
978 /* Skip pass values below the current pass level. */
979 if (dl->pass <= bus_current_pass)
983 * Bail once we hit a driver with a pass level that is
990 * Raise the pass level to the next level and rescan
993 bus_current_pass = dl->pass;
994 BUS_NEW_PASS(root_bus);
998 * If there isn't a driver registered for the requested pass,
999 * then bus_current_pass might still be less than 'pass'. Set
1000 * it to 'pass' in that case.
1002 if (bus_current_pass < pass)
1003 bus_current_pass = pass;
1004 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
1008 * Devclass implementation
1011 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
1015 * @brief Find or create a device class
1017 * If a device class with the name @p classname exists, return it,
1018 * otherwise if @p create is non-zero create and return a new device
1021 * If @p parentname is non-NULL, the parent of the devclass is set to
1022 * the devclass of that name.
1024 * @param classname the devclass name to find or create
1025 * @param parentname the parent devclass name or @c NULL
1026 * @param create non-zero to create a devclass
1029 devclass_find_internal(const char *classname, const char *parentname,
1034 PDEBUG(("looking for %s", classname));
1038 TAILQ_FOREACH(dc, &devclasses, link) {
1039 if (!strcmp(dc->name, classname))
1043 if (create && !dc) {
1044 PDEBUG(("creating %s", classname));
1045 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1046 M_BUS, M_NOWAIT | M_ZERO);
1050 dc->name = (char*) (dc + 1);
1051 strcpy(dc->name, classname);
1052 TAILQ_INIT(&dc->drivers);
1053 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1055 bus_data_generation_update();
1059 * If a parent class is specified, then set that as our parent so
1060 * that this devclass will support drivers for the parent class as
1061 * well. If the parent class has the same name don't do this though
1062 * as it creates a cycle that can trigger an infinite loop in
1063 * device_probe_child() if a device exists for which there is no
1066 if (parentname && dc && !dc->parent &&
1067 strcmp(classname, parentname) != 0) {
1068 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1069 dc->parent->flags |= DC_HAS_CHILDREN;
1076 * @brief Create a device class
1078 * If a device class with the name @p classname exists, return it,
1079 * otherwise create and return a new device class.
1081 * @param classname the devclass name to find or create
1084 devclass_create(const char *classname)
1086 return (devclass_find_internal(classname, NULL, TRUE));
1090 * @brief Find a device class
1092 * If a device class with the name @p classname exists, return it,
1093 * otherwise return @c NULL.
1095 * @param classname the devclass name to find
1098 devclass_find(const char *classname)
1100 return (devclass_find_internal(classname, NULL, FALSE));
1104 * @brief Register that a device driver has been added to a devclass
1106 * Register that a device driver has been added to a devclass. This
1107 * is called by devclass_add_driver to accomplish the recursive
1108 * notification of all the children classes of dc, as well as dc.
1109 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1112 * We do a full search here of the devclass list at each iteration
1113 * level to save storing children-lists in the devclass structure. If
1114 * we ever move beyond a few dozen devices doing this, we may need to
1117 * @param dc the devclass to edit
1118 * @param driver the driver that was just added
1121 devclass_driver_added(devclass_t dc, driver_t *driver)
1127 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1129 for (i = 0; i < dc->maxunit; i++)
1130 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1131 BUS_DRIVER_ADDED(dc->devices[i], driver);
1134 * Walk through the children classes. Since we only keep a
1135 * single parent pointer around, we walk the entire list of
1136 * devclasses looking for children. We set the
1137 * DC_HAS_CHILDREN flag when a child devclass is created on
1138 * the parent, so we only walk the list for those devclasses
1139 * that have children.
1141 if (!(dc->flags & DC_HAS_CHILDREN))
1144 TAILQ_FOREACH(dc, &devclasses, link) {
1145 if (dc->parent == parent)
1146 devclass_driver_added(dc, driver);
1151 * @brief Add a device driver to a device class
1153 * Add a device driver to a devclass. This is normally called
1154 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1155 * all devices in the devclass will be called to allow them to attempt
1156 * to re-probe any unmatched children.
1158 * @param dc the devclass to edit
1159 * @param driver the driver to register
1162 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1165 const char *parentname;
1167 PDEBUG(("%s", DRIVERNAME(driver)));
1169 /* Don't allow invalid pass values. */
1170 if (pass <= BUS_PASS_ROOT)
1173 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1178 * Compile the driver's methods. Also increase the reference count
1179 * so that the class doesn't get freed when the last instance
1180 * goes. This means we can safely use static methods and avoids a
1181 * double-free in devclass_delete_driver.
1183 kobj_class_compile((kobj_class_t) driver);
1186 * If the driver has any base classes, make the
1187 * devclass inherit from the devclass of the driver's
1188 * first base class. This will allow the system to
1189 * search for drivers in both devclasses for children
1190 * of a device using this driver.
1192 if (driver->baseclasses)
1193 parentname = driver->baseclasses[0]->name;
1196 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1198 dl->driver = driver;
1199 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1200 driver->refs++; /* XXX: kobj_mtx */
1202 driver_register_pass(dl);
1204 devclass_driver_added(dc, driver);
1205 bus_data_generation_update();
1210 * @brief Register that a device driver has been deleted from a devclass
1212 * Register that a device driver has been removed from a devclass.
1213 * This is called by devclass_delete_driver to accomplish the
1214 * recursive notification of all the children classes of busclass, as
1215 * well as busclass. Each layer will attempt to detach the driver
1216 * from any devices that are children of the bus's devclass. The function
1217 * will return an error if a device fails to detach.
1219 * We do a full search here of the devclass list at each iteration
1220 * level to save storing children-lists in the devclass structure. If
1221 * we ever move beyond a few dozen devices doing this, we may need to
1224 * @param busclass the devclass of the parent bus
1225 * @param dc the devclass of the driver being deleted
1226 * @param driver the driver being deleted
1229 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1236 * Disassociate from any devices. We iterate through all the
1237 * devices in the devclass of the driver and detach any which are
1238 * using the driver and which have a parent in the devclass which
1239 * we are deleting from.
1241 * Note that since a driver can be in multiple devclasses, we
1242 * should not detach devices which are not children of devices in
1243 * the affected devclass.
1245 for (i = 0; i < dc->maxunit; i++) {
1246 if (dc->devices[i]) {
1247 dev = dc->devices[i];
1248 if (dev->driver == driver && dev->parent &&
1249 dev->parent->devclass == busclass) {
1250 if ((error = device_detach(dev)) != 0)
1252 BUS_PROBE_NOMATCH(dev->parent, dev);
1254 dev->flags |= DF_DONENOMATCH;
1260 * Walk through the children classes. Since we only keep a
1261 * single parent pointer around, we walk the entire list of
1262 * devclasses looking for children. We set the
1263 * DC_HAS_CHILDREN flag when a child devclass is created on
1264 * the parent, so we only walk the list for those devclasses
1265 * that have children.
1267 if (!(busclass->flags & DC_HAS_CHILDREN))
1270 TAILQ_FOREACH(busclass, &devclasses, link) {
1271 if (busclass->parent == parent) {
1272 error = devclass_driver_deleted(busclass, dc, driver);
1281 * @brief Delete a device driver from a device class
1283 * Delete a device driver from a devclass. This is normally called
1284 * automatically by DRIVER_MODULE().
1286 * If the driver is currently attached to any devices,
1287 * devclass_delete_driver() will first attempt to detach from each
1288 * device. If one of the detach calls fails, the driver will not be
1291 * @param dc the devclass to edit
1292 * @param driver the driver to unregister
1295 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1297 devclass_t dc = devclass_find(driver->name);
1301 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1307 * Find the link structure in the bus' list of drivers.
1309 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1310 if (dl->driver == driver)
1315 PDEBUG(("%s not found in %s list", driver->name,
1320 error = devclass_driver_deleted(busclass, dc, driver);
1324 TAILQ_REMOVE(&busclass->drivers, dl, link);
1329 if (driver->refs == 0)
1330 kobj_class_free((kobj_class_t) driver);
1332 bus_data_generation_update();
1337 * @brief Quiesces a set of device drivers from a device class
1339 * Quiesce a device driver from a devclass. This is normally called
1340 * automatically by DRIVER_MODULE().
1342 * If the driver is currently attached to any devices,
1343 * devclass_quiesece_driver() will first attempt to quiesce each
1346 * @param dc the devclass to edit
1347 * @param driver the driver to unregister
1350 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1352 devclass_t dc = devclass_find(driver->name);
1358 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1364 * Find the link structure in the bus' list of drivers.
1366 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1367 if (dl->driver == driver)
1372 PDEBUG(("%s not found in %s list", driver->name,
1378 * Quiesce all devices. We iterate through all the devices in
1379 * the devclass of the driver and quiesce any which are using
1380 * the driver and which have a parent in the devclass which we
1383 * Note that since a driver can be in multiple devclasses, we
1384 * should not quiesce devices which are not children of
1385 * devices in the affected devclass.
1387 for (i = 0; i < dc->maxunit; i++) {
1388 if (dc->devices[i]) {
1389 dev = dc->devices[i];
1390 if (dev->driver == driver && dev->parent &&
1391 dev->parent->devclass == busclass) {
1392 if ((error = device_quiesce(dev)) != 0)
1405 devclass_find_driver_internal(devclass_t dc, const char *classname)
1409 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1411 TAILQ_FOREACH(dl, &dc->drivers, link) {
1412 if (!strcmp(dl->driver->name, classname))
1416 PDEBUG(("not found"));
1421 * @brief Return the name of the devclass
1424 devclass_get_name(devclass_t dc)
1430 * @brief Find a device given a unit number
1432 * @param dc the devclass to search
1433 * @param unit the unit number to search for
1435 * @returns the device with the given unit number or @c
1436 * NULL if there is no such device
1439 devclass_get_device(devclass_t dc, int unit)
1441 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1443 return (dc->devices[unit]);
1447 * @brief Find the softc field of a device given a unit number
1449 * @param dc the devclass to search
1450 * @param unit the unit number to search for
1452 * @returns the softc field of the device with the given
1453 * unit number or @c NULL if there is no such
1457 devclass_get_softc(devclass_t dc, int unit)
1461 dev = devclass_get_device(dc, unit);
1465 return (device_get_softc(dev));
1469 * @brief Get a list of devices in the devclass
1471 * An array containing a list of all the devices in the given devclass
1472 * is allocated and returned in @p *devlistp. The number of devices
1473 * in the array is returned in @p *devcountp. The caller should free
1474 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1476 * @param dc the devclass to examine
1477 * @param devlistp points at location for array pointer return
1479 * @param devcountp points at location for array size return value
1482 * @retval ENOMEM the array allocation failed
1485 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1490 count = devclass_get_count(dc);
1491 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1496 for (i = 0; i < dc->maxunit; i++) {
1497 if (dc->devices[i]) {
1498 list[count] = dc->devices[i];
1510 * @brief Get a list of drivers in the devclass
1512 * An array containing a list of pointers to all the drivers in the
1513 * given devclass is allocated and returned in @p *listp. The number
1514 * of drivers in the array is returned in @p *countp. The caller should
1515 * free the array using @c free(p, M_TEMP).
1517 * @param dc the devclass to examine
1518 * @param listp gives location for array pointer return value
1519 * @param countp gives location for number of array elements
1523 * @retval ENOMEM the array allocation failed
1526 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1533 TAILQ_FOREACH(dl, &dc->drivers, link)
1535 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1540 TAILQ_FOREACH(dl, &dc->drivers, link) {
1541 list[count] = dl->driver;
1551 * @brief Get the number of devices in a devclass
1553 * @param dc the devclass to examine
1556 devclass_get_count(devclass_t dc)
1561 for (i = 0; i < dc->maxunit; i++)
1568 * @brief Get the maximum unit number used in a devclass
1570 * Note that this is one greater than the highest currently-allocated
1571 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1572 * that not even the devclass has been allocated yet.
1574 * @param dc the devclass to examine
1577 devclass_get_maxunit(devclass_t dc)
1581 return (dc->maxunit);
1585 * @brief Find a free unit number in a devclass
1587 * This function searches for the first unused unit number greater
1588 * that or equal to @p unit.
1590 * @param dc the devclass to examine
1591 * @param unit the first unit number to check
1594 devclass_find_free_unit(devclass_t dc, int unit)
1598 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1604 * @brief Set the parent of a devclass
1606 * The parent class is normally initialised automatically by
1609 * @param dc the devclass to edit
1610 * @param pdc the new parent devclass
1613 devclass_set_parent(devclass_t dc, devclass_t pdc)
1619 * @brief Get the parent of a devclass
1621 * @param dc the devclass to examine
1624 devclass_get_parent(devclass_t dc)
1626 return (dc->parent);
1629 struct sysctl_ctx_list *
1630 devclass_get_sysctl_ctx(devclass_t dc)
1632 return (&dc->sysctl_ctx);
1636 devclass_get_sysctl_tree(devclass_t dc)
1638 return (dc->sysctl_tree);
1643 * @brief Allocate a unit number
1645 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1646 * will do). The allocated unit number is returned in @p *unitp.
1648 * @param dc the devclass to allocate from
1649 * @param unitp points at the location for the allocated unit
1653 * @retval EEXIST the requested unit number is already allocated
1654 * @retval ENOMEM memory allocation failure
1657 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1662 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1664 /* Ask the parent bus if it wants to wire this device. */
1666 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1669 /* If we were given a wired unit number, check for existing device */
1672 if (unit >= 0 && unit < dc->maxunit &&
1673 dc->devices[unit] != NULL) {
1675 printf("%s: %s%d already exists; skipping it\n",
1676 dc->name, dc->name, *unitp);
1680 /* Unwired device, find the next available slot for it */
1682 for (unit = 0;; unit++) {
1683 /* If there is an "at" hint for a unit then skip it. */
1684 if (resource_string_value(dc->name, unit, "at", &s) ==
1688 /* If this device slot is already in use, skip it. */
1689 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1697 * We've selected a unit beyond the length of the table, so let's
1698 * extend the table to make room for all units up to and including
1701 if (unit >= dc->maxunit) {
1702 device_t *newlist, *oldlist;
1705 oldlist = dc->devices;
1706 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1707 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1710 if (oldlist != NULL)
1711 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1712 bzero(newlist + dc->maxunit,
1713 sizeof(device_t) * (newsize - dc->maxunit));
1714 dc->devices = newlist;
1715 dc->maxunit = newsize;
1716 if (oldlist != NULL)
1717 free(oldlist, M_BUS);
1719 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1727 * @brief Add a device to a devclass
1729 * A unit number is allocated for the device (using the device's
1730 * preferred unit number if any) and the device is registered in the
1731 * devclass. This allows the device to be looked up by its unit
1732 * number, e.g. by decoding a dev_t minor number.
1734 * @param dc the devclass to add to
1735 * @param dev the device to add
1738 * @retval EEXIST the requested unit number is already allocated
1739 * @retval ENOMEM memory allocation failure
1742 devclass_add_device(devclass_t dc, device_t dev)
1746 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1748 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1751 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1755 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1756 free(dev->nameunit, M_BUS);
1757 dev->nameunit = NULL;
1760 dc->devices[dev->unit] = dev;
1762 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1769 * @brief Delete a device from a devclass
1771 * The device is removed from the devclass's device list and its unit
1774 * @param dc the devclass to delete from
1775 * @param dev the device to delete
1780 devclass_delete_device(devclass_t dc, device_t dev)
1785 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1787 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1788 panic("devclass_delete_device: inconsistent device class");
1789 dc->devices[dev->unit] = NULL;
1790 if (dev->flags & DF_WILDCARD)
1792 dev->devclass = NULL;
1793 free(dev->nameunit, M_BUS);
1794 dev->nameunit = NULL;
1801 * @brief Make a new device and add it as a child of @p parent
1803 * @param parent the parent of the new device
1804 * @param name the devclass name of the new device or @c NULL
1805 * to leave the devclass unspecified
1806 * @parem unit the unit number of the new device of @c -1 to
1807 * leave the unit number unspecified
1809 * @returns the new device
1812 make_device(device_t parent, const char *name, int unit)
1817 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1820 dc = devclass_find_internal(name, NULL, TRUE);
1822 printf("make_device: can't find device class %s\n",
1830 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1834 dev->parent = parent;
1835 TAILQ_INIT(&dev->children);
1836 kobj_init((kobj_t) dev, &null_class);
1838 dev->devclass = NULL;
1840 dev->nameunit = NULL;
1844 dev->flags = DF_ENABLED;
1847 dev->flags |= DF_WILDCARD;
1849 dev->flags |= DF_FIXEDCLASS;
1850 if (devclass_add_device(dc, dev)) {
1851 kobj_delete((kobj_t) dev, M_BUS);
1855 if (parent != NULL && device_has_quiet_children(parent))
1856 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1860 dev->state = DS_NOTPRESENT;
1862 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1863 bus_data_generation_update();
1870 * @brief Print a description of a device.
1873 device_print_child(device_t dev, device_t child)
1877 if (device_is_alive(child))
1878 retval += BUS_PRINT_CHILD(dev, child);
1880 retval += device_printf(child, " not found\n");
1886 * @brief Create a new device
1888 * This creates a new device and adds it as a child of an existing
1889 * parent device. The new device will be added after the last existing
1890 * child with order zero.
1892 * @param dev the device which will be the parent of the
1894 * @param name devclass name for new device or @c NULL if not
1896 * @param unit unit number for new device or @c -1 if not
1899 * @returns the new device
1902 device_add_child(device_t dev, const char *name, int unit)
1904 return (device_add_child_ordered(dev, 0, name, unit));
1908 * @brief Create a new device
1910 * This creates a new device and adds it as a child of an existing
1911 * parent device. The new device will be added after the last existing
1912 * child with the same order.
1914 * @param dev the device which will be the parent of the
1916 * @param order a value which is used to partially sort the
1917 * children of @p dev - devices created using
1918 * lower values of @p order appear first in @p
1919 * dev's list of children
1920 * @param name devclass name for new device or @c NULL if not
1922 * @param unit unit number for new device or @c -1 if not
1925 * @returns the new device
1928 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1933 PDEBUG(("%s at %s with order %u as unit %d",
1934 name, DEVICENAME(dev), order, unit));
1935 KASSERT(name != NULL || unit == -1,
1936 ("child device with wildcard name and specific unit number"));
1938 child = make_device(dev, name, unit);
1941 child->order = order;
1943 TAILQ_FOREACH(place, &dev->children, link) {
1944 if (place->order > order)
1950 * The device 'place' is the first device whose order is
1951 * greater than the new child.
1953 TAILQ_INSERT_BEFORE(place, child, link);
1956 * The new child's order is greater or equal to the order of
1957 * any existing device. Add the child to the tail of the list.
1959 TAILQ_INSERT_TAIL(&dev->children, child, link);
1962 bus_data_generation_update();
1967 * @brief Delete a device
1969 * This function deletes a device along with all of its children. If
1970 * the device currently has a driver attached to it, the device is
1971 * detached first using device_detach().
1973 * @param dev the parent device
1974 * @param child the device to delete
1977 * @retval non-zero a unit error code describing the error
1980 device_delete_child(device_t dev, device_t child)
1983 device_t grandchild;
1985 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1987 /* detach parent before deleting children, if any */
1988 if ((error = device_detach(child)) != 0)
1991 /* remove children second */
1992 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1993 error = device_delete_child(child, grandchild);
1998 if (child->devclass)
1999 devclass_delete_device(child->devclass, child);
2001 BUS_CHILD_DELETED(dev, child);
2002 TAILQ_REMOVE(&dev->children, child, link);
2003 TAILQ_REMOVE(&bus_data_devices, child, devlink);
2004 kobj_delete((kobj_t) child, M_BUS);
2006 bus_data_generation_update();
2011 * @brief Delete all children devices of the given device, if any.
2013 * This function deletes all children devices of the given device, if
2014 * any, using the device_delete_child() function for each device it
2015 * finds. If a child device cannot be deleted, this function will
2016 * return an error code.
2018 * @param dev the parent device
2021 * @retval non-zero a device would not detach
2024 device_delete_children(device_t dev)
2029 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2033 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2034 error = device_delete_child(dev, child);
2036 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2044 * @brief Find a device given a unit number
2046 * This is similar to devclass_get_devices() but only searches for
2047 * devices which have @p dev as a parent.
2049 * @param dev the parent device to search
2050 * @param unit the unit number to search for. If the unit is -1,
2051 * return the first child of @p dev which has name
2052 * @p classname (that is, the one with the lowest unit.)
2054 * @returns the device with the given unit number or @c
2055 * NULL if there is no such device
2058 device_find_child(device_t dev, const char *classname, int unit)
2063 dc = devclass_find(classname);
2068 child = devclass_get_device(dc, unit);
2069 if (child && child->parent == dev)
2072 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2073 child = devclass_get_device(dc, unit);
2074 if (child && child->parent == dev)
2085 first_matching_driver(devclass_t dc, device_t dev)
2088 return (devclass_find_driver_internal(dc, dev->devclass->name));
2089 return (TAILQ_FIRST(&dc->drivers));
2096 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2098 if (dev->devclass) {
2100 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2101 if (!strcmp(dev->devclass->name, dl->driver->name))
2105 return (TAILQ_NEXT(last, link));
2112 device_probe_child(device_t dev, device_t child)
2115 driverlink_t best = NULL;
2117 int result, pri = 0;
2118 int hasclass = (child->devclass != NULL);
2124 panic("device_probe_child: parent device has no devclass");
2127 * If the state is already probed, then return. However, don't
2128 * return if we can rebid this object.
2130 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2133 for (; dc; dc = dc->parent) {
2134 for (dl = first_matching_driver(dc, child);
2136 dl = next_matching_driver(dc, child, dl)) {
2137 /* If this driver's pass is too high, then ignore it. */
2138 if (dl->pass > bus_current_pass)
2141 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2142 result = device_set_driver(child, dl->driver);
2143 if (result == ENOMEM)
2145 else if (result != 0)
2148 if (device_set_devclass(child,
2149 dl->driver->name) != 0) {
2150 char const * devname =
2151 device_get_name(child);
2152 if (devname == NULL)
2153 devname = "(unknown)";
2154 printf("driver bug: Unable to set "
2155 "devclass (class: %s "
2159 (void)device_set_driver(child, NULL);
2164 /* Fetch any flags for the device before probing. */
2165 resource_int_value(dl->driver->name, child->unit,
2166 "flags", &child->devflags);
2168 result = DEVICE_PROBE(child);
2170 /* Reset flags and devclass before the next probe. */
2171 child->devflags = 0;
2173 (void)device_set_devclass(child, NULL);
2176 * If the driver returns SUCCESS, there can be
2177 * no higher match for this device.
2186 * Reset DF_QUIET in case this driver doesn't
2187 * end up as the best driver.
2189 device_verbose(child);
2192 * Probes that return BUS_PROBE_NOWILDCARD or lower
2193 * only match on devices whose driver was explicitly
2196 if (result <= BUS_PROBE_NOWILDCARD &&
2197 !(child->flags & DF_FIXEDCLASS)) {
2202 * The driver returned an error so it
2203 * certainly doesn't match.
2206 (void)device_set_driver(child, NULL);
2211 * A priority lower than SUCCESS, remember the
2212 * best matching driver. Initialise the value
2213 * of pri for the first match.
2215 if (best == NULL || result > pri) {
2222 * If we have an unambiguous match in this devclass,
2223 * don't look in the parent.
2225 if (best && pri == 0)
2230 * If we found a driver, change state and initialise the devclass.
2232 /* XXX What happens if we rebid and got no best? */
2235 * If this device was attached, and we were asked to
2236 * rescan, and it is a different driver, then we have
2237 * to detach the old driver and reattach this new one.
2238 * Note, we don't have to check for DF_REBID here
2239 * because if the state is > DS_ALIVE, we know it must
2242 * This assumes that all DF_REBID drivers can have
2243 * their probe routine called at any time and that
2244 * they are idempotent as well as completely benign in
2245 * normal operations.
2247 * We also have to make sure that the detach
2248 * succeeded, otherwise we fail the operation (or
2249 * maybe it should just fail silently? I'm torn).
2251 if (child->state > DS_ALIVE && best->driver != child->driver)
2252 if ((result = device_detach(dev)) != 0)
2255 /* Set the winning driver, devclass, and flags. */
2256 if (!child->devclass) {
2257 result = device_set_devclass(child, best->driver->name);
2261 result = device_set_driver(child, best->driver);
2264 resource_int_value(best->driver->name, child->unit,
2265 "flags", &child->devflags);
2269 * A bit bogus. Call the probe method again to make
2270 * sure that we have the right description.
2272 DEVICE_PROBE(child);
2274 child->flags |= DF_REBID;
2277 child->flags &= ~DF_REBID;
2278 child->state = DS_ALIVE;
2280 bus_data_generation_update();
2288 * @brief Return the parent of a device
2291 device_get_parent(device_t dev)
2293 return (dev->parent);
2297 * @brief Get a list of children of a device
2299 * An array containing a list of all the children of the given device
2300 * is allocated and returned in @p *devlistp. The number of devices
2301 * in the array is returned in @p *devcountp. The caller should free
2302 * the array using @c free(p, M_TEMP).
2304 * @param dev the device to examine
2305 * @param devlistp points at location for array pointer return
2307 * @param devcountp points at location for array size return value
2310 * @retval ENOMEM the array allocation failed
2313 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2320 TAILQ_FOREACH(child, &dev->children, link) {
2329 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2334 TAILQ_FOREACH(child, &dev->children, link) {
2335 list[count] = child;
2346 * @brief Return the current driver for the device or @c NULL if there
2347 * is no driver currently attached
2350 device_get_driver(device_t dev)
2352 return (dev->driver);
2356 * @brief Return the current devclass for the device or @c NULL if
2360 device_get_devclass(device_t dev)
2362 return (dev->devclass);
2366 * @brief Return the name of the device's devclass or @c NULL if there
2370 device_get_name(device_t dev)
2372 if (dev != NULL && dev->devclass)
2373 return (devclass_get_name(dev->devclass));
2378 * @brief Return a string containing the device's devclass name
2379 * followed by an ascii representation of the device's unit number
2383 device_get_nameunit(device_t dev)
2385 return (dev->nameunit);
2389 * @brief Return the device's unit number.
2392 device_get_unit(device_t dev)
2398 * @brief Return the device's description string
2401 device_get_desc(device_t dev)
2407 * @brief Return the device's flags
2410 device_get_flags(device_t dev)
2412 return (dev->devflags);
2415 struct sysctl_ctx_list *
2416 device_get_sysctl_ctx(device_t dev)
2418 return (&dev->sysctl_ctx);
2422 device_get_sysctl_tree(device_t dev)
2424 return (dev->sysctl_tree);
2428 * @brief Print the name of the device followed by a colon and a space
2430 * @returns the number of characters printed
2433 device_print_prettyname(device_t dev)
2435 const char *name = device_get_name(dev);
2438 return (printf("unknown: "));
2439 return (printf("%s%d: ", name, device_get_unit(dev)));
2443 * @brief Print the name of the device followed by a colon, a space
2444 * and the result of calling vprintf() with the value of @p fmt and
2445 * the following arguments.
2447 * @returns the number of characters printed
2450 device_printf(device_t dev, const char * fmt, ...)
2455 retval = device_print_prettyname(dev);
2457 retval += vprintf(fmt, ap);
2466 device_set_desc_internal(device_t dev, const char* desc, int copy)
2468 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2469 free(dev->desc, M_BUS);
2470 dev->flags &= ~DF_DESCMALLOCED;
2475 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2477 strcpy(dev->desc, desc);
2478 dev->flags |= DF_DESCMALLOCED;
2481 /* Avoid a -Wcast-qual warning */
2482 dev->desc = (char *)(uintptr_t) desc;
2485 bus_data_generation_update();
2489 * @brief Set the device's description
2491 * The value of @c desc should be a string constant that will not
2492 * change (at least until the description is changed in a subsequent
2493 * call to device_set_desc() or device_set_desc_copy()).
2496 device_set_desc(device_t dev, const char* desc)
2498 device_set_desc_internal(dev, desc, FALSE);
2502 * @brief Set the device's description
2504 * The string pointed to by @c desc is copied. Use this function if
2505 * the device description is generated, (e.g. with sprintf()).
2508 device_set_desc_copy(device_t dev, const char* desc)
2510 device_set_desc_internal(dev, desc, TRUE);
2514 * @brief Set the device's flags
2517 device_set_flags(device_t dev, uint32_t flags)
2519 dev->devflags = flags;
2523 * @brief Return the device's softc field
2525 * The softc is allocated and zeroed when a driver is attached, based
2526 * on the size field of the driver.
2529 device_get_softc(device_t dev)
2531 return (dev->softc);
2535 * @brief Set the device's softc field
2537 * Most drivers do not need to use this since the softc is allocated
2538 * automatically when the driver is attached.
2541 device_set_softc(device_t dev, void *softc)
2543 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2544 free(dev->softc, M_BUS_SC);
2547 dev->flags |= DF_EXTERNALSOFTC;
2549 dev->flags &= ~DF_EXTERNALSOFTC;
2553 * @brief Free claimed softc
2555 * Most drivers do not need to use this since the softc is freed
2556 * automatically when the driver is detached.
2559 device_free_softc(void *softc)
2561 free(softc, M_BUS_SC);
2565 * @brief Claim softc
2567 * This function can be used to let the driver free the automatically
2568 * allocated softc using "device_free_softc()". This function is
2569 * useful when the driver is refcounting the softc and the softc
2570 * cannot be freed when the "device_detach" method is called.
2573 device_claim_softc(device_t dev)
2576 dev->flags |= DF_EXTERNALSOFTC;
2578 dev->flags &= ~DF_EXTERNALSOFTC;
2582 * @brief Get the device's ivars field
2584 * The ivars field is used by the parent device to store per-device
2585 * state (e.g. the physical location of the device or a list of
2589 device_get_ivars(device_t dev)
2592 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2593 return (dev->ivars);
2597 * @brief Set the device's ivars field
2600 device_set_ivars(device_t dev, void * ivars)
2603 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2608 * @brief Return the device's state
2611 device_get_state(device_t dev)
2613 return (dev->state);
2617 * @brief Set the DF_ENABLED flag for the device
2620 device_enable(device_t dev)
2622 dev->flags |= DF_ENABLED;
2626 * @brief Clear the DF_ENABLED flag for the device
2629 device_disable(device_t dev)
2631 dev->flags &= ~DF_ENABLED;
2635 * @brief Increment the busy counter for the device
2638 device_busy(device_t dev)
2640 if (dev->state < DS_ATTACHING)
2641 panic("device_busy: called for unattached device");
2642 if (dev->busy == 0 && dev->parent)
2643 device_busy(dev->parent);
2645 if (dev->state == DS_ATTACHED)
2646 dev->state = DS_BUSY;
2650 * @brief Decrement the busy counter for the device
2653 device_unbusy(device_t dev)
2655 if (dev->busy != 0 && dev->state != DS_BUSY &&
2656 dev->state != DS_ATTACHING)
2657 panic("device_unbusy: called for non-busy device %s",
2658 device_get_nameunit(dev));
2660 if (dev->busy == 0) {
2662 device_unbusy(dev->parent);
2663 if (dev->state == DS_BUSY)
2664 dev->state = DS_ATTACHED;
2669 * @brief Set the DF_QUIET flag for the device
2672 device_quiet(device_t dev)
2674 dev->flags |= DF_QUIET;
2678 * @brief Set the DF_QUIET_CHILDREN flag for the device
2681 device_quiet_children(device_t dev)
2683 dev->flags |= DF_QUIET_CHILDREN;
2687 * @brief Clear the DF_QUIET flag for the device
2690 device_verbose(device_t dev)
2692 dev->flags &= ~DF_QUIET;
2696 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2699 device_has_quiet_children(device_t dev)
2701 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2705 * @brief Return non-zero if the DF_QUIET flag is set on the device
2708 device_is_quiet(device_t dev)
2710 return ((dev->flags & DF_QUIET) != 0);
2714 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2717 device_is_enabled(device_t dev)
2719 return ((dev->flags & DF_ENABLED) != 0);
2723 * @brief Return non-zero if the device was successfully probed
2726 device_is_alive(device_t dev)
2728 return (dev->state >= DS_ALIVE);
2732 * @brief Return non-zero if the device currently has a driver
2736 device_is_attached(device_t dev)
2738 return (dev->state >= DS_ATTACHED);
2742 * @brief Return non-zero if the device is currently suspended.
2745 device_is_suspended(device_t dev)
2747 return ((dev->flags & DF_SUSPENDED) != 0);
2751 * @brief Set the devclass of a device
2752 * @see devclass_add_device().
2755 device_set_devclass(device_t dev, const char *classname)
2762 devclass_delete_device(dev->devclass, dev);
2766 if (dev->devclass) {
2767 printf("device_set_devclass: device class already set\n");
2771 dc = devclass_find_internal(classname, NULL, TRUE);
2775 error = devclass_add_device(dc, dev);
2777 bus_data_generation_update();
2782 * @brief Set the devclass of a device and mark the devclass fixed.
2783 * @see device_set_devclass()
2786 device_set_devclass_fixed(device_t dev, const char *classname)
2790 if (classname == NULL)
2793 error = device_set_devclass(dev, classname);
2796 dev->flags |= DF_FIXEDCLASS;
2801 * @brief Set the driver of a device
2804 * @retval EBUSY the device already has a driver attached
2805 * @retval ENOMEM a memory allocation failure occurred
2808 device_set_driver(device_t dev, driver_t *driver)
2810 if (dev->state >= DS_ATTACHED)
2813 if (dev->driver == driver)
2816 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2817 free(dev->softc, M_BUS_SC);
2820 device_set_desc(dev, NULL);
2821 kobj_delete((kobj_t) dev, NULL);
2822 dev->driver = driver;
2824 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2825 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2826 dev->softc = malloc(driver->size, M_BUS_SC,
2829 kobj_delete((kobj_t) dev, NULL);
2830 kobj_init((kobj_t) dev, &null_class);
2836 kobj_init((kobj_t) dev, &null_class);
2839 bus_data_generation_update();
2844 * @brief Probe a device, and return this status.
2846 * This function is the core of the device autoconfiguration
2847 * system. Its purpose is to select a suitable driver for a device and
2848 * then call that driver to initialise the hardware appropriately. The
2849 * driver is selected by calling the DEVICE_PROBE() method of a set of
2850 * candidate drivers and then choosing the driver which returned the
2851 * best value. This driver is then attached to the device using
2854 * The set of suitable drivers is taken from the list of drivers in
2855 * the parent device's devclass. If the device was originally created
2856 * with a specific class name (see device_add_child()), only drivers
2857 * with that name are probed, otherwise all drivers in the devclass
2858 * are probed. If no drivers return successful probe values in the
2859 * parent devclass, the search continues in the parent of that
2860 * devclass (see devclass_get_parent()) if any.
2862 * @param dev the device to initialise
2865 * @retval ENXIO no driver was found
2866 * @retval ENOMEM memory allocation failure
2867 * @retval non-zero some other unix error code
2868 * @retval -1 Device already attached
2871 device_probe(device_t dev)
2877 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2880 if (!(dev->flags & DF_ENABLED)) {
2881 if (bootverbose && device_get_name(dev) != NULL) {
2882 device_print_prettyname(dev);
2883 printf("not probed (disabled)\n");
2887 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2888 if (bus_current_pass == BUS_PASS_DEFAULT &&
2889 !(dev->flags & DF_DONENOMATCH)) {
2890 BUS_PROBE_NOMATCH(dev->parent, dev);
2892 dev->flags |= DF_DONENOMATCH;
2900 * @brief Probe a device and attach a driver if possible
2902 * calls device_probe() and attaches if that was successful.
2905 device_probe_and_attach(device_t dev)
2911 error = device_probe(dev);
2914 else if (error != 0)
2917 CURVNET_SET_QUIET(vnet0);
2918 error = device_attach(dev);
2924 * @brief Attach a device driver to a device
2926 * This function is a wrapper around the DEVICE_ATTACH() driver
2927 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2928 * device's sysctl tree, optionally prints a description of the device
2929 * and queues a notification event for user-based device management
2932 * Normally this function is only called internally from
2933 * device_probe_and_attach().
2935 * @param dev the device to initialise
2938 * @retval ENXIO no driver was found
2939 * @retval ENOMEM memory allocation failure
2940 * @retval non-zero some other unix error code
2943 device_attach(device_t dev)
2945 uint64_t attachtime;
2948 if (resource_disabled(dev->driver->name, dev->unit)) {
2949 device_disable(dev);
2951 device_printf(dev, "disabled via hints entry\n");
2955 device_sysctl_init(dev);
2956 if (!device_is_quiet(dev))
2957 device_print_child(dev->parent, dev);
2958 attachtime = get_cyclecount();
2959 dev->state = DS_ATTACHING;
2960 if ((error = DEVICE_ATTACH(dev)) != 0) {
2961 printf("device_attach: %s%d attach returned %d\n",
2962 dev->driver->name, dev->unit, error);
2963 if (!(dev->flags & DF_FIXEDCLASS))
2964 devclass_delete_device(dev->devclass, dev);
2965 (void)device_set_driver(dev, NULL);
2966 device_sysctl_fini(dev);
2967 KASSERT(dev->busy == 0, ("attach failed but busy"));
2968 dev->state = DS_NOTPRESENT;
2971 attachtime = get_cyclecount() - attachtime;
2973 * 4 bits per device is a reasonable value for desktop and server
2974 * hardware with good get_cyclecount() implementations, but WILL
2975 * need to be adjusted on other platforms.
2977 #define RANDOM_PROBE_BIT_GUESS 4
2979 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n",
2980 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS,
2981 dev->driver->name, dev->unit);
2982 random_harvest_direct(&attachtime, sizeof(attachtime),
2983 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH);
2984 device_sysctl_update(dev);
2986 dev->state = DS_BUSY;
2988 dev->state = DS_ATTACHED;
2989 dev->flags &= ~DF_DONENOMATCH;
2990 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2996 * @brief Detach a driver from a device
2998 * This function is a wrapper around the DEVICE_DETACH() driver
2999 * method. If the call to DEVICE_DETACH() succeeds, it calls
3000 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
3001 * notification event for user-based device management services and
3002 * cleans up the device's sysctl tree.
3004 * @param dev the device to un-initialise
3007 * @retval ENXIO no driver was found
3008 * @retval ENOMEM memory allocation failure
3009 * @retval non-zero some other unix error code
3012 device_detach(device_t dev)
3018 PDEBUG(("%s", DEVICENAME(dev)));
3019 if (dev->state == DS_BUSY)
3021 if (dev->state != DS_ATTACHED)
3024 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3025 if ((error = DEVICE_DETACH(dev)) != 0) {
3026 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3027 EVHDEV_DETACH_FAILED);
3030 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3031 EVHDEV_DETACH_COMPLETE);
3034 if (!device_is_quiet(dev))
3035 device_printf(dev, "detached\n");
3037 BUS_CHILD_DETACHED(dev->parent, dev);
3039 if (!(dev->flags & DF_FIXEDCLASS))
3040 devclass_delete_device(dev->devclass, dev);
3042 device_verbose(dev);
3043 dev->state = DS_NOTPRESENT;
3044 (void)device_set_driver(dev, NULL);
3045 device_sysctl_fini(dev);
3051 * @brief Tells a driver to quiesce itself.
3053 * This function is a wrapper around the DEVICE_QUIESCE() driver
3054 * method. If the call to DEVICE_QUIESCE() succeeds.
3056 * @param dev the device to quiesce
3059 * @retval ENXIO no driver was found
3060 * @retval ENOMEM memory allocation failure
3061 * @retval non-zero some other unix error code
3064 device_quiesce(device_t dev)
3067 PDEBUG(("%s", DEVICENAME(dev)));
3068 if (dev->state == DS_BUSY)
3070 if (dev->state != DS_ATTACHED)
3073 return (DEVICE_QUIESCE(dev));
3077 * @brief Notify a device of system shutdown
3079 * This function calls the DEVICE_SHUTDOWN() driver method if the
3080 * device currently has an attached driver.
3082 * @returns the value returned by DEVICE_SHUTDOWN()
3085 device_shutdown(device_t dev)
3087 if (dev->state < DS_ATTACHED)
3089 return (DEVICE_SHUTDOWN(dev));
3093 * @brief Set the unit number of a device
3095 * This function can be used to override the unit number used for a
3096 * device (e.g. to wire a device to a pre-configured unit number).
3099 device_set_unit(device_t dev, int unit)
3104 dc = device_get_devclass(dev);
3105 if (unit < dc->maxunit && dc->devices[unit])
3107 err = devclass_delete_device(dc, dev);
3111 err = devclass_add_device(dc, dev);
3115 bus_data_generation_update();
3119 /*======================================*/
3121 * Some useful method implementations to make life easier for bus drivers.
3125 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3130 args->memattr = VM_MEMATTR_UNCACHEABLE;
3134 * @brief Initialise a resource list.
3136 * @param rl the resource list to initialise
3139 resource_list_init(struct resource_list *rl)
3145 * @brief Reclaim memory used by a resource list.
3147 * This function frees the memory for all resource entries on the list
3150 * @param rl the resource list to free
3153 resource_list_free(struct resource_list *rl)
3155 struct resource_list_entry *rle;
3157 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3159 panic("resource_list_free: resource entry is busy");
3160 STAILQ_REMOVE_HEAD(rl, link);
3166 * @brief Add a resource entry.
3168 * This function adds a resource entry using the given @p type, @p
3169 * start, @p end and @p count values. A rid value is chosen by
3170 * searching sequentially for the first unused rid starting at zero.
3172 * @param rl the resource list to edit
3173 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3174 * @param start the start address of the resource
3175 * @param end the end address of the resource
3176 * @param count XXX end-start+1
3179 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3180 rman_res_t end, rman_res_t count)
3185 while (resource_list_find(rl, type, rid) != NULL)
3187 resource_list_add(rl, type, rid, start, end, count);
3192 * @brief Add or modify a resource entry.
3194 * If an existing entry exists with the same type and rid, it will be
3195 * modified using the given values of @p start, @p end and @p
3196 * count. If no entry exists, a new one will be created using the
3197 * given values. The resource list entry that matches is then returned.
3199 * @param rl the resource list to edit
3200 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3201 * @param rid the resource identifier
3202 * @param start the start address of the resource
3203 * @param end the end address of the resource
3204 * @param count XXX end-start+1
3206 struct resource_list_entry *
3207 resource_list_add(struct resource_list *rl, int type, int rid,
3208 rman_res_t start, rman_res_t end, rman_res_t count)
3210 struct resource_list_entry *rle;
3212 rle = resource_list_find(rl, type, rid);
3214 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3217 panic("resource_list_add: can't record entry");
3218 STAILQ_INSERT_TAIL(rl, rle, link);
3226 panic("resource_list_add: resource entry is busy");
3235 * @brief Determine if a resource entry is busy.
3237 * Returns true if a resource entry is busy meaning that it has an
3238 * associated resource that is not an unallocated "reserved" resource.
3240 * @param rl the resource list to search
3241 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3242 * @param rid the resource identifier
3244 * @returns Non-zero if the entry is busy, zero otherwise.
3247 resource_list_busy(struct resource_list *rl, int type, int rid)
3249 struct resource_list_entry *rle;
3251 rle = resource_list_find(rl, type, rid);
3252 if (rle == NULL || rle->res == NULL)
3254 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3255 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3256 ("reserved resource is active"));
3263 * @brief Determine if a resource entry is reserved.
3265 * Returns true if a resource entry is reserved meaning that it has an
3266 * associated "reserved" resource. The resource can either be
3267 * allocated or unallocated.
3269 * @param rl the resource list to search
3270 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3271 * @param rid the resource identifier
3273 * @returns Non-zero if the entry is reserved, zero otherwise.
3276 resource_list_reserved(struct resource_list *rl, int type, int rid)
3278 struct resource_list_entry *rle;
3280 rle = resource_list_find(rl, type, rid);
3281 if (rle != NULL && rle->flags & RLE_RESERVED)
3287 * @brief Find a resource entry by type and rid.
3289 * @param rl the resource list to search
3290 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3291 * @param rid the resource identifier
3293 * @returns the resource entry pointer or NULL if there is no such
3296 struct resource_list_entry *
3297 resource_list_find(struct resource_list *rl, int type, int rid)
3299 struct resource_list_entry *rle;
3301 STAILQ_FOREACH(rle, rl, link) {
3302 if (rle->type == type && rle->rid == rid)
3309 * @brief Delete a resource entry.
3311 * @param rl the resource list to edit
3312 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3313 * @param rid the resource identifier
3316 resource_list_delete(struct resource_list *rl, int type, int rid)
3318 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3321 if (rle->res != NULL)
3322 panic("resource_list_delete: resource has not been released");
3323 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3329 * @brief Allocate a reserved resource
3331 * This can be used by buses to force the allocation of resources
3332 * that are always active in the system even if they are not allocated
3333 * by a driver (e.g. PCI BARs). This function is usually called when
3334 * adding a new child to the bus. The resource is allocated from the
3335 * parent bus when it is reserved. The resource list entry is marked
3336 * with RLE_RESERVED to note that it is a reserved resource.
3338 * Subsequent attempts to allocate the resource with
3339 * resource_list_alloc() will succeed the first time and will set
3340 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3341 * resource that has been allocated is released with
3342 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3343 * the actual resource remains allocated. The resource can be released to
3344 * the parent bus by calling resource_list_unreserve().
3346 * @param rl the resource list to allocate from
3347 * @param bus the parent device of @p child
3348 * @param child the device for which the resource is being reserved
3349 * @param type the type of resource to allocate
3350 * @param rid a pointer to the resource identifier
3351 * @param start hint at the start of the resource range - pass
3352 * @c 0 for any start address
3353 * @param end hint at the end of the resource range - pass
3354 * @c ~0 for any end address
3355 * @param count hint at the size of range required - pass @c 1
3357 * @param flags any extra flags to control the resource
3358 * allocation - see @c RF_XXX flags in
3359 * <sys/rman.h> for details
3361 * @returns the resource which was allocated or @c NULL if no
3362 * resource could be allocated
3365 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3366 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3368 struct resource_list_entry *rle = NULL;
3369 int passthrough = (device_get_parent(child) != bus);
3374 "resource_list_reserve() should only be called for direct children");
3375 if (flags & RF_ACTIVE)
3377 "resource_list_reserve() should only reserve inactive resources");
3379 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3382 rle = resource_list_find(rl, type, *rid);
3383 rle->flags |= RLE_RESERVED;
3389 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3391 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3392 * and passing the allocation up to the parent of @p bus. This assumes
3393 * that the first entry of @c device_get_ivars(child) is a struct
3394 * resource_list. This also handles 'passthrough' allocations where a
3395 * child is a remote descendant of bus by passing the allocation up to
3396 * the parent of bus.
3398 * Typically, a bus driver would store a list of child resources
3399 * somewhere in the child device's ivars (see device_get_ivars()) and
3400 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3401 * then call resource_list_alloc() to perform the allocation.
3403 * @param rl the resource list to allocate from
3404 * @param bus the parent device of @p child
3405 * @param child the device which is requesting an allocation
3406 * @param type the type of resource to allocate
3407 * @param rid a pointer to the resource identifier
3408 * @param start hint at the start of the resource range - pass
3409 * @c 0 for any start address
3410 * @param end hint at the end of the resource range - pass
3411 * @c ~0 for any end address
3412 * @param count hint at the size of range required - pass @c 1
3414 * @param flags any extra flags to control the resource
3415 * allocation - see @c RF_XXX flags in
3416 * <sys/rman.h> for details
3418 * @returns the resource which was allocated or @c NULL if no
3419 * resource could be allocated
3422 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3423 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3425 struct resource_list_entry *rle = NULL;
3426 int passthrough = (device_get_parent(child) != bus);
3427 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3430 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3431 type, rid, start, end, count, flags));
3434 rle = resource_list_find(rl, type, *rid);
3437 return (NULL); /* no resource of that type/rid */
3440 if (rle->flags & RLE_RESERVED) {
3441 if (rle->flags & RLE_ALLOCATED)
3443 if ((flags & RF_ACTIVE) &&
3444 bus_activate_resource(child, type, *rid,
3447 rle->flags |= RLE_ALLOCATED;
3451 "resource entry %#x type %d for child %s is busy\n", *rid,
3452 type, device_get_nameunit(child));
3458 count = ulmax(count, rle->count);
3459 end = ulmax(rle->end, start + count - 1);
3462 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3463 type, rid, start, end, count, flags);
3466 * Record the new range.
3469 rle->start = rman_get_start(rle->res);
3470 rle->end = rman_get_end(rle->res);
3478 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3480 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3481 * used with resource_list_alloc().
3483 * @param rl the resource list which was allocated from
3484 * @param bus the parent device of @p child
3485 * @param child the device which is requesting a release
3486 * @param type the type of resource to release
3487 * @param rid the resource identifier
3488 * @param res the resource to release
3491 * @retval non-zero a standard unix error code indicating what
3492 * error condition prevented the operation
3495 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3496 int type, int rid, struct resource *res)
3498 struct resource_list_entry *rle = NULL;
3499 int passthrough = (device_get_parent(child) != bus);
3503 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3507 rle = resource_list_find(rl, type, rid);
3510 panic("resource_list_release: can't find resource");
3512 panic("resource_list_release: resource entry is not busy");
3513 if (rle->flags & RLE_RESERVED) {
3514 if (rle->flags & RLE_ALLOCATED) {
3515 if (rman_get_flags(res) & RF_ACTIVE) {
3516 error = bus_deactivate_resource(child, type,
3521 rle->flags &= ~RLE_ALLOCATED;
3527 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3537 * @brief Release all active resources of a given type
3539 * Release all active resources of a specified type. This is intended
3540 * to be used to cleanup resources leaked by a driver after detach or
3543 * @param rl the resource list which was allocated from
3544 * @param bus the parent device of @p child
3545 * @param child the device whose active resources are being released
3546 * @param type the type of resources to release
3549 * @retval EBUSY at least one resource was active
3552 resource_list_release_active(struct resource_list *rl, device_t bus,
3553 device_t child, int type)
3555 struct resource_list_entry *rle;
3559 STAILQ_FOREACH(rle, rl, link) {
3560 if (rle->type != type)
3562 if (rle->res == NULL)
3564 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3568 error = resource_list_release(rl, bus, child, type,
3569 rman_get_rid(rle->res), rle->res);
3572 "Failed to release active resource: %d\n", error);
3579 * @brief Fully release a reserved resource
3581 * Fully releases a resource reserved via resource_list_reserve().
3583 * @param rl the resource list which was allocated from
3584 * @param bus the parent device of @p child
3585 * @param child the device whose reserved resource is being released
3586 * @param type the type of resource to release
3587 * @param rid the resource identifier
3588 * @param res the resource to release
3591 * @retval non-zero a standard unix error code indicating what
3592 * error condition prevented the operation
3595 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3598 struct resource_list_entry *rle = NULL;
3599 int passthrough = (device_get_parent(child) != bus);
3603 "resource_list_unreserve() should only be called for direct children");
3605 rle = resource_list_find(rl, type, rid);
3608 panic("resource_list_unreserve: can't find resource");
3609 if (!(rle->flags & RLE_RESERVED))
3611 if (rle->flags & RLE_ALLOCATED)
3613 rle->flags &= ~RLE_RESERVED;
3614 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3618 * @brief Print a description of resources in a resource list
3620 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3621 * The name is printed if at least one resource of the given type is available.
3622 * The format is used to print resource start and end.
3624 * @param rl the resource list to print
3625 * @param name the name of @p type, e.g. @c "memory"
3626 * @param type type type of resource entry to print
3627 * @param format printf(9) format string to print resource
3628 * start and end values
3630 * @returns the number of characters printed
3633 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3636 struct resource_list_entry *rle;
3637 int printed, retval;
3641 /* Yes, this is kinda cheating */
3642 STAILQ_FOREACH(rle, rl, link) {
3643 if (rle->type == type) {
3645 retval += printf(" %s ", name);
3647 retval += printf(",");
3649 retval += printf(format, rle->start);
3650 if (rle->count > 1) {
3651 retval += printf("-");
3652 retval += printf(format, rle->start +
3661 * @brief Releases all the resources in a list.
3663 * @param rl The resource list to purge.
3668 resource_list_purge(struct resource_list *rl)
3670 struct resource_list_entry *rle;
3672 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3674 bus_release_resource(rman_get_device(rle->res),
3675 rle->type, rle->rid, rle->res);
3676 STAILQ_REMOVE_HEAD(rl, link);
3682 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3685 return (device_add_child_ordered(dev, order, name, unit));
3689 * @brief Helper function for implementing DEVICE_PROBE()
3691 * This function can be used to help implement the DEVICE_PROBE() for
3692 * a bus (i.e. a device which has other devices attached to it). It
3693 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3697 bus_generic_probe(device_t dev)
3699 devclass_t dc = dev->devclass;
3702 TAILQ_FOREACH(dl, &dc->drivers, link) {
3704 * If this driver's pass is too high, then ignore it.
3705 * For most drivers in the default pass, this will
3706 * never be true. For early-pass drivers they will
3707 * only call the identify routines of eligible drivers
3708 * when this routine is called. Drivers for later
3709 * passes should have their identify routines called
3710 * on early-pass buses during BUS_NEW_PASS().
3712 if (dl->pass > bus_current_pass)
3714 DEVICE_IDENTIFY(dl->driver, dev);
3721 * @brief Helper function for implementing DEVICE_ATTACH()
3723 * This function can be used to help implement the DEVICE_ATTACH() for
3724 * a bus. It calls device_probe_and_attach() for each of the device's
3728 bus_generic_attach(device_t dev)
3732 TAILQ_FOREACH(child, &dev->children, link) {
3733 device_probe_and_attach(child);
3740 * @brief Helper function for implementing DEVICE_DETACH()
3742 * This function can be used to help implement the DEVICE_DETACH() for
3743 * a bus. It calls device_detach() for each of the device's
3747 bus_generic_detach(device_t dev)
3752 if (dev->state != DS_ATTACHED)
3756 * Detach children in the reverse order.
3757 * See bus_generic_suspend for details.
3759 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3760 if ((error = device_detach(child)) != 0)
3768 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3770 * This function can be used to help implement the DEVICE_SHUTDOWN()
3771 * for a bus. It calls device_shutdown() for each of the device's
3775 bus_generic_shutdown(device_t dev)
3780 * Shut down children in the reverse order.
3781 * See bus_generic_suspend for details.
3783 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3784 device_shutdown(child);
3791 * @brief Default function for suspending a child device.
3793 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3796 bus_generic_suspend_child(device_t dev, device_t child)
3800 error = DEVICE_SUSPEND(child);
3803 child->flags |= DF_SUSPENDED;
3809 * @brief Default function for resuming a child device.
3811 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3814 bus_generic_resume_child(device_t dev, device_t child)
3817 DEVICE_RESUME(child);
3818 child->flags &= ~DF_SUSPENDED;
3824 * @brief Helper function for implementing DEVICE_SUSPEND()
3826 * This function can be used to help implement the DEVICE_SUSPEND()
3827 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3828 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3829 * operation is aborted and any devices which were suspended are
3830 * resumed immediately by calling their DEVICE_RESUME() methods.
3833 bus_generic_suspend(device_t dev)
3839 * Suspend children in the reverse order.
3840 * For most buses all children are equal, so the order does not matter.
3841 * Other buses, such as acpi, carefully order their child devices to
3842 * express implicit dependencies between them. For such buses it is
3843 * safer to bring down devices in the reverse order.
3845 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3846 error = BUS_SUSPEND_CHILD(dev, child);
3848 child = TAILQ_NEXT(child, link);
3849 if (child != NULL) {
3850 TAILQ_FOREACH_FROM(child, &dev->children, link)
3851 BUS_RESUME_CHILD(dev, child);
3860 * @brief Helper function for implementing DEVICE_RESUME()
3862 * This function can be used to help implement the DEVICE_RESUME() for
3863 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3866 bus_generic_resume(device_t dev)
3870 TAILQ_FOREACH(child, &dev->children, link) {
3871 BUS_RESUME_CHILD(dev, child);
3872 /* if resume fails, there's nothing we can usefully do... */
3878 * @brief Helper function for implementing BUS_PRINT_CHILD().
3880 * This function prints the first part of the ascii representation of
3881 * @p child, including its name, unit and description (if any - see
3882 * device_set_desc()).
3884 * @returns the number of characters printed
3887 bus_print_child_header(device_t dev, device_t child)
3891 if (device_get_desc(child)) {
3892 retval += device_printf(child, "<%s>", device_get_desc(child));
3894 retval += printf("%s", device_get_nameunit(child));
3901 * @brief Helper function for implementing BUS_PRINT_CHILD().
3903 * This function prints the last part of the ascii representation of
3904 * @p child, which consists of the string @c " on " followed by the
3905 * name and unit of the @p dev.
3907 * @returns the number of characters printed
3910 bus_print_child_footer(device_t dev, device_t child)
3912 return (printf(" on %s\n", device_get_nameunit(dev)));
3916 * @brief Helper function for implementing BUS_PRINT_CHILD().
3918 * This function prints out the VM domain for the given device.
3920 * @returns the number of characters printed
3923 bus_print_child_domain(device_t dev, device_t child)
3927 /* No domain? Don't print anything */
3928 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3931 return (printf(" numa-domain %d", domain));
3935 * @brief Helper function for implementing BUS_PRINT_CHILD().
3937 * This function simply calls bus_print_child_header() followed by
3938 * bus_print_child_footer().
3940 * @returns the number of characters printed
3943 bus_generic_print_child(device_t dev, device_t child)
3947 retval += bus_print_child_header(dev, child);
3948 retval += bus_print_child_domain(dev, child);
3949 retval += bus_print_child_footer(dev, child);
3955 * @brief Stub function for implementing BUS_READ_IVAR().
3960 bus_generic_read_ivar(device_t dev, device_t child, int index,
3967 * @brief Stub function for implementing BUS_WRITE_IVAR().
3972 bus_generic_write_ivar(device_t dev, device_t child, int index,
3979 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3983 struct resource_list *
3984 bus_generic_get_resource_list(device_t dev, device_t child)
3990 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3992 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3993 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3994 * and then calls device_probe_and_attach() for each unattached child.
3997 bus_generic_driver_added(device_t dev, driver_t *driver)
4001 DEVICE_IDENTIFY(driver, dev);
4002 TAILQ_FOREACH(child, &dev->children, link) {
4003 if (child->state == DS_NOTPRESENT ||
4004 (child->flags & DF_REBID))
4005 device_probe_and_attach(child);
4010 * @brief Helper function for implementing BUS_NEW_PASS().
4012 * This implementing of BUS_NEW_PASS() first calls the identify
4013 * routines for any drivers that probe at the current pass. Then it
4014 * walks the list of devices for this bus. If a device is already
4015 * attached, then it calls BUS_NEW_PASS() on that device. If the
4016 * device is not already attached, it attempts to attach a driver to
4020 bus_generic_new_pass(device_t dev)
4027 TAILQ_FOREACH(dl, &dc->drivers, link) {
4028 if (dl->pass == bus_current_pass)
4029 DEVICE_IDENTIFY(dl->driver, dev);
4031 TAILQ_FOREACH(child, &dev->children, link) {
4032 if (child->state >= DS_ATTACHED)
4033 BUS_NEW_PASS(child);
4034 else if (child->state == DS_NOTPRESENT)
4035 device_probe_and_attach(child);
4040 * @brief Helper function for implementing BUS_SETUP_INTR().
4042 * This simple implementation of BUS_SETUP_INTR() simply calls the
4043 * BUS_SETUP_INTR() method of the parent of @p dev.
4046 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4047 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4050 /* Propagate up the bus hierarchy until someone handles it. */
4052 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4053 filter, intr, arg, cookiep));
4058 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4060 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4061 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4064 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4067 /* Propagate up the bus hierarchy until someone handles it. */
4069 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4074 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4076 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4077 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4080 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4081 struct resource *r, rman_res_t start, rman_res_t end)
4083 /* Propagate up the bus hierarchy until someone handles it. */
4085 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4091 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4093 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4094 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4097 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4098 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4100 /* Propagate up the bus hierarchy until someone handles it. */
4102 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4103 start, end, count, flags));
4108 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4110 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4111 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4114 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4117 /* Propagate up the bus hierarchy until someone handles it. */
4119 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4125 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4127 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4128 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4131 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4134 /* Propagate up the bus hierarchy until someone handles it. */
4136 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4142 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4144 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4145 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4148 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4149 int rid, struct resource *r)
4151 /* Propagate up the bus hierarchy until someone handles it. */
4153 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4159 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4161 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4162 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4165 bus_generic_map_resource(device_t dev, device_t child, int type,
4166 struct resource *r, struct resource_map_request *args,
4167 struct resource_map *map)
4169 /* Propagate up the bus hierarchy until someone handles it. */
4171 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4177 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4179 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4180 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4183 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4184 struct resource *r, struct resource_map *map)
4186 /* Propagate up the bus hierarchy until someone handles it. */
4188 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4193 * @brief Helper function for implementing BUS_BIND_INTR().
4195 * This simple implementation of BUS_BIND_INTR() simply calls the
4196 * BUS_BIND_INTR() method of the parent of @p dev.
4199 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4203 /* Propagate up the bus hierarchy until someone handles it. */
4205 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4210 * @brief Helper function for implementing BUS_CONFIG_INTR().
4212 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4213 * BUS_CONFIG_INTR() method of the parent of @p dev.
4216 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4217 enum intr_polarity pol)
4220 /* Propagate up the bus hierarchy until someone handles it. */
4222 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4227 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4229 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4230 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4233 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4234 void *cookie, const char *descr)
4237 /* Propagate up the bus hierarchy until someone handles it. */
4239 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4245 * @brief Helper function for implementing BUS_GET_CPUS().
4247 * This simple implementation of BUS_GET_CPUS() simply calls the
4248 * BUS_GET_CPUS() method of the parent of @p dev.
4251 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4252 size_t setsize, cpuset_t *cpuset)
4255 /* Propagate up the bus hierarchy until someone handles it. */
4256 if (dev->parent != NULL)
4257 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4262 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4264 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4265 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4268 bus_generic_get_dma_tag(device_t dev, device_t child)
4271 /* Propagate up the bus hierarchy until someone handles it. */
4272 if (dev->parent != NULL)
4273 return (BUS_GET_DMA_TAG(dev->parent, child));
4278 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4280 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4281 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4284 bus_generic_get_bus_tag(device_t dev, device_t child)
4287 /* Propagate up the bus hierarchy until someone handles it. */
4288 if (dev->parent != NULL)
4289 return (BUS_GET_BUS_TAG(dev->parent, child));
4290 return ((bus_space_tag_t)0);
4294 * @brief Helper function for implementing BUS_GET_RESOURCE().
4296 * This implementation of BUS_GET_RESOURCE() uses the
4297 * resource_list_find() function to do most of the work. It calls
4298 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4302 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4303 rman_res_t *startp, rman_res_t *countp)
4305 struct resource_list * rl = NULL;
4306 struct resource_list_entry * rle = NULL;
4308 rl = BUS_GET_RESOURCE_LIST(dev, child);
4312 rle = resource_list_find(rl, type, rid);
4317 *startp = rle->start;
4319 *countp = rle->count;
4325 * @brief Helper function for implementing BUS_SET_RESOURCE().
4327 * This implementation of BUS_SET_RESOURCE() uses the
4328 * resource_list_add() function to do most of the work. It calls
4329 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4333 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4334 rman_res_t start, rman_res_t count)
4336 struct resource_list * rl = NULL;
4338 rl = BUS_GET_RESOURCE_LIST(dev, child);
4342 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4348 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4350 * This implementation of BUS_DELETE_RESOURCE() uses the
4351 * resource_list_delete() function to do most of the work. It calls
4352 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4356 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4358 struct resource_list * rl = NULL;
4360 rl = BUS_GET_RESOURCE_LIST(dev, child);
4364 resource_list_delete(rl, type, rid);
4370 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4372 * This implementation of BUS_RELEASE_RESOURCE() uses the
4373 * resource_list_release() function to do most of the work. It calls
4374 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4377 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4378 int rid, struct resource *r)
4380 struct resource_list * rl = NULL;
4382 if (device_get_parent(child) != dev)
4383 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4386 rl = BUS_GET_RESOURCE_LIST(dev, child);
4390 return (resource_list_release(rl, dev, child, type, rid, r));
4394 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4396 * This implementation of BUS_ALLOC_RESOURCE() uses the
4397 * resource_list_alloc() function to do most of the work. It calls
4398 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4401 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4402 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4404 struct resource_list * rl = NULL;
4406 if (device_get_parent(child) != dev)
4407 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4408 type, rid, start, end, count, flags));
4410 rl = BUS_GET_RESOURCE_LIST(dev, child);
4414 return (resource_list_alloc(rl, dev, child, type, rid,
4415 start, end, count, flags));
4419 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4421 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4422 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4425 bus_generic_child_present(device_t dev, device_t child)
4427 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4431 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4435 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4441 * @brief Helper function for implementing BUS_RESCAN().
4443 * This null implementation of BUS_RESCAN() always fails to indicate
4444 * the bus does not support rescanning.
4447 bus_null_rescan(device_t dev)
4454 * Some convenience functions to make it easier for drivers to use the
4455 * resource-management functions. All these really do is hide the
4456 * indirection through the parent's method table, making for slightly
4457 * less-wordy code. In the future, it might make sense for this code
4458 * to maintain some sort of a list of resources allocated by each device.
4462 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4463 struct resource **res)
4467 for (i = 0; rs[i].type != -1; i++)
4469 for (i = 0; rs[i].type != -1; i++) {
4470 res[i] = bus_alloc_resource_any(dev,
4471 rs[i].type, &rs[i].rid, rs[i].flags);
4472 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4473 bus_release_resources(dev, rs, res);
4481 bus_release_resources(device_t dev, const struct resource_spec *rs,
4482 struct resource **res)
4486 for (i = 0; rs[i].type != -1; i++)
4487 if (res[i] != NULL) {
4488 bus_release_resource(
4489 dev, rs[i].type, rs[i].rid, res[i]);
4495 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4497 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4501 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4502 rman_res_t end, rman_res_t count, u_int flags)
4504 struct resource *res;
4506 if (dev->parent == NULL)
4508 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4514 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4516 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4520 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4523 if (dev->parent == NULL)
4525 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4529 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4531 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4535 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4537 if (dev->parent == NULL)
4539 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4543 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4545 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4549 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4551 if (dev->parent == NULL)
4553 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4557 * @brief Wrapper function for BUS_MAP_RESOURCE().
4559 * This function simply calls the BUS_MAP_RESOURCE() method of the
4563 bus_map_resource(device_t dev, int type, struct resource *r,
4564 struct resource_map_request *args, struct resource_map *map)
4566 if (dev->parent == NULL)
4568 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4572 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4574 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4578 bus_unmap_resource(device_t dev, int type, struct resource *r,
4579 struct resource_map *map)
4581 if (dev->parent == NULL)
4583 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4587 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4589 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4593 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4597 if (dev->parent == NULL)
4599 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4604 * @brief Wrapper function for BUS_SETUP_INTR().
4606 * This function simply calls the BUS_SETUP_INTR() method of the
4610 bus_setup_intr(device_t dev, struct resource *r, int flags,
4611 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4615 if (dev->parent == NULL)
4617 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4621 if (handler != NULL && !(flags & INTR_MPSAFE))
4622 device_printf(dev, "[GIANT-LOCKED]\n");
4627 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4629 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4633 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4635 if (dev->parent == NULL)
4637 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4641 * @brief Wrapper function for BUS_BIND_INTR().
4643 * This function simply calls the BUS_BIND_INTR() method of the
4647 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4649 if (dev->parent == NULL)
4651 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4655 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4657 * This function first formats the requested description into a
4658 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4659 * the parent of @p dev.
4662 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4663 const char *fmt, ...)
4666 char descr[MAXCOMLEN + 1];
4668 if (dev->parent == NULL)
4671 vsnprintf(descr, sizeof(descr), fmt, ap);
4673 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4677 * @brief Wrapper function for BUS_SET_RESOURCE().
4679 * This function simply calls the BUS_SET_RESOURCE() method of the
4683 bus_set_resource(device_t dev, int type, int rid,
4684 rman_res_t start, rman_res_t count)
4686 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4691 * @brief Wrapper function for BUS_GET_RESOURCE().
4693 * This function simply calls the BUS_GET_RESOURCE() method of the
4697 bus_get_resource(device_t dev, int type, int rid,
4698 rman_res_t *startp, rman_res_t *countp)
4700 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4705 * @brief Wrapper function for BUS_GET_RESOURCE().
4707 * This function simply calls the BUS_GET_RESOURCE() method of the
4708 * parent of @p dev and returns the start value.
4711 bus_get_resource_start(device_t dev, int type, int rid)
4717 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4725 * @brief Wrapper function for BUS_GET_RESOURCE().
4727 * This function simply calls the BUS_GET_RESOURCE() method of the
4728 * parent of @p dev and returns the count value.
4731 bus_get_resource_count(device_t dev, int type, int rid)
4737 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4745 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4747 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4751 bus_delete_resource(device_t dev, int type, int rid)
4753 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4757 * @brief Wrapper function for BUS_CHILD_PRESENT().
4759 * This function simply calls the BUS_CHILD_PRESENT() method of the
4763 bus_child_present(device_t child)
4765 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4769 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4771 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4775 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4779 parent = device_get_parent(child);
4780 if (parent == NULL) {
4784 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4788 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4790 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4794 bus_child_location_str(device_t child, char *buf, size_t buflen)
4798 parent = device_get_parent(child);
4799 if (parent == NULL) {
4803 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4807 * @brief Wrapper function for BUS_GET_CPUS().
4809 * This function simply calls the BUS_GET_CPUS() method of the
4813 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4817 parent = device_get_parent(dev);
4820 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4824 * @brief Wrapper function for BUS_GET_DMA_TAG().
4826 * This function simply calls the BUS_GET_DMA_TAG() method of the
4830 bus_get_dma_tag(device_t dev)
4834 parent = device_get_parent(dev);
4837 return (BUS_GET_DMA_TAG(parent, dev));
4841 * @brief Wrapper function for BUS_GET_BUS_TAG().
4843 * This function simply calls the BUS_GET_BUS_TAG() method of the
4847 bus_get_bus_tag(device_t dev)
4851 parent = device_get_parent(dev);
4853 return ((bus_space_tag_t)0);
4854 return (BUS_GET_BUS_TAG(parent, dev));
4858 * @brief Wrapper function for BUS_GET_DOMAIN().
4860 * This function simply calls the BUS_GET_DOMAIN() method of the
4864 bus_get_domain(device_t dev, int *domain)
4866 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4869 /* Resume all devices and then notify userland that we're up again. */
4871 root_resume(device_t dev)
4875 error = bus_generic_resume(dev);
4877 devctl_notify("kern", "power", "resume", NULL);
4882 root_print_child(device_t dev, device_t child)
4886 retval += bus_print_child_header(dev, child);
4887 retval += printf("\n");
4893 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4894 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4897 * If an interrupt mapping gets to here something bad has happened.
4899 panic("root_setup_intr");
4903 * If we get here, assume that the device is permanent and really is
4904 * present in the system. Removable bus drivers are expected to intercept
4905 * this call long before it gets here. We return -1 so that drivers that
4906 * really care can check vs -1 or some ERRNO returned higher in the food
4910 root_child_present(device_t dev, device_t child)
4916 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
4922 /* Default to returning the set of all CPUs. */
4923 if (setsize != sizeof(cpuset_t))
4932 static kobj_method_t root_methods[] = {
4933 /* Device interface */
4934 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4935 KOBJMETHOD(device_suspend, bus_generic_suspend),
4936 KOBJMETHOD(device_resume, root_resume),
4939 KOBJMETHOD(bus_print_child, root_print_child),
4940 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4941 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4942 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4943 KOBJMETHOD(bus_child_present, root_child_present),
4944 KOBJMETHOD(bus_get_cpus, root_get_cpus),
4949 static driver_t root_driver = {
4956 devclass_t root_devclass;
4959 root_bus_module_handler(module_t mod, int what, void* arg)
4963 TAILQ_INIT(&bus_data_devices);
4964 kobj_class_compile((kobj_class_t) &root_driver);
4965 root_bus = make_device(NULL, "root", 0);
4966 root_bus->desc = "System root bus";
4967 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4968 root_bus->driver = &root_driver;
4969 root_bus->state = DS_ATTACHED;
4970 root_devclass = devclass_find_internal("root", NULL, FALSE);
4975 device_shutdown(root_bus);
4978 return (EOPNOTSUPP);
4984 static moduledata_t root_bus_mod = {
4986 root_bus_module_handler,
4989 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4992 * @brief Automatically configure devices
4994 * This function begins the autoconfiguration process by calling
4995 * device_probe_and_attach() for each child of the @c root0 device.
4998 root_bus_configure(void)
5003 /* Eventually this will be split up, but this is sufficient for now. */
5004 bus_set_pass(BUS_PASS_DEFAULT);
5008 * @brief Module handler for registering device drivers
5010 * This module handler is used to automatically register device
5011 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5012 * devclass_add_driver() for the driver described by the
5013 * driver_module_data structure pointed to by @p arg
5016 driver_module_handler(module_t mod, int what, void *arg)
5018 struct driver_module_data *dmd;
5019 devclass_t bus_devclass;
5020 kobj_class_t driver;
5023 dmd = (struct driver_module_data *)arg;
5024 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5029 if (dmd->dmd_chainevh)
5030 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5032 pass = dmd->dmd_pass;
5033 driver = dmd->dmd_driver;
5034 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5035 DRIVERNAME(driver), dmd->dmd_busname, pass));
5036 error = devclass_add_driver(bus_devclass, driver, pass,
5041 PDEBUG(("Unloading module: driver %s from bus %s",
5042 DRIVERNAME(dmd->dmd_driver),
5044 error = devclass_delete_driver(bus_devclass,
5047 if (!error && dmd->dmd_chainevh)
5048 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5051 PDEBUG(("Quiesce module: driver %s from bus %s",
5052 DRIVERNAME(dmd->dmd_driver),
5054 error = devclass_quiesce_driver(bus_devclass,
5057 if (!error && dmd->dmd_chainevh)
5058 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5069 * @brief Enumerate all hinted devices for this bus.
5071 * Walks through the hints for this bus and calls the bus_hinted_child
5072 * routine for each one it fines. It searches first for the specific
5073 * bus that's being probed for hinted children (eg isa0), and then for
5074 * generic children (eg isa).
5076 * @param dev bus device to enumerate
5079 bus_enumerate_hinted_children(device_t bus)
5082 const char *dname, *busname;
5086 * enumerate all devices on the specific bus
5088 busname = device_get_nameunit(bus);
5090 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5091 BUS_HINTED_CHILD(bus, dname, dunit);
5094 * and all the generic ones.
5096 busname = device_get_name(bus);
5098 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5099 BUS_HINTED_CHILD(bus, dname, dunit);
5104 /* the _short versions avoid iteration by not calling anything that prints
5105 * more than oneliners. I love oneliners.
5109 print_device_short(device_t dev, int indent)
5114 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5115 dev->unit, dev->desc,
5116 (dev->parent? "":"no "),
5117 (TAILQ_EMPTY(&dev->children)? "no ":""),
5118 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5119 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5120 (dev->flags&DF_WILDCARD? "wildcard,":""),
5121 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5122 (dev->flags&DF_REBID? "rebiddable,":""),
5123 (dev->flags&DF_SUSPENDED? "suspended,":""),
5124 (dev->ivars? "":"no "),
5125 (dev->softc? "":"no "),
5130 print_device(device_t dev, int indent)
5135 print_device_short(dev, indent);
5137 indentprintf(("Parent:\n"));
5138 print_device_short(dev->parent, indent+1);
5139 indentprintf(("Driver:\n"));
5140 print_driver_short(dev->driver, indent+1);
5141 indentprintf(("Devclass:\n"));
5142 print_devclass_short(dev->devclass, indent+1);
5146 print_device_tree_short(device_t dev, int indent)
5147 /* print the device and all its children (indented) */
5154 print_device_short(dev, indent);
5156 TAILQ_FOREACH(child, &dev->children, link) {
5157 print_device_tree_short(child, indent+1);
5162 print_device_tree(device_t dev, int indent)
5163 /* print the device and all its children (indented) */
5170 print_device(dev, indent);
5172 TAILQ_FOREACH(child, &dev->children, link) {
5173 print_device_tree(child, indent+1);
5178 print_driver_short(driver_t *driver, int indent)
5183 indentprintf(("driver %s: softc size = %zd\n",
5184 driver->name, driver->size));
5188 print_driver(driver_t *driver, int indent)
5193 print_driver_short(driver, indent);
5197 print_driver_list(driver_list_t drivers, int indent)
5199 driverlink_t driver;
5201 TAILQ_FOREACH(driver, &drivers, link) {
5202 print_driver(driver->driver, indent);
5207 print_devclass_short(devclass_t dc, int indent)
5212 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5216 print_devclass(devclass_t dc, int indent)
5223 print_devclass_short(dc, indent);
5224 indentprintf(("Drivers:\n"));
5225 print_driver_list(dc->drivers, indent+1);
5227 indentprintf(("Devices:\n"));
5228 for (i = 0; i < dc->maxunit; i++)
5230 print_device(dc->devices[i], indent+1);
5234 print_devclass_list_short(void)
5238 printf("Short listing of devclasses, drivers & devices:\n");
5239 TAILQ_FOREACH(dc, &devclasses, link) {
5240 print_devclass_short(dc, 0);
5245 print_devclass_list(void)
5249 printf("Full listing of devclasses, drivers & devices:\n");
5250 TAILQ_FOREACH(dc, &devclasses, link) {
5251 print_devclass(dc, 0);
5258 * User-space access to the device tree.
5260 * We implement a small set of nodes:
5262 * hw.bus Single integer read method to obtain the
5263 * current generation count.
5264 * hw.bus.devices Reads the entire device tree in flat space.
5265 * hw.bus.rman Resource manager interface
5267 * We might like to add the ability to scan devclasses and/or drivers to
5268 * determine what else is currently loaded/available.
5272 sysctl_bus(SYSCTL_HANDLER_ARGS)
5274 struct u_businfo ubus;
5276 ubus.ub_version = BUS_USER_VERSION;
5277 ubus.ub_generation = bus_data_generation;
5279 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5281 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5282 "bus-related data");
5285 sysctl_devices(SYSCTL_HANDLER_ARGS)
5287 int *name = (int *)arg1;
5288 u_int namelen = arg2;
5291 struct u_device *udev;
5298 if (bus_data_generation_check(name[0]))
5304 * Scan the list of devices, looking for the requested index.
5306 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5314 * Populate the return item, careful not to overflow the buffer.
5316 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5319 udev->dv_handle = (uintptr_t)dev;
5320 udev->dv_parent = (uintptr_t)dev->parent;
5321 udev->dv_devflags = dev->devflags;
5322 udev->dv_flags = dev->flags;
5323 udev->dv_state = dev->state;
5324 walker = udev->dv_fields;
5325 ep = walker + sizeof(udev->dv_fields);
5327 if ((src) == NULL) \
5330 strlcpy(walker, (src), ep - walker); \
5331 walker += strlen(walker) + 1; \
5339 CP(dev->driver != NULL ? dev->driver->name : NULL);
5340 bus_child_pnpinfo_str(dev, walker, ep - walker);
5341 walker += strlen(walker) + 1;
5344 bus_child_location_str(dev, walker, ep - walker);
5345 walker += strlen(walker) + 1;
5351 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5356 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5357 "system device tree");
5360 bus_data_generation_check(int generation)
5362 if (generation != bus_data_generation)
5365 /* XXX generate optimised lists here? */
5370 bus_data_generation_update(void)
5372 bus_data_generation++;
5376 bus_free_resource(device_t dev, int type, struct resource *r)
5380 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5384 device_lookup_by_name(const char *name)
5388 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5389 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5396 * /dev/devctl2 implementation. The existing /dev/devctl device has
5397 * implicit semantics on open, so it could not be reused for this.
5398 * Another option would be to call this /dev/bus?
5401 find_device(struct devreq *req, device_t *devp)
5406 * First, ensure that the name is nul terminated.
5408 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5412 * Second, try to find an attached device whose name matches
5415 dev = device_lookup_by_name(req->dr_name);
5421 /* Finally, give device enumerators a chance. */
5423 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5431 driver_exists(device_t bus, const char *driver)
5435 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5436 if (devclass_find_driver_internal(dc, driver) != NULL)
5443 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5450 /* Locate the device to control. */
5452 req = (struct devreq *)data;
5460 case DEV_SET_DRIVER:
5461 case DEV_CLEAR_DRIVER:
5464 error = priv_check(td, PRIV_DRIVER);
5466 error = find_device(req, &dev);
5477 /* Perform the requested operation. */
5480 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5482 else if (!device_is_enabled(dev))
5485 error = device_probe_and_attach(dev);
5488 if (!device_is_attached(dev)) {
5492 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5493 error = device_quiesce(dev);
5497 error = device_detach(dev);
5500 if (device_is_enabled(dev)) {
5506 * If the device has been probed but not attached (e.g.
5507 * when it has been disabled by a loader hint), just
5508 * attach the device rather than doing a full probe.
5511 if (device_is_alive(dev)) {
5513 * If the device was disabled via a hint, clear
5516 if (resource_disabled(dev->driver->name, dev->unit))
5517 resource_unset_value(dev->driver->name,
5518 dev->unit, "disabled");
5519 error = device_attach(dev);
5521 error = device_probe_and_attach(dev);
5524 if (!device_is_enabled(dev)) {
5529 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5530 error = device_quiesce(dev);
5536 * Force DF_FIXEDCLASS on around detach to preserve
5537 * the existing name.
5540 dev->flags |= DF_FIXEDCLASS;
5541 error = device_detach(dev);
5542 if (!(old & DF_FIXEDCLASS))
5543 dev->flags &= ~DF_FIXEDCLASS;
5545 device_disable(dev);
5548 if (device_is_suspended(dev)) {
5552 if (device_get_parent(dev) == NULL) {
5556 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5559 if (!device_is_suspended(dev)) {
5563 if (device_get_parent(dev) == NULL) {
5567 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5569 case DEV_SET_DRIVER: {
5573 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5576 if (driver[0] == '\0') {
5580 if (dev->devclass != NULL &&
5581 strcmp(driver, dev->devclass->name) == 0)
5582 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5586 * Scan drivers for this device's bus looking for at
5587 * least one matching driver.
5589 if (dev->parent == NULL) {
5593 if (!driver_exists(dev->parent, driver)) {
5597 dc = devclass_create(driver);
5603 /* Detach device if necessary. */
5604 if (device_is_attached(dev)) {
5605 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5606 error = device_detach(dev);
5613 /* Clear any previously-fixed device class and unit. */
5614 if (dev->flags & DF_FIXEDCLASS)
5615 devclass_delete_device(dev->devclass, dev);
5616 dev->flags |= DF_WILDCARD;
5619 /* Force the new device class. */
5620 error = devclass_add_device(dc, dev);
5623 dev->flags |= DF_FIXEDCLASS;
5624 error = device_probe_and_attach(dev);
5627 case DEV_CLEAR_DRIVER:
5628 if (!(dev->flags & DF_FIXEDCLASS)) {
5632 if (device_is_attached(dev)) {
5633 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5634 error = device_detach(dev);
5641 dev->flags &= ~DF_FIXEDCLASS;
5642 dev->flags |= DF_WILDCARD;
5643 devclass_delete_device(dev->devclass, dev);
5644 error = device_probe_and_attach(dev);
5647 if (!device_is_attached(dev)) {
5651 error = BUS_RESCAN(dev);
5656 parent = device_get_parent(dev);
5657 if (parent == NULL) {
5661 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5662 if (bus_child_present(dev) != 0) {
5668 error = device_delete_child(parent, dev);
5676 static struct cdevsw devctl2_cdevsw = {
5677 .d_version = D_VERSION,
5678 .d_ioctl = devctl2_ioctl,
5679 .d_name = "devctl2",
5686 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5687 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5691 * APIs to manage deprecation and obsolescence.
5693 static int obsolete_panic = 0;
5694 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5696 /* 0 - don't panic, 1 - panic if already obsolete, 2 - panic if deprecated */
5698 gone_panic(int major, int running, const char *msg)
5701 switch (obsolete_panic)
5706 if (running < major)
5715 _gone_in(int major, const char *msg)
5718 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5719 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5720 printf("Obsolete code will removed soon: %s\n", msg);
5721 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5722 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5727 _gone_in_dev(device_t dev, int major, const char *msg)
5730 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5731 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5733 "Obsolete code will removed soon: %s\n", msg);
5734 else if (P_OSREL_MAJOR(__FreeBSD_version) + 1 == major)
5736 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5741 DB_SHOW_COMMAND(device, db_show_device)
5748 dev = (device_t)addr;
5750 db_printf("name: %s\n", device_get_nameunit(dev));
5751 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5752 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5753 db_printf(" addr: %p\n", dev);
5754 db_printf(" parent: %p\n", dev->parent);
5755 db_printf(" softc: %p\n", dev->softc);
5756 db_printf(" ivars: %p\n", dev->ivars);
5759 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5763 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5764 db_show_device((db_expr_t)dev, true, count, modif);