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/domainset.h>
38 #include <sys/eventhandler.h>
39 #include <sys/filio.h>
41 #include <sys/kernel.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
50 #include <sys/condvar.h>
51 #include <sys/queue.h>
52 #include <machine/bus.h>
53 #include <sys/random.h>
56 #include <sys/selinfo.h>
57 #include <sys/signalvar.h>
59 #include <sys/sysctl.h>
60 #include <sys/systm.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 */
87 #define DL_DEFERRED_PROBE 1 /* Probe deferred on this */
88 TAILQ_ENTRY(driverlink) passlink;
92 * Forward declarations
94 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
95 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
96 typedef TAILQ_HEAD(device_list, device) device_list_t;
99 TAILQ_ENTRY(devclass) link;
100 devclass_t parent; /* parent in devclass hierarchy */
101 driver_list_t drivers; /* bus devclasses store drivers for bus */
103 device_t *devices; /* array of devices indexed by unit */
104 int maxunit; /* size of devices array */
106 #define DC_HAS_CHILDREN 1
108 struct sysctl_ctx_list sysctl_ctx;
109 struct sysctl_oid *sysctl_tree;
113 * @brief Implementation of device.
117 * A device is a kernel object. The first field must be the
118 * current ops table for the object.
125 TAILQ_ENTRY(device) link; /**< list of devices in parent */
126 TAILQ_ENTRY(device) devlink; /**< global device list membership */
127 device_t parent; /**< parent of this device */
128 device_list_t children; /**< list of child devices */
131 * Details of this device.
133 driver_t *driver; /**< current driver */
134 devclass_t devclass; /**< current device class */
135 int unit; /**< current unit number */
136 char* nameunit; /**< name+unit e.g. foodev0 */
137 char* desc; /**< driver specific description */
138 int busy; /**< count of calls to device_busy() */
139 device_state_t state; /**< current device state */
140 uint32_t devflags; /**< api level flags for device_get_flags() */
141 u_int flags; /**< internal device flags */
142 u_int order; /**< order from device_add_child_ordered() */
143 void *ivars; /**< instance variables */
144 void *softc; /**< current driver's variables */
146 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
147 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
150 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
151 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
153 EVENTHANDLER_LIST_DEFINE(device_attach);
154 EVENTHANDLER_LIST_DEFINE(device_detach);
155 EVENTHANDLER_LIST_DEFINE(dev_lookup);
157 static void devctl2_init(void);
158 static bool device_frozen;
160 #define DRIVERNAME(d) ((d)? d->name : "no driver")
161 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
165 static int bus_debug = 1;
166 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0,
169 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
170 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
173 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
174 * prevent syslog from deleting initial spaces
176 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
178 static void print_device_short(device_t dev, int indent);
179 static void print_device(device_t dev, int indent);
180 void print_device_tree_short(device_t dev, int indent);
181 void print_device_tree(device_t dev, int indent);
182 static void print_driver_short(driver_t *driver, int indent);
183 static void print_driver(driver_t *driver, int indent);
184 static void print_driver_list(driver_list_t drivers, int indent);
185 static void print_devclass_short(devclass_t dc, int indent);
186 static void print_devclass(devclass_t dc, int indent);
187 void print_devclass_list_short(void);
188 void print_devclass_list(void);
191 /* Make the compiler ignore the function calls */
192 #define PDEBUG(a) /* nop */
193 #define DEVICENAME(d) /* nop */
195 #define print_device_short(d,i) /* nop */
196 #define print_device(d,i) /* nop */
197 #define print_device_tree_short(d,i) /* nop */
198 #define print_device_tree(d,i) /* nop */
199 #define print_driver_short(d,i) /* nop */
200 #define print_driver(d,i) /* nop */
201 #define print_driver_list(d,i) /* nop */
202 #define print_devclass_short(d,i) /* nop */
203 #define print_devclass(d,i) /* nop */
204 #define print_devclass_list_short() /* nop */
205 #define print_devclass_list() /* nop */
213 DEVCLASS_SYSCTL_PARENT,
217 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
219 devclass_t dc = (devclass_t)arg1;
223 case DEVCLASS_SYSCTL_PARENT:
224 value = dc->parent ? dc->parent->name : "";
229 return (SYSCTL_OUT_STR(req, value));
233 devclass_sysctl_init(devclass_t dc)
236 if (dc->sysctl_tree != NULL)
238 sysctl_ctx_init(&dc->sysctl_ctx);
239 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
240 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
241 CTLFLAG_RD, NULL, "");
242 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
243 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
244 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
250 DEVICE_SYSCTL_DRIVER,
251 DEVICE_SYSCTL_LOCATION,
252 DEVICE_SYSCTL_PNPINFO,
253 DEVICE_SYSCTL_PARENT,
257 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
259 device_t dev = (device_t)arg1;
266 case DEVICE_SYSCTL_DESC:
267 value = dev->desc ? dev->desc : "";
269 case DEVICE_SYSCTL_DRIVER:
270 value = dev->driver ? dev->driver->name : "";
272 case DEVICE_SYSCTL_LOCATION:
273 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
274 bus_child_location_str(dev, buf, 1024);
276 case DEVICE_SYSCTL_PNPINFO:
277 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
278 bus_child_pnpinfo_str(dev, buf, 1024);
280 case DEVICE_SYSCTL_PARENT:
281 value = dev->parent ? dev->parent->nameunit : "";
286 error = SYSCTL_OUT_STR(req, value);
293 device_sysctl_init(device_t dev)
295 devclass_t dc = dev->devclass;
298 if (dev->sysctl_tree != NULL)
300 devclass_sysctl_init(dc);
301 sysctl_ctx_init(&dev->sysctl_ctx);
302 dev->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&dev->sysctl_ctx,
303 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
304 dev->nameunit + strlen(dc->name),
305 CTLFLAG_RD, NULL, "", "device_index");
306 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
307 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
308 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
309 "device description");
310 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
311 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
312 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
313 "device driver name");
314 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
315 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
316 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
317 "device location relative to parent");
318 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
319 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
320 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
321 "device identification");
322 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
323 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
324 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
326 if (bus_get_domain(dev, &domain) == 0)
327 SYSCTL_ADD_INT(&dev->sysctl_ctx,
328 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
329 CTLFLAG_RD, NULL, domain, "NUMA domain");
333 device_sysctl_update(device_t dev)
335 devclass_t dc = dev->devclass;
337 if (dev->sysctl_tree == NULL)
339 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
343 device_sysctl_fini(device_t dev)
345 if (dev->sysctl_tree == NULL)
347 sysctl_ctx_free(&dev->sysctl_ctx);
348 dev->sysctl_tree = NULL;
352 * /dev/devctl implementation
356 * This design allows only one reader for /dev/devctl. This is not desirable
357 * in the long run, but will get a lot of hair out of this implementation.
358 * Maybe we should make this device a clonable device.
360 * Also note: we specifically do not attach a device to the device_t tree
361 * to avoid potential chicken and egg problems. One could argue that all
362 * of this belongs to the root node. One could also further argue that the
363 * sysctl interface that we have not might more properly be an ioctl
364 * interface, but at this stage of the game, I'm not inclined to rock that
367 * I'm also not sure that the SIGIO support is done correctly or not, as
368 * I copied it from a driver that had SIGIO support that likely hasn't been
369 * tested since 3.4 or 2.2.8!
372 /* Deprecated way to adjust queue length */
373 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
374 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN |
375 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
376 "devctl disable -- deprecated");
378 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
379 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
380 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
381 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN |
382 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
384 static d_open_t devopen;
385 static d_close_t devclose;
386 static d_read_t devread;
387 static d_ioctl_t devioctl;
388 static d_poll_t devpoll;
389 static d_kqfilter_t devkqfilter;
391 static struct cdevsw dev_cdevsw = {
392 .d_version = D_VERSION,
398 .d_kqfilter = devkqfilter,
402 struct dev_event_info
405 TAILQ_ENTRY(dev_event_info) dei_link;
408 TAILQ_HEAD(devq, dev_event_info);
410 static struct dev_softc
423 static void filt_devctl_detach(struct knote *kn);
424 static int filt_devctl_read(struct knote *kn, long hint);
426 struct filterops devctl_rfiltops = {
428 .f_detach = filt_devctl_detach,
429 .f_event = filt_devctl_read,
432 static struct cdev *devctl_dev;
437 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
438 UID_ROOT, GID_WHEEL, 0600, "devctl");
439 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
440 cv_init(&devsoftc.cv, "dev cv");
441 TAILQ_INIT(&devsoftc.devq);
442 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
447 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
450 mtx_lock(&devsoftc.mtx);
451 if (devsoftc.inuse) {
452 mtx_unlock(&devsoftc.mtx);
457 mtx_unlock(&devsoftc.mtx);
462 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
465 mtx_lock(&devsoftc.mtx);
467 devsoftc.nonblock = 0;
469 cv_broadcast(&devsoftc.cv);
470 funsetown(&devsoftc.sigio);
471 mtx_unlock(&devsoftc.mtx);
476 * The read channel for this device is used to report changes to
477 * userland in realtime. We are required to free the data as well as
478 * the n1 object because we allocate them separately. Also note that
479 * we return one record at a time. If you try to read this device a
480 * character at a time, you will lose the rest of the data. Listening
481 * programs are expected to cope.
484 devread(struct cdev *dev, struct uio *uio, int ioflag)
486 struct dev_event_info *n1;
489 mtx_lock(&devsoftc.mtx);
490 while (TAILQ_EMPTY(&devsoftc.devq)) {
491 if (devsoftc.nonblock) {
492 mtx_unlock(&devsoftc.mtx);
495 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
498 * Need to translate ERESTART to EINTR here? -- jake
500 mtx_unlock(&devsoftc.mtx);
504 n1 = TAILQ_FIRST(&devsoftc.devq);
505 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
507 mtx_unlock(&devsoftc.mtx);
508 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
509 free(n1->dei_data, M_BUS);
515 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
521 devsoftc.nonblock = 1;
523 devsoftc.nonblock = 0;
532 return fsetown(*(int *)data, &devsoftc.sigio);
534 *(int *)data = fgetown(&devsoftc.sigio);
537 /* (un)Support for other fcntl() calls. */
548 devpoll(struct cdev *dev, int events, struct thread *td)
552 mtx_lock(&devsoftc.mtx);
553 if (events & (POLLIN | POLLRDNORM)) {
554 if (!TAILQ_EMPTY(&devsoftc.devq))
555 revents = events & (POLLIN | POLLRDNORM);
557 selrecord(td, &devsoftc.sel);
559 mtx_unlock(&devsoftc.mtx);
565 devkqfilter(struct cdev *dev, struct knote *kn)
569 if (kn->kn_filter == EVFILT_READ) {
570 kn->kn_fop = &devctl_rfiltops;
571 knlist_add(&devsoftc.sel.si_note, kn, 0);
579 filt_devctl_detach(struct knote *kn)
582 knlist_remove(&devsoftc.sel.si_note, kn, 0);
586 filt_devctl_read(struct knote *kn, long hint)
588 kn->kn_data = devsoftc.queued;
589 return (kn->kn_data != 0);
593 * @brief Return whether the userland process is running
596 devctl_process_running(void)
598 return (devsoftc.inuse == 1);
602 * @brief Queue data to be read from the devctl device
604 * Generic interface to queue data to the devctl device. It is
605 * assumed that @p data is properly formatted. It is further assumed
606 * that @p data is allocated using the M_BUS malloc type.
609 devctl_queue_data_f(char *data, int flags)
611 struct dev_event_info *n1 = NULL, *n2 = NULL;
613 if (strlen(data) == 0)
615 if (devctl_queue_length == 0)
617 n1 = malloc(sizeof(*n1), M_BUS, flags);
621 mtx_lock(&devsoftc.mtx);
622 if (devctl_queue_length == 0) {
623 mtx_unlock(&devsoftc.mtx);
624 free(n1->dei_data, M_BUS);
628 /* Leave at least one spot in the queue... */
629 while (devsoftc.queued > devctl_queue_length - 1) {
630 n2 = TAILQ_FIRST(&devsoftc.devq);
631 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
632 free(n2->dei_data, M_BUS);
636 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
638 cv_broadcast(&devsoftc.cv);
639 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
640 mtx_unlock(&devsoftc.mtx);
641 selwakeup(&devsoftc.sel);
642 if (devsoftc.async && devsoftc.sigio != NULL)
643 pgsigio(&devsoftc.sigio, SIGIO, 0);
647 * We have to free data on all error paths since the caller
648 * assumes it will be free'd when this item is dequeued.
655 devctl_queue_data(char *data)
658 devctl_queue_data_f(data, M_NOWAIT);
662 * @brief Send a 'notification' to userland, using standard ways
665 devctl_notify_f(const char *system, const char *subsystem, const char *type,
666 const char *data, int flags)
672 return; /* BOGUS! Must specify system. */
673 if (subsystem == NULL)
674 return; /* BOGUS! Must specify subsystem. */
676 return; /* BOGUS! Must specify type. */
677 len += strlen(" system=") + strlen(system);
678 len += strlen(" subsystem=") + strlen(subsystem);
679 len += strlen(" type=") + strlen(type);
680 /* add in the data message plus newline. */
683 len += 3; /* '!', '\n', and NUL */
684 msg = malloc(len, M_BUS, flags);
686 return; /* Drop it on the floor */
688 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
689 system, subsystem, type, data);
691 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
692 system, subsystem, type);
693 devctl_queue_data_f(msg, flags);
697 devctl_notify(const char *system, const char *subsystem, const char *type,
701 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
705 * Common routine that tries to make sending messages as easy as possible.
706 * We allocate memory for the data, copy strings into that, but do not
707 * free it unless there's an error. The dequeue part of the driver should
708 * free the data. We don't send data when the device is disabled. We do
709 * send data, even when we have no listeners, because we wish to avoid
710 * races relating to startup and restart of listening applications.
712 * devaddq is designed to string together the type of event, with the
713 * object of that event, plus the plug and play info and location info
714 * for that event. This is likely most useful for devices, but less
715 * useful for other consumers of this interface. Those should use
716 * the devctl_queue_data() interface instead.
719 devaddq(const char *type, const char *what, device_t dev)
726 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
728 data = malloc(1024, M_BUS, M_NOWAIT);
732 /* get the bus specific location of this device */
733 loc = malloc(1024, M_BUS, M_NOWAIT);
737 bus_child_location_str(dev, loc, 1024);
739 /* Get the bus specific pnp info of this device */
740 pnp = malloc(1024, M_BUS, M_NOWAIT);
744 bus_child_pnpinfo_str(dev, pnp, 1024);
746 /* Get the parent of this device, or / if high enough in the tree. */
747 if (device_get_parent(dev) == NULL)
748 parstr = "."; /* Or '/' ? */
750 parstr = device_get_nameunit(device_get_parent(dev));
751 /* String it all together. */
752 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
756 devctl_queue_data(data);
766 * A device was added to the tree. We are called just after it successfully
767 * attaches (that is, probe and attach success for this device). No call
768 * is made if a device is merely parented into the tree. See devnomatch
769 * if probe fails. If attach fails, no notification is sent (but maybe
770 * we should have a different message for this).
773 devadded(device_t dev)
775 devaddq("+", device_get_nameunit(dev), dev);
779 * A device was removed from the tree. We are called just before this
783 devremoved(device_t dev)
785 devaddq("-", device_get_nameunit(dev), dev);
789 * Called when there's no match for this device. This is only called
790 * the first time that no match happens, so we don't keep getting this
791 * message. Should that prove to be undesirable, we can change it.
792 * This is called when all drivers that can attach to a given bus
793 * decline to accept this device. Other errors may not be detected.
796 devnomatch(device_t dev)
798 devaddq("?", "", dev);
802 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
804 struct dev_event_info *n1;
807 dis = (devctl_queue_length == 0);
808 error = sysctl_handle_int(oidp, &dis, 0, req);
809 if (error || !req->newptr)
811 if (mtx_initialized(&devsoftc.mtx))
812 mtx_lock(&devsoftc.mtx);
814 while (!TAILQ_EMPTY(&devsoftc.devq)) {
815 n1 = TAILQ_FIRST(&devsoftc.devq);
816 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
817 free(n1->dei_data, M_BUS);
821 devctl_queue_length = 0;
823 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
825 if (mtx_initialized(&devsoftc.mtx))
826 mtx_unlock(&devsoftc.mtx);
831 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
833 struct dev_event_info *n1;
836 q = devctl_queue_length;
837 error = sysctl_handle_int(oidp, &q, 0, req);
838 if (error || !req->newptr)
842 if (mtx_initialized(&devsoftc.mtx))
843 mtx_lock(&devsoftc.mtx);
844 devctl_queue_length = q;
845 while (devsoftc.queued > devctl_queue_length) {
846 n1 = TAILQ_FIRST(&devsoftc.devq);
847 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
848 free(n1->dei_data, M_BUS);
852 if (mtx_initialized(&devsoftc.mtx))
853 mtx_unlock(&devsoftc.mtx);
858 * @brief safely quotes strings that might have double quotes in them.
860 * The devctl protocol relies on quoted strings having matching quotes.
861 * This routine quotes any internal quotes so the resulting string
862 * is safe to pass to snprintf to construct, for example pnp info strings.
863 * Strings are always terminated with a NUL, but may be truncated if longer
864 * than @p len bytes after quotes.
866 * @param sb sbuf to place the characters into
867 * @param src Original buffer.
870 devctl_safe_quote_sb(struct sbuf *sb, const char *src)
873 while (*src != '\0') {
874 if (*src == '"' || *src == '\\')
876 sbuf_putc(sb, *src++);
880 /* End of /dev/devctl code */
882 static TAILQ_HEAD(,device) bus_data_devices;
883 static int bus_data_generation = 1;
885 static kobj_method_t null_methods[] = {
889 DEFINE_CLASS(null, null_methods, 0);
892 * Bus pass implementation
895 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
896 int bus_current_pass = BUS_PASS_ROOT;
900 * @brief Register the pass level of a new driver attachment
902 * Register a new driver attachment's pass level. If no driver
903 * attachment with the same pass level has been added, then @p new
904 * will be added to the global passes list.
906 * @param new the new driver attachment
909 driver_register_pass(struct driverlink *new)
911 struct driverlink *dl;
913 /* We only consider pass numbers during boot. */
914 if (bus_current_pass == BUS_PASS_DEFAULT)
918 * Walk the passes list. If we already know about this pass
919 * then there is nothing to do. If we don't, then insert this
920 * driver link into the list.
922 TAILQ_FOREACH(dl, &passes, passlink) {
923 if (dl->pass < new->pass)
925 if (dl->pass == new->pass)
927 TAILQ_INSERT_BEFORE(dl, new, passlink);
930 TAILQ_INSERT_TAIL(&passes, new, passlink);
934 * @brief Raise the current bus pass
936 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
937 * method on the root bus to kick off a new device tree scan for each
938 * new pass level that has at least one driver.
941 bus_set_pass(int pass)
943 struct driverlink *dl;
945 if (bus_current_pass > pass)
946 panic("Attempt to lower bus pass level");
948 TAILQ_FOREACH(dl, &passes, passlink) {
949 /* Skip pass values below the current pass level. */
950 if (dl->pass <= bus_current_pass)
954 * Bail once we hit a driver with a pass level that is
961 * Raise the pass level to the next level and rescan
964 bus_current_pass = dl->pass;
965 BUS_NEW_PASS(root_bus);
969 * If there isn't a driver registered for the requested pass,
970 * then bus_current_pass might still be less than 'pass'. Set
971 * it to 'pass' in that case.
973 if (bus_current_pass < pass)
974 bus_current_pass = pass;
975 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
979 * Devclass implementation
982 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
986 * @brief Find or create a device class
988 * If a device class with the name @p classname exists, return it,
989 * otherwise if @p create is non-zero create and return a new device
992 * If @p parentname is non-NULL, the parent of the devclass is set to
993 * the devclass of that name.
995 * @param classname the devclass name to find or create
996 * @param parentname the parent devclass name or @c NULL
997 * @param create non-zero to create a devclass
1000 devclass_find_internal(const char *classname, const char *parentname,
1005 PDEBUG(("looking for %s", classname));
1009 TAILQ_FOREACH(dc, &devclasses, link) {
1010 if (!strcmp(dc->name, classname))
1014 if (create && !dc) {
1015 PDEBUG(("creating %s", classname));
1016 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
1017 M_BUS, M_NOWAIT | M_ZERO);
1021 dc->name = (char*) (dc + 1);
1022 strcpy(dc->name, classname);
1023 TAILQ_INIT(&dc->drivers);
1024 TAILQ_INSERT_TAIL(&devclasses, dc, link);
1026 bus_data_generation_update();
1030 * If a parent class is specified, then set that as our parent so
1031 * that this devclass will support drivers for the parent class as
1032 * well. If the parent class has the same name don't do this though
1033 * as it creates a cycle that can trigger an infinite loop in
1034 * device_probe_child() if a device exists for which there is no
1037 if (parentname && dc && !dc->parent &&
1038 strcmp(classname, parentname) != 0) {
1039 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1040 dc->parent->flags |= DC_HAS_CHILDREN;
1047 * @brief Create a device class
1049 * If a device class with the name @p classname exists, return it,
1050 * otherwise create and return a new device class.
1052 * @param classname the devclass name to find or create
1055 devclass_create(const char *classname)
1057 return (devclass_find_internal(classname, NULL, TRUE));
1061 * @brief Find a device class
1063 * If a device class with the name @p classname exists, return it,
1064 * otherwise return @c NULL.
1066 * @param classname the devclass name to find
1069 devclass_find(const char *classname)
1071 return (devclass_find_internal(classname, NULL, FALSE));
1075 * @brief Register that a device driver has been added to a devclass
1077 * Register that a device driver has been added to a devclass. This
1078 * is called by devclass_add_driver to accomplish the recursive
1079 * notification of all the children classes of dc, as well as dc.
1080 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1083 * We do a full search here of the devclass list at each iteration
1084 * level to save storing children-lists in the devclass structure. If
1085 * we ever move beyond a few dozen devices doing this, we may need to
1088 * @param dc the devclass to edit
1089 * @param driver the driver that was just added
1092 devclass_driver_added(devclass_t dc, driver_t *driver)
1098 * Call BUS_DRIVER_ADDED for any existing buses in this class.
1100 for (i = 0; i < dc->maxunit; i++)
1101 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1102 BUS_DRIVER_ADDED(dc->devices[i], driver);
1105 * Walk through the children classes. Since we only keep a
1106 * single parent pointer around, we walk the entire list of
1107 * devclasses looking for children. We set the
1108 * DC_HAS_CHILDREN flag when a child devclass is created on
1109 * the parent, so we only walk the list for those devclasses
1110 * that have children.
1112 if (!(dc->flags & DC_HAS_CHILDREN))
1115 TAILQ_FOREACH(dc, &devclasses, link) {
1116 if (dc->parent == parent)
1117 devclass_driver_added(dc, driver);
1122 * @brief Add a device driver to a device class
1124 * Add a device driver to a devclass. This is normally called
1125 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1126 * all devices in the devclass will be called to allow them to attempt
1127 * to re-probe any unmatched children.
1129 * @param dc the devclass to edit
1130 * @param driver the driver to register
1133 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1136 const char *parentname;
1138 PDEBUG(("%s", DRIVERNAME(driver)));
1140 /* Don't allow invalid pass values. */
1141 if (pass <= BUS_PASS_ROOT)
1144 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1149 * Compile the driver's methods. Also increase the reference count
1150 * so that the class doesn't get freed when the last instance
1151 * goes. This means we can safely use static methods and avoids a
1152 * double-free in devclass_delete_driver.
1154 kobj_class_compile((kobj_class_t) driver);
1157 * If the driver has any base classes, make the
1158 * devclass inherit from the devclass of the driver's
1159 * first base class. This will allow the system to
1160 * search for drivers in both devclasses for children
1161 * of a device using this driver.
1163 if (driver->baseclasses)
1164 parentname = driver->baseclasses[0]->name;
1167 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1169 dl->driver = driver;
1170 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1171 driver->refs++; /* XXX: kobj_mtx */
1173 driver_register_pass(dl);
1175 if (device_frozen) {
1176 dl->flags |= DL_DEFERRED_PROBE;
1178 devclass_driver_added(dc, driver);
1180 bus_data_generation_update();
1185 * @brief Register that a device driver has been deleted from a devclass
1187 * Register that a device driver has been removed from a devclass.
1188 * This is called by devclass_delete_driver to accomplish the
1189 * recursive notification of all the children classes of busclass, as
1190 * well as busclass. Each layer will attempt to detach the driver
1191 * from any devices that are children of the bus's devclass. The function
1192 * will return an error if a device fails to detach.
1194 * We do a full search here of the devclass list at each iteration
1195 * level to save storing children-lists in the devclass structure. If
1196 * we ever move beyond a few dozen devices doing this, we may need to
1199 * @param busclass the devclass of the parent bus
1200 * @param dc the devclass of the driver being deleted
1201 * @param driver the driver being deleted
1204 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1211 * Disassociate from any devices. We iterate through all the
1212 * devices in the devclass of the driver and detach any which are
1213 * using the driver and which have a parent in the devclass which
1214 * we are deleting from.
1216 * Note that since a driver can be in multiple devclasses, we
1217 * should not detach devices which are not children of devices in
1218 * the affected devclass.
1220 * If we're frozen, we don't generate NOMATCH events. Mark to
1223 for (i = 0; i < dc->maxunit; i++) {
1224 if (dc->devices[i]) {
1225 dev = dc->devices[i];
1226 if (dev->driver == driver && dev->parent &&
1227 dev->parent->devclass == busclass) {
1228 if ((error = device_detach(dev)) != 0)
1230 if (device_frozen) {
1231 dev->flags &= ~DF_DONENOMATCH;
1232 dev->flags |= DF_NEEDNOMATCH;
1234 BUS_PROBE_NOMATCH(dev->parent, dev);
1236 dev->flags |= DF_DONENOMATCH;
1243 * Walk through the children classes. Since we only keep a
1244 * single parent pointer around, we walk the entire list of
1245 * devclasses looking for children. We set the
1246 * DC_HAS_CHILDREN flag when a child devclass is created on
1247 * the parent, so we only walk the list for those devclasses
1248 * that have children.
1250 if (!(busclass->flags & DC_HAS_CHILDREN))
1253 TAILQ_FOREACH(busclass, &devclasses, link) {
1254 if (busclass->parent == parent) {
1255 error = devclass_driver_deleted(busclass, dc, driver);
1264 * @brief Delete a device driver from a device class
1266 * Delete a device driver from a devclass. This is normally called
1267 * automatically by DRIVER_MODULE().
1269 * If the driver is currently attached to any devices,
1270 * devclass_delete_driver() will first attempt to detach from each
1271 * device. If one of the detach calls fails, the driver will not be
1274 * @param dc the devclass to edit
1275 * @param driver the driver to unregister
1278 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1280 devclass_t dc = devclass_find(driver->name);
1284 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1290 * Find the link structure in the bus' list of drivers.
1292 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1293 if (dl->driver == driver)
1298 PDEBUG(("%s not found in %s list", driver->name,
1303 error = devclass_driver_deleted(busclass, dc, driver);
1307 TAILQ_REMOVE(&busclass->drivers, dl, link);
1312 if (driver->refs == 0)
1313 kobj_class_free((kobj_class_t) driver);
1315 bus_data_generation_update();
1320 * @brief Quiesces a set of device drivers from a device class
1322 * Quiesce a device driver from a devclass. This is normally called
1323 * automatically by DRIVER_MODULE().
1325 * If the driver is currently attached to any devices,
1326 * devclass_quiesece_driver() will first attempt to quiesce each
1329 * @param dc the devclass to edit
1330 * @param driver the driver to unregister
1333 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1335 devclass_t dc = devclass_find(driver->name);
1341 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1347 * Find the link structure in the bus' list of drivers.
1349 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1350 if (dl->driver == driver)
1355 PDEBUG(("%s not found in %s list", driver->name,
1361 * Quiesce all devices. We iterate through all the devices in
1362 * the devclass of the driver and quiesce any which are using
1363 * the driver and which have a parent in the devclass which we
1366 * Note that since a driver can be in multiple devclasses, we
1367 * should not quiesce devices which are not children of
1368 * devices in the affected devclass.
1370 for (i = 0; i < dc->maxunit; i++) {
1371 if (dc->devices[i]) {
1372 dev = dc->devices[i];
1373 if (dev->driver == driver && dev->parent &&
1374 dev->parent->devclass == busclass) {
1375 if ((error = device_quiesce(dev)) != 0)
1388 devclass_find_driver_internal(devclass_t dc, const char *classname)
1392 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1394 TAILQ_FOREACH(dl, &dc->drivers, link) {
1395 if (!strcmp(dl->driver->name, classname))
1399 PDEBUG(("not found"));
1404 * @brief Return the name of the devclass
1407 devclass_get_name(devclass_t dc)
1413 * @brief Find a device given a unit number
1415 * @param dc the devclass to search
1416 * @param unit the unit number to search for
1418 * @returns the device with the given unit number or @c
1419 * NULL if there is no such device
1422 devclass_get_device(devclass_t dc, int unit)
1424 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1426 return (dc->devices[unit]);
1430 * @brief Find the softc field of 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 softc field of the device with the given
1436 * unit number or @c NULL if there is no such
1440 devclass_get_softc(devclass_t dc, int unit)
1444 dev = devclass_get_device(dc, unit);
1448 return (device_get_softc(dev));
1452 * @brief Get a list of devices in the devclass
1454 * An array containing a list of all the devices in the given devclass
1455 * is allocated and returned in @p *devlistp. The number of devices
1456 * in the array is returned in @p *devcountp. The caller should free
1457 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1459 * @param dc the devclass to examine
1460 * @param devlistp points at location for array pointer return
1462 * @param devcountp points at location for array size return value
1465 * @retval ENOMEM the array allocation failed
1468 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1473 count = devclass_get_count(dc);
1474 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1479 for (i = 0; i < dc->maxunit; i++) {
1480 if (dc->devices[i]) {
1481 list[count] = dc->devices[i];
1493 * @brief Get a list of drivers in the devclass
1495 * An array containing a list of pointers to all the drivers in the
1496 * given devclass is allocated and returned in @p *listp. The number
1497 * of drivers in the array is returned in @p *countp. The caller should
1498 * free the array using @c free(p, M_TEMP).
1500 * @param dc the devclass to examine
1501 * @param listp gives location for array pointer return value
1502 * @param countp gives location for number of array elements
1506 * @retval ENOMEM the array allocation failed
1509 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1516 TAILQ_FOREACH(dl, &dc->drivers, link)
1518 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1523 TAILQ_FOREACH(dl, &dc->drivers, link) {
1524 list[count] = dl->driver;
1534 * @brief Get the number of devices in a devclass
1536 * @param dc the devclass to examine
1539 devclass_get_count(devclass_t dc)
1544 for (i = 0; i < dc->maxunit; i++)
1551 * @brief Get the maximum unit number used in a devclass
1553 * Note that this is one greater than the highest currently-allocated
1554 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1555 * that not even the devclass has been allocated yet.
1557 * @param dc the devclass to examine
1560 devclass_get_maxunit(devclass_t dc)
1564 return (dc->maxunit);
1568 * @brief Find a free unit number in a devclass
1570 * This function searches for the first unused unit number greater
1571 * that or equal to @p unit.
1573 * @param dc the devclass to examine
1574 * @param unit the first unit number to check
1577 devclass_find_free_unit(devclass_t dc, int unit)
1581 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1587 * @brief Set the parent of a devclass
1589 * The parent class is normally initialised automatically by
1592 * @param dc the devclass to edit
1593 * @param pdc the new parent devclass
1596 devclass_set_parent(devclass_t dc, devclass_t pdc)
1602 * @brief Get the parent of a devclass
1604 * @param dc the devclass to examine
1607 devclass_get_parent(devclass_t dc)
1609 return (dc->parent);
1612 struct sysctl_ctx_list *
1613 devclass_get_sysctl_ctx(devclass_t dc)
1615 return (&dc->sysctl_ctx);
1619 devclass_get_sysctl_tree(devclass_t dc)
1621 return (dc->sysctl_tree);
1626 * @brief Allocate a unit number
1628 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1629 * will do). The allocated unit number is returned in @p *unitp.
1631 * @param dc the devclass to allocate from
1632 * @param unitp points at the location for the allocated unit
1636 * @retval EEXIST the requested unit number is already allocated
1637 * @retval ENOMEM memory allocation failure
1640 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1645 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1647 /* Ask the parent bus if it wants to wire this device. */
1649 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1652 /* If we were given a wired unit number, check for existing device */
1655 if (unit >= 0 && unit < dc->maxunit &&
1656 dc->devices[unit] != NULL) {
1658 printf("%s: %s%d already exists; skipping it\n",
1659 dc->name, dc->name, *unitp);
1663 /* Unwired device, find the next available slot for it */
1665 for (unit = 0;; unit++) {
1666 /* If there is an "at" hint for a unit then skip it. */
1667 if (resource_string_value(dc->name, unit, "at", &s) ==
1671 /* If this device slot is already in use, skip it. */
1672 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1680 * We've selected a unit beyond the length of the table, so let's
1681 * extend the table to make room for all units up to and including
1684 if (unit >= dc->maxunit) {
1685 device_t *newlist, *oldlist;
1688 oldlist = dc->devices;
1689 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1690 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1693 if (oldlist != NULL)
1694 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1695 bzero(newlist + dc->maxunit,
1696 sizeof(device_t) * (newsize - dc->maxunit));
1697 dc->devices = newlist;
1698 dc->maxunit = newsize;
1699 if (oldlist != NULL)
1700 free(oldlist, M_BUS);
1702 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1710 * @brief Add a device to a devclass
1712 * A unit number is allocated for the device (using the device's
1713 * preferred unit number if any) and the device is registered in the
1714 * devclass. This allows the device to be looked up by its unit
1715 * number, e.g. by decoding a dev_t minor number.
1717 * @param dc the devclass to add to
1718 * @param dev the device to add
1721 * @retval EEXIST the requested unit number is already allocated
1722 * @retval ENOMEM memory allocation failure
1725 devclass_add_device(devclass_t dc, device_t dev)
1729 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1731 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1734 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1738 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1739 free(dev->nameunit, M_BUS);
1740 dev->nameunit = NULL;
1743 dc->devices[dev->unit] = dev;
1745 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1752 * @brief Delete a device from a devclass
1754 * The device is removed from the devclass's device list and its unit
1757 * @param dc the devclass to delete from
1758 * @param dev the device to delete
1763 devclass_delete_device(devclass_t dc, device_t dev)
1768 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1770 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1771 panic("devclass_delete_device: inconsistent device class");
1772 dc->devices[dev->unit] = NULL;
1773 if (dev->flags & DF_WILDCARD)
1775 dev->devclass = NULL;
1776 free(dev->nameunit, M_BUS);
1777 dev->nameunit = NULL;
1784 * @brief Make a new device and add it as a child of @p parent
1786 * @param parent the parent of the new device
1787 * @param name the devclass name of the new device or @c NULL
1788 * to leave the devclass unspecified
1789 * @parem unit the unit number of the new device of @c -1 to
1790 * leave the unit number unspecified
1792 * @returns the new device
1795 make_device(device_t parent, const char *name, int unit)
1800 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1803 dc = devclass_find_internal(name, NULL, TRUE);
1805 printf("make_device: can't find device class %s\n",
1813 dev = malloc(sizeof(*dev), M_BUS, M_NOWAIT|M_ZERO);
1817 dev->parent = parent;
1818 TAILQ_INIT(&dev->children);
1819 kobj_init((kobj_t) dev, &null_class);
1821 dev->devclass = NULL;
1823 dev->nameunit = NULL;
1827 dev->flags = DF_ENABLED;
1830 dev->flags |= DF_WILDCARD;
1832 dev->flags |= DF_FIXEDCLASS;
1833 if (devclass_add_device(dc, dev)) {
1834 kobj_delete((kobj_t) dev, M_BUS);
1838 if (parent != NULL && device_has_quiet_children(parent))
1839 dev->flags |= DF_QUIET | DF_QUIET_CHILDREN;
1843 dev->state = DS_NOTPRESENT;
1845 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1846 bus_data_generation_update();
1853 * @brief Print a description of a device.
1856 device_print_child(device_t dev, device_t child)
1860 if (device_is_alive(child))
1861 retval += BUS_PRINT_CHILD(dev, child);
1863 retval += device_printf(child, " not found\n");
1869 * @brief Create a new device
1871 * This creates a new device and adds it as a child of an existing
1872 * parent device. The new device will be added after the last existing
1873 * child with order zero.
1875 * @param dev the device which will be the parent of the
1877 * @param name devclass name for new device or @c NULL if not
1879 * @param unit unit number for new device or @c -1 if not
1882 * @returns the new device
1885 device_add_child(device_t dev, const char *name, int unit)
1887 return (device_add_child_ordered(dev, 0, name, unit));
1891 * @brief Create a new device
1893 * This creates a new device and adds it as a child of an existing
1894 * parent device. The new device will be added after the last existing
1895 * child with the same order.
1897 * @param dev the device which will be the parent of the
1899 * @param order a value which is used to partially sort the
1900 * children of @p dev - devices created using
1901 * lower values of @p order appear first in @p
1902 * dev's list of children
1903 * @param name devclass name for new device or @c NULL if not
1905 * @param unit unit number for new device or @c -1 if not
1908 * @returns the new device
1911 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1916 PDEBUG(("%s at %s with order %u as unit %d",
1917 name, DEVICENAME(dev), order, unit));
1918 KASSERT(name != NULL || unit == -1,
1919 ("child device with wildcard name and specific unit number"));
1921 child = make_device(dev, name, unit);
1924 child->order = order;
1926 TAILQ_FOREACH(place, &dev->children, link) {
1927 if (place->order > order)
1933 * The device 'place' is the first device whose order is
1934 * greater than the new child.
1936 TAILQ_INSERT_BEFORE(place, child, link);
1939 * The new child's order is greater or equal to the order of
1940 * any existing device. Add the child to the tail of the list.
1942 TAILQ_INSERT_TAIL(&dev->children, child, link);
1945 bus_data_generation_update();
1950 * @brief Delete a device
1952 * This function deletes a device along with all of its children. If
1953 * the device currently has a driver attached to it, the device is
1954 * detached first using device_detach().
1956 * @param dev the parent device
1957 * @param child the device to delete
1960 * @retval non-zero a unit error code describing the error
1963 device_delete_child(device_t dev, device_t child)
1966 device_t grandchild;
1968 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1970 /* detach parent before deleting children, if any */
1971 if ((error = device_detach(child)) != 0)
1974 /* remove children second */
1975 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1976 error = device_delete_child(child, grandchild);
1981 if (child->devclass)
1982 devclass_delete_device(child->devclass, child);
1984 BUS_CHILD_DELETED(dev, child);
1985 TAILQ_REMOVE(&dev->children, child, link);
1986 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1987 kobj_delete((kobj_t) child, M_BUS);
1989 bus_data_generation_update();
1994 * @brief Delete all children devices of the given device, if any.
1996 * This function deletes all children devices of the given device, if
1997 * any, using the device_delete_child() function for each device it
1998 * finds. If a child device cannot be deleted, this function will
1999 * return an error code.
2001 * @param dev the parent device
2004 * @retval non-zero a device would not detach
2007 device_delete_children(device_t dev)
2012 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
2016 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
2017 error = device_delete_child(dev, child);
2019 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
2027 * @brief Find a device given a unit number
2029 * This is similar to devclass_get_devices() but only searches for
2030 * devices which have @p dev as a parent.
2032 * @param dev the parent device to search
2033 * @param unit the unit number to search for. If the unit is -1,
2034 * return the first child of @p dev which has name
2035 * @p classname (that is, the one with the lowest unit.)
2037 * @returns the device with the given unit number or @c
2038 * NULL if there is no such device
2041 device_find_child(device_t dev, const char *classname, int unit)
2046 dc = devclass_find(classname);
2051 child = devclass_get_device(dc, unit);
2052 if (child && child->parent == dev)
2055 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2056 child = devclass_get_device(dc, unit);
2057 if (child && child->parent == dev)
2068 first_matching_driver(devclass_t dc, device_t dev)
2071 return (devclass_find_driver_internal(dc, dev->devclass->name));
2072 return (TAILQ_FIRST(&dc->drivers));
2079 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2081 if (dev->devclass) {
2083 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2084 if (!strcmp(dev->devclass->name, dl->driver->name))
2088 return (TAILQ_NEXT(last, link));
2095 device_probe_child(device_t dev, device_t child)
2098 driverlink_t best = NULL;
2100 int result, pri = 0;
2101 int hasclass = (child->devclass != NULL);
2107 panic("device_probe_child: parent device has no devclass");
2110 * If the state is already probed, then return. However, don't
2111 * return if we can rebid this object.
2113 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2116 for (; dc; dc = dc->parent) {
2117 for (dl = first_matching_driver(dc, child);
2119 dl = next_matching_driver(dc, child, dl)) {
2120 /* If this driver's pass is too high, then ignore it. */
2121 if (dl->pass > bus_current_pass)
2124 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2125 result = device_set_driver(child, dl->driver);
2126 if (result == ENOMEM)
2128 else if (result != 0)
2131 if (device_set_devclass(child,
2132 dl->driver->name) != 0) {
2133 char const * devname =
2134 device_get_name(child);
2135 if (devname == NULL)
2136 devname = "(unknown)";
2137 printf("driver bug: Unable to set "
2138 "devclass (class: %s "
2142 (void)device_set_driver(child, NULL);
2147 /* Fetch any flags for the device before probing. */
2148 resource_int_value(dl->driver->name, child->unit,
2149 "flags", &child->devflags);
2151 result = DEVICE_PROBE(child);
2153 /* Reset flags and devclass before the next probe. */
2154 child->devflags = 0;
2156 (void)device_set_devclass(child, NULL);
2159 * If the driver returns SUCCESS, there can be
2160 * no higher match for this device.
2169 * Reset DF_QUIET in case this driver doesn't
2170 * end up as the best driver.
2172 device_verbose(child);
2175 * Probes that return BUS_PROBE_NOWILDCARD or lower
2176 * only match on devices whose driver was explicitly
2179 if (result <= BUS_PROBE_NOWILDCARD &&
2180 !(child->flags & DF_FIXEDCLASS)) {
2185 * The driver returned an error so it
2186 * certainly doesn't match.
2189 (void)device_set_driver(child, NULL);
2194 * A priority lower than SUCCESS, remember the
2195 * best matching driver. Initialise the value
2196 * of pri for the first match.
2198 if (best == NULL || result > pri) {
2205 * If we have an unambiguous match in this devclass,
2206 * don't look in the parent.
2208 if (best && pri == 0)
2213 * If we found a driver, change state and initialise the devclass.
2215 /* XXX What happens if we rebid and got no best? */
2218 * If this device was attached, and we were asked to
2219 * rescan, and it is a different driver, then we have
2220 * to detach the old driver and reattach this new one.
2221 * Note, we don't have to check for DF_REBID here
2222 * because if the state is > DS_ALIVE, we know it must
2225 * This assumes that all DF_REBID drivers can have
2226 * their probe routine called at any time and that
2227 * they are idempotent as well as completely benign in
2228 * normal operations.
2230 * We also have to make sure that the detach
2231 * succeeded, otherwise we fail the operation (or
2232 * maybe it should just fail silently? I'm torn).
2234 if (child->state > DS_ALIVE && best->driver != child->driver)
2235 if ((result = device_detach(dev)) != 0)
2238 /* Set the winning driver, devclass, and flags. */
2239 if (!child->devclass) {
2240 result = device_set_devclass(child, best->driver->name);
2244 result = device_set_driver(child, best->driver);
2247 resource_int_value(best->driver->name, child->unit,
2248 "flags", &child->devflags);
2252 * A bit bogus. Call the probe method again to make
2253 * sure that we have the right description.
2255 DEVICE_PROBE(child);
2257 child->flags |= DF_REBID;
2260 child->flags &= ~DF_REBID;
2261 child->state = DS_ALIVE;
2263 bus_data_generation_update();
2271 * @brief Return the parent of a device
2274 device_get_parent(device_t dev)
2276 return (dev->parent);
2280 * @brief Get a list of children of a device
2282 * An array containing a list of all the children of the given device
2283 * is allocated and returned in @p *devlistp. The number of devices
2284 * in the array is returned in @p *devcountp. The caller should free
2285 * the array using @c free(p, M_TEMP).
2287 * @param dev the device to examine
2288 * @param devlistp points at location for array pointer return
2290 * @param devcountp points at location for array size return value
2293 * @retval ENOMEM the array allocation failed
2296 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2303 TAILQ_FOREACH(child, &dev->children, link) {
2312 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2317 TAILQ_FOREACH(child, &dev->children, link) {
2318 list[count] = child;
2329 * @brief Return the current driver for the device or @c NULL if there
2330 * is no driver currently attached
2333 device_get_driver(device_t dev)
2335 return (dev->driver);
2339 * @brief Return the current devclass for the device or @c NULL if
2343 device_get_devclass(device_t dev)
2345 return (dev->devclass);
2349 * @brief Return the name of the device's devclass or @c NULL if there
2353 device_get_name(device_t dev)
2355 if (dev != NULL && dev->devclass)
2356 return (devclass_get_name(dev->devclass));
2361 * @brief Return a string containing the device's devclass name
2362 * followed by an ascii representation of the device's unit number
2366 device_get_nameunit(device_t dev)
2368 return (dev->nameunit);
2372 * @brief Return the device's unit number.
2375 device_get_unit(device_t dev)
2381 * @brief Return the device's description string
2384 device_get_desc(device_t dev)
2390 * @brief Return the device's flags
2393 device_get_flags(device_t dev)
2395 return (dev->devflags);
2398 struct sysctl_ctx_list *
2399 device_get_sysctl_ctx(device_t dev)
2401 return (&dev->sysctl_ctx);
2405 device_get_sysctl_tree(device_t dev)
2407 return (dev->sysctl_tree);
2411 * @brief Print the name of the device followed by a colon and a space
2413 * @returns the number of characters printed
2416 device_print_prettyname(device_t dev)
2418 const char *name = device_get_name(dev);
2421 return (printf("unknown: "));
2422 return (printf("%s%d: ", name, device_get_unit(dev)));
2426 * @brief Print the name of the device followed by a colon, a space
2427 * and the result of calling vprintf() with the value of @p fmt and
2428 * the following arguments.
2430 * @returns the number of characters printed
2433 device_printf(device_t dev, const char * fmt, ...)
2438 retval = device_print_prettyname(dev);
2440 retval += vprintf(fmt, ap);
2449 device_set_desc_internal(device_t dev, const char* desc, int copy)
2451 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2452 free(dev->desc, M_BUS);
2453 dev->flags &= ~DF_DESCMALLOCED;
2458 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2460 strcpy(dev->desc, desc);
2461 dev->flags |= DF_DESCMALLOCED;
2464 /* Avoid a -Wcast-qual warning */
2465 dev->desc = (char *)(uintptr_t) desc;
2468 bus_data_generation_update();
2472 * @brief Set the device's description
2474 * The value of @c desc should be a string constant that will not
2475 * change (at least until the description is changed in a subsequent
2476 * call to device_set_desc() or device_set_desc_copy()).
2479 device_set_desc(device_t dev, const char* desc)
2481 device_set_desc_internal(dev, desc, FALSE);
2485 * @brief Set the device's description
2487 * The string pointed to by @c desc is copied. Use this function if
2488 * the device description is generated, (e.g. with sprintf()).
2491 device_set_desc_copy(device_t dev, const char* desc)
2493 device_set_desc_internal(dev, desc, TRUE);
2497 * @brief Set the device's flags
2500 device_set_flags(device_t dev, uint32_t flags)
2502 dev->devflags = flags;
2506 * @brief Return the device's softc field
2508 * The softc is allocated and zeroed when a driver is attached, based
2509 * on the size field of the driver.
2512 device_get_softc(device_t dev)
2514 return (dev->softc);
2518 * @brief Set the device's softc field
2520 * Most drivers do not need to use this since the softc is allocated
2521 * automatically when the driver is attached.
2524 device_set_softc(device_t dev, void *softc)
2526 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2527 free_domain(dev->softc, M_BUS_SC);
2530 dev->flags |= DF_EXTERNALSOFTC;
2532 dev->flags &= ~DF_EXTERNALSOFTC;
2536 * @brief Free claimed softc
2538 * Most drivers do not need to use this since the softc is freed
2539 * automatically when the driver is detached.
2542 device_free_softc(void *softc)
2544 free_domain(softc, M_BUS_SC);
2548 * @brief Claim softc
2550 * This function can be used to let the driver free the automatically
2551 * allocated softc using "device_free_softc()". This function is
2552 * useful when the driver is refcounting the softc and the softc
2553 * cannot be freed when the "device_detach" method is called.
2556 device_claim_softc(device_t dev)
2559 dev->flags |= DF_EXTERNALSOFTC;
2561 dev->flags &= ~DF_EXTERNALSOFTC;
2565 * @brief Get the device's ivars field
2567 * The ivars field is used by the parent device to store per-device
2568 * state (e.g. the physical location of the device or a list of
2572 device_get_ivars(device_t dev)
2575 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2576 return (dev->ivars);
2580 * @brief Set the device's ivars field
2583 device_set_ivars(device_t dev, void * ivars)
2586 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2591 * @brief Return the device's state
2594 device_get_state(device_t dev)
2596 return (dev->state);
2600 * @brief Set the DF_ENABLED flag for the device
2603 device_enable(device_t dev)
2605 dev->flags |= DF_ENABLED;
2609 * @brief Clear the DF_ENABLED flag for the device
2612 device_disable(device_t dev)
2614 dev->flags &= ~DF_ENABLED;
2618 * @brief Increment the busy counter for the device
2621 device_busy(device_t dev)
2623 if (dev->state < DS_ATTACHING)
2624 panic("device_busy: called for unattached device");
2625 if (dev->busy == 0 && dev->parent)
2626 device_busy(dev->parent);
2628 if (dev->state == DS_ATTACHED)
2629 dev->state = DS_BUSY;
2633 * @brief Decrement the busy counter for the device
2636 device_unbusy(device_t dev)
2638 if (dev->busy != 0 && dev->state != DS_BUSY &&
2639 dev->state != DS_ATTACHING)
2640 panic("device_unbusy: called for non-busy device %s",
2641 device_get_nameunit(dev));
2643 if (dev->busy == 0) {
2645 device_unbusy(dev->parent);
2646 if (dev->state == DS_BUSY)
2647 dev->state = DS_ATTACHED;
2652 * @brief Set the DF_QUIET flag for the device
2655 device_quiet(device_t dev)
2657 dev->flags |= DF_QUIET;
2661 * @brief Set the DF_QUIET_CHILDREN flag for the device
2664 device_quiet_children(device_t dev)
2666 dev->flags |= DF_QUIET_CHILDREN;
2670 * @brief Clear the DF_QUIET flag for the device
2673 device_verbose(device_t dev)
2675 dev->flags &= ~DF_QUIET;
2679 * @brief Return non-zero if the DF_QUIET_CHIDLREN flag is set on the device
2682 device_has_quiet_children(device_t dev)
2684 return ((dev->flags & DF_QUIET_CHILDREN) != 0);
2688 * @brief Return non-zero if the DF_QUIET flag is set on the device
2691 device_is_quiet(device_t dev)
2693 return ((dev->flags & DF_QUIET) != 0);
2697 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2700 device_is_enabled(device_t dev)
2702 return ((dev->flags & DF_ENABLED) != 0);
2706 * @brief Return non-zero if the device was successfully probed
2709 device_is_alive(device_t dev)
2711 return (dev->state >= DS_ALIVE);
2715 * @brief Return non-zero if the device currently has a driver
2719 device_is_attached(device_t dev)
2721 return (dev->state >= DS_ATTACHED);
2725 * @brief Return non-zero if the device is currently suspended.
2728 device_is_suspended(device_t dev)
2730 return ((dev->flags & DF_SUSPENDED) != 0);
2734 * @brief Set the devclass of a device
2735 * @see devclass_add_device().
2738 device_set_devclass(device_t dev, const char *classname)
2745 devclass_delete_device(dev->devclass, dev);
2749 if (dev->devclass) {
2750 printf("device_set_devclass: device class already set\n");
2754 dc = devclass_find_internal(classname, NULL, TRUE);
2758 error = devclass_add_device(dc, dev);
2760 bus_data_generation_update();
2765 * @brief Set the devclass of a device and mark the devclass fixed.
2766 * @see device_set_devclass()
2769 device_set_devclass_fixed(device_t dev, const char *classname)
2773 if (classname == NULL)
2776 error = device_set_devclass(dev, classname);
2779 dev->flags |= DF_FIXEDCLASS;
2784 * @brief Set the driver of a device
2787 * @retval EBUSY the device already has a driver attached
2788 * @retval ENOMEM a memory allocation failure occurred
2791 device_set_driver(device_t dev, driver_t *driver)
2794 struct domainset *policy;
2796 if (dev->state >= DS_ATTACHED)
2799 if (dev->driver == driver)
2802 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2803 free_domain(dev->softc, M_BUS_SC);
2806 device_set_desc(dev, NULL);
2807 kobj_delete((kobj_t) dev, NULL);
2808 dev->driver = driver;
2810 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2811 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2812 if (bus_get_domain(dev, &domain) == 0)
2813 policy = DOMAINSET_PREF(domain);
2815 policy = DOMAINSET_RR();
2816 dev->softc = malloc_domainset(driver->size, M_BUS_SC,
2817 policy, M_NOWAIT | M_ZERO);
2819 kobj_delete((kobj_t) dev, NULL);
2820 kobj_init((kobj_t) dev, &null_class);
2826 kobj_init((kobj_t) dev, &null_class);
2829 bus_data_generation_update();
2834 * @brief Probe a device, and return this status.
2836 * This function is the core of the device autoconfiguration
2837 * system. Its purpose is to select a suitable driver for a device and
2838 * then call that driver to initialise the hardware appropriately. The
2839 * driver is selected by calling the DEVICE_PROBE() method of a set of
2840 * candidate drivers and then choosing the driver which returned the
2841 * best value. This driver is then attached to the device using
2844 * The set of suitable drivers is taken from the list of drivers in
2845 * the parent device's devclass. If the device was originally created
2846 * with a specific class name (see device_add_child()), only drivers
2847 * with that name are probed, otherwise all drivers in the devclass
2848 * are probed. If no drivers return successful probe values in the
2849 * parent devclass, the search continues in the parent of that
2850 * devclass (see devclass_get_parent()) if any.
2852 * @param dev the device to initialise
2855 * @retval ENXIO no driver was found
2856 * @retval ENOMEM memory allocation failure
2857 * @retval non-zero some other unix error code
2858 * @retval -1 Device already attached
2861 device_probe(device_t dev)
2867 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2870 if (!(dev->flags & DF_ENABLED)) {
2871 if (bootverbose && device_get_name(dev) != NULL) {
2872 device_print_prettyname(dev);
2873 printf("not probed (disabled)\n");
2877 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2878 if (bus_current_pass == BUS_PASS_DEFAULT &&
2879 !(dev->flags & DF_DONENOMATCH)) {
2880 BUS_PROBE_NOMATCH(dev->parent, dev);
2882 dev->flags |= DF_DONENOMATCH;
2890 * @brief Probe a device and attach a driver if possible
2892 * calls device_probe() and attaches if that was successful.
2895 device_probe_and_attach(device_t dev)
2901 error = device_probe(dev);
2904 else if (error != 0)
2907 CURVNET_SET_QUIET(vnet0);
2908 error = device_attach(dev);
2914 * @brief Attach a device driver to a device
2916 * This function is a wrapper around the DEVICE_ATTACH() driver
2917 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2918 * device's sysctl tree, optionally prints a description of the device
2919 * and queues a notification event for user-based device management
2922 * Normally this function is only called internally from
2923 * device_probe_and_attach().
2925 * @param dev the device to initialise
2928 * @retval ENXIO no driver was found
2929 * @retval ENOMEM memory allocation failure
2930 * @retval non-zero some other unix error code
2933 device_attach(device_t dev)
2935 uint64_t attachtime;
2936 uint16_t attachentropy;
2939 if (resource_disabled(dev->driver->name, dev->unit)) {
2940 device_disable(dev);
2942 device_printf(dev, "disabled via hints entry\n");
2946 device_sysctl_init(dev);
2947 if (!device_is_quiet(dev))
2948 device_print_child(dev->parent, dev);
2949 attachtime = get_cyclecount();
2950 dev->state = DS_ATTACHING;
2951 if ((error = DEVICE_ATTACH(dev)) != 0) {
2952 printf("device_attach: %s%d attach returned %d\n",
2953 dev->driver->name, dev->unit, error);
2954 if (!(dev->flags & DF_FIXEDCLASS))
2955 devclass_delete_device(dev->devclass, dev);
2956 (void)device_set_driver(dev, NULL);
2957 device_sysctl_fini(dev);
2958 KASSERT(dev->busy == 0, ("attach failed but busy"));
2959 dev->state = DS_NOTPRESENT;
2962 dev->flags |= DF_ATTACHED_ONCE;
2963 /* We only need the low bits of this time, but ranges from tens to thousands
2964 * have been seen, so keep 2 bytes' worth.
2966 attachentropy = (uint16_t)(get_cyclecount() - attachtime);
2967 random_harvest_direct(&attachentropy, sizeof(attachentropy), RANDOM_ATTACH);
2968 device_sysctl_update(dev);
2970 dev->state = DS_BUSY;
2972 dev->state = DS_ATTACHED;
2973 dev->flags &= ~DF_DONENOMATCH;
2974 EVENTHANDLER_DIRECT_INVOKE(device_attach, dev);
2980 * @brief Detach a driver from a device
2982 * This function is a wrapper around the DEVICE_DETACH() driver
2983 * method. If the call to DEVICE_DETACH() succeeds, it calls
2984 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2985 * notification event for user-based device management services and
2986 * cleans up the device's sysctl tree.
2988 * @param dev the device to un-initialise
2991 * @retval ENXIO no driver was found
2992 * @retval ENOMEM memory allocation failure
2993 * @retval non-zero some other unix error code
2996 device_detach(device_t dev)
3002 PDEBUG(("%s", DEVICENAME(dev)));
3003 if (dev->state == DS_BUSY)
3005 if (dev->state == DS_ATTACHING) {
3006 device_printf(dev, "device in attaching state! Deferring detach.\n");
3009 if (dev->state != DS_ATTACHED)
3012 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN);
3013 if ((error = DEVICE_DETACH(dev)) != 0) {
3014 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3015 EVHDEV_DETACH_FAILED);
3018 EVENTHANDLER_DIRECT_INVOKE(device_detach, dev,
3019 EVHDEV_DETACH_COMPLETE);
3022 if (!device_is_quiet(dev))
3023 device_printf(dev, "detached\n");
3025 BUS_CHILD_DETACHED(dev->parent, dev);
3027 if (!(dev->flags & DF_FIXEDCLASS))
3028 devclass_delete_device(dev->devclass, dev);
3030 device_verbose(dev);
3031 dev->state = DS_NOTPRESENT;
3032 (void)device_set_driver(dev, NULL);
3033 device_sysctl_fini(dev);
3039 * @brief Tells a driver to quiesce itself.
3041 * This function is a wrapper around the DEVICE_QUIESCE() driver
3042 * method. If the call to DEVICE_QUIESCE() succeeds.
3044 * @param dev the device to quiesce
3047 * @retval ENXIO no driver was found
3048 * @retval ENOMEM memory allocation failure
3049 * @retval non-zero some other unix error code
3052 device_quiesce(device_t dev)
3055 PDEBUG(("%s", DEVICENAME(dev)));
3056 if (dev->state == DS_BUSY)
3058 if (dev->state != DS_ATTACHED)
3061 return (DEVICE_QUIESCE(dev));
3065 * @brief Notify a device of system shutdown
3067 * This function calls the DEVICE_SHUTDOWN() driver method if the
3068 * device currently has an attached driver.
3070 * @returns the value returned by DEVICE_SHUTDOWN()
3073 device_shutdown(device_t dev)
3075 if (dev->state < DS_ATTACHED)
3077 return (DEVICE_SHUTDOWN(dev));
3081 * @brief Set the unit number of a device
3083 * This function can be used to override the unit number used for a
3084 * device (e.g. to wire a device to a pre-configured unit number).
3087 device_set_unit(device_t dev, int unit)
3092 dc = device_get_devclass(dev);
3093 if (unit < dc->maxunit && dc->devices[unit])
3095 err = devclass_delete_device(dc, dev);
3099 err = devclass_add_device(dc, dev);
3103 bus_data_generation_update();
3107 /*======================================*/
3109 * Some useful method implementations to make life easier for bus drivers.
3113 resource_init_map_request_impl(struct resource_map_request *args, size_t sz)
3118 args->memattr = VM_MEMATTR_UNCACHEABLE;
3122 * @brief Initialise a resource list.
3124 * @param rl the resource list to initialise
3127 resource_list_init(struct resource_list *rl)
3133 * @brief Reclaim memory used by a resource list.
3135 * This function frees the memory for all resource entries on the list
3138 * @param rl the resource list to free
3141 resource_list_free(struct resource_list *rl)
3143 struct resource_list_entry *rle;
3145 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3147 panic("resource_list_free: resource entry is busy");
3148 STAILQ_REMOVE_HEAD(rl, link);
3154 * @brief Add a resource entry.
3156 * This function adds a resource entry using the given @p type, @p
3157 * start, @p end and @p count values. A rid value is chosen by
3158 * searching sequentially for the first unused rid starting at zero.
3160 * @param rl the resource list to edit
3161 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3162 * @param start the start address of the resource
3163 * @param end the end address of the resource
3164 * @param count XXX end-start+1
3167 resource_list_add_next(struct resource_list *rl, int type, rman_res_t start,
3168 rman_res_t end, rman_res_t count)
3173 while (resource_list_find(rl, type, rid) != NULL)
3175 resource_list_add(rl, type, rid, start, end, count);
3180 * @brief Add or modify a resource entry.
3182 * If an existing entry exists with the same type and rid, it will be
3183 * modified using the given values of @p start, @p end and @p
3184 * count. If no entry exists, a new one will be created using the
3185 * given values. The resource list entry that matches is then returned.
3187 * @param rl the resource list to edit
3188 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3189 * @param rid the resource identifier
3190 * @param start the start address of the resource
3191 * @param end the end address of the resource
3192 * @param count XXX end-start+1
3194 struct resource_list_entry *
3195 resource_list_add(struct resource_list *rl, int type, int rid,
3196 rman_res_t start, rman_res_t end, rman_res_t count)
3198 struct resource_list_entry *rle;
3200 rle = resource_list_find(rl, type, rid);
3202 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3205 panic("resource_list_add: can't record entry");
3206 STAILQ_INSERT_TAIL(rl, rle, link);
3214 panic("resource_list_add: resource entry is busy");
3223 * @brief Determine if a resource entry is busy.
3225 * Returns true if a resource entry is busy meaning that it has an
3226 * associated resource that is not an unallocated "reserved" resource.
3228 * @param rl the resource list to search
3229 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3230 * @param rid the resource identifier
3232 * @returns Non-zero if the entry is busy, zero otherwise.
3235 resource_list_busy(struct resource_list *rl, int type, int rid)
3237 struct resource_list_entry *rle;
3239 rle = resource_list_find(rl, type, rid);
3240 if (rle == NULL || rle->res == NULL)
3242 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3243 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3244 ("reserved resource is active"));
3251 * @brief Determine if a resource entry is reserved.
3253 * Returns true if a resource entry is reserved meaning that it has an
3254 * associated "reserved" resource. The resource can either be
3255 * allocated or unallocated.
3257 * @param rl the resource list to search
3258 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3259 * @param rid the resource identifier
3261 * @returns Non-zero if the entry is reserved, zero otherwise.
3264 resource_list_reserved(struct resource_list *rl, int type, int rid)
3266 struct resource_list_entry *rle;
3268 rle = resource_list_find(rl, type, rid);
3269 if (rle != NULL && rle->flags & RLE_RESERVED)
3275 * @brief Find a resource entry by type and rid.
3277 * @param rl the resource list to search
3278 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3279 * @param rid the resource identifier
3281 * @returns the resource entry pointer or NULL if there is no such
3284 struct resource_list_entry *
3285 resource_list_find(struct resource_list *rl, int type, int rid)
3287 struct resource_list_entry *rle;
3289 STAILQ_FOREACH(rle, rl, link) {
3290 if (rle->type == type && rle->rid == rid)
3297 * @brief Delete a resource entry.
3299 * @param rl the resource list to edit
3300 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3301 * @param rid the resource identifier
3304 resource_list_delete(struct resource_list *rl, int type, int rid)
3306 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3309 if (rle->res != NULL)
3310 panic("resource_list_delete: resource has not been released");
3311 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3317 * @brief Allocate a reserved resource
3319 * This can be used by buses to force the allocation of resources
3320 * that are always active in the system even if they are not allocated
3321 * by a driver (e.g. PCI BARs). This function is usually called when
3322 * adding a new child to the bus. The resource is allocated from the
3323 * parent bus when it is reserved. The resource list entry is marked
3324 * with RLE_RESERVED to note that it is a reserved resource.
3326 * Subsequent attempts to allocate the resource with
3327 * resource_list_alloc() will succeed the first time and will set
3328 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3329 * resource that has been allocated is released with
3330 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3331 * the actual resource remains allocated. The resource can be released to
3332 * the parent bus by calling resource_list_unreserve().
3334 * @param rl the resource list to allocate from
3335 * @param bus the parent device of @p child
3336 * @param child the device for which the resource is being reserved
3337 * @param type the type of resource to allocate
3338 * @param rid a pointer to the resource identifier
3339 * @param start hint at the start of the resource range - pass
3340 * @c 0 for any start address
3341 * @param end hint at the end of the resource range - pass
3342 * @c ~0 for any end address
3343 * @param count hint at the size of range required - pass @c 1
3345 * @param flags any extra flags to control the resource
3346 * allocation - see @c RF_XXX flags in
3347 * <sys/rman.h> for details
3349 * @returns the resource which was allocated or @c NULL if no
3350 * resource could be allocated
3353 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3354 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3356 struct resource_list_entry *rle = NULL;
3357 int passthrough = (device_get_parent(child) != bus);
3362 "resource_list_reserve() should only be called for direct children");
3363 if (flags & RF_ACTIVE)
3365 "resource_list_reserve() should only reserve inactive resources");
3367 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3370 rle = resource_list_find(rl, type, *rid);
3371 rle->flags |= RLE_RESERVED;
3377 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3379 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3380 * and passing the allocation up to the parent of @p bus. This assumes
3381 * that the first entry of @c device_get_ivars(child) is a struct
3382 * resource_list. This also handles 'passthrough' allocations where a
3383 * child is a remote descendant of bus by passing the allocation up to
3384 * the parent of bus.
3386 * Typically, a bus driver would store a list of child resources
3387 * somewhere in the child device's ivars (see device_get_ivars()) and
3388 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3389 * then call resource_list_alloc() to perform the allocation.
3391 * @param rl the resource list to allocate from
3392 * @param bus the parent device of @p child
3393 * @param child the device which is requesting an allocation
3394 * @param type the type of resource to allocate
3395 * @param rid a pointer to the resource identifier
3396 * @param start hint at the start of the resource range - pass
3397 * @c 0 for any start address
3398 * @param end hint at the end of the resource range - pass
3399 * @c ~0 for any end address
3400 * @param count hint at the size of range required - pass @c 1
3402 * @param flags any extra flags to control the resource
3403 * allocation - see @c RF_XXX flags in
3404 * <sys/rman.h> for details
3406 * @returns the resource which was allocated or @c NULL if no
3407 * resource could be allocated
3410 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3411 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
3413 struct resource_list_entry *rle = NULL;
3414 int passthrough = (device_get_parent(child) != bus);
3415 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
3418 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3419 type, rid, start, end, count, flags));
3422 rle = resource_list_find(rl, type, *rid);
3425 return (NULL); /* no resource of that type/rid */
3428 if (rle->flags & RLE_RESERVED) {
3429 if (rle->flags & RLE_ALLOCATED)
3431 if ((flags & RF_ACTIVE) &&
3432 bus_activate_resource(child, type, *rid,
3435 rle->flags |= RLE_ALLOCATED;
3439 "resource entry %#x type %d for child %s is busy\n", *rid,
3440 type, device_get_nameunit(child));
3446 count = ulmax(count, rle->count);
3447 end = ulmax(rle->end, start + count - 1);
3450 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3451 type, rid, start, end, count, flags);
3454 * Record the new range.
3457 rle->start = rman_get_start(rle->res);
3458 rle->end = rman_get_end(rle->res);
3466 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3468 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3469 * used with resource_list_alloc().
3471 * @param rl the resource list which was allocated from
3472 * @param bus the parent device of @p child
3473 * @param child the device which is requesting a release
3474 * @param type the type of resource to release
3475 * @param rid the resource identifier
3476 * @param res the resource to release
3479 * @retval non-zero a standard unix error code indicating what
3480 * error condition prevented the operation
3483 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3484 int type, int rid, struct resource *res)
3486 struct resource_list_entry *rle = NULL;
3487 int passthrough = (device_get_parent(child) != bus);
3491 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3495 rle = resource_list_find(rl, type, rid);
3498 panic("resource_list_release: can't find resource");
3500 panic("resource_list_release: resource entry is not busy");
3501 if (rle->flags & RLE_RESERVED) {
3502 if (rle->flags & RLE_ALLOCATED) {
3503 if (rman_get_flags(res) & RF_ACTIVE) {
3504 error = bus_deactivate_resource(child, type,
3509 rle->flags &= ~RLE_ALLOCATED;
3515 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3525 * @brief Release all active resources of a given type
3527 * Release all active resources of a specified type. This is intended
3528 * to be used to cleanup resources leaked by a driver after detach or
3531 * @param rl the resource list which was allocated from
3532 * @param bus the parent device of @p child
3533 * @param child the device whose active resources are being released
3534 * @param type the type of resources to release
3537 * @retval EBUSY at least one resource was active
3540 resource_list_release_active(struct resource_list *rl, device_t bus,
3541 device_t child, int type)
3543 struct resource_list_entry *rle;
3547 STAILQ_FOREACH(rle, rl, link) {
3548 if (rle->type != type)
3550 if (rle->res == NULL)
3552 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3556 error = resource_list_release(rl, bus, child, type,
3557 rman_get_rid(rle->res), rle->res);
3560 "Failed to release active resource: %d\n", error);
3567 * @brief Fully release a reserved resource
3569 * Fully releases a resource reserved via resource_list_reserve().
3571 * @param rl the resource list which was allocated from
3572 * @param bus the parent device of @p child
3573 * @param child the device whose reserved resource is being released
3574 * @param type the type of resource to release
3575 * @param rid the resource identifier
3576 * @param res the resource to release
3579 * @retval non-zero a standard unix error code indicating what
3580 * error condition prevented the operation
3583 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3586 struct resource_list_entry *rle = NULL;
3587 int passthrough = (device_get_parent(child) != bus);
3591 "resource_list_unreserve() should only be called for direct children");
3593 rle = resource_list_find(rl, type, rid);
3596 panic("resource_list_unreserve: can't find resource");
3597 if (!(rle->flags & RLE_RESERVED))
3599 if (rle->flags & RLE_ALLOCATED)
3601 rle->flags &= ~RLE_RESERVED;
3602 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3606 * @brief Print a description of resources in a resource list
3608 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3609 * The name is printed if at least one resource of the given type is available.
3610 * The format is used to print resource start and end.
3612 * @param rl the resource list to print
3613 * @param name the name of @p type, e.g. @c "memory"
3614 * @param type type type of resource entry to print
3615 * @param format printf(9) format string to print resource
3616 * start and end values
3618 * @returns the number of characters printed
3621 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3624 struct resource_list_entry *rle;
3625 int printed, retval;
3629 /* Yes, this is kinda cheating */
3630 STAILQ_FOREACH(rle, rl, link) {
3631 if (rle->type == type) {
3633 retval += printf(" %s ", name);
3635 retval += printf(",");
3637 retval += printf(format, rle->start);
3638 if (rle->count > 1) {
3639 retval += printf("-");
3640 retval += printf(format, rle->start +
3649 * @brief Releases all the resources in a list.
3651 * @param rl The resource list to purge.
3656 resource_list_purge(struct resource_list *rl)
3658 struct resource_list_entry *rle;
3660 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3662 bus_release_resource(rman_get_device(rle->res),
3663 rle->type, rle->rid, rle->res);
3664 STAILQ_REMOVE_HEAD(rl, link);
3670 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3673 return (device_add_child_ordered(dev, order, name, unit));
3677 * @brief Helper function for implementing DEVICE_PROBE()
3679 * This function can be used to help implement the DEVICE_PROBE() for
3680 * a bus (i.e. a device which has other devices attached to it). It
3681 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3685 bus_generic_probe(device_t dev)
3687 devclass_t dc = dev->devclass;
3690 TAILQ_FOREACH(dl, &dc->drivers, link) {
3692 * If this driver's pass is too high, then ignore it.
3693 * For most drivers in the default pass, this will
3694 * never be true. For early-pass drivers they will
3695 * only call the identify routines of eligible drivers
3696 * when this routine is called. Drivers for later
3697 * passes should have their identify routines called
3698 * on early-pass buses during BUS_NEW_PASS().
3700 if (dl->pass > bus_current_pass)
3702 DEVICE_IDENTIFY(dl->driver, dev);
3709 * @brief Helper function for implementing DEVICE_ATTACH()
3711 * This function can be used to help implement the DEVICE_ATTACH() for
3712 * a bus. It calls device_probe_and_attach() for each of the device's
3716 bus_generic_attach(device_t dev)
3720 TAILQ_FOREACH(child, &dev->children, link) {
3721 device_probe_and_attach(child);
3728 * @brief Helper function for delaying attaching children
3730 * Many buses can't run transactions on the bus which children need to probe and
3731 * attach until after interrupts and/or timers are running. This function
3732 * delays their attach until interrupts and timers are enabled.
3735 bus_delayed_attach_children(device_t dev)
3737 /* Probe and attach the bus children when interrupts are available */
3738 config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev);
3744 * @brief Helper function for implementing DEVICE_DETACH()
3746 * This function can be used to help implement the DEVICE_DETACH() for
3747 * a bus. It calls device_detach() for each of the device's
3751 bus_generic_detach(device_t dev)
3756 if (dev->state != DS_ATTACHED)
3760 * Detach children in the reverse order.
3761 * See bus_generic_suspend for details.
3763 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3764 if ((error = device_detach(child)) != 0)
3772 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3774 * This function can be used to help implement the DEVICE_SHUTDOWN()
3775 * for a bus. It calls device_shutdown() for each of the device's
3779 bus_generic_shutdown(device_t dev)
3784 * Shut down children in the reverse order.
3785 * See bus_generic_suspend for details.
3787 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3788 device_shutdown(child);
3795 * @brief Default function for suspending a child device.
3797 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD().
3800 bus_generic_suspend_child(device_t dev, device_t child)
3804 error = DEVICE_SUSPEND(child);
3807 child->flags |= DF_SUSPENDED;
3813 * @brief Default function for resuming a child device.
3815 * This function is to be used by a bus's DEVICE_RESUME_CHILD().
3818 bus_generic_resume_child(device_t dev, device_t child)
3821 DEVICE_RESUME(child);
3822 child->flags &= ~DF_SUSPENDED;
3828 * @brief Helper function for implementing DEVICE_SUSPEND()
3830 * This function can be used to help implement the DEVICE_SUSPEND()
3831 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3832 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3833 * operation is aborted and any devices which were suspended are
3834 * resumed immediately by calling their DEVICE_RESUME() methods.
3837 bus_generic_suspend(device_t dev)
3843 * Suspend children in the reverse order.
3844 * For most buses all children are equal, so the order does not matter.
3845 * Other buses, such as acpi, carefully order their child devices to
3846 * express implicit dependencies between them. For such buses it is
3847 * safer to bring down devices in the reverse order.
3849 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3850 error = BUS_SUSPEND_CHILD(dev, child);
3852 child = TAILQ_NEXT(child, link);
3853 if (child != NULL) {
3854 TAILQ_FOREACH_FROM(child, &dev->children, link)
3855 BUS_RESUME_CHILD(dev, child);
3864 * @brief Helper function for implementing DEVICE_RESUME()
3866 * This function can be used to help implement the DEVICE_RESUME() for
3867 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3870 bus_generic_resume(device_t dev)
3874 TAILQ_FOREACH(child, &dev->children, link) {
3875 BUS_RESUME_CHILD(dev, child);
3876 /* if resume fails, there's nothing we can usefully do... */
3883 * @brief Helper function for implementing BUS_RESET_POST
3885 * Bus can use this function to implement common operations of
3886 * re-attaching or resuming the children after the bus itself was
3887 * reset, and after restoring bus-unique state of children.
3889 * @param dev The bus
3890 * #param flags DEVF_RESET_*
3893 bus_helper_reset_post(device_t dev, int flags)
3899 TAILQ_FOREACH(child, &dev->children,link) {
3900 BUS_RESET_POST(dev, child);
3901 error1 = (flags & DEVF_RESET_DETACH) != 0 ?
3902 device_probe_and_attach(child) :
3903 BUS_RESUME_CHILD(dev, child);
3904 if (error == 0 && error1 != 0)
3911 bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags)
3914 child = TAILQ_NEXT(child, link);
3917 TAILQ_FOREACH_FROM(child, &dev->children,link) {
3918 BUS_RESET_POST(dev, child);
3919 if ((flags & DEVF_RESET_DETACH) != 0)
3920 device_probe_and_attach(child);
3922 BUS_RESUME_CHILD(dev, child);
3927 * @brief Helper function for implementing BUS_RESET_PREPARE
3929 * Bus can use this function to implement common operations of
3930 * detaching or suspending the children before the bus itself is
3931 * reset, and then save bus-unique state of children that must
3932 * persists around reset.
3934 * @param dev The bus
3935 * #param flags DEVF_RESET_*
3938 bus_helper_reset_prepare(device_t dev, int flags)
3943 if (dev->state != DS_ATTACHED)
3946 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) {
3947 if ((flags & DEVF_RESET_DETACH) != 0) {
3948 error = device_get_state(child) == DS_ATTACHED ?
3949 device_detach(child) : 0;
3951 error = BUS_SUSPEND_CHILD(dev, child);
3954 error = BUS_RESET_PREPARE(dev, child);
3956 if ((flags & DEVF_RESET_DETACH) != 0)
3957 device_probe_and_attach(child);
3959 BUS_RESUME_CHILD(dev, child);
3963 bus_helper_reset_prepare_rollback(dev, child, flags);
3971 * @brief Helper function for implementing BUS_PRINT_CHILD().
3973 * This function prints the first part of the ascii representation of
3974 * @p child, including its name, unit and description (if any - see
3975 * device_set_desc()).
3977 * @returns the number of characters printed
3980 bus_print_child_header(device_t dev, device_t child)
3984 if (device_get_desc(child)) {
3985 retval += device_printf(child, "<%s>", device_get_desc(child));
3987 retval += printf("%s", device_get_nameunit(child));
3994 * @brief Helper function for implementing BUS_PRINT_CHILD().
3996 * This function prints the last part of the ascii representation of
3997 * @p child, which consists of the string @c " on " followed by the
3998 * name and unit of the @p dev.
4000 * @returns the number of characters printed
4003 bus_print_child_footer(device_t dev, device_t child)
4005 return (printf(" on %s\n", device_get_nameunit(dev)));
4009 * @brief Helper function for implementing BUS_PRINT_CHILD().
4011 * This function prints out the VM domain for the given device.
4013 * @returns the number of characters printed
4016 bus_print_child_domain(device_t dev, device_t child)
4020 /* No domain? Don't print anything */
4021 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
4024 return (printf(" numa-domain %d", domain));
4028 * @brief Helper function for implementing BUS_PRINT_CHILD().
4030 * This function simply calls bus_print_child_header() followed by
4031 * bus_print_child_footer().
4033 * @returns the number of characters printed
4036 bus_generic_print_child(device_t dev, device_t child)
4040 retval += bus_print_child_header(dev, child);
4041 retval += bus_print_child_domain(dev, child);
4042 retval += bus_print_child_footer(dev, child);
4048 * @brief Stub function for implementing BUS_READ_IVAR().
4053 bus_generic_read_ivar(device_t dev, device_t child, int index,
4060 * @brief Stub function for implementing BUS_WRITE_IVAR().
4065 bus_generic_write_ivar(device_t dev, device_t child, int index,
4072 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
4076 struct resource_list *
4077 bus_generic_get_resource_list(device_t dev, device_t child)
4083 * @brief Helper function for implementing BUS_DRIVER_ADDED().
4085 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
4086 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
4087 * and then calls device_probe_and_attach() for each unattached child.
4090 bus_generic_driver_added(device_t dev, driver_t *driver)
4094 DEVICE_IDENTIFY(driver, dev);
4095 TAILQ_FOREACH(child, &dev->children, link) {
4096 if (child->state == DS_NOTPRESENT ||
4097 (child->flags & DF_REBID))
4098 device_probe_and_attach(child);
4103 * @brief Helper function for implementing BUS_NEW_PASS().
4105 * This implementing of BUS_NEW_PASS() first calls the identify
4106 * routines for any drivers that probe at the current pass. Then it
4107 * walks the list of devices for this bus. If a device is already
4108 * attached, then it calls BUS_NEW_PASS() on that device. If the
4109 * device is not already attached, it attempts to attach a driver to
4113 bus_generic_new_pass(device_t dev)
4120 TAILQ_FOREACH(dl, &dc->drivers, link) {
4121 if (dl->pass == bus_current_pass)
4122 DEVICE_IDENTIFY(dl->driver, dev);
4124 TAILQ_FOREACH(child, &dev->children, link) {
4125 if (child->state >= DS_ATTACHED)
4126 BUS_NEW_PASS(child);
4127 else if (child->state == DS_NOTPRESENT)
4128 device_probe_and_attach(child);
4133 * @brief Helper function for implementing BUS_SETUP_INTR().
4135 * This simple implementation of BUS_SETUP_INTR() simply calls the
4136 * BUS_SETUP_INTR() method of the parent of @p dev.
4139 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
4140 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
4143 /* Propagate up the bus hierarchy until someone handles it. */
4145 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
4146 filter, intr, arg, cookiep));
4151 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
4153 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
4154 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
4157 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
4160 /* Propagate up the bus hierarchy until someone handles it. */
4162 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
4167 * @brief Helper function for implementing BUS_SUSPEND_INTR().
4169 * This simple implementation of BUS_SUSPEND_INTR() simply calls the
4170 * BUS_SUSPEND_INTR() method of the parent of @p dev.
4173 bus_generic_suspend_intr(device_t dev, device_t child, struct resource *irq)
4175 /* Propagate up the bus hierarchy until someone handles it. */
4177 return (BUS_SUSPEND_INTR(dev->parent, child, irq));
4182 * @brief Helper function for implementing BUS_RESUME_INTR().
4184 * This simple implementation of BUS_RESUME_INTR() simply calls the
4185 * BUS_RESUME_INTR() method of the parent of @p dev.
4188 bus_generic_resume_intr(device_t dev, device_t child, struct resource *irq)
4190 /* Propagate up the bus hierarchy until someone handles it. */
4192 return (BUS_RESUME_INTR(dev->parent, child, irq));
4197 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
4199 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
4200 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
4203 bus_generic_adjust_resource(device_t dev, device_t child, int type,
4204 struct resource *r, rman_res_t start, rman_res_t end)
4206 /* Propagate up the bus hierarchy until someone handles it. */
4208 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
4214 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4216 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
4217 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
4220 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
4221 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4223 /* Propagate up the bus hierarchy until someone handles it. */
4225 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
4226 start, end, count, flags));
4231 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4233 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
4234 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
4237 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
4240 /* Propagate up the bus hierarchy until someone handles it. */
4242 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
4248 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
4250 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
4251 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
4254 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
4257 /* Propagate up the bus hierarchy until someone handles it. */
4259 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
4265 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
4267 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
4268 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
4271 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
4272 int rid, struct resource *r)
4274 /* Propagate up the bus hierarchy until someone handles it. */
4276 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
4282 * @brief Helper function for implementing BUS_MAP_RESOURCE().
4284 * This simple implementation of BUS_MAP_RESOURCE() simply calls the
4285 * BUS_MAP_RESOURCE() method of the parent of @p dev.
4288 bus_generic_map_resource(device_t dev, device_t child, int type,
4289 struct resource *r, struct resource_map_request *args,
4290 struct resource_map *map)
4292 /* Propagate up the bus hierarchy until someone handles it. */
4294 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args,
4300 * @brief Helper function for implementing BUS_UNMAP_RESOURCE().
4302 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the
4303 * BUS_UNMAP_RESOURCE() method of the parent of @p dev.
4306 bus_generic_unmap_resource(device_t dev, device_t child, int type,
4307 struct resource *r, struct resource_map *map)
4309 /* Propagate up the bus hierarchy until someone handles it. */
4311 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map));
4316 * @brief Helper function for implementing BUS_BIND_INTR().
4318 * This simple implementation of BUS_BIND_INTR() simply calls the
4319 * BUS_BIND_INTR() method of the parent of @p dev.
4322 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
4326 /* Propagate up the bus hierarchy until someone handles it. */
4328 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
4333 * @brief Helper function for implementing BUS_CONFIG_INTR().
4335 * This simple implementation of BUS_CONFIG_INTR() simply calls the
4336 * BUS_CONFIG_INTR() method of the parent of @p dev.
4339 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4340 enum intr_polarity pol)
4343 /* Propagate up the bus hierarchy until someone handles it. */
4345 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4350 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4352 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4353 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4356 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4357 void *cookie, const char *descr)
4360 /* Propagate up the bus hierarchy until someone handles it. */
4362 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4368 * @brief Helper function for implementing BUS_GET_CPUS().
4370 * This simple implementation of BUS_GET_CPUS() simply calls the
4371 * BUS_GET_CPUS() method of the parent of @p dev.
4374 bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
4375 size_t setsize, cpuset_t *cpuset)
4378 /* Propagate up the bus hierarchy until someone handles it. */
4379 if (dev->parent != NULL)
4380 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset));
4385 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4387 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4388 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4391 bus_generic_get_dma_tag(device_t dev, device_t child)
4394 /* Propagate up the bus hierarchy until someone handles it. */
4395 if (dev->parent != NULL)
4396 return (BUS_GET_DMA_TAG(dev->parent, child));
4401 * @brief Helper function for implementing BUS_GET_BUS_TAG().
4403 * This simple implementation of BUS_GET_BUS_TAG() simply calls the
4404 * BUS_GET_BUS_TAG() method of the parent of @p dev.
4407 bus_generic_get_bus_tag(device_t dev, device_t child)
4410 /* Propagate up the bus hierarchy until someone handles it. */
4411 if (dev->parent != NULL)
4412 return (BUS_GET_BUS_TAG(dev->parent, child));
4413 return ((bus_space_tag_t)0);
4417 * @brief Helper function for implementing BUS_GET_RESOURCE().
4419 * This implementation of BUS_GET_RESOURCE() uses the
4420 * resource_list_find() function to do most of the work. It calls
4421 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4425 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4426 rman_res_t *startp, rman_res_t *countp)
4428 struct resource_list * rl = NULL;
4429 struct resource_list_entry * rle = NULL;
4431 rl = BUS_GET_RESOURCE_LIST(dev, child);
4435 rle = resource_list_find(rl, type, rid);
4440 *startp = rle->start;
4442 *countp = rle->count;
4448 * @brief Helper function for implementing BUS_SET_RESOURCE().
4450 * This implementation of BUS_SET_RESOURCE() uses the
4451 * resource_list_add() function to do most of the work. It calls
4452 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4456 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4457 rman_res_t start, rman_res_t count)
4459 struct resource_list * rl = NULL;
4461 rl = BUS_GET_RESOURCE_LIST(dev, child);
4465 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4471 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4473 * This implementation of BUS_DELETE_RESOURCE() uses the
4474 * resource_list_delete() function to do most of the work. It calls
4475 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4479 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4481 struct resource_list * rl = NULL;
4483 rl = BUS_GET_RESOURCE_LIST(dev, child);
4487 resource_list_delete(rl, type, rid);
4493 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4495 * This implementation of BUS_RELEASE_RESOURCE() uses the
4496 * resource_list_release() function to do most of the work. It calls
4497 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4500 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4501 int rid, struct resource *r)
4503 struct resource_list * rl = NULL;
4505 if (device_get_parent(child) != dev)
4506 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4509 rl = BUS_GET_RESOURCE_LIST(dev, child);
4513 return (resource_list_release(rl, dev, child, type, rid, r));
4517 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4519 * This implementation of BUS_ALLOC_RESOURCE() uses the
4520 * resource_list_alloc() function to do most of the work. It calls
4521 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4524 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4525 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
4527 struct resource_list * rl = NULL;
4529 if (device_get_parent(child) != dev)
4530 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4531 type, rid, start, end, count, flags));
4533 rl = BUS_GET_RESOURCE_LIST(dev, child);
4537 return (resource_list_alloc(rl, dev, child, type, rid,
4538 start, end, count, flags));
4542 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4544 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4545 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4548 bus_generic_child_present(device_t dev, device_t child)
4550 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4554 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4558 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4564 * @brief Helper function for implementing BUS_RESCAN().
4566 * This null implementation of BUS_RESCAN() always fails to indicate
4567 * the bus does not support rescanning.
4570 bus_null_rescan(device_t dev)
4577 * Some convenience functions to make it easier for drivers to use the
4578 * resource-management functions. All these really do is hide the
4579 * indirection through the parent's method table, making for slightly
4580 * less-wordy code. In the future, it might make sense for this code
4581 * to maintain some sort of a list of resources allocated by each device.
4585 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4586 struct resource **res)
4590 for (i = 0; rs[i].type != -1; i++)
4592 for (i = 0; rs[i].type != -1; i++) {
4593 res[i] = bus_alloc_resource_any(dev,
4594 rs[i].type, &rs[i].rid, rs[i].flags);
4595 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4596 bus_release_resources(dev, rs, res);
4604 bus_release_resources(device_t dev, const struct resource_spec *rs,
4605 struct resource **res)
4609 for (i = 0; rs[i].type != -1; i++)
4610 if (res[i] != NULL) {
4611 bus_release_resource(
4612 dev, rs[i].type, rs[i].rid, res[i]);
4618 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4620 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4624 bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
4625 rman_res_t end, rman_res_t count, u_int flags)
4627 struct resource *res;
4629 if (dev->parent == NULL)
4631 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4637 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4639 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4643 bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start,
4646 if (dev->parent == NULL)
4648 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4652 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4654 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4658 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4660 if (dev->parent == NULL)
4662 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4666 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4668 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4672 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4674 if (dev->parent == NULL)
4676 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4680 * @brief Wrapper function for BUS_MAP_RESOURCE().
4682 * This function simply calls the BUS_MAP_RESOURCE() method of the
4686 bus_map_resource(device_t dev, int type, struct resource *r,
4687 struct resource_map_request *args, struct resource_map *map)
4689 if (dev->parent == NULL)
4691 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map));
4695 * @brief Wrapper function for BUS_UNMAP_RESOURCE().
4697 * This function simply calls the BUS_UNMAP_RESOURCE() method of the
4701 bus_unmap_resource(device_t dev, int type, struct resource *r,
4702 struct resource_map *map)
4704 if (dev->parent == NULL)
4706 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map));
4710 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4712 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4716 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4720 if (dev->parent == NULL)
4722 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r);
4727 * @brief Wrapper function for BUS_SETUP_INTR().
4729 * This function simply calls the BUS_SETUP_INTR() method of the
4733 bus_setup_intr(device_t dev, struct resource *r, int flags,
4734 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4738 if (dev->parent == NULL)
4740 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4744 if (handler != NULL && !(flags & INTR_MPSAFE))
4745 device_printf(dev, "[GIANT-LOCKED]\n");
4750 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4752 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4756 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4758 if (dev->parent == NULL)
4760 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4764 * @brief Wrapper function for BUS_SUSPEND_INTR().
4766 * This function simply calls the BUS_SUSPEND_INTR() method of the
4770 bus_suspend_intr(device_t dev, struct resource *r)
4772 if (dev->parent == NULL)
4774 return (BUS_SUSPEND_INTR(dev->parent, dev, r));
4778 * @brief Wrapper function for BUS_RESUME_INTR().
4780 * This function simply calls the BUS_RESUME_INTR() method of the
4784 bus_resume_intr(device_t dev, struct resource *r)
4786 if (dev->parent == NULL)
4788 return (BUS_RESUME_INTR(dev->parent, dev, r));
4792 * @brief Wrapper function for BUS_BIND_INTR().
4794 * This function simply calls the BUS_BIND_INTR() method of the
4798 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4800 if (dev->parent == NULL)
4802 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4806 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4808 * This function first formats the requested description into a
4809 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4810 * the parent of @p dev.
4813 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4814 const char *fmt, ...)
4817 char descr[MAXCOMLEN + 1];
4819 if (dev->parent == NULL)
4822 vsnprintf(descr, sizeof(descr), fmt, ap);
4824 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4828 * @brief Wrapper function for BUS_SET_RESOURCE().
4830 * This function simply calls the BUS_SET_RESOURCE() method of the
4834 bus_set_resource(device_t dev, int type, int rid,
4835 rman_res_t start, rman_res_t count)
4837 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4842 * @brief Wrapper function for BUS_GET_RESOURCE().
4844 * This function simply calls the BUS_GET_RESOURCE() method of the
4848 bus_get_resource(device_t dev, int type, int rid,
4849 rman_res_t *startp, rman_res_t *countp)
4851 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4856 * @brief Wrapper function for BUS_GET_RESOURCE().
4858 * This function simply calls the BUS_GET_RESOURCE() method of the
4859 * parent of @p dev and returns the start value.
4862 bus_get_resource_start(device_t dev, int type, int rid)
4868 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4876 * @brief Wrapper function for BUS_GET_RESOURCE().
4878 * This function simply calls the BUS_GET_RESOURCE() method of the
4879 * parent of @p dev and returns the count value.
4882 bus_get_resource_count(device_t dev, int type, int rid)
4888 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4896 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4898 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4902 bus_delete_resource(device_t dev, int type, int rid)
4904 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4908 * @brief Wrapper function for BUS_CHILD_PRESENT().
4910 * This function simply calls the BUS_CHILD_PRESENT() method of the
4914 bus_child_present(device_t child)
4916 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4920 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4922 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4926 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4930 parent = device_get_parent(child);
4931 if (parent == NULL) {
4935 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4939 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4941 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4945 bus_child_location_str(device_t child, char *buf, size_t buflen)
4949 parent = device_get_parent(child);
4950 if (parent == NULL) {
4954 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4958 * @brief Wrapper function for BUS_GET_CPUS().
4960 * This function simply calls the BUS_GET_CPUS() method of the
4964 bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset)
4968 parent = device_get_parent(dev);
4971 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset));
4975 * @brief Wrapper function for BUS_GET_DMA_TAG().
4977 * This function simply calls the BUS_GET_DMA_TAG() method of the
4981 bus_get_dma_tag(device_t dev)
4985 parent = device_get_parent(dev);
4988 return (BUS_GET_DMA_TAG(parent, dev));
4992 * @brief Wrapper function for BUS_GET_BUS_TAG().
4994 * This function simply calls the BUS_GET_BUS_TAG() method of the
4998 bus_get_bus_tag(device_t dev)
5002 parent = device_get_parent(dev);
5004 return ((bus_space_tag_t)0);
5005 return (BUS_GET_BUS_TAG(parent, dev));
5009 * @brief Wrapper function for BUS_GET_DOMAIN().
5011 * This function simply calls the BUS_GET_DOMAIN() method of the
5015 bus_get_domain(device_t dev, int *domain)
5017 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
5020 /* Resume all devices and then notify userland that we're up again. */
5022 root_resume(device_t dev)
5026 error = bus_generic_resume(dev);
5028 devctl_notify("kern", "power", "resume", NULL); /* Deprecated gone in 14 */
5029 devctl_notify("kernel", "power", "resume", NULL);
5035 root_print_child(device_t dev, device_t child)
5039 retval += bus_print_child_header(dev, child);
5040 retval += printf("\n");
5046 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
5047 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
5050 * If an interrupt mapping gets to here something bad has happened.
5052 panic("root_setup_intr");
5056 * If we get here, assume that the device is permanent and really is
5057 * present in the system. Removable bus drivers are expected to intercept
5058 * this call long before it gets here. We return -1 so that drivers that
5059 * really care can check vs -1 or some ERRNO returned higher in the food
5063 root_child_present(device_t dev, device_t child)
5069 root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
5075 /* Default to returning the set of all CPUs. */
5076 if (setsize != sizeof(cpuset_t))
5085 static kobj_method_t root_methods[] = {
5086 /* Device interface */
5087 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
5088 KOBJMETHOD(device_suspend, bus_generic_suspend),
5089 KOBJMETHOD(device_resume, root_resume),
5092 KOBJMETHOD(bus_print_child, root_print_child),
5093 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
5094 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
5095 KOBJMETHOD(bus_setup_intr, root_setup_intr),
5096 KOBJMETHOD(bus_child_present, root_child_present),
5097 KOBJMETHOD(bus_get_cpus, root_get_cpus),
5102 static driver_t root_driver = {
5109 devclass_t root_devclass;
5112 root_bus_module_handler(module_t mod, int what, void* arg)
5116 TAILQ_INIT(&bus_data_devices);
5117 kobj_class_compile((kobj_class_t) &root_driver);
5118 root_bus = make_device(NULL, "root", 0);
5119 root_bus->desc = "System root bus";
5120 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
5121 root_bus->driver = &root_driver;
5122 root_bus->state = DS_ATTACHED;
5123 root_devclass = devclass_find_internal("root", NULL, FALSE);
5128 device_shutdown(root_bus);
5131 return (EOPNOTSUPP);
5137 static moduledata_t root_bus_mod = {
5139 root_bus_module_handler,
5142 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
5145 * @brief Automatically configure devices
5147 * This function begins the autoconfiguration process by calling
5148 * device_probe_and_attach() for each child of the @c root0 device.
5151 root_bus_configure(void)
5156 /* Eventually this will be split up, but this is sufficient for now. */
5157 bus_set_pass(BUS_PASS_DEFAULT);
5161 * @brief Module handler for registering device drivers
5163 * This module handler is used to automatically register device
5164 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
5165 * devclass_add_driver() for the driver described by the
5166 * driver_module_data structure pointed to by @p arg
5169 driver_module_handler(module_t mod, int what, void *arg)
5171 struct driver_module_data *dmd;
5172 devclass_t bus_devclass;
5173 kobj_class_t driver;
5176 dmd = (struct driver_module_data *)arg;
5177 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
5182 if (dmd->dmd_chainevh)
5183 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5185 pass = dmd->dmd_pass;
5186 driver = dmd->dmd_driver;
5187 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
5188 DRIVERNAME(driver), dmd->dmd_busname, pass));
5189 error = devclass_add_driver(bus_devclass, driver, pass,
5194 PDEBUG(("Unloading module: driver %s from bus %s",
5195 DRIVERNAME(dmd->dmd_driver),
5197 error = devclass_delete_driver(bus_devclass,
5200 if (!error && dmd->dmd_chainevh)
5201 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5204 PDEBUG(("Quiesce module: driver %s from bus %s",
5205 DRIVERNAME(dmd->dmd_driver),
5207 error = devclass_quiesce_driver(bus_devclass,
5210 if (!error && dmd->dmd_chainevh)
5211 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
5222 * @brief Enumerate all hinted devices for this bus.
5224 * Walks through the hints for this bus and calls the bus_hinted_child
5225 * routine for each one it fines. It searches first for the specific
5226 * bus that's being probed for hinted children (eg isa0), and then for
5227 * generic children (eg isa).
5229 * @param dev bus device to enumerate
5232 bus_enumerate_hinted_children(device_t bus)
5235 const char *dname, *busname;
5239 * enumerate all devices on the specific bus
5241 busname = device_get_nameunit(bus);
5243 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5244 BUS_HINTED_CHILD(bus, dname, dunit);
5247 * and all the generic ones.
5249 busname = device_get_name(bus);
5251 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
5252 BUS_HINTED_CHILD(bus, dname, dunit);
5257 /* the _short versions avoid iteration by not calling anything that prints
5258 * more than oneliners. I love oneliners.
5262 print_device_short(device_t dev, int indent)
5267 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
5268 dev->unit, dev->desc,
5269 (dev->parent? "":"no "),
5270 (TAILQ_EMPTY(&dev->children)? "no ":""),
5271 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
5272 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
5273 (dev->flags&DF_WILDCARD? "wildcard,":""),
5274 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
5275 (dev->flags&DF_REBID? "rebiddable,":""),
5276 (dev->flags&DF_SUSPENDED? "suspended,":""),
5277 (dev->ivars? "":"no "),
5278 (dev->softc? "":"no "),
5283 print_device(device_t dev, int indent)
5288 print_device_short(dev, indent);
5290 indentprintf(("Parent:\n"));
5291 print_device_short(dev->parent, indent+1);
5292 indentprintf(("Driver:\n"));
5293 print_driver_short(dev->driver, indent+1);
5294 indentprintf(("Devclass:\n"));
5295 print_devclass_short(dev->devclass, indent+1);
5299 print_device_tree_short(device_t dev, int indent)
5300 /* print the device and all its children (indented) */
5307 print_device_short(dev, indent);
5309 TAILQ_FOREACH(child, &dev->children, link) {
5310 print_device_tree_short(child, indent+1);
5315 print_device_tree(device_t dev, int indent)
5316 /* print the device and all its children (indented) */
5323 print_device(dev, indent);
5325 TAILQ_FOREACH(child, &dev->children, link) {
5326 print_device_tree(child, indent+1);
5331 print_driver_short(driver_t *driver, int indent)
5336 indentprintf(("driver %s: softc size = %zd\n",
5337 driver->name, driver->size));
5341 print_driver(driver_t *driver, int indent)
5346 print_driver_short(driver, indent);
5350 print_driver_list(driver_list_t drivers, int indent)
5352 driverlink_t driver;
5354 TAILQ_FOREACH(driver, &drivers, link) {
5355 print_driver(driver->driver, indent);
5360 print_devclass_short(devclass_t dc, int indent)
5365 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
5369 print_devclass(devclass_t dc, int indent)
5376 print_devclass_short(dc, indent);
5377 indentprintf(("Drivers:\n"));
5378 print_driver_list(dc->drivers, indent+1);
5380 indentprintf(("Devices:\n"));
5381 for (i = 0; i < dc->maxunit; i++)
5383 print_device(dc->devices[i], indent+1);
5387 print_devclass_list_short(void)
5391 printf("Short listing of devclasses, drivers & devices:\n");
5392 TAILQ_FOREACH(dc, &devclasses, link) {
5393 print_devclass_short(dc, 0);
5398 print_devclass_list(void)
5402 printf("Full listing of devclasses, drivers & devices:\n");
5403 TAILQ_FOREACH(dc, &devclasses, link) {
5404 print_devclass(dc, 0);
5411 * User-space access to the device tree.
5413 * We implement a small set of nodes:
5415 * hw.bus Single integer read method to obtain the
5416 * current generation count.
5417 * hw.bus.devices Reads the entire device tree in flat space.
5418 * hw.bus.rman Resource manager interface
5420 * We might like to add the ability to scan devclasses and/or drivers to
5421 * determine what else is currently loaded/available.
5425 sysctl_bus(SYSCTL_HANDLER_ARGS)
5427 struct u_businfo ubus;
5429 ubus.ub_version = BUS_USER_VERSION;
5430 ubus.ub_generation = bus_data_generation;
5432 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
5434 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
5435 "bus-related data");
5438 sysctl_devices(SYSCTL_HANDLER_ARGS)
5440 int *name = (int *)arg1;
5441 u_int namelen = arg2;
5444 struct u_device *udev;
5451 if (bus_data_generation_check(name[0]))
5457 * Scan the list of devices, looking for the requested index.
5459 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5467 * Populate the return item, careful not to overflow the buffer.
5469 udev = malloc(sizeof(*udev), M_BUS, M_WAITOK | M_ZERO);
5472 udev->dv_handle = (uintptr_t)dev;
5473 udev->dv_parent = (uintptr_t)dev->parent;
5474 udev->dv_devflags = dev->devflags;
5475 udev->dv_flags = dev->flags;
5476 udev->dv_state = dev->state;
5477 walker = udev->dv_fields;
5478 ep = walker + sizeof(udev->dv_fields);
5480 if ((src) == NULL) \
5483 strlcpy(walker, (src), ep - walker); \
5484 walker += strlen(walker) + 1; \
5492 CP(dev->driver != NULL ? dev->driver->name : NULL);
5493 bus_child_pnpinfo_str(dev, walker, ep - walker);
5494 walker += strlen(walker) + 1;
5497 bus_child_location_str(dev, walker, ep - walker);
5498 walker += strlen(walker) + 1;
5504 error = SYSCTL_OUT(req, udev, sizeof(*udev));
5509 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
5510 "system device tree");
5513 bus_data_generation_check(int generation)
5515 if (generation != bus_data_generation)
5518 /* XXX generate optimised lists here? */
5523 bus_data_generation_update(void)
5525 bus_data_generation++;
5529 bus_free_resource(device_t dev, int type, struct resource *r)
5533 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5537 device_lookup_by_name(const char *name)
5541 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5542 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5549 * /dev/devctl2 implementation. The existing /dev/devctl device has
5550 * implicit semantics on open, so it could not be reused for this.
5551 * Another option would be to call this /dev/bus?
5554 find_device(struct devreq *req, device_t *devp)
5559 * First, ensure that the name is nul terminated.
5561 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5565 * Second, try to find an attached device whose name matches
5568 dev = device_lookup_by_name(req->dr_name);
5574 /* Finally, give device enumerators a chance. */
5576 EVENTHANDLER_DIRECT_INVOKE(dev_lookup, req->dr_name, &dev);
5584 driver_exists(device_t bus, const char *driver)
5588 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5589 if (devclass_find_driver_internal(dc, driver) != NULL)
5596 device_gen_nomatch(device_t dev)
5600 if (dev->flags & DF_NEEDNOMATCH &&
5601 dev->state == DS_NOTPRESENT) {
5602 BUS_PROBE_NOMATCH(dev->parent, dev);
5604 dev->flags |= DF_DONENOMATCH;
5606 dev->flags &= ~DF_NEEDNOMATCH;
5607 TAILQ_FOREACH(child, &dev->children, link) {
5608 device_gen_nomatch(child);
5613 device_do_deferred_actions(void)
5619 * Walk through the devclasses to find all the drivers we've tagged as
5620 * deferred during the freeze and call the driver added routines. They
5621 * have already been added to the lists in the background, so the driver
5622 * added routines that trigger a probe will have all the right bidders
5623 * for the probe auction.
5625 TAILQ_FOREACH(dc, &devclasses, link) {
5626 TAILQ_FOREACH(dl, &dc->drivers, link) {
5627 if (dl->flags & DL_DEFERRED_PROBE) {
5628 devclass_driver_added(dc, dl->driver);
5629 dl->flags &= ~DL_DEFERRED_PROBE;
5635 * We also defer no-match events during a freeze. Walk the tree and
5636 * generate all the pent-up events that are still relevant.
5638 device_gen_nomatch(root_bus);
5639 bus_data_generation_update();
5643 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5650 /* Locate the device to control. */
5652 req = (struct devreq *)data;
5660 case DEV_SET_DRIVER:
5661 case DEV_CLEAR_DRIVER:
5665 error = priv_check(td, PRIV_DRIVER);
5667 error = find_device(req, &dev);
5671 error = priv_check(td, PRIV_DRIVER);
5682 /* Perform the requested operation. */
5685 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5687 else if (!device_is_enabled(dev))
5690 error = device_probe_and_attach(dev);
5693 if (!device_is_attached(dev)) {
5697 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5698 error = device_quiesce(dev);
5702 error = device_detach(dev);
5705 if (device_is_enabled(dev)) {
5711 * If the device has been probed but not attached (e.g.
5712 * when it has been disabled by a loader hint), just
5713 * attach the device rather than doing a full probe.
5716 if (device_is_alive(dev)) {
5718 * If the device was disabled via a hint, clear
5721 if (resource_disabled(dev->driver->name, dev->unit))
5722 resource_unset_value(dev->driver->name,
5723 dev->unit, "disabled");
5724 error = device_attach(dev);
5726 error = device_probe_and_attach(dev);
5729 if (!device_is_enabled(dev)) {
5734 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5735 error = device_quiesce(dev);
5741 * Force DF_FIXEDCLASS on around detach to preserve
5742 * the existing name.
5745 dev->flags |= DF_FIXEDCLASS;
5746 error = device_detach(dev);
5747 if (!(old & DF_FIXEDCLASS))
5748 dev->flags &= ~DF_FIXEDCLASS;
5750 device_disable(dev);
5753 if (device_is_suspended(dev)) {
5757 if (device_get_parent(dev) == NULL) {
5761 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev);
5764 if (!device_is_suspended(dev)) {
5768 if (device_get_parent(dev) == NULL) {
5772 error = BUS_RESUME_CHILD(device_get_parent(dev), dev);
5774 case DEV_SET_DRIVER: {
5778 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5781 if (driver[0] == '\0') {
5785 if (dev->devclass != NULL &&
5786 strcmp(driver, dev->devclass->name) == 0)
5787 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5791 * Scan drivers for this device's bus looking for at
5792 * least one matching driver.
5794 if (dev->parent == NULL) {
5798 if (!driver_exists(dev->parent, driver)) {
5802 dc = devclass_create(driver);
5808 /* Detach device if necessary. */
5809 if (device_is_attached(dev)) {
5810 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5811 error = device_detach(dev);
5818 /* Clear any previously-fixed device class and unit. */
5819 if (dev->flags & DF_FIXEDCLASS)
5820 devclass_delete_device(dev->devclass, dev);
5821 dev->flags |= DF_WILDCARD;
5824 /* Force the new device class. */
5825 error = devclass_add_device(dc, dev);
5828 dev->flags |= DF_FIXEDCLASS;
5829 error = device_probe_and_attach(dev);
5832 case DEV_CLEAR_DRIVER:
5833 if (!(dev->flags & DF_FIXEDCLASS)) {
5837 if (device_is_attached(dev)) {
5838 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5839 error = device_detach(dev);
5846 dev->flags &= ~DF_FIXEDCLASS;
5847 dev->flags |= DF_WILDCARD;
5848 devclass_delete_device(dev->devclass, dev);
5849 error = device_probe_and_attach(dev);
5852 if (!device_is_attached(dev)) {
5856 error = BUS_RESCAN(dev);
5861 parent = device_get_parent(dev);
5862 if (parent == NULL) {
5866 if (!(req->dr_flags & DEVF_FORCE_DELETE)) {
5867 if (bus_child_present(dev) != 0) {
5873 error = device_delete_child(parent, dev);
5880 device_frozen = true;
5886 device_do_deferred_actions();
5887 device_frozen = false;
5891 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) {
5895 error = BUS_RESET_CHILD(device_get_parent(dev), dev,
5903 static struct cdevsw devctl2_cdevsw = {
5904 .d_version = D_VERSION,
5905 .d_ioctl = devctl2_ioctl,
5906 .d_name = "devctl2",
5913 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5914 UID_ROOT, GID_WHEEL, 0600, "devctl2");
5918 * APIs to manage deprecation and obsolescence.
5920 static int obsolete_panic = 0;
5921 SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0,
5922 "Panic when obsolete features are used (0 = never, 1 = if osbolete, "
5923 "2 = if deprecated)");
5926 gone_panic(int major, int running, const char *msg)
5929 switch (obsolete_panic)
5934 if (running < major)
5943 _gone_in(int major, const char *msg)
5946 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5947 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5948 printf("Obsolete code will removed soon: %s\n", msg);
5950 printf("Deprecated code (to be removed in FreeBSD %d): %s\n",
5955 _gone_in_dev(device_t dev, int major, const char *msg)
5958 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg);
5959 if (P_OSREL_MAJOR(__FreeBSD_version) >= major)
5961 "Obsolete code will removed soon: %s\n", msg);
5964 "Deprecated code (to be removed in FreeBSD %d): %s\n",
5969 DB_SHOW_COMMAND(device, db_show_device)
5976 dev = (device_t)addr;
5978 db_printf("name: %s\n", device_get_nameunit(dev));
5979 db_printf(" driver: %s\n", DRIVERNAME(dev->driver));
5980 db_printf(" class: %s\n", DEVCLANAME(dev->devclass));
5981 db_printf(" addr: %p\n", dev);
5982 db_printf(" parent: %p\n", dev->parent);
5983 db_printf(" softc: %p\n", dev->softc);
5984 db_printf(" ivars: %p\n", dev->ivars);
5987 DB_SHOW_ALL_COMMAND(devices, db_show_all_devices)
5991 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5992 db_show_device((db_expr_t)dev, true, count, modif);