2 * Copyright (c) 1997,1998 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
26 * $FreeBSD: src/sys/kern/subr_bus.c,v 1.54.2.9 2002/10/10 15:13:32 jhb Exp $
27 * $DragonFly: src/sys/kern/subr_bus.c,v 1.46 2008/10/03 00:26:21 hasso Exp $
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <sys/malloc.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
38 #include <sys/bus_private.h>
39 #include <sys/sysctl.h>
40 #include <sys/systm.h>
43 #include <sys/device.h>
46 #include <sys/selinfo.h>
48 #include <sys/filio.h>
50 #include <sys/signalvar.h>
52 #include <machine/stdarg.h> /* for device_printf() */
54 #include <sys/thread2.h>
56 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
58 MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
61 #define PDEBUG(a) (kprintf("%s:%d: ", __func__, __LINE__), kprintf a, kprintf("\n"))
62 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
63 #define DRIVERNAME(d) ((d)? d->name : "no driver")
64 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
66 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to
67 * prevent syslog from deleting initial spaces
69 #define indentprintf(p) do { int iJ; kprintf("."); for (iJ=0; iJ<indent; iJ++) kprintf(" "); kprintf p ; } while(0)
71 static void print_device_short(device_t dev, int indent);
72 static void print_device(device_t dev, int indent);
73 void print_device_tree_short(device_t dev, int indent);
74 void print_device_tree(device_t dev, int indent);
75 static void print_driver_short(driver_t *driver, int indent);
76 static void print_driver(driver_t *driver, int indent);
77 static void print_driver_list(driver_list_t drivers, int indent);
78 static void print_devclass_short(devclass_t dc, int indent);
79 static void print_devclass(devclass_t dc, int indent);
80 void print_devclass_list_short(void);
81 void print_devclass_list(void);
84 /* Make the compiler ignore the function calls */
85 #define PDEBUG(a) /* nop */
86 #define DEVICENAME(d) /* nop */
87 #define DRIVERNAME(d) /* nop */
88 #define DEVCLANAME(d) /* nop */
90 #define print_device_short(d,i) /* nop */
91 #define print_device(d,i) /* nop */
92 #define print_device_tree_short(d,i) /* nop */
93 #define print_device_tree(d,i) /* nop */
94 #define print_driver_short(d,i) /* nop */
95 #define print_driver(d,i) /* nop */
96 #define print_driver_list(d,i) /* nop */
97 #define print_devclass_short(d,i) /* nop */
98 #define print_devclass(d,i) /* nop */
99 #define print_devclass_list_short() /* nop */
100 #define print_devclass_list() /* nop */
103 static void device_attach_async(device_t dev);
104 static void device_attach_thread(void *arg);
105 static int device_doattach(device_t dev);
107 static int do_async_attach = 0;
108 static int numasyncthreads;
109 TUNABLE_INT("kern.do_async_attach", &do_async_attach);
112 * /dev/devctl implementation
116 * This design allows only one reader for /dev/devctl. This is not desirable
117 * in the long run, but will get a lot of hair out of this implementation.
118 * Maybe we should make this device a clonable device.
120 * Also note: we specifically do not attach a device to the device_t tree
121 * to avoid potential chicken and egg problems. One could argue that all
122 * of this belongs to the root node. One could also further argue that the
123 * sysctl interface that we have not might more properly be an ioctl
124 * interface, but at this stage of the game, I'm not inclined to rock that
127 * I'm also not sure that the SIGIO support is done correctly or not, as
128 * I copied it from a driver that had SIGIO support that likely hasn't been
129 * tested since 3.4 or 2.2.8!
132 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
133 static int devctl_disable = 0;
134 TUNABLE_INT("hw.bus.devctl_disable", &devctl_disable);
135 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
136 sysctl_devctl_disable, "I", "devctl disable");
138 #define CDEV_MAJOR 188
140 static d_open_t devopen;
141 static d_close_t devclose;
142 static d_read_t devread;
143 static d_ioctl_t devioctl;
144 static d_poll_t devpoll;
146 static struct dev_ops devctl_ops = {
147 { "devctl", CDEV_MAJOR, 0 },
155 struct dev_event_info
158 TAILQ_ENTRY(dev_event_info) dei_link;
161 TAILQ_HEAD(devq, dev_event_info);
163 static struct dev_softc
170 struct proc *async_proc;
176 dev_ops_add(&devctl_ops, -1, 0);
177 make_dev(&devctl_ops, 0, UID_ROOT, GID_WHEEL, 0600, "devctl");
178 lockinit(&devsoftc.lock, "dev mtx", 0, 0);
179 TAILQ_INIT(&devsoftc.devq);
183 devopen(struct dev_open_args *ap)
189 devsoftc.nonblock = 0;
190 devsoftc.async_proc = NULL;
195 devclose(struct dev_close_args *ap)
198 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
200 lockmgr(&devsoftc.lock, LK_RELEASE);
206 * The read channel for this device is used to report changes to
207 * userland in realtime. We are required to free the data as well as
208 * the n1 object because we allocate them separately. Also note that
209 * we return one record at a time. If you try to read this device a
210 * character at a time, you will lose the rest of the data. Listening
211 * programs are expected to cope.
214 devread(struct dev_read_args *ap)
216 struct uio *uio = ap->a_uio;
217 struct dev_event_info *n1;
220 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
221 while (TAILQ_EMPTY(&devsoftc.devq)) {
222 if (devsoftc.nonblock) {
223 lockmgr(&devsoftc.lock, LK_RELEASE);
227 tsleep_interlock(&devsoftc);
228 lockmgr(&devsoftc.lock, LK_RELEASE);
229 rv = tsleep(&devsoftc, PCATCH, "devctl", 0);
231 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
234 * Need to translate ERESTART to EINTR here? -- jake
236 lockmgr(&devsoftc.lock, LK_RELEASE);
240 n1 = TAILQ_FIRST(&devsoftc.devq);
241 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
242 lockmgr(&devsoftc.lock, LK_RELEASE);
243 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
244 kfree(n1->dei_data, M_BUS);
250 devioctl(struct dev_ioctl_args *ap)
255 if (*(int*)ap->a_data)
256 devsoftc.nonblock = 1;
258 devsoftc.nonblock = 0;
261 if (*(int*)ap->a_data)
262 devsoftc.async_proc = curproc;
264 devsoftc.async_proc = NULL;
267 /* (un)Support for other fcntl() calls. */
280 devpoll(struct dev_poll_args *ap)
284 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
285 if (ap->a_events & (POLLIN | POLLRDNORM)) {
286 if (!TAILQ_EMPTY(&devsoftc.devq))
287 revents = ap->a_events & (POLLIN | POLLRDNORM);
289 selrecord(curthread, &devsoftc.sel);
291 lockmgr(&devsoftc.lock, LK_RELEASE);
293 ap->a_events = revents;
298 * @brief Return whether the userland process is running
301 devctl_process_running(void)
303 return (devsoftc.inuse == 1);
307 * @brief Queue data to be read from the devctl device
309 * Generic interface to queue data to the devctl device. It is
310 * assumed that @p data is properly formatted. It is further assumed
311 * that @p data is allocated using the M_BUS malloc type.
314 devctl_queue_data(char *data)
316 struct dev_event_info *n1 = NULL;
319 n1 = kmalloc(sizeof(*n1), M_BUS, M_NOWAIT);
323 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
324 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
326 lockmgr(&devsoftc.lock, LK_RELEASE);
327 get_mplock(); /* XXX */
328 selwakeup(&devsoftc.sel);
329 rel_mplock(); /* XXX */
330 p = devsoftc.async_proc;
336 * @brief Send a 'notification' to userland, using standard ways
339 devctl_notify(const char *system, const char *subsystem, const char *type,
346 return; /* BOGUS! Must specify system. */
347 if (subsystem == NULL)
348 return; /* BOGUS! Must specify subsystem. */
350 return; /* BOGUS! Must specify type. */
351 len += strlen(" system=") + strlen(system);
352 len += strlen(" subsystem=") + strlen(subsystem);
353 len += strlen(" type=") + strlen(type);
354 /* add in the data message plus newline. */
357 len += 3; /* '!', '\n', and NUL */
358 msg = kmalloc(len, M_BUS, M_NOWAIT);
360 return; /* Drop it on the floor */
362 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
363 system, subsystem, type, data);
365 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
366 system, subsystem, type);
367 devctl_queue_data(msg);
371 * Common routine that tries to make sending messages as easy as possible.
372 * We allocate memory for the data, copy strings into that, but do not
373 * free it unless there's an error. The dequeue part of the driver should
374 * free the data. We don't send data when the device is disabled. We do
375 * send data, even when we have no listeners, because we wish to avoid
376 * races relating to startup and restart of listening applications.
378 * devaddq is designed to string together the type of event, with the
379 * object of that event, plus the plug and play info and location info
380 * for that event. This is likely most useful for devices, but less
381 * useful for other consumers of this interface. Those should use
382 * the devctl_queue_data() interface instead.
385 devaddq(const char *type, const char *what, device_t dev)
394 data = kmalloc(1024, M_BUS, M_NOWAIT);
398 /* get the bus specific location of this device */
399 loc = kmalloc(1024, M_BUS, M_NOWAIT);
403 bus_child_location_str(dev, loc, 1024);
405 /* Get the bus specific pnp info of this device */
406 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
410 bus_child_pnpinfo_str(dev, pnp, 1024);
412 /* Get the parent of this device, or / if high enough in the tree. */
413 if (device_get_parent(dev) == NULL)
414 parstr = "."; /* Or '/' ? */
416 parstr = device_get_nameunit(device_get_parent(dev));
417 /* String it all together. */
418 ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
422 devctl_queue_data(data);
432 * A device was added to the tree. We are called just after it successfully
433 * attaches (that is, probe and attach success for this device). No call
434 * is made if a device is merely parented into the tree. See devnomatch
435 * if probe fails. If attach fails, no notification is sent (but maybe
436 * we should have a different message for this).
439 devadded(device_t dev)
444 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
447 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
451 bus_child_pnpinfo_str(dev, pnp, 1024);
452 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
453 devaddq("+", tmp, dev);
463 * A device was removed from the tree. We are called just before this
467 devremoved(device_t dev)
472 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
475 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
479 bus_child_pnpinfo_str(dev, pnp, 1024);
480 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
481 devaddq("-", tmp, dev);
491 * Called when there's no match for this device. This is only called
492 * the first time that no match happens, so we don't keep getitng this
493 * message. Should that prove to be undesirable, we can change it.
494 * This is called when all drivers that can attach to a given bus
495 * decline to accept this device. Other errrors may not be detected.
498 devnomatch(device_t dev)
500 devaddq("?", "", dev);
504 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
506 struct dev_event_info *n1;
509 dis = devctl_disable;
510 error = sysctl_handle_int(oidp, &dis, 0, req);
511 if (error || !req->newptr)
513 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
514 devctl_disable = dis;
516 while (!TAILQ_EMPTY(&devsoftc.devq)) {
517 n1 = TAILQ_FIRST(&devsoftc.devq);
518 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
519 kfree(n1->dei_data, M_BUS);
523 lockmgr(&devsoftc.lock, LK_RELEASE);
527 /* End of /dev/devctl code */
529 TAILQ_HEAD(,device) bus_data_devices;
530 static int bus_data_generation = 1;
532 kobj_method_t null_methods[] = {
536 DEFINE_CLASS(null, null_methods, 0);
539 * Devclass implementation
542 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
545 devclass_find_internal(const char *classname, const char *parentname,
550 PDEBUG(("looking for %s", classname));
551 if (classname == NULL)
554 TAILQ_FOREACH(dc, &devclasses, link)
555 if (!strcmp(dc->name, classname))
559 PDEBUG(("creating %s", classname));
560 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
561 M_BUS, M_INTWAIT | M_ZERO);
565 dc->name = (char*) (dc + 1);
566 strcpy(dc->name, classname);
569 TAILQ_INIT(&dc->drivers);
570 TAILQ_INSERT_TAIL(&devclasses, dc, link);
572 bus_data_generation_update();
575 if (parentname && dc && !dc->parent)
576 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
582 devclass_create(const char *classname)
584 return(devclass_find_internal(classname, NULL, TRUE));
588 devclass_find(const char *classname)
590 return(devclass_find_internal(classname, NULL, FALSE));
594 devclass_find_unit(const char *classname, int unit)
598 if ((dc = devclass_find(classname)) != NULL)
599 return(devclass_get_device(dc, unit));
604 devclass_add_driver(devclass_t dc, driver_t *driver)
610 PDEBUG(("%s", DRIVERNAME(driver)));
612 dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
617 * Compile the driver's methods. Also increase the reference count
618 * so that the class doesn't get freed when the last instance
619 * goes. This means we can safely use static methods and avoids a
620 * double-free in devclass_delete_driver.
622 kobj_class_instantiate(driver);
625 * Make sure the devclass which the driver is implementing exists.
627 devclass_find_internal(driver->name, NULL, TRUE);
630 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
633 * Call BUS_DRIVER_ADDED for any existing busses in this class,
634 * but only if the bus has already been attached (otherwise we
635 * might probe too early).
637 * This is what will cause a newly loaded module to be associated
638 * with hardware. bus_generic_driver_added() is typically what ends
641 for (i = 0; i < dc->maxunit; i++) {
642 if ((dev = dc->devices[i]) != NULL) {
643 if (dev->state >= DS_ATTACHED)
644 BUS_DRIVER_ADDED(dev, driver);
648 bus_data_generation_update();
653 devclass_delete_driver(devclass_t busclass, driver_t *driver)
655 devclass_t dc = devclass_find(driver->name);
661 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
667 * Find the link structure in the bus' list of drivers.
669 TAILQ_FOREACH(dl, &busclass->drivers, link)
670 if (dl->driver == driver)
674 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
679 * Disassociate from any devices. We iterate through all the
680 * devices in the devclass of the driver and detach any which are
681 * using the driver and which have a parent in the devclass which
682 * we are deleting from.
684 * Note that since a driver can be in multiple devclasses, we
685 * should not detach devices which are not children of devices in
686 * the affected devclass.
688 for (i = 0; i < dc->maxunit; i++)
689 if (dc->devices[i]) {
690 dev = dc->devices[i];
691 if (dev->driver == driver && dev->parent &&
692 dev->parent->devclass == busclass) {
693 if ((error = device_detach(dev)) != 0)
695 device_set_driver(dev, NULL);
699 TAILQ_REMOVE(&busclass->drivers, dl, link);
702 kobj_class_uninstantiate(driver);
704 bus_data_generation_update();
709 devclass_find_driver_internal(devclass_t dc, const char *classname)
713 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
715 TAILQ_FOREACH(dl, &dc->drivers, link)
716 if (!strcmp(dl->driver->name, classname))
719 PDEBUG(("not found"));
724 devclass_find_driver(devclass_t dc, const char *classname)
728 dl = devclass_find_driver_internal(dc, classname);
736 devclass_get_name(devclass_t dc)
742 devclass_get_device(devclass_t dc, int unit)
744 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
746 return(dc->devices[unit]);
750 devclass_get_softc(devclass_t dc, int unit)
754 dev = devclass_get_device(dc, unit);
758 return(device_get_softc(dev));
762 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
769 for (i = 0; i < dc->maxunit; i++)
773 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
778 for (i = 0; i < dc->maxunit; i++)
779 if (dc->devices[i]) {
780 list[count] = dc->devices[i];
791 * @brief Get a list of drivers in the devclass
793 * An array containing a list of pointers to all the drivers in the
794 * given devclass is allocated and returned in @p *listp. The number
795 * of drivers in the array is returned in @p *countp. The caller should
796 * free the array using @c free(p, M_TEMP).
798 * @param dc the devclass to examine
799 * @param listp gives location for array pointer return value
800 * @param countp gives location for number of array elements
804 * @retval ENOMEM the array allocation failed
807 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
814 TAILQ_FOREACH(dl, &dc->drivers, link)
816 list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
821 TAILQ_FOREACH(dl, &dc->drivers, link) {
822 list[count] = dl->driver;
832 * @brief Get the number of devices in a devclass
834 * @param dc the devclass to examine
837 devclass_get_count(devclass_t dc)
842 for (i = 0; i < dc->maxunit; i++)
849 devclass_get_maxunit(devclass_t dc)
855 devclass_set_parent(devclass_t dc, devclass_t pdc)
861 devclass_get_parent(devclass_t dc)
867 devclass_alloc_unit(devclass_t dc, int *unitp)
871 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
873 /* If we have been given a wired unit number, check for existing device */
875 if (unit >= 0 && unit < dc->maxunit &&
876 dc->devices[unit] != NULL) {
878 kprintf("%s-: %s%d exists, using next available unit number\n",
879 dc->name, dc->name, unit);
880 /* find the next available slot */
881 while (++unit < dc->maxunit && dc->devices[unit] != NULL)
885 /* Unwired device, find the next available slot for it */
887 while (unit < dc->maxunit && dc->devices[unit] != NULL)
892 * We've selected a unit beyond the length of the table, so let's
893 * extend the table to make room for all units up to and including
896 if (unit >= dc->maxunit) {
900 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
901 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
905 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
907 kfree(dc->devices, M_BUS);
908 dc->devices = newlist;
909 dc->maxunit = newsize;
911 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
918 devclass_add_device(devclass_t dc, device_t dev)
922 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
924 buflen = strlen(dc->name) + 5;
925 dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
929 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
930 kfree(dev->nameunit, M_BUS);
931 dev->nameunit = NULL;
934 dc->devices[dev->unit] = dev;
936 ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
942 devclass_delete_device(devclass_t dc, device_t dev)
947 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
949 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
950 panic("devclass_delete_device: inconsistent device class");
951 dc->devices[dev->unit] = NULL;
952 if (dev->flags & DF_WILDCARD)
954 dev->devclass = NULL;
955 kfree(dev->nameunit, M_BUS);
956 dev->nameunit = NULL;
962 make_device(device_t parent, const char *name, int unit)
967 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
970 dc = devclass_find_internal(name, NULL, TRUE);
972 kprintf("make_device: can't find device class %s\n", name);
978 dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
982 dev->parent = parent;
983 TAILQ_INIT(&dev->children);
984 kobj_init((kobj_t) dev, &null_class);
986 dev->devclass = NULL;
988 dev->nameunit = NULL;
992 dev->flags = DF_ENABLED;
995 dev->flags |= DF_WILDCARD;
997 dev->flags |= DF_FIXEDCLASS;
998 if (devclass_add_device(dc, dev) != 0) {
999 kobj_delete((kobj_t)dev, M_BUS);
1006 dev->state = DS_NOTPRESENT;
1008 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1009 bus_data_generation_update();
1015 device_print_child(device_t dev, device_t child)
1019 if (device_is_alive(child))
1020 retval += BUS_PRINT_CHILD(dev, child);
1022 retval += device_printf(child, " not found\n");
1028 device_add_child(device_t dev, const char *name, int unit)
1030 return device_add_child_ordered(dev, 0, name, unit);
1034 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1039 PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1042 child = make_device(dev, name, unit);
1045 child->order = order;
1047 TAILQ_FOREACH(place, &dev->children, link)
1048 if (place->order > order)
1053 * The device 'place' is the first device whose order is
1054 * greater than the new child.
1056 TAILQ_INSERT_BEFORE(place, child, link);
1059 * The new child's order is greater or equal to the order of
1060 * any existing device. Add the child to the tail of the list.
1062 TAILQ_INSERT_TAIL(&dev->children, child, link);
1065 bus_data_generation_update();
1070 device_delete_child(device_t dev, device_t child)
1073 device_t grandchild;
1075 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1077 /* remove children first */
1078 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1079 error = device_delete_child(child, grandchild);
1084 if ((error = device_detach(child)) != 0)
1086 if (child->devclass)
1087 devclass_delete_device(child->devclass, child);
1088 TAILQ_REMOVE(&dev->children, child, link);
1089 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1090 device_set_desc(child, NULL);
1091 kobj_delete((kobj_t)child, M_BUS);
1093 bus_data_generation_update();
1098 * @brief Find a device given a unit number
1100 * This is similar to devclass_get_devices() but only searches for
1101 * devices which have @p dev as a parent.
1103 * @param dev the parent device to search
1104 * @param unit the unit number to search for. If the unit is -1,
1105 * return the first child of @p dev which has name
1106 * @p classname (that is, the one with the lowest unit.)
1108 * @returns the device with the given unit number or @c
1109 * NULL if there is no such device
1112 device_find_child(device_t dev, const char *classname, int unit)
1117 dc = devclass_find(classname);
1122 child = devclass_get_device(dc, unit);
1123 if (child && child->parent == dev)
1126 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1127 child = devclass_get_device(dc, unit);
1128 if (child && child->parent == dev)
1136 first_matching_driver(devclass_t dc, device_t dev)
1139 return(devclass_find_driver_internal(dc, dev->devclass->name));
1141 return(TAILQ_FIRST(&dc->drivers));
1145 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1147 if (dev->devclass) {
1149 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1150 if (!strcmp(dev->devclass->name, dl->driver->name))
1154 return(TAILQ_NEXT(last, link));
1158 device_probe_child(device_t dev, device_t child)
1161 driverlink_t best = 0;
1163 int result, pri = 0;
1164 int hasclass = (child->devclass != 0);
1168 panic("device_probe_child: parent device has no devclass");
1170 if (child->state == DS_ALIVE)
1173 for (; dc; dc = dc->parent) {
1174 for (dl = first_matching_driver(dc, child); dl;
1175 dl = next_matching_driver(dc, child, dl)) {
1176 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1177 device_set_driver(child, dl->driver);
1179 device_set_devclass(child, dl->driver->name);
1180 result = DEVICE_PROBE(child);
1182 device_set_devclass(child, 0);
1185 * If the driver returns SUCCESS, there can be
1186 * no higher match for this device.
1195 * The driver returned an error so it
1196 * certainly doesn't match.
1199 device_set_driver(child, 0);
1204 * A priority lower than SUCCESS, remember the
1205 * best matching driver. Initialise the value
1206 * of pri for the first match.
1208 if (best == 0 || result > pri) {
1215 * If we have unambiguous match in this devclass,
1216 * don't look in the parent.
1218 if (best && pri == 0)
1223 * If we found a driver, change state and initialise the devclass.
1226 if (!child->devclass)
1227 device_set_devclass(child, best->driver->name);
1228 device_set_driver(child, best->driver);
1231 * A bit bogus. Call the probe method again to make
1232 * sure that we have the right description.
1234 DEVICE_PROBE(child);
1237 bus_data_generation_update();
1238 child->state = DS_ALIVE;
1246 device_get_parent(device_t dev)
1252 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1259 TAILQ_FOREACH(child, &dev->children, link)
1262 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1267 TAILQ_FOREACH(child, &dev->children, link) {
1268 list[count] = child;
1279 device_get_driver(device_t dev)
1281 return(dev->driver);
1285 device_get_devclass(device_t dev)
1287 return(dev->devclass);
1291 device_get_name(device_t dev)
1294 return devclass_get_name(dev->devclass);
1299 device_get_nameunit(device_t dev)
1301 return(dev->nameunit);
1305 device_get_unit(device_t dev)
1311 device_get_desc(device_t dev)
1317 device_get_flags(device_t dev)
1319 return(dev->devflags);
1323 device_print_prettyname(device_t dev)
1325 const char *name = device_get_name(dev);
1328 return kprintf("unknown: ");
1330 return kprintf("%s%d: ", name, device_get_unit(dev));
1334 device_printf(device_t dev, const char * fmt, ...)
1339 retval = device_print_prettyname(dev);
1340 __va_start(ap, fmt);
1341 retval += kvprintf(fmt, ap);
1347 device_set_desc_internal(device_t dev, const char* desc, int copy)
1349 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1350 kfree(dev->desc, M_BUS);
1351 dev->flags &= ~DF_DESCMALLOCED;
1356 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1358 strcpy(dev->desc, desc);
1359 dev->flags |= DF_DESCMALLOCED;
1362 /* Avoid a -Wcast-qual warning */
1363 dev->desc = (char *)(uintptr_t) desc;
1366 bus_data_generation_update();
1370 device_set_desc(device_t dev, const char* desc)
1372 device_set_desc_internal(dev, desc, FALSE);
1376 device_set_desc_copy(device_t dev, const char* desc)
1378 device_set_desc_internal(dev, desc, TRUE);
1382 device_set_flags(device_t dev, uint32_t flags)
1384 dev->devflags = flags;
1388 device_get_softc(device_t dev)
1394 device_set_softc(device_t dev, void *softc)
1396 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1397 kfree(dev->softc, M_BUS);
1400 dev->flags |= DF_EXTERNALSOFTC;
1402 dev->flags &= ~DF_EXTERNALSOFTC;
1406 device_set_async_attach(device_t dev, int enable)
1409 dev->flags |= DF_ASYNCPROBE;
1411 dev->flags &= ~DF_ASYNCPROBE;
1415 device_get_ivars(device_t dev)
1421 device_set_ivars(device_t dev, void * ivars)
1430 device_get_state(device_t dev)
1436 device_enable(device_t dev)
1438 dev->flags |= DF_ENABLED;
1442 device_disable(device_t dev)
1444 dev->flags &= ~DF_ENABLED;
1451 device_busy(device_t dev)
1453 if (dev->state < DS_ATTACHED)
1454 panic("device_busy: called for unattached device");
1455 if (dev->busy == 0 && dev->parent)
1456 device_busy(dev->parent);
1458 dev->state = DS_BUSY;
1465 device_unbusy(device_t dev)
1467 if (dev->state != DS_BUSY)
1468 panic("device_unbusy: called for non-busy device");
1470 if (dev->busy == 0) {
1472 device_unbusy(dev->parent);
1473 dev->state = DS_ATTACHED;
1478 device_quiet(device_t dev)
1480 dev->flags |= DF_QUIET;
1484 device_verbose(device_t dev)
1486 dev->flags &= ~DF_QUIET;
1490 device_is_quiet(device_t dev)
1492 return((dev->flags & DF_QUIET) != 0);
1496 device_is_enabled(device_t dev)
1498 return((dev->flags & DF_ENABLED) != 0);
1502 device_is_alive(device_t dev)
1504 return(dev->state >= DS_ALIVE);
1508 device_is_attached(device_t dev)
1510 return(dev->state >= DS_ATTACHED);
1514 device_set_devclass(device_t dev, const char *classname)
1521 devclass_delete_device(dev->devclass, dev);
1525 if (dev->devclass) {
1526 kprintf("device_set_devclass: device class already set\n");
1530 dc = devclass_find_internal(classname, NULL, TRUE);
1534 error = devclass_add_device(dc, dev);
1536 bus_data_generation_update();
1541 device_set_driver(device_t dev, driver_t *driver)
1543 if (dev->state >= DS_ATTACHED)
1546 if (dev->driver == driver)
1549 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1550 kfree(dev->softc, M_BUS);
1553 kobj_delete((kobj_t) dev, 0);
1554 dev->driver = driver;
1556 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1557 if (!(dev->flags & DF_EXTERNALSOFTC)) {
1558 dev->softc = kmalloc(driver->size, M_BUS,
1559 M_INTWAIT | M_ZERO);
1561 kobj_delete((kobj_t)dev, 0);
1562 kobj_init((kobj_t) dev, &null_class);
1568 kobj_init((kobj_t) dev, &null_class);
1571 bus_data_generation_update();
1576 device_probe_and_attach(device_t dev)
1578 device_t bus = dev->parent;
1581 if (dev->state >= DS_ALIVE)
1584 if ((dev->flags & DF_ENABLED) == 0) {
1586 device_print_prettyname(dev);
1587 kprintf("not probed (disabled)\n");
1592 error = device_probe_child(bus, dev);
1594 if (!(dev->flags & DF_DONENOMATCH)) {
1595 BUS_PROBE_NOMATCH(bus, dev);
1597 dev->flags |= DF_DONENOMATCH;
1603 * Output the exact device chain prior to the attach in case the
1604 * system locks up during attach, and generate the full info after
1605 * the attach so correct irq and other information is displayed.
1607 if (bootverbose && !device_is_quiet(dev)) {
1610 kprintf("%s", device_get_nameunit(dev));
1611 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1612 kprintf(".%s", device_get_nameunit(tmp));
1615 if (!device_is_quiet(dev))
1616 device_print_child(bus, dev);
1617 if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1618 kprintf("%s: probing asynchronously\n",
1619 device_get_nameunit(dev));
1620 dev->state = DS_INPROGRESS;
1621 device_attach_async(dev);
1624 error = device_doattach(dev);
1630 * Device is known to be alive, do the attach asynchronously.
1632 * The MP lock is held by all threads.
1635 device_attach_async(device_t dev)
1639 atomic_add_int(&numasyncthreads, 1);
1640 lwkt_create(device_attach_thread, dev, &td, NULL,
1641 0, 0, (dev->desc ? dev->desc : "devattach"));
1645 device_attach_thread(void *arg)
1649 (void)device_doattach(dev);
1650 atomic_subtract_int(&numasyncthreads, 1);
1651 wakeup(&numasyncthreads);
1655 * Device is known to be alive, do the attach (synchronous or asynchronous)
1658 device_doattach(device_t dev)
1660 device_t bus = dev->parent;
1661 int hasclass = (dev->devclass != 0);
1664 error = DEVICE_ATTACH(dev);
1666 dev->state = DS_ATTACHED;
1667 if (bootverbose && !device_is_quiet(dev))
1668 device_print_child(bus, dev);
1671 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1672 dev->driver->name, dev->unit, error);
1673 /* Unset the class that was set in device_probe_child */
1675 device_set_devclass(dev, 0);
1676 device_set_driver(dev, NULL);
1677 dev->state = DS_NOTPRESENT;
1683 device_detach(device_t dev)
1687 PDEBUG(("%s", DEVICENAME(dev)));
1688 if (dev->state == DS_BUSY)
1690 if (dev->state != DS_ATTACHED)
1693 if ((error = DEVICE_DETACH(dev)) != 0)
1696 device_printf(dev, "detached\n");
1698 BUS_CHILD_DETACHED(dev->parent, dev);
1700 if (!(dev->flags & DF_FIXEDCLASS))
1701 devclass_delete_device(dev->devclass, dev);
1703 dev->state = DS_NOTPRESENT;
1704 device_set_driver(dev, NULL);
1710 device_shutdown(device_t dev)
1712 if (dev->state < DS_ATTACHED)
1714 PDEBUG(("%s", DEVICENAME(dev)));
1715 return DEVICE_SHUTDOWN(dev);
1719 device_set_unit(device_t dev, int unit)
1724 dc = device_get_devclass(dev);
1725 if (unit < dc->maxunit && dc->devices[unit])
1727 err = devclass_delete_device(dc, dev);
1731 err = devclass_add_device(dc, dev);
1735 bus_data_generation_update();
1739 /*======================================*/
1741 * Access functions for device resources.
1744 /* Supplied by config(8) in ioconf.c */
1745 extern struct config_device config_devtab[];
1746 extern int devtab_count;
1748 /* Runtime version */
1749 struct config_device *devtab = config_devtab;
1752 resource_new_name(const char *name, int unit)
1754 struct config_device *new;
1756 new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1757 M_INTWAIT | M_ZERO);
1760 if (devtab && devtab_count > 0)
1761 bcopy(devtab, new, devtab_count * sizeof(*new));
1762 new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1763 if (new[devtab_count].name == NULL) {
1767 strcpy(new[devtab_count].name, name);
1768 new[devtab_count].unit = unit;
1769 new[devtab_count].resource_count = 0;
1770 new[devtab_count].resources = NULL;
1771 if (devtab && devtab != config_devtab)
1772 kfree(devtab, M_TEMP);
1774 return devtab_count++;
1778 resource_new_resname(int j, const char *resname, resource_type type)
1780 struct config_resource *new;
1783 i = devtab[j].resource_count;
1784 new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1787 if (devtab[j].resources && i > 0)
1788 bcopy(devtab[j].resources, new, i * sizeof(*new));
1789 new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1790 if (new[i].name == NULL) {
1794 strcpy(new[i].name, resname);
1796 if (devtab[j].resources)
1797 kfree(devtab[j].resources, M_TEMP);
1798 devtab[j].resources = new;
1799 devtab[j].resource_count = i + 1;
1804 resource_match_string(int i, const char *resname, const char *value)
1807 struct config_resource *res;
1809 for (j = 0, res = devtab[i].resources;
1810 j < devtab[i].resource_count; j++, res++)
1811 if (!strcmp(res->name, resname)
1812 && res->type == RES_STRING
1813 && !strcmp(res->u.stringval, value))
1819 resource_find(const char *name, int unit, const char *resname,
1820 struct config_resource **result)
1823 struct config_resource *res;
1826 * First check specific instances, then generic.
1828 for (i = 0; i < devtab_count; i++) {
1829 if (devtab[i].unit < 0)
1831 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1832 res = devtab[i].resources;
1833 for (j = 0; j < devtab[i].resource_count; j++, res++)
1834 if (!strcmp(res->name, resname)) {
1840 for (i = 0; i < devtab_count; i++) {
1841 if (devtab[i].unit >= 0)
1843 /* XXX should this `&& devtab[i].unit == unit' be here? */
1844 /* XXX if so, then the generic match does nothing */
1845 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1846 res = devtab[i].resources;
1847 for (j = 0; j < devtab[i].resource_count; j++, res++)
1848 if (!strcmp(res->name, resname)) {
1858 resource_int_value(const char *name, int unit, const char *resname, int *result)
1861 struct config_resource *res;
1863 if ((error = resource_find(name, unit, resname, &res)) != 0)
1865 if (res->type != RES_INT)
1867 *result = res->u.intval;
1872 resource_long_value(const char *name, int unit, const char *resname,
1876 struct config_resource *res;
1878 if ((error = resource_find(name, unit, resname, &res)) != 0)
1880 if (res->type != RES_LONG)
1882 *result = res->u.longval;
1887 resource_string_value(const char *name, int unit, const char *resname,
1891 struct config_resource *res;
1893 if ((error = resource_find(name, unit, resname, &res)) != 0)
1895 if (res->type != RES_STRING)
1897 *result = res->u.stringval;
1902 resource_query_string(int i, const char *resname, const char *value)
1908 for (; i < devtab_count; i++)
1909 if (resource_match_string(i, resname, value) >= 0)
1915 resource_locate(int i, const char *resname)
1921 for (; i < devtab_count; i++)
1922 if (!strcmp(devtab[i].name, resname))
1928 resource_count(void)
1930 return(devtab_count);
1934 resource_query_name(int i)
1936 return(devtab[i].name);
1940 resource_query_unit(int i)
1942 return(devtab[i].unit);
1946 resource_create(const char *name, int unit, const char *resname,
1947 resource_type type, struct config_resource **result)
1950 struct config_resource *res = NULL;
1952 for (i = 0; i < devtab_count; i++)
1953 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1954 res = devtab[i].resources;
1958 i = resource_new_name(name, unit);
1961 res = devtab[i].resources;
1963 for (j = 0; j < devtab[i].resource_count; j++, res++)
1964 if (!strcmp(res->name, resname)) {
1968 j = resource_new_resname(i, resname, type);
1971 res = &devtab[i].resources[j];
1977 resource_set_int(const char *name, int unit, const char *resname, int value)
1980 struct config_resource *res;
1982 error = resource_create(name, unit, resname, RES_INT, &res);
1985 if (res->type != RES_INT)
1987 res->u.intval = value;
1992 resource_set_long(const char *name, int unit, const char *resname, long value)
1995 struct config_resource *res;
1997 error = resource_create(name, unit, resname, RES_LONG, &res);
2000 if (res->type != RES_LONG)
2002 res->u.longval = value;
2007 resource_set_string(const char *name, int unit, const char *resname,
2011 struct config_resource *res;
2013 error = resource_create(name, unit, resname, RES_STRING, &res);
2016 if (res->type != RES_STRING)
2018 if (res->u.stringval)
2019 kfree(res->u.stringval, M_TEMP);
2020 res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2021 if (res->u.stringval == NULL)
2023 strcpy(res->u.stringval, value);
2028 resource_cfgload(void *dummy __unused)
2030 struct config_resource *res, *cfgres;
2033 char *name, *resname;
2037 int config_devtab_count;
2039 config_devtab_count = devtab_count;
2043 for (i = 0; i < config_devtab_count; i++) {
2044 name = config_devtab[i].name;
2045 unit = config_devtab[i].unit;
2047 for (j = 0; j < config_devtab[i].resource_count; j++) {
2048 cfgres = config_devtab[i].resources;
2049 resname = cfgres[j].name;
2050 type = cfgres[j].type;
2051 error = resource_create(name, unit, resname, type,
2054 kprintf("create resource %s%d: error %d\n",
2058 if (res->type != type) {
2059 kprintf("type mismatch %s%d: %d != %d\n",
2060 name, unit, res->type, type);
2065 res->u.intval = cfgres[j].u.intval;
2068 res->u.longval = cfgres[j].u.longval;
2071 if (res->u.stringval)
2072 kfree(res->u.stringval, M_TEMP);
2073 stringval = cfgres[j].u.stringval;
2074 res->u.stringval = kmalloc(strlen(stringval) + 1,
2076 if (res->u.stringval == NULL)
2078 strcpy(res->u.stringval, stringval);
2081 panic("unknown resource type %d", type);
2086 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2089 /*======================================*/
2091 * Some useful method implementations to make life easier for bus drivers.
2095 resource_list_init(struct resource_list *rl)
2101 resource_list_free(struct resource_list *rl)
2103 struct resource_list_entry *rle;
2105 while ((rle = SLIST_FIRST(rl)) != NULL) {
2107 panic("resource_list_free: resource entry is busy");
2108 SLIST_REMOVE_HEAD(rl, link);
2114 resource_list_add(struct resource_list *rl,
2116 u_long start, u_long end, u_long count)
2118 struct resource_list_entry *rle;
2120 rle = resource_list_find(rl, type, rid);
2122 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2125 panic("resource_list_add: can't record entry");
2126 SLIST_INSERT_HEAD(rl, rle, link);
2133 panic("resource_list_add: resource entry is busy");
2140 struct resource_list_entry*
2141 resource_list_find(struct resource_list *rl,
2144 struct resource_list_entry *rle;
2146 SLIST_FOREACH(rle, rl, link)
2147 if (rle->type == type && rle->rid == rid)
2153 resource_list_delete(struct resource_list *rl,
2156 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2159 if (rle->res != NULL)
2160 panic("resource_list_delete: resource has not been released");
2161 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2167 resource_list_alloc(struct resource_list *rl,
2168 device_t bus, device_t child,
2170 u_long start, u_long end,
2171 u_long count, u_int flags)
2173 struct resource_list_entry *rle = 0;
2174 int passthrough = (device_get_parent(child) != bus);
2175 int isdefault = (start == 0UL && end == ~0UL);
2178 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2180 start, end, count, flags));
2183 rle = resource_list_find(rl, type, *rid);
2186 return(0); /* no resource of that type/rid */
2189 panic("resource_list_alloc: resource entry is busy");
2193 count = max(count, rle->count);
2194 end = max(rle->end, start + count - 1);
2197 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2198 type, rid, start, end, count, flags);
2201 * Record the new range.
2204 rle->start = rman_get_start(rle->res);
2205 rle->end = rman_get_end(rle->res);
2213 resource_list_release(struct resource_list *rl,
2214 device_t bus, device_t child,
2215 int type, int rid, struct resource *res)
2217 struct resource_list_entry *rle = 0;
2218 int passthrough = (device_get_parent(child) != bus);
2222 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2226 rle = resource_list_find(rl, type, rid);
2229 panic("resource_list_release: can't find resource");
2231 panic("resource_list_release: resource entry is not busy");
2233 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2243 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2246 struct resource_list_entry *rle;
2247 int printed, retval;
2251 /* Yes, this is kinda cheating */
2252 SLIST_FOREACH(rle, rl, link) {
2253 if (rle->type == type) {
2255 retval += kprintf(" %s ", name);
2257 retval += kprintf(",");
2259 retval += kprintf(format, rle->start);
2260 if (rle->count > 1) {
2261 retval += kprintf("-");
2262 retval += kprintf(format, rle->start +
2271 * Generic driver/device identify functions. These will install a device
2272 * rendezvous point under the parent using the same name as the driver
2273 * name, which will at a later time be probed and attached.
2275 * These functions are used when the parent does not 'scan' its bus for
2276 * matching devices, or for the particular devices using these functions,
2277 * or when the device is a pseudo or synthesized device (such as can be
2278 * found under firewire and ppbus).
2281 bus_generic_identify(driver_t *driver, device_t parent)
2283 if (parent->state == DS_ATTACHED)
2285 BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2290 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2292 if (parent->state == DS_ATTACHED)
2294 BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2299 * Call DEVICE_IDENTIFY for each driver.
2302 bus_generic_probe(device_t dev)
2304 devclass_t dc = dev->devclass;
2307 TAILQ_FOREACH(dl, &dc->drivers, link) {
2308 DEVICE_IDENTIFY(dl->driver, dev);
2315 * This is an aweful hack due to the isa bus and autoconf code not
2316 * probing the ISA devices until after everything else has configured.
2317 * The ISA bus did a dummy attach long ago so we have to set it back
2318 * to an earlier state so the probe thinks its the initial probe and
2321 * XXX remove by properly defering the ISA bus scan.
2324 bus_generic_probe_hack(device_t dev)
2326 if (dev->state == DS_ATTACHED) {
2327 dev->state = DS_ALIVE;
2328 bus_generic_probe(dev);
2329 dev->state = DS_ATTACHED;
2335 bus_generic_attach(device_t dev)
2339 TAILQ_FOREACH(child, &dev->children, link) {
2340 device_probe_and_attach(child);
2347 bus_generic_detach(device_t dev)
2352 if (dev->state != DS_ATTACHED)
2355 TAILQ_FOREACH(child, &dev->children, link)
2356 if ((error = device_detach(child)) != 0)
2363 bus_generic_shutdown(device_t dev)
2367 TAILQ_FOREACH(child, &dev->children, link)
2368 device_shutdown(child);
2374 bus_generic_suspend(device_t dev)
2377 device_t child, child2;
2379 TAILQ_FOREACH(child, &dev->children, link) {
2380 error = DEVICE_SUSPEND(child);
2382 for (child2 = TAILQ_FIRST(&dev->children);
2383 child2 && child2 != child;
2384 child2 = TAILQ_NEXT(child2, link))
2385 DEVICE_RESUME(child2);
2393 bus_generic_resume(device_t dev)
2397 TAILQ_FOREACH(child, &dev->children, link)
2398 DEVICE_RESUME(child);
2399 /* if resume fails, there's nothing we can usefully do... */
2405 bus_print_child_header(device_t dev, device_t child)
2409 if (device_get_desc(child))
2410 retval += device_printf(child, "<%s>", device_get_desc(child));
2412 retval += kprintf("%s", device_get_nameunit(child));
2414 if (child->state != DS_ATTACHED)
2415 kprintf(" [tentative]");
2417 kprintf(" [attached!]");
2423 bus_print_child_footer(device_t dev, device_t child)
2425 return(kprintf(" on %s\n", device_get_nameunit(dev)));
2429 bus_generic_add_child(device_t dev, device_t child, int order,
2430 const char *name, int unit)
2433 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2435 dev = device_add_child_ordered(child, order, name, unit);
2441 bus_generic_print_child(device_t dev, device_t child)
2445 retval += bus_print_child_header(dev, child);
2446 retval += bus_print_child_footer(dev, child);
2452 bus_generic_read_ivar(device_t dev, device_t child, int index,
2458 error = BUS_READ_IVAR(dev->parent, child, index, result);
2465 bus_generic_write_ivar(device_t dev, device_t child, int index,
2471 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2478 * Resource list are used for iterations, do not recurse.
2480 struct resource_list *
2481 bus_generic_get_resource_list(device_t dev, device_t child)
2487 bus_generic_driver_added(device_t dev, driver_t *driver)
2491 DEVICE_IDENTIFY(driver, dev);
2492 TAILQ_FOREACH(child, &dev->children, link) {
2493 if (child->state == DS_NOTPRESENT)
2494 device_probe_and_attach(child);
2499 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2500 int flags, driver_intr_t *intr, void *arg,
2501 void **cookiep, lwkt_serialize_t serializer)
2503 /* Propagate up the bus hierarchy until someone handles it. */
2505 return(BUS_SETUP_INTR(dev->parent, child, irq, flags,
2506 intr, arg, cookiep, serializer));
2512 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2515 /* Propagate up the bus hierarchy until someone handles it. */
2517 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2523 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2526 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2532 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2535 BUS_ENABLE_INTR(dev->parent, child, cookie);
2539 bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig,
2540 enum intr_polarity pol)
2542 /* Propagate up the bus hierarchy until someone handles it. */
2544 return(BUS_CONFIG_INTR(dev->parent, irq, trig, pol));
2550 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2551 u_long start, u_long end, u_long count, u_int flags)
2553 /* Propagate up the bus hierarchy until someone handles it. */
2555 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2556 start, end, count, flags));
2562 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2565 /* Propagate up the bus hierarchy until someone handles it. */
2567 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2573 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2576 /* Propagate up the bus hierarchy until someone handles it. */
2578 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2584 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2585 int rid, struct resource *r)
2587 /* Propagate up the bus hierarchy until someone handles it. */
2589 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2596 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2597 u_long *startp, u_long *countp)
2603 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2610 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2611 u_long start, u_long count)
2617 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2624 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2627 BUS_DELETE_RESOURCE(dev, child, type, rid);
2631 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2632 u_long *startp, u_long *countp)
2634 struct resource_list *rl = NULL;
2635 struct resource_list_entry *rle = NULL;
2637 rl = BUS_GET_RESOURCE_LIST(dev, child);
2641 rle = resource_list_find(rl, type, rid);
2646 *startp = rle->start;
2648 *countp = rle->count;
2654 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2655 u_long start, u_long count)
2657 struct resource_list *rl = NULL;
2659 rl = BUS_GET_RESOURCE_LIST(dev, child);
2663 resource_list_add(rl, type, rid, start, (start + count - 1), count);
2669 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2671 struct resource_list *rl = NULL;
2673 rl = BUS_GET_RESOURCE_LIST(dev, child);
2677 resource_list_delete(rl, type, rid);
2681 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2682 int rid, struct resource *r)
2684 struct resource_list *rl = NULL;
2686 rl = BUS_GET_RESOURCE_LIST(dev, child);
2690 return(resource_list_release(rl, dev, child, type, rid, r));
2694 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2695 int *rid, u_long start, u_long end, u_long count, u_int flags)
2697 struct resource_list *rl = NULL;
2699 rl = BUS_GET_RESOURCE_LIST(dev, child);
2703 return(resource_list_alloc(rl, dev, child, type, rid,
2704 start, end, count, flags));
2708 bus_generic_child_present(device_t bus, device_t child)
2710 return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2715 * Some convenience functions to make it easier for drivers to use the
2716 * resource-management functions. All these really do is hide the
2717 * indirection through the parent's method table, making for slightly
2718 * less-wordy code. In the future, it might make sense for this code
2719 * to maintain some sort of a list of resources allocated by each device.
2722 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2723 struct resource **res)
2727 for (i = 0; rs[i].type != -1; i++)
2729 for (i = 0; rs[i].type != -1; i++) {
2730 res[i] = bus_alloc_resource_any(dev,
2731 rs[i].type, &rs[i].rid, rs[i].flags);
2732 if (res[i] == NULL) {
2733 bus_release_resources(dev, rs, res);
2741 bus_release_resources(device_t dev, const struct resource_spec *rs,
2742 struct resource **res)
2746 for (i = 0; rs[i].type != -1; i++)
2747 if (res[i] != NULL) {
2748 bus_release_resource(
2749 dev, rs[i].type, rs[i].rid, res[i]);
2755 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2756 u_long count, u_int flags)
2758 if (dev->parent == 0)
2760 return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2765 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2767 if (dev->parent == 0)
2769 return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2773 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2775 if (dev->parent == 0)
2777 return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2781 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2783 if (dev->parent == 0)
2785 return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2789 bus_setup_intr(device_t dev, struct resource *r, int flags,
2790 driver_intr_t handler, void *arg,
2791 void **cookiep, lwkt_serialize_t serializer)
2793 if (dev->parent == 0)
2795 return(BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2796 cookiep, serializer));
2800 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2802 if (dev->parent == 0)
2804 return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2808 bus_enable_intr(device_t dev, void *cookie)
2811 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2815 bus_disable_intr(device_t dev, void *cookie)
2818 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2824 bus_set_resource(device_t dev, int type, int rid,
2825 u_long start, u_long count)
2827 return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2832 bus_get_resource(device_t dev, int type, int rid,
2833 u_long *startp, u_long *countp)
2835 return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2840 bus_get_resource_start(device_t dev, int type, int rid)
2842 u_long start, count;
2845 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2853 bus_get_resource_count(device_t dev, int type, int rid)
2855 u_long start, count;
2858 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2866 bus_delete_resource(device_t dev, int type, int rid)
2868 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2872 bus_child_present(device_t child)
2874 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
2878 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
2882 parent = device_get_parent(child);
2883 if (parent == NULL) {
2887 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
2891 bus_child_location_str(device_t child, char *buf, size_t buflen)
2895 parent = device_get_parent(child);
2896 if (parent == NULL) {
2900 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
2904 root_print_child(device_t dev, device_t child)
2910 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
2911 void **cookiep, lwkt_serialize_t serializer)
2914 * If an interrupt mapping gets to here something bad has happened.
2916 panic("root_setup_intr");
2920 * If we get here, assume that the device is permanant and really is
2921 * present in the system. Removable bus drivers are expected to intercept
2922 * this call long before it gets here. We return -1 so that drivers that
2923 * really care can check vs -1 or some ERRNO returned higher in the food
2927 root_child_present(device_t dev, device_t child)
2933 * XXX NOTE! other defaults may be set in bus_if.m
2935 static kobj_method_t root_methods[] = {
2936 /* Device interface */
2937 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
2938 KOBJMETHOD(device_suspend, bus_generic_suspend),
2939 KOBJMETHOD(device_resume, bus_generic_resume),
2942 KOBJMETHOD(bus_add_child, bus_generic_add_child),
2943 KOBJMETHOD(bus_print_child, root_print_child),
2944 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
2945 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
2946 KOBJMETHOD(bus_setup_intr, root_setup_intr),
2947 KOBJMETHOD(bus_child_present, root_child_present),
2952 static driver_t root_driver = {
2959 devclass_t root_devclass;
2962 root_bus_module_handler(module_t mod, int what, void* arg)
2966 TAILQ_INIT(&bus_data_devices);
2967 root_bus = make_device(NULL, "root", 0);
2968 root_bus->desc = "System root bus";
2969 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
2970 root_bus->driver = &root_driver;
2971 root_bus->state = DS_ALIVE;
2972 root_devclass = devclass_find_internal("root", NULL, FALSE);
2977 device_shutdown(root_bus);
2984 static moduledata_t root_bus_mod = {
2986 root_bus_module_handler,
2989 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
2992 root_bus_configure(void)
3000 * handle device_identify based device attachments to the root_bus
3001 * (typically nexus).
3003 bus_generic_probe(root_bus);
3006 * Probe and attach the devices under root_bus.
3008 TAILQ_FOREACH(dev, &root_bus->children, link) {
3009 device_probe_and_attach(dev);
3013 * Wait for all asynchronous attaches to complete. If we don't
3014 * our legacy ISA bus scan could steal device unit numbers or
3018 if (numasyncthreads)
3019 kprintf("Waiting for async drivers to attach\n");
3020 while (numasyncthreads > 0) {
3021 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3023 if (warncount == 0) {
3024 kprintf("Warning: Still waiting for %d "
3025 "drivers to attach\n", numasyncthreads);
3026 } else if (warncount == -30) {
3027 kprintf("Giving up on %d drivers\n", numasyncthreads);
3031 root_bus->state = DS_ATTACHED;
3035 driver_module_handler(module_t mod, int what, void *arg)
3038 struct driver_module_data *dmd;
3039 devclass_t bus_devclass;
3040 kobj_class_t driver;
3041 const char *parentname;
3043 dmd = (struct driver_module_data *)arg;
3044 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3049 if (dmd->dmd_chainevh)
3050 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3052 driver = dmd->dmd_driver;
3053 PDEBUG(("Loading module: driver %s on bus %s",
3054 DRIVERNAME(driver), dmd->dmd_busname));
3057 * If the driver has any base classes, make the
3058 * devclass inherit from the devclass of the driver's
3059 * first base class. This will allow the system to
3060 * search for drivers in both devclasses for children
3061 * of a device using this driver.
3063 if (driver->baseclasses)
3064 parentname = driver->baseclasses[0]->name;
3067 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3070 error = devclass_add_driver(bus_devclass, driver);
3076 PDEBUG(("Unloading module: driver %s from bus %s",
3077 DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3078 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3080 if (!error && dmd->dmd_chainevh)
3081 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3091 * The _short versions avoid iteration by not calling anything that prints
3092 * more than oneliners. I love oneliners.
3096 print_device_short(device_t dev, int indent)
3101 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3102 dev->unit, dev->desc,
3103 (dev->parent? "":"no "),
3104 (TAILQ_EMPTY(&dev->children)? "no ":""),
3105 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3106 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3107 (dev->flags&DF_WILDCARD? "wildcard,":""),
3108 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3109 (dev->ivars? "":"no "),
3110 (dev->softc? "":"no "),
3115 print_device(device_t dev, int indent)
3120 print_device_short(dev, indent);
3122 indentprintf(("Parent:\n"));
3123 print_device_short(dev->parent, indent+1);
3124 indentprintf(("Driver:\n"));
3125 print_driver_short(dev->driver, indent+1);
3126 indentprintf(("Devclass:\n"));
3127 print_devclass_short(dev->devclass, indent+1);
3131 * Print the device and all its children (indented).
3134 print_device_tree_short(device_t dev, int indent)
3141 print_device_short(dev, indent);
3143 TAILQ_FOREACH(child, &dev->children, link)
3144 print_device_tree_short(child, indent+1);
3148 * Print the device and all its children (indented).
3151 print_device_tree(device_t dev, int indent)
3158 print_device(dev, indent);
3160 TAILQ_FOREACH(child, &dev->children, link)
3161 print_device_tree(child, indent+1);
3165 print_driver_short(driver_t *driver, int indent)
3170 indentprintf(("driver %s: softc size = %d\n",
3171 driver->name, driver->size));
3175 print_driver(driver_t *driver, int indent)
3180 print_driver_short(driver, indent);
3185 print_driver_list(driver_list_t drivers, int indent)
3187 driverlink_t driver;
3189 TAILQ_FOREACH(driver, &drivers, link)
3190 print_driver(driver->driver, indent);
3194 print_devclass_short(devclass_t dc, int indent)
3199 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3203 print_devclass(devclass_t dc, int indent)
3210 print_devclass_short(dc, indent);
3211 indentprintf(("Drivers:\n"));
3212 print_driver_list(dc->drivers, indent+1);
3214 indentprintf(("Devices:\n"));
3215 for (i = 0; i < dc->maxunit; i++)
3217 print_device(dc->devices[i], indent+1);
3221 print_devclass_list_short(void)
3225 kprintf("Short listing of devclasses, drivers & devices:\n");
3226 TAILQ_FOREACH(dc, &devclasses, link) {
3227 print_devclass_short(dc, 0);
3232 print_devclass_list(void)
3236 kprintf("Full listing of devclasses, drivers & devices:\n");
3237 TAILQ_FOREACH(dc, &devclasses, link) {
3238 print_devclass(dc, 0);
3245 * Check to see if a device is disabled via a disabled hint.
3248 resource_disabled(const char *name, int unit)
3252 error = resource_int_value(name, unit, "disabled", &value);
3259 * User-space access to the device tree.
3261 * We implement a small set of nodes:
3263 * hw.bus Single integer read method to obtain the
3264 * current generation count.
3265 * hw.bus.devices Reads the entire device tree in flat space.
3266 * hw.bus.rman Resource manager interface
3268 * We might like to add the ability to scan devclasses and/or drivers to
3269 * determine what else is currently loaded/available.
3273 sysctl_bus(SYSCTL_HANDLER_ARGS)
3275 struct u_businfo ubus;
3277 ubus.ub_version = BUS_USER_VERSION;
3278 ubus.ub_generation = bus_data_generation;
3280 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3282 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3283 "bus-related data");
3286 sysctl_devices(SYSCTL_HANDLER_ARGS)
3288 int *name = (int *)arg1;
3289 u_int namelen = arg2;
3292 struct u_device udev; /* XXX this is a bit big */
3298 if (bus_data_generation_check(name[0]))
3304 * Scan the list of devices, looking for the requested index.
3306 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3314 * Populate the return array.
3316 bzero(&udev, sizeof(udev));
3317 udev.dv_handle = (uintptr_t)dev;
3318 udev.dv_parent = (uintptr_t)dev->parent;
3319 if (dev->nameunit != NULL)
3320 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3321 if (dev->desc != NULL)
3322 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3323 if (dev->driver != NULL && dev->driver->name != NULL)
3324 strlcpy(udev.dv_drivername, dev->driver->name,
3325 sizeof(udev.dv_drivername));
3326 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3327 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3328 udev.dv_devflags = dev->devflags;
3329 udev.dv_flags = dev->flags;
3330 udev.dv_state = dev->state;
3331 error = SYSCTL_OUT(req, &udev, sizeof(udev));
3335 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3336 "system device tree");
3339 bus_data_generation_check(int generation)
3341 if (generation != bus_data_generation)
3344 /* XXX generate optimised lists here? */
3349 bus_data_generation_update(void)
3351 bus_data_generation++;