2 * Copyright (c) 1997,1998,2003 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include "opt_random.h"
33 #include <sys/param.h>
35 #include <sys/filio.h>
37 #include <sys/kernel.h>
39 #include <sys/limits.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
46 #include <sys/condvar.h>
47 #include <sys/queue.h>
48 #include <machine/bus.h>
49 #include <sys/random.h>
51 #include <sys/selinfo.h>
52 #include <sys/signalvar.h>
53 #include <sys/sysctl.h>
54 #include <sys/systm.h>
57 #include <sys/interrupt.h>
58 #include <sys/cpuset.h>
62 #include <machine/cpu.h>
63 #include <machine/stdarg.h>
67 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
68 SYSCTL_NODE(, OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
71 * Used to attach drivers to devclasses.
73 typedef struct driverlink *driverlink_t;
76 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
78 TAILQ_ENTRY(driverlink) passlink;
82 * Forward declarations
84 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
85 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
86 typedef TAILQ_HEAD(device_list, device) device_list_t;
89 TAILQ_ENTRY(devclass) link;
90 devclass_t parent; /* parent in devclass hierarchy */
91 driver_list_t drivers; /* bus devclasses store drivers for bus */
93 device_t *devices; /* array of devices indexed by unit */
94 int maxunit; /* size of devices array */
96 #define DC_HAS_CHILDREN 1
98 struct sysctl_ctx_list sysctl_ctx;
99 struct sysctl_oid *sysctl_tree;
103 * @brief Implementation of device.
107 * A device is a kernel object. The first field must be the
108 * current ops table for the object.
115 TAILQ_ENTRY(device) link; /**< list of devices in parent */
116 TAILQ_ENTRY(device) devlink; /**< global device list membership */
117 device_t parent; /**< parent of this device */
118 device_list_t children; /**< list of child devices */
121 * Details of this device.
123 driver_t *driver; /**< current driver */
124 devclass_t devclass; /**< current device class */
125 int unit; /**< current unit number */
126 char* nameunit; /**< name+unit e.g. foodev0 */
127 char* desc; /**< driver specific description */
128 int busy; /**< count of calls to device_busy() */
129 device_state_t state; /**< current device state */
130 uint32_t devflags; /**< api level flags for device_get_flags() */
131 u_int flags; /**< internal device flags */
132 #define DF_ENABLED 0x01 /* device should be probed/attached */
133 #define DF_FIXEDCLASS 0x02 /* devclass specified at create time */
134 #define DF_WILDCARD 0x04 /* unit was originally wildcard */
135 #define DF_DESCMALLOCED 0x08 /* description was malloced */
136 #define DF_QUIET 0x10 /* don't print verbose attach message */
137 #define DF_DONENOMATCH 0x20 /* don't execute DEVICE_NOMATCH again */
138 #define DF_EXTERNALSOFTC 0x40 /* softc not allocated by us */
139 #define DF_REBID 0x80 /* Can rebid after attach */
140 u_int order; /**< order from device_add_child_ordered() */
141 void *ivars; /**< instance variables */
142 void *softc; /**< current driver's variables */
144 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
145 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
148 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
149 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
151 static void devctl2_init(void);
155 static int bus_debug = 1;
156 TUNABLE_INT("bus.debug", &bus_debug);
157 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RW, &bus_debug, 0,
160 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
161 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
162 #define DRIVERNAME(d) ((d)? d->name : "no driver")
163 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
166 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
167 * prevent syslog from deleting initial spaces
169 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
171 static void print_device_short(device_t dev, int indent);
172 static void print_device(device_t dev, int indent);
173 void print_device_tree_short(device_t dev, int indent);
174 void print_device_tree(device_t dev, int indent);
175 static void print_driver_short(driver_t *driver, int indent);
176 static void print_driver(driver_t *driver, int indent);
177 static void print_driver_list(driver_list_t drivers, int indent);
178 static void print_devclass_short(devclass_t dc, int indent);
179 static void print_devclass(devclass_t dc, int indent);
180 void print_devclass_list_short(void);
181 void print_devclass_list(void);
184 /* Make the compiler ignore the function calls */
185 #define PDEBUG(a) /* nop */
186 #define DEVICENAME(d) /* nop */
187 #define DRIVERNAME(d) /* nop */
188 #define DEVCLANAME(d) /* nop */
190 #define print_device_short(d,i) /* nop */
191 #define print_device(d,i) /* nop */
192 #define print_device_tree_short(d,i) /* nop */
193 #define print_device_tree(d,i) /* nop */
194 #define print_driver_short(d,i) /* nop */
195 #define print_driver(d,i) /* nop */
196 #define print_driver_list(d,i) /* nop */
197 #define print_devclass_short(d,i) /* nop */
198 #define print_devclass(d,i) /* nop */
199 #define print_devclass_list_short() /* nop */
200 #define print_devclass_list() /* nop */
208 DEVCLASS_SYSCTL_PARENT,
212 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
214 devclass_t dc = (devclass_t)arg1;
218 case DEVCLASS_SYSCTL_PARENT:
219 value = dc->parent ? dc->parent->name : "";
224 return (SYSCTL_OUT(req, value, strlen(value)));
228 devclass_sysctl_init(devclass_t dc)
231 if (dc->sysctl_tree != NULL)
233 sysctl_ctx_init(&dc->sysctl_ctx);
234 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
235 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
236 CTLFLAG_RD, NULL, "");
237 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
238 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
239 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
245 DEVICE_SYSCTL_DRIVER,
246 DEVICE_SYSCTL_LOCATION,
247 DEVICE_SYSCTL_PNPINFO,
248 DEVICE_SYSCTL_PARENT,
252 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
254 device_t dev = (device_t)arg1;
261 case DEVICE_SYSCTL_DESC:
262 value = dev->desc ? dev->desc : "";
264 case DEVICE_SYSCTL_DRIVER:
265 value = dev->driver ? dev->driver->name : "";
267 case DEVICE_SYSCTL_LOCATION:
268 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
269 bus_child_location_str(dev, buf, 1024);
271 case DEVICE_SYSCTL_PNPINFO:
272 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
273 bus_child_pnpinfo_str(dev, buf, 1024);
275 case DEVICE_SYSCTL_PARENT:
276 value = dev->parent ? dev->parent->nameunit : "";
281 error = SYSCTL_OUT(req, value, strlen(value));
288 device_sysctl_init(device_t dev)
290 devclass_t dc = dev->devclass;
293 if (dev->sysctl_tree != NULL)
295 devclass_sysctl_init(dc);
296 sysctl_ctx_init(&dev->sysctl_ctx);
297 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx,
298 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
299 dev->nameunit + strlen(dc->name),
300 CTLFLAG_RD, NULL, "");
301 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
302 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
303 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
304 "device description");
305 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
306 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
307 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
308 "device driver name");
309 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
310 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
311 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
312 "device location relative to parent");
313 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
314 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
315 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
316 "device identification");
317 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
318 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
319 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
321 if (bus_get_domain(dev, &domain) == 0)
322 SYSCTL_ADD_INT(&dev->sysctl_ctx,
323 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain",
324 CTLFLAG_RD, NULL, domain, "NUMA domain");
328 device_sysctl_update(device_t dev)
330 devclass_t dc = dev->devclass;
332 if (dev->sysctl_tree == NULL)
334 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
338 device_sysctl_fini(device_t dev)
340 if (dev->sysctl_tree == NULL)
342 sysctl_ctx_free(&dev->sysctl_ctx);
343 dev->sysctl_tree = NULL;
347 * /dev/devctl implementation
351 * This design allows only one reader for /dev/devctl. This is not desirable
352 * in the long run, but will get a lot of hair out of this implementation.
353 * Maybe we should make this device a clonable device.
355 * Also note: we specifically do not attach a device to the device_t tree
356 * to avoid potential chicken and egg problems. One could argue that all
357 * of this belongs to the root node. One could also further argue that the
358 * sysctl interface that we have not might more properly be an ioctl
359 * interface, but at this stage of the game, I'm not inclined to rock that
362 * I'm also not sure that the SIGIO support is done correctly or not, as
363 * I copied it from a driver that had SIGIO support that likely hasn't been
364 * tested since 3.4 or 2.2.8!
367 /* Deprecated way to adjust queue length */
368 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
369 /* XXX Need to support old-style tunable hw.bus.devctl_disable" */
370 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW |
371 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I",
372 "devctl disable -- deprecated");
374 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
375 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
376 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
377 TUNABLE_INT("hw.bus.devctl_queue", &devctl_queue_length);
378 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RW |
379 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length");
381 static d_open_t devopen;
382 static d_close_t devclose;
383 static d_read_t devread;
384 static d_ioctl_t devioctl;
385 static d_poll_t devpoll;
386 static d_kqfilter_t devkqfilter;
388 static struct cdevsw dev_cdevsw = {
389 .d_version = D_VERSION,
395 .d_kqfilter = devkqfilter,
399 struct dev_event_info
402 TAILQ_ENTRY(dev_event_info) dei_link;
405 TAILQ_HEAD(devq, dev_event_info);
407 static struct dev_softc
420 static void filt_devctl_detach(struct knote *kn);
421 static int filt_devctl_read(struct knote *kn, long hint);
423 struct filterops devctl_rfiltops = {
425 .f_detach = filt_devctl_detach,
426 .f_event = filt_devctl_read,
429 static struct cdev *devctl_dev;
434 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
435 UID_ROOT, GID_WHEEL, 0600, "devctl");
436 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
437 cv_init(&devsoftc.cv, "dev cv");
438 TAILQ_INIT(&devsoftc.devq);
439 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx);
444 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
447 mtx_lock(&devsoftc.mtx);
448 if (devsoftc.inuse) {
449 mtx_unlock(&devsoftc.mtx);
454 mtx_unlock(&devsoftc.mtx);
459 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
462 mtx_lock(&devsoftc.mtx);
464 devsoftc.nonblock = 0;
466 cv_broadcast(&devsoftc.cv);
467 funsetown(&devsoftc.sigio);
468 mtx_unlock(&devsoftc.mtx);
473 * The read channel for this device is used to report changes to
474 * userland in realtime. We are required to free the data as well as
475 * the n1 object because we allocate them separately. Also note that
476 * we return one record at a time. If you try to read this device a
477 * character at a time, you will lose the rest of the data. Listening
478 * programs are expected to cope.
481 devread(struct cdev *dev, struct uio *uio, int ioflag)
483 struct dev_event_info *n1;
486 mtx_lock(&devsoftc.mtx);
487 while (TAILQ_EMPTY(&devsoftc.devq)) {
488 if (devsoftc.nonblock) {
489 mtx_unlock(&devsoftc.mtx);
492 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
495 * Need to translate ERESTART to EINTR here? -- jake
497 mtx_unlock(&devsoftc.mtx);
501 n1 = TAILQ_FIRST(&devsoftc.devq);
502 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
504 mtx_unlock(&devsoftc.mtx);
505 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
506 free(n1->dei_data, M_BUS);
512 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
518 devsoftc.nonblock = 1;
520 devsoftc.nonblock = 0;
529 return fsetown(*(int *)data, &devsoftc.sigio);
531 *(int *)data = fgetown(&devsoftc.sigio);
534 /* (un)Support for other fcntl() calls. */
545 devpoll(struct cdev *dev, int events, struct thread *td)
549 mtx_lock(&devsoftc.mtx);
550 if (events & (POLLIN | POLLRDNORM)) {
551 if (!TAILQ_EMPTY(&devsoftc.devq))
552 revents = events & (POLLIN | POLLRDNORM);
554 selrecord(td, &devsoftc.sel);
556 mtx_unlock(&devsoftc.mtx);
562 devkqfilter(struct cdev *dev, struct knote *kn)
566 if (kn->kn_filter == EVFILT_READ) {
567 kn->kn_fop = &devctl_rfiltops;
568 knlist_add(&devsoftc.sel.si_note, kn, 0);
576 filt_devctl_detach(struct knote *kn)
579 knlist_remove(&devsoftc.sel.si_note, kn, 0);
583 filt_devctl_read(struct knote *kn, long hint)
585 kn->kn_data = devsoftc.queued;
586 return (kn->kn_data != 0);
590 * @brief Return whether the userland process is running
593 devctl_process_running(void)
595 return (devsoftc.inuse == 1);
599 * @brief Queue data to be read from the devctl device
601 * Generic interface to queue data to the devctl device. It is
602 * assumed that @p data is properly formatted. It is further assumed
603 * that @p data is allocated using the M_BUS malloc type.
606 devctl_queue_data_f(char *data, int flags)
608 struct dev_event_info *n1 = NULL, *n2 = NULL;
610 if (strlen(data) == 0)
612 if (devctl_queue_length == 0)
614 n1 = malloc(sizeof(*n1), M_BUS, flags);
618 mtx_lock(&devsoftc.mtx);
619 if (devctl_queue_length == 0) {
620 mtx_unlock(&devsoftc.mtx);
621 free(n1->dei_data, M_BUS);
625 /* Leave at least one spot in the queue... */
626 while (devsoftc.queued > devctl_queue_length - 1) {
627 n2 = TAILQ_FIRST(&devsoftc.devq);
628 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
629 free(n2->dei_data, M_BUS);
633 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
635 cv_broadcast(&devsoftc.cv);
636 KNOTE_LOCKED(&devsoftc.sel.si_note, 0);
637 mtx_unlock(&devsoftc.mtx);
638 selwakeup(&devsoftc.sel);
639 if (devsoftc.async && devsoftc.sigio != NULL)
640 pgsigio(&devsoftc.sigio, SIGIO, 0);
644 * We have to free data on all error paths since the caller
645 * assumes it will be free'd when this item is dequeued.
652 devctl_queue_data(char *data)
655 devctl_queue_data_f(data, M_NOWAIT);
659 * @brief Send a 'notification' to userland, using standard ways
662 devctl_notify_f(const char *system, const char *subsystem, const char *type,
663 const char *data, int flags)
669 return; /* BOGUS! Must specify system. */
670 if (subsystem == NULL)
671 return; /* BOGUS! Must specify subsystem. */
673 return; /* BOGUS! Must specify type. */
674 len += strlen(" system=") + strlen(system);
675 len += strlen(" subsystem=") + strlen(subsystem);
676 len += strlen(" type=") + strlen(type);
677 /* add in the data message plus newline. */
680 len += 3; /* '!', '\n', and NUL */
681 msg = malloc(len, M_BUS, flags);
683 return; /* Drop it on the floor */
685 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
686 system, subsystem, type, data);
688 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
689 system, subsystem, type);
690 devctl_queue_data_f(msg, flags);
694 devctl_notify(const char *system, const char *subsystem, const char *type,
698 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
702 * Common routine that tries to make sending messages as easy as possible.
703 * We allocate memory for the data, copy strings into that, but do not
704 * free it unless there's an error. The dequeue part of the driver should
705 * free the data. We don't send data when the device is disabled. We do
706 * send data, even when we have no listeners, because we wish to avoid
707 * races relating to startup and restart of listening applications.
709 * devaddq is designed to string together the type of event, with the
710 * object of that event, plus the plug and play info and location info
711 * for that event. This is likely most useful for devices, but less
712 * useful for other consumers of this interface. Those should use
713 * the devctl_queue_data() interface instead.
716 devaddq(const char *type, const char *what, device_t dev)
723 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
725 data = malloc(1024, M_BUS, M_NOWAIT);
729 /* get the bus specific location of this device */
730 loc = malloc(1024, M_BUS, M_NOWAIT);
734 bus_child_location_str(dev, loc, 1024);
736 /* Get the bus specific pnp info of this device */
737 pnp = malloc(1024, M_BUS, M_NOWAIT);
741 bus_child_pnpinfo_str(dev, pnp, 1024);
743 /* Get the parent of this device, or / if high enough in the tree. */
744 if (device_get_parent(dev) == NULL)
745 parstr = "."; /* Or '/' ? */
747 parstr = device_get_nameunit(device_get_parent(dev));
748 /* String it all together. */
749 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
753 devctl_queue_data(data);
763 * A device was added to the tree. We are called just after it successfully
764 * attaches (that is, probe and attach success for this device). No call
765 * is made if a device is merely parented into the tree. See devnomatch
766 * if probe fails. If attach fails, no notification is sent (but maybe
767 * we should have a different message for this).
770 devadded(device_t dev)
772 devaddq("+", device_get_nameunit(dev), dev);
776 * A device was removed from the tree. We are called just before this
780 devremoved(device_t dev)
782 devaddq("-", device_get_nameunit(dev), dev);
786 * Called when there's no match for this device. This is only called
787 * the first time that no match happens, so we don't keep getting this
788 * message. Should that prove to be undesirable, we can change it.
789 * This is called when all drivers that can attach to a given bus
790 * decline to accept this device. Other errors may not be detected.
793 devnomatch(device_t dev)
795 devaddq("?", "", dev);
799 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
801 struct dev_event_info *n1;
804 dis = devctl_queue_length == 0;
805 error = sysctl_handle_int(oidp, &dis, 0, req);
806 if (error || !req->newptr)
808 mtx_lock(&devsoftc.mtx);
810 while (!TAILQ_EMPTY(&devsoftc.devq)) {
811 n1 = TAILQ_FIRST(&devsoftc.devq);
812 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
813 free(n1->dei_data, M_BUS);
817 devctl_queue_length = 0;
819 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
821 mtx_unlock(&devsoftc.mtx);
826 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
828 struct dev_event_info *n1;
831 q = devctl_queue_length;
832 error = sysctl_handle_int(oidp, &q, 0, req);
833 if (error || !req->newptr)
837 mtx_lock(&devsoftc.mtx);
838 devctl_queue_length = q;
839 while (devsoftc.queued > devctl_queue_length) {
840 n1 = TAILQ_FIRST(&devsoftc.devq);
841 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
842 free(n1->dei_data, M_BUS);
846 mtx_unlock(&devsoftc.mtx);
850 /* End of /dev/devctl code */
852 static TAILQ_HEAD(,device) bus_data_devices;
853 static int bus_data_generation = 1;
855 static kobj_method_t null_methods[] = {
859 DEFINE_CLASS(null, null_methods, 0);
862 * Bus pass implementation
865 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
866 int bus_current_pass = BUS_PASS_ROOT;
870 * @brief Register the pass level of a new driver attachment
872 * Register a new driver attachment's pass level. If no driver
873 * attachment with the same pass level has been added, then @p new
874 * will be added to the global passes list.
876 * @param new the new driver attachment
879 driver_register_pass(struct driverlink *new)
881 struct driverlink *dl;
883 /* We only consider pass numbers during boot. */
884 if (bus_current_pass == BUS_PASS_DEFAULT)
888 * Walk the passes list. If we already know about this pass
889 * then there is nothing to do. If we don't, then insert this
890 * driver link into the list.
892 TAILQ_FOREACH(dl, &passes, passlink) {
893 if (dl->pass < new->pass)
895 if (dl->pass == new->pass)
897 TAILQ_INSERT_BEFORE(dl, new, passlink);
900 TAILQ_INSERT_TAIL(&passes, new, passlink);
904 * @brief Raise the current bus pass
906 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
907 * method on the root bus to kick off a new device tree scan for each
908 * new pass level that has at least one driver.
911 bus_set_pass(int pass)
913 struct driverlink *dl;
915 if (bus_current_pass > pass)
916 panic("Attempt to lower bus pass level");
918 TAILQ_FOREACH(dl, &passes, passlink) {
919 /* Skip pass values below the current pass level. */
920 if (dl->pass <= bus_current_pass)
924 * Bail once we hit a driver with a pass level that is
931 * Raise the pass level to the next level and rescan
934 bus_current_pass = dl->pass;
935 BUS_NEW_PASS(root_bus);
939 * If there isn't a driver registered for the requested pass,
940 * then bus_current_pass might still be less than 'pass'. Set
941 * it to 'pass' in that case.
943 if (bus_current_pass < pass)
944 bus_current_pass = pass;
945 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
949 * Devclass implementation
952 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
956 * @brief Find or create a device class
958 * If a device class with the name @p classname exists, return it,
959 * otherwise if @p create is non-zero create and return a new device
962 * If @p parentname is non-NULL, the parent of the devclass is set to
963 * the devclass of that name.
965 * @param classname the devclass name to find or create
966 * @param parentname the parent devclass name or @c NULL
967 * @param create non-zero to create a devclass
970 devclass_find_internal(const char *classname, const char *parentname,
975 PDEBUG(("looking for %s", classname));
979 TAILQ_FOREACH(dc, &devclasses, link) {
980 if (!strcmp(dc->name, classname))
985 PDEBUG(("creating %s", classname));
986 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
987 M_BUS, M_NOWAIT | M_ZERO);
991 dc->name = (char*) (dc + 1);
992 strcpy(dc->name, classname);
993 TAILQ_INIT(&dc->drivers);
994 TAILQ_INSERT_TAIL(&devclasses, dc, link);
996 bus_data_generation_update();
1000 * If a parent class is specified, then set that as our parent so
1001 * that this devclass will support drivers for the parent class as
1002 * well. If the parent class has the same name don't do this though
1003 * as it creates a cycle that can trigger an infinite loop in
1004 * device_probe_child() if a device exists for which there is no
1007 if (parentname && dc && !dc->parent &&
1008 strcmp(classname, parentname) != 0) {
1009 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
1010 dc->parent->flags |= DC_HAS_CHILDREN;
1017 * @brief Create a device class
1019 * If a device class with the name @p classname exists, return it,
1020 * otherwise create and return a new device class.
1022 * @param classname the devclass name to find or create
1025 devclass_create(const char *classname)
1027 return (devclass_find_internal(classname, NULL, TRUE));
1031 * @brief Find a device class
1033 * If a device class with the name @p classname exists, return it,
1034 * otherwise return @c NULL.
1036 * @param classname the devclass name to find
1039 devclass_find(const char *classname)
1041 return (devclass_find_internal(classname, NULL, FALSE));
1045 * @brief Register that a device driver has been added to a devclass
1047 * Register that a device driver has been added to a devclass. This
1048 * is called by devclass_add_driver to accomplish the recursive
1049 * notification of all the children classes of dc, as well as dc.
1050 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1053 * We do a full search here of the devclass list at each iteration
1054 * level to save storing children-lists in the devclass structure. If
1055 * we ever move beyond a few dozen devices doing this, we may need to
1058 * @param dc the devclass to edit
1059 * @param driver the driver that was just added
1062 devclass_driver_added(devclass_t dc, driver_t *driver)
1068 * Call BUS_DRIVER_ADDED for any existing busses in this class.
1070 for (i = 0; i < dc->maxunit; i++)
1071 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1072 BUS_DRIVER_ADDED(dc->devices[i], driver);
1075 * Walk through the children classes. Since we only keep a
1076 * single parent pointer around, we walk the entire list of
1077 * devclasses looking for children. We set the
1078 * DC_HAS_CHILDREN flag when a child devclass is created on
1079 * the parent, so we only walk the list for those devclasses
1080 * that have children.
1082 if (!(dc->flags & DC_HAS_CHILDREN))
1085 TAILQ_FOREACH(dc, &devclasses, link) {
1086 if (dc->parent == parent)
1087 devclass_driver_added(dc, driver);
1092 * @brief Add a device driver to a device class
1094 * Add a device driver to a devclass. This is normally called
1095 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1096 * all devices in the devclass will be called to allow them to attempt
1097 * to re-probe any unmatched children.
1099 * @param dc the devclass to edit
1100 * @param driver the driver to register
1103 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1106 const char *parentname;
1108 PDEBUG(("%s", DRIVERNAME(driver)));
1110 /* Don't allow invalid pass values. */
1111 if (pass <= BUS_PASS_ROOT)
1114 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1119 * Compile the driver's methods. Also increase the reference count
1120 * so that the class doesn't get freed when the last instance
1121 * goes. This means we can safely use static methods and avoids a
1122 * double-free in devclass_delete_driver.
1124 kobj_class_compile((kobj_class_t) driver);
1127 * If the driver has any base classes, make the
1128 * devclass inherit from the devclass of the driver's
1129 * first base class. This will allow the system to
1130 * search for drivers in both devclasses for children
1131 * of a device using this driver.
1133 if (driver->baseclasses)
1134 parentname = driver->baseclasses[0]->name;
1137 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1139 dl->driver = driver;
1140 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1141 driver->refs++; /* XXX: kobj_mtx */
1143 driver_register_pass(dl);
1145 devclass_driver_added(dc, driver);
1146 bus_data_generation_update();
1151 * @brief Register that a device driver has been deleted from a devclass
1153 * Register that a device driver has been removed from a devclass.
1154 * This is called by devclass_delete_driver to accomplish the
1155 * recursive notification of all the children classes of busclass, as
1156 * well as busclass. Each layer will attempt to detach the driver
1157 * from any devices that are children of the bus's devclass. The function
1158 * will return an error if a device fails to detach.
1160 * We do a full search here of the devclass list at each iteration
1161 * level to save storing children-lists in the devclass structure. If
1162 * we ever move beyond a few dozen devices doing this, we may need to
1165 * @param busclass the devclass of the parent bus
1166 * @param dc the devclass of the driver being deleted
1167 * @param driver the driver being deleted
1170 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1177 * Disassociate from any devices. We iterate through all the
1178 * devices in the devclass of the driver and detach any which are
1179 * using the driver and which have a parent in the devclass which
1180 * we are deleting from.
1182 * Note that since a driver can be in multiple devclasses, we
1183 * should not detach devices which are not children of devices in
1184 * the affected devclass.
1186 for (i = 0; i < dc->maxunit; i++) {
1187 if (dc->devices[i]) {
1188 dev = dc->devices[i];
1189 if (dev->driver == driver && dev->parent &&
1190 dev->parent->devclass == busclass) {
1191 if ((error = device_detach(dev)) != 0)
1193 BUS_PROBE_NOMATCH(dev->parent, dev);
1195 dev->flags |= DF_DONENOMATCH;
1201 * Walk through the children classes. Since we only keep a
1202 * single parent pointer around, we walk the entire list of
1203 * devclasses looking for children. We set the
1204 * DC_HAS_CHILDREN flag when a child devclass is created on
1205 * the parent, so we only walk the list for those devclasses
1206 * that have children.
1208 if (!(busclass->flags & DC_HAS_CHILDREN))
1211 TAILQ_FOREACH(busclass, &devclasses, link) {
1212 if (busclass->parent == parent) {
1213 error = devclass_driver_deleted(busclass, dc, driver);
1222 * @brief Delete a device driver from a device class
1224 * Delete a device driver from a devclass. This is normally called
1225 * automatically by DRIVER_MODULE().
1227 * If the driver is currently attached to any devices,
1228 * devclass_delete_driver() will first attempt to detach from each
1229 * device. If one of the detach calls fails, the driver will not be
1232 * @param dc the devclass to edit
1233 * @param driver the driver to unregister
1236 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1238 devclass_t dc = devclass_find(driver->name);
1242 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1248 * Find the link structure in the bus' list of drivers.
1250 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1251 if (dl->driver == driver)
1256 PDEBUG(("%s not found in %s list", driver->name,
1261 error = devclass_driver_deleted(busclass, dc, driver);
1265 TAILQ_REMOVE(&busclass->drivers, dl, link);
1270 if (driver->refs == 0)
1271 kobj_class_free((kobj_class_t) driver);
1273 bus_data_generation_update();
1278 * @brief Quiesces a set of device drivers from a device class
1280 * Quiesce a device driver from a devclass. This is normally called
1281 * automatically by DRIVER_MODULE().
1283 * If the driver is currently attached to any devices,
1284 * devclass_quiesece_driver() will first attempt to quiesce each
1287 * @param dc the devclass to edit
1288 * @param driver the driver to unregister
1291 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1293 devclass_t dc = devclass_find(driver->name);
1299 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1305 * Find the link structure in the bus' list of drivers.
1307 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1308 if (dl->driver == driver)
1313 PDEBUG(("%s not found in %s list", driver->name,
1319 * Quiesce all devices. We iterate through all the devices in
1320 * the devclass of the driver and quiesce any which are using
1321 * the driver and which have a parent in the devclass which we
1324 * Note that since a driver can be in multiple devclasses, we
1325 * should not quiesce devices which are not children of
1326 * devices in the affected devclass.
1328 for (i = 0; i < dc->maxunit; i++) {
1329 if (dc->devices[i]) {
1330 dev = dc->devices[i];
1331 if (dev->driver == driver && dev->parent &&
1332 dev->parent->devclass == busclass) {
1333 if ((error = device_quiesce(dev)) != 0)
1346 devclass_find_driver_internal(devclass_t dc, const char *classname)
1350 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1352 TAILQ_FOREACH(dl, &dc->drivers, link) {
1353 if (!strcmp(dl->driver->name, classname))
1357 PDEBUG(("not found"));
1362 * @brief Return the name of the devclass
1365 devclass_get_name(devclass_t dc)
1371 * @brief Find a device given a unit number
1373 * @param dc the devclass to search
1374 * @param unit the unit number to search for
1376 * @returns the device with the given unit number or @c
1377 * NULL if there is no such device
1380 devclass_get_device(devclass_t dc, int unit)
1382 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1384 return (dc->devices[unit]);
1388 * @brief Find the softc field of a device given a unit number
1390 * @param dc the devclass to search
1391 * @param unit the unit number to search for
1393 * @returns the softc field of the device with the given
1394 * unit number or @c NULL if there is no such
1398 devclass_get_softc(devclass_t dc, int unit)
1402 dev = devclass_get_device(dc, unit);
1406 return (device_get_softc(dev));
1410 * @brief Get a list of devices in the devclass
1412 * An array containing a list of all the devices in the given devclass
1413 * is allocated and returned in @p *devlistp. The number of devices
1414 * in the array is returned in @p *devcountp. The caller should free
1415 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1417 * @param dc the devclass to examine
1418 * @param devlistp points at location for array pointer return
1420 * @param devcountp points at location for array size return value
1423 * @retval ENOMEM the array allocation failed
1426 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1431 count = devclass_get_count(dc);
1432 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1437 for (i = 0; i < dc->maxunit; i++) {
1438 if (dc->devices[i]) {
1439 list[count] = dc->devices[i];
1451 * @brief Get a list of drivers in the devclass
1453 * An array containing a list of pointers to all the drivers in the
1454 * given devclass is allocated and returned in @p *listp. The number
1455 * of drivers in the array is returned in @p *countp. The caller should
1456 * free the array using @c free(p, M_TEMP).
1458 * @param dc the devclass to examine
1459 * @param listp gives location for array pointer return value
1460 * @param countp gives location for number of array elements
1464 * @retval ENOMEM the array allocation failed
1467 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1474 TAILQ_FOREACH(dl, &dc->drivers, link)
1476 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1481 TAILQ_FOREACH(dl, &dc->drivers, link) {
1482 list[count] = dl->driver;
1492 * @brief Get the number of devices in a devclass
1494 * @param dc the devclass to examine
1497 devclass_get_count(devclass_t dc)
1502 for (i = 0; i < dc->maxunit; i++)
1509 * @brief Get the maximum unit number used in a devclass
1511 * Note that this is one greater than the highest currently-allocated
1512 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1513 * that not even the devclass has been allocated yet.
1515 * @param dc the devclass to examine
1518 devclass_get_maxunit(devclass_t dc)
1522 return (dc->maxunit);
1526 * @brief Find a free unit number in a devclass
1528 * This function searches for the first unused unit number greater
1529 * that or equal to @p unit.
1531 * @param dc the devclass to examine
1532 * @param unit the first unit number to check
1535 devclass_find_free_unit(devclass_t dc, int unit)
1539 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1545 * @brief Set the parent of a devclass
1547 * The parent class is normally initialised automatically by
1550 * @param dc the devclass to edit
1551 * @param pdc the new parent devclass
1554 devclass_set_parent(devclass_t dc, devclass_t pdc)
1560 * @brief Get the parent of a devclass
1562 * @param dc the devclass to examine
1565 devclass_get_parent(devclass_t dc)
1567 return (dc->parent);
1570 struct sysctl_ctx_list *
1571 devclass_get_sysctl_ctx(devclass_t dc)
1573 return (&dc->sysctl_ctx);
1577 devclass_get_sysctl_tree(devclass_t dc)
1579 return (dc->sysctl_tree);
1584 * @brief Allocate a unit number
1586 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1587 * will do). The allocated unit number is returned in @p *unitp.
1589 * @param dc the devclass to allocate from
1590 * @param unitp points at the location for the allocated unit
1594 * @retval EEXIST the requested unit number is already allocated
1595 * @retval ENOMEM memory allocation failure
1598 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1603 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1605 /* Ask the parent bus if it wants to wire this device. */
1607 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1610 /* If we were given a wired unit number, check for existing device */
1613 if (unit >= 0 && unit < dc->maxunit &&
1614 dc->devices[unit] != NULL) {
1616 printf("%s: %s%d already exists; skipping it\n",
1617 dc->name, dc->name, *unitp);
1621 /* Unwired device, find the next available slot for it */
1623 for (unit = 0;; unit++) {
1624 /* If there is an "at" hint for a unit then skip it. */
1625 if (resource_string_value(dc->name, unit, "at", &s) ==
1629 /* If this device slot is already in use, skip it. */
1630 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1638 * We've selected a unit beyond the length of the table, so let's
1639 * extend the table to make room for all units up to and including
1642 if (unit >= dc->maxunit) {
1643 device_t *newlist, *oldlist;
1646 oldlist = dc->devices;
1647 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1648 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1651 if (oldlist != NULL)
1652 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1653 bzero(newlist + dc->maxunit,
1654 sizeof(device_t) * (newsize - dc->maxunit));
1655 dc->devices = newlist;
1656 dc->maxunit = newsize;
1657 if (oldlist != NULL)
1658 free(oldlist, M_BUS);
1660 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1668 * @brief Add a device to a devclass
1670 * A unit number is allocated for the device (using the device's
1671 * preferred unit number if any) and the device is registered in the
1672 * devclass. This allows the device to be looked up by its unit
1673 * number, e.g. by decoding a dev_t minor number.
1675 * @param dc the devclass to add to
1676 * @param dev the device to add
1679 * @retval EEXIST the requested unit number is already allocated
1680 * @retval ENOMEM memory allocation failure
1683 devclass_add_device(devclass_t dc, device_t dev)
1687 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1689 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1692 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1696 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1697 free(dev->nameunit, M_BUS);
1698 dev->nameunit = NULL;
1701 dc->devices[dev->unit] = dev;
1703 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1710 * @brief Delete a device from a devclass
1712 * The device is removed from the devclass's device list and its unit
1715 * @param dc the devclass to delete from
1716 * @param dev the device to delete
1721 devclass_delete_device(devclass_t dc, device_t dev)
1726 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1728 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1729 panic("devclass_delete_device: inconsistent device class");
1730 dc->devices[dev->unit] = NULL;
1731 if (dev->flags & DF_WILDCARD)
1733 dev->devclass = NULL;
1734 free(dev->nameunit, M_BUS);
1735 dev->nameunit = NULL;
1742 * @brief Make a new device and add it as a child of @p parent
1744 * @param parent the parent of the new device
1745 * @param name the devclass name of the new device or @c NULL
1746 * to leave the devclass unspecified
1747 * @parem unit the unit number of the new device of @c -1 to
1748 * leave the unit number unspecified
1750 * @returns the new device
1753 make_device(device_t parent, const char *name, int unit)
1758 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1761 dc = devclass_find_internal(name, NULL, TRUE);
1763 printf("make_device: can't find device class %s\n",
1771 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
1775 dev->parent = parent;
1776 TAILQ_INIT(&dev->children);
1777 kobj_init((kobj_t) dev, &null_class);
1779 dev->devclass = NULL;
1781 dev->nameunit = NULL;
1785 dev->flags = DF_ENABLED;
1788 dev->flags |= DF_WILDCARD;
1790 dev->flags |= DF_FIXEDCLASS;
1791 if (devclass_add_device(dc, dev)) {
1792 kobj_delete((kobj_t) dev, M_BUS);
1799 dev->state = DS_NOTPRESENT;
1801 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1802 bus_data_generation_update();
1809 * @brief Print a description of a device.
1812 device_print_child(device_t dev, device_t child)
1816 if (device_is_alive(child))
1817 retval += BUS_PRINT_CHILD(dev, child);
1819 retval += device_printf(child, " not found\n");
1825 * @brief Create a new device
1827 * This creates a new device and adds it as a child of an existing
1828 * parent device. The new device will be added after the last existing
1829 * child with order zero.
1831 * @param dev the device which will be the parent of the
1833 * @param name devclass name for new device or @c NULL if not
1835 * @param unit unit number for new device or @c -1 if not
1838 * @returns the new device
1841 device_add_child(device_t dev, const char *name, int unit)
1843 return (device_add_child_ordered(dev, 0, name, unit));
1847 * @brief Create a new device
1849 * This creates a new device and adds it as a child of an existing
1850 * parent device. The new device will be added after the last existing
1851 * child with the same order.
1853 * @param dev the device which will be the parent of the
1855 * @param order a value which is used to partially sort the
1856 * children of @p dev - devices created using
1857 * lower values of @p order appear first in @p
1858 * dev's list of children
1859 * @param name devclass name for new device or @c NULL if not
1861 * @param unit unit number for new device or @c -1 if not
1864 * @returns the new device
1867 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1872 PDEBUG(("%s at %s with order %u as unit %d",
1873 name, DEVICENAME(dev), order, unit));
1874 KASSERT(name != NULL || unit == -1,
1875 ("child device with wildcard name and specific unit number"));
1877 child = make_device(dev, name, unit);
1880 child->order = order;
1882 TAILQ_FOREACH(place, &dev->children, link) {
1883 if (place->order > order)
1889 * The device 'place' is the first device whose order is
1890 * greater than the new child.
1892 TAILQ_INSERT_BEFORE(place, child, link);
1895 * The new child's order is greater or equal to the order of
1896 * any existing device. Add the child to the tail of the list.
1898 TAILQ_INSERT_TAIL(&dev->children, child, link);
1901 bus_data_generation_update();
1906 * @brief Delete a device
1908 * This function deletes a device along with all of its children. If
1909 * the device currently has a driver attached to it, the device is
1910 * detached first using device_detach().
1912 * @param dev the parent device
1913 * @param child the device to delete
1916 * @retval non-zero a unit error code describing the error
1919 device_delete_child(device_t dev, device_t child)
1922 device_t grandchild;
1924 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1926 /* detach parent before deleting children, if any */
1927 if ((error = device_detach(child)) != 0)
1930 /* remove children second */
1931 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1932 error = device_delete_child(child, grandchild);
1937 if (child->devclass)
1938 devclass_delete_device(child->devclass, child);
1940 BUS_CHILD_DELETED(dev, child);
1941 TAILQ_REMOVE(&dev->children, child, link);
1942 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1943 kobj_delete((kobj_t) child, M_BUS);
1945 bus_data_generation_update();
1950 * @brief Delete all children devices of the given device, if any.
1952 * This function deletes all children devices of the given device, if
1953 * any, using the device_delete_child() function for each device it
1954 * finds. If a child device cannot be deleted, this function will
1955 * return an error code.
1957 * @param dev the parent device
1960 * @retval non-zero a device would not detach
1963 device_delete_children(device_t dev)
1968 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1972 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1973 error = device_delete_child(dev, child);
1975 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
1983 * @brief Find a device given a unit number
1985 * This is similar to devclass_get_devices() but only searches for
1986 * devices which have @p dev as a parent.
1988 * @param dev the parent device to search
1989 * @param unit the unit number to search for. If the unit is -1,
1990 * return the first child of @p dev which has name
1991 * @p classname (that is, the one with the lowest unit.)
1993 * @returns the device with the given unit number or @c
1994 * NULL if there is no such device
1997 device_find_child(device_t dev, const char *classname, int unit)
2002 dc = devclass_find(classname);
2007 child = devclass_get_device(dc, unit);
2008 if (child && child->parent == dev)
2011 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
2012 child = devclass_get_device(dc, unit);
2013 if (child && child->parent == dev)
2024 first_matching_driver(devclass_t dc, device_t dev)
2027 return (devclass_find_driver_internal(dc, dev->devclass->name));
2028 return (TAILQ_FIRST(&dc->drivers));
2035 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
2037 if (dev->devclass) {
2039 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
2040 if (!strcmp(dev->devclass->name, dl->driver->name))
2044 return (TAILQ_NEXT(last, link));
2051 device_probe_child(device_t dev, device_t child)
2054 driverlink_t best = NULL;
2056 int result, pri = 0;
2057 int hasclass = (child->devclass != NULL);
2063 panic("device_probe_child: parent device has no devclass");
2066 * If the state is already probed, then return. However, don't
2067 * return if we can rebid this object.
2069 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2072 for (; dc; dc = dc->parent) {
2073 for (dl = first_matching_driver(dc, child);
2075 dl = next_matching_driver(dc, child, dl)) {
2076 /* If this driver's pass is too high, then ignore it. */
2077 if (dl->pass > bus_current_pass)
2080 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2081 result = device_set_driver(child, dl->driver);
2082 if (result == ENOMEM)
2084 else if (result != 0)
2087 if (device_set_devclass(child,
2088 dl->driver->name) != 0) {
2089 char const * devname =
2090 device_get_name(child);
2091 if (devname == NULL)
2092 devname = "(unknown)";
2093 printf("driver bug: Unable to set "
2094 "devclass (class: %s "
2098 (void)device_set_driver(child, NULL);
2103 /* Fetch any flags for the device before probing. */
2104 resource_int_value(dl->driver->name, child->unit,
2105 "flags", &child->devflags);
2107 result = DEVICE_PROBE(child);
2109 /* Reset flags and devclass before the next probe. */
2110 child->devflags = 0;
2112 (void)device_set_devclass(child, NULL);
2115 * If the driver returns SUCCESS, there can be
2116 * no higher match for this device.
2125 * Probes that return BUS_PROBE_NOWILDCARD or lower
2126 * only match on devices whose driver was explicitly
2129 if (result <= BUS_PROBE_NOWILDCARD &&
2130 !(child->flags & DF_FIXEDCLASS)) {
2135 * The driver returned an error so it
2136 * certainly doesn't match.
2139 (void)device_set_driver(child, NULL);
2144 * A priority lower than SUCCESS, remember the
2145 * best matching driver. Initialise the value
2146 * of pri for the first match.
2148 if (best == NULL || result > pri) {
2155 * If we have an unambiguous match in this devclass,
2156 * don't look in the parent.
2158 if (best && pri == 0)
2163 * If we found a driver, change state and initialise the devclass.
2165 /* XXX What happens if we rebid and got no best? */
2168 * If this device was attached, and we were asked to
2169 * rescan, and it is a different driver, then we have
2170 * to detach the old driver and reattach this new one.
2171 * Note, we don't have to check for DF_REBID here
2172 * because if the state is > DS_ALIVE, we know it must
2175 * This assumes that all DF_REBID drivers can have
2176 * their probe routine called at any time and that
2177 * they are idempotent as well as completely benign in
2178 * normal operations.
2180 * We also have to make sure that the detach
2181 * succeeded, otherwise we fail the operation (or
2182 * maybe it should just fail silently? I'm torn).
2184 if (child->state > DS_ALIVE && best->driver != child->driver)
2185 if ((result = device_detach(dev)) != 0)
2188 /* Set the winning driver, devclass, and flags. */
2189 if (!child->devclass) {
2190 result = device_set_devclass(child, best->driver->name);
2194 result = device_set_driver(child, best->driver);
2197 resource_int_value(best->driver->name, child->unit,
2198 "flags", &child->devflags);
2202 * A bit bogus. Call the probe method again to make
2203 * sure that we have the right description.
2205 DEVICE_PROBE(child);
2207 child->flags |= DF_REBID;
2210 child->flags &= ~DF_REBID;
2211 child->state = DS_ALIVE;
2213 bus_data_generation_update();
2221 * @brief Return the parent of a device
2224 device_get_parent(device_t dev)
2226 return (dev->parent);
2230 * @brief Get a list of children of a device
2232 * An array containing a list of all the children of the given device
2233 * is allocated and returned in @p *devlistp. The number of devices
2234 * in the array is returned in @p *devcountp. The caller should free
2235 * the array using @c free(p, M_TEMP).
2237 * @param dev the device to examine
2238 * @param devlistp points at location for array pointer return
2240 * @param devcountp points at location for array size return value
2243 * @retval ENOMEM the array allocation failed
2246 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2253 TAILQ_FOREACH(child, &dev->children, link) {
2262 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2267 TAILQ_FOREACH(child, &dev->children, link) {
2268 list[count] = child;
2279 * @brief Return the current driver for the device or @c NULL if there
2280 * is no driver currently attached
2283 device_get_driver(device_t dev)
2285 return (dev->driver);
2289 * @brief Return the current devclass for the device or @c NULL if
2293 device_get_devclass(device_t dev)
2295 return (dev->devclass);
2299 * @brief Return the name of the device's devclass or @c NULL if there
2303 device_get_name(device_t dev)
2305 if (dev != NULL && dev->devclass)
2306 return (devclass_get_name(dev->devclass));
2311 * @brief Return a string containing the device's devclass name
2312 * followed by an ascii representation of the device's unit number
2316 device_get_nameunit(device_t dev)
2318 return (dev->nameunit);
2322 * @brief Return the device's unit number.
2325 device_get_unit(device_t dev)
2331 * @brief Return the device's description string
2334 device_get_desc(device_t dev)
2340 * @brief Return the device's flags
2343 device_get_flags(device_t dev)
2345 return (dev->devflags);
2348 struct sysctl_ctx_list *
2349 device_get_sysctl_ctx(device_t dev)
2351 return (&dev->sysctl_ctx);
2355 device_get_sysctl_tree(device_t dev)
2357 return (dev->sysctl_tree);
2361 * @brief Print the name of the device followed by a colon and a space
2363 * @returns the number of characters printed
2366 device_print_prettyname(device_t dev)
2368 const char *name = device_get_name(dev);
2371 return (printf("unknown: "));
2372 return (printf("%s%d: ", name, device_get_unit(dev)));
2376 * @brief Print the name of the device followed by a colon, a space
2377 * and the result of calling vprintf() with the value of @p fmt and
2378 * the following arguments.
2380 * @returns the number of characters printed
2383 device_printf(device_t dev, const char * fmt, ...)
2388 retval = device_print_prettyname(dev);
2390 retval += vprintf(fmt, ap);
2399 device_set_desc_internal(device_t dev, const char* desc, int copy)
2401 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2402 free(dev->desc, M_BUS);
2403 dev->flags &= ~DF_DESCMALLOCED;
2408 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2410 strcpy(dev->desc, desc);
2411 dev->flags |= DF_DESCMALLOCED;
2414 /* Avoid a -Wcast-qual warning */
2415 dev->desc = (char *)(uintptr_t) desc;
2418 bus_data_generation_update();
2422 * @brief Set the device's description
2424 * The value of @c desc should be a string constant that will not
2425 * change (at least until the description is changed in a subsequent
2426 * call to device_set_desc() or device_set_desc_copy()).
2429 device_set_desc(device_t dev, const char* desc)
2431 device_set_desc_internal(dev, desc, FALSE);
2435 * @brief Set the device's description
2437 * The string pointed to by @c desc is copied. Use this function if
2438 * the device description is generated, (e.g. with sprintf()).
2441 device_set_desc_copy(device_t dev, const char* desc)
2443 device_set_desc_internal(dev, desc, TRUE);
2447 * @brief Set the device's flags
2450 device_set_flags(device_t dev, uint32_t flags)
2452 dev->devflags = flags;
2456 * @brief Return the device's softc field
2458 * The softc is allocated and zeroed when a driver is attached, based
2459 * on the size field of the driver.
2462 device_get_softc(device_t dev)
2464 return (dev->softc);
2468 * @brief Set the device's softc field
2470 * Most drivers do not need to use this since the softc is allocated
2471 * automatically when the driver is attached.
2474 device_set_softc(device_t dev, void *softc)
2476 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2477 free(dev->softc, M_BUS_SC);
2480 dev->flags |= DF_EXTERNALSOFTC;
2482 dev->flags &= ~DF_EXTERNALSOFTC;
2486 * @brief Free claimed softc
2488 * Most drivers do not need to use this since the softc is freed
2489 * automatically when the driver is detached.
2492 device_free_softc(void *softc)
2494 free(softc, M_BUS_SC);
2498 * @brief Claim softc
2500 * This function can be used to let the driver free the automatically
2501 * allocated softc using "device_free_softc()". This function is
2502 * useful when the driver is refcounting the softc and the softc
2503 * cannot be freed when the "device_detach" method is called.
2506 device_claim_softc(device_t dev)
2509 dev->flags |= DF_EXTERNALSOFTC;
2511 dev->flags &= ~DF_EXTERNALSOFTC;
2515 * @brief Get the device's ivars field
2517 * The ivars field is used by the parent device to store per-device
2518 * state (e.g. the physical location of the device or a list of
2522 device_get_ivars(device_t dev)
2525 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2526 return (dev->ivars);
2530 * @brief Set the device's ivars field
2533 device_set_ivars(device_t dev, void * ivars)
2536 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2541 * @brief Return the device's state
2544 device_get_state(device_t dev)
2546 return (dev->state);
2550 * @brief Set the DF_ENABLED flag for the device
2553 device_enable(device_t dev)
2555 dev->flags |= DF_ENABLED;
2559 * @brief Clear the DF_ENABLED flag for the device
2562 device_disable(device_t dev)
2564 dev->flags &= ~DF_ENABLED;
2568 * @brief Increment the busy counter for the device
2571 device_busy(device_t dev)
2573 if (dev->state < DS_ATTACHING)
2574 panic("device_busy: called for unattached device");
2575 if (dev->busy == 0 && dev->parent)
2576 device_busy(dev->parent);
2578 if (dev->state == DS_ATTACHED)
2579 dev->state = DS_BUSY;
2583 * @brief Decrement the busy counter for the device
2586 device_unbusy(device_t dev)
2588 if (dev->busy != 0 && dev->state != DS_BUSY &&
2589 dev->state != DS_ATTACHING)
2590 panic("device_unbusy: called for non-busy device %s",
2591 device_get_nameunit(dev));
2593 if (dev->busy == 0) {
2595 device_unbusy(dev->parent);
2596 if (dev->state == DS_BUSY)
2597 dev->state = DS_ATTACHED;
2602 * @brief Set the DF_QUIET flag for the device
2605 device_quiet(device_t dev)
2607 dev->flags |= DF_QUIET;
2611 * @brief Clear the DF_QUIET flag for the device
2614 device_verbose(device_t dev)
2616 dev->flags &= ~DF_QUIET;
2620 * @brief Return non-zero if the DF_QUIET flag is set on the device
2623 device_is_quiet(device_t dev)
2625 return ((dev->flags & DF_QUIET) != 0);
2629 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2632 device_is_enabled(device_t dev)
2634 return ((dev->flags & DF_ENABLED) != 0);
2638 * @brief Return non-zero if the device was successfully probed
2641 device_is_alive(device_t dev)
2643 return (dev->state >= DS_ALIVE);
2647 * @brief Return non-zero if the device currently has a driver
2651 device_is_attached(device_t dev)
2653 return (dev->state >= DS_ATTACHED);
2657 * @brief Set the devclass of a device
2658 * @see devclass_add_device().
2661 device_set_devclass(device_t dev, const char *classname)
2668 devclass_delete_device(dev->devclass, dev);
2672 if (dev->devclass) {
2673 printf("device_set_devclass: device class already set\n");
2677 dc = devclass_find_internal(classname, NULL, TRUE);
2681 error = devclass_add_device(dc, dev);
2683 bus_data_generation_update();
2688 * @brief Set the driver of a device
2691 * @retval EBUSY the device already has a driver attached
2692 * @retval ENOMEM a memory allocation failure occurred
2695 device_set_driver(device_t dev, driver_t *driver)
2697 if (dev->state >= DS_ATTACHED)
2700 if (dev->driver == driver)
2703 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2704 free(dev->softc, M_BUS_SC);
2707 device_set_desc(dev, NULL);
2708 kobj_delete((kobj_t) dev, NULL);
2709 dev->driver = driver;
2711 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2712 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2713 dev->softc = malloc(driver->size, M_BUS_SC,
2716 kobj_delete((kobj_t) dev, NULL);
2717 kobj_init((kobj_t) dev, &null_class);
2723 kobj_init((kobj_t) dev, &null_class);
2726 bus_data_generation_update();
2731 * @brief Probe a device, and return this status.
2733 * This function is the core of the device autoconfiguration
2734 * system. Its purpose is to select a suitable driver for a device and
2735 * then call that driver to initialise the hardware appropriately. The
2736 * driver is selected by calling the DEVICE_PROBE() method of a set of
2737 * candidate drivers and then choosing the driver which returned the
2738 * best value. This driver is then attached to the device using
2741 * The set of suitable drivers is taken from the list of drivers in
2742 * the parent device's devclass. If the device was originally created
2743 * with a specific class name (see device_add_child()), only drivers
2744 * with that name are probed, otherwise all drivers in the devclass
2745 * are probed. If no drivers return successful probe values in the
2746 * parent devclass, the search continues in the parent of that
2747 * devclass (see devclass_get_parent()) if any.
2749 * @param dev the device to initialise
2752 * @retval ENXIO no driver was found
2753 * @retval ENOMEM memory allocation failure
2754 * @retval non-zero some other unix error code
2755 * @retval -1 Device already attached
2758 device_probe(device_t dev)
2764 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2767 if (!(dev->flags & DF_ENABLED)) {
2768 if (bootverbose && device_get_name(dev) != NULL) {
2769 device_print_prettyname(dev);
2770 printf("not probed (disabled)\n");
2774 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2775 if (bus_current_pass == BUS_PASS_DEFAULT &&
2776 !(dev->flags & DF_DONENOMATCH)) {
2777 BUS_PROBE_NOMATCH(dev->parent, dev);
2779 dev->flags |= DF_DONENOMATCH;
2787 * @brief Probe a device and attach a driver if possible
2789 * calls device_probe() and attaches if that was successful.
2792 device_probe_and_attach(device_t dev)
2798 error = device_probe(dev);
2801 else if (error != 0)
2804 CURVNET_SET_QUIET(vnet0);
2805 error = device_attach(dev);
2811 * @brief Attach a device driver to a device
2813 * This function is a wrapper around the DEVICE_ATTACH() driver
2814 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2815 * device's sysctl tree, optionally prints a description of the device
2816 * and queues a notification event for user-based device management
2819 * Normally this function is only called internally from
2820 * device_probe_and_attach().
2822 * @param dev the device to initialise
2825 * @retval ENXIO no driver was found
2826 * @retval ENOMEM memory allocation failure
2827 * @retval non-zero some other unix error code
2830 device_attach(device_t dev)
2832 uint64_t attachtime;
2835 if (resource_disabled(dev->driver->name, dev->unit)) {
2836 device_disable(dev);
2838 device_printf(dev, "disabled via hints entry\n");
2842 device_sysctl_init(dev);
2843 if (!device_is_quiet(dev))
2844 device_print_child(dev->parent, dev);
2845 attachtime = get_cyclecount();
2846 dev->state = DS_ATTACHING;
2847 if ((error = DEVICE_ATTACH(dev)) != 0) {
2848 printf("device_attach: %s%d attach returned %d\n",
2849 dev->driver->name, dev->unit, error);
2850 if (!(dev->flags & DF_FIXEDCLASS))
2851 devclass_delete_device(dev->devclass, dev);
2852 (void)device_set_driver(dev, NULL);
2853 device_sysctl_fini(dev);
2854 KASSERT(dev->busy == 0, ("attach failed but busy"));
2855 dev->state = DS_NOTPRESENT;
2858 attachtime = get_cyclecount() - attachtime;
2860 * 4 bits per device is a reasonable value for desktop and server
2861 * hardware with good get_cyclecount() implementations, but may
2862 * need to be adjusted on other platforms.
2865 printf("%s(): feeding %d bit(s) of entropy from %s%d\n",
2866 __func__, 4, dev->driver->name, dev->unit);
2868 random_harvest(&attachtime, sizeof(attachtime), 4, RANDOM_ATTACH);
2869 device_sysctl_update(dev);
2871 dev->state = DS_BUSY;
2873 dev->state = DS_ATTACHED;
2874 dev->flags &= ~DF_DONENOMATCH;
2880 * @brief Detach a driver from a device
2882 * This function is a wrapper around the DEVICE_DETACH() driver
2883 * method. If the call to DEVICE_DETACH() succeeds, it calls
2884 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2885 * notification event for user-based device management services and
2886 * cleans up the device's sysctl tree.
2888 * @param dev the device to un-initialise
2891 * @retval ENXIO no driver was found
2892 * @retval ENOMEM memory allocation failure
2893 * @retval non-zero some other unix error code
2896 device_detach(device_t dev)
2902 PDEBUG(("%s", DEVICENAME(dev)));
2903 if (dev->state == DS_BUSY)
2905 if (dev->state != DS_ATTACHED)
2908 if ((error = DEVICE_DETACH(dev)) != 0)
2911 if (!device_is_quiet(dev))
2912 device_printf(dev, "detached\n");
2914 BUS_CHILD_DETACHED(dev->parent, dev);
2916 if (!(dev->flags & DF_FIXEDCLASS))
2917 devclass_delete_device(dev->devclass, dev);
2919 dev->state = DS_NOTPRESENT;
2920 (void)device_set_driver(dev, NULL);
2921 device_sysctl_fini(dev);
2927 * @brief Tells a driver to quiesce itself.
2929 * This function is a wrapper around the DEVICE_QUIESCE() driver
2930 * method. If the call to DEVICE_QUIESCE() succeeds.
2932 * @param dev the device to quiesce
2935 * @retval ENXIO no driver was found
2936 * @retval ENOMEM memory allocation failure
2937 * @retval non-zero some other unix error code
2940 device_quiesce(device_t dev)
2943 PDEBUG(("%s", DEVICENAME(dev)));
2944 if (dev->state == DS_BUSY)
2946 if (dev->state != DS_ATTACHED)
2949 return (DEVICE_QUIESCE(dev));
2953 * @brief Notify a device of system shutdown
2955 * This function calls the DEVICE_SHUTDOWN() driver method if the
2956 * device currently has an attached driver.
2958 * @returns the value returned by DEVICE_SHUTDOWN()
2961 device_shutdown(device_t dev)
2963 if (dev->state < DS_ATTACHED)
2965 return (DEVICE_SHUTDOWN(dev));
2969 * @brief Set the unit number of a device
2971 * This function can be used to override the unit number used for a
2972 * device (e.g. to wire a device to a pre-configured unit number).
2975 device_set_unit(device_t dev, int unit)
2980 dc = device_get_devclass(dev);
2981 if (unit < dc->maxunit && dc->devices[unit])
2983 err = devclass_delete_device(dc, dev);
2987 err = devclass_add_device(dc, dev);
2991 bus_data_generation_update();
2995 /*======================================*/
2997 * Some useful method implementations to make life easier for bus drivers.
3001 * @brief Initialise a resource list.
3003 * @param rl the resource list to initialise
3006 resource_list_init(struct resource_list *rl)
3012 * @brief Reclaim memory used by a resource list.
3014 * This function frees the memory for all resource entries on the list
3017 * @param rl the resource list to free
3020 resource_list_free(struct resource_list *rl)
3022 struct resource_list_entry *rle;
3024 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3026 panic("resource_list_free: resource entry is busy");
3027 STAILQ_REMOVE_HEAD(rl, link);
3033 * @brief Add a resource entry.
3035 * This function adds a resource entry using the given @p type, @p
3036 * start, @p end and @p count values. A rid value is chosen by
3037 * searching sequentially for the first unused rid starting at zero.
3039 * @param rl the resource list to edit
3040 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3041 * @param start the start address of the resource
3042 * @param end the end address of the resource
3043 * @param count XXX end-start+1
3046 resource_list_add_next(struct resource_list *rl, int type, u_long start,
3047 u_long end, u_long count)
3052 while (resource_list_find(rl, type, rid) != NULL)
3054 resource_list_add(rl, type, rid, start, end, count);
3059 * @brief Add or modify a resource entry.
3061 * If an existing entry exists with the same type and rid, it will be
3062 * modified using the given values of @p start, @p end and @p
3063 * count. If no entry exists, a new one will be created using the
3064 * given values. The resource list entry that matches is then returned.
3066 * @param rl the resource list to edit
3067 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3068 * @param rid the resource identifier
3069 * @param start the start address of the resource
3070 * @param end the end address of the resource
3071 * @param count XXX end-start+1
3073 struct resource_list_entry *
3074 resource_list_add(struct resource_list *rl, int type, int rid,
3075 u_long start, u_long end, u_long count)
3077 struct resource_list_entry *rle;
3079 rle = resource_list_find(rl, type, rid);
3081 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3084 panic("resource_list_add: can't record entry");
3085 STAILQ_INSERT_TAIL(rl, rle, link);
3093 panic("resource_list_add: resource entry is busy");
3102 * @brief Determine if a resource entry is busy.
3104 * Returns true if a resource entry is busy meaning that it has an
3105 * associated resource that is not an unallocated "reserved" resource.
3107 * @param rl the resource list to search
3108 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3109 * @param rid the resource identifier
3111 * @returns Non-zero if the entry is busy, zero otherwise.
3114 resource_list_busy(struct resource_list *rl, int type, int rid)
3116 struct resource_list_entry *rle;
3118 rle = resource_list_find(rl, type, rid);
3119 if (rle == NULL || rle->res == NULL)
3121 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3122 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3123 ("reserved resource is active"));
3130 * @brief Determine if a resource entry is reserved.
3132 * Returns true if a resource entry is reserved meaning that it has an
3133 * associated "reserved" resource. The resource can either be
3134 * allocated or unallocated.
3136 * @param rl the resource list to search
3137 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3138 * @param rid the resource identifier
3140 * @returns Non-zero if the entry is reserved, zero otherwise.
3143 resource_list_reserved(struct resource_list *rl, int type, int rid)
3145 struct resource_list_entry *rle;
3147 rle = resource_list_find(rl, type, rid);
3148 if (rle != NULL && rle->flags & RLE_RESERVED)
3154 * @brief Find a resource entry by type and rid.
3156 * @param rl the resource list to search
3157 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3158 * @param rid the resource identifier
3160 * @returns the resource entry pointer or NULL if there is no such
3163 struct resource_list_entry *
3164 resource_list_find(struct resource_list *rl, int type, int rid)
3166 struct resource_list_entry *rle;
3168 STAILQ_FOREACH(rle, rl, link) {
3169 if (rle->type == type && rle->rid == rid)
3176 * @brief Delete a resource entry.
3178 * @param rl the resource list to edit
3179 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3180 * @param rid the resource identifier
3183 resource_list_delete(struct resource_list *rl, int type, int rid)
3185 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3188 if (rle->res != NULL)
3189 panic("resource_list_delete: resource has not been released");
3190 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3196 * @brief Allocate a reserved resource
3198 * This can be used by busses to force the allocation of resources
3199 * that are always active in the system even if they are not allocated
3200 * by a driver (e.g. PCI BARs). This function is usually called when
3201 * adding a new child to the bus. The resource is allocated from the
3202 * parent bus when it is reserved. The resource list entry is marked
3203 * with RLE_RESERVED to note that it is a reserved resource.
3205 * Subsequent attempts to allocate the resource with
3206 * resource_list_alloc() will succeed the first time and will set
3207 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3208 * resource that has been allocated is released with
3209 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3210 * the actual resource remains allocated. The resource can be released to
3211 * the parent bus by calling resource_list_unreserve().
3213 * @param rl the resource list to allocate from
3214 * @param bus the parent device of @p child
3215 * @param child the device for which the resource is being reserved
3216 * @param type the type of resource to allocate
3217 * @param rid a pointer to the resource identifier
3218 * @param start hint at the start of the resource range - pass
3219 * @c 0UL for any start address
3220 * @param end hint at the end of the resource range - pass
3221 * @c ~0UL for any end address
3222 * @param count hint at the size of range required - pass @c 1
3224 * @param flags any extra flags to control the resource
3225 * allocation - see @c RF_XXX flags in
3226 * <sys/rman.h> for details
3228 * @returns the resource which was allocated or @c NULL if no
3229 * resource could be allocated
3232 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3233 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
3235 struct resource_list_entry *rle = NULL;
3236 int passthrough = (device_get_parent(child) != bus);
3241 "resource_list_reserve() should only be called for direct children");
3242 if (flags & RF_ACTIVE)
3244 "resource_list_reserve() should only reserve inactive resources");
3246 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3249 rle = resource_list_find(rl, type, *rid);
3250 rle->flags |= RLE_RESERVED;
3256 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3258 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3259 * and passing the allocation up to the parent of @p bus. This assumes
3260 * that the first entry of @c device_get_ivars(child) is a struct
3261 * resource_list. This also handles 'passthrough' allocations where a
3262 * child is a remote descendant of bus by passing the allocation up to
3263 * the parent of bus.
3265 * Typically, a bus driver would store a list of child resources
3266 * somewhere in the child device's ivars (see device_get_ivars()) and
3267 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3268 * then call resource_list_alloc() to perform the allocation.
3270 * @param rl the resource list to allocate from
3271 * @param bus the parent device of @p child
3272 * @param child the device which is requesting an allocation
3273 * @param type the type of resource to allocate
3274 * @param rid a pointer to the resource identifier
3275 * @param start hint at the start of the resource range - pass
3276 * @c 0UL for any start address
3277 * @param end hint at the end of the resource range - pass
3278 * @c ~0UL for any end address
3279 * @param count hint at the size of range required - pass @c 1
3281 * @param flags any extra flags to control the resource
3282 * allocation - see @c RF_XXX flags in
3283 * <sys/rman.h> for details
3285 * @returns the resource which was allocated or @c NULL if no
3286 * resource could be allocated
3289 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3290 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
3292 struct resource_list_entry *rle = NULL;
3293 int passthrough = (device_get_parent(child) != bus);
3294 int isdefault = (start == 0UL && end == ~0UL);
3297 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3298 type, rid, start, end, count, flags));
3301 rle = resource_list_find(rl, type, *rid);
3304 return (NULL); /* no resource of that type/rid */
3307 if (rle->flags & RLE_RESERVED) {
3308 if (rle->flags & RLE_ALLOCATED)
3310 if ((flags & RF_ACTIVE) &&
3311 bus_activate_resource(child, type, *rid,
3314 rle->flags |= RLE_ALLOCATED;
3318 "resource entry %#x type %d for child %s is busy\n", *rid,
3319 type, device_get_nameunit(child));
3325 count = ulmax(count, rle->count);
3326 end = ulmax(rle->end, start + count - 1);
3329 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3330 type, rid, start, end, count, flags);
3333 * Record the new range.
3336 rle->start = rman_get_start(rle->res);
3337 rle->end = rman_get_end(rle->res);
3345 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3347 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3348 * used with resource_list_alloc().
3350 * @param rl the resource list which was allocated from
3351 * @param bus the parent device of @p child
3352 * @param child the device which is requesting a release
3353 * @param type the type of resource to release
3354 * @param rid the resource identifier
3355 * @param res the resource to release
3358 * @retval non-zero a standard unix error code indicating what
3359 * error condition prevented the operation
3362 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3363 int type, int rid, struct resource *res)
3365 struct resource_list_entry *rle = NULL;
3366 int passthrough = (device_get_parent(child) != bus);
3370 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3374 rle = resource_list_find(rl, type, rid);
3377 panic("resource_list_release: can't find resource");
3379 panic("resource_list_release: resource entry is not busy");
3380 if (rle->flags & RLE_RESERVED) {
3381 if (rle->flags & RLE_ALLOCATED) {
3382 if (rman_get_flags(res) & RF_ACTIVE) {
3383 error = bus_deactivate_resource(child, type,
3388 rle->flags &= ~RLE_ALLOCATED;
3394 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3404 * @brief Release all active resources of a given type
3406 * Release all active resources of a specified type. This is intended
3407 * to be used to cleanup resources leaked by a driver after detach or
3410 * @param rl the resource list which was allocated from
3411 * @param bus the parent device of @p child
3412 * @param child the device whose active resources are being released
3413 * @param type the type of resources to release
3416 * @retval EBUSY at least one resource was active
3419 resource_list_release_active(struct resource_list *rl, device_t bus,
3420 device_t child, int type)
3422 struct resource_list_entry *rle;
3426 STAILQ_FOREACH(rle, rl, link) {
3427 if (rle->type != type)
3429 if (rle->res == NULL)
3431 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) ==
3435 error = resource_list_release(rl, bus, child, type,
3436 rman_get_rid(rle->res), rle->res);
3439 "Failed to release active resource: %d\n", error);
3446 * @brief Fully release a reserved resource
3448 * Fully releases a resource reserved via resource_list_reserve().
3450 * @param rl the resource list which was allocated from
3451 * @param bus the parent device of @p child
3452 * @param child the device whose reserved resource is being released
3453 * @param type the type of resource to release
3454 * @param rid the resource identifier
3455 * @param res the resource to release
3458 * @retval non-zero a standard unix error code indicating what
3459 * error condition prevented the operation
3462 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3465 struct resource_list_entry *rle = NULL;
3466 int passthrough = (device_get_parent(child) != bus);
3470 "resource_list_unreserve() should only be called for direct children");
3472 rle = resource_list_find(rl, type, rid);
3475 panic("resource_list_unreserve: can't find resource");
3476 if (!(rle->flags & RLE_RESERVED))
3478 if (rle->flags & RLE_ALLOCATED)
3480 rle->flags &= ~RLE_RESERVED;
3481 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3485 * @brief Print a description of resources in a resource list
3487 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3488 * The name is printed if at least one resource of the given type is available.
3489 * The format is used to print resource start and end.
3491 * @param rl the resource list to print
3492 * @param name the name of @p type, e.g. @c "memory"
3493 * @param type type type of resource entry to print
3494 * @param format printf(9) format string to print resource
3495 * start and end values
3497 * @returns the number of characters printed
3500 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3503 struct resource_list_entry *rle;
3504 int printed, retval;
3508 /* Yes, this is kinda cheating */
3509 STAILQ_FOREACH(rle, rl, link) {
3510 if (rle->type == type) {
3512 retval += printf(" %s ", name);
3514 retval += printf(",");
3516 retval += printf(format, rle->start);
3517 if (rle->count > 1) {
3518 retval += printf("-");
3519 retval += printf(format, rle->start +
3528 * @brief Releases all the resources in a list.
3530 * @param rl The resource list to purge.
3535 resource_list_purge(struct resource_list *rl)
3537 struct resource_list_entry *rle;
3539 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3541 bus_release_resource(rman_get_device(rle->res),
3542 rle->type, rle->rid, rle->res);
3543 STAILQ_REMOVE_HEAD(rl, link);
3549 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3552 return (device_add_child_ordered(dev, order, name, unit));
3556 * @brief Helper function for implementing DEVICE_PROBE()
3558 * This function can be used to help implement the DEVICE_PROBE() for
3559 * a bus (i.e. a device which has other devices attached to it). It
3560 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3564 bus_generic_probe(device_t dev)
3566 devclass_t dc = dev->devclass;
3569 TAILQ_FOREACH(dl, &dc->drivers, link) {
3571 * If this driver's pass is too high, then ignore it.
3572 * For most drivers in the default pass, this will
3573 * never be true. For early-pass drivers they will
3574 * only call the identify routines of eligible drivers
3575 * when this routine is called. Drivers for later
3576 * passes should have their identify routines called
3577 * on early-pass busses during BUS_NEW_PASS().
3579 if (dl->pass > bus_current_pass)
3581 DEVICE_IDENTIFY(dl->driver, dev);
3588 * @brief Helper function for implementing DEVICE_ATTACH()
3590 * This function can be used to help implement the DEVICE_ATTACH() for
3591 * a bus. It calls device_probe_and_attach() for each of the device's
3595 bus_generic_attach(device_t dev)
3599 TAILQ_FOREACH(child, &dev->children, link) {
3600 device_probe_and_attach(child);
3607 * @brief Helper function for implementing DEVICE_DETACH()
3609 * This function can be used to help implement the DEVICE_DETACH() for
3610 * a bus. It calls device_detach() for each of the device's
3614 bus_generic_detach(device_t dev)
3619 if (dev->state != DS_ATTACHED)
3622 TAILQ_FOREACH(child, &dev->children, link) {
3623 if ((error = device_detach(child)) != 0)
3631 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3633 * This function can be used to help implement the DEVICE_SHUTDOWN()
3634 * for a bus. It calls device_shutdown() for each of the device's
3638 bus_generic_shutdown(device_t dev)
3642 TAILQ_FOREACH(child, &dev->children, link) {
3643 device_shutdown(child);
3650 * @brief Helper function for implementing DEVICE_SUSPEND()
3652 * This function can be used to help implement the DEVICE_SUSPEND()
3653 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3654 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3655 * operation is aborted and any devices which were suspended are
3656 * resumed immediately by calling their DEVICE_RESUME() methods.
3659 bus_generic_suspend(device_t dev)
3662 device_t child, child2;
3664 TAILQ_FOREACH(child, &dev->children, link) {
3665 error = DEVICE_SUSPEND(child);
3667 for (child2 = TAILQ_FIRST(&dev->children);
3668 child2 && child2 != child;
3669 child2 = TAILQ_NEXT(child2, link))
3670 DEVICE_RESUME(child2);
3678 * @brief Helper function for implementing DEVICE_RESUME()
3680 * This function can be used to help implement the DEVICE_RESUME() for
3681 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3684 bus_generic_resume(device_t dev)
3688 TAILQ_FOREACH(child, &dev->children, link) {
3689 DEVICE_RESUME(child);
3690 /* if resume fails, there's nothing we can usefully do... */
3696 * @brief Helper function for implementing BUS_PRINT_CHILD().
3698 * This function prints the first part of the ascii representation of
3699 * @p child, including its name, unit and description (if any - see
3700 * device_set_desc()).
3702 * @returns the number of characters printed
3705 bus_print_child_header(device_t dev, device_t child)
3709 if (device_get_desc(child)) {
3710 retval += device_printf(child, "<%s>", device_get_desc(child));
3712 retval += printf("%s", device_get_nameunit(child));
3719 * @brief Helper function for implementing BUS_PRINT_CHILD().
3721 * This function prints the last part of the ascii representation of
3722 * @p child, which consists of the string @c " on " followed by the
3723 * name and unit of the @p dev.
3725 * @returns the number of characters printed
3728 bus_print_child_footer(device_t dev, device_t child)
3730 return (printf(" on %s\n", device_get_nameunit(dev)));
3734 * @brief Helper function for implementing BUS_PRINT_CHILD().
3736 * This function prints out the VM domain for the given device.
3738 * @returns the number of characters printed
3741 bus_print_child_domain(device_t dev, device_t child)
3745 /* No domain? Don't print anything */
3746 if (BUS_GET_DOMAIN(dev, child, &domain) != 0)
3749 return (printf(" numa-domain %d", domain));
3753 * @brief Helper function for implementing BUS_PRINT_CHILD().
3755 * This function simply calls bus_print_child_header() followed by
3756 * bus_print_child_footer().
3758 * @returns the number of characters printed
3761 bus_generic_print_child(device_t dev, device_t child)
3765 retval += bus_print_child_header(dev, child);
3766 retval += bus_print_child_domain(dev, child);
3767 retval += bus_print_child_footer(dev, child);
3773 * @brief Stub function for implementing BUS_READ_IVAR().
3778 bus_generic_read_ivar(device_t dev, device_t child, int index,
3785 * @brief Stub function for implementing BUS_WRITE_IVAR().
3790 bus_generic_write_ivar(device_t dev, device_t child, int index,
3797 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3801 struct resource_list *
3802 bus_generic_get_resource_list(device_t dev, device_t child)
3808 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3810 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3811 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3812 * and then calls device_probe_and_attach() for each unattached child.
3815 bus_generic_driver_added(device_t dev, driver_t *driver)
3819 DEVICE_IDENTIFY(driver, dev);
3820 TAILQ_FOREACH(child, &dev->children, link) {
3821 if (child->state == DS_NOTPRESENT ||
3822 (child->flags & DF_REBID))
3823 device_probe_and_attach(child);
3828 * @brief Helper function for implementing BUS_NEW_PASS().
3830 * This implementing of BUS_NEW_PASS() first calls the identify
3831 * routines for any drivers that probe at the current pass. Then it
3832 * walks the list of devices for this bus. If a device is already
3833 * attached, then it calls BUS_NEW_PASS() on that device. If the
3834 * device is not already attached, it attempts to attach a driver to
3838 bus_generic_new_pass(device_t dev)
3845 TAILQ_FOREACH(dl, &dc->drivers, link) {
3846 if (dl->pass == bus_current_pass)
3847 DEVICE_IDENTIFY(dl->driver, dev);
3849 TAILQ_FOREACH(child, &dev->children, link) {
3850 if (child->state >= DS_ATTACHED)
3851 BUS_NEW_PASS(child);
3852 else if (child->state == DS_NOTPRESENT)
3853 device_probe_and_attach(child);
3858 * @brief Helper function for implementing BUS_SETUP_INTR().
3860 * This simple implementation of BUS_SETUP_INTR() simply calls the
3861 * BUS_SETUP_INTR() method of the parent of @p dev.
3864 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3865 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3868 /* Propagate up the bus hierarchy until someone handles it. */
3870 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3871 filter, intr, arg, cookiep));
3876 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3878 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3879 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3882 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3885 /* Propagate up the bus hierarchy until someone handles it. */
3887 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
3892 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
3894 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
3895 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
3898 bus_generic_adjust_resource(device_t dev, device_t child, int type,
3899 struct resource *r, u_long start, u_long end)
3901 /* Propagate up the bus hierarchy until someone handles it. */
3903 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
3909 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
3911 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
3912 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
3915 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
3916 u_long start, u_long end, u_long count, u_int flags)
3918 /* Propagate up the bus hierarchy until someone handles it. */
3920 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
3921 start, end, count, flags));
3926 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
3928 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
3929 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
3932 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
3935 /* Propagate up the bus hierarchy until someone handles it. */
3937 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
3943 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
3945 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
3946 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
3949 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
3952 /* Propagate up the bus hierarchy until someone handles it. */
3954 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
3960 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
3962 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
3963 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
3966 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
3967 int rid, struct resource *r)
3969 /* Propagate up the bus hierarchy until someone handles it. */
3971 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
3977 * @brief Helper function for implementing BUS_BIND_INTR().
3979 * This simple implementation of BUS_BIND_INTR() simply calls the
3980 * BUS_BIND_INTR() method of the parent of @p dev.
3983 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
3987 /* Propagate up the bus hierarchy until someone handles it. */
3989 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
3994 * @brief Helper function for implementing BUS_CONFIG_INTR().
3996 * This simple implementation of BUS_CONFIG_INTR() simply calls the
3997 * BUS_CONFIG_INTR() method of the parent of @p dev.
4000 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
4001 enum intr_polarity pol)
4004 /* Propagate up the bus hierarchy until someone handles it. */
4006 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
4011 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
4013 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
4014 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
4017 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
4018 void *cookie, const char *descr)
4021 /* Propagate up the bus hierarchy until someone handles it. */
4023 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
4029 * @brief Helper function for implementing BUS_GET_DMA_TAG().
4031 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
4032 * BUS_GET_DMA_TAG() method of the parent of @p dev.
4035 bus_generic_get_dma_tag(device_t dev, device_t child)
4038 /* Propagate up the bus hierarchy until someone handles it. */
4039 if (dev->parent != NULL)
4040 return (BUS_GET_DMA_TAG(dev->parent, child));
4045 * @brief Helper function for implementing BUS_GET_RESOURCE().
4047 * This implementation of BUS_GET_RESOURCE() uses the
4048 * resource_list_find() function to do most of the work. It calls
4049 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4053 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
4054 u_long *startp, u_long *countp)
4056 struct resource_list * rl = NULL;
4057 struct resource_list_entry * rle = NULL;
4059 rl = BUS_GET_RESOURCE_LIST(dev, child);
4063 rle = resource_list_find(rl, type, rid);
4068 *startp = rle->start;
4070 *countp = rle->count;
4076 * @brief Helper function for implementing BUS_SET_RESOURCE().
4078 * This implementation of BUS_SET_RESOURCE() uses the
4079 * resource_list_add() function to do most of the work. It calls
4080 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4084 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
4085 u_long start, u_long count)
4087 struct resource_list * rl = NULL;
4089 rl = BUS_GET_RESOURCE_LIST(dev, child);
4093 resource_list_add(rl, type, rid, start, (start + count - 1), count);
4099 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
4101 * This implementation of BUS_DELETE_RESOURCE() uses the
4102 * resource_list_delete() function to do most of the work. It calls
4103 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
4107 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
4109 struct resource_list * rl = NULL;
4111 rl = BUS_GET_RESOURCE_LIST(dev, child);
4115 resource_list_delete(rl, type, rid);
4121 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
4123 * This implementation of BUS_RELEASE_RESOURCE() uses the
4124 * resource_list_release() function to do most of the work. It calls
4125 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4128 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
4129 int rid, struct resource *r)
4131 struct resource_list * rl = NULL;
4133 if (device_get_parent(child) != dev)
4134 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
4137 rl = BUS_GET_RESOURCE_LIST(dev, child);
4141 return (resource_list_release(rl, dev, child, type, rid, r));
4145 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4147 * This implementation of BUS_ALLOC_RESOURCE() uses the
4148 * resource_list_alloc() function to do most of the work. It calls
4149 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4152 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4153 int *rid, u_long start, u_long end, u_long count, u_int flags)
4155 struct resource_list * rl = NULL;
4157 if (device_get_parent(child) != dev)
4158 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4159 type, rid, start, end, count, flags));
4161 rl = BUS_GET_RESOURCE_LIST(dev, child);
4165 return (resource_list_alloc(rl, dev, child, type, rid,
4166 start, end, count, flags));
4170 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4172 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4173 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4176 bus_generic_child_present(device_t dev, device_t child)
4178 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4182 bus_generic_get_domain(device_t dev, device_t child, int *domain)
4186 return (BUS_GET_DOMAIN(dev->parent, dev, domain));
4192 * Some convenience functions to make it easier for drivers to use the
4193 * resource-management functions. All these really do is hide the
4194 * indirection through the parent's method table, making for slightly
4195 * less-wordy code. In the future, it might make sense for this code
4196 * to maintain some sort of a list of resources allocated by each device.
4200 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4201 struct resource **res)
4205 for (i = 0; rs[i].type != -1; i++)
4207 for (i = 0; rs[i].type != -1; i++) {
4208 res[i] = bus_alloc_resource_any(dev,
4209 rs[i].type, &rs[i].rid, rs[i].flags);
4210 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4211 bus_release_resources(dev, rs, res);
4219 bus_release_resources(device_t dev, const struct resource_spec *rs,
4220 struct resource **res)
4224 for (i = 0; rs[i].type != -1; i++)
4225 if (res[i] != NULL) {
4226 bus_release_resource(
4227 dev, rs[i].type, rs[i].rid, res[i]);
4233 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4235 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4239 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
4240 u_long count, u_int flags)
4242 if (dev->parent == NULL)
4244 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4249 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4251 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4255 bus_adjust_resource(device_t dev, int type, struct resource *r, u_long start,
4258 if (dev->parent == NULL)
4260 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4264 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4266 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4270 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4272 if (dev->parent == NULL)
4274 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4278 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4280 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4284 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4286 if (dev->parent == NULL)
4288 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4292 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4294 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4298 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4300 if (dev->parent == NULL)
4302 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
4306 * @brief Wrapper function for BUS_SETUP_INTR().
4308 * This function simply calls the BUS_SETUP_INTR() method of the
4312 bus_setup_intr(device_t dev, struct resource *r, int flags,
4313 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4317 if (dev->parent == NULL)
4319 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4323 if (handler != NULL && !(flags & INTR_MPSAFE))
4324 device_printf(dev, "[GIANT-LOCKED]\n");
4329 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4331 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4335 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4337 if (dev->parent == NULL)
4339 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4343 * @brief Wrapper function for BUS_BIND_INTR().
4345 * This function simply calls the BUS_BIND_INTR() method of the
4349 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4351 if (dev->parent == NULL)
4353 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4357 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4359 * This function first formats the requested description into a
4360 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4361 * the parent of @p dev.
4364 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4365 const char *fmt, ...)
4368 char descr[MAXCOMLEN + 1];
4370 if (dev->parent == NULL)
4373 vsnprintf(descr, sizeof(descr), fmt, ap);
4375 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4379 * @brief Wrapper function for BUS_SET_RESOURCE().
4381 * This function simply calls the BUS_SET_RESOURCE() method of the
4385 bus_set_resource(device_t dev, int type, int rid,
4386 u_long start, u_long count)
4388 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4393 * @brief Wrapper function for BUS_GET_RESOURCE().
4395 * This function simply calls the BUS_GET_RESOURCE() method of the
4399 bus_get_resource(device_t dev, int type, int rid,
4400 u_long *startp, u_long *countp)
4402 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4407 * @brief Wrapper function for BUS_GET_RESOURCE().
4409 * This function simply calls the BUS_GET_RESOURCE() method of the
4410 * parent of @p dev and returns the start value.
4413 bus_get_resource_start(device_t dev, int type, int rid)
4415 u_long start, count;
4418 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4426 * @brief Wrapper function for BUS_GET_RESOURCE().
4428 * This function simply calls the BUS_GET_RESOURCE() method of the
4429 * parent of @p dev and returns the count value.
4432 bus_get_resource_count(device_t dev, int type, int rid)
4434 u_long start, count;
4437 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4445 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4447 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4451 bus_delete_resource(device_t dev, int type, int rid)
4453 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4457 * @brief Wrapper function for BUS_CHILD_PRESENT().
4459 * This function simply calls the BUS_CHILD_PRESENT() method of the
4463 bus_child_present(device_t child)
4465 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4469 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4471 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4475 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4479 parent = device_get_parent(child);
4480 if (parent == NULL) {
4484 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4488 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4490 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4494 bus_child_location_str(device_t child, char *buf, size_t buflen)
4498 parent = device_get_parent(child);
4499 if (parent == NULL) {
4503 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4507 * @brief Wrapper function for BUS_GET_DMA_TAG().
4509 * This function simply calls the BUS_GET_DMA_TAG() method of the
4513 bus_get_dma_tag(device_t dev)
4517 parent = device_get_parent(dev);
4520 return (BUS_GET_DMA_TAG(parent, dev));
4524 * @brief Wrapper function for BUS_GET_DOMAIN().
4526 * This function simply calls the BUS_GET_DOMAIN() method of the
4530 bus_get_domain(device_t dev, int *domain)
4532 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain));
4535 /* Resume all devices and then notify userland that we're up again. */
4537 root_resume(device_t dev)
4541 error = bus_generic_resume(dev);
4543 devctl_notify("kern", "power", "resume", NULL);
4548 root_print_child(device_t dev, device_t child)
4552 retval += bus_print_child_header(dev, child);
4553 retval += printf("\n");
4559 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4560 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4563 * If an interrupt mapping gets to here something bad has happened.
4565 panic("root_setup_intr");
4569 * If we get here, assume that the device is permanent and really is
4570 * present in the system. Removable bus drivers are expected to intercept
4571 * this call long before it gets here. We return -1 so that drivers that
4572 * really care can check vs -1 or some ERRNO returned higher in the food
4576 root_child_present(device_t dev, device_t child)
4581 static kobj_method_t root_methods[] = {
4582 /* Device interface */
4583 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4584 KOBJMETHOD(device_suspend, bus_generic_suspend),
4585 KOBJMETHOD(device_resume, root_resume),
4588 KOBJMETHOD(bus_print_child, root_print_child),
4589 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4590 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4591 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4592 KOBJMETHOD(bus_child_present, root_child_present),
4597 static driver_t root_driver = {
4604 devclass_t root_devclass;
4607 root_bus_module_handler(module_t mod, int what, void* arg)
4611 TAILQ_INIT(&bus_data_devices);
4612 kobj_class_compile((kobj_class_t) &root_driver);
4613 root_bus = make_device(NULL, "root", 0);
4614 root_bus->desc = "System root bus";
4615 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4616 root_bus->driver = &root_driver;
4617 root_bus->state = DS_ATTACHED;
4618 root_devclass = devclass_find_internal("root", NULL, FALSE);
4623 device_shutdown(root_bus);
4626 return (EOPNOTSUPP);
4632 static moduledata_t root_bus_mod = {
4634 root_bus_module_handler,
4637 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4640 * @brief Automatically configure devices
4642 * This function begins the autoconfiguration process by calling
4643 * device_probe_and_attach() for each child of the @c root0 device.
4646 root_bus_configure(void)
4651 /* Eventually this will be split up, but this is sufficient for now. */
4652 bus_set_pass(BUS_PASS_DEFAULT);
4656 * @brief Module handler for registering device drivers
4658 * This module handler is used to automatically register device
4659 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4660 * devclass_add_driver() for the driver described by the
4661 * driver_module_data structure pointed to by @p arg
4664 driver_module_handler(module_t mod, int what, void *arg)
4666 struct driver_module_data *dmd;
4667 devclass_t bus_devclass;
4668 kobj_class_t driver;
4671 dmd = (struct driver_module_data *)arg;
4672 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4677 if (dmd->dmd_chainevh)
4678 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4680 pass = dmd->dmd_pass;
4681 driver = dmd->dmd_driver;
4682 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4683 DRIVERNAME(driver), dmd->dmd_busname, pass));
4684 error = devclass_add_driver(bus_devclass, driver, pass,
4689 PDEBUG(("Unloading module: driver %s from bus %s",
4690 DRIVERNAME(dmd->dmd_driver),
4692 error = devclass_delete_driver(bus_devclass,
4695 if (!error && dmd->dmd_chainevh)
4696 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4699 PDEBUG(("Quiesce module: driver %s from bus %s",
4700 DRIVERNAME(dmd->dmd_driver),
4702 error = devclass_quiesce_driver(bus_devclass,
4705 if (!error && dmd->dmd_chainevh)
4706 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4717 * @brief Enumerate all hinted devices for this bus.
4719 * Walks through the hints for this bus and calls the bus_hinted_child
4720 * routine for each one it fines. It searches first for the specific
4721 * bus that's being probed for hinted children (eg isa0), and then for
4722 * generic children (eg isa).
4724 * @param dev bus device to enumerate
4727 bus_enumerate_hinted_children(device_t bus)
4730 const char *dname, *busname;
4734 * enumerate all devices on the specific bus
4736 busname = device_get_nameunit(bus);
4738 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4739 BUS_HINTED_CHILD(bus, dname, dunit);
4742 * and all the generic ones.
4744 busname = device_get_name(bus);
4746 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4747 BUS_HINTED_CHILD(bus, dname, dunit);
4752 /* the _short versions avoid iteration by not calling anything that prints
4753 * more than oneliners. I love oneliners.
4757 print_device_short(device_t dev, int indent)
4762 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
4763 dev->unit, dev->desc,
4764 (dev->parent? "":"no "),
4765 (TAILQ_EMPTY(&dev->children)? "no ":""),
4766 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
4767 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
4768 (dev->flags&DF_WILDCARD? "wildcard,":""),
4769 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
4770 (dev->flags&DF_REBID? "rebiddable,":""),
4771 (dev->ivars? "":"no "),
4772 (dev->softc? "":"no "),
4777 print_device(device_t dev, int indent)
4782 print_device_short(dev, indent);
4784 indentprintf(("Parent:\n"));
4785 print_device_short(dev->parent, indent+1);
4786 indentprintf(("Driver:\n"));
4787 print_driver_short(dev->driver, indent+1);
4788 indentprintf(("Devclass:\n"));
4789 print_devclass_short(dev->devclass, indent+1);
4793 print_device_tree_short(device_t dev, int indent)
4794 /* print the device and all its children (indented) */
4801 print_device_short(dev, indent);
4803 TAILQ_FOREACH(child, &dev->children, link) {
4804 print_device_tree_short(child, indent+1);
4809 print_device_tree(device_t dev, int indent)
4810 /* print the device and all its children (indented) */
4817 print_device(dev, indent);
4819 TAILQ_FOREACH(child, &dev->children, link) {
4820 print_device_tree(child, indent+1);
4825 print_driver_short(driver_t *driver, int indent)
4830 indentprintf(("driver %s: softc size = %zd\n",
4831 driver->name, driver->size));
4835 print_driver(driver_t *driver, int indent)
4840 print_driver_short(driver, indent);
4844 print_driver_list(driver_list_t drivers, int indent)
4846 driverlink_t driver;
4848 TAILQ_FOREACH(driver, &drivers, link) {
4849 print_driver(driver->driver, indent);
4854 print_devclass_short(devclass_t dc, int indent)
4859 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
4863 print_devclass(devclass_t dc, int indent)
4870 print_devclass_short(dc, indent);
4871 indentprintf(("Drivers:\n"));
4872 print_driver_list(dc->drivers, indent+1);
4874 indentprintf(("Devices:\n"));
4875 for (i = 0; i < dc->maxunit; i++)
4877 print_device(dc->devices[i], indent+1);
4881 print_devclass_list_short(void)
4885 printf("Short listing of devclasses, drivers & devices:\n");
4886 TAILQ_FOREACH(dc, &devclasses, link) {
4887 print_devclass_short(dc, 0);
4892 print_devclass_list(void)
4896 printf("Full listing of devclasses, drivers & devices:\n");
4897 TAILQ_FOREACH(dc, &devclasses, link) {
4898 print_devclass(dc, 0);
4905 * User-space access to the device tree.
4907 * We implement a small set of nodes:
4909 * hw.bus Single integer read method to obtain the
4910 * current generation count.
4911 * hw.bus.devices Reads the entire device tree in flat space.
4912 * hw.bus.rman Resource manager interface
4914 * We might like to add the ability to scan devclasses and/or drivers to
4915 * determine what else is currently loaded/available.
4919 sysctl_bus(SYSCTL_HANDLER_ARGS)
4921 struct u_businfo ubus;
4923 ubus.ub_version = BUS_USER_VERSION;
4924 ubus.ub_generation = bus_data_generation;
4926 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
4928 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
4929 "bus-related data");
4932 sysctl_devices(SYSCTL_HANDLER_ARGS)
4934 int *name = (int *)arg1;
4935 u_int namelen = arg2;
4938 struct u_device udev; /* XXX this is a bit big */
4944 if (bus_data_generation_check(name[0]))
4950 * Scan the list of devices, looking for the requested index.
4952 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
4960 * Populate the return array.
4962 bzero(&udev, sizeof(udev));
4963 udev.dv_handle = (uintptr_t)dev;
4964 udev.dv_parent = (uintptr_t)dev->parent;
4965 if (dev->nameunit != NULL)
4966 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
4967 if (dev->desc != NULL)
4968 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
4969 if (dev->driver != NULL && dev->driver->name != NULL)
4970 strlcpy(udev.dv_drivername, dev->driver->name,
4971 sizeof(udev.dv_drivername));
4972 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
4973 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
4974 udev.dv_devflags = dev->devflags;
4975 udev.dv_flags = dev->flags;
4976 udev.dv_state = dev->state;
4977 error = SYSCTL_OUT(req, &udev, sizeof(udev));
4981 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
4982 "system device tree");
4985 bus_data_generation_check(int generation)
4987 if (generation != bus_data_generation)
4990 /* XXX generate optimised lists here? */
4995 bus_data_generation_update(void)
4997 bus_data_generation++;
5001 bus_free_resource(device_t dev, int type, struct resource *r)
5005 return (bus_release_resource(dev, type, rman_get_rid(r), r));
5009 device_lookup_by_name(const char *name)
5013 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
5014 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0)
5021 * /dev/devctl2 implementation. The existing /dev/devctl device has
5022 * implicit semantics on open, so it could not be reused for this.
5023 * Another option would be to call this /dev/bus?
5026 find_device(struct devreq *req, device_t *devp)
5031 * First, ensure that the name is nul terminated.
5033 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL)
5037 * Second, try to find an attached device whose name matches
5040 dev = device_lookup_by_name(req->dr_name);
5046 /* Finally, give device enumerators a chance. */
5048 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev);
5056 driver_exists(struct device *bus, const char *driver)
5060 for (dc = bus->devclass; dc != NULL; dc = dc->parent) {
5061 if (devclass_find_driver_internal(dc, driver) != NULL)
5068 devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
5075 /* Locate the device to control. */
5077 req = (struct devreq *)data;
5083 case DEV_SET_DRIVER:
5084 case DEV_CLEAR_DRIVER:
5085 error = priv_check(td, PRIV_DRIVER);
5087 error = find_device(req, &dev);
5098 /* Perform the requested operation. */
5101 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0)
5103 else if (!device_is_enabled(dev))
5106 error = device_probe_and_attach(dev);
5109 if (!device_is_attached(dev)) {
5113 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5114 error = device_quiesce(dev);
5118 error = device_detach(dev);
5121 if (device_is_enabled(dev)) {
5127 * If the device has been probed but not attached (e.g.
5128 * when it has been disabled by a loader hint), just
5129 * attach the device rather than doing a full probe.
5132 if (device_is_alive(dev)) {
5134 * If the device was disabled via a hint, clear
5137 if (resource_disabled(dev->driver->name, dev->unit))
5138 resource_unset_value(dev->driver->name,
5139 dev->unit, "disabled");
5140 error = device_attach(dev);
5142 error = device_probe_and_attach(dev);
5145 if (!device_is_enabled(dev)) {
5150 if (!(req->dr_flags & DEVF_FORCE_DETACH)) {
5151 error = device_quiesce(dev);
5157 * Force DF_FIXEDCLASS on around detach to preserve
5158 * the existing name.
5161 dev->flags |= DF_FIXEDCLASS;
5162 error = device_detach(dev);
5163 if (!(old & DF_FIXEDCLASS))
5164 dev->flags &= ~DF_FIXEDCLASS;
5166 device_disable(dev);
5168 case DEV_SET_DRIVER: {
5172 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL);
5175 if (driver[0] == '\0') {
5179 if (dev->devclass != NULL &&
5180 strcmp(driver, dev->devclass->name) == 0)
5181 /* XXX: Could possibly force DF_FIXEDCLASS on? */
5185 * Scan drivers for this device's bus looking for at
5186 * least one matching driver.
5188 if (dev->parent == NULL) {
5192 if (!driver_exists(dev->parent, driver)) {
5196 dc = devclass_create(driver);
5202 /* Detach device if necessary. */
5203 if (device_is_attached(dev)) {
5204 if (req->dr_flags & DEVF_SET_DRIVER_DETACH)
5205 error = device_detach(dev);
5212 /* Clear any previously-fixed device class and unit. */
5213 if (dev->flags & DF_FIXEDCLASS)
5214 devclass_delete_device(dev->devclass, dev);
5215 dev->flags |= DF_WILDCARD;
5218 /* Force the new device class. */
5219 error = devclass_add_device(dc, dev);
5222 dev->flags |= DF_FIXEDCLASS;
5223 error = device_probe_and_attach(dev);
5226 case DEV_CLEAR_DRIVER:
5227 if (!(dev->flags & DF_FIXEDCLASS)) {
5231 if (device_is_attached(dev)) {
5232 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH)
5233 error = device_detach(dev);
5240 dev->flags &= ~DF_FIXEDCLASS;
5241 dev->flags |= DF_WILDCARD;
5242 devclass_delete_device(dev->devclass, dev);
5243 error = device_probe_and_attach(dev);
5250 static struct cdevsw devctl2_cdevsw = {
5251 .d_version = D_VERSION,
5252 .d_ioctl = devctl2_ioctl,
5253 .d_name = "devctl2",
5260 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL,
5261 UID_ROOT, GID_WHEEL, 0600, "devctl2");