2 * Copyright (c) 1997,1998,2003 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/filio.h>
36 #include <sys/kernel.h>
38 #include <sys/limits.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
44 #include <sys/condvar.h>
45 #include <sys/queue.h>
46 #include <machine/bus.h>
48 #include <sys/selinfo.h>
49 #include <sys/signalvar.h>
50 #include <sys/sysctl.h>
51 #include <sys/systm.h>
54 #include <sys/interrupt.h>
56 #include <machine/stdarg.h>
60 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
61 SYSCTL_NODE(, OID_AUTO, dev, CTLFLAG_RW, NULL, NULL);
64 * Used to attach drivers to devclasses.
66 typedef struct driverlink *driverlink_t;
69 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
71 TAILQ_ENTRY(driverlink) passlink;
75 * Forward declarations
77 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
78 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
79 typedef TAILQ_HEAD(device_list, device) device_list_t;
82 TAILQ_ENTRY(devclass) link;
83 devclass_t parent; /* parent in devclass hierarchy */
84 driver_list_t drivers; /* bus devclasses store drivers for bus */
86 device_t *devices; /* array of devices indexed by unit */
87 int maxunit; /* size of devices array */
89 #define DC_HAS_CHILDREN 1
91 struct sysctl_ctx_list sysctl_ctx;
92 struct sysctl_oid *sysctl_tree;
96 * @brief Implementation of device.
100 * A device is a kernel object. The first field must be the
101 * current ops table for the object.
108 TAILQ_ENTRY(device) link; /**< list of devices in parent */
109 TAILQ_ENTRY(device) devlink; /**< global device list membership */
110 device_t parent; /**< parent of this device */
111 device_list_t children; /**< list of child devices */
114 * Details of this device.
116 driver_t *driver; /**< current driver */
117 devclass_t devclass; /**< current device class */
118 int unit; /**< current unit number */
119 char* nameunit; /**< name+unit e.g. foodev0 */
120 char* desc; /**< driver specific description */
121 int busy; /**< count of calls to device_busy() */
122 device_state_t state; /**< current device state */
123 uint32_t devflags; /**< api level flags for device_get_flags() */
124 u_int flags; /**< internal device flags */
125 #define DF_ENABLED 0x01 /* device should be probed/attached */
126 #define DF_FIXEDCLASS 0x02 /* devclass specified at create time */
127 #define DF_WILDCARD 0x04 /* unit was originally wildcard */
128 #define DF_DESCMALLOCED 0x08 /* description was malloced */
129 #define DF_QUIET 0x10 /* don't print verbose attach message */
130 #define DF_DONENOMATCH 0x20 /* don't execute DEVICE_NOMATCH again */
131 #define DF_EXTERNALSOFTC 0x40 /* softc not allocated by us */
132 #define DF_REBID 0x80 /* Can rebid after attach */
133 u_int order; /**< order from device_add_child_ordered() */
134 void *ivars; /**< instance variables */
135 void *softc; /**< current driver's variables */
137 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
138 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
141 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
142 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
146 static int bus_debug = 1;
147 TUNABLE_INT("bus.debug", &bus_debug);
148 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RW, &bus_debug, 0,
151 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
152 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
153 #define DRIVERNAME(d) ((d)? d->name : "no driver")
154 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
157 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
158 * prevent syslog from deleting initial spaces
160 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
162 static void print_device_short(device_t dev, int indent);
163 static void print_device(device_t dev, int indent);
164 void print_device_tree_short(device_t dev, int indent);
165 void print_device_tree(device_t dev, int indent);
166 static void print_driver_short(driver_t *driver, int indent);
167 static void print_driver(driver_t *driver, int indent);
168 static void print_driver_list(driver_list_t drivers, int indent);
169 static void print_devclass_short(devclass_t dc, int indent);
170 static void print_devclass(devclass_t dc, int indent);
171 void print_devclass_list_short(void);
172 void print_devclass_list(void);
175 /* Make the compiler ignore the function calls */
176 #define PDEBUG(a) /* nop */
177 #define DEVICENAME(d) /* nop */
178 #define DRIVERNAME(d) /* nop */
179 #define DEVCLANAME(d) /* nop */
181 #define print_device_short(d,i) /* nop */
182 #define print_device(d,i) /* nop */
183 #define print_device_tree_short(d,i) /* nop */
184 #define print_device_tree(d,i) /* nop */
185 #define print_driver_short(d,i) /* nop */
186 #define print_driver(d,i) /* nop */
187 #define print_driver_list(d,i) /* nop */
188 #define print_devclass_short(d,i) /* nop */
189 #define print_devclass(d,i) /* nop */
190 #define print_devclass_list_short() /* nop */
191 #define print_devclass_list() /* nop */
199 DEVCLASS_SYSCTL_PARENT,
203 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
205 devclass_t dc = (devclass_t)arg1;
209 case DEVCLASS_SYSCTL_PARENT:
210 value = dc->parent ? dc->parent->name : "";
215 return (SYSCTL_OUT(req, value, strlen(value)));
219 devclass_sysctl_init(devclass_t dc)
222 if (dc->sysctl_tree != NULL)
224 sysctl_ctx_init(&dc->sysctl_ctx);
225 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
226 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
227 CTLFLAG_RD, NULL, "");
228 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
229 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
230 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
236 DEVICE_SYSCTL_DRIVER,
237 DEVICE_SYSCTL_LOCATION,
238 DEVICE_SYSCTL_PNPINFO,
239 DEVICE_SYSCTL_PARENT,
243 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
245 device_t dev = (device_t)arg1;
252 case DEVICE_SYSCTL_DESC:
253 value = dev->desc ? dev->desc : "";
255 case DEVICE_SYSCTL_DRIVER:
256 value = dev->driver ? dev->driver->name : "";
258 case DEVICE_SYSCTL_LOCATION:
259 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
260 bus_child_location_str(dev, buf, 1024);
262 case DEVICE_SYSCTL_PNPINFO:
263 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
264 bus_child_pnpinfo_str(dev, buf, 1024);
266 case DEVICE_SYSCTL_PARENT:
267 value = dev->parent ? dev->parent->nameunit : "";
272 error = SYSCTL_OUT(req, value, strlen(value));
279 device_sysctl_init(device_t dev)
281 devclass_t dc = dev->devclass;
283 if (dev->sysctl_tree != NULL)
285 devclass_sysctl_init(dc);
286 sysctl_ctx_init(&dev->sysctl_ctx);
287 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx,
288 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
289 dev->nameunit + strlen(dc->name),
290 CTLFLAG_RD, NULL, "");
291 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
292 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD,
293 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
294 "device description");
295 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
296 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD,
297 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
298 "device driver name");
299 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
300 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD,
301 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
302 "device location relative to parent");
303 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
304 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD,
305 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
306 "device identification");
307 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
308 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD,
309 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
314 device_sysctl_update(device_t dev)
316 devclass_t dc = dev->devclass;
318 if (dev->sysctl_tree == NULL)
320 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
324 device_sysctl_fini(device_t dev)
326 if (dev->sysctl_tree == NULL)
328 sysctl_ctx_free(&dev->sysctl_ctx);
329 dev->sysctl_tree = NULL;
333 * /dev/devctl implementation
337 * This design allows only one reader for /dev/devctl. This is not desirable
338 * in the long run, but will get a lot of hair out of this implementation.
339 * Maybe we should make this device a clonable device.
341 * Also note: we specifically do not attach a device to the device_t tree
342 * to avoid potential chicken and egg problems. One could argue that all
343 * of this belongs to the root node. One could also further argue that the
344 * sysctl interface that we have not might more properly be an ioctl
345 * interface, but at this stage of the game, I'm not inclined to rock that
348 * I'm also not sure that the SIGIO support is done correctly or not, as
349 * I copied it from a driver that had SIGIO support that likely hasn't been
350 * tested since 3.4 or 2.2.8!
353 /* Deprecated way to adjust queue length */
354 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
355 /* XXX Need to support old-style tunable hw.bus.devctl_disable" */
356 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, NULL,
357 0, sysctl_devctl_disable, "I", "devctl disable -- deprecated");
359 #define DEVCTL_DEFAULT_QUEUE_LEN 1000
360 static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS);
361 static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
362 TUNABLE_INT("hw.bus.devctl_queue", &devctl_queue_length);
363 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RW, NULL,
364 0, sysctl_devctl_queue, "I", "devctl queue length");
366 static d_open_t devopen;
367 static d_close_t devclose;
368 static d_read_t devread;
369 static d_ioctl_t devioctl;
370 static d_poll_t devpoll;
372 static struct cdevsw dev_cdevsw = {
373 .d_version = D_VERSION,
374 .d_flags = D_NEEDGIANT,
383 struct dev_event_info
386 TAILQ_ENTRY(dev_event_info) dei_link;
389 TAILQ_HEAD(devq, dev_event_info);
391 static struct dev_softc
400 struct proc *async_proc;
403 static struct cdev *devctl_dev;
408 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL,
409 UID_ROOT, GID_WHEEL, 0600, "devctl");
410 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
411 cv_init(&devsoftc.cv, "dev cv");
412 TAILQ_INIT(&devsoftc.devq);
416 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
422 devsoftc.nonblock = 0;
423 devsoftc.async_proc = NULL;
428 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
431 mtx_lock(&devsoftc.mtx);
432 cv_broadcast(&devsoftc.cv);
433 mtx_unlock(&devsoftc.mtx);
434 devsoftc.async_proc = NULL;
439 * The read channel for this device is used to report changes to
440 * userland in realtime. We are required to free the data as well as
441 * the n1 object because we allocate them separately. Also note that
442 * we return one record at a time. If you try to read this device a
443 * character at a time, you will lose the rest of the data. Listening
444 * programs are expected to cope.
447 devread(struct cdev *dev, struct uio *uio, int ioflag)
449 struct dev_event_info *n1;
452 mtx_lock(&devsoftc.mtx);
453 while (TAILQ_EMPTY(&devsoftc.devq)) {
454 if (devsoftc.nonblock) {
455 mtx_unlock(&devsoftc.mtx);
458 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
461 * Need to translate ERESTART to EINTR here? -- jake
463 mtx_unlock(&devsoftc.mtx);
467 n1 = TAILQ_FIRST(&devsoftc.devq);
468 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
470 mtx_unlock(&devsoftc.mtx);
471 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
472 free(n1->dei_data, M_BUS);
478 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
484 devsoftc.nonblock = 1;
486 devsoftc.nonblock = 0;
490 devsoftc.async_proc = td->td_proc;
492 devsoftc.async_proc = NULL;
495 /* (un)Support for other fcntl() calls. */
508 devpoll(struct cdev *dev, int events, struct thread *td)
512 mtx_lock(&devsoftc.mtx);
513 if (events & (POLLIN | POLLRDNORM)) {
514 if (!TAILQ_EMPTY(&devsoftc.devq))
515 revents = events & (POLLIN | POLLRDNORM);
517 selrecord(td, &devsoftc.sel);
519 mtx_unlock(&devsoftc.mtx);
525 * @brief Return whether the userland process is running
528 devctl_process_running(void)
530 return (devsoftc.inuse == 1);
534 * @brief Queue data to be read from the devctl device
536 * Generic interface to queue data to the devctl device. It is
537 * assumed that @p data is properly formatted. It is further assumed
538 * that @p data is allocated using the M_BUS malloc type.
541 devctl_queue_data_f(char *data, int flags)
543 struct dev_event_info *n1 = NULL, *n2 = NULL;
546 if (strlen(data) == 0)
548 if (devctl_queue_length == 0)
550 n1 = malloc(sizeof(*n1), M_BUS, flags);
554 mtx_lock(&devsoftc.mtx);
555 if (devctl_queue_length == 0) {
556 mtx_unlock(&devsoftc.mtx);
557 free(n1->dei_data, M_BUS);
561 /* Leave at least one spot in the queue... */
562 while (devsoftc.queued > devctl_queue_length - 1) {
563 n2 = TAILQ_FIRST(&devsoftc.devq);
564 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link);
565 free(n2->dei_data, M_BUS);
569 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
571 cv_broadcast(&devsoftc.cv);
572 mtx_unlock(&devsoftc.mtx);
573 selwakeup(&devsoftc.sel);
574 p = devsoftc.async_proc;
577 kern_psignal(p, SIGIO);
583 * We have to free data on all error paths since the caller
584 * assumes it will be free'd when this item is dequeued.
591 devctl_queue_data(char *data)
594 devctl_queue_data_f(data, M_NOWAIT);
598 * @brief Send a 'notification' to userland, using standard ways
601 devctl_notify_f(const char *system, const char *subsystem, const char *type,
602 const char *data, int flags)
608 return; /* BOGUS! Must specify system. */
609 if (subsystem == NULL)
610 return; /* BOGUS! Must specify subsystem. */
612 return; /* BOGUS! Must specify type. */
613 len += strlen(" system=") + strlen(system);
614 len += strlen(" subsystem=") + strlen(subsystem);
615 len += strlen(" type=") + strlen(type);
616 /* add in the data message plus newline. */
619 len += 3; /* '!', '\n', and NUL */
620 msg = malloc(len, M_BUS, flags);
622 return; /* Drop it on the floor */
624 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
625 system, subsystem, type, data);
627 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
628 system, subsystem, type);
629 devctl_queue_data_f(msg, flags);
633 devctl_notify(const char *system, const char *subsystem, const char *type,
637 devctl_notify_f(system, subsystem, type, data, M_NOWAIT);
641 * Common routine that tries to make sending messages as easy as possible.
642 * We allocate memory for the data, copy strings into that, but do not
643 * free it unless there's an error. The dequeue part of the driver should
644 * free the data. We don't send data when the device is disabled. We do
645 * send data, even when we have no listeners, because we wish to avoid
646 * races relating to startup and restart of listening applications.
648 * devaddq is designed to string together the type of event, with the
649 * object of that event, plus the plug and play info and location info
650 * for that event. This is likely most useful for devices, but less
651 * useful for other consumers of this interface. Those should use
652 * the devctl_queue_data() interface instead.
655 devaddq(const char *type, const char *what, device_t dev)
662 if (!devctl_queue_length)/* Rare race, but lost races safely discard */
664 data = malloc(1024, M_BUS, M_NOWAIT);
668 /* get the bus specific location of this device */
669 loc = malloc(1024, M_BUS, M_NOWAIT);
673 bus_child_location_str(dev, loc, 1024);
675 /* Get the bus specific pnp info of this device */
676 pnp = malloc(1024, M_BUS, M_NOWAIT);
680 bus_child_pnpinfo_str(dev, pnp, 1024);
682 /* Get the parent of this device, or / if high enough in the tree. */
683 if (device_get_parent(dev) == NULL)
684 parstr = "."; /* Or '/' ? */
686 parstr = device_get_nameunit(device_get_parent(dev));
687 /* String it all together. */
688 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
692 devctl_queue_data(data);
702 * A device was added to the tree. We are called just after it successfully
703 * attaches (that is, probe and attach success for this device). No call
704 * is made if a device is merely parented into the tree. See devnomatch
705 * if probe fails. If attach fails, no notification is sent (but maybe
706 * we should have a different message for this).
709 devadded(device_t dev)
711 devaddq("+", device_get_nameunit(dev), dev);
715 * A device was removed from the tree. We are called just before this
719 devremoved(device_t dev)
721 devaddq("-", device_get_nameunit(dev), dev);
725 * Called when there's no match for this device. This is only called
726 * the first time that no match happens, so we don't keep getting this
727 * message. Should that prove to be undesirable, we can change it.
728 * This is called when all drivers that can attach to a given bus
729 * decline to accept this device. Other errors may not be detected.
732 devnomatch(device_t dev)
734 devaddq("?", "", dev);
738 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
740 struct dev_event_info *n1;
743 dis = devctl_queue_length == 0;
744 error = sysctl_handle_int(oidp, &dis, 0, req);
745 if (error || !req->newptr)
747 mtx_lock(&devsoftc.mtx);
749 while (!TAILQ_EMPTY(&devsoftc.devq)) {
750 n1 = TAILQ_FIRST(&devsoftc.devq);
751 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
752 free(n1->dei_data, M_BUS);
756 devctl_queue_length = 0;
758 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN;
760 mtx_unlock(&devsoftc.mtx);
765 sysctl_devctl_queue(SYSCTL_HANDLER_ARGS)
767 struct dev_event_info *n1;
770 q = devctl_queue_length;
771 error = sysctl_handle_int(oidp, &q, 0, req);
772 if (error || !req->newptr)
776 mtx_lock(&devsoftc.mtx);
777 devctl_queue_length = q;
778 while (devsoftc.queued > devctl_queue_length) {
779 n1 = TAILQ_FIRST(&devsoftc.devq);
780 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
781 free(n1->dei_data, M_BUS);
785 mtx_unlock(&devsoftc.mtx);
789 /* End of /dev/devctl code */
791 static TAILQ_HEAD(,device) bus_data_devices;
792 static int bus_data_generation = 1;
794 static kobj_method_t null_methods[] = {
798 DEFINE_CLASS(null, null_methods, 0);
801 * Bus pass implementation
804 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
805 int bus_current_pass = BUS_PASS_ROOT;
809 * @brief Register the pass level of a new driver attachment
811 * Register a new driver attachment's pass level. If no driver
812 * attachment with the same pass level has been added, then @p new
813 * will be added to the global passes list.
815 * @param new the new driver attachment
818 driver_register_pass(struct driverlink *new)
820 struct driverlink *dl;
822 /* We only consider pass numbers during boot. */
823 if (bus_current_pass == BUS_PASS_DEFAULT)
827 * Walk the passes list. If we already know about this pass
828 * then there is nothing to do. If we don't, then insert this
829 * driver link into the list.
831 TAILQ_FOREACH(dl, &passes, passlink) {
832 if (dl->pass < new->pass)
834 if (dl->pass == new->pass)
836 TAILQ_INSERT_BEFORE(dl, new, passlink);
839 TAILQ_INSERT_TAIL(&passes, new, passlink);
843 * @brief Raise the current bus pass
845 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
846 * method on the root bus to kick off a new device tree scan for each
847 * new pass level that has at least one driver.
850 bus_set_pass(int pass)
852 struct driverlink *dl;
854 if (bus_current_pass > pass)
855 panic("Attempt to lower bus pass level");
857 TAILQ_FOREACH(dl, &passes, passlink) {
858 /* Skip pass values below the current pass level. */
859 if (dl->pass <= bus_current_pass)
863 * Bail once we hit a driver with a pass level that is
870 * Raise the pass level to the next level and rescan
873 bus_current_pass = dl->pass;
874 BUS_NEW_PASS(root_bus);
878 * If there isn't a driver registered for the requested pass,
879 * then bus_current_pass might still be less than 'pass'. Set
880 * it to 'pass' in that case.
882 if (bus_current_pass < pass)
883 bus_current_pass = pass;
884 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
888 * Devclass implementation
891 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
895 * @brief Find or create a device class
897 * If a device class with the name @p classname exists, return it,
898 * otherwise if @p create is non-zero create and return a new device
901 * If @p parentname is non-NULL, the parent of the devclass is set to
902 * the devclass of that name.
904 * @param classname the devclass name to find or create
905 * @param parentname the parent devclass name or @c NULL
906 * @param create non-zero to create a devclass
909 devclass_find_internal(const char *classname, const char *parentname,
914 PDEBUG(("looking for %s", classname));
918 TAILQ_FOREACH(dc, &devclasses, link) {
919 if (!strcmp(dc->name, classname))
924 PDEBUG(("creating %s", classname));
925 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
926 M_BUS, M_NOWAIT | M_ZERO);
930 dc->name = (char*) (dc + 1);
931 strcpy(dc->name, classname);
932 TAILQ_INIT(&dc->drivers);
933 TAILQ_INSERT_TAIL(&devclasses, dc, link);
935 bus_data_generation_update();
939 * If a parent class is specified, then set that as our parent so
940 * that this devclass will support drivers for the parent class as
941 * well. If the parent class has the same name don't do this though
942 * as it creates a cycle that can trigger an infinite loop in
943 * device_probe_child() if a device exists for which there is no
946 if (parentname && dc && !dc->parent &&
947 strcmp(classname, parentname) != 0) {
948 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
949 dc->parent->flags |= DC_HAS_CHILDREN;
956 * @brief Create a device class
958 * If a device class with the name @p classname exists, return it,
959 * otherwise create and return a new device class.
961 * @param classname the devclass name to find or create
964 devclass_create(const char *classname)
966 return (devclass_find_internal(classname, NULL, TRUE));
970 * @brief Find a device class
972 * If a device class with the name @p classname exists, return it,
973 * otherwise return @c NULL.
975 * @param classname the devclass name to find
978 devclass_find(const char *classname)
980 return (devclass_find_internal(classname, NULL, FALSE));
984 * @brief Register that a device driver has been added to a devclass
986 * Register that a device driver has been added to a devclass. This
987 * is called by devclass_add_driver to accomplish the recursive
988 * notification of all the children classes of dc, as well as dc.
989 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
992 * We do a full search here of the devclass list at each iteration
993 * level to save storing children-lists in the devclass structure. If
994 * we ever move beyond a few dozen devices doing this, we may need to
997 * @param dc the devclass to edit
998 * @param driver the driver that was just added
1001 devclass_driver_added(devclass_t dc, driver_t *driver)
1007 * Call BUS_DRIVER_ADDED for any existing busses in this class.
1009 for (i = 0; i < dc->maxunit; i++)
1010 if (dc->devices[i] && device_is_attached(dc->devices[i]))
1011 BUS_DRIVER_ADDED(dc->devices[i], driver);
1014 * Walk through the children classes. Since we only keep a
1015 * single parent pointer around, we walk the entire list of
1016 * devclasses looking for children. We set the
1017 * DC_HAS_CHILDREN flag when a child devclass is created on
1018 * the parent, so we only walk the list for those devclasses
1019 * that have children.
1021 if (!(dc->flags & DC_HAS_CHILDREN))
1024 TAILQ_FOREACH(dc, &devclasses, link) {
1025 if (dc->parent == parent)
1026 devclass_driver_added(dc, driver);
1031 * @brief Add a device driver to a device class
1033 * Add a device driver to a devclass. This is normally called
1034 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1035 * all devices in the devclass will be called to allow them to attempt
1036 * to re-probe any unmatched children.
1038 * @param dc the devclass to edit
1039 * @param driver the driver to register
1042 devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp)
1045 const char *parentname;
1047 PDEBUG(("%s", DRIVERNAME(driver)));
1049 /* Don't allow invalid pass values. */
1050 if (pass <= BUS_PASS_ROOT)
1053 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1058 * Compile the driver's methods. Also increase the reference count
1059 * so that the class doesn't get freed when the last instance
1060 * goes. This means we can safely use static methods and avoids a
1061 * double-free in devclass_delete_driver.
1063 kobj_class_compile((kobj_class_t) driver);
1066 * If the driver has any base classes, make the
1067 * devclass inherit from the devclass of the driver's
1068 * first base class. This will allow the system to
1069 * search for drivers in both devclasses for children
1070 * of a device using this driver.
1072 if (driver->baseclasses)
1073 parentname = driver->baseclasses[0]->name;
1076 *dcp = devclass_find_internal(driver->name, parentname, TRUE);
1078 dl->driver = driver;
1079 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
1080 driver->refs++; /* XXX: kobj_mtx */
1082 driver_register_pass(dl);
1084 devclass_driver_added(dc, driver);
1085 bus_data_generation_update();
1090 * @brief Register that a device driver has been deleted from a devclass
1092 * Register that a device driver has been removed from a devclass.
1093 * This is called by devclass_delete_driver to accomplish the
1094 * recursive notification of all the children classes of busclass, as
1095 * well as busclass. Each layer will attempt to detach the driver
1096 * from any devices that are children of the bus's devclass. The function
1097 * will return an error if a device fails to detach.
1099 * We do a full search here of the devclass list at each iteration
1100 * level to save storing children-lists in the devclass structure. If
1101 * we ever move beyond a few dozen devices doing this, we may need to
1104 * @param busclass the devclass of the parent bus
1105 * @param dc the devclass of the driver being deleted
1106 * @param driver the driver being deleted
1109 devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver)
1116 * Disassociate from any devices. We iterate through all the
1117 * devices in the devclass of the driver and detach any which are
1118 * using the driver and which have a parent in the devclass which
1119 * we are deleting from.
1121 * Note that since a driver can be in multiple devclasses, we
1122 * should not detach devices which are not children of devices in
1123 * the affected devclass.
1125 for (i = 0; i < dc->maxunit; i++) {
1126 if (dc->devices[i]) {
1127 dev = dc->devices[i];
1128 if (dev->driver == driver && dev->parent &&
1129 dev->parent->devclass == busclass) {
1130 if ((error = device_detach(dev)) != 0)
1132 BUS_PROBE_NOMATCH(dev->parent, dev);
1134 dev->flags |= DF_DONENOMATCH;
1140 * Walk through the children classes. Since we only keep a
1141 * single parent pointer around, we walk the entire list of
1142 * devclasses looking for children. We set the
1143 * DC_HAS_CHILDREN flag when a child devclass is created on
1144 * the parent, so we only walk the list for those devclasses
1145 * that have children.
1147 if (!(busclass->flags & DC_HAS_CHILDREN))
1150 TAILQ_FOREACH(busclass, &devclasses, link) {
1151 if (busclass->parent == parent) {
1152 error = devclass_driver_deleted(busclass, dc, driver);
1161 * @brief Delete a device driver from a device class
1163 * Delete a device driver from a devclass. This is normally called
1164 * automatically by DRIVER_MODULE().
1166 * If the driver is currently attached to any devices,
1167 * devclass_delete_driver() will first attempt to detach from each
1168 * device. If one of the detach calls fails, the driver will not be
1171 * @param dc the devclass to edit
1172 * @param driver the driver to unregister
1175 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1177 devclass_t dc = devclass_find(driver->name);
1181 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1187 * Find the link structure in the bus' list of drivers.
1189 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1190 if (dl->driver == driver)
1195 PDEBUG(("%s not found in %s list", driver->name,
1200 error = devclass_driver_deleted(busclass, dc, driver);
1204 TAILQ_REMOVE(&busclass->drivers, dl, link);
1209 if (driver->refs == 0)
1210 kobj_class_free((kobj_class_t) driver);
1212 bus_data_generation_update();
1217 * @brief Quiesces a set of device drivers from a device class
1219 * Quiesce a device driver from a devclass. This is normally called
1220 * automatically by DRIVER_MODULE().
1222 * If the driver is currently attached to any devices,
1223 * devclass_quiesece_driver() will first attempt to quiesce each
1226 * @param dc the devclass to edit
1227 * @param driver the driver to unregister
1230 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1232 devclass_t dc = devclass_find(driver->name);
1238 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1244 * Find the link structure in the bus' list of drivers.
1246 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1247 if (dl->driver == driver)
1252 PDEBUG(("%s not found in %s list", driver->name,
1258 * Quiesce all devices. We iterate through all the devices in
1259 * the devclass of the driver and quiesce any which are using
1260 * the driver and which have a parent in the devclass which we
1263 * Note that since a driver can be in multiple devclasses, we
1264 * should not quiesce devices which are not children of
1265 * devices in the affected devclass.
1267 for (i = 0; i < dc->maxunit; i++) {
1268 if (dc->devices[i]) {
1269 dev = dc->devices[i];
1270 if (dev->driver == driver && dev->parent &&
1271 dev->parent->devclass == busclass) {
1272 if ((error = device_quiesce(dev)) != 0)
1285 devclass_find_driver_internal(devclass_t dc, const char *classname)
1289 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1291 TAILQ_FOREACH(dl, &dc->drivers, link) {
1292 if (!strcmp(dl->driver->name, classname))
1296 PDEBUG(("not found"));
1301 * @brief Return the name of the devclass
1304 devclass_get_name(devclass_t dc)
1310 * @brief Find a device given a unit number
1312 * @param dc the devclass to search
1313 * @param unit the unit number to search for
1315 * @returns the device with the given unit number or @c
1316 * NULL if there is no such device
1319 devclass_get_device(devclass_t dc, int unit)
1321 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1323 return (dc->devices[unit]);
1327 * @brief Find the softc field of a device given a unit number
1329 * @param dc the devclass to search
1330 * @param unit the unit number to search for
1332 * @returns the softc field of the device with the given
1333 * unit number or @c NULL if there is no such
1337 devclass_get_softc(devclass_t dc, int unit)
1341 dev = devclass_get_device(dc, unit);
1345 return (device_get_softc(dev));
1349 * @brief Get a list of devices in the devclass
1351 * An array containing a list of all the devices in the given devclass
1352 * is allocated and returned in @p *devlistp. The number of devices
1353 * in the array is returned in @p *devcountp. The caller should free
1354 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1356 * @param dc the devclass to examine
1357 * @param devlistp points at location for array pointer return
1359 * @param devcountp points at location for array size return value
1362 * @retval ENOMEM the array allocation failed
1365 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1370 count = devclass_get_count(dc);
1371 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1376 for (i = 0; i < dc->maxunit; i++) {
1377 if (dc->devices[i]) {
1378 list[count] = dc->devices[i];
1390 * @brief Get a list of drivers in the devclass
1392 * An array containing a list of pointers to all the drivers in the
1393 * given devclass is allocated and returned in @p *listp. The number
1394 * of drivers in the array is returned in @p *countp. The caller should
1395 * free the array using @c free(p, M_TEMP).
1397 * @param dc the devclass to examine
1398 * @param listp gives location for array pointer return value
1399 * @param countp gives location for number of array elements
1403 * @retval ENOMEM the array allocation failed
1406 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1413 TAILQ_FOREACH(dl, &dc->drivers, link)
1415 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1420 TAILQ_FOREACH(dl, &dc->drivers, link) {
1421 list[count] = dl->driver;
1431 * @brief Get the number of devices in a devclass
1433 * @param dc the devclass to examine
1436 devclass_get_count(devclass_t dc)
1441 for (i = 0; i < dc->maxunit; i++)
1448 * @brief Get the maximum unit number used in a devclass
1450 * Note that this is one greater than the highest currently-allocated
1451 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1452 * that not even the devclass has been allocated yet.
1454 * @param dc the devclass to examine
1457 devclass_get_maxunit(devclass_t dc)
1461 return (dc->maxunit);
1465 * @brief Find a free unit number in a devclass
1467 * This function searches for the first unused unit number greater
1468 * that or equal to @p unit.
1470 * @param dc the devclass to examine
1471 * @param unit the first unit number to check
1474 devclass_find_free_unit(devclass_t dc, int unit)
1478 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1484 * @brief Set the parent of a devclass
1486 * The parent class is normally initialised automatically by
1489 * @param dc the devclass to edit
1490 * @param pdc the new parent devclass
1493 devclass_set_parent(devclass_t dc, devclass_t pdc)
1499 * @brief Get the parent of a devclass
1501 * @param dc the devclass to examine
1504 devclass_get_parent(devclass_t dc)
1506 return (dc->parent);
1509 struct sysctl_ctx_list *
1510 devclass_get_sysctl_ctx(devclass_t dc)
1512 return (&dc->sysctl_ctx);
1516 devclass_get_sysctl_tree(devclass_t dc)
1518 return (dc->sysctl_tree);
1523 * @brief Allocate a unit number
1525 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1526 * will do). The allocated unit number is returned in @p *unitp.
1528 * @param dc the devclass to allocate from
1529 * @param unitp points at the location for the allocated unit
1533 * @retval EEXIST the requested unit number is already allocated
1534 * @retval ENOMEM memory allocation failure
1537 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1542 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1544 /* Ask the parent bus if it wants to wire this device. */
1546 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1549 /* If we were given a wired unit number, check for existing device */
1552 if (unit >= 0 && unit < dc->maxunit &&
1553 dc->devices[unit] != NULL) {
1555 printf("%s: %s%d already exists; skipping it\n",
1556 dc->name, dc->name, *unitp);
1560 /* Unwired device, find the next available slot for it */
1562 for (unit = 0;; unit++) {
1563 /* If there is an "at" hint for a unit then skip it. */
1564 if (resource_string_value(dc->name, unit, "at", &s) ==
1568 /* If this device slot is already in use, skip it. */
1569 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1577 * We've selected a unit beyond the length of the table, so let's
1578 * extend the table to make room for all units up to and including
1581 if (unit >= dc->maxunit) {
1582 device_t *newlist, *oldlist;
1585 oldlist = dc->devices;
1586 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1587 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1590 if (oldlist != NULL)
1591 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1592 bzero(newlist + dc->maxunit,
1593 sizeof(device_t) * (newsize - dc->maxunit));
1594 dc->devices = newlist;
1595 dc->maxunit = newsize;
1596 if (oldlist != NULL)
1597 free(oldlist, M_BUS);
1599 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1607 * @brief Add a device to a devclass
1609 * A unit number is allocated for the device (using the device's
1610 * preferred unit number if any) and the device is registered in the
1611 * devclass. This allows the device to be looked up by its unit
1612 * number, e.g. by decoding a dev_t minor number.
1614 * @param dc the devclass to add to
1615 * @param dev the device to add
1618 * @retval EEXIST the requested unit number is already allocated
1619 * @retval ENOMEM memory allocation failure
1622 devclass_add_device(devclass_t dc, device_t dev)
1626 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1628 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX);
1631 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1635 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1636 free(dev->nameunit, M_BUS);
1637 dev->nameunit = NULL;
1640 dc->devices[dev->unit] = dev;
1642 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1649 * @brief Delete a device from a devclass
1651 * The device is removed from the devclass's device list and its unit
1654 * @param dc the devclass to delete from
1655 * @param dev the device to delete
1660 devclass_delete_device(devclass_t dc, device_t dev)
1665 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1667 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1668 panic("devclass_delete_device: inconsistent device class");
1669 dc->devices[dev->unit] = NULL;
1670 if (dev->flags & DF_WILDCARD)
1672 dev->devclass = NULL;
1673 free(dev->nameunit, M_BUS);
1674 dev->nameunit = NULL;
1681 * @brief Make a new device and add it as a child of @p parent
1683 * @param parent the parent of the new device
1684 * @param name the devclass name of the new device or @c NULL
1685 * to leave the devclass unspecified
1686 * @parem unit the unit number of the new device of @c -1 to
1687 * leave the unit number unspecified
1689 * @returns the new device
1692 make_device(device_t parent, const char *name, int unit)
1697 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1700 dc = devclass_find_internal(name, NULL, TRUE);
1702 printf("make_device: can't find device class %s\n",
1710 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
1714 dev->parent = parent;
1715 TAILQ_INIT(&dev->children);
1716 kobj_init((kobj_t) dev, &null_class);
1718 dev->devclass = NULL;
1720 dev->nameunit = NULL;
1724 dev->flags = DF_ENABLED;
1727 dev->flags |= DF_WILDCARD;
1729 dev->flags |= DF_FIXEDCLASS;
1730 if (devclass_add_device(dc, dev)) {
1731 kobj_delete((kobj_t) dev, M_BUS);
1738 dev->state = DS_NOTPRESENT;
1740 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1741 bus_data_generation_update();
1748 * @brief Print a description of a device.
1751 device_print_child(device_t dev, device_t child)
1755 if (device_is_alive(child))
1756 retval += BUS_PRINT_CHILD(dev, child);
1758 retval += device_printf(child, " not found\n");
1764 * @brief Create a new device
1766 * This creates a new device and adds it as a child of an existing
1767 * parent device. The new device will be added after the last existing
1768 * child with order zero.
1770 * @param dev the device which will be the parent of the
1772 * @param name devclass name for new device or @c NULL if not
1774 * @param unit unit number for new device or @c -1 if not
1777 * @returns the new device
1780 device_add_child(device_t dev, const char *name, int unit)
1782 return (device_add_child_ordered(dev, 0, name, unit));
1786 * @brief Create a new device
1788 * This creates a new device and adds it as a child of an existing
1789 * parent device. The new device will be added after the last existing
1790 * child with the same order.
1792 * @param dev the device which will be the parent of the
1794 * @param order a value which is used to partially sort the
1795 * children of @p dev - devices created using
1796 * lower values of @p order appear first in @p
1797 * dev's list of children
1798 * @param name devclass name for new device or @c NULL if not
1800 * @param unit unit number for new device or @c -1 if not
1803 * @returns the new device
1806 device_add_child_ordered(device_t dev, u_int order, const char *name, int unit)
1811 PDEBUG(("%s at %s with order %u as unit %d",
1812 name, DEVICENAME(dev), order, unit));
1813 KASSERT(name != NULL || unit == -1,
1814 ("child device with wildcard name and specific unit number"));
1816 child = make_device(dev, name, unit);
1819 child->order = order;
1821 TAILQ_FOREACH(place, &dev->children, link) {
1822 if (place->order > order)
1828 * The device 'place' is the first device whose order is
1829 * greater than the new child.
1831 TAILQ_INSERT_BEFORE(place, child, link);
1834 * The new child's order is greater or equal to the order of
1835 * any existing device. Add the child to the tail of the list.
1837 TAILQ_INSERT_TAIL(&dev->children, child, link);
1840 bus_data_generation_update();
1845 * @brief Delete a device
1847 * This function deletes a device along with all of its children. If
1848 * the device currently has a driver attached to it, the device is
1849 * detached first using device_detach().
1851 * @param dev the parent device
1852 * @param child the device to delete
1855 * @retval non-zero a unit error code describing the error
1858 device_delete_child(device_t dev, device_t child)
1861 device_t grandchild;
1863 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1865 /* remove children first */
1866 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) {
1867 error = device_delete_child(child, grandchild);
1872 if ((error = device_detach(child)) != 0)
1874 if (child->devclass)
1875 devclass_delete_device(child->devclass, child);
1877 BUS_CHILD_DELETED(dev, child);
1878 TAILQ_REMOVE(&dev->children, child, link);
1879 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1880 kobj_delete((kobj_t) child, M_BUS);
1882 bus_data_generation_update();
1887 * @brief Delete all children devices of the given device, if any.
1889 * This function deletes all children devices of the given device, if
1890 * any, using the device_delete_child() function for each device it
1891 * finds. If a child device cannot be deleted, this function will
1892 * return an error code.
1894 * @param dev the parent device
1897 * @retval non-zero a device would not detach
1900 device_delete_children(device_t dev)
1905 PDEBUG(("Deleting all children of %s", DEVICENAME(dev)));
1909 while ((child = TAILQ_FIRST(&dev->children)) != NULL) {
1910 error = device_delete_child(dev, child);
1912 PDEBUG(("Failed deleting %s", DEVICENAME(child)));
1920 * @brief Find a device given a unit number
1922 * This is similar to devclass_get_devices() but only searches for
1923 * devices which have @p dev as a parent.
1925 * @param dev the parent device to search
1926 * @param unit the unit number to search for. If the unit is -1,
1927 * return the first child of @p dev which has name
1928 * @p classname (that is, the one with the lowest unit.)
1930 * @returns the device with the given unit number or @c
1931 * NULL if there is no such device
1934 device_find_child(device_t dev, const char *classname, int unit)
1939 dc = devclass_find(classname);
1944 child = devclass_get_device(dc, unit);
1945 if (child && child->parent == dev)
1948 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1949 child = devclass_get_device(dc, unit);
1950 if (child && child->parent == dev)
1961 first_matching_driver(devclass_t dc, device_t dev)
1964 return (devclass_find_driver_internal(dc, dev->devclass->name));
1965 return (TAILQ_FIRST(&dc->drivers));
1972 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1974 if (dev->devclass) {
1976 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1977 if (!strcmp(dev->devclass->name, dl->driver->name))
1981 return (TAILQ_NEXT(last, link));
1988 device_probe_child(device_t dev, device_t child)
1991 driverlink_t best = NULL;
1993 int result, pri = 0;
1994 int hasclass = (child->devclass != NULL);
2000 panic("device_probe_child: parent device has no devclass");
2003 * If the state is already probed, then return. However, don't
2004 * return if we can rebid this object.
2006 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
2009 for (; dc; dc = dc->parent) {
2010 for (dl = first_matching_driver(dc, child);
2012 dl = next_matching_driver(dc, child, dl)) {
2013 /* If this driver's pass is too high, then ignore it. */
2014 if (dl->pass > bus_current_pass)
2017 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
2018 result = device_set_driver(child, dl->driver);
2019 if (result == ENOMEM)
2021 else if (result != 0)
2024 if (device_set_devclass(child,
2025 dl->driver->name) != 0) {
2026 char const * devname =
2027 device_get_name(child);
2028 if (devname == NULL)
2029 devname = "(unknown)";
2030 printf("driver bug: Unable to set "
2031 "devclass (class: %s "
2035 (void)device_set_driver(child, NULL);
2040 /* Fetch any flags for the device before probing. */
2041 resource_int_value(dl->driver->name, child->unit,
2042 "flags", &child->devflags);
2044 result = DEVICE_PROBE(child);
2046 /* Reset flags and devclass before the next probe. */
2047 child->devflags = 0;
2049 (void)device_set_devclass(child, NULL);
2052 * If the driver returns SUCCESS, there can be
2053 * no higher match for this device.
2062 * The driver returned an error so it
2063 * certainly doesn't match.
2066 (void)device_set_driver(child, NULL);
2071 * A priority lower than SUCCESS, remember the
2072 * best matching driver. Initialise the value
2073 * of pri for the first match.
2075 if (best == NULL || result > pri) {
2077 * Probes that return BUS_PROBE_NOWILDCARD
2078 * or lower only match when they are set
2079 * in stone by the parent bus.
2081 if (result <= BUS_PROBE_NOWILDCARD &&
2082 child->flags & DF_WILDCARD)
2090 * If we have an unambiguous match in this devclass,
2091 * don't look in the parent.
2093 if (best && pri == 0)
2098 * If we found a driver, change state and initialise the devclass.
2100 /* XXX What happens if we rebid and got no best? */
2103 * If this device was attached, and we were asked to
2104 * rescan, and it is a different driver, then we have
2105 * to detach the old driver and reattach this new one.
2106 * Note, we don't have to check for DF_REBID here
2107 * because if the state is > DS_ALIVE, we know it must
2110 * This assumes that all DF_REBID drivers can have
2111 * their probe routine called at any time and that
2112 * they are idempotent as well as completely benign in
2113 * normal operations.
2115 * We also have to make sure that the detach
2116 * succeeded, otherwise we fail the operation (or
2117 * maybe it should just fail silently? I'm torn).
2119 if (child->state > DS_ALIVE && best->driver != child->driver)
2120 if ((result = device_detach(dev)) != 0)
2123 /* Set the winning driver, devclass, and flags. */
2124 if (!child->devclass) {
2125 result = device_set_devclass(child, best->driver->name);
2129 result = device_set_driver(child, best->driver);
2132 resource_int_value(best->driver->name, child->unit,
2133 "flags", &child->devflags);
2137 * A bit bogus. Call the probe method again to make
2138 * sure that we have the right description.
2140 DEVICE_PROBE(child);
2142 child->flags |= DF_REBID;
2145 child->flags &= ~DF_REBID;
2146 child->state = DS_ALIVE;
2148 bus_data_generation_update();
2156 * @brief Return the parent of a device
2159 device_get_parent(device_t dev)
2161 return (dev->parent);
2165 * @brief Get a list of children of a device
2167 * An array containing a list of all the children of the given device
2168 * is allocated and returned in @p *devlistp. The number of devices
2169 * in the array is returned in @p *devcountp. The caller should free
2170 * the array using @c free(p, M_TEMP).
2172 * @param dev the device to examine
2173 * @param devlistp points at location for array pointer return
2175 * @param devcountp points at location for array size return value
2178 * @retval ENOMEM the array allocation failed
2181 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2188 TAILQ_FOREACH(child, &dev->children, link) {
2197 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2202 TAILQ_FOREACH(child, &dev->children, link) {
2203 list[count] = child;
2214 * @brief Return the current driver for the device or @c NULL if there
2215 * is no driver currently attached
2218 device_get_driver(device_t dev)
2220 return (dev->driver);
2224 * @brief Return the current devclass for the device or @c NULL if
2228 device_get_devclass(device_t dev)
2230 return (dev->devclass);
2234 * @brief Return the name of the device's devclass or @c NULL if there
2238 device_get_name(device_t dev)
2240 if (dev != NULL && dev->devclass)
2241 return (devclass_get_name(dev->devclass));
2246 * @brief Return a string containing the device's devclass name
2247 * followed by an ascii representation of the device's unit number
2251 device_get_nameunit(device_t dev)
2253 return (dev->nameunit);
2257 * @brief Return the device's unit number.
2260 device_get_unit(device_t dev)
2266 * @brief Return the device's description string
2269 device_get_desc(device_t dev)
2275 * @brief Return the device's flags
2278 device_get_flags(device_t dev)
2280 return (dev->devflags);
2283 struct sysctl_ctx_list *
2284 device_get_sysctl_ctx(device_t dev)
2286 return (&dev->sysctl_ctx);
2290 device_get_sysctl_tree(device_t dev)
2292 return (dev->sysctl_tree);
2296 * @brief Print the name of the device followed by a colon and a space
2298 * @returns the number of characters printed
2301 device_print_prettyname(device_t dev)
2303 const char *name = device_get_name(dev);
2306 return (printf("unknown: "));
2307 return (printf("%s%d: ", name, device_get_unit(dev)));
2311 * @brief Print the name of the device followed by a colon, a space
2312 * and the result of calling vprintf() with the value of @p fmt and
2313 * the following arguments.
2315 * @returns the number of characters printed
2318 device_printf(device_t dev, const char * fmt, ...)
2323 retval = device_print_prettyname(dev);
2325 retval += vprintf(fmt, ap);
2334 device_set_desc_internal(device_t dev, const char* desc, int copy)
2336 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2337 free(dev->desc, M_BUS);
2338 dev->flags &= ~DF_DESCMALLOCED;
2343 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2345 strcpy(dev->desc, desc);
2346 dev->flags |= DF_DESCMALLOCED;
2349 /* Avoid a -Wcast-qual warning */
2350 dev->desc = (char *)(uintptr_t) desc;
2353 bus_data_generation_update();
2357 * @brief Set the device's description
2359 * The value of @c desc should be a string constant that will not
2360 * change (at least until the description is changed in a subsequent
2361 * call to device_set_desc() or device_set_desc_copy()).
2364 device_set_desc(device_t dev, const char* desc)
2366 device_set_desc_internal(dev, desc, FALSE);
2370 * @brief Set the device's description
2372 * The string pointed to by @c desc is copied. Use this function if
2373 * the device description is generated, (e.g. with sprintf()).
2376 device_set_desc_copy(device_t dev, const char* desc)
2378 device_set_desc_internal(dev, desc, TRUE);
2382 * @brief Set the device's flags
2385 device_set_flags(device_t dev, uint32_t flags)
2387 dev->devflags = flags;
2391 * @brief Return the device's softc field
2393 * The softc is allocated and zeroed when a driver is attached, based
2394 * on the size field of the driver.
2397 device_get_softc(device_t dev)
2399 return (dev->softc);
2403 * @brief Set the device's softc field
2405 * Most drivers do not need to use this since the softc is allocated
2406 * automatically when the driver is attached.
2409 device_set_softc(device_t dev, void *softc)
2411 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2412 free(dev->softc, M_BUS_SC);
2415 dev->flags |= DF_EXTERNALSOFTC;
2417 dev->flags &= ~DF_EXTERNALSOFTC;
2421 * @brief Free claimed softc
2423 * Most drivers do not need to use this since the softc is freed
2424 * automatically when the driver is detached.
2427 device_free_softc(void *softc)
2429 free(softc, M_BUS_SC);
2433 * @brief Claim softc
2435 * This function can be used to let the driver free the automatically
2436 * allocated softc using "device_free_softc()". This function is
2437 * useful when the driver is refcounting the softc and the softc
2438 * cannot be freed when the "device_detach" method is called.
2441 device_claim_softc(device_t dev)
2444 dev->flags |= DF_EXTERNALSOFTC;
2446 dev->flags &= ~DF_EXTERNALSOFTC;
2450 * @brief Get the device's ivars field
2452 * The ivars field is used by the parent device to store per-device
2453 * state (e.g. the physical location of the device or a list of
2457 device_get_ivars(device_t dev)
2460 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2461 return (dev->ivars);
2465 * @brief Set the device's ivars field
2468 device_set_ivars(device_t dev, void * ivars)
2471 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2476 * @brief Return the device's state
2479 device_get_state(device_t dev)
2481 return (dev->state);
2485 * @brief Set the DF_ENABLED flag for the device
2488 device_enable(device_t dev)
2490 dev->flags |= DF_ENABLED;
2494 * @brief Clear the DF_ENABLED flag for the device
2497 device_disable(device_t dev)
2499 dev->flags &= ~DF_ENABLED;
2503 * @brief Increment the busy counter for the device
2506 device_busy(device_t dev)
2508 if (dev->state < DS_ATTACHING)
2509 panic("device_busy: called for unattached device");
2510 if (dev->busy == 0 && dev->parent)
2511 device_busy(dev->parent);
2513 if (dev->state == DS_ATTACHED)
2514 dev->state = DS_BUSY;
2518 * @brief Decrement the busy counter for the device
2521 device_unbusy(device_t dev)
2523 if (dev->busy != 0 && dev->state != DS_BUSY &&
2524 dev->state != DS_ATTACHING)
2525 panic("device_unbusy: called for non-busy device %s",
2526 device_get_nameunit(dev));
2528 if (dev->busy == 0) {
2530 device_unbusy(dev->parent);
2531 if (dev->state == DS_BUSY)
2532 dev->state = DS_ATTACHED;
2537 * @brief Set the DF_QUIET flag for the device
2540 device_quiet(device_t dev)
2542 dev->flags |= DF_QUIET;
2546 * @brief Clear the DF_QUIET flag for the device
2549 device_verbose(device_t dev)
2551 dev->flags &= ~DF_QUIET;
2555 * @brief Return non-zero if the DF_QUIET flag is set on the device
2558 device_is_quiet(device_t dev)
2560 return ((dev->flags & DF_QUIET) != 0);
2564 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2567 device_is_enabled(device_t dev)
2569 return ((dev->flags & DF_ENABLED) != 0);
2573 * @brief Return non-zero if the device was successfully probed
2576 device_is_alive(device_t dev)
2578 return (dev->state >= DS_ALIVE);
2582 * @brief Return non-zero if the device currently has a driver
2586 device_is_attached(device_t dev)
2588 return (dev->state >= DS_ATTACHED);
2592 * @brief Set the devclass of a device
2593 * @see devclass_add_device().
2596 device_set_devclass(device_t dev, const char *classname)
2603 devclass_delete_device(dev->devclass, dev);
2607 if (dev->devclass) {
2608 printf("device_set_devclass: device class already set\n");
2612 dc = devclass_find_internal(classname, NULL, TRUE);
2616 error = devclass_add_device(dc, dev);
2618 bus_data_generation_update();
2623 * @brief Set the driver of a device
2626 * @retval EBUSY the device already has a driver attached
2627 * @retval ENOMEM a memory allocation failure occurred
2630 device_set_driver(device_t dev, driver_t *driver)
2632 if (dev->state >= DS_ATTACHED)
2635 if (dev->driver == driver)
2638 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2639 free(dev->softc, M_BUS_SC);
2642 device_set_desc(dev, NULL);
2643 kobj_delete((kobj_t) dev, NULL);
2644 dev->driver = driver;
2646 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2647 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2648 dev->softc = malloc(driver->size, M_BUS_SC,
2651 kobj_delete((kobj_t) dev, NULL);
2652 kobj_init((kobj_t) dev, &null_class);
2658 kobj_init((kobj_t) dev, &null_class);
2661 bus_data_generation_update();
2666 * @brief Probe a device, and return this status.
2668 * This function is the core of the device autoconfiguration
2669 * system. Its purpose is to select a suitable driver for a device and
2670 * then call that driver to initialise the hardware appropriately. The
2671 * driver is selected by calling the DEVICE_PROBE() method of a set of
2672 * candidate drivers and then choosing the driver which returned the
2673 * best value. This driver is then attached to the device using
2676 * The set of suitable drivers is taken from the list of drivers in
2677 * the parent device's devclass. If the device was originally created
2678 * with a specific class name (see device_add_child()), only drivers
2679 * with that name are probed, otherwise all drivers in the devclass
2680 * are probed. If no drivers return successful probe values in the
2681 * parent devclass, the search continues in the parent of that
2682 * devclass (see devclass_get_parent()) if any.
2684 * @param dev the device to initialise
2687 * @retval ENXIO no driver was found
2688 * @retval ENOMEM memory allocation failure
2689 * @retval non-zero some other unix error code
2690 * @retval -1 Device already attached
2693 device_probe(device_t dev)
2699 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2702 if (!(dev->flags & DF_ENABLED)) {
2703 if (bootverbose && device_get_name(dev) != NULL) {
2704 device_print_prettyname(dev);
2705 printf("not probed (disabled)\n");
2709 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2710 if (bus_current_pass == BUS_PASS_DEFAULT &&
2711 !(dev->flags & DF_DONENOMATCH)) {
2712 BUS_PROBE_NOMATCH(dev->parent, dev);
2714 dev->flags |= DF_DONENOMATCH;
2722 * @brief Probe a device and attach a driver if possible
2724 * calls device_probe() and attaches if that was successful.
2727 device_probe_and_attach(device_t dev)
2733 error = device_probe(dev);
2736 else if (error != 0)
2738 return (device_attach(dev));
2742 * @brief Attach a device driver to a device
2744 * This function is a wrapper around the DEVICE_ATTACH() driver
2745 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2746 * device's sysctl tree, optionally prints a description of the device
2747 * and queues a notification event for user-based device management
2750 * Normally this function is only called internally from
2751 * device_probe_and_attach().
2753 * @param dev the device to initialise
2756 * @retval ENXIO no driver was found
2757 * @retval ENOMEM memory allocation failure
2758 * @retval non-zero some other unix error code
2761 device_attach(device_t dev)
2765 if (resource_disabled(dev->driver->name, dev->unit)) {
2766 device_disable(dev);
2768 device_printf(dev, "disabled via hints entry\n");
2772 device_sysctl_init(dev);
2773 if (!device_is_quiet(dev))
2774 device_print_child(dev->parent, dev);
2775 dev->state = DS_ATTACHING;
2776 if ((error = DEVICE_ATTACH(dev)) != 0) {
2777 printf("device_attach: %s%d attach returned %d\n",
2778 dev->driver->name, dev->unit, error);
2779 if (!(dev->flags & DF_FIXEDCLASS))
2780 devclass_delete_device(dev->devclass, dev);
2781 (void)device_set_driver(dev, NULL);
2782 device_sysctl_fini(dev);
2783 KASSERT(dev->busy == 0, ("attach failed but busy"));
2784 dev->state = DS_NOTPRESENT;
2787 device_sysctl_update(dev);
2789 dev->state = DS_BUSY;
2791 dev->state = DS_ATTACHED;
2792 dev->flags &= ~DF_DONENOMATCH;
2798 * @brief Detach a driver from a device
2800 * This function is a wrapper around the DEVICE_DETACH() driver
2801 * method. If the call to DEVICE_DETACH() succeeds, it calls
2802 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2803 * notification event for user-based device management services and
2804 * cleans up the device's sysctl tree.
2806 * @param dev the device to un-initialise
2809 * @retval ENXIO no driver was found
2810 * @retval ENOMEM memory allocation failure
2811 * @retval non-zero some other unix error code
2814 device_detach(device_t dev)
2820 PDEBUG(("%s", DEVICENAME(dev)));
2821 if (dev->state == DS_BUSY)
2823 if (dev->state != DS_ATTACHED)
2826 if ((error = DEVICE_DETACH(dev)) != 0)
2829 if (!device_is_quiet(dev))
2830 device_printf(dev, "detached\n");
2832 BUS_CHILD_DETACHED(dev->parent, dev);
2834 if (!(dev->flags & DF_FIXEDCLASS))
2835 devclass_delete_device(dev->devclass, dev);
2837 dev->state = DS_NOTPRESENT;
2838 (void)device_set_driver(dev, NULL);
2839 device_sysctl_fini(dev);
2845 * @brief Tells a driver to quiesce itself.
2847 * This function is a wrapper around the DEVICE_QUIESCE() driver
2848 * method. If the call to DEVICE_QUIESCE() succeeds.
2850 * @param dev the device to quiesce
2853 * @retval ENXIO no driver was found
2854 * @retval ENOMEM memory allocation failure
2855 * @retval non-zero some other unix error code
2858 device_quiesce(device_t dev)
2861 PDEBUG(("%s", DEVICENAME(dev)));
2862 if (dev->state == DS_BUSY)
2864 if (dev->state != DS_ATTACHED)
2867 return (DEVICE_QUIESCE(dev));
2871 * @brief Notify a device of system shutdown
2873 * This function calls the DEVICE_SHUTDOWN() driver method if the
2874 * device currently has an attached driver.
2876 * @returns the value returned by DEVICE_SHUTDOWN()
2879 device_shutdown(device_t dev)
2881 if (dev->state < DS_ATTACHED)
2883 return (DEVICE_SHUTDOWN(dev));
2887 * @brief Set the unit number of a device
2889 * This function can be used to override the unit number used for a
2890 * device (e.g. to wire a device to a pre-configured unit number).
2893 device_set_unit(device_t dev, int unit)
2898 dc = device_get_devclass(dev);
2899 if (unit < dc->maxunit && dc->devices[unit])
2901 err = devclass_delete_device(dc, dev);
2905 err = devclass_add_device(dc, dev);
2909 bus_data_generation_update();
2913 /*======================================*/
2915 * Some useful method implementations to make life easier for bus drivers.
2919 * @brief Initialise a resource list.
2921 * @param rl the resource list to initialise
2924 resource_list_init(struct resource_list *rl)
2930 * @brief Reclaim memory used by a resource list.
2932 * This function frees the memory for all resource entries on the list
2935 * @param rl the resource list to free
2938 resource_list_free(struct resource_list *rl)
2940 struct resource_list_entry *rle;
2942 while ((rle = STAILQ_FIRST(rl)) != NULL) {
2944 panic("resource_list_free: resource entry is busy");
2945 STAILQ_REMOVE_HEAD(rl, link);
2951 * @brief Add a resource entry.
2953 * This function adds a resource entry using the given @p type, @p
2954 * start, @p end and @p count values. A rid value is chosen by
2955 * searching sequentially for the first unused rid starting at zero.
2957 * @param rl the resource list to edit
2958 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2959 * @param start the start address of the resource
2960 * @param end the end address of the resource
2961 * @param count XXX end-start+1
2964 resource_list_add_next(struct resource_list *rl, int type, u_long start,
2965 u_long end, u_long count)
2970 while (resource_list_find(rl, type, rid) != NULL)
2972 resource_list_add(rl, type, rid, start, end, count);
2977 * @brief Add or modify a resource entry.
2979 * If an existing entry exists with the same type and rid, it will be
2980 * modified using the given values of @p start, @p end and @p
2981 * count. If no entry exists, a new one will be created using the
2982 * given values. The resource list entry that matches is then returned.
2984 * @param rl the resource list to edit
2985 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2986 * @param rid the resource identifier
2987 * @param start the start address of the resource
2988 * @param end the end address of the resource
2989 * @param count XXX end-start+1
2991 struct resource_list_entry *
2992 resource_list_add(struct resource_list *rl, int type, int rid,
2993 u_long start, u_long end, u_long count)
2995 struct resource_list_entry *rle;
2997 rle = resource_list_find(rl, type, rid);
2999 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
3002 panic("resource_list_add: can't record entry");
3003 STAILQ_INSERT_TAIL(rl, rle, link);
3011 panic("resource_list_add: resource entry is busy");
3020 * @brief Determine if a resource entry is busy.
3022 * Returns true if a resource entry is busy meaning that it has an
3023 * associated resource that is not an unallocated "reserved" resource.
3025 * @param rl the resource list to search
3026 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3027 * @param rid the resource identifier
3029 * @returns Non-zero if the entry is busy, zero otherwise.
3032 resource_list_busy(struct resource_list *rl, int type, int rid)
3034 struct resource_list_entry *rle;
3036 rle = resource_list_find(rl, type, rid);
3037 if (rle == NULL || rle->res == NULL)
3039 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) {
3040 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE),
3041 ("reserved resource is active"));
3048 * @brief Determine if a resource entry is reserved.
3050 * Returns true if a resource entry is reserved meaning that it has an
3051 * associated "reserved" resource. The resource can either be
3052 * allocated or unallocated.
3054 * @param rl the resource list to search
3055 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3056 * @param rid the resource identifier
3058 * @returns Non-zero if the entry is reserved, zero otherwise.
3061 resource_list_reserved(struct resource_list *rl, int type, int rid)
3063 struct resource_list_entry *rle;
3065 rle = resource_list_find(rl, type, rid);
3066 if (rle != NULL && rle->flags & RLE_RESERVED)
3072 * @brief Find a resource entry by type and rid.
3074 * @param rl the resource list to search
3075 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3076 * @param rid the resource identifier
3078 * @returns the resource entry pointer or NULL if there is no such
3081 struct resource_list_entry *
3082 resource_list_find(struct resource_list *rl, int type, int rid)
3084 struct resource_list_entry *rle;
3086 STAILQ_FOREACH(rle, rl, link) {
3087 if (rle->type == type && rle->rid == rid)
3094 * @brief Delete a resource entry.
3096 * @param rl the resource list to edit
3097 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
3098 * @param rid the resource identifier
3101 resource_list_delete(struct resource_list *rl, int type, int rid)
3103 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
3106 if (rle->res != NULL)
3107 panic("resource_list_delete: resource has not been released");
3108 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
3114 * @brief Allocate a reserved resource
3116 * This can be used by busses to force the allocation of resources
3117 * that are always active in the system even if they are not allocated
3118 * by a driver (e.g. PCI BARs). This function is usually called when
3119 * adding a new child to the bus. The resource is allocated from the
3120 * parent bus when it is reserved. The resource list entry is marked
3121 * with RLE_RESERVED to note that it is a reserved resource.
3123 * Subsequent attempts to allocate the resource with
3124 * resource_list_alloc() will succeed the first time and will set
3125 * RLE_ALLOCATED to note that it has been allocated. When a reserved
3126 * resource that has been allocated is released with
3127 * resource_list_release() the resource RLE_ALLOCATED is cleared, but
3128 * the actual resource remains allocated. The resource can be released to
3129 * the parent bus by calling resource_list_unreserve().
3131 * @param rl the resource list to allocate from
3132 * @param bus the parent device of @p child
3133 * @param child the device for which the resource is being reserved
3134 * @param type the type of resource to allocate
3135 * @param rid a pointer to the resource identifier
3136 * @param start hint at the start of the resource range - pass
3137 * @c 0UL for any start address
3138 * @param end hint at the end of the resource range - pass
3139 * @c ~0UL for any end address
3140 * @param count hint at the size of range required - pass @c 1
3142 * @param flags any extra flags to control the resource
3143 * allocation - see @c RF_XXX flags in
3144 * <sys/rman.h> for details
3146 * @returns the resource which was allocated or @c NULL if no
3147 * resource could be allocated
3150 resource_list_reserve(struct resource_list *rl, device_t bus, device_t child,
3151 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
3153 struct resource_list_entry *rle = NULL;
3154 int passthrough = (device_get_parent(child) != bus);
3159 "resource_list_reserve() should only be called for direct children");
3160 if (flags & RF_ACTIVE)
3162 "resource_list_reserve() should only reserve inactive resources");
3164 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
3167 rle = resource_list_find(rl, type, *rid);
3168 rle->flags |= RLE_RESERVED;
3174 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
3176 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
3177 * and passing the allocation up to the parent of @p bus. This assumes
3178 * that the first entry of @c device_get_ivars(child) is a struct
3179 * resource_list. This also handles 'passthrough' allocations where a
3180 * child is a remote descendant of bus by passing the allocation up to
3181 * the parent of bus.
3183 * Typically, a bus driver would store a list of child resources
3184 * somewhere in the child device's ivars (see device_get_ivars()) and
3185 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
3186 * then call resource_list_alloc() to perform the allocation.
3188 * @param rl the resource list to allocate from
3189 * @param bus the parent device of @p child
3190 * @param child the device which is requesting an allocation
3191 * @param type the type of resource to allocate
3192 * @param rid a pointer to the resource identifier
3193 * @param start hint at the start of the resource range - pass
3194 * @c 0UL for any start address
3195 * @param end hint at the end of the resource range - pass
3196 * @c ~0UL for any end address
3197 * @param count hint at the size of range required - pass @c 1
3199 * @param flags any extra flags to control the resource
3200 * allocation - see @c RF_XXX flags in
3201 * <sys/rman.h> for details
3203 * @returns the resource which was allocated or @c NULL if no
3204 * resource could be allocated
3207 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
3208 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
3210 struct resource_list_entry *rle = NULL;
3211 int passthrough = (device_get_parent(child) != bus);
3212 int isdefault = (start == 0UL && end == ~0UL);
3215 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3216 type, rid, start, end, count, flags));
3219 rle = resource_list_find(rl, type, *rid);
3222 return (NULL); /* no resource of that type/rid */
3225 if (rle->flags & RLE_RESERVED) {
3226 if (rle->flags & RLE_ALLOCATED)
3228 if ((flags & RF_ACTIVE) &&
3229 bus_activate_resource(child, type, *rid,
3232 rle->flags |= RLE_ALLOCATED;
3235 panic("resource_list_alloc: resource entry is busy");
3240 count = ulmax(count, rle->count);
3241 end = ulmax(rle->end, start + count - 1);
3244 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
3245 type, rid, start, end, count, flags);
3248 * Record the new range.
3251 rle->start = rman_get_start(rle->res);
3252 rle->end = rman_get_end(rle->res);
3260 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
3262 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
3263 * used with resource_list_alloc().
3265 * @param rl the resource list which was allocated from
3266 * @param bus the parent device of @p child
3267 * @param child the device which is requesting a release
3268 * @param type the type of resource to release
3269 * @param rid the resource identifier
3270 * @param res the resource to release
3273 * @retval non-zero a standard unix error code indicating what
3274 * error condition prevented the operation
3277 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3278 int type, int rid, struct resource *res)
3280 struct resource_list_entry *rle = NULL;
3281 int passthrough = (device_get_parent(child) != bus);
3285 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3289 rle = resource_list_find(rl, type, rid);
3292 panic("resource_list_release: can't find resource");
3294 panic("resource_list_release: resource entry is not busy");
3295 if (rle->flags & RLE_RESERVED) {
3296 if (rle->flags & RLE_ALLOCATED) {
3297 if (rman_get_flags(res) & RF_ACTIVE) {
3298 error = bus_deactivate_resource(child, type,
3303 rle->flags &= ~RLE_ALLOCATED;
3309 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3319 * @brief Fully release a reserved resource
3321 * Fully releases a resource reserved via resource_list_reserve().
3323 * @param rl the resource list which was allocated from
3324 * @param bus the parent device of @p child
3325 * @param child the device whose reserved resource is being released
3326 * @param type the type of resource to release
3327 * @param rid the resource identifier
3328 * @param res the resource to release
3331 * @retval non-zero a standard unix error code indicating what
3332 * error condition prevented the operation
3335 resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child,
3338 struct resource_list_entry *rle = NULL;
3339 int passthrough = (device_get_parent(child) != bus);
3343 "resource_list_unreserve() should only be called for direct children");
3345 rle = resource_list_find(rl, type, rid);
3348 panic("resource_list_unreserve: can't find resource");
3349 if (!(rle->flags & RLE_RESERVED))
3351 if (rle->flags & RLE_ALLOCATED)
3353 rle->flags &= ~RLE_RESERVED;
3354 return (resource_list_release(rl, bus, child, type, rid, rle->res));
3358 * @brief Print a description of resources in a resource list
3360 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3361 * The name is printed if at least one resource of the given type is available.
3362 * The format is used to print resource start and end.
3364 * @param rl the resource list to print
3365 * @param name the name of @p type, e.g. @c "memory"
3366 * @param type type type of resource entry to print
3367 * @param format printf(9) format string to print resource
3368 * start and end values
3370 * @returns the number of characters printed
3373 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3376 struct resource_list_entry *rle;
3377 int printed, retval;
3381 /* Yes, this is kinda cheating */
3382 STAILQ_FOREACH(rle, rl, link) {
3383 if (rle->type == type) {
3385 retval += printf(" %s ", name);
3387 retval += printf(",");
3389 retval += printf(format, rle->start);
3390 if (rle->count > 1) {
3391 retval += printf("-");
3392 retval += printf(format, rle->start +
3401 * @brief Releases all the resources in a list.
3403 * @param rl The resource list to purge.
3408 resource_list_purge(struct resource_list *rl)
3410 struct resource_list_entry *rle;
3412 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3414 bus_release_resource(rman_get_device(rle->res),
3415 rle->type, rle->rid, rle->res);
3416 STAILQ_REMOVE_HEAD(rl, link);
3422 bus_generic_add_child(device_t dev, u_int order, const char *name, int unit)
3425 return (device_add_child_ordered(dev, order, name, unit));
3429 * @brief Helper function for implementing DEVICE_PROBE()
3431 * This function can be used to help implement the DEVICE_PROBE() for
3432 * a bus (i.e. a device which has other devices attached to it). It
3433 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3437 bus_generic_probe(device_t dev)
3439 devclass_t dc = dev->devclass;
3442 TAILQ_FOREACH(dl, &dc->drivers, link) {
3444 * If this driver's pass is too high, then ignore it.
3445 * For most drivers in the default pass, this will
3446 * never be true. For early-pass drivers they will
3447 * only call the identify routines of eligible drivers
3448 * when this routine is called. Drivers for later
3449 * passes should have their identify routines called
3450 * on early-pass busses during BUS_NEW_PASS().
3452 if (dl->pass > bus_current_pass)
3454 DEVICE_IDENTIFY(dl->driver, dev);
3461 * @brief Helper function for implementing DEVICE_ATTACH()
3463 * This function can be used to help implement the DEVICE_ATTACH() for
3464 * a bus. It calls device_probe_and_attach() for each of the device's
3468 bus_generic_attach(device_t dev)
3472 TAILQ_FOREACH(child, &dev->children, link) {
3473 device_probe_and_attach(child);
3480 * @brief Helper function for implementing DEVICE_DETACH()
3482 * This function can be used to help implement the DEVICE_DETACH() for
3483 * a bus. It calls device_detach() for each of the device's
3487 bus_generic_detach(device_t dev)
3492 if (dev->state != DS_ATTACHED)
3495 TAILQ_FOREACH(child, &dev->children, link) {
3496 if ((error = device_detach(child)) != 0)
3504 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3506 * This function can be used to help implement the DEVICE_SHUTDOWN()
3507 * for a bus. It calls device_shutdown() for each of the device's
3511 bus_generic_shutdown(device_t dev)
3515 TAILQ_FOREACH(child, &dev->children, link) {
3516 device_shutdown(child);
3523 * @brief Helper function for implementing DEVICE_SUSPEND()
3525 * This function can be used to help implement the DEVICE_SUSPEND()
3526 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3527 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3528 * operation is aborted and any devices which were suspended are
3529 * resumed immediately by calling their DEVICE_RESUME() methods.
3532 bus_generic_suspend(device_t dev)
3535 device_t child, child2;
3537 TAILQ_FOREACH(child, &dev->children, link) {
3538 error = DEVICE_SUSPEND(child);
3540 for (child2 = TAILQ_FIRST(&dev->children);
3541 child2 && child2 != child;
3542 child2 = TAILQ_NEXT(child2, link))
3543 DEVICE_RESUME(child2);
3551 * @brief Helper function for implementing DEVICE_RESUME()
3553 * This function can be used to help implement the DEVICE_RESUME() for
3554 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3557 bus_generic_resume(device_t dev)
3561 TAILQ_FOREACH(child, &dev->children, link) {
3562 DEVICE_RESUME(child);
3563 /* if resume fails, there's nothing we can usefully do... */
3569 * @brief Helper function for implementing BUS_PRINT_CHILD().
3571 * This function prints the first part of the ascii representation of
3572 * @p child, including its name, unit and description (if any - see
3573 * device_set_desc()).
3575 * @returns the number of characters printed
3578 bus_print_child_header(device_t dev, device_t child)
3582 if (device_get_desc(child)) {
3583 retval += device_printf(child, "<%s>", device_get_desc(child));
3585 retval += printf("%s", device_get_nameunit(child));
3592 * @brief Helper function for implementing BUS_PRINT_CHILD().
3594 * This function prints the last part of the ascii representation of
3595 * @p child, which consists of the string @c " on " followed by the
3596 * name and unit of the @p dev.
3598 * @returns the number of characters printed
3601 bus_print_child_footer(device_t dev, device_t child)
3603 return (printf(" on %s\n", device_get_nameunit(dev)));
3607 * @brief Helper function for implementing BUS_PRINT_CHILD().
3609 * This function simply calls bus_print_child_header() followed by
3610 * bus_print_child_footer().
3612 * @returns the number of characters printed
3615 bus_generic_print_child(device_t dev, device_t child)
3619 retval += bus_print_child_header(dev, child);
3620 retval += bus_print_child_footer(dev, child);
3626 * @brief Stub function for implementing BUS_READ_IVAR().
3631 bus_generic_read_ivar(device_t dev, device_t child, int index,
3638 * @brief Stub function for implementing BUS_WRITE_IVAR().
3643 bus_generic_write_ivar(device_t dev, device_t child, int index,
3650 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3654 struct resource_list *
3655 bus_generic_get_resource_list(device_t dev, device_t child)
3661 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3663 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3664 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3665 * and then calls device_probe_and_attach() for each unattached child.
3668 bus_generic_driver_added(device_t dev, driver_t *driver)
3672 DEVICE_IDENTIFY(driver, dev);
3673 TAILQ_FOREACH(child, &dev->children, link) {
3674 if (child->state == DS_NOTPRESENT ||
3675 (child->flags & DF_REBID))
3676 device_probe_and_attach(child);
3681 * @brief Helper function for implementing BUS_NEW_PASS().
3683 * This implementing of BUS_NEW_PASS() first calls the identify
3684 * routines for any drivers that probe at the current pass. Then it
3685 * walks the list of devices for this bus. If a device is already
3686 * attached, then it calls BUS_NEW_PASS() on that device. If the
3687 * device is not already attached, it attempts to attach a driver to
3691 bus_generic_new_pass(device_t dev)
3698 TAILQ_FOREACH(dl, &dc->drivers, link) {
3699 if (dl->pass == bus_current_pass)
3700 DEVICE_IDENTIFY(dl->driver, dev);
3702 TAILQ_FOREACH(child, &dev->children, link) {
3703 if (child->state >= DS_ATTACHED)
3704 BUS_NEW_PASS(child);
3705 else if (child->state == DS_NOTPRESENT)
3706 device_probe_and_attach(child);
3711 * @brief Helper function for implementing BUS_SETUP_INTR().
3713 * This simple implementation of BUS_SETUP_INTR() simply calls the
3714 * BUS_SETUP_INTR() method of the parent of @p dev.
3717 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3718 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3721 /* Propagate up the bus hierarchy until someone handles it. */
3723 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3724 filter, intr, arg, cookiep));
3729 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3731 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3732 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3735 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3738 /* Propagate up the bus hierarchy until someone handles it. */
3740 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
3745 * @brief Helper function for implementing BUS_ADJUST_RESOURCE().
3747 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the
3748 * BUS_ADJUST_RESOURCE() method of the parent of @p dev.
3751 bus_generic_adjust_resource(device_t dev, device_t child, int type,
3752 struct resource *r, u_long start, u_long end)
3754 /* Propagate up the bus hierarchy until someone handles it. */
3756 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start,
3762 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
3764 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
3765 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
3768 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
3769 u_long start, u_long end, u_long count, u_int flags)
3771 /* Propagate up the bus hierarchy until someone handles it. */
3773 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
3774 start, end, count, flags));
3779 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
3781 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
3782 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
3785 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
3788 /* Propagate up the bus hierarchy until someone handles it. */
3790 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
3796 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
3798 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
3799 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
3802 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
3805 /* Propagate up the bus hierarchy until someone handles it. */
3807 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
3813 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
3815 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
3816 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
3819 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
3820 int rid, struct resource *r)
3822 /* Propagate up the bus hierarchy until someone handles it. */
3824 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
3830 * @brief Helper function for implementing BUS_BIND_INTR().
3832 * This simple implementation of BUS_BIND_INTR() simply calls the
3833 * BUS_BIND_INTR() method of the parent of @p dev.
3836 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
3840 /* Propagate up the bus hierarchy until someone handles it. */
3842 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
3847 * @brief Helper function for implementing BUS_CONFIG_INTR().
3849 * This simple implementation of BUS_CONFIG_INTR() simply calls the
3850 * BUS_CONFIG_INTR() method of the parent of @p dev.
3853 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
3854 enum intr_polarity pol)
3857 /* Propagate up the bus hierarchy until someone handles it. */
3859 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
3864 * @brief Helper function for implementing BUS_DESCRIBE_INTR().
3866 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the
3867 * BUS_DESCRIBE_INTR() method of the parent of @p dev.
3870 bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq,
3871 void *cookie, const char *descr)
3874 /* Propagate up the bus hierarchy until someone handles it. */
3876 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie,
3882 * @brief Helper function for implementing BUS_GET_DMA_TAG().
3884 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
3885 * BUS_GET_DMA_TAG() method of the parent of @p dev.
3888 bus_generic_get_dma_tag(device_t dev, device_t child)
3891 /* Propagate up the bus hierarchy until someone handles it. */
3892 if (dev->parent != NULL)
3893 return (BUS_GET_DMA_TAG(dev->parent, child));
3898 * @brief Helper function for implementing BUS_GET_RESOURCE().
3900 * This implementation of BUS_GET_RESOURCE() uses the
3901 * resource_list_find() function to do most of the work. It calls
3902 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3906 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
3907 u_long *startp, u_long *countp)
3909 struct resource_list * rl = NULL;
3910 struct resource_list_entry * rle = NULL;
3912 rl = BUS_GET_RESOURCE_LIST(dev, child);
3916 rle = resource_list_find(rl, type, rid);
3921 *startp = rle->start;
3923 *countp = rle->count;
3929 * @brief Helper function for implementing BUS_SET_RESOURCE().
3931 * This implementation of BUS_SET_RESOURCE() uses the
3932 * resource_list_add() function to do most of the work. It calls
3933 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3937 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
3938 u_long start, u_long count)
3940 struct resource_list * rl = NULL;
3942 rl = BUS_GET_RESOURCE_LIST(dev, child);
3946 resource_list_add(rl, type, rid, start, (start + count - 1), count);
3952 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
3954 * This implementation of BUS_DELETE_RESOURCE() uses the
3955 * resource_list_delete() function to do most of the work. It calls
3956 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3960 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
3962 struct resource_list * rl = NULL;
3964 rl = BUS_GET_RESOURCE_LIST(dev, child);
3968 resource_list_delete(rl, type, rid);
3974 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
3976 * This implementation of BUS_RELEASE_RESOURCE() uses the
3977 * resource_list_release() function to do most of the work. It calls
3978 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
3981 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
3982 int rid, struct resource *r)
3984 struct resource_list * rl = NULL;
3986 if (device_get_parent(child) != dev)
3987 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
3990 rl = BUS_GET_RESOURCE_LIST(dev, child);
3994 return (resource_list_release(rl, dev, child, type, rid, r));
3998 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
4000 * This implementation of BUS_ALLOC_RESOURCE() uses the
4001 * resource_list_alloc() function to do most of the work. It calls
4002 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
4005 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
4006 int *rid, u_long start, u_long end, u_long count, u_int flags)
4008 struct resource_list * rl = NULL;
4010 if (device_get_parent(child) != dev)
4011 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
4012 type, rid, start, end, count, flags));
4014 rl = BUS_GET_RESOURCE_LIST(dev, child);
4018 return (resource_list_alloc(rl, dev, child, type, rid,
4019 start, end, count, flags));
4023 * @brief Helper function for implementing BUS_CHILD_PRESENT().
4025 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
4026 * BUS_CHILD_PRESENT() method of the parent of @p dev.
4029 bus_generic_child_present(device_t dev, device_t child)
4031 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
4035 * Some convenience functions to make it easier for drivers to use the
4036 * resource-management functions. All these really do is hide the
4037 * indirection through the parent's method table, making for slightly
4038 * less-wordy code. In the future, it might make sense for this code
4039 * to maintain some sort of a list of resources allocated by each device.
4043 bus_alloc_resources(device_t dev, struct resource_spec *rs,
4044 struct resource **res)
4048 for (i = 0; rs[i].type != -1; i++)
4050 for (i = 0; rs[i].type != -1; i++) {
4051 res[i] = bus_alloc_resource_any(dev,
4052 rs[i].type, &rs[i].rid, rs[i].flags);
4053 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
4054 bus_release_resources(dev, rs, res);
4062 bus_release_resources(device_t dev, const struct resource_spec *rs,
4063 struct resource **res)
4067 for (i = 0; rs[i].type != -1; i++)
4068 if (res[i] != NULL) {
4069 bus_release_resource(
4070 dev, rs[i].type, rs[i].rid, res[i]);
4076 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
4078 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
4082 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
4083 u_long count, u_int flags)
4085 if (dev->parent == NULL)
4087 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
4092 * @brief Wrapper function for BUS_ADJUST_RESOURCE().
4094 * This function simply calls the BUS_ADJUST_RESOURCE() method of the
4098 bus_adjust_resource(device_t dev, int type, struct resource *r, u_long start,
4101 if (dev->parent == NULL)
4103 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end));
4107 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
4109 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
4113 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
4115 if (dev->parent == NULL)
4117 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4121 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
4123 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
4127 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
4129 if (dev->parent == NULL)
4131 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
4135 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
4137 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
4141 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
4143 if (dev->parent == NULL)
4145 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
4149 * @brief Wrapper function for BUS_SETUP_INTR().
4151 * This function simply calls the BUS_SETUP_INTR() method of the
4155 bus_setup_intr(device_t dev, struct resource *r, int flags,
4156 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
4160 if (dev->parent == NULL)
4162 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
4166 if (handler != NULL && !(flags & INTR_MPSAFE))
4167 device_printf(dev, "[GIANT-LOCKED]\n");
4172 * @brief Wrapper function for BUS_TEARDOWN_INTR().
4174 * This function simply calls the BUS_TEARDOWN_INTR() method of the
4178 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
4180 if (dev->parent == NULL)
4182 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
4186 * @brief Wrapper function for BUS_BIND_INTR().
4188 * This function simply calls the BUS_BIND_INTR() method of the
4192 bus_bind_intr(device_t dev, struct resource *r, int cpu)
4194 if (dev->parent == NULL)
4196 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
4200 * @brief Wrapper function for BUS_DESCRIBE_INTR().
4202 * This function first formats the requested description into a
4203 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of
4204 * the parent of @p dev.
4207 bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
4208 const char *fmt, ...)
4211 char descr[MAXCOMLEN + 1];
4213 if (dev->parent == NULL)
4216 vsnprintf(descr, sizeof(descr), fmt, ap);
4218 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr));
4222 * @brief Wrapper function for BUS_SET_RESOURCE().
4224 * This function simply calls the BUS_SET_RESOURCE() method of the
4228 bus_set_resource(device_t dev, int type, int rid,
4229 u_long start, u_long count)
4231 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
4236 * @brief Wrapper function for BUS_GET_RESOURCE().
4238 * This function simply calls the BUS_GET_RESOURCE() method of the
4242 bus_get_resource(device_t dev, int type, int rid,
4243 u_long *startp, u_long *countp)
4245 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4250 * @brief Wrapper function for BUS_GET_RESOURCE().
4252 * This function simply calls the BUS_GET_RESOURCE() method of the
4253 * parent of @p dev and returns the start value.
4256 bus_get_resource_start(device_t dev, int type, int rid)
4258 u_long start, count;
4261 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4269 * @brief Wrapper function for BUS_GET_RESOURCE().
4271 * This function simply calls the BUS_GET_RESOURCE() method of the
4272 * parent of @p dev and returns the count value.
4275 bus_get_resource_count(device_t dev, int type, int rid)
4277 u_long start, count;
4280 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
4288 * @brief Wrapper function for BUS_DELETE_RESOURCE().
4290 * This function simply calls the BUS_DELETE_RESOURCE() method of the
4294 bus_delete_resource(device_t dev, int type, int rid)
4296 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
4300 * @brief Wrapper function for BUS_CHILD_PRESENT().
4302 * This function simply calls the BUS_CHILD_PRESENT() method of the
4306 bus_child_present(device_t child)
4308 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
4312 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
4314 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
4318 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
4322 parent = device_get_parent(child);
4323 if (parent == NULL) {
4327 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
4331 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
4333 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
4337 bus_child_location_str(device_t child, char *buf, size_t buflen)
4341 parent = device_get_parent(child);
4342 if (parent == NULL) {
4346 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
4350 * @brief Wrapper function for BUS_GET_DMA_TAG().
4352 * This function simply calls the BUS_GET_DMA_TAG() method of the
4356 bus_get_dma_tag(device_t dev)
4360 parent = device_get_parent(dev);
4363 return (BUS_GET_DMA_TAG(parent, dev));
4366 /* Resume all devices and then notify userland that we're up again. */
4368 root_resume(device_t dev)
4372 error = bus_generic_resume(dev);
4374 devctl_notify("kern", "power", "resume", NULL);
4379 root_print_child(device_t dev, device_t child)
4383 retval += bus_print_child_header(dev, child);
4384 retval += printf("\n");
4390 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4391 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4394 * If an interrupt mapping gets to here something bad has happened.
4396 panic("root_setup_intr");
4400 * If we get here, assume that the device is permanant and really is
4401 * present in the system. Removable bus drivers are expected to intercept
4402 * this call long before it gets here. We return -1 so that drivers that
4403 * really care can check vs -1 or some ERRNO returned higher in the food
4407 root_child_present(device_t dev, device_t child)
4412 static kobj_method_t root_methods[] = {
4413 /* Device interface */
4414 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4415 KOBJMETHOD(device_suspend, bus_generic_suspend),
4416 KOBJMETHOD(device_resume, root_resume),
4419 KOBJMETHOD(bus_print_child, root_print_child),
4420 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4421 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4422 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4423 KOBJMETHOD(bus_child_present, root_child_present),
4428 static driver_t root_driver = {
4435 devclass_t root_devclass;
4438 root_bus_module_handler(module_t mod, int what, void* arg)
4442 TAILQ_INIT(&bus_data_devices);
4443 kobj_class_compile((kobj_class_t) &root_driver);
4444 root_bus = make_device(NULL, "root", 0);
4445 root_bus->desc = "System root bus";
4446 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4447 root_bus->driver = &root_driver;
4448 root_bus->state = DS_ATTACHED;
4449 root_devclass = devclass_find_internal("root", NULL, FALSE);
4454 device_shutdown(root_bus);
4457 return (EOPNOTSUPP);
4463 static moduledata_t root_bus_mod = {
4465 root_bus_module_handler,
4468 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4471 * @brief Automatically configure devices
4473 * This function begins the autoconfiguration process by calling
4474 * device_probe_and_attach() for each child of the @c root0 device.
4477 root_bus_configure(void)
4482 /* Eventually this will be split up, but this is sufficient for now. */
4483 bus_set_pass(BUS_PASS_DEFAULT);
4487 * @brief Module handler for registering device drivers
4489 * This module handler is used to automatically register device
4490 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4491 * devclass_add_driver() for the driver described by the
4492 * driver_module_data structure pointed to by @p arg
4495 driver_module_handler(module_t mod, int what, void *arg)
4497 struct driver_module_data *dmd;
4498 devclass_t bus_devclass;
4499 kobj_class_t driver;
4502 dmd = (struct driver_module_data *)arg;
4503 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4508 if (dmd->dmd_chainevh)
4509 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4511 pass = dmd->dmd_pass;
4512 driver = dmd->dmd_driver;
4513 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4514 DRIVERNAME(driver), dmd->dmd_busname, pass));
4515 error = devclass_add_driver(bus_devclass, driver, pass,
4520 PDEBUG(("Unloading module: driver %s from bus %s",
4521 DRIVERNAME(dmd->dmd_driver),
4523 error = devclass_delete_driver(bus_devclass,
4526 if (!error && dmd->dmd_chainevh)
4527 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4530 PDEBUG(("Quiesce module: driver %s from bus %s",
4531 DRIVERNAME(dmd->dmd_driver),
4533 error = devclass_quiesce_driver(bus_devclass,
4536 if (!error && dmd->dmd_chainevh)
4537 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4548 * @brief Enumerate all hinted devices for this bus.
4550 * Walks through the hints for this bus and calls the bus_hinted_child
4551 * routine for each one it fines. It searches first for the specific
4552 * bus that's being probed for hinted children (eg isa0), and then for
4553 * generic children (eg isa).
4555 * @param dev bus device to enumerate
4558 bus_enumerate_hinted_children(device_t bus)
4561 const char *dname, *busname;
4565 * enumerate all devices on the specific bus
4567 busname = device_get_nameunit(bus);
4569 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4570 BUS_HINTED_CHILD(bus, dname, dunit);
4573 * and all the generic ones.
4575 busname = device_get_name(bus);
4577 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4578 BUS_HINTED_CHILD(bus, dname, dunit);
4583 /* the _short versions avoid iteration by not calling anything that prints
4584 * more than oneliners. I love oneliners.
4588 print_device_short(device_t dev, int indent)
4593 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
4594 dev->unit, dev->desc,
4595 (dev->parent? "":"no "),
4596 (TAILQ_EMPTY(&dev->children)? "no ":""),
4597 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
4598 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
4599 (dev->flags&DF_WILDCARD? "wildcard,":""),
4600 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
4601 (dev->flags&DF_REBID? "rebiddable,":""),
4602 (dev->ivars? "":"no "),
4603 (dev->softc? "":"no "),
4608 print_device(device_t dev, int indent)
4613 print_device_short(dev, indent);
4615 indentprintf(("Parent:\n"));
4616 print_device_short(dev->parent, indent+1);
4617 indentprintf(("Driver:\n"));
4618 print_driver_short(dev->driver, indent+1);
4619 indentprintf(("Devclass:\n"));
4620 print_devclass_short(dev->devclass, indent+1);
4624 print_device_tree_short(device_t dev, int indent)
4625 /* print the device and all its children (indented) */
4632 print_device_short(dev, indent);
4634 TAILQ_FOREACH(child, &dev->children, link) {
4635 print_device_tree_short(child, indent+1);
4640 print_device_tree(device_t dev, int indent)
4641 /* print the device and all its children (indented) */
4648 print_device(dev, indent);
4650 TAILQ_FOREACH(child, &dev->children, link) {
4651 print_device_tree(child, indent+1);
4656 print_driver_short(driver_t *driver, int indent)
4661 indentprintf(("driver %s: softc size = %zd\n",
4662 driver->name, driver->size));
4666 print_driver(driver_t *driver, int indent)
4671 print_driver_short(driver, indent);
4675 print_driver_list(driver_list_t drivers, int indent)
4677 driverlink_t driver;
4679 TAILQ_FOREACH(driver, &drivers, link) {
4680 print_driver(driver->driver, indent);
4685 print_devclass_short(devclass_t dc, int indent)
4690 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
4694 print_devclass(devclass_t dc, int indent)
4701 print_devclass_short(dc, indent);
4702 indentprintf(("Drivers:\n"));
4703 print_driver_list(dc->drivers, indent+1);
4705 indentprintf(("Devices:\n"));
4706 for (i = 0; i < dc->maxunit; i++)
4708 print_device(dc->devices[i], indent+1);
4712 print_devclass_list_short(void)
4716 printf("Short listing of devclasses, drivers & devices:\n");
4717 TAILQ_FOREACH(dc, &devclasses, link) {
4718 print_devclass_short(dc, 0);
4723 print_devclass_list(void)
4727 printf("Full listing of devclasses, drivers & devices:\n");
4728 TAILQ_FOREACH(dc, &devclasses, link) {
4729 print_devclass(dc, 0);
4736 * User-space access to the device tree.
4738 * We implement a small set of nodes:
4740 * hw.bus Single integer read method to obtain the
4741 * current generation count.
4742 * hw.bus.devices Reads the entire device tree in flat space.
4743 * hw.bus.rman Resource manager interface
4745 * We might like to add the ability to scan devclasses and/or drivers to
4746 * determine what else is currently loaded/available.
4750 sysctl_bus(SYSCTL_HANDLER_ARGS)
4752 struct u_businfo ubus;
4754 ubus.ub_version = BUS_USER_VERSION;
4755 ubus.ub_generation = bus_data_generation;
4757 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
4759 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
4760 "bus-related data");
4763 sysctl_devices(SYSCTL_HANDLER_ARGS)
4765 int *name = (int *)arg1;
4766 u_int namelen = arg2;
4769 struct u_device udev; /* XXX this is a bit big */
4775 if (bus_data_generation_check(name[0]))
4781 * Scan the list of devices, looking for the requested index.
4783 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
4791 * Populate the return array.
4793 bzero(&udev, sizeof(udev));
4794 udev.dv_handle = (uintptr_t)dev;
4795 udev.dv_parent = (uintptr_t)dev->parent;
4796 if (dev->nameunit != NULL)
4797 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
4798 if (dev->desc != NULL)
4799 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
4800 if (dev->driver != NULL && dev->driver->name != NULL)
4801 strlcpy(udev.dv_drivername, dev->driver->name,
4802 sizeof(udev.dv_drivername));
4803 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
4804 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
4805 udev.dv_devflags = dev->devflags;
4806 udev.dv_flags = dev->flags;
4807 udev.dv_state = dev->state;
4808 error = SYSCTL_OUT(req, &udev, sizeof(udev));
4812 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
4813 "system device tree");
4816 bus_data_generation_check(int generation)
4818 if (generation != bus_data_generation)
4821 /* XXX generate optimised lists here? */
4826 bus_data_generation_update(void)
4828 bus_data_generation++;
4832 bus_free_resource(device_t dev, int type, struct resource *r)
4836 return (bus_release_resource(dev, type, rman_get_rid(r), r));