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/malloc.h>
39 #include <sys/module.h>
40 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/queue.h>
45 #include <machine/bus.h>
47 #include <sys/selinfo.h>
48 #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 u_int32_t devflags; /**< api level flags for device_get_flags() */
124 u_short flags; /**< internal device flags */
125 #define DF_ENABLED 1 /* device should be probed/attached */
126 #define DF_FIXEDCLASS 2 /* devclass specified at create time */
127 #define DF_WILDCARD 4 /* unit was originally wildcard */
128 #define DF_DESCMALLOCED 8 /* description was malloced */
129 #define DF_QUIET 16 /* don't print verbose attach message */
130 #define DF_DONENOMATCH 32 /* don't execute DEVICE_NOMATCH again */
131 #define DF_EXTERNALSOFTC 64 /* softc not allocated by us */
132 #define DF_REBID 128 /* Can rebid after attach */
133 u_char order; /**< order from device_add_child_ordered() */
135 void *ivars; /**< instance variables */
136 void *softc; /**< current driver's variables */
138 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
139 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
142 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
143 static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc");
147 static int bus_debug = 1;
148 TUNABLE_INT("bus.debug", &bus_debug);
149 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RW, &bus_debug, 0,
152 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");}
153 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
154 #define DRIVERNAME(d) ((d)? d->name : "no driver")
155 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
158 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to
159 * prevent syslog from deleting initial spaces
161 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
163 static void print_device_short(device_t dev, int indent);
164 static void print_device(device_t dev, int indent);
165 void print_device_tree_short(device_t dev, int indent);
166 void print_device_tree(device_t dev, int indent);
167 static void print_driver_short(driver_t *driver, int indent);
168 static void print_driver(driver_t *driver, int indent);
169 static void print_driver_list(driver_list_t drivers, int indent);
170 static void print_devclass_short(devclass_t dc, int indent);
171 static void print_devclass(devclass_t dc, int indent);
172 void print_devclass_list_short(void);
173 void print_devclass_list(void);
176 /* Make the compiler ignore the function calls */
177 #define PDEBUG(a) /* nop */
178 #define DEVICENAME(d) /* nop */
179 #define DRIVERNAME(d) /* nop */
180 #define DEVCLANAME(d) /* nop */
182 #define print_device_short(d,i) /* nop */
183 #define print_device(d,i) /* nop */
184 #define print_device_tree_short(d,i) /* nop */
185 #define print_device_tree(d,i) /* nop */
186 #define print_driver_short(d,i) /* nop */
187 #define print_driver(d,i) /* nop */
188 #define print_driver_list(d,i) /* nop */
189 #define print_devclass_short(d,i) /* nop */
190 #define print_devclass(d,i) /* nop */
191 #define print_devclass_list_short() /* nop */
192 #define print_devclass_list() /* nop */
196 * Newbus locking facilities.
198 static struct sx newbus_lock;
200 #define NBL_LOCK_INIT() sx_init(&newbus_lock, "newbus")
201 #define NBL_LOCK_DESTROY() sx_destroy(&newbus_lock)
202 #define NBL_XLOCK() sx_xlock(&newbus_lock)
203 #define NBL_SLOCK() sx_slock(&newbus_lock)
204 #define NBL_XUNLOCK() sx_xunlock(&newbus_lock)
205 #define NBL_SUNLOCK() sx_sunlock(&newbus_lock)
207 #define NBL_ASSERT(what) do { \
209 sx_assert(&newbus_lock, (what)); \
212 #define NBL_ASSERT(what)
248 DEVCLASS_SYSCTL_PARENT,
252 devclass_sysctl_handler(SYSCTL_HANDLER_ARGS)
254 devclass_t dc = (devclass_t)arg1;
258 case DEVCLASS_SYSCTL_PARENT:
259 value = dc->parent ? dc->parent->name : "";
264 return (SYSCTL_OUT(req, value, strlen(value)));
268 devclass_sysctl_init(devclass_t dc)
271 if (dc->sysctl_tree != NULL)
273 sysctl_ctx_init(&dc->sysctl_ctx);
274 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx,
275 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name,
276 CTLFLAG_RD, NULL, "");
277 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree),
278 OID_AUTO, "%parent", CTLFLAG_RD,
279 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A",
285 DEVICE_SYSCTL_DRIVER,
286 DEVICE_SYSCTL_LOCATION,
287 DEVICE_SYSCTL_PNPINFO,
288 DEVICE_SYSCTL_PARENT,
292 device_sysctl_handler(SYSCTL_HANDLER_ARGS)
294 device_t dev = (device_t)arg1;
301 case DEVICE_SYSCTL_DESC:
302 value = dev->desc ? dev->desc : "";
304 case DEVICE_SYSCTL_DRIVER:
305 value = dev->driver ? dev->driver->name : "";
307 case DEVICE_SYSCTL_LOCATION:
308 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
309 bus_child_location_str(dev, buf, 1024);
311 case DEVICE_SYSCTL_PNPINFO:
312 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO);
313 bus_child_pnpinfo_str(dev, buf, 1024);
315 case DEVICE_SYSCTL_PARENT:
316 value = dev->parent ? dev->parent->nameunit : "";
321 error = SYSCTL_OUT(req, value, strlen(value));
328 device_sysctl_init(device_t dev)
330 devclass_t dc = dev->devclass;
332 if (dev->sysctl_tree != NULL)
334 devclass_sysctl_init(dc);
335 sysctl_ctx_init(&dev->sysctl_ctx);
336 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx,
337 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO,
338 dev->nameunit + strlen(dc->name),
339 CTLFLAG_RD, NULL, "");
340 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
341 OID_AUTO, "%desc", CTLFLAG_RD,
342 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A",
343 "device description");
344 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
345 OID_AUTO, "%driver", CTLFLAG_RD,
346 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A",
347 "device driver name");
348 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
349 OID_AUTO, "%location", CTLFLAG_RD,
350 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A",
351 "device location relative to parent");
352 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
353 OID_AUTO, "%pnpinfo", CTLFLAG_RD,
354 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A",
355 "device identification");
356 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree),
357 OID_AUTO, "%parent", CTLFLAG_RD,
358 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A",
363 device_sysctl_update(device_t dev)
365 devclass_t dc = dev->devclass;
367 if (dev->sysctl_tree == NULL)
369 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name));
373 device_sysctl_fini(device_t dev)
375 if (dev->sysctl_tree == NULL)
377 sysctl_ctx_free(&dev->sysctl_ctx);
378 dev->sysctl_tree = NULL;
382 * /dev/devctl implementation
386 * This design allows only one reader for /dev/devctl. This is not desirable
387 * in the long run, but will get a lot of hair out of this implementation.
388 * Maybe we should make this device a clonable device.
390 * Also note: we specifically do not attach a device to the device_t tree
391 * to avoid potential chicken and egg problems. One could argue that all
392 * of this belongs to the root node. One could also further argue that the
393 * sysctl interface that we have not might more properly be an ioctl
394 * interface, but at this stage of the game, I'm not inclined to rock that
397 * I'm also not sure that the SIGIO support is done correctly or not, as
398 * I copied it from a driver that had SIGIO support that likely hasn't been
399 * tested since 3.4 or 2.2.8!
402 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
403 static int devctl_disable = 0;
404 TUNABLE_INT("hw.bus.devctl_disable", &devctl_disable);
405 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, NULL,
406 0, sysctl_devctl_disable, "I", "devctl disable");
408 static d_open_t devopen;
409 static d_close_t devclose;
410 static d_read_t devread;
411 static d_ioctl_t devioctl;
412 static d_poll_t devpoll;
414 static struct cdevsw dev_cdevsw = {
415 .d_version = D_VERSION,
424 struct dev_event_info
427 TAILQ_ENTRY(dev_event_info) dei_link;
430 TAILQ_HEAD(devq, dev_event_info);
432 static struct dev_softc
440 struct proc *async_proc;
443 static struct cdev *devctl_dev;
448 devctl_dev = make_dev(&dev_cdevsw, 0, UID_ROOT, GID_WHEEL, 0600,
450 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF);
451 cv_init(&devsoftc.cv, "dev cv");
452 TAILQ_INIT(&devsoftc.devq);
456 devopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
462 devsoftc.nonblock = 0;
463 devsoftc.async_proc = NULL;
468 devclose(struct cdev *dev, int fflag, int devtype, struct thread *td)
471 mtx_lock(&devsoftc.mtx);
472 cv_broadcast(&devsoftc.cv);
473 mtx_unlock(&devsoftc.mtx);
479 * The read channel for this device is used to report changes to
480 * userland in realtime. We are required to free the data as well as
481 * the n1 object because we allocate them separately. Also note that
482 * we return one record at a time. If you try to read this device a
483 * character at a time, you will lose the rest of the data. Listening
484 * programs are expected to cope.
487 devread(struct cdev *dev, struct uio *uio, int ioflag)
489 struct dev_event_info *n1;
492 mtx_lock(&devsoftc.mtx);
493 while (TAILQ_EMPTY(&devsoftc.devq)) {
494 if (devsoftc.nonblock) {
495 mtx_unlock(&devsoftc.mtx);
498 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx);
501 * Need to translate ERESTART to EINTR here? -- jake
503 mtx_unlock(&devsoftc.mtx);
507 n1 = TAILQ_FIRST(&devsoftc.devq);
508 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
509 mtx_unlock(&devsoftc.mtx);
510 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
511 free(n1->dei_data, M_BUS);
517 devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
523 devsoftc.nonblock = 1;
525 devsoftc.nonblock = 0;
529 devsoftc.async_proc = td->td_proc;
531 devsoftc.async_proc = NULL;
534 /* (un)Support for other fcntl() calls. */
547 devpoll(struct cdev *dev, int events, struct thread *td)
551 mtx_lock(&devsoftc.mtx);
552 if (events & (POLLIN | POLLRDNORM)) {
553 if (!TAILQ_EMPTY(&devsoftc.devq))
554 revents = events & (POLLIN | POLLRDNORM);
556 selrecord(td, &devsoftc.sel);
558 mtx_unlock(&devsoftc.mtx);
564 * @brief Return whether the userland process is running
567 devctl_process_running(void)
569 return (devsoftc.inuse == 1);
573 * @brief Queue data to be read from the devctl device
575 * Generic interface to queue data to the devctl device. It is
576 * assumed that @p data is properly formatted. It is further assumed
577 * that @p data is allocated using the M_BUS malloc type.
580 devctl_queue_data(char *data)
582 struct dev_event_info *n1 = NULL;
586 * Do not allow empty strings to be queued, as they
587 * cause devd to exit prematurely.
589 if (strlen(data) == 0)
591 n1 = malloc(sizeof(*n1), M_BUS, M_NOWAIT);
595 mtx_lock(&devsoftc.mtx);
596 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
597 cv_broadcast(&devsoftc.cv);
598 mtx_unlock(&devsoftc.mtx);
599 selwakeup(&devsoftc.sel);
600 p = devsoftc.async_proc;
609 * @brief Send a 'notification' to userland, using standard ways
612 devctl_notify(const char *system, const char *subsystem, const char *type,
619 return; /* BOGUS! Must specify system. */
620 if (subsystem == NULL)
621 return; /* BOGUS! Must specify subsystem. */
623 return; /* BOGUS! Must specify type. */
624 len += strlen(" system=") + strlen(system);
625 len += strlen(" subsystem=") + strlen(subsystem);
626 len += strlen(" type=") + strlen(type);
627 /* add in the data message plus newline. */
630 len += 3; /* '!', '\n', and NUL */
631 msg = malloc(len, M_BUS, M_NOWAIT);
633 return; /* Drop it on the floor */
635 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
636 system, subsystem, type, data);
638 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
639 system, subsystem, type);
640 devctl_queue_data(msg);
644 * Common routine that tries to make sending messages as easy as possible.
645 * We allocate memory for the data, copy strings into that, but do not
646 * free it unless there's an error. The dequeue part of the driver should
647 * free the data. We don't send data when the device is disabled. We do
648 * send data, even when we have no listeners, because we wish to avoid
649 * races relating to startup and restart of listening applications.
651 * devaddq is designed to string together the type of event, with the
652 * object of that event, plus the plug and play info and location info
653 * for that event. This is likely most useful for devices, but less
654 * useful for other consumers of this interface. Those should use
655 * the devctl_queue_data() interface instead.
658 devaddq(const char *type, const char *what, device_t dev)
667 data = malloc(1024, M_BUS, M_NOWAIT);
671 /* get the bus specific location of this device */
672 loc = malloc(1024, M_BUS, M_NOWAIT);
676 bus_child_location_str(dev, loc, 1024);
678 /* Get the bus specific pnp info of this device */
679 pnp = malloc(1024, M_BUS, M_NOWAIT);
683 bus_child_pnpinfo_str(dev, pnp, 1024);
685 /* Get the parent of this device, or / if high enough in the tree. */
686 if (device_get_parent(dev) == NULL)
687 parstr = "."; /* Or '/' ? */
689 parstr = device_get_nameunit(device_get_parent(dev));
690 /* String it all together. */
691 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
695 devctl_queue_data(data);
705 * A device was added to the tree. We are called just after it successfully
706 * attaches (that is, probe and attach success for this device). No call
707 * is made if a device is merely parented into the tree. See devnomatch
708 * if probe fails. If attach fails, no notification is sent (but maybe
709 * we should have a different message for this).
712 devadded(device_t dev)
717 pnp = malloc(1024, M_BUS, M_NOWAIT);
720 tmp = malloc(1024, M_BUS, M_NOWAIT);
724 bus_child_pnpinfo_str(dev, pnp, 1024);
725 snprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
726 devaddq("+", tmp, dev);
736 * A device was removed from the tree. We are called just before this
740 devremoved(device_t dev)
745 pnp = malloc(1024, M_BUS, M_NOWAIT);
748 tmp = malloc(1024, M_BUS, M_NOWAIT);
752 bus_child_pnpinfo_str(dev, pnp, 1024);
753 snprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
754 devaddq("-", tmp, dev);
764 * Called when there's no match for this device. This is only called
765 * the first time that no match happens, so we don't keep getting this
766 * message. Should that prove to be undesirable, we can change it.
767 * This is called when all drivers that can attach to a given bus
768 * decline to accept this device. Other errrors may not be detected.
771 devnomatch(device_t dev)
773 devaddq("?", "", dev);
777 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
779 struct dev_event_info *n1;
782 dis = devctl_disable;
783 error = sysctl_handle_int(oidp, &dis, 0, req);
784 if (error || !req->newptr)
786 mtx_lock(&devsoftc.mtx);
787 devctl_disable = dis;
789 while (!TAILQ_EMPTY(&devsoftc.devq)) {
790 n1 = TAILQ_FIRST(&devsoftc.devq);
791 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
792 free(n1->dei_data, M_BUS);
796 mtx_unlock(&devsoftc.mtx);
800 /* End of /dev/devctl code */
802 static TAILQ_HEAD(,device) bus_data_devices;
803 static int bus_data_generation = 1;
805 static kobj_method_t null_methods[] = {
809 DEFINE_CLASS(null, null_methods, 0);
812 * Bus pass implementation
815 static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes);
816 int bus_current_pass = BUS_PASS_ROOT;
820 * @brief Register the pass level of a new driver attachment
822 * Register a new driver attachment's pass level. If no driver
823 * attachment with the same pass level has been added, then @p new
824 * will be added to the global passes list.
826 * @param new the new driver attachment
829 driver_register_pass(struct driverlink *new)
831 struct driverlink *dl;
833 /* We only consider pass numbers during boot. */
834 if (bus_current_pass == BUS_PASS_DEFAULT)
838 * Walk the passes list. If we already know about this pass
839 * then there is nothing to do. If we don't, then insert this
840 * driver link into the list.
842 TAILQ_FOREACH(dl, &passes, passlink) {
843 if (dl->pass < new->pass)
845 if (dl->pass == new->pass)
847 TAILQ_INSERT_BEFORE(dl, new, passlink);
850 TAILQ_INSERT_TAIL(&passes, new, passlink);
854 * @brief Raise the current bus pass
856 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS()
857 * method on the root bus to kick off a new device tree scan for each
858 * new pass level that has at least one driver.
861 bus_set_pass(int pass)
863 struct driverlink *dl;
865 if (bus_current_pass > pass)
866 panic("Attempt to lower bus pass level");
868 TAILQ_FOREACH(dl, &passes, passlink) {
869 /* Skip pass values below the current pass level. */
870 if (dl->pass <= bus_current_pass)
874 * Bail once we hit a driver with a pass level that is
881 * Raise the pass level to the next level and rescan
884 bus_current_pass = dl->pass;
885 BUS_NEW_PASS(root_bus);
889 * If there isn't a driver registered for the requested pass,
890 * then bus_current_pass might still be less than 'pass'. Set
891 * it to 'pass' in that case.
893 if (bus_current_pass < pass)
894 bus_current_pass = pass;
895 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level"));
899 * Devclass implementation
902 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
906 * @brief Find or create a device class
908 * If a device class with the name @p classname exists, return it,
909 * otherwise if @p create is non-zero create and return a new device
912 * If @p parentname is non-NULL, the parent of the devclass is set to
913 * the devclass of that name.
915 * @param classname the devclass name to find or create
916 * @param parentname the parent devclass name or @c NULL
917 * @param create non-zero to create a devclass
920 devclass_find_internal(const char *classname, const char *parentname,
925 PDEBUG(("looking for %s", classname));
929 TAILQ_FOREACH(dc, &devclasses, link) {
930 if (!strcmp(dc->name, classname))
935 PDEBUG(("creating %s", classname));
936 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
937 M_BUS, M_NOWAIT|M_ZERO);
941 dc->name = (char*) (dc + 1);
942 strcpy(dc->name, classname);
943 TAILQ_INIT(&dc->drivers);
944 TAILQ_INSERT_TAIL(&devclasses, dc, link);
946 bus_data_generation_update();
950 * If a parent class is specified, then set that as our parent so
951 * that this devclass will support drivers for the parent class as
952 * well. If the parent class has the same name don't do this though
953 * as it creates a cycle that can trigger an infinite loop in
954 * device_probe_child() if a device exists for which there is no
957 if (parentname && dc && !dc->parent &&
958 strcmp(classname, parentname) != 0) {
959 dc->parent = devclass_find_internal(parentname, NULL, TRUE);
960 dc->parent->flags |= DC_HAS_CHILDREN;
967 * @brief Create a device class
969 * If a device class with the name @p classname exists, return it,
970 * otherwise create and return a new device class.
972 * @param classname the devclass name to find or create
975 devclass_create(const char *classname)
977 return (devclass_find_internal(classname, NULL, TRUE));
981 * @brief Find a device class
983 * If a device class with the name @p classname exists, return it,
984 * otherwise return @c NULL.
986 * @param classname the devclass name to find
989 devclass_find(const char *classname)
991 return (devclass_find_internal(classname, NULL, FALSE));
995 * @brief Register that a device driver has been added to a devclass
997 * Register that a device driver has been added to a devclass. This
998 * is called by devclass_add_driver to accomplish the recursive
999 * notification of all the children classes of dc, as well as dc.
1000 * Each layer will have BUS_DRIVER_ADDED() called for all instances of
1001 * the devclass. We do a full search here of the devclass list at
1002 * each iteration level to save storing children-lists in the devclass
1003 * structure. If we ever move beyond a few dozen devices doing this,
1004 * we may need to reevaluate...
1006 * @param dc the devclass to edit
1007 * @param driver the driver that was just added
1010 devclass_driver_added(devclass_t dc, driver_t *driver)
1016 * Call BUS_DRIVER_ADDED for any existing busses in this class.
1018 for (i = 0; i < dc->maxunit; i++)
1020 BUS_DRIVER_ADDED(dc->devices[i], driver);
1023 * Walk through the children classes. Since we only keep a
1024 * single parent pointer around, we walk the entire list of
1025 * devclasses looking for children. We set the
1026 * DC_HAS_CHILDREN flag when a child devclass is created on
1027 * the parent, so we only walk the list for those devclasses
1028 * that have children.
1030 if (!(dc->flags & DC_HAS_CHILDREN))
1033 TAILQ_FOREACH(dc, &devclasses, link) {
1034 if (dc->parent == parent)
1035 devclass_driver_added(dc, driver);
1040 * @brief Add a device driver to a device class
1042 * Add a device driver to a devclass. This is normally called
1043 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of
1044 * all devices in the devclass will be called to allow them to attempt
1045 * to re-probe any unmatched children.
1047 * @param dc the devclass to edit
1048 * @param driver the driver to register
1051 devclass_add_driver(devclass_t dc, driver_t *driver, int pass)
1055 PDEBUG(("%s", DRIVERNAME(driver)));
1057 /* Don't allow invalid pass values. */
1058 if (pass <= BUS_PASS_ROOT)
1061 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
1066 * Compile the driver's methods. Also increase the reference count
1067 * so that the class doesn't get freed when the last instance
1068 * goes. This means we can safely use static methods and avoids a
1069 * double-free in devclass_delete_driver.
1071 kobj_class_compile((kobj_class_t) driver);
1074 * Make sure the devclass which the driver is implementing exists.
1076 devclass_find_internal(driver->name, NULL, 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 Delete a device driver from a device class
1092 * Delete a device driver from a devclass. This is normally called
1093 * automatically by DRIVER_MODULE().
1095 * If the driver is currently attached to any devices,
1096 * devclass_delete_driver() will first attempt to detach from each
1097 * device. If one of the detach calls fails, the driver will not be
1100 * @param dc the devclass to edit
1101 * @param driver the driver to unregister
1104 devclass_delete_driver(devclass_t busclass, driver_t *driver)
1106 devclass_t dc = devclass_find(driver->name);
1112 NBL_ASSERT(SA_XLOCKED);
1113 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1119 * Find the link structure in the bus' list of drivers.
1121 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1122 if (dl->driver == driver)
1127 PDEBUG(("%s not found in %s list", driver->name,
1133 * Disassociate from any devices. We iterate through all the
1134 * devices in the devclass of the driver and detach any which are
1135 * using the driver and which have a parent in the devclass which
1136 * we are deleting from.
1138 * Note that since a driver can be in multiple devclasses, we
1139 * should not detach devices which are not children of devices in
1140 * the affected devclass.
1142 for (i = 0; i < dc->maxunit; i++) {
1143 if (dc->devices[i]) {
1144 dev = dc->devices[i];
1145 if (dev->driver == driver && dev->parent &&
1146 dev->parent->devclass == busclass) {
1147 if ((error = device_detach(dev)) != 0)
1149 device_set_driver(dev, NULL);
1154 TAILQ_REMOVE(&busclass->drivers, dl, link);
1159 if (driver->refs == 0)
1160 kobj_class_free((kobj_class_t) driver);
1162 bus_data_generation_update();
1167 * @brief Quiesces a set of device drivers from a device class
1169 * Quiesce a device driver from a devclass. This is normally called
1170 * automatically by DRIVER_MODULE().
1172 * If the driver is currently attached to any devices,
1173 * devclass_quiesece_driver() will first attempt to quiesce each
1176 * @param dc the devclass to edit
1177 * @param driver the driver to unregister
1180 devclass_quiesce_driver(devclass_t busclass, driver_t *driver)
1182 devclass_t dc = devclass_find(driver->name);
1188 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
1194 * Find the link structure in the bus' list of drivers.
1196 TAILQ_FOREACH(dl, &busclass->drivers, link) {
1197 if (dl->driver == driver)
1202 PDEBUG(("%s not found in %s list", driver->name,
1208 * Quiesce all devices. We iterate through all the devices in
1209 * the devclass of the driver and quiesce any which are using
1210 * the driver and which have a parent in the devclass which we
1213 * Note that since a driver can be in multiple devclasses, we
1214 * should not quiesce devices which are not children of
1215 * devices in the affected devclass.
1217 for (i = 0; i < dc->maxunit; i++) {
1218 if (dc->devices[i]) {
1219 dev = dc->devices[i];
1220 if (dev->driver == driver && dev->parent &&
1221 dev->parent->devclass == busclass) {
1222 if ((error = device_quiesce(dev)) != 0)
1235 devclass_find_driver_internal(devclass_t dc, const char *classname)
1239 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
1241 TAILQ_FOREACH(dl, &dc->drivers, link) {
1242 if (!strcmp(dl->driver->name, classname))
1246 PDEBUG(("not found"));
1251 * @brief Return the name of the devclass
1254 devclass_get_name(devclass_t dc)
1260 * @brief Find a device given a unit number
1262 * @param dc the devclass to search
1263 * @param unit the unit number to search for
1265 * @returns the device with the given unit number or @c
1266 * NULL if there is no such device
1269 devclass_get_device(devclass_t dc, int unit)
1271 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
1273 return (dc->devices[unit]);
1277 * @brief Find the softc field of a device given a unit number
1279 * @param dc the devclass to search
1280 * @param unit the unit number to search for
1282 * @returns the softc field of the device with the given
1283 * unit number or @c NULL if there is no such
1287 devclass_get_softc(devclass_t dc, int unit)
1291 dev = devclass_get_device(dc, unit);
1295 return (device_get_softc(dev));
1299 * @brief Get a list of devices in the devclass
1301 * An array containing a list of all the devices in the given devclass
1302 * is allocated and returned in @p *devlistp. The number of devices
1303 * in the array is returned in @p *devcountp. The caller should free
1304 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0.
1306 * @param dc the devclass to examine
1307 * @param devlistp points at location for array pointer return
1309 * @param devcountp points at location for array size return value
1312 * @retval ENOMEM the array allocation failed
1315 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
1320 count = devclass_get_count(dc);
1321 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
1326 for (i = 0; i < dc->maxunit; i++) {
1327 if (dc->devices[i]) {
1328 list[count] = dc->devices[i];
1340 * @brief Get a list of drivers in the devclass
1342 * An array containing a list of pointers to all the drivers in the
1343 * given devclass is allocated and returned in @p *listp. The number
1344 * of drivers in the array is returned in @p *countp. The caller should
1345 * free the array using @c free(p, M_TEMP).
1347 * @param dc the devclass to examine
1348 * @param listp gives location for array pointer return value
1349 * @param countp gives location for number of array elements
1353 * @retval ENOMEM the array allocation failed
1356 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
1363 TAILQ_FOREACH(dl, &dc->drivers, link)
1365 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
1370 TAILQ_FOREACH(dl, &dc->drivers, link) {
1371 list[count] = dl->driver;
1381 * @brief Get the number of devices in a devclass
1383 * @param dc the devclass to examine
1386 devclass_get_count(devclass_t dc)
1391 for (i = 0; i < dc->maxunit; i++)
1398 * @brief Get the maximum unit number used in a devclass
1400 * Note that this is one greater than the highest currently-allocated
1401 * unit. If a null devclass_t is passed in, -1 is returned to indicate
1402 * that not even the devclass has been allocated yet.
1404 * @param dc the devclass to examine
1407 devclass_get_maxunit(devclass_t dc)
1411 return (dc->maxunit);
1415 * @brief Find a free unit number in a devclass
1417 * This function searches for the first unused unit number greater
1418 * that or equal to @p unit.
1420 * @param dc the devclass to examine
1421 * @param unit the first unit number to check
1424 devclass_find_free_unit(devclass_t dc, int unit)
1428 while (unit < dc->maxunit && dc->devices[unit] != NULL)
1434 * @brief Set the parent of a devclass
1436 * The parent class is normally initialised automatically by
1439 * @param dc the devclass to edit
1440 * @param pdc the new parent devclass
1443 devclass_set_parent(devclass_t dc, devclass_t pdc)
1449 * @brief Get the parent of a devclass
1451 * @param dc the devclass to examine
1454 devclass_get_parent(devclass_t dc)
1456 return (dc->parent);
1459 struct sysctl_ctx_list *
1460 devclass_get_sysctl_ctx(devclass_t dc)
1462 return (&dc->sysctl_ctx);
1466 devclass_get_sysctl_tree(devclass_t dc)
1468 return (dc->sysctl_tree);
1473 * @brief Allocate a unit number
1475 * On entry, @p *unitp is the desired unit number (or @c -1 if any
1476 * will do). The allocated unit number is returned in @p *unitp.
1478 * @param dc the devclass to allocate from
1479 * @param unitp points at the location for the allocated unit
1483 * @retval EEXIST the requested unit number is already allocated
1484 * @retval ENOMEM memory allocation failure
1487 devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp)
1492 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
1494 /* Ask the parent bus if it wants to wire this device. */
1496 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name,
1499 /* If we were given a wired unit number, check for existing device */
1502 if (unit >= 0 && unit < dc->maxunit &&
1503 dc->devices[unit] != NULL) {
1505 printf("%s: %s%d already exists; skipping it\n",
1506 dc->name, dc->name, *unitp);
1510 /* Unwired device, find the next available slot for it */
1512 for (unit = 0;; unit++) {
1513 /* If there is an "at" hint for a unit then skip it. */
1514 if (resource_string_value(dc->name, unit, "at", &s) ==
1518 /* If this device slot is already in use, skip it. */
1519 if (unit < dc->maxunit && dc->devices[unit] != NULL)
1527 * We've selected a unit beyond the length of the table, so let's
1528 * extend the table to make room for all units up to and including
1531 if (unit >= dc->maxunit) {
1532 device_t *newlist, *oldlist;
1535 oldlist = dc->devices;
1536 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
1537 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
1540 if (oldlist != NULL)
1541 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit);
1542 bzero(newlist + dc->maxunit,
1543 sizeof(device_t) * (newsize - dc->maxunit));
1544 dc->devices = newlist;
1545 dc->maxunit = newsize;
1546 if (oldlist != NULL)
1547 free(oldlist, M_BUS);
1549 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
1557 * @brief Add a device to a devclass
1559 * A unit number is allocated for the device (using the device's
1560 * preferred unit number if any) and the device is registered in the
1561 * devclass. This allows the device to be looked up by its unit
1562 * number, e.g. by decoding a dev_t minor number.
1564 * @param dc the devclass to add to
1565 * @param dev the device to add
1568 * @retval EEXIST the requested unit number is already allocated
1569 * @retval ENOMEM memory allocation failure
1572 devclass_add_device(devclass_t dc, device_t dev)
1576 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1578 buflen = snprintf(NULL, 0, "%s%d$", dc->name, dev->unit);
1581 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
1585 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) {
1586 free(dev->nameunit, M_BUS);
1587 dev->nameunit = NULL;
1590 dc->devices[dev->unit] = dev;
1592 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
1599 * @brief Delete a device from a devclass
1601 * The device is removed from the devclass's device list and its unit
1604 * @param dc the devclass to delete from
1605 * @param dev the device to delete
1610 devclass_delete_device(devclass_t dc, device_t dev)
1615 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
1617 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
1618 panic("devclass_delete_device: inconsistent device class");
1619 dc->devices[dev->unit] = NULL;
1620 if (dev->flags & DF_WILDCARD)
1622 dev->devclass = NULL;
1623 free(dev->nameunit, M_BUS);
1624 dev->nameunit = NULL;
1631 * @brief Make a new device and add it as a child of @p parent
1633 * @param parent the parent of the new device
1634 * @param name the devclass name of the new device or @c NULL
1635 * to leave the devclass unspecified
1636 * @parem unit the unit number of the new device of @c -1 to
1637 * leave the unit number unspecified
1639 * @returns the new device
1642 make_device(device_t parent, const char *name, int unit)
1647 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1650 dc = devclass_find_internal(name, NULL, TRUE);
1652 printf("make_device: can't find device class %s\n",
1660 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
1664 dev->parent = parent;
1665 TAILQ_INIT(&dev->children);
1666 kobj_init((kobj_t) dev, &null_class);
1668 dev->devclass = NULL;
1670 dev->nameunit = NULL;
1674 dev->flags = DF_ENABLED;
1677 dev->flags |= DF_WILDCARD;
1679 dev->flags |= DF_FIXEDCLASS;
1680 if (devclass_add_device(dc, dev)) {
1681 kobj_delete((kobj_t) dev, M_BUS);
1688 dev->state = DS_NOTPRESENT;
1690 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1691 bus_data_generation_update();
1698 * @brief Print a description of a device.
1701 device_print_child(device_t dev, device_t child)
1705 if (device_is_alive(child))
1706 retval += BUS_PRINT_CHILD(dev, child);
1708 retval += device_printf(child, " not found\n");
1714 * @brief Create a new device
1716 * This creates a new device and adds it as a child of an existing
1717 * parent device. The new device will be added after the last existing
1718 * child with order zero.
1720 * @param dev the device which will be the parent of the
1722 * @param name devclass name for new device or @c NULL if not
1724 * @param unit unit number for new device or @c -1 if not
1727 * @returns the new device
1730 device_add_child(device_t dev, const char *name, int unit)
1732 return (device_add_child_ordered(dev, 0, name, unit));
1736 * @brief Create a new device
1738 * This creates a new device and adds it as a child of an existing
1739 * parent device. The new device will be added after the last existing
1740 * child with the same order.
1742 * @param dev the device which will be the parent of the
1744 * @param order a value which is used to partially sort the
1745 * children of @p dev - devices created using
1746 * lower values of @p order appear first in @p
1747 * dev's list of children
1748 * @param name devclass name for new device or @c NULL if not
1750 * @param unit unit number for new device or @c -1 if not
1753 * @returns the new device
1756 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1761 PDEBUG(("%s at %s with order %d as unit %d",
1762 name, DEVICENAME(dev), order, unit));
1764 child = make_device(dev, name, unit);
1767 child->order = order;
1769 TAILQ_FOREACH(place, &dev->children, link) {
1770 if (place->order > order)
1776 * The device 'place' is the first device whose order is
1777 * greater than the new child.
1779 TAILQ_INSERT_BEFORE(place, child, link);
1782 * The new child's order is greater or equal to the order of
1783 * any existing device. Add the child to the tail of the list.
1785 TAILQ_INSERT_TAIL(&dev->children, child, link);
1788 bus_data_generation_update();
1793 * @brief Delete a device
1795 * This function deletes a device along with all of its children. If
1796 * the device currently has a driver attached to it, the device is
1797 * detached first using device_detach().
1799 * @param dev the parent device
1800 * @param child the device to delete
1803 * @retval non-zero a unit error code describing the error
1806 device_delete_child(device_t dev, device_t child)
1809 device_t grandchild;
1811 NBL_ASSERT(SA_XLOCKED);
1812 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1814 /* remove children first */
1815 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1816 error = device_delete_child(child, grandchild);
1821 if ((error = device_detach(child)) != 0)
1823 if (child->devclass)
1824 devclass_delete_device(child->devclass, child);
1825 TAILQ_REMOVE(&dev->children, child, link);
1826 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1827 kobj_delete((kobj_t) child, M_BUS);
1829 bus_data_generation_update();
1834 * @brief Find a device given a unit number
1836 * This is similar to devclass_get_devices() but only searches for
1837 * devices which have @p dev as a parent.
1839 * @param dev the parent device to search
1840 * @param unit the unit number to search for. If the unit is -1,
1841 * return the first child of @p dev which has name
1842 * @p classname (that is, the one with the lowest unit.)
1844 * @returns the device with the given unit number or @c
1845 * NULL if there is no such device
1848 device_find_child(device_t dev, const char *classname, int unit)
1853 dc = devclass_find(classname);
1858 child = devclass_get_device(dc, unit);
1859 if (child && child->parent == dev)
1862 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1863 child = devclass_get_device(dc, unit);
1864 if (child && child->parent == dev)
1875 first_matching_driver(devclass_t dc, device_t dev)
1878 return (devclass_find_driver_internal(dc, dev->devclass->name));
1879 return (TAILQ_FIRST(&dc->drivers));
1886 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1888 if (dev->devclass) {
1890 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1891 if (!strcmp(dev->devclass->name, dl->driver->name))
1895 return (TAILQ_NEXT(last, link));
1902 device_probe_child(device_t dev, device_t child)
1905 driverlink_t best = NULL;
1907 int result, pri = 0;
1908 int hasclass = (child->devclass != NULL);
1910 NBL_ASSERT(SA_XLOCKED);
1914 panic("device_probe_child: parent device has no devclass");
1917 * If the state is already probed, then return. However, don't
1918 * return if we can rebid this object.
1920 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0)
1923 for (; dc; dc = dc->parent) {
1924 for (dl = first_matching_driver(dc, child);
1926 dl = next_matching_driver(dc, child, dl)) {
1928 /* If this driver's pass is too high, then ignore it. */
1929 if (dl->pass > bus_current_pass)
1932 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1933 device_set_driver(child, dl->driver);
1935 if (device_set_devclass(child, dl->driver->name)) {
1936 printf("driver bug: Unable to set devclass (devname: %s)\n",
1937 (child ? device_get_name(child) :
1939 device_set_driver(child, NULL);
1944 /* Fetch any flags for the device before probing. */
1945 resource_int_value(dl->driver->name, child->unit,
1946 "flags", &child->devflags);
1948 result = DEVICE_PROBE(child);
1950 /* Reset flags and devclass before the next probe. */
1951 child->devflags = 0;
1953 device_set_devclass(child, NULL);
1956 * If the driver returns SUCCESS, there can be
1957 * no higher match for this device.
1966 * The driver returned an error so it
1967 * certainly doesn't match.
1970 device_set_driver(child, NULL);
1975 * A priority lower than SUCCESS, remember the
1976 * best matching driver. Initialise the value
1977 * of pri for the first match.
1979 if (best == NULL || result > pri) {
1981 * Probes that return BUS_PROBE_NOWILDCARD
1982 * or lower only match when they are set
1983 * in stone by the parent bus.
1985 if (result <= BUS_PROBE_NOWILDCARD &&
1986 child->flags & DF_WILDCARD)
1994 * If we have an unambiguous match in this devclass,
1995 * don't look in the parent.
1997 if (best && pri == 0)
2002 * If we found a driver, change state and initialise the devclass.
2004 /* XXX What happens if we rebid and got no best? */
2007 * If this device was atached, and we were asked to
2008 * rescan, and it is a different driver, then we have
2009 * to detach the old driver and reattach this new one.
2010 * Note, we don't have to check for DF_REBID here
2011 * because if the state is > DS_ALIVE, we know it must
2014 * This assumes that all DF_REBID drivers can have
2015 * their probe routine called at any time and that
2016 * they are idempotent as well as completely benign in
2017 * normal operations.
2019 * We also have to make sure that the detach
2020 * succeeded, otherwise we fail the operation (or
2021 * maybe it should just fail silently? I'm torn).
2023 if (child->state > DS_ALIVE && best->driver != child->driver)
2024 if ((result = device_detach(dev)) != 0)
2027 /* Set the winning driver, devclass, and flags. */
2028 if (!child->devclass) {
2029 result = device_set_devclass(child, best->driver->name);
2033 device_set_driver(child, best->driver);
2034 resource_int_value(best->driver->name, child->unit,
2035 "flags", &child->devflags);
2039 * A bit bogus. Call the probe method again to make
2040 * sure that we have the right description.
2042 DEVICE_PROBE(child);
2044 child->flags |= DF_REBID;
2047 child->flags &= ~DF_REBID;
2048 child->state = DS_ALIVE;
2050 bus_data_generation_update();
2058 * @brief Return the parent of a device
2061 device_get_parent(device_t dev)
2063 return (dev->parent);
2067 * @brief Get a list of children of a device
2069 * An array containing a list of all the children of the given device
2070 * is allocated and returned in @p *devlistp. The number of devices
2071 * in the array is returned in @p *devcountp. The caller should free
2072 * the array using @c free(p, M_TEMP).
2074 * @param dev the device to examine
2075 * @param devlistp points at location for array pointer return
2077 * @param devcountp points at location for array size return value
2080 * @retval ENOMEM the array allocation failed
2083 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
2090 TAILQ_FOREACH(child, &dev->children, link) {
2094 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
2099 TAILQ_FOREACH(child, &dev->children, link) {
2100 list[count] = child;
2111 * @brief Return the current driver for the device or @c NULL if there
2112 * is no driver currently attached
2115 device_get_driver(device_t dev)
2117 return (dev->driver);
2121 * @brief Return the current devclass for the device or @c NULL if
2125 device_get_devclass(device_t dev)
2127 return (dev->devclass);
2131 * @brief Return the name of the device's devclass or @c NULL if there
2135 device_get_name(device_t dev)
2137 if (dev != NULL && dev->devclass)
2138 return (devclass_get_name(dev->devclass));
2143 * @brief Return a string containing the device's devclass name
2144 * followed by an ascii representation of the device's unit number
2148 device_get_nameunit(device_t dev)
2150 return (dev->nameunit);
2154 * @brief Return the device's unit number.
2157 device_get_unit(device_t dev)
2163 * @brief Return the device's description string
2166 device_get_desc(device_t dev)
2172 * @brief Return the device's flags
2175 device_get_flags(device_t dev)
2177 return (dev->devflags);
2180 struct sysctl_ctx_list *
2181 device_get_sysctl_ctx(device_t dev)
2183 return (&dev->sysctl_ctx);
2187 device_get_sysctl_tree(device_t dev)
2189 return (dev->sysctl_tree);
2193 * @brief Print the name of the device followed by a colon and a space
2195 * @returns the number of characters printed
2198 device_print_prettyname(device_t dev)
2200 const char *name = device_get_name(dev);
2203 return (printf("unknown: "));
2204 return (printf("%s%d: ", name, device_get_unit(dev)));
2208 * @brief Print the name of the device followed by a colon, a space
2209 * and the result of calling vprintf() with the value of @p fmt and
2210 * the following arguments.
2212 * @returns the number of characters printed
2215 device_printf(device_t dev, const char * fmt, ...)
2220 retval = device_print_prettyname(dev);
2222 retval += vprintf(fmt, ap);
2231 device_set_desc_internal(device_t dev, const char* desc, int copy)
2233 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
2234 free(dev->desc, M_BUS);
2235 dev->flags &= ~DF_DESCMALLOCED;
2240 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
2242 strcpy(dev->desc, desc);
2243 dev->flags |= DF_DESCMALLOCED;
2246 /* Avoid a -Wcast-qual warning */
2247 dev->desc = (char *)(uintptr_t) desc;
2250 bus_data_generation_update();
2254 * @brief Set the device's description
2256 * The value of @c desc should be a string constant that will not
2257 * change (at least until the description is changed in a subsequent
2258 * call to device_set_desc() or device_set_desc_copy()).
2261 device_set_desc(device_t dev, const char* desc)
2263 device_set_desc_internal(dev, desc, FALSE);
2267 * @brief Set the device's description
2269 * The string pointed to by @c desc is copied. Use this function if
2270 * the device description is generated, (e.g. with sprintf()).
2273 device_set_desc_copy(device_t dev, const char* desc)
2275 device_set_desc_internal(dev, desc, TRUE);
2279 * @brief Set the device's flags
2282 device_set_flags(device_t dev, u_int32_t flags)
2284 dev->devflags = flags;
2288 * @brief Return the device's softc field
2290 * The softc is allocated and zeroed when a driver is attached, based
2291 * on the size field of the driver.
2294 device_get_softc(device_t dev)
2296 return (dev->softc);
2300 * @brief Set the device's softc field
2302 * Most drivers do not need to use this since the softc is allocated
2303 * automatically when the driver is attached.
2306 device_set_softc(device_t dev, void *softc)
2308 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
2309 free(dev->softc, M_BUS_SC);
2312 dev->flags |= DF_EXTERNALSOFTC;
2314 dev->flags &= ~DF_EXTERNALSOFTC;
2318 * @brief Get the device's ivars field
2320 * The ivars field is used by the parent device to store per-device
2321 * state (e.g. the physical location of the device or a list of
2325 device_get_ivars(device_t dev)
2328 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)"));
2329 return (dev->ivars);
2333 * @brief Set the device's ivars field
2336 device_set_ivars(device_t dev, void * ivars)
2339 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)"));
2344 * @brief Return the device's state
2347 device_get_state(device_t dev)
2349 return (dev->state);
2353 * @brief Set the DF_ENABLED flag for the device
2356 device_enable(device_t dev)
2358 dev->flags |= DF_ENABLED;
2362 * @brief Clear the DF_ENABLED flag for the device
2365 device_disable(device_t dev)
2367 dev->flags &= ~DF_ENABLED;
2371 * @brief Increment the busy counter for the device
2374 device_busy(device_t dev)
2376 if (dev->state < DS_ATTACHED)
2377 panic("device_busy: called for unattached device");
2378 if (dev->busy == 0 && dev->parent)
2379 device_busy(dev->parent);
2381 dev->state = DS_BUSY;
2385 * @brief Decrement the busy counter for the device
2388 device_unbusy(device_t dev)
2390 if (dev->state != DS_BUSY)
2391 panic("device_unbusy: called for non-busy device %s",
2392 device_get_nameunit(dev));
2394 if (dev->busy == 0) {
2396 device_unbusy(dev->parent);
2397 dev->state = DS_ATTACHED;
2402 * @brief Set the DF_QUIET flag for the device
2405 device_quiet(device_t dev)
2407 dev->flags |= DF_QUIET;
2411 * @brief Clear the DF_QUIET flag for the device
2414 device_verbose(device_t dev)
2416 dev->flags &= ~DF_QUIET;
2420 * @brief Return non-zero if the DF_QUIET flag is set on the device
2423 device_is_quiet(device_t dev)
2425 return ((dev->flags & DF_QUIET) != 0);
2429 * @brief Return non-zero if the DF_ENABLED flag is set on the device
2432 device_is_enabled(device_t dev)
2434 return ((dev->flags & DF_ENABLED) != 0);
2438 * @brief Return non-zero if the device was successfully probed
2441 device_is_alive(device_t dev)
2443 return (dev->state >= DS_ALIVE);
2447 * @brief Return non-zero if the device currently has a driver
2451 device_is_attached(device_t dev)
2453 return (dev->state >= DS_ATTACHED);
2457 * @brief Set the devclass of a device
2458 * @see devclass_add_device().
2461 device_set_devclass(device_t dev, const char *classname)
2468 devclass_delete_device(dev->devclass, dev);
2472 if (dev->devclass) {
2473 printf("device_set_devclass: device class already set\n");
2477 dc = devclass_find_internal(classname, NULL, TRUE);
2481 error = devclass_add_device(dc, dev);
2483 bus_data_generation_update();
2488 * @brief Set the driver of a device
2491 * @retval EBUSY the device already has a driver attached
2492 * @retval ENOMEM a memory allocation failure occurred
2495 device_set_driver(device_t dev, driver_t *driver)
2497 if (dev->state >= DS_ATTACHED)
2500 if (dev->driver == driver)
2503 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
2504 free(dev->softc, M_BUS_SC);
2507 kobj_delete((kobj_t) dev, NULL);
2508 dev->driver = driver;
2510 kobj_init((kobj_t) dev, (kobj_class_t) driver);
2511 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) {
2512 dev->softc = malloc(driver->size, M_BUS_SC,
2515 kobj_delete((kobj_t) dev, NULL);
2516 kobj_init((kobj_t) dev, &null_class);
2522 kobj_init((kobj_t) dev, &null_class);
2525 bus_data_generation_update();
2530 * @brief Probe a device, and return this status.
2532 * This function is the core of the device autoconfiguration
2533 * system. Its purpose is to select a suitable driver for a device and
2534 * then call that driver to initialise the hardware appropriately. The
2535 * driver is selected by calling the DEVICE_PROBE() method of a set of
2536 * candidate drivers and then choosing the driver which returned the
2537 * best value. This driver is then attached to the device using
2540 * The set of suitable drivers is taken from the list of drivers in
2541 * the parent device's devclass. If the device was originally created
2542 * with a specific class name (see device_add_child()), only drivers
2543 * with that name are probed, otherwise all drivers in the devclass
2544 * are probed. If no drivers return successful probe values in the
2545 * parent devclass, the search continues in the parent of that
2546 * devclass (see devclass_get_parent()) if any.
2548 * @param dev the device to initialise
2551 * @retval ENXIO no driver was found
2552 * @retval ENOMEM memory allocation failure
2553 * @retval non-zero some other unix error code
2554 * @retval -1 Device already attached
2557 device_probe(device_t dev)
2561 NBL_ASSERT(SA_XLOCKED);
2563 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0)
2566 if (!(dev->flags & DF_ENABLED)) {
2567 if (bootverbose && device_get_name(dev) != NULL) {
2568 device_print_prettyname(dev);
2569 printf("not probed (disabled)\n");
2573 if ((error = device_probe_child(dev->parent, dev)) != 0) {
2574 if (bus_current_pass == BUS_PASS_DEFAULT &&
2575 !(dev->flags & DF_DONENOMATCH)) {
2576 BUS_PROBE_NOMATCH(dev->parent, dev);
2578 dev->flags |= DF_DONENOMATCH;
2586 * @brief Probe a device and attach a driver if possible
2588 * calls device_probe() and attaches if that was successful.
2591 device_probe_and_attach(device_t dev)
2595 NBL_ASSERT(SA_XLOCKED);
2597 error = device_probe(dev);
2600 else if (error != 0)
2602 return (device_attach(dev));
2606 * @brief Attach a device driver to a device
2608 * This function is a wrapper around the DEVICE_ATTACH() driver
2609 * method. In addition to calling DEVICE_ATTACH(), it initialises the
2610 * device's sysctl tree, optionally prints a description of the device
2611 * and queues a notification event for user-based device management
2614 * Normally this function is only called internally from
2615 * device_probe_and_attach().
2617 * @param dev the device to initialise
2620 * @retval ENXIO no driver was found
2621 * @retval ENOMEM memory allocation failure
2622 * @retval non-zero some other unix error code
2625 device_attach(device_t dev)
2629 NBL_ASSERT(SA_XLOCKED);
2631 device_sysctl_init(dev);
2632 if (!device_is_quiet(dev))
2633 device_print_child(dev->parent, dev);
2634 if ((error = DEVICE_ATTACH(dev)) != 0) {
2635 printf("device_attach: %s%d attach returned %d\n",
2636 dev->driver->name, dev->unit, error);
2637 /* Unset the class; set in device_probe_child */
2638 if (dev->devclass == NULL)
2639 device_set_devclass(dev, NULL);
2640 device_set_driver(dev, NULL);
2641 device_sysctl_fini(dev);
2642 dev->state = DS_NOTPRESENT;
2645 device_sysctl_update(dev);
2646 dev->state = DS_ATTACHED;
2652 * @brief Detach a driver from a device
2654 * This function is a wrapper around the DEVICE_DETACH() driver
2655 * method. If the call to DEVICE_DETACH() succeeds, it calls
2656 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a
2657 * notification event for user-based device management services and
2658 * cleans up the device's sysctl tree.
2660 * @param dev the device to un-initialise
2663 * @retval ENXIO no driver was found
2664 * @retval ENOMEM memory allocation failure
2665 * @retval non-zero some other unix error code
2668 device_detach(device_t dev)
2672 NBL_ASSERT(SA_XLOCKED);
2674 PDEBUG(("%s", DEVICENAME(dev)));
2675 if (dev->state == DS_BUSY)
2677 if (dev->state != DS_ATTACHED)
2680 if ((error = DEVICE_DETACH(dev)) != 0)
2683 if (!device_is_quiet(dev))
2684 device_printf(dev, "detached\n");
2686 BUS_CHILD_DETACHED(dev->parent, dev);
2688 if (!(dev->flags & DF_FIXEDCLASS))
2689 devclass_delete_device(dev->devclass, dev);
2691 dev->state = DS_NOTPRESENT;
2692 device_set_driver(dev, NULL);
2693 device_set_desc(dev, NULL);
2694 device_sysctl_fini(dev);
2700 * @brief Tells a driver to quiesce itself.
2702 * This function is a wrapper around the DEVICE_QUIESCE() driver
2703 * method. If the call to DEVICE_QUIESCE() succeeds.
2705 * @param dev the device to quiesce
2708 * @retval ENXIO no driver was found
2709 * @retval ENOMEM memory allocation failure
2710 * @retval non-zero some other unix error code
2713 device_quiesce(device_t dev)
2716 NBL_ASSERT(SA_XLOCKED);
2718 PDEBUG(("%s", DEVICENAME(dev)));
2719 if (dev->state == DS_BUSY)
2721 if (dev->state != DS_ATTACHED)
2724 return (DEVICE_QUIESCE(dev));
2728 * @brief Notify a device of system shutdown
2730 * This function calls the DEVICE_SHUTDOWN() driver method if the
2731 * device currently has an attached driver.
2733 * @returns the value returned by DEVICE_SHUTDOWN()
2736 device_shutdown(device_t dev)
2739 if (dev->state < DS_ATTACHED)
2741 return (DEVICE_SHUTDOWN(dev));
2745 * @brief Set the unit number of a device
2747 * This function can be used to override the unit number used for a
2748 * device (e.g. to wire a device to a pre-configured unit number).
2751 device_set_unit(device_t dev, int unit)
2756 dc = device_get_devclass(dev);
2757 if (unit < dc->maxunit && dc->devices[unit])
2759 err = devclass_delete_device(dc, dev);
2763 err = devclass_add_device(dc, dev);
2767 bus_data_generation_update();
2771 /*======================================*/
2773 * Some useful method implementations to make life easier for bus drivers.
2777 * @brief Initialise a resource list.
2779 * @param rl the resource list to initialise
2782 resource_list_init(struct resource_list *rl)
2788 * @brief Reclaim memory used by a resource list.
2790 * This function frees the memory for all resource entries on the list
2793 * @param rl the resource list to free
2796 resource_list_free(struct resource_list *rl)
2798 struct resource_list_entry *rle;
2800 while ((rle = STAILQ_FIRST(rl)) != NULL) {
2802 panic("resource_list_free: resource entry is busy");
2803 STAILQ_REMOVE_HEAD(rl, link);
2809 * @brief Add a resource entry.
2811 * This function adds a resource entry using the given @p type, @p
2812 * start, @p end and @p count values. A rid value is chosen by
2813 * searching sequentially for the first unused rid starting at zero.
2815 * @param rl the resource list to edit
2816 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2817 * @param start the start address of the resource
2818 * @param end the end address of the resource
2819 * @param count XXX end-start+1
2822 resource_list_add_next(struct resource_list *rl, int type, u_long start,
2823 u_long end, u_long count)
2828 while (resource_list_find(rl, type, rid) != NULL)
2830 resource_list_add(rl, type, rid, start, end, count);
2835 * @brief Add or modify a resource entry.
2837 * If an existing entry exists with the same type and rid, it will be
2838 * modified using the given values of @p start, @p end and @p
2839 * count. If no entry exists, a new one will be created using the
2840 * given values. The resource list entry that matches is then returned.
2842 * @param rl the resource list to edit
2843 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2844 * @param rid the resource identifier
2845 * @param start the start address of the resource
2846 * @param end the end address of the resource
2847 * @param count XXX end-start+1
2849 struct resource_list_entry *
2850 resource_list_add(struct resource_list *rl, int type, int rid,
2851 u_long start, u_long end, u_long count)
2853 struct resource_list_entry *rle;
2855 rle = resource_list_find(rl, type, rid);
2857 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
2860 panic("resource_list_add: can't record entry");
2861 STAILQ_INSERT_TAIL(rl, rle, link);
2868 panic("resource_list_add: resource entry is busy");
2877 * @brief Find a resource entry by type and rid.
2879 * @param rl the resource list to search
2880 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2881 * @param rid the resource identifier
2883 * @returns the resource entry pointer or NULL if there is no such
2886 struct resource_list_entry *
2887 resource_list_find(struct resource_list *rl, int type, int rid)
2889 struct resource_list_entry *rle;
2891 STAILQ_FOREACH(rle, rl, link) {
2892 if (rle->type == type && rle->rid == rid)
2899 * @brief Delete a resource entry.
2901 * @param rl the resource list to edit
2902 * @param type the resource entry type (e.g. SYS_RES_MEMORY)
2903 * @param rid the resource identifier
2906 resource_list_delete(struct resource_list *rl, int type, int rid)
2908 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2911 if (rle->res != NULL)
2912 panic("resource_list_delete: resource has not been released");
2913 STAILQ_REMOVE(rl, rle, resource_list_entry, link);
2919 * @brief Helper function for implementing BUS_ALLOC_RESOURCE()
2921 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list
2922 * and passing the allocation up to the parent of @p bus. This assumes
2923 * that the first entry of @c device_get_ivars(child) is a struct
2924 * resource_list. This also handles 'passthrough' allocations where a
2925 * child is a remote descendant of bus by passing the allocation up to
2926 * the parent of bus.
2928 * Typically, a bus driver would store a list of child resources
2929 * somewhere in the child device's ivars (see device_get_ivars()) and
2930 * its implementation of BUS_ALLOC_RESOURCE() would find that list and
2931 * then call resource_list_alloc() to perform the allocation.
2933 * @param rl the resource list to allocate from
2934 * @param bus the parent device of @p child
2935 * @param child the device which is requesting an allocation
2936 * @param type the type of resource to allocate
2937 * @param rid a pointer to the resource identifier
2938 * @param start hint at the start of the resource range - pass
2939 * @c 0UL for any start address
2940 * @param end hint at the end of the resource range - pass
2941 * @c ~0UL for any end address
2942 * @param count hint at the size of range required - pass @c 1
2944 * @param flags any extra flags to control the resource
2945 * allocation - see @c RF_XXX flags in
2946 * <sys/rman.h> for details
2948 * @returns the resource which was allocated or @c NULL if no
2949 * resource could be allocated
2952 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
2953 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
2955 struct resource_list_entry *rle = NULL;
2956 int passthrough = (device_get_parent(child) != bus);
2957 int isdefault = (start == 0UL && end == ~0UL);
2960 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2961 type, rid, start, end, count, flags));
2964 rle = resource_list_find(rl, type, *rid);
2967 return (NULL); /* no resource of that type/rid */
2970 panic("resource_list_alloc: resource entry is busy");
2974 count = ulmax(count, rle->count);
2975 end = ulmax(rle->end, start + count - 1);
2978 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2979 type, rid, start, end, count, flags);
2982 * Record the new range.
2985 rle->start = rman_get_start(rle->res);
2986 rle->end = rman_get_end(rle->res);
2994 * @brief Helper function for implementing BUS_RELEASE_RESOURCE()
2996 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally
2997 * used with resource_list_alloc().
2999 * @param rl the resource list which was allocated from
3000 * @param bus the parent device of @p child
3001 * @param child the device which is requesting a release
3002 * @param type the type of resource to allocate
3003 * @param rid the resource identifier
3004 * @param res the resource to release
3007 * @retval non-zero a standard unix error code indicating what
3008 * error condition prevented the operation
3011 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
3012 int type, int rid, struct resource *res)
3014 struct resource_list_entry *rle = NULL;
3015 int passthrough = (device_get_parent(child) != bus);
3019 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3023 rle = resource_list_find(rl, type, rid);
3026 panic("resource_list_release: can't find resource");
3028 panic("resource_list_release: resource entry is not busy");
3030 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
3040 * @brief Print a description of resources in a resource list
3042 * Print all resources of a specified type, for use in BUS_PRINT_CHILD().
3043 * The name is printed if at least one resource of the given type is available.
3044 * The format is used to print resource start and end.
3046 * @param rl the resource list to print
3047 * @param name the name of @p type, e.g. @c "memory"
3048 * @param type type type of resource entry to print
3049 * @param format printf(9) format string to print resource
3050 * start and end values
3052 * @returns the number of characters printed
3055 resource_list_print_type(struct resource_list *rl, const char *name, int type,
3058 struct resource_list_entry *rle;
3059 int printed, retval;
3063 /* Yes, this is kinda cheating */
3064 STAILQ_FOREACH(rle, rl, link) {
3065 if (rle->type == type) {
3067 retval += printf(" %s ", name);
3069 retval += printf(",");
3071 retval += printf(format, rle->start);
3072 if (rle->count > 1) {
3073 retval += printf("-");
3074 retval += printf(format, rle->start +
3083 * @brief Releases all the resources in a list.
3085 * @param rl The resource list to purge.
3090 resource_list_purge(struct resource_list *rl)
3092 struct resource_list_entry *rle;
3094 while ((rle = STAILQ_FIRST(rl)) != NULL) {
3096 bus_release_resource(rman_get_device(rle->res),
3097 rle->type, rle->rid, rle->res);
3098 STAILQ_REMOVE_HEAD(rl, link);
3104 bus_generic_add_child(device_t dev, int order, const char *name, int unit)
3107 return (device_add_child_ordered(dev, order, name, unit));
3111 * @brief Helper function for implementing DEVICE_PROBE()
3113 * This function can be used to help implement the DEVICE_PROBE() for
3114 * a bus (i.e. a device which has other devices attached to it). It
3115 * calls the DEVICE_IDENTIFY() method of each driver in the device's
3119 bus_generic_probe(device_t dev)
3121 devclass_t dc = dev->devclass;
3124 TAILQ_FOREACH(dl, &dc->drivers, link) {
3126 * If this driver's pass is too high, then ignore it.
3127 * For most drivers in the default pass, this will
3128 * never be true. For early-pass drivers they will
3129 * only call the identify routines of eligible drivers
3130 * when this routine is called. Drivers for later
3131 * passes should have their identify routines called
3132 * on early-pass busses during BUS_NEW_PASS().
3134 if (dl->pass > bus_current_pass)
3136 DEVICE_IDENTIFY(dl->driver, dev);
3143 * @brief Helper function for implementing DEVICE_ATTACH()
3145 * This function can be used to help implement the DEVICE_ATTACH() for
3146 * a bus. It calls device_probe_and_attach() for each of the device's
3150 bus_generic_attach(device_t dev)
3154 NBL_ASSERT(SA_XLOCKED);
3156 TAILQ_FOREACH(child, &dev->children, link) {
3157 device_probe_and_attach(child);
3164 * @brief Helper function for implementing DEVICE_DETACH()
3166 * This function can be used to help implement the DEVICE_DETACH() for
3167 * a bus. It calls device_detach() for each of the device's
3171 bus_generic_detach(device_t dev)
3176 NBL_ASSERT(SA_XLOCKED);
3178 if (dev->state != DS_ATTACHED)
3181 TAILQ_FOREACH(child, &dev->children, link) {
3182 if ((error = device_detach(child)) != 0)
3190 * @brief Helper function for implementing DEVICE_SHUTDOWN()
3192 * This function can be used to help implement the DEVICE_SHUTDOWN()
3193 * for a bus. It calls device_shutdown() for each of the device's
3197 bus_generic_shutdown(device_t dev)
3201 TAILQ_FOREACH(child, &dev->children, link) {
3202 device_shutdown(child);
3209 * @brief Helper function for implementing DEVICE_SUSPEND()
3211 * This function can be used to help implement the DEVICE_SUSPEND()
3212 * for a bus. It calls DEVICE_SUSPEND() for each of the device's
3213 * children. If any call to DEVICE_SUSPEND() fails, the suspend
3214 * operation is aborted and any devices which were suspended are
3215 * resumed immediately by calling their DEVICE_RESUME() methods.
3218 bus_generic_suspend(device_t dev)
3221 device_t child, child2;
3223 TAILQ_FOREACH(child, &dev->children, link) {
3224 error = DEVICE_SUSPEND(child);
3226 for (child2 = TAILQ_FIRST(&dev->children);
3227 child2 && child2 != child;
3228 child2 = TAILQ_NEXT(child2, link))
3229 DEVICE_RESUME(child2);
3237 * @brief Helper function for implementing DEVICE_RESUME()
3239 * This function can be used to help implement the DEVICE_RESUME() for
3240 * a bus. It calls DEVICE_RESUME() on each of the device's children.
3243 bus_generic_resume(device_t dev)
3247 TAILQ_FOREACH(child, &dev->children, link) {
3248 DEVICE_RESUME(child);
3249 /* if resume fails, there's nothing we can usefully do... */
3255 * @brief Helper function for implementing BUS_PRINT_CHILD().
3257 * This function prints the first part of the ascii representation of
3258 * @p child, including its name, unit and description (if any - see
3259 * device_set_desc()).
3261 * @returns the number of characters printed
3264 bus_print_child_header(device_t dev, device_t child)
3268 if (device_get_desc(child)) {
3269 retval += device_printf(child, "<%s>", device_get_desc(child));
3271 retval += printf("%s", device_get_nameunit(child));
3278 * @brief Helper function for implementing BUS_PRINT_CHILD().
3280 * This function prints the last part of the ascii representation of
3281 * @p child, which consists of the string @c " on " followed by the
3282 * name and unit of the @p dev.
3284 * @returns the number of characters printed
3287 bus_print_child_footer(device_t dev, device_t child)
3289 return (printf(" on %s\n", device_get_nameunit(dev)));
3293 * @brief Helper function for implementing BUS_PRINT_CHILD().
3295 * This function simply calls bus_print_child_header() followed by
3296 * bus_print_child_footer().
3298 * @returns the number of characters printed
3301 bus_generic_print_child(device_t dev, device_t child)
3305 retval += bus_print_child_header(dev, child);
3306 retval += bus_print_child_footer(dev, child);
3312 * @brief Stub function for implementing BUS_READ_IVAR().
3317 bus_generic_read_ivar(device_t dev, device_t child, int index,
3324 * @brief Stub function for implementing BUS_WRITE_IVAR().
3329 bus_generic_write_ivar(device_t dev, device_t child, int index,
3336 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST().
3340 struct resource_list *
3341 bus_generic_get_resource_list(device_t dev, device_t child)
3347 * @brief Helper function for implementing BUS_DRIVER_ADDED().
3349 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's
3350 * DEVICE_IDENTIFY() method to allow it to add new children to the bus
3351 * and then calls device_probe_and_attach() for each unattached child.
3354 bus_generic_driver_added(device_t dev, driver_t *driver)
3358 DEVICE_IDENTIFY(driver, dev);
3359 TAILQ_FOREACH(child, &dev->children, link) {
3360 if (child->state == DS_NOTPRESENT ||
3361 (child->flags & DF_REBID))
3362 device_probe_and_attach(child);
3367 * @brief Helper function for implementing BUS_NEW_PASS().
3369 * This implementing of BUS_NEW_PASS() first calls the identify
3370 * routines for any drivers that probe at the current pass. Then it
3371 * walks the list of devices for this bus. If a device is already
3372 * attached, then it calls BUS_NEW_PASS() on that device. If the
3373 * device is not already attached, it attempts to attach a driver to
3377 bus_generic_new_pass(device_t dev)
3384 TAILQ_FOREACH(dl, &dc->drivers, link) {
3385 if (dl->pass == bus_current_pass)
3386 DEVICE_IDENTIFY(dl->driver, dev);
3388 TAILQ_FOREACH(child, &dev->children, link) {
3389 if (child->state >= DS_ATTACHED)
3390 BUS_NEW_PASS(child);
3391 else if (child->state == DS_NOTPRESENT)
3392 device_probe_and_attach(child);
3397 * @brief Helper function for implementing BUS_SETUP_INTR().
3399 * This simple implementation of BUS_SETUP_INTR() simply calls the
3400 * BUS_SETUP_INTR() method of the parent of @p dev.
3403 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
3404 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
3407 /* Propagate up the bus hierarchy until someone handles it. */
3409 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
3410 filter, intr, arg, cookiep));
3415 * @brief Helper function for implementing BUS_TEARDOWN_INTR().
3417 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the
3418 * BUS_TEARDOWN_INTR() method of the parent of @p dev.
3421 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
3424 /* Propagate up the bus hierarchy until someone handles it. */
3426 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
3431 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
3433 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the
3434 * BUS_ALLOC_RESOURCE() method of the parent of @p dev.
3437 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
3438 u_long start, u_long end, u_long count, u_int flags)
3440 /* Propagate up the bus hierarchy until someone handles it. */
3442 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
3443 start, end, count, flags));
3448 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
3450 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the
3451 * BUS_RELEASE_RESOURCE() method of the parent of @p dev.
3454 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
3457 /* Propagate up the bus hierarchy until someone handles it. */
3459 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
3465 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE().
3467 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the
3468 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev.
3471 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
3474 /* Propagate up the bus hierarchy until someone handles it. */
3476 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
3482 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE().
3484 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the
3485 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev.
3488 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
3489 int rid, struct resource *r)
3491 /* Propagate up the bus hierarchy until someone handles it. */
3493 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
3499 * @brief Helper function for implementing BUS_BIND_INTR().
3501 * This simple implementation of BUS_BIND_INTR() simply calls the
3502 * BUS_BIND_INTR() method of the parent of @p dev.
3505 bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq,
3509 /* Propagate up the bus hierarchy until someone handles it. */
3511 return (BUS_BIND_INTR(dev->parent, child, irq, cpu));
3516 * @brief Helper function for implementing BUS_CONFIG_INTR().
3518 * This simple implementation of BUS_CONFIG_INTR() simply calls the
3519 * BUS_CONFIG_INTR() method of the parent of @p dev.
3522 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
3523 enum intr_polarity pol)
3526 /* Propagate up the bus hierarchy until someone handles it. */
3528 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
3533 * @brief Helper function for implementing BUS_GET_DMA_TAG().
3535 * This simple implementation of BUS_GET_DMA_TAG() simply calls the
3536 * BUS_GET_DMA_TAG() method of the parent of @p dev.
3539 bus_generic_get_dma_tag(device_t dev, device_t child)
3542 /* Propagate up the bus hierarchy until someone handles it. */
3543 if (dev->parent != NULL)
3544 return (BUS_GET_DMA_TAG(dev->parent, child));
3549 * @brief Helper function for implementing BUS_GET_RESOURCE().
3551 * This implementation of BUS_GET_RESOURCE() uses the
3552 * resource_list_find() function to do most of the work. It calls
3553 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3557 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
3558 u_long *startp, u_long *countp)
3560 struct resource_list * rl = NULL;
3561 struct resource_list_entry * rle = NULL;
3563 rl = BUS_GET_RESOURCE_LIST(dev, child);
3567 rle = resource_list_find(rl, type, rid);
3572 *startp = rle->start;
3574 *countp = rle->count;
3580 * @brief Helper function for implementing BUS_SET_RESOURCE().
3582 * This implementation of BUS_SET_RESOURCE() uses the
3583 * resource_list_add() function to do most of the work. It calls
3584 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3588 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
3589 u_long start, u_long count)
3591 struct resource_list * rl = NULL;
3593 rl = BUS_GET_RESOURCE_LIST(dev, child);
3597 resource_list_add(rl, type, rid, start, (start + count - 1), count);
3603 * @brief Helper function for implementing BUS_DELETE_RESOURCE().
3605 * This implementation of BUS_DELETE_RESOURCE() uses the
3606 * resource_list_delete() function to do most of the work. It calls
3607 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to
3611 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
3613 struct resource_list * rl = NULL;
3615 rl = BUS_GET_RESOURCE_LIST(dev, child);
3619 resource_list_delete(rl, type, rid);
3625 * @brief Helper function for implementing BUS_RELEASE_RESOURCE().
3627 * This implementation of BUS_RELEASE_RESOURCE() uses the
3628 * resource_list_release() function to do most of the work. It calls
3629 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
3632 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
3633 int rid, struct resource *r)
3635 struct resource_list * rl = NULL;
3637 rl = BUS_GET_RESOURCE_LIST(dev, child);
3641 return (resource_list_release(rl, dev, child, type, rid, r));
3645 * @brief Helper function for implementing BUS_ALLOC_RESOURCE().
3647 * This implementation of BUS_ALLOC_RESOURCE() uses the
3648 * resource_list_alloc() function to do most of the work. It calls
3649 * BUS_GET_RESOURCE_LIST() to find a suitable resource list.
3652 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
3653 int *rid, u_long start, u_long end, u_long count, u_int flags)
3655 struct resource_list * rl = NULL;
3657 rl = BUS_GET_RESOURCE_LIST(dev, child);
3661 return (resource_list_alloc(rl, dev, child, type, rid,
3662 start, end, count, flags));
3666 * @brief Helper function for implementing BUS_CHILD_PRESENT().
3668 * This simple implementation of BUS_CHILD_PRESENT() simply calls the
3669 * BUS_CHILD_PRESENT() method of the parent of @p dev.
3672 bus_generic_child_present(device_t dev, device_t child)
3674 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev));
3678 * Some convenience functions to make it easier for drivers to use the
3679 * resource-management functions. All these really do is hide the
3680 * indirection through the parent's method table, making for slightly
3681 * less-wordy code. In the future, it might make sense for this code
3682 * to maintain some sort of a list of resources allocated by each device.
3686 bus_alloc_resources(device_t dev, struct resource_spec *rs,
3687 struct resource **res)
3691 for (i = 0; rs[i].type != -1; i++)
3693 for (i = 0; rs[i].type != -1; i++) {
3694 res[i] = bus_alloc_resource_any(dev,
3695 rs[i].type, &rs[i].rid, rs[i].flags);
3696 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) {
3697 bus_release_resources(dev, rs, res);
3705 bus_release_resources(device_t dev, const struct resource_spec *rs,
3706 struct resource **res)
3710 for (i = 0; rs[i].type != -1; i++)
3711 if (res[i] != NULL) {
3712 bus_release_resource(
3713 dev, rs[i].type, rs[i].rid, res[i]);
3719 * @brief Wrapper function for BUS_ALLOC_RESOURCE().
3721 * This function simply calls the BUS_ALLOC_RESOURCE() method of the
3725 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
3726 u_long count, u_int flags)
3728 if (dev->parent == NULL)
3730 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
3735 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE().
3737 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the
3741 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
3743 if (dev->parent == NULL)
3745 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
3749 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE().
3751 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the
3755 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
3757 if (dev->parent == NULL)
3759 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
3763 * @brief Wrapper function for BUS_RELEASE_RESOURCE().
3765 * This function simply calls the BUS_RELEASE_RESOURCE() method of the
3769 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
3771 if (dev->parent == NULL)
3773 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
3777 * @brief Wrapper function for BUS_SETUP_INTR().
3779 * This function simply calls the BUS_SETUP_INTR() method of the
3783 bus_setup_intr(device_t dev, struct resource *r, int flags,
3784 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep)
3788 if (dev->parent == NULL)
3790 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler,
3794 if (handler != NULL && !(flags & INTR_MPSAFE))
3795 device_printf(dev, "[GIANT-LOCKED]\n");
3796 if (bootverbose && (flags & INTR_MPSAFE))
3797 device_printf(dev, "[MPSAFE]\n");
3798 if (filter != NULL) {
3799 if (handler == NULL)
3800 device_printf(dev, "[FILTER]\n");
3802 device_printf(dev, "[FILTER+ITHREAD]\n");
3804 device_printf(dev, "[ITHREAD]\n");
3809 * @brief Wrapper function for BUS_TEARDOWN_INTR().
3811 * This function simply calls the BUS_TEARDOWN_INTR() method of the
3815 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
3817 if (dev->parent == NULL)
3819 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
3823 * @brief Wrapper function for BUS_BIND_INTR().
3825 * This function simply calls the BUS_BIND_INTR() method of the
3829 bus_bind_intr(device_t dev, struct resource *r, int cpu)
3831 if (dev->parent == NULL)
3833 return (BUS_BIND_INTR(dev->parent, dev, r, cpu));
3837 * @brief Wrapper function for BUS_SET_RESOURCE().
3839 * This function simply calls the BUS_SET_RESOURCE() method of the
3843 bus_set_resource(device_t dev, int type, int rid,
3844 u_long start, u_long count)
3846 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
3851 * @brief Wrapper function for BUS_GET_RESOURCE().
3853 * This function simply calls the BUS_GET_RESOURCE() method of the
3857 bus_get_resource(device_t dev, int type, int rid,
3858 u_long *startp, u_long *countp)
3860 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
3865 * @brief Wrapper function for BUS_GET_RESOURCE().
3867 * This function simply calls the BUS_GET_RESOURCE() method of the
3868 * parent of @p dev and returns the start value.
3871 bus_get_resource_start(device_t dev, int type, int rid)
3873 u_long start, count;
3876 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
3884 * @brief Wrapper function for BUS_GET_RESOURCE().
3886 * This function simply calls the BUS_GET_RESOURCE() method of the
3887 * parent of @p dev and returns the count value.
3890 bus_get_resource_count(device_t dev, int type, int rid)
3892 u_long start, count;
3895 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
3903 * @brief Wrapper function for BUS_DELETE_RESOURCE().
3905 * This function simply calls the BUS_DELETE_RESOURCE() method of the
3909 bus_delete_resource(device_t dev, int type, int rid)
3911 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
3915 * @brief Wrapper function for BUS_CHILD_PRESENT().
3917 * This function simply calls the BUS_CHILD_PRESENT() method of the
3921 bus_child_present(device_t child)
3923 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
3927 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR().
3929 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the
3933 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
3937 parent = device_get_parent(child);
3938 if (parent == NULL) {
3942 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
3946 * @brief Wrapper function for BUS_CHILD_LOCATION_STR().
3948 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the
3952 bus_child_location_str(device_t child, char *buf, size_t buflen)
3956 parent = device_get_parent(child);
3957 if (parent == NULL) {
3961 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
3965 * @brief Wrapper function for BUS_GET_DMA_TAG().
3967 * This function simply calls the BUS_GET_DMA_TAG() method of the
3971 bus_get_dma_tag(device_t dev)
3975 parent = device_get_parent(dev);
3978 return (BUS_GET_DMA_TAG(parent, dev));
3981 /* Resume all devices and then notify userland that we're up again. */
3983 root_resume(device_t dev)
3987 error = bus_generic_resume(dev);
3989 devctl_notify("kern", "power", "resume", NULL);
3994 root_print_child(device_t dev, device_t child)
3998 retval += bus_print_child_header(dev, child);
3999 retval += printf("\n");
4005 root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
4006 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep)
4009 * If an interrupt mapping gets to here something bad has happened.
4011 panic("root_setup_intr");
4015 * If we get here, assume that the device is permanant and really is
4016 * present in the system. Removable bus drivers are expected to intercept
4017 * this call long before it gets here. We return -1 so that drivers that
4018 * really care can check vs -1 or some ERRNO returned higher in the food
4022 root_child_present(device_t dev, device_t child)
4027 static kobj_method_t root_methods[] = {
4028 /* Device interface */
4029 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
4030 KOBJMETHOD(device_suspend, bus_generic_suspend),
4031 KOBJMETHOD(device_resume, root_resume),
4034 KOBJMETHOD(bus_print_child, root_print_child),
4035 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
4036 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
4037 KOBJMETHOD(bus_setup_intr, root_setup_intr),
4038 KOBJMETHOD(bus_child_present, root_child_present),
4043 static driver_t root_driver = {
4050 devclass_t root_devclass;
4053 root_bus_module_handler(module_t mod, int what, void* arg)
4057 TAILQ_INIT(&bus_data_devices);
4059 kobj_class_compile((kobj_class_t) &root_driver);
4060 root_bus = make_device(NULL, "root", 0);
4061 root_bus->desc = "System root bus";
4062 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
4063 root_bus->driver = &root_driver;
4064 root_bus->state = DS_ATTACHED;
4065 root_devclass = devclass_find_internal("root", NULL, FALSE);
4070 device_shutdown(root_bus);
4073 return (EOPNOTSUPP);
4079 static moduledata_t root_bus_mod = {
4081 root_bus_module_handler,
4084 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
4087 * @brief Automatically configure devices
4089 * This function begins the autoconfiguration process by calling
4090 * device_probe_and_attach() for each child of the @c root0 device.
4093 root_bus_configure(void)
4098 /* Eventually this will be split up, but this is sufficient for now. */
4099 bus_set_pass(BUS_PASS_DEFAULT);
4103 * @brief Module handler for registering device drivers
4105 * This module handler is used to automatically register device
4106 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls
4107 * devclass_add_driver() for the driver described by the
4108 * driver_module_data structure pointed to by @p arg
4111 driver_module_handler(module_t mod, int what, void *arg)
4113 struct driver_module_data *dmd;
4114 devclass_t bus_devclass;
4115 kobj_class_t driver;
4119 dmd = (struct driver_module_data *)arg;
4122 * If MOD_SHUTDOWN is passed, return immediately in order to
4123 * avoid unnecessary locking and a LOR with the modules sx lock.
4125 if (what == MOD_SHUTDOWN)
4126 return (EOPNOTSUPP);
4128 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
4129 if (bus_devclass == NULL) {
4136 if (dmd->dmd_chainevh)
4137 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4141 pass = dmd->dmd_pass;
4142 driver = dmd->dmd_driver;
4143 PDEBUG(("Loading module: driver %s on bus %s (pass %d)",
4144 DRIVERNAME(driver), dmd->dmd_busname, pass));
4145 error = devclass_add_driver(bus_devclass, driver, pass);
4150 * If the driver has any base classes, make the
4151 * devclass inherit from the devclass of the driver's
4152 * first base class. This will allow the system to
4153 * search for drivers in both devclasses for children
4154 * of a device using this driver.
4156 if (driver->baseclasses) {
4157 const char *parentname;
4158 parentname = driver->baseclasses[0]->name;
4159 *dmd->dmd_devclass =
4160 devclass_find_internal(driver->name,
4163 *dmd->dmd_devclass =
4164 devclass_find_internal(driver->name, NULL, TRUE);
4169 PDEBUG(("Unloading module: driver %s from bus %s",
4170 DRIVERNAME(dmd->dmd_driver),
4172 error = devclass_delete_driver(bus_devclass,
4175 if (!error && dmd->dmd_chainevh)
4176 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4179 PDEBUG(("Quiesce module: driver %s from bus %s",
4180 DRIVERNAME(dmd->dmd_driver),
4182 error = devclass_quiesce_driver(bus_devclass,
4185 if (!error && dmd->dmd_chainevh)
4186 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
4198 * @brief Enumerate all hinted devices for this bus.
4200 * Walks through the hints for this bus and calls the bus_hinted_child
4201 * routine for each one it fines. It searches first for the specific
4202 * bus that's being probed for hinted children (eg isa0), and then for
4203 * generic children (eg isa).
4205 * @param dev bus device to enumerate
4208 bus_enumerate_hinted_children(device_t bus)
4211 const char *dname, *busname;
4215 * enumerate all devices on the specific bus
4217 busname = device_get_nameunit(bus);
4219 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4220 BUS_HINTED_CHILD(bus, dname, dunit);
4223 * and all the generic ones.
4225 busname = device_get_name(bus);
4227 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0)
4228 BUS_HINTED_CHILD(bus, dname, dunit);
4233 /* the _short versions avoid iteration by not calling anything that prints
4234 * more than oneliners. I love oneliners.
4238 print_device_short(device_t dev, int indent)
4243 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
4244 dev->unit, dev->desc,
4245 (dev->parent? "":"no "),
4246 (TAILQ_EMPTY(&dev->children)? "no ":""),
4247 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
4248 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
4249 (dev->flags&DF_WILDCARD? "wildcard,":""),
4250 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
4251 (dev->flags&DF_REBID? "rebiddable,":""),
4252 (dev->ivars? "":"no "),
4253 (dev->softc? "":"no "),
4258 print_device(device_t dev, int indent)
4263 print_device_short(dev, indent);
4265 indentprintf(("Parent:\n"));
4266 print_device_short(dev->parent, indent+1);
4267 indentprintf(("Driver:\n"));
4268 print_driver_short(dev->driver, indent+1);
4269 indentprintf(("Devclass:\n"));
4270 print_devclass_short(dev->devclass, indent+1);
4274 print_device_tree_short(device_t dev, int indent)
4275 /* print the device and all its children (indented) */
4282 print_device_short(dev, indent);
4284 TAILQ_FOREACH(child, &dev->children, link) {
4285 print_device_tree_short(child, indent+1);
4290 print_device_tree(device_t dev, int indent)
4291 /* print the device and all its children (indented) */
4298 print_device(dev, indent);
4300 TAILQ_FOREACH(child, &dev->children, link) {
4301 print_device_tree(child, indent+1);
4306 print_driver_short(driver_t *driver, int indent)
4311 indentprintf(("driver %s: softc size = %zd\n",
4312 driver->name, driver->size));
4316 print_driver(driver_t *driver, int indent)
4321 print_driver_short(driver, indent);
4326 print_driver_list(driver_list_t drivers, int indent)
4328 driverlink_t driver;
4330 TAILQ_FOREACH(driver, &drivers, link) {
4331 print_driver(driver->driver, indent);
4336 print_devclass_short(devclass_t dc, int indent)
4341 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
4345 print_devclass(devclass_t dc, int indent)
4352 print_devclass_short(dc, indent);
4353 indentprintf(("Drivers:\n"));
4354 print_driver_list(dc->drivers, indent+1);
4356 indentprintf(("Devices:\n"));
4357 for (i = 0; i < dc->maxunit; i++)
4359 print_device(dc->devices[i], indent+1);
4363 print_devclass_list_short(void)
4367 printf("Short listing of devclasses, drivers & devices:\n");
4368 TAILQ_FOREACH(dc, &devclasses, link) {
4369 print_devclass_short(dc, 0);
4374 print_devclass_list(void)
4378 printf("Full listing of devclasses, drivers & devices:\n");
4379 TAILQ_FOREACH(dc, &devclasses, link) {
4380 print_devclass(dc, 0);
4387 * User-space access to the device tree.
4389 * We implement a small set of nodes:
4391 * hw.bus Single integer read method to obtain the
4392 * current generation count.
4393 * hw.bus.devices Reads the entire device tree in flat space.
4394 * hw.bus.rman Resource manager interface
4396 * We might like to add the ability to scan devclasses and/or drivers to
4397 * determine what else is currently loaded/available.
4401 sysctl_bus(SYSCTL_HANDLER_ARGS)
4403 struct u_businfo ubus;
4405 ubus.ub_version = BUS_USER_VERSION;
4406 ubus.ub_generation = bus_data_generation;
4408 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
4410 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
4411 "bus-related data");
4414 sysctl_devices(SYSCTL_HANDLER_ARGS)
4416 int *name = (int *)arg1;
4417 u_int namelen = arg2;
4420 struct u_device udev; /* XXX this is a bit big */
4426 if (bus_data_generation_check(name[0]))
4432 * Scan the list of devices, looking for the requested index.
4434 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
4442 * Populate the return array.
4444 bzero(&udev, sizeof(udev));
4445 udev.dv_handle = (uintptr_t)dev;
4446 udev.dv_parent = (uintptr_t)dev->parent;
4447 if (dev->nameunit != NULL)
4448 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
4449 if (dev->desc != NULL)
4450 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
4451 if (dev->driver != NULL && dev->driver->name != NULL)
4452 strlcpy(udev.dv_drivername, dev->driver->name,
4453 sizeof(udev.dv_drivername));
4454 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
4455 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
4456 udev.dv_devflags = dev->devflags;
4457 udev.dv_flags = dev->flags;
4458 udev.dv_state = dev->state;
4459 error = SYSCTL_OUT(req, &udev, sizeof(udev));
4463 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
4464 "system device tree");
4467 bus_data_generation_check(int generation)
4469 if (generation != bus_data_generation)
4472 /* XXX generate optimised lists here? */
4477 bus_data_generation_update(void)
4479 bus_data_generation++;
4483 bus_free_resource(device_t dev, int type, struct resource *r)
4487 return (bus_release_resource(dev, type, rman_get_rid(r), r));