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>
55 #include <sys/mplock2.h>
57 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
59 MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
62 #define PDEBUG(a) (kprintf("%s:%d: ", __func__, __LINE__), kprintf a, kprintf("\n"))
63 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
64 #define DRIVERNAME(d) ((d)? d->name : "no driver")
65 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
67 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to
68 * prevent syslog from deleting initial spaces
70 #define indentprintf(p) do { int iJ; kprintf("."); for (iJ=0; iJ<indent; iJ++) kprintf(" "); kprintf p ; } while(0)
72 static void print_device_short(device_t dev, int indent);
73 static void print_device(device_t dev, int indent);
74 void print_device_tree_short(device_t dev, int indent);
75 void print_device_tree(device_t dev, int indent);
76 static void print_driver_short(driver_t *driver, int indent);
77 static void print_driver(driver_t *driver, int indent);
78 static void print_driver_list(driver_list_t drivers, int indent);
79 static void print_devclass_short(devclass_t dc, int indent);
80 static void print_devclass(devclass_t dc, int indent);
81 void print_devclass_list_short(void);
82 void print_devclass_list(void);
85 /* Make the compiler ignore the function calls */
86 #define PDEBUG(a) /* nop */
87 #define DEVICENAME(d) /* nop */
88 #define DRIVERNAME(d) /* nop */
89 #define DEVCLANAME(d) /* nop */
91 #define print_device_short(d,i) /* nop */
92 #define print_device(d,i) /* nop */
93 #define print_device_tree_short(d,i) /* nop */
94 #define print_device_tree(d,i) /* nop */
95 #define print_driver_short(d,i) /* nop */
96 #define print_driver(d,i) /* nop */
97 #define print_driver_list(d,i) /* nop */
98 #define print_devclass_short(d,i) /* nop */
99 #define print_devclass(d,i) /* nop */
100 #define print_devclass_list_short() /* nop */
101 #define print_devclass_list() /* nop */
104 static void device_attach_async(device_t dev);
105 static void device_attach_thread(void *arg);
106 static int device_doattach(device_t dev);
108 static int do_async_attach = 0;
109 static int numasyncthreads;
110 TUNABLE_INT("kern.do_async_attach", &do_async_attach);
113 * /dev/devctl implementation
117 * This design allows only one reader for /dev/devctl. This is not desirable
118 * in the long run, but will get a lot of hair out of this implementation.
119 * Maybe we should make this device a clonable device.
121 * Also note: we specifically do not attach a device to the device_t tree
122 * to avoid potential chicken and egg problems. One could argue that all
123 * of this belongs to the root node. One could also further argue that the
124 * sysctl interface that we have not might more properly be an ioctl
125 * interface, but at this stage of the game, I'm not inclined to rock that
128 * I'm also not sure that the SIGIO support is done correctly or not, as
129 * I copied it from a driver that had SIGIO support that likely hasn't been
130 * tested since 3.4 or 2.2.8!
133 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
134 static int devctl_disable = 0;
135 TUNABLE_INT("hw.bus.devctl_disable", &devctl_disable);
136 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
137 sysctl_devctl_disable, "I", "devctl disable");
139 #define CDEV_MAJOR 188
141 static d_open_t devopen;
142 static d_close_t devclose;
143 static d_read_t devread;
144 static d_ioctl_t devioctl;
145 static d_poll_t devpoll;
147 static struct dev_ops devctl_ops = {
148 { "devctl", CDEV_MAJOR, 0 },
156 struct dev_event_info
159 TAILQ_ENTRY(dev_event_info) dei_link;
162 TAILQ_HEAD(devq, dev_event_info);
164 static struct dev_softc
171 struct proc *async_proc;
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);
226 tsleep_interlock(&devsoftc, PCATCH);
227 lockmgr(&devsoftc.lock, LK_RELEASE);
228 rv = tsleep(&devsoftc, PCATCH | PINTERLOCKED, "devctl", 0);
229 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
232 * Need to translate ERESTART to EINTR here? -- jake
234 lockmgr(&devsoftc.lock, LK_RELEASE);
238 n1 = TAILQ_FIRST(&devsoftc.devq);
239 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
240 lockmgr(&devsoftc.lock, LK_RELEASE);
241 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
242 kfree(n1->dei_data, M_BUS);
248 devioctl(struct dev_ioctl_args *ap)
253 if (*(int*)ap->a_data)
254 devsoftc.nonblock = 1;
256 devsoftc.nonblock = 0;
259 if (*(int*)ap->a_data)
260 devsoftc.async_proc = curproc;
262 devsoftc.async_proc = NULL;
265 /* (un)Support for other fcntl() calls. */
278 devpoll(struct dev_poll_args *ap)
282 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
283 if (ap->a_events & (POLLIN | POLLRDNORM)) {
284 if (!TAILQ_EMPTY(&devsoftc.devq))
285 revents = ap->a_events & (POLLIN | POLLRDNORM);
287 selrecord(curthread, &devsoftc.sel);
289 lockmgr(&devsoftc.lock, LK_RELEASE);
291 ap->a_events = revents;
296 * @brief Return whether the userland process is running
299 devctl_process_running(void)
301 return (devsoftc.inuse == 1);
305 * @brief Queue data to be read from the devctl device
307 * Generic interface to queue data to the devctl device. It is
308 * assumed that @p data is properly formatted. It is further assumed
309 * that @p data is allocated using the M_BUS malloc type.
312 devctl_queue_data(char *data)
314 struct dev_event_info *n1 = NULL;
317 n1 = kmalloc(sizeof(*n1), M_BUS, M_NOWAIT);
321 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
322 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
324 lockmgr(&devsoftc.lock, LK_RELEASE);
325 get_mplock(); /* XXX */
326 selwakeup(&devsoftc.sel);
327 rel_mplock(); /* XXX */
328 p = devsoftc.async_proc;
334 * @brief Send a 'notification' to userland, using standard ways
337 devctl_notify(const char *system, const char *subsystem, const char *type,
344 return; /* BOGUS! Must specify system. */
345 if (subsystem == NULL)
346 return; /* BOGUS! Must specify subsystem. */
348 return; /* BOGUS! Must specify type. */
349 len += strlen(" system=") + strlen(system);
350 len += strlen(" subsystem=") + strlen(subsystem);
351 len += strlen(" type=") + strlen(type);
352 /* add in the data message plus newline. */
355 len += 3; /* '!', '\n', and NUL */
356 msg = kmalloc(len, M_BUS, M_NOWAIT);
358 return; /* Drop it on the floor */
360 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
361 system, subsystem, type, data);
363 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
364 system, subsystem, type);
365 devctl_queue_data(msg);
369 * Common routine that tries to make sending messages as easy as possible.
370 * We allocate memory for the data, copy strings into that, but do not
371 * free it unless there's an error. The dequeue part of the driver should
372 * free the data. We don't send data when the device is disabled. We do
373 * send data, even when we have no listeners, because we wish to avoid
374 * races relating to startup and restart of listening applications.
376 * devaddq is designed to string together the type of event, with the
377 * object of that event, plus the plug and play info and location info
378 * for that event. This is likely most useful for devices, but less
379 * useful for other consumers of this interface. Those should use
380 * the devctl_queue_data() interface instead.
383 devaddq(const char *type, const char *what, device_t dev)
392 data = kmalloc(1024, M_BUS, M_NOWAIT);
396 /* get the bus specific location of this device */
397 loc = kmalloc(1024, M_BUS, M_NOWAIT);
401 bus_child_location_str(dev, loc, 1024);
403 /* Get the bus specific pnp info of this device */
404 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
408 bus_child_pnpinfo_str(dev, pnp, 1024);
410 /* Get the parent of this device, or / if high enough in the tree. */
411 if (device_get_parent(dev) == NULL)
412 parstr = "."; /* Or '/' ? */
414 parstr = device_get_nameunit(device_get_parent(dev));
415 /* String it all together. */
416 ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
420 devctl_queue_data(data);
430 * A device was added to the tree. We are called just after it successfully
431 * attaches (that is, probe and attach success for this device). No call
432 * is made if a device is merely parented into the tree. See devnomatch
433 * if probe fails. If attach fails, no notification is sent (but maybe
434 * we should have a different message for this).
437 devadded(device_t dev)
442 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
445 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
449 bus_child_pnpinfo_str(dev, pnp, 1024);
450 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
451 devaddq("+", tmp, dev);
461 * A device was removed from the tree. We are called just before this
465 devremoved(device_t dev)
470 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
473 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
477 bus_child_pnpinfo_str(dev, pnp, 1024);
478 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
479 devaddq("-", tmp, dev);
489 * Called when there's no match for this device. This is only called
490 * the first time that no match happens, so we don't keep getitng this
491 * message. Should that prove to be undesirable, we can change it.
492 * This is called when all drivers that can attach to a given bus
493 * decline to accept this device. Other errrors may not be detected.
496 devnomatch(device_t dev)
498 devaddq("?", "", dev);
502 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
504 struct dev_event_info *n1;
507 dis = devctl_disable;
508 error = sysctl_handle_int(oidp, &dis, 0, req);
509 if (error || !req->newptr)
511 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
512 devctl_disable = dis;
514 while (!TAILQ_EMPTY(&devsoftc.devq)) {
515 n1 = TAILQ_FIRST(&devsoftc.devq);
516 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
517 kfree(n1->dei_data, M_BUS);
521 lockmgr(&devsoftc.lock, LK_RELEASE);
525 /* End of /dev/devctl code */
527 TAILQ_HEAD(,device) bus_data_devices;
528 static int bus_data_generation = 1;
530 kobj_method_t null_methods[] = {
534 DEFINE_CLASS(null, null_methods, 0);
537 * Devclass implementation
540 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
543 devclass_find_internal(const char *classname, const char *parentname,
548 PDEBUG(("looking for %s", classname));
549 if (classname == NULL)
552 TAILQ_FOREACH(dc, &devclasses, link)
553 if (!strcmp(dc->name, classname))
557 PDEBUG(("creating %s", classname));
558 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
559 M_BUS, M_INTWAIT | M_ZERO);
563 dc->name = (char*) (dc + 1);
564 strcpy(dc->name, classname);
567 TAILQ_INIT(&dc->drivers);
568 TAILQ_INSERT_TAIL(&devclasses, dc, link);
570 bus_data_generation_update();
573 if (parentname && dc && !dc->parent)
574 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
580 devclass_create(const char *classname)
582 return(devclass_find_internal(classname, NULL, TRUE));
586 devclass_find(const char *classname)
588 return(devclass_find_internal(classname, NULL, FALSE));
592 devclass_find_unit(const char *classname, int unit)
596 if ((dc = devclass_find(classname)) != NULL)
597 return(devclass_get_device(dc, unit));
602 devclass_add_driver(devclass_t dc, driver_t *driver)
608 PDEBUG(("%s", DRIVERNAME(driver)));
610 dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
615 * Compile the driver's methods. Also increase the reference count
616 * so that the class doesn't get freed when the last instance
617 * goes. This means we can safely use static methods and avoids a
618 * double-free in devclass_delete_driver.
620 kobj_class_instantiate(driver);
623 * Make sure the devclass which the driver is implementing exists.
625 devclass_find_internal(driver->name, NULL, TRUE);
628 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
631 * Call BUS_DRIVER_ADDED for any existing busses in this class,
632 * but only if the bus has already been attached (otherwise we
633 * might probe too early).
635 * This is what will cause a newly loaded module to be associated
636 * with hardware. bus_generic_driver_added() is typically what ends
639 for (i = 0; i < dc->maxunit; i++) {
640 if ((dev = dc->devices[i]) != NULL) {
641 if (dev->state >= DS_ATTACHED)
642 BUS_DRIVER_ADDED(dev, driver);
646 bus_data_generation_update();
651 devclass_delete_driver(devclass_t busclass, driver_t *driver)
653 devclass_t dc = devclass_find(driver->name);
659 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
665 * Find the link structure in the bus' list of drivers.
667 TAILQ_FOREACH(dl, &busclass->drivers, link)
668 if (dl->driver == driver)
672 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
677 * Disassociate from any devices. We iterate through all the
678 * devices in the devclass of the driver and detach any which are
679 * using the driver and which have a parent in the devclass which
680 * we are deleting from.
682 * Note that since a driver can be in multiple devclasses, we
683 * should not detach devices which are not children of devices in
684 * the affected devclass.
686 for (i = 0; i < dc->maxunit; i++)
687 if (dc->devices[i]) {
688 dev = dc->devices[i];
689 if (dev->driver == driver && dev->parent &&
690 dev->parent->devclass == busclass) {
691 if ((error = device_detach(dev)) != 0)
693 device_set_driver(dev, NULL);
697 TAILQ_REMOVE(&busclass->drivers, dl, link);
700 kobj_class_uninstantiate(driver);
702 bus_data_generation_update();
707 devclass_find_driver_internal(devclass_t dc, const char *classname)
711 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
713 TAILQ_FOREACH(dl, &dc->drivers, link)
714 if (!strcmp(dl->driver->name, classname))
717 PDEBUG(("not found"));
722 devclass_find_driver(devclass_t dc, const char *classname)
726 dl = devclass_find_driver_internal(dc, classname);
734 devclass_get_name(devclass_t dc)
740 devclass_get_device(devclass_t dc, int unit)
742 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
744 return(dc->devices[unit]);
748 devclass_get_softc(devclass_t dc, int unit)
752 dev = devclass_get_device(dc, unit);
756 return(device_get_softc(dev));
760 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
767 for (i = 0; i < dc->maxunit; i++)
771 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
776 for (i = 0; i < dc->maxunit; i++)
777 if (dc->devices[i]) {
778 list[count] = dc->devices[i];
789 * @brief Get a list of drivers in the devclass
791 * An array containing a list of pointers to all the drivers in the
792 * given devclass is allocated and returned in @p *listp. The number
793 * of drivers in the array is returned in @p *countp. The caller should
794 * free the array using @c free(p, M_TEMP).
796 * @param dc the devclass to examine
797 * @param listp gives location for array pointer return value
798 * @param countp gives location for number of array elements
802 * @retval ENOMEM the array allocation failed
805 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
812 TAILQ_FOREACH(dl, &dc->drivers, link)
814 list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
819 TAILQ_FOREACH(dl, &dc->drivers, link) {
820 list[count] = dl->driver;
830 * @brief Get the number of devices in a devclass
832 * @param dc the devclass to examine
835 devclass_get_count(devclass_t dc)
840 for (i = 0; i < dc->maxunit; i++)
847 devclass_get_maxunit(devclass_t dc)
853 devclass_set_parent(devclass_t dc, devclass_t pdc)
859 devclass_get_parent(devclass_t dc)
865 devclass_alloc_unit(devclass_t dc, int *unitp)
869 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
871 /* If we have been given a wired unit number, check for existing device */
873 if (unit >= 0 && unit < dc->maxunit &&
874 dc->devices[unit] != NULL) {
876 kprintf("%s-: %s%d exists, using next available unit number\n",
877 dc->name, dc->name, unit);
878 /* find the next available slot */
879 while (++unit < dc->maxunit && dc->devices[unit] != NULL)
883 /* Unwired device, find the next available slot for it */
885 while (unit < dc->maxunit && dc->devices[unit] != NULL)
890 * We've selected a unit beyond the length of the table, so let's
891 * extend the table to make room for all units up to and including
894 if (unit >= dc->maxunit) {
898 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
899 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
903 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
905 kfree(dc->devices, M_BUS);
906 dc->devices = newlist;
907 dc->maxunit = newsize;
909 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
916 devclass_add_device(devclass_t dc, device_t dev)
920 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
922 buflen = strlen(dc->name) + 5;
923 dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
927 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
928 kfree(dev->nameunit, M_BUS);
929 dev->nameunit = NULL;
932 dc->devices[dev->unit] = dev;
934 ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
940 devclass_delete_device(devclass_t dc, device_t dev)
945 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
947 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
948 panic("devclass_delete_device: inconsistent device class");
949 dc->devices[dev->unit] = NULL;
950 if (dev->flags & DF_WILDCARD)
952 dev->devclass = NULL;
953 kfree(dev->nameunit, M_BUS);
954 dev->nameunit = NULL;
960 make_device(device_t parent, const char *name, int unit)
965 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
968 dc = devclass_find_internal(name, NULL, TRUE);
970 kprintf("make_device: can't find device class %s\n", name);
976 dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
980 dev->parent = parent;
981 TAILQ_INIT(&dev->children);
982 kobj_init((kobj_t) dev, &null_class);
984 dev->devclass = NULL;
986 dev->nameunit = NULL;
990 dev->flags = DF_ENABLED;
993 dev->flags |= DF_WILDCARD;
995 dev->flags |= DF_FIXEDCLASS;
996 if (devclass_add_device(dc, dev) != 0) {
997 kobj_delete((kobj_t)dev, M_BUS);
1004 dev->state = DS_NOTPRESENT;
1006 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1007 bus_data_generation_update();
1013 device_print_child(device_t dev, device_t child)
1017 if (device_is_alive(child))
1018 retval += BUS_PRINT_CHILD(dev, child);
1020 retval += device_printf(child, " not found\n");
1026 device_add_child(device_t dev, const char *name, int unit)
1028 return device_add_child_ordered(dev, 0, name, unit);
1032 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1037 PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1040 child = make_device(dev, name, unit);
1043 child->order = order;
1045 TAILQ_FOREACH(place, &dev->children, link)
1046 if (place->order > order)
1051 * The device 'place' is the first device whose order is
1052 * greater than the new child.
1054 TAILQ_INSERT_BEFORE(place, child, link);
1057 * The new child's order is greater or equal to the order of
1058 * any existing device. Add the child to the tail of the list.
1060 TAILQ_INSERT_TAIL(&dev->children, child, link);
1063 bus_data_generation_update();
1068 device_delete_child(device_t dev, device_t child)
1071 device_t grandchild;
1073 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1075 /* remove children first */
1076 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1077 error = device_delete_child(child, grandchild);
1082 if ((error = device_detach(child)) != 0)
1084 if (child->devclass)
1085 devclass_delete_device(child->devclass, child);
1086 TAILQ_REMOVE(&dev->children, child, link);
1087 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1088 device_set_desc(child, NULL);
1089 kobj_delete((kobj_t)child, M_BUS);
1091 bus_data_generation_update();
1096 * @brief Find a device given a unit number
1098 * This is similar to devclass_get_devices() but only searches for
1099 * devices which have @p dev as a parent.
1101 * @param dev the parent device to search
1102 * @param unit the unit number to search for. If the unit is -1,
1103 * return the first child of @p dev which has name
1104 * @p classname (that is, the one with the lowest unit.)
1106 * @returns the device with the given unit number or @c
1107 * NULL if there is no such device
1110 device_find_child(device_t dev, const char *classname, int unit)
1115 dc = devclass_find(classname);
1120 child = devclass_get_device(dc, unit);
1121 if (child && child->parent == dev)
1124 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1125 child = devclass_get_device(dc, unit);
1126 if (child && child->parent == dev)
1134 first_matching_driver(devclass_t dc, device_t dev)
1137 return(devclass_find_driver_internal(dc, dev->devclass->name));
1139 return(TAILQ_FIRST(&dc->drivers));
1143 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1145 if (dev->devclass) {
1147 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1148 if (!strcmp(dev->devclass->name, dl->driver->name))
1152 return(TAILQ_NEXT(last, link));
1156 device_probe_child(device_t dev, device_t child)
1159 driverlink_t best = 0;
1161 int result, pri = 0;
1162 int hasclass = (child->devclass != 0);
1166 panic("device_probe_child: parent device has no devclass");
1168 if (child->state == DS_ALIVE)
1171 for (; dc; dc = dc->parent) {
1172 for (dl = first_matching_driver(dc, child); dl;
1173 dl = next_matching_driver(dc, child, dl)) {
1174 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1175 device_set_driver(child, dl->driver);
1177 device_set_devclass(child, dl->driver->name);
1178 result = DEVICE_PROBE(child);
1180 device_set_devclass(child, 0);
1183 * If the driver returns SUCCESS, there can be
1184 * no higher match for this device.
1193 * The driver returned an error so it
1194 * certainly doesn't match.
1197 device_set_driver(child, 0);
1202 * A priority lower than SUCCESS, remember the
1203 * best matching driver. Initialise the value
1204 * of pri for the first match.
1206 if (best == 0 || result > pri) {
1213 * If we have unambiguous match in this devclass,
1214 * don't look in the parent.
1216 if (best && pri == 0)
1221 * If we found a driver, change state and initialise the devclass.
1224 if (!child->devclass)
1225 device_set_devclass(child, best->driver->name);
1226 device_set_driver(child, best->driver);
1229 * A bit bogus. Call the probe method again to make
1230 * sure that we have the right description.
1232 DEVICE_PROBE(child);
1235 bus_data_generation_update();
1236 child->state = DS_ALIVE;
1244 device_get_parent(device_t dev)
1250 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1257 TAILQ_FOREACH(child, &dev->children, link)
1260 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1265 TAILQ_FOREACH(child, &dev->children, link) {
1266 list[count] = child;
1277 device_get_driver(device_t dev)
1279 return(dev->driver);
1283 device_get_devclass(device_t dev)
1285 return(dev->devclass);
1289 device_get_name(device_t dev)
1292 return devclass_get_name(dev->devclass);
1297 device_get_nameunit(device_t dev)
1299 return(dev->nameunit);
1303 device_get_unit(device_t dev)
1309 device_get_desc(device_t dev)
1315 device_get_flags(device_t dev)
1317 return(dev->devflags);
1321 device_print_prettyname(device_t dev)
1323 const char *name = device_get_name(dev);
1326 return kprintf("unknown: ");
1328 return kprintf("%s%d: ", name, device_get_unit(dev));
1332 device_printf(device_t dev, const char * fmt, ...)
1337 retval = device_print_prettyname(dev);
1338 __va_start(ap, fmt);
1339 retval += kvprintf(fmt, ap);
1345 device_set_desc_internal(device_t dev, const char* desc, int copy)
1347 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1348 kfree(dev->desc, M_BUS);
1349 dev->flags &= ~DF_DESCMALLOCED;
1354 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1356 strcpy(dev->desc, desc);
1357 dev->flags |= DF_DESCMALLOCED;
1360 /* Avoid a -Wcast-qual warning */
1361 dev->desc = (char *)(uintptr_t) desc;
1364 bus_data_generation_update();
1368 device_set_desc(device_t dev, const char* desc)
1370 device_set_desc_internal(dev, desc, FALSE);
1374 device_set_desc_copy(device_t dev, const char* desc)
1376 device_set_desc_internal(dev, desc, TRUE);
1380 device_set_flags(device_t dev, uint32_t flags)
1382 dev->devflags = flags;
1386 device_get_softc(device_t dev)
1392 device_set_softc(device_t dev, void *softc)
1394 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1395 kfree(dev->softc, M_BUS);
1398 dev->flags |= DF_EXTERNALSOFTC;
1400 dev->flags &= ~DF_EXTERNALSOFTC;
1404 device_set_async_attach(device_t dev, int enable)
1407 dev->flags |= DF_ASYNCPROBE;
1409 dev->flags &= ~DF_ASYNCPROBE;
1413 device_get_ivars(device_t dev)
1419 device_set_ivars(device_t dev, void * ivars)
1428 device_get_state(device_t dev)
1434 device_enable(device_t dev)
1436 dev->flags |= DF_ENABLED;
1440 device_disable(device_t dev)
1442 dev->flags &= ~DF_ENABLED;
1449 device_busy(device_t dev)
1451 if (dev->state < DS_ATTACHED)
1452 panic("device_busy: called for unattached device");
1453 if (dev->busy == 0 && dev->parent)
1454 device_busy(dev->parent);
1456 dev->state = DS_BUSY;
1463 device_unbusy(device_t dev)
1465 if (dev->state != DS_BUSY)
1466 panic("device_unbusy: called for non-busy device");
1468 if (dev->busy == 0) {
1470 device_unbusy(dev->parent);
1471 dev->state = DS_ATTACHED;
1476 device_quiet(device_t dev)
1478 dev->flags |= DF_QUIET;
1482 device_verbose(device_t dev)
1484 dev->flags &= ~DF_QUIET;
1488 device_is_quiet(device_t dev)
1490 return((dev->flags & DF_QUIET) != 0);
1494 device_is_enabled(device_t dev)
1496 return((dev->flags & DF_ENABLED) != 0);
1500 device_is_alive(device_t dev)
1502 return(dev->state >= DS_ALIVE);
1506 device_is_attached(device_t dev)
1508 return(dev->state >= DS_ATTACHED);
1512 device_set_devclass(device_t dev, const char *classname)
1519 devclass_delete_device(dev->devclass, dev);
1523 if (dev->devclass) {
1524 kprintf("device_set_devclass: device class already set\n");
1528 dc = devclass_find_internal(classname, NULL, TRUE);
1532 error = devclass_add_device(dc, dev);
1534 bus_data_generation_update();
1539 device_set_driver(device_t dev, driver_t *driver)
1541 if (dev->state >= DS_ATTACHED)
1544 if (dev->driver == driver)
1547 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1548 kfree(dev->softc, M_BUS);
1551 kobj_delete((kobj_t) dev, 0);
1552 dev->driver = driver;
1554 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1555 if (!(dev->flags & DF_EXTERNALSOFTC)) {
1556 dev->softc = kmalloc(driver->size, M_BUS,
1557 M_INTWAIT | M_ZERO);
1559 kobj_delete((kobj_t)dev, 0);
1560 kobj_init((kobj_t) dev, &null_class);
1566 kobj_init((kobj_t) dev, &null_class);
1569 bus_data_generation_update();
1574 device_probe_and_attach(device_t dev)
1576 device_t bus = dev->parent;
1579 if (dev->state >= DS_ALIVE)
1582 if ((dev->flags & DF_ENABLED) == 0) {
1584 device_print_prettyname(dev);
1585 kprintf("not probed (disabled)\n");
1590 error = device_probe_child(bus, dev);
1592 if (!(dev->flags & DF_DONENOMATCH)) {
1593 BUS_PROBE_NOMATCH(bus, dev);
1595 dev->flags |= DF_DONENOMATCH;
1601 * Output the exact device chain prior to the attach in case the
1602 * system locks up during attach, and generate the full info after
1603 * the attach so correct irq and other information is displayed.
1605 if (bootverbose && !device_is_quiet(dev)) {
1608 kprintf("%s", device_get_nameunit(dev));
1609 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1610 kprintf(".%s", device_get_nameunit(tmp));
1613 if (!device_is_quiet(dev))
1614 device_print_child(bus, dev);
1615 if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1616 kprintf("%s: probing asynchronously\n",
1617 device_get_nameunit(dev));
1618 dev->state = DS_INPROGRESS;
1619 device_attach_async(dev);
1622 error = device_doattach(dev);
1628 * Device is known to be alive, do the attach asynchronously.
1630 * The MP lock is held by all threads.
1633 device_attach_async(device_t dev)
1637 atomic_add_int(&numasyncthreads, 1);
1638 lwkt_create(device_attach_thread, dev, &td, NULL,
1639 0, 0, (dev->desc ? dev->desc : "devattach"));
1643 device_attach_thread(void *arg)
1647 (void)device_doattach(dev);
1648 atomic_subtract_int(&numasyncthreads, 1);
1649 wakeup(&numasyncthreads);
1653 * Device is known to be alive, do the attach (synchronous or asynchronous)
1656 device_doattach(device_t dev)
1658 device_t bus = dev->parent;
1659 int hasclass = (dev->devclass != 0);
1662 error = DEVICE_ATTACH(dev);
1664 dev->state = DS_ATTACHED;
1665 if (bootverbose && !device_is_quiet(dev))
1666 device_print_child(bus, dev);
1669 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1670 dev->driver->name, dev->unit, error);
1671 /* Unset the class that was set in device_probe_child */
1673 device_set_devclass(dev, 0);
1674 device_set_driver(dev, NULL);
1675 dev->state = DS_NOTPRESENT;
1681 device_detach(device_t dev)
1685 PDEBUG(("%s", DEVICENAME(dev)));
1686 if (dev->state == DS_BUSY)
1688 if (dev->state != DS_ATTACHED)
1691 if ((error = DEVICE_DETACH(dev)) != 0)
1694 device_printf(dev, "detached\n");
1696 BUS_CHILD_DETACHED(dev->parent, dev);
1698 if (!(dev->flags & DF_FIXEDCLASS))
1699 devclass_delete_device(dev->devclass, dev);
1701 dev->state = DS_NOTPRESENT;
1702 device_set_driver(dev, NULL);
1708 device_shutdown(device_t dev)
1710 if (dev->state < DS_ATTACHED)
1712 PDEBUG(("%s", DEVICENAME(dev)));
1713 return DEVICE_SHUTDOWN(dev);
1717 device_set_unit(device_t dev, int unit)
1722 dc = device_get_devclass(dev);
1723 if (unit < dc->maxunit && dc->devices[unit])
1725 err = devclass_delete_device(dc, dev);
1729 err = devclass_add_device(dc, dev);
1733 bus_data_generation_update();
1737 /*======================================*/
1739 * Access functions for device resources.
1742 /* Supplied by config(8) in ioconf.c */
1743 extern struct config_device config_devtab[];
1744 extern int devtab_count;
1746 /* Runtime version */
1747 struct config_device *devtab = config_devtab;
1750 resource_new_name(const char *name, int unit)
1752 struct config_device *new;
1754 new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1755 M_INTWAIT | M_ZERO);
1758 if (devtab && devtab_count > 0)
1759 bcopy(devtab, new, devtab_count * sizeof(*new));
1760 new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1761 if (new[devtab_count].name == NULL) {
1765 strcpy(new[devtab_count].name, name);
1766 new[devtab_count].unit = unit;
1767 new[devtab_count].resource_count = 0;
1768 new[devtab_count].resources = NULL;
1769 if (devtab && devtab != config_devtab)
1770 kfree(devtab, M_TEMP);
1772 return devtab_count++;
1776 resource_new_resname(int j, const char *resname, resource_type type)
1778 struct config_resource *new;
1781 i = devtab[j].resource_count;
1782 new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1785 if (devtab[j].resources && i > 0)
1786 bcopy(devtab[j].resources, new, i * sizeof(*new));
1787 new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1788 if (new[i].name == NULL) {
1792 strcpy(new[i].name, resname);
1794 if (devtab[j].resources)
1795 kfree(devtab[j].resources, M_TEMP);
1796 devtab[j].resources = new;
1797 devtab[j].resource_count = i + 1;
1802 resource_match_string(int i, const char *resname, const char *value)
1805 struct config_resource *res;
1807 for (j = 0, res = devtab[i].resources;
1808 j < devtab[i].resource_count; j++, res++)
1809 if (!strcmp(res->name, resname)
1810 && res->type == RES_STRING
1811 && !strcmp(res->u.stringval, value))
1817 resource_find(const char *name, int unit, const char *resname,
1818 struct config_resource **result)
1821 struct config_resource *res;
1824 * First check specific instances, then generic.
1826 for (i = 0; i < devtab_count; i++) {
1827 if (devtab[i].unit < 0)
1829 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1830 res = devtab[i].resources;
1831 for (j = 0; j < devtab[i].resource_count; j++, res++)
1832 if (!strcmp(res->name, resname)) {
1838 for (i = 0; i < devtab_count; i++) {
1839 if (devtab[i].unit >= 0)
1841 /* XXX should this `&& devtab[i].unit == unit' be here? */
1842 /* XXX if so, then the generic match does nothing */
1843 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1844 res = devtab[i].resources;
1845 for (j = 0; j < devtab[i].resource_count; j++, res++)
1846 if (!strcmp(res->name, resname)) {
1856 resource_int_value(const char *name, int unit, const char *resname, int *result)
1859 struct config_resource *res;
1861 if ((error = resource_find(name, unit, resname, &res)) != 0)
1863 if (res->type != RES_INT)
1865 *result = res->u.intval;
1870 resource_long_value(const char *name, int unit, const char *resname,
1874 struct config_resource *res;
1876 if ((error = resource_find(name, unit, resname, &res)) != 0)
1878 if (res->type != RES_LONG)
1880 *result = res->u.longval;
1885 resource_string_value(const char *name, int unit, const char *resname,
1889 struct config_resource *res;
1891 if ((error = resource_find(name, unit, resname, &res)) != 0)
1893 if (res->type != RES_STRING)
1895 *result = res->u.stringval;
1900 resource_query_string(int i, const char *resname, const char *value)
1906 for (; i < devtab_count; i++)
1907 if (resource_match_string(i, resname, value) >= 0)
1913 resource_locate(int i, const char *resname)
1919 for (; i < devtab_count; i++)
1920 if (!strcmp(devtab[i].name, resname))
1926 resource_count(void)
1928 return(devtab_count);
1932 resource_query_name(int i)
1934 return(devtab[i].name);
1938 resource_query_unit(int i)
1940 return(devtab[i].unit);
1944 resource_create(const char *name, int unit, const char *resname,
1945 resource_type type, struct config_resource **result)
1948 struct config_resource *res = NULL;
1950 for (i = 0; i < devtab_count; i++)
1951 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1952 res = devtab[i].resources;
1956 i = resource_new_name(name, unit);
1959 res = devtab[i].resources;
1961 for (j = 0; j < devtab[i].resource_count; j++, res++)
1962 if (!strcmp(res->name, resname)) {
1966 j = resource_new_resname(i, resname, type);
1969 res = &devtab[i].resources[j];
1975 resource_set_int(const char *name, int unit, const char *resname, int value)
1978 struct config_resource *res;
1980 error = resource_create(name, unit, resname, RES_INT, &res);
1983 if (res->type != RES_INT)
1985 res->u.intval = value;
1990 resource_set_long(const char *name, int unit, const char *resname, long value)
1993 struct config_resource *res;
1995 error = resource_create(name, unit, resname, RES_LONG, &res);
1998 if (res->type != RES_LONG)
2000 res->u.longval = value;
2005 resource_set_string(const char *name, int unit, const char *resname,
2009 struct config_resource *res;
2011 error = resource_create(name, unit, resname, RES_STRING, &res);
2014 if (res->type != RES_STRING)
2016 if (res->u.stringval)
2017 kfree(res->u.stringval, M_TEMP);
2018 res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2019 if (res->u.stringval == NULL)
2021 strcpy(res->u.stringval, value);
2026 resource_cfgload(void *dummy __unused)
2028 struct config_resource *res, *cfgres;
2031 char *name, *resname;
2035 int config_devtab_count;
2037 config_devtab_count = devtab_count;
2041 for (i = 0; i < config_devtab_count; i++) {
2042 name = config_devtab[i].name;
2043 unit = config_devtab[i].unit;
2045 for (j = 0; j < config_devtab[i].resource_count; j++) {
2046 cfgres = config_devtab[i].resources;
2047 resname = cfgres[j].name;
2048 type = cfgres[j].type;
2049 error = resource_create(name, unit, resname, type,
2052 kprintf("create resource %s%d: error %d\n",
2056 if (res->type != type) {
2057 kprintf("type mismatch %s%d: %d != %d\n",
2058 name, unit, res->type, type);
2063 res->u.intval = cfgres[j].u.intval;
2066 res->u.longval = cfgres[j].u.longval;
2069 if (res->u.stringval)
2070 kfree(res->u.stringval, M_TEMP);
2071 stringval = cfgres[j].u.stringval;
2072 res->u.stringval = kmalloc(strlen(stringval) + 1,
2074 if (res->u.stringval == NULL)
2076 strcpy(res->u.stringval, stringval);
2079 panic("unknown resource type %d", type);
2084 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2087 /*======================================*/
2089 * Some useful method implementations to make life easier for bus drivers.
2093 resource_list_init(struct resource_list *rl)
2099 resource_list_free(struct resource_list *rl)
2101 struct resource_list_entry *rle;
2103 while ((rle = SLIST_FIRST(rl)) != NULL) {
2105 panic("resource_list_free: resource entry is busy");
2106 SLIST_REMOVE_HEAD(rl, link);
2112 resource_list_add(struct resource_list *rl,
2114 u_long start, u_long end, u_long count)
2116 struct resource_list_entry *rle;
2118 rle = resource_list_find(rl, type, rid);
2120 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2123 panic("resource_list_add: can't record entry");
2124 SLIST_INSERT_HEAD(rl, rle, link);
2131 panic("resource_list_add: resource entry is busy");
2138 struct resource_list_entry*
2139 resource_list_find(struct resource_list *rl,
2142 struct resource_list_entry *rle;
2144 SLIST_FOREACH(rle, rl, link)
2145 if (rle->type == type && rle->rid == rid)
2151 resource_list_delete(struct resource_list *rl,
2154 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2157 if (rle->res != NULL)
2158 panic("resource_list_delete: resource has not been released");
2159 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2165 resource_list_alloc(struct resource_list *rl,
2166 device_t bus, device_t child,
2168 u_long start, u_long end,
2169 u_long count, u_int flags)
2171 struct resource_list_entry *rle = 0;
2172 int passthrough = (device_get_parent(child) != bus);
2173 int isdefault = (start == 0UL && end == ~0UL);
2176 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2178 start, end, count, flags));
2181 rle = resource_list_find(rl, type, *rid);
2184 return(0); /* no resource of that type/rid */
2187 panic("resource_list_alloc: resource entry is busy");
2191 count = max(count, rle->count);
2192 end = max(rle->end, start + count - 1);
2195 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2196 type, rid, start, end, count, flags);
2199 * Record the new range.
2202 rle->start = rman_get_start(rle->res);
2203 rle->end = rman_get_end(rle->res);
2211 resource_list_release(struct resource_list *rl,
2212 device_t bus, device_t child,
2213 int type, int rid, struct resource *res)
2215 struct resource_list_entry *rle = 0;
2216 int passthrough = (device_get_parent(child) != bus);
2220 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2224 rle = resource_list_find(rl, type, rid);
2227 panic("resource_list_release: can't find resource");
2229 panic("resource_list_release: resource entry is not busy");
2231 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2241 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2244 struct resource_list_entry *rle;
2245 int printed, retval;
2249 /* Yes, this is kinda cheating */
2250 SLIST_FOREACH(rle, rl, link) {
2251 if (rle->type == type) {
2253 retval += kprintf(" %s ", name);
2255 retval += kprintf(",");
2257 retval += kprintf(format, rle->start);
2258 if (rle->count > 1) {
2259 retval += kprintf("-");
2260 retval += kprintf(format, rle->start +
2269 * Generic driver/device identify functions. These will install a device
2270 * rendezvous point under the parent using the same name as the driver
2271 * name, which will at a later time be probed and attached.
2273 * These functions are used when the parent does not 'scan' its bus for
2274 * matching devices, or for the particular devices using these functions,
2275 * or when the device is a pseudo or synthesized device (such as can be
2276 * found under firewire and ppbus).
2279 bus_generic_identify(driver_t *driver, device_t parent)
2281 if (parent->state == DS_ATTACHED)
2283 BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2288 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2290 if (parent->state == DS_ATTACHED)
2292 BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2297 * Call DEVICE_IDENTIFY for each driver.
2300 bus_generic_probe(device_t dev)
2302 devclass_t dc = dev->devclass;
2305 TAILQ_FOREACH(dl, &dc->drivers, link) {
2306 DEVICE_IDENTIFY(dl->driver, dev);
2313 * This is an aweful hack due to the isa bus and autoconf code not
2314 * probing the ISA devices until after everything else has configured.
2315 * The ISA bus did a dummy attach long ago so we have to set it back
2316 * to an earlier state so the probe thinks its the initial probe and
2319 * XXX remove by properly defering the ISA bus scan.
2322 bus_generic_probe_hack(device_t dev)
2324 if (dev->state == DS_ATTACHED) {
2325 dev->state = DS_ALIVE;
2326 bus_generic_probe(dev);
2327 dev->state = DS_ATTACHED;
2333 bus_generic_attach(device_t dev)
2337 TAILQ_FOREACH(child, &dev->children, link) {
2338 device_probe_and_attach(child);
2345 bus_generic_detach(device_t dev)
2350 if (dev->state != DS_ATTACHED)
2353 TAILQ_FOREACH(child, &dev->children, link)
2354 if ((error = device_detach(child)) != 0)
2361 bus_generic_shutdown(device_t dev)
2365 TAILQ_FOREACH(child, &dev->children, link)
2366 device_shutdown(child);
2372 bus_generic_suspend(device_t dev)
2375 device_t child, child2;
2377 TAILQ_FOREACH(child, &dev->children, link) {
2378 error = DEVICE_SUSPEND(child);
2380 for (child2 = TAILQ_FIRST(&dev->children);
2381 child2 && child2 != child;
2382 child2 = TAILQ_NEXT(child2, link))
2383 DEVICE_RESUME(child2);
2391 bus_generic_resume(device_t dev)
2395 TAILQ_FOREACH(child, &dev->children, link)
2396 DEVICE_RESUME(child);
2397 /* if resume fails, there's nothing we can usefully do... */
2403 bus_print_child_header(device_t dev, device_t child)
2407 if (device_get_desc(child))
2408 retval += device_printf(child, "<%s>", device_get_desc(child));
2410 retval += kprintf("%s", device_get_nameunit(child));
2412 if (child->state != DS_ATTACHED)
2413 kprintf(" [tentative]");
2415 kprintf(" [attached!]");
2421 bus_print_child_footer(device_t dev, device_t child)
2423 return(kprintf(" on %s\n", device_get_nameunit(dev)));
2427 bus_generic_add_child(device_t dev, device_t child, int order,
2428 const char *name, int unit)
2431 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2433 dev = device_add_child_ordered(child, order, name, unit);
2439 bus_generic_print_child(device_t dev, device_t child)
2443 retval += bus_print_child_header(dev, child);
2444 retval += bus_print_child_footer(dev, child);
2450 bus_generic_read_ivar(device_t dev, device_t child, int index,
2456 error = BUS_READ_IVAR(dev->parent, child, index, result);
2463 bus_generic_write_ivar(device_t dev, device_t child, int index,
2469 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2476 * Resource list are used for iterations, do not recurse.
2478 struct resource_list *
2479 bus_generic_get_resource_list(device_t dev, device_t child)
2485 bus_generic_driver_added(device_t dev, driver_t *driver)
2489 DEVICE_IDENTIFY(driver, dev);
2490 TAILQ_FOREACH(child, &dev->children, link) {
2491 if (child->state == DS_NOTPRESENT)
2492 device_probe_and_attach(child);
2497 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2498 int flags, driver_intr_t *intr, void *arg,
2499 void **cookiep, lwkt_serialize_t serializer)
2501 /* Propagate up the bus hierarchy until someone handles it. */
2503 return(BUS_SETUP_INTR(dev->parent, child, irq, flags,
2504 intr, arg, cookiep, serializer));
2510 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2513 /* Propagate up the bus hierarchy until someone handles it. */
2515 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2521 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2524 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2530 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2533 BUS_ENABLE_INTR(dev->parent, child, cookie);
2537 bus_generic_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
2538 enum intr_polarity pol)
2540 /* Propagate up the bus hierarchy until someone handles it. */
2542 return(BUS_CONFIG_INTR(dev->parent, child, irq, trig, pol));
2548 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2549 u_long start, u_long end, u_long count, u_int flags)
2551 /* Propagate up the bus hierarchy until someone handles it. */
2553 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2554 start, end, count, flags));
2560 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2563 /* Propagate up the bus hierarchy until someone handles it. */
2565 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2571 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2574 /* Propagate up the bus hierarchy until someone handles it. */
2576 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2582 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2583 int rid, struct resource *r)
2585 /* Propagate up the bus hierarchy until someone handles it. */
2587 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2594 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2595 u_long *startp, u_long *countp)
2601 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2608 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2609 u_long start, u_long count)
2615 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2622 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2625 BUS_DELETE_RESOURCE(dev, child, type, rid);
2629 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2630 u_long *startp, u_long *countp)
2632 struct resource_list *rl = NULL;
2633 struct resource_list_entry *rle = NULL;
2635 rl = BUS_GET_RESOURCE_LIST(dev, child);
2639 rle = resource_list_find(rl, type, rid);
2644 *startp = rle->start;
2646 *countp = rle->count;
2652 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2653 u_long start, u_long count)
2655 struct resource_list *rl = NULL;
2657 rl = BUS_GET_RESOURCE_LIST(dev, child);
2661 resource_list_add(rl, type, rid, start, (start + count - 1), count);
2667 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2669 struct resource_list *rl = NULL;
2671 rl = BUS_GET_RESOURCE_LIST(dev, child);
2675 resource_list_delete(rl, type, rid);
2679 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2680 int rid, struct resource *r)
2682 struct resource_list *rl = NULL;
2684 rl = BUS_GET_RESOURCE_LIST(dev, child);
2688 return(resource_list_release(rl, dev, child, type, rid, r));
2692 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2693 int *rid, u_long start, u_long end, u_long count, u_int flags)
2695 struct resource_list *rl = NULL;
2697 rl = BUS_GET_RESOURCE_LIST(dev, child);
2701 return(resource_list_alloc(rl, dev, child, type, rid,
2702 start, end, count, flags));
2706 bus_generic_child_present(device_t bus, device_t child)
2708 return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2713 * Some convenience functions to make it easier for drivers to use the
2714 * resource-management functions. All these really do is hide the
2715 * indirection through the parent's method table, making for slightly
2716 * less-wordy code. In the future, it might make sense for this code
2717 * to maintain some sort of a list of resources allocated by each device.
2720 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2721 struct resource **res)
2725 for (i = 0; rs[i].type != -1; i++)
2727 for (i = 0; rs[i].type != -1; i++) {
2728 res[i] = bus_alloc_resource_any(dev,
2729 rs[i].type, &rs[i].rid, rs[i].flags);
2730 if (res[i] == NULL) {
2731 bus_release_resources(dev, rs, res);
2739 bus_release_resources(device_t dev, const struct resource_spec *rs,
2740 struct resource **res)
2744 for (i = 0; rs[i].type != -1; i++)
2745 if (res[i] != NULL) {
2746 bus_release_resource(
2747 dev, rs[i].type, rs[i].rid, res[i]);
2753 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2754 u_long count, u_int flags)
2756 if (dev->parent == 0)
2758 return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2763 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2765 if (dev->parent == 0)
2767 return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2771 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2773 if (dev->parent == 0)
2775 return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2779 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2781 if (dev->parent == 0)
2783 return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2787 bus_setup_intr(device_t dev, struct resource *r, int flags,
2788 driver_intr_t handler, void *arg,
2789 void **cookiep, lwkt_serialize_t serializer)
2791 if (dev->parent == 0)
2793 return(BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2794 cookiep, serializer));
2798 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2800 if (dev->parent == 0)
2802 return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2806 bus_enable_intr(device_t dev, void *cookie)
2809 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2813 bus_disable_intr(device_t dev, void *cookie)
2816 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2822 bus_set_resource(device_t dev, int type, int rid,
2823 u_long start, u_long count)
2825 return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2830 bus_get_resource(device_t dev, int type, int rid,
2831 u_long *startp, u_long *countp)
2833 return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2838 bus_get_resource_start(device_t dev, int type, int rid)
2840 u_long start, count;
2843 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2851 bus_get_resource_count(device_t dev, int type, int rid)
2853 u_long start, count;
2856 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2864 bus_delete_resource(device_t dev, int type, int rid)
2866 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2870 bus_child_present(device_t child)
2872 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
2876 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
2880 parent = device_get_parent(child);
2881 if (parent == NULL) {
2885 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
2889 bus_child_location_str(device_t child, char *buf, size_t buflen)
2893 parent = device_get_parent(child);
2894 if (parent == NULL) {
2898 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
2902 root_print_child(device_t dev, device_t child)
2908 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
2909 void **cookiep, lwkt_serialize_t serializer)
2912 * If an interrupt mapping gets to here something bad has happened.
2914 panic("root_setup_intr");
2918 * If we get here, assume that the device is permanant and really is
2919 * present in the system. Removable bus drivers are expected to intercept
2920 * this call long before it gets here. We return -1 so that drivers that
2921 * really care can check vs -1 or some ERRNO returned higher in the food
2925 root_child_present(device_t dev, device_t child)
2931 * XXX NOTE! other defaults may be set in bus_if.m
2933 static kobj_method_t root_methods[] = {
2934 /* Device interface */
2935 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
2936 KOBJMETHOD(device_suspend, bus_generic_suspend),
2937 KOBJMETHOD(device_resume, bus_generic_resume),
2940 KOBJMETHOD(bus_add_child, bus_generic_add_child),
2941 KOBJMETHOD(bus_print_child, root_print_child),
2942 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
2943 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
2944 KOBJMETHOD(bus_setup_intr, root_setup_intr),
2945 KOBJMETHOD(bus_child_present, root_child_present),
2950 static driver_t root_driver = {
2957 devclass_t root_devclass;
2960 root_bus_module_handler(module_t mod, int what, void* arg)
2964 TAILQ_INIT(&bus_data_devices);
2965 root_bus = make_device(NULL, "root", 0);
2966 root_bus->desc = "System root bus";
2967 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
2968 root_bus->driver = &root_driver;
2969 root_bus->state = DS_ALIVE;
2970 root_devclass = devclass_find_internal("root", NULL, FALSE);
2975 device_shutdown(root_bus);
2982 static moduledata_t root_bus_mod = {
2984 root_bus_module_handler,
2987 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
2990 root_bus_configure(void)
2998 * handle device_identify based device attachments to the root_bus
2999 * (typically nexus).
3001 bus_generic_probe(root_bus);
3004 * Probe and attach the devices under root_bus.
3006 TAILQ_FOREACH(dev, &root_bus->children, link) {
3007 device_probe_and_attach(dev);
3011 * Wait for all asynchronous attaches to complete. If we don't
3012 * our legacy ISA bus scan could steal device unit numbers or
3016 if (numasyncthreads)
3017 kprintf("Waiting for async drivers to attach\n");
3018 while (numasyncthreads > 0) {
3019 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3021 if (warncount == 0) {
3022 kprintf("Warning: Still waiting for %d "
3023 "drivers to attach\n", numasyncthreads);
3024 } else if (warncount == -30) {
3025 kprintf("Giving up on %d drivers\n", numasyncthreads);
3029 root_bus->state = DS_ATTACHED;
3033 driver_module_handler(module_t mod, int what, void *arg)
3036 struct driver_module_data *dmd;
3037 devclass_t bus_devclass;
3038 kobj_class_t driver;
3039 const char *parentname;
3041 dmd = (struct driver_module_data *)arg;
3042 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3047 if (dmd->dmd_chainevh)
3048 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3050 driver = dmd->dmd_driver;
3051 PDEBUG(("Loading module: driver %s on bus %s",
3052 DRIVERNAME(driver), dmd->dmd_busname));
3055 * If the driver has any base classes, make the
3056 * devclass inherit from the devclass of the driver's
3057 * first base class. This will allow the system to
3058 * search for drivers in both devclasses for children
3059 * of a device using this driver.
3061 if (driver->baseclasses)
3062 parentname = driver->baseclasses[0]->name;
3065 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3068 error = devclass_add_driver(bus_devclass, driver);
3074 PDEBUG(("Unloading module: driver %s from bus %s",
3075 DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3076 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3078 if (!error && dmd->dmd_chainevh)
3079 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3089 * The _short versions avoid iteration by not calling anything that prints
3090 * more than oneliners. I love oneliners.
3094 print_device_short(device_t dev, int indent)
3099 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3100 dev->unit, dev->desc,
3101 (dev->parent? "":"no "),
3102 (TAILQ_EMPTY(&dev->children)? "no ":""),
3103 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3104 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3105 (dev->flags&DF_WILDCARD? "wildcard,":""),
3106 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3107 (dev->ivars? "":"no "),
3108 (dev->softc? "":"no "),
3113 print_device(device_t dev, int indent)
3118 print_device_short(dev, indent);
3120 indentprintf(("Parent:\n"));
3121 print_device_short(dev->parent, indent+1);
3122 indentprintf(("Driver:\n"));
3123 print_driver_short(dev->driver, indent+1);
3124 indentprintf(("Devclass:\n"));
3125 print_devclass_short(dev->devclass, indent+1);
3129 * Print the device and all its children (indented).
3132 print_device_tree_short(device_t dev, int indent)
3139 print_device_short(dev, indent);
3141 TAILQ_FOREACH(child, &dev->children, link)
3142 print_device_tree_short(child, indent+1);
3146 * Print the device and all its children (indented).
3149 print_device_tree(device_t dev, int indent)
3156 print_device(dev, indent);
3158 TAILQ_FOREACH(child, &dev->children, link)
3159 print_device_tree(child, indent+1);
3163 print_driver_short(driver_t *driver, int indent)
3168 indentprintf(("driver %s: softc size = %d\n",
3169 driver->name, driver->size));
3173 print_driver(driver_t *driver, int indent)
3178 print_driver_short(driver, indent);
3183 print_driver_list(driver_list_t drivers, int indent)
3185 driverlink_t driver;
3187 TAILQ_FOREACH(driver, &drivers, link)
3188 print_driver(driver->driver, indent);
3192 print_devclass_short(devclass_t dc, int indent)
3197 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3201 print_devclass(devclass_t dc, int indent)
3208 print_devclass_short(dc, indent);
3209 indentprintf(("Drivers:\n"));
3210 print_driver_list(dc->drivers, indent+1);
3212 indentprintf(("Devices:\n"));
3213 for (i = 0; i < dc->maxunit; i++)
3215 print_device(dc->devices[i], indent+1);
3219 print_devclass_list_short(void)
3223 kprintf("Short listing of devclasses, drivers & devices:\n");
3224 TAILQ_FOREACH(dc, &devclasses, link) {
3225 print_devclass_short(dc, 0);
3230 print_devclass_list(void)
3234 kprintf("Full listing of devclasses, drivers & devices:\n");
3235 TAILQ_FOREACH(dc, &devclasses, link) {
3236 print_devclass(dc, 0);
3243 * Check to see if a device is disabled via a disabled hint.
3246 resource_disabled(const char *name, int unit)
3250 error = resource_int_value(name, unit, "disabled", &value);
3257 * User-space access to the device tree.
3259 * We implement a small set of nodes:
3261 * hw.bus Single integer read method to obtain the
3262 * current generation count.
3263 * hw.bus.devices Reads the entire device tree in flat space.
3264 * hw.bus.rman Resource manager interface
3266 * We might like to add the ability to scan devclasses and/or drivers to
3267 * determine what else is currently loaded/available.
3271 sysctl_bus(SYSCTL_HANDLER_ARGS)
3273 struct u_businfo ubus;
3275 ubus.ub_version = BUS_USER_VERSION;
3276 ubus.ub_generation = bus_data_generation;
3278 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3280 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3281 "bus-related data");
3284 sysctl_devices(SYSCTL_HANDLER_ARGS)
3286 int *name = (int *)arg1;
3287 u_int namelen = arg2;
3290 struct u_device udev; /* XXX this is a bit big */
3296 if (bus_data_generation_check(name[0]))
3302 * Scan the list of devices, looking for the requested index.
3304 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3312 * Populate the return array.
3314 bzero(&udev, sizeof(udev));
3315 udev.dv_handle = (uintptr_t)dev;
3316 udev.dv_parent = (uintptr_t)dev->parent;
3317 if (dev->nameunit != NULL)
3318 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3319 if (dev->desc != NULL)
3320 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3321 if (dev->driver != NULL && dev->driver->name != NULL)
3322 strlcpy(udev.dv_drivername, dev->driver->name,
3323 sizeof(udev.dv_drivername));
3324 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3325 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3326 udev.dv_devflags = dev->devflags;
3327 udev.dv_flags = dev->flags;
3328 udev.dv_state = dev->state;
3329 error = SYSCTL_OUT(req, &udev, sizeof(udev));
3333 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3334 "system device tree");
3337 bus_data_generation_check(int generation)
3339 if (generation != bus_data_generation)
3342 /* XXX generate optimised lists here? */
3347 bus_data_generation_update(void)
3349 bus_data_generation++;