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>
49 #include <sys/event.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_kqfilter_t devkqfilter;
147 static struct dev_ops devctl_ops = {
148 { "devctl", CDEV_MAJOR, 0 },
153 .d_kqfilter = devkqfilter
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. */
277 static void dev_filter_detach(struct knote *);
278 static int dev_filter_read(struct knote *, long);
280 static struct filterops dev_filtops =
281 { 1, NULL, dev_filter_detach, dev_filter_read };
284 devkqfilter(struct dev_kqfilter_args *ap)
286 struct knote *kn = ap->a_kn;
290 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
292 switch (kn->kn_filter) {
294 kn->kn_fop = &dev_filtops;
297 ap->a_result = EOPNOTSUPP;
298 lockmgr(&devsoftc.lock, LK_RELEASE);
303 klist = &devsoftc.sel.si_note;
304 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
307 lockmgr(&devsoftc.lock, LK_RELEASE);
313 dev_filter_detach(struct knote *kn)
317 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
319 klist = &devsoftc.sel.si_note;
320 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
322 lockmgr(&devsoftc.lock, LK_RELEASE);
326 dev_filter_read(struct knote *kn, long hint)
330 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
331 if (!TAILQ_EMPTY(&devsoftc.devq))
333 lockmgr(&devsoftc.lock, LK_RELEASE);
340 * @brief Return whether the userland process is running
343 devctl_process_running(void)
345 return (devsoftc.inuse == 1);
349 * @brief Queue data to be read from the devctl device
351 * Generic interface to queue data to the devctl device. It is
352 * assumed that @p data is properly formatted. It is further assumed
353 * that @p data is allocated using the M_BUS malloc type.
356 devctl_queue_data(char *data)
358 struct dev_event_info *n1 = NULL;
361 n1 = kmalloc(sizeof(*n1), M_BUS, M_NOWAIT);
365 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
366 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
368 lockmgr(&devsoftc.lock, LK_RELEASE);
369 get_mplock(); /* XXX */
370 selwakeup(&devsoftc.sel);
371 KNOTE(&devsoftc.sel.si_note, 0);
372 rel_mplock(); /* XXX */
373 p = devsoftc.async_proc;
379 * @brief Send a 'notification' to userland, using standard ways
382 devctl_notify(const char *system, const char *subsystem, const char *type,
389 return; /* BOGUS! Must specify system. */
390 if (subsystem == NULL)
391 return; /* BOGUS! Must specify subsystem. */
393 return; /* BOGUS! Must specify type. */
394 len += strlen(" system=") + strlen(system);
395 len += strlen(" subsystem=") + strlen(subsystem);
396 len += strlen(" type=") + strlen(type);
397 /* add in the data message plus newline. */
400 len += 3; /* '!', '\n', and NUL */
401 msg = kmalloc(len, M_BUS, M_NOWAIT);
403 return; /* Drop it on the floor */
405 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
406 system, subsystem, type, data);
408 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
409 system, subsystem, type);
410 devctl_queue_data(msg);
414 * Common routine that tries to make sending messages as easy as possible.
415 * We allocate memory for the data, copy strings into that, but do not
416 * free it unless there's an error. The dequeue part of the driver should
417 * free the data. We don't send data when the device is disabled. We do
418 * send data, even when we have no listeners, because we wish to avoid
419 * races relating to startup and restart of listening applications.
421 * devaddq is designed to string together the type of event, with the
422 * object of that event, plus the plug and play info and location info
423 * for that event. This is likely most useful for devices, but less
424 * useful for other consumers of this interface. Those should use
425 * the devctl_queue_data() interface instead.
428 devaddq(const char *type, const char *what, device_t dev)
437 data = kmalloc(1024, M_BUS, M_NOWAIT);
441 /* get the bus specific location of this device */
442 loc = kmalloc(1024, M_BUS, M_NOWAIT);
446 bus_child_location_str(dev, loc, 1024);
448 /* Get the bus specific pnp info of this device */
449 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
453 bus_child_pnpinfo_str(dev, pnp, 1024);
455 /* Get the parent of this device, or / if high enough in the tree. */
456 if (device_get_parent(dev) == NULL)
457 parstr = "."; /* Or '/' ? */
459 parstr = device_get_nameunit(device_get_parent(dev));
460 /* String it all together. */
461 ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
465 devctl_queue_data(data);
475 * A device was added to the tree. We are called just after it successfully
476 * attaches (that is, probe and attach success for this device). No call
477 * is made if a device is merely parented into the tree. See devnomatch
478 * if probe fails. If attach fails, no notification is sent (but maybe
479 * we should have a different message for this).
482 devadded(device_t dev)
487 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
490 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
494 bus_child_pnpinfo_str(dev, pnp, 1024);
495 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
496 devaddq("+", tmp, dev);
506 * A device was removed from the tree. We are called just before this
510 devremoved(device_t dev)
515 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
518 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
522 bus_child_pnpinfo_str(dev, pnp, 1024);
523 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
524 devaddq("-", tmp, dev);
534 * Called when there's no match for this device. This is only called
535 * the first time that no match happens, so we don't keep getitng this
536 * message. Should that prove to be undesirable, we can change it.
537 * This is called when all drivers that can attach to a given bus
538 * decline to accept this device. Other errrors may not be detected.
541 devnomatch(device_t dev)
543 devaddq("?", "", dev);
547 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
549 struct dev_event_info *n1;
552 dis = devctl_disable;
553 error = sysctl_handle_int(oidp, &dis, 0, req);
554 if (error || !req->newptr)
556 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
557 devctl_disable = dis;
559 while (!TAILQ_EMPTY(&devsoftc.devq)) {
560 n1 = TAILQ_FIRST(&devsoftc.devq);
561 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
562 kfree(n1->dei_data, M_BUS);
566 lockmgr(&devsoftc.lock, LK_RELEASE);
570 /* End of /dev/devctl code */
572 TAILQ_HEAD(,device) bus_data_devices;
573 static int bus_data_generation = 1;
575 kobj_method_t null_methods[] = {
579 DEFINE_CLASS(null, null_methods, 0);
582 * Devclass implementation
585 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
588 devclass_find_internal(const char *classname, const char *parentname,
593 PDEBUG(("looking for %s", classname));
594 if (classname == NULL)
597 TAILQ_FOREACH(dc, &devclasses, link)
598 if (!strcmp(dc->name, classname))
602 PDEBUG(("creating %s", classname));
603 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
604 M_BUS, M_INTWAIT | M_ZERO);
608 dc->name = (char*) (dc + 1);
609 strcpy(dc->name, classname);
612 TAILQ_INIT(&dc->drivers);
613 TAILQ_INSERT_TAIL(&devclasses, dc, link);
615 bus_data_generation_update();
618 if (parentname && dc && !dc->parent)
619 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
625 devclass_create(const char *classname)
627 return(devclass_find_internal(classname, NULL, TRUE));
631 devclass_find(const char *classname)
633 return(devclass_find_internal(classname, NULL, FALSE));
637 devclass_find_unit(const char *classname, int unit)
641 if ((dc = devclass_find(classname)) != NULL)
642 return(devclass_get_device(dc, unit));
647 devclass_add_driver(devclass_t dc, driver_t *driver)
653 PDEBUG(("%s", DRIVERNAME(driver)));
655 dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
660 * Compile the driver's methods. Also increase the reference count
661 * so that the class doesn't get freed when the last instance
662 * goes. This means we can safely use static methods and avoids a
663 * double-free in devclass_delete_driver.
665 kobj_class_instantiate(driver);
668 * Make sure the devclass which the driver is implementing exists.
670 devclass_find_internal(driver->name, NULL, TRUE);
673 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
676 * Call BUS_DRIVER_ADDED for any existing busses in this class,
677 * but only if the bus has already been attached (otherwise we
678 * might probe too early).
680 * This is what will cause a newly loaded module to be associated
681 * with hardware. bus_generic_driver_added() is typically what ends
684 for (i = 0; i < dc->maxunit; i++) {
685 if ((dev = dc->devices[i]) != NULL) {
686 if (dev->state >= DS_ATTACHED)
687 BUS_DRIVER_ADDED(dev, driver);
691 bus_data_generation_update();
696 devclass_delete_driver(devclass_t busclass, driver_t *driver)
698 devclass_t dc = devclass_find(driver->name);
704 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
710 * Find the link structure in the bus' list of drivers.
712 TAILQ_FOREACH(dl, &busclass->drivers, link)
713 if (dl->driver == driver)
717 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
722 * Disassociate from any devices. We iterate through all the
723 * devices in the devclass of the driver and detach any which are
724 * using the driver and which have a parent in the devclass which
725 * we are deleting from.
727 * Note that since a driver can be in multiple devclasses, we
728 * should not detach devices which are not children of devices in
729 * the affected devclass.
731 for (i = 0; i < dc->maxunit; i++)
732 if (dc->devices[i]) {
733 dev = dc->devices[i];
734 if (dev->driver == driver && dev->parent &&
735 dev->parent->devclass == busclass) {
736 if ((error = device_detach(dev)) != 0)
738 device_set_driver(dev, NULL);
742 TAILQ_REMOVE(&busclass->drivers, dl, link);
745 kobj_class_uninstantiate(driver);
747 bus_data_generation_update();
752 devclass_find_driver_internal(devclass_t dc, const char *classname)
756 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
758 TAILQ_FOREACH(dl, &dc->drivers, link)
759 if (!strcmp(dl->driver->name, classname))
762 PDEBUG(("not found"));
767 devclass_find_driver(devclass_t dc, const char *classname)
771 dl = devclass_find_driver_internal(dc, classname);
779 devclass_get_name(devclass_t dc)
785 devclass_get_device(devclass_t dc, int unit)
787 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
789 return(dc->devices[unit]);
793 devclass_get_softc(devclass_t dc, int unit)
797 dev = devclass_get_device(dc, unit);
801 return(device_get_softc(dev));
805 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
812 for (i = 0; i < dc->maxunit; i++)
816 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
821 for (i = 0; i < dc->maxunit; i++)
822 if (dc->devices[i]) {
823 list[count] = dc->devices[i];
834 * @brief Get a list of drivers in the devclass
836 * An array containing a list of pointers to all the drivers in the
837 * given devclass is allocated and returned in @p *listp. The number
838 * of drivers in the array is returned in @p *countp. The caller should
839 * free the array using @c free(p, M_TEMP).
841 * @param dc the devclass to examine
842 * @param listp gives location for array pointer return value
843 * @param countp gives location for number of array elements
847 * @retval ENOMEM the array allocation failed
850 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
857 TAILQ_FOREACH(dl, &dc->drivers, link)
859 list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
864 TAILQ_FOREACH(dl, &dc->drivers, link) {
865 list[count] = dl->driver;
875 * @brief Get the number of devices in a devclass
877 * @param dc the devclass to examine
880 devclass_get_count(devclass_t dc)
885 for (i = 0; i < dc->maxunit; i++)
892 devclass_get_maxunit(devclass_t dc)
898 devclass_set_parent(devclass_t dc, devclass_t pdc)
904 devclass_get_parent(devclass_t dc)
910 devclass_alloc_unit(devclass_t dc, int *unitp)
914 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
916 /* If we have been given a wired unit number, check for existing device */
918 if (unit >= 0 && unit < dc->maxunit &&
919 dc->devices[unit] != NULL) {
921 kprintf("%s-: %s%d exists, using next available unit number\n",
922 dc->name, dc->name, unit);
923 /* find the next available slot */
924 while (++unit < dc->maxunit && dc->devices[unit] != NULL)
928 /* Unwired device, find the next available slot for it */
930 while (unit < dc->maxunit && dc->devices[unit] != NULL)
935 * We've selected a unit beyond the length of the table, so let's
936 * extend the table to make room for all units up to and including
939 if (unit >= dc->maxunit) {
943 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
944 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
948 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
950 kfree(dc->devices, M_BUS);
951 dc->devices = newlist;
952 dc->maxunit = newsize;
954 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
961 devclass_add_device(devclass_t dc, device_t dev)
965 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
967 buflen = strlen(dc->name) + 5;
968 dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
972 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
973 kfree(dev->nameunit, M_BUS);
974 dev->nameunit = NULL;
977 dc->devices[dev->unit] = dev;
979 ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
985 devclass_delete_device(devclass_t dc, device_t dev)
990 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
992 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
993 panic("devclass_delete_device: inconsistent device class");
994 dc->devices[dev->unit] = NULL;
995 if (dev->flags & DF_WILDCARD)
997 dev->devclass = NULL;
998 kfree(dev->nameunit, M_BUS);
999 dev->nameunit = NULL;
1005 make_device(device_t parent, const char *name, int unit)
1010 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1013 dc = devclass_find_internal(name, NULL, TRUE);
1015 kprintf("make_device: can't find device class %s\n", name);
1021 dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
1025 dev->parent = parent;
1026 TAILQ_INIT(&dev->children);
1027 kobj_init((kobj_t) dev, &null_class);
1029 dev->devclass = NULL;
1031 dev->nameunit = NULL;
1035 dev->flags = DF_ENABLED;
1038 dev->flags |= DF_WILDCARD;
1040 dev->flags |= DF_FIXEDCLASS;
1041 if (devclass_add_device(dc, dev) != 0) {
1042 kobj_delete((kobj_t)dev, M_BUS);
1049 dev->state = DS_NOTPRESENT;
1051 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1052 bus_data_generation_update();
1058 device_print_child(device_t dev, device_t child)
1062 if (device_is_alive(child))
1063 retval += BUS_PRINT_CHILD(dev, child);
1065 retval += device_printf(child, " not found\n");
1071 device_add_child(device_t dev, const char *name, int unit)
1073 return device_add_child_ordered(dev, 0, name, unit);
1077 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1082 PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1085 child = make_device(dev, name, unit);
1088 child->order = order;
1090 TAILQ_FOREACH(place, &dev->children, link)
1091 if (place->order > order)
1096 * The device 'place' is the first device whose order is
1097 * greater than the new child.
1099 TAILQ_INSERT_BEFORE(place, child, link);
1102 * The new child's order is greater or equal to the order of
1103 * any existing device. Add the child to the tail of the list.
1105 TAILQ_INSERT_TAIL(&dev->children, child, link);
1108 bus_data_generation_update();
1113 device_delete_child(device_t dev, device_t child)
1116 device_t grandchild;
1118 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1120 /* remove children first */
1121 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1122 error = device_delete_child(child, grandchild);
1127 if ((error = device_detach(child)) != 0)
1129 if (child->devclass)
1130 devclass_delete_device(child->devclass, child);
1131 TAILQ_REMOVE(&dev->children, child, link);
1132 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1133 device_set_desc(child, NULL);
1134 kobj_delete((kobj_t)child, M_BUS);
1136 bus_data_generation_update();
1141 * @brief Find a device given a unit number
1143 * This is similar to devclass_get_devices() but only searches for
1144 * devices which have @p dev as a parent.
1146 * @param dev the parent device to search
1147 * @param unit the unit number to search for. If the unit is -1,
1148 * return the first child of @p dev which has name
1149 * @p classname (that is, the one with the lowest unit.)
1151 * @returns the device with the given unit number or @c
1152 * NULL if there is no such device
1155 device_find_child(device_t dev, const char *classname, int unit)
1160 dc = devclass_find(classname);
1165 child = devclass_get_device(dc, unit);
1166 if (child && child->parent == dev)
1169 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1170 child = devclass_get_device(dc, unit);
1171 if (child && child->parent == dev)
1179 first_matching_driver(devclass_t dc, device_t dev)
1182 return(devclass_find_driver_internal(dc, dev->devclass->name));
1184 return(TAILQ_FIRST(&dc->drivers));
1188 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1190 if (dev->devclass) {
1192 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1193 if (!strcmp(dev->devclass->name, dl->driver->name))
1197 return(TAILQ_NEXT(last, link));
1201 device_probe_child(device_t dev, device_t child)
1204 driverlink_t best = 0;
1206 int result, pri = 0;
1207 int hasclass = (child->devclass != 0);
1211 panic("device_probe_child: parent device has no devclass");
1213 if (child->state == DS_ALIVE)
1216 for (; dc; dc = dc->parent) {
1217 for (dl = first_matching_driver(dc, child); dl;
1218 dl = next_matching_driver(dc, child, dl)) {
1219 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1220 device_set_driver(child, dl->driver);
1222 device_set_devclass(child, dl->driver->name);
1223 result = DEVICE_PROBE(child);
1225 device_set_devclass(child, 0);
1228 * If the driver returns SUCCESS, there can be
1229 * no higher match for this device.
1238 * The driver returned an error so it
1239 * certainly doesn't match.
1242 device_set_driver(child, 0);
1247 * A priority lower than SUCCESS, remember the
1248 * best matching driver. Initialise the value
1249 * of pri for the first match.
1251 if (best == 0 || result > pri) {
1258 * If we have unambiguous match in this devclass,
1259 * don't look in the parent.
1261 if (best && pri == 0)
1266 * If we found a driver, change state and initialise the devclass.
1269 if (!child->devclass)
1270 device_set_devclass(child, best->driver->name);
1271 device_set_driver(child, best->driver);
1274 * A bit bogus. Call the probe method again to make
1275 * sure that we have the right description.
1277 DEVICE_PROBE(child);
1280 bus_data_generation_update();
1281 child->state = DS_ALIVE;
1289 device_get_parent(device_t dev)
1295 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1302 TAILQ_FOREACH(child, &dev->children, link)
1305 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1310 TAILQ_FOREACH(child, &dev->children, link) {
1311 list[count] = child;
1322 device_get_driver(device_t dev)
1324 return(dev->driver);
1328 device_get_devclass(device_t dev)
1330 return(dev->devclass);
1334 device_get_name(device_t dev)
1337 return devclass_get_name(dev->devclass);
1342 device_get_nameunit(device_t dev)
1344 return(dev->nameunit);
1348 device_get_unit(device_t dev)
1354 device_get_desc(device_t dev)
1360 device_get_flags(device_t dev)
1362 return(dev->devflags);
1366 device_print_prettyname(device_t dev)
1368 const char *name = device_get_name(dev);
1371 return kprintf("unknown: ");
1373 return kprintf("%s%d: ", name, device_get_unit(dev));
1377 device_printf(device_t dev, const char * fmt, ...)
1382 retval = device_print_prettyname(dev);
1383 __va_start(ap, fmt);
1384 retval += kvprintf(fmt, ap);
1390 device_set_desc_internal(device_t dev, const char* desc, int copy)
1392 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1393 kfree(dev->desc, M_BUS);
1394 dev->flags &= ~DF_DESCMALLOCED;
1399 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1401 strcpy(dev->desc, desc);
1402 dev->flags |= DF_DESCMALLOCED;
1405 /* Avoid a -Wcast-qual warning */
1406 dev->desc = (char *)(uintptr_t) desc;
1409 bus_data_generation_update();
1413 device_set_desc(device_t dev, const char* desc)
1415 device_set_desc_internal(dev, desc, FALSE);
1419 device_set_desc_copy(device_t dev, const char* desc)
1421 device_set_desc_internal(dev, desc, TRUE);
1425 device_set_flags(device_t dev, uint32_t flags)
1427 dev->devflags = flags;
1431 device_get_softc(device_t dev)
1437 device_set_softc(device_t dev, void *softc)
1439 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1440 kfree(dev->softc, M_BUS);
1443 dev->flags |= DF_EXTERNALSOFTC;
1445 dev->flags &= ~DF_EXTERNALSOFTC;
1449 device_set_async_attach(device_t dev, int enable)
1452 dev->flags |= DF_ASYNCPROBE;
1454 dev->flags &= ~DF_ASYNCPROBE;
1458 device_get_ivars(device_t dev)
1464 device_set_ivars(device_t dev, void * ivars)
1473 device_get_state(device_t dev)
1479 device_enable(device_t dev)
1481 dev->flags |= DF_ENABLED;
1485 device_disable(device_t dev)
1487 dev->flags &= ~DF_ENABLED;
1494 device_busy(device_t dev)
1496 if (dev->state < DS_ATTACHED)
1497 panic("device_busy: called for unattached device");
1498 if (dev->busy == 0 && dev->parent)
1499 device_busy(dev->parent);
1501 dev->state = DS_BUSY;
1508 device_unbusy(device_t dev)
1510 if (dev->state != DS_BUSY)
1511 panic("device_unbusy: called for non-busy device");
1513 if (dev->busy == 0) {
1515 device_unbusy(dev->parent);
1516 dev->state = DS_ATTACHED;
1521 device_quiet(device_t dev)
1523 dev->flags |= DF_QUIET;
1527 device_verbose(device_t dev)
1529 dev->flags &= ~DF_QUIET;
1533 device_is_quiet(device_t dev)
1535 return((dev->flags & DF_QUIET) != 0);
1539 device_is_enabled(device_t dev)
1541 return((dev->flags & DF_ENABLED) != 0);
1545 device_is_alive(device_t dev)
1547 return(dev->state >= DS_ALIVE);
1551 device_is_attached(device_t dev)
1553 return(dev->state >= DS_ATTACHED);
1557 device_set_devclass(device_t dev, const char *classname)
1564 devclass_delete_device(dev->devclass, dev);
1568 if (dev->devclass) {
1569 kprintf("device_set_devclass: device class already set\n");
1573 dc = devclass_find_internal(classname, NULL, TRUE);
1577 error = devclass_add_device(dc, dev);
1579 bus_data_generation_update();
1584 device_set_driver(device_t dev, driver_t *driver)
1586 if (dev->state >= DS_ATTACHED)
1589 if (dev->driver == driver)
1592 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1593 kfree(dev->softc, M_BUS);
1596 kobj_delete((kobj_t) dev, 0);
1597 dev->driver = driver;
1599 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1600 if (!(dev->flags & DF_EXTERNALSOFTC)) {
1601 dev->softc = kmalloc(driver->size, M_BUS,
1602 M_INTWAIT | M_ZERO);
1604 kobj_delete((kobj_t)dev, 0);
1605 kobj_init((kobj_t) dev, &null_class);
1611 kobj_init((kobj_t) dev, &null_class);
1614 bus_data_generation_update();
1619 device_probe_and_attach(device_t dev)
1621 device_t bus = dev->parent;
1624 if (dev->state >= DS_ALIVE)
1627 if ((dev->flags & DF_ENABLED) == 0) {
1629 device_print_prettyname(dev);
1630 kprintf("not probed (disabled)\n");
1635 error = device_probe_child(bus, dev);
1637 if (!(dev->flags & DF_DONENOMATCH)) {
1638 BUS_PROBE_NOMATCH(bus, dev);
1640 dev->flags |= DF_DONENOMATCH;
1646 * Output the exact device chain prior to the attach in case the
1647 * system locks up during attach, and generate the full info after
1648 * the attach so correct irq and other information is displayed.
1650 if (bootverbose && !device_is_quiet(dev)) {
1653 kprintf("%s", device_get_nameunit(dev));
1654 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1655 kprintf(".%s", device_get_nameunit(tmp));
1658 if (!device_is_quiet(dev))
1659 device_print_child(bus, dev);
1660 if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1661 kprintf("%s: probing asynchronously\n",
1662 device_get_nameunit(dev));
1663 dev->state = DS_INPROGRESS;
1664 device_attach_async(dev);
1667 error = device_doattach(dev);
1673 * Device is known to be alive, do the attach asynchronously.
1675 * The MP lock is held by all threads.
1678 device_attach_async(device_t dev)
1682 atomic_add_int(&numasyncthreads, 1);
1683 lwkt_create(device_attach_thread, dev, &td, NULL,
1684 0, 0, (dev->desc ? dev->desc : "devattach"));
1688 device_attach_thread(void *arg)
1692 (void)device_doattach(dev);
1693 atomic_subtract_int(&numasyncthreads, 1);
1694 wakeup(&numasyncthreads);
1698 * Device is known to be alive, do the attach (synchronous or asynchronous)
1701 device_doattach(device_t dev)
1703 device_t bus = dev->parent;
1704 int hasclass = (dev->devclass != 0);
1707 error = DEVICE_ATTACH(dev);
1709 dev->state = DS_ATTACHED;
1710 if (bootverbose && !device_is_quiet(dev))
1711 device_print_child(bus, dev);
1714 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1715 dev->driver->name, dev->unit, error);
1716 /* Unset the class that was set in device_probe_child */
1718 device_set_devclass(dev, 0);
1719 device_set_driver(dev, NULL);
1720 dev->state = DS_NOTPRESENT;
1726 device_detach(device_t dev)
1730 PDEBUG(("%s", DEVICENAME(dev)));
1731 if (dev->state == DS_BUSY)
1733 if (dev->state != DS_ATTACHED)
1736 if ((error = DEVICE_DETACH(dev)) != 0)
1739 device_printf(dev, "detached\n");
1741 BUS_CHILD_DETACHED(dev->parent, dev);
1743 if (!(dev->flags & DF_FIXEDCLASS))
1744 devclass_delete_device(dev->devclass, dev);
1746 dev->state = DS_NOTPRESENT;
1747 device_set_driver(dev, NULL);
1753 device_shutdown(device_t dev)
1755 if (dev->state < DS_ATTACHED)
1757 PDEBUG(("%s", DEVICENAME(dev)));
1758 return DEVICE_SHUTDOWN(dev);
1762 device_set_unit(device_t dev, int unit)
1767 dc = device_get_devclass(dev);
1768 if (unit < dc->maxunit && dc->devices[unit])
1770 err = devclass_delete_device(dc, dev);
1774 err = devclass_add_device(dc, dev);
1778 bus_data_generation_update();
1782 /*======================================*/
1784 * Access functions for device resources.
1787 /* Supplied by config(8) in ioconf.c */
1788 extern struct config_device config_devtab[];
1789 extern int devtab_count;
1791 /* Runtime version */
1792 struct config_device *devtab = config_devtab;
1795 resource_new_name(const char *name, int unit)
1797 struct config_device *new;
1799 new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1800 M_INTWAIT | M_ZERO);
1803 if (devtab && devtab_count > 0)
1804 bcopy(devtab, new, devtab_count * sizeof(*new));
1805 new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1806 if (new[devtab_count].name == NULL) {
1810 strcpy(new[devtab_count].name, name);
1811 new[devtab_count].unit = unit;
1812 new[devtab_count].resource_count = 0;
1813 new[devtab_count].resources = NULL;
1814 if (devtab && devtab != config_devtab)
1815 kfree(devtab, M_TEMP);
1817 return devtab_count++;
1821 resource_new_resname(int j, const char *resname, resource_type type)
1823 struct config_resource *new;
1826 i = devtab[j].resource_count;
1827 new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1830 if (devtab[j].resources && i > 0)
1831 bcopy(devtab[j].resources, new, i * sizeof(*new));
1832 new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1833 if (new[i].name == NULL) {
1837 strcpy(new[i].name, resname);
1839 if (devtab[j].resources)
1840 kfree(devtab[j].resources, M_TEMP);
1841 devtab[j].resources = new;
1842 devtab[j].resource_count = i + 1;
1847 resource_match_string(int i, const char *resname, const char *value)
1850 struct config_resource *res;
1852 for (j = 0, res = devtab[i].resources;
1853 j < devtab[i].resource_count; j++, res++)
1854 if (!strcmp(res->name, resname)
1855 && res->type == RES_STRING
1856 && !strcmp(res->u.stringval, value))
1862 resource_find(const char *name, int unit, const char *resname,
1863 struct config_resource **result)
1866 struct config_resource *res;
1869 * First check specific instances, then generic.
1871 for (i = 0; i < devtab_count; i++) {
1872 if (devtab[i].unit < 0)
1874 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1875 res = devtab[i].resources;
1876 for (j = 0; j < devtab[i].resource_count; j++, res++)
1877 if (!strcmp(res->name, resname)) {
1883 for (i = 0; i < devtab_count; i++) {
1884 if (devtab[i].unit >= 0)
1886 /* XXX should this `&& devtab[i].unit == unit' be here? */
1887 /* XXX if so, then the generic match does nothing */
1888 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1889 res = devtab[i].resources;
1890 for (j = 0; j < devtab[i].resource_count; j++, res++)
1891 if (!strcmp(res->name, resname)) {
1901 resource_int_value(const char *name, int unit, const char *resname, int *result)
1904 struct config_resource *res;
1906 if ((error = resource_find(name, unit, resname, &res)) != 0)
1908 if (res->type != RES_INT)
1910 *result = res->u.intval;
1915 resource_long_value(const char *name, int unit, const char *resname,
1919 struct config_resource *res;
1921 if ((error = resource_find(name, unit, resname, &res)) != 0)
1923 if (res->type != RES_LONG)
1925 *result = res->u.longval;
1930 resource_string_value(const char *name, int unit, const char *resname,
1934 struct config_resource *res;
1936 if ((error = resource_find(name, unit, resname, &res)) != 0)
1938 if (res->type != RES_STRING)
1940 *result = res->u.stringval;
1945 resource_query_string(int i, const char *resname, const char *value)
1951 for (; i < devtab_count; i++)
1952 if (resource_match_string(i, resname, value) >= 0)
1958 resource_locate(int i, const char *resname)
1964 for (; i < devtab_count; i++)
1965 if (!strcmp(devtab[i].name, resname))
1971 resource_count(void)
1973 return(devtab_count);
1977 resource_query_name(int i)
1979 return(devtab[i].name);
1983 resource_query_unit(int i)
1985 return(devtab[i].unit);
1989 resource_create(const char *name, int unit, const char *resname,
1990 resource_type type, struct config_resource **result)
1993 struct config_resource *res = NULL;
1995 for (i = 0; i < devtab_count; i++)
1996 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1997 res = devtab[i].resources;
2001 i = resource_new_name(name, unit);
2004 res = devtab[i].resources;
2006 for (j = 0; j < devtab[i].resource_count; j++, res++)
2007 if (!strcmp(res->name, resname)) {
2011 j = resource_new_resname(i, resname, type);
2014 res = &devtab[i].resources[j];
2020 resource_set_int(const char *name, int unit, const char *resname, int value)
2023 struct config_resource *res;
2025 error = resource_create(name, unit, resname, RES_INT, &res);
2028 if (res->type != RES_INT)
2030 res->u.intval = value;
2035 resource_set_long(const char *name, int unit, const char *resname, long value)
2038 struct config_resource *res;
2040 error = resource_create(name, unit, resname, RES_LONG, &res);
2043 if (res->type != RES_LONG)
2045 res->u.longval = value;
2050 resource_set_string(const char *name, int unit, const char *resname,
2054 struct config_resource *res;
2056 error = resource_create(name, unit, resname, RES_STRING, &res);
2059 if (res->type != RES_STRING)
2061 if (res->u.stringval)
2062 kfree(res->u.stringval, M_TEMP);
2063 res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2064 if (res->u.stringval == NULL)
2066 strcpy(res->u.stringval, value);
2071 resource_cfgload(void *dummy __unused)
2073 struct config_resource *res, *cfgres;
2076 char *name, *resname;
2080 int config_devtab_count;
2082 config_devtab_count = devtab_count;
2086 for (i = 0; i < config_devtab_count; i++) {
2087 name = config_devtab[i].name;
2088 unit = config_devtab[i].unit;
2090 for (j = 0; j < config_devtab[i].resource_count; j++) {
2091 cfgres = config_devtab[i].resources;
2092 resname = cfgres[j].name;
2093 type = cfgres[j].type;
2094 error = resource_create(name, unit, resname, type,
2097 kprintf("create resource %s%d: error %d\n",
2101 if (res->type != type) {
2102 kprintf("type mismatch %s%d: %d != %d\n",
2103 name, unit, res->type, type);
2108 res->u.intval = cfgres[j].u.intval;
2111 res->u.longval = cfgres[j].u.longval;
2114 if (res->u.stringval)
2115 kfree(res->u.stringval, M_TEMP);
2116 stringval = cfgres[j].u.stringval;
2117 res->u.stringval = kmalloc(strlen(stringval) + 1,
2119 if (res->u.stringval == NULL)
2121 strcpy(res->u.stringval, stringval);
2124 panic("unknown resource type %d", type);
2129 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2132 /*======================================*/
2134 * Some useful method implementations to make life easier for bus drivers.
2138 resource_list_init(struct resource_list *rl)
2144 resource_list_free(struct resource_list *rl)
2146 struct resource_list_entry *rle;
2148 while ((rle = SLIST_FIRST(rl)) != NULL) {
2150 panic("resource_list_free: resource entry is busy");
2151 SLIST_REMOVE_HEAD(rl, link);
2157 resource_list_add(struct resource_list *rl,
2159 u_long start, u_long end, u_long count)
2161 struct resource_list_entry *rle;
2163 rle = resource_list_find(rl, type, rid);
2165 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2168 panic("resource_list_add: can't record entry");
2169 SLIST_INSERT_HEAD(rl, rle, link);
2176 panic("resource_list_add: resource entry is busy");
2183 struct resource_list_entry*
2184 resource_list_find(struct resource_list *rl,
2187 struct resource_list_entry *rle;
2189 SLIST_FOREACH(rle, rl, link)
2190 if (rle->type == type && rle->rid == rid)
2196 resource_list_delete(struct resource_list *rl,
2199 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2202 if (rle->res != NULL)
2203 panic("resource_list_delete: resource has not been released");
2204 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2210 resource_list_alloc(struct resource_list *rl,
2211 device_t bus, device_t child,
2213 u_long start, u_long end,
2214 u_long count, u_int flags)
2216 struct resource_list_entry *rle = 0;
2217 int passthrough = (device_get_parent(child) != bus);
2218 int isdefault = (start == 0UL && end == ~0UL);
2221 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2223 start, end, count, flags));
2226 rle = resource_list_find(rl, type, *rid);
2229 return(0); /* no resource of that type/rid */
2232 panic("resource_list_alloc: resource entry is busy");
2236 count = max(count, rle->count);
2237 end = max(rle->end, start + count - 1);
2240 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2241 type, rid, start, end, count, flags);
2244 * Record the new range.
2247 rle->start = rman_get_start(rle->res);
2248 rle->end = rman_get_end(rle->res);
2256 resource_list_release(struct resource_list *rl,
2257 device_t bus, device_t child,
2258 int type, int rid, struct resource *res)
2260 struct resource_list_entry *rle = 0;
2261 int passthrough = (device_get_parent(child) != bus);
2265 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2269 rle = resource_list_find(rl, type, rid);
2272 panic("resource_list_release: can't find resource");
2274 panic("resource_list_release: resource entry is not busy");
2276 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2286 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2289 struct resource_list_entry *rle;
2290 int printed, retval;
2294 /* Yes, this is kinda cheating */
2295 SLIST_FOREACH(rle, rl, link) {
2296 if (rle->type == type) {
2298 retval += kprintf(" %s ", name);
2300 retval += kprintf(",");
2302 retval += kprintf(format, rle->start);
2303 if (rle->count > 1) {
2304 retval += kprintf("-");
2305 retval += kprintf(format, rle->start +
2314 * Generic driver/device identify functions. These will install a device
2315 * rendezvous point under the parent using the same name as the driver
2316 * name, which will at a later time be probed and attached.
2318 * These functions are used when the parent does not 'scan' its bus for
2319 * matching devices, or for the particular devices using these functions,
2320 * or when the device is a pseudo or synthesized device (such as can be
2321 * found under firewire and ppbus).
2324 bus_generic_identify(driver_t *driver, device_t parent)
2326 if (parent->state == DS_ATTACHED)
2328 BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2333 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2335 if (parent->state == DS_ATTACHED)
2337 BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2342 * Call DEVICE_IDENTIFY for each driver.
2345 bus_generic_probe(device_t dev)
2347 devclass_t dc = dev->devclass;
2350 TAILQ_FOREACH(dl, &dc->drivers, link) {
2351 DEVICE_IDENTIFY(dl->driver, dev);
2358 * This is an aweful hack due to the isa bus and autoconf code not
2359 * probing the ISA devices until after everything else has configured.
2360 * The ISA bus did a dummy attach long ago so we have to set it back
2361 * to an earlier state so the probe thinks its the initial probe and
2364 * XXX remove by properly defering the ISA bus scan.
2367 bus_generic_probe_hack(device_t dev)
2369 if (dev->state == DS_ATTACHED) {
2370 dev->state = DS_ALIVE;
2371 bus_generic_probe(dev);
2372 dev->state = DS_ATTACHED;
2378 bus_generic_attach(device_t dev)
2382 TAILQ_FOREACH(child, &dev->children, link) {
2383 device_probe_and_attach(child);
2390 bus_generic_detach(device_t dev)
2395 if (dev->state != DS_ATTACHED)
2398 TAILQ_FOREACH(child, &dev->children, link)
2399 if ((error = device_detach(child)) != 0)
2406 bus_generic_shutdown(device_t dev)
2410 TAILQ_FOREACH(child, &dev->children, link)
2411 device_shutdown(child);
2417 bus_generic_suspend(device_t dev)
2420 device_t child, child2;
2422 TAILQ_FOREACH(child, &dev->children, link) {
2423 error = DEVICE_SUSPEND(child);
2425 for (child2 = TAILQ_FIRST(&dev->children);
2426 child2 && child2 != child;
2427 child2 = TAILQ_NEXT(child2, link))
2428 DEVICE_RESUME(child2);
2436 bus_generic_resume(device_t dev)
2440 TAILQ_FOREACH(child, &dev->children, link)
2441 DEVICE_RESUME(child);
2442 /* if resume fails, there's nothing we can usefully do... */
2448 bus_print_child_header(device_t dev, device_t child)
2452 if (device_get_desc(child))
2453 retval += device_printf(child, "<%s>", device_get_desc(child));
2455 retval += kprintf("%s", device_get_nameunit(child));
2457 if (child->state != DS_ATTACHED)
2458 kprintf(" [tentative]");
2460 kprintf(" [attached!]");
2466 bus_print_child_footer(device_t dev, device_t child)
2468 return(kprintf(" on %s\n", device_get_nameunit(dev)));
2472 bus_generic_add_child(device_t dev, device_t child, int order,
2473 const char *name, int unit)
2476 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2478 dev = device_add_child_ordered(child, order, name, unit);
2484 bus_generic_print_child(device_t dev, device_t child)
2488 retval += bus_print_child_header(dev, child);
2489 retval += bus_print_child_footer(dev, child);
2495 bus_generic_read_ivar(device_t dev, device_t child, int index,
2501 error = BUS_READ_IVAR(dev->parent, child, index, result);
2508 bus_generic_write_ivar(device_t dev, device_t child, int index,
2514 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2521 * Resource list are used for iterations, do not recurse.
2523 struct resource_list *
2524 bus_generic_get_resource_list(device_t dev, device_t child)
2530 bus_generic_driver_added(device_t dev, driver_t *driver)
2534 DEVICE_IDENTIFY(driver, dev);
2535 TAILQ_FOREACH(child, &dev->children, link) {
2536 if (child->state == DS_NOTPRESENT)
2537 device_probe_and_attach(child);
2542 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2543 int flags, driver_intr_t *intr, void *arg,
2544 void **cookiep, lwkt_serialize_t serializer)
2546 /* Propagate up the bus hierarchy until someone handles it. */
2548 return(BUS_SETUP_INTR(dev->parent, child, irq, flags,
2549 intr, arg, cookiep, serializer));
2555 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2558 /* Propagate up the bus hierarchy until someone handles it. */
2560 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2566 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2569 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2575 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2578 BUS_ENABLE_INTR(dev->parent, child, cookie);
2582 bus_generic_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
2583 enum intr_polarity pol)
2585 /* Propagate up the bus hierarchy until someone handles it. */
2587 return(BUS_CONFIG_INTR(dev->parent, child, irq, trig, pol));
2593 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2594 u_long start, u_long end, u_long count, u_int flags)
2596 /* Propagate up the bus hierarchy until someone handles it. */
2598 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2599 start, end, count, flags));
2605 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2608 /* Propagate up the bus hierarchy until someone handles it. */
2610 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2616 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2619 /* Propagate up the bus hierarchy until someone handles it. */
2621 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2627 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2628 int rid, struct resource *r)
2630 /* Propagate up the bus hierarchy until someone handles it. */
2632 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2639 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2640 u_long *startp, u_long *countp)
2646 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2653 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2654 u_long start, u_long count)
2660 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2667 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2670 BUS_DELETE_RESOURCE(dev, child, type, rid);
2674 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2675 u_long *startp, u_long *countp)
2677 struct resource_list *rl = NULL;
2678 struct resource_list_entry *rle = NULL;
2680 rl = BUS_GET_RESOURCE_LIST(dev, child);
2684 rle = resource_list_find(rl, type, rid);
2689 *startp = rle->start;
2691 *countp = rle->count;
2697 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2698 u_long start, u_long count)
2700 struct resource_list *rl = NULL;
2702 rl = BUS_GET_RESOURCE_LIST(dev, child);
2706 resource_list_add(rl, type, rid, start, (start + count - 1), count);
2712 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2714 struct resource_list *rl = NULL;
2716 rl = BUS_GET_RESOURCE_LIST(dev, child);
2720 resource_list_delete(rl, type, rid);
2724 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2725 int rid, struct resource *r)
2727 struct resource_list *rl = NULL;
2729 rl = BUS_GET_RESOURCE_LIST(dev, child);
2733 return(resource_list_release(rl, dev, child, type, rid, r));
2737 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2738 int *rid, u_long start, u_long end, u_long count, u_int flags)
2740 struct resource_list *rl = NULL;
2742 rl = BUS_GET_RESOURCE_LIST(dev, child);
2746 return(resource_list_alloc(rl, dev, child, type, rid,
2747 start, end, count, flags));
2751 bus_generic_child_present(device_t bus, device_t child)
2753 return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2758 * Some convenience functions to make it easier for drivers to use the
2759 * resource-management functions. All these really do is hide the
2760 * indirection through the parent's method table, making for slightly
2761 * less-wordy code. In the future, it might make sense for this code
2762 * to maintain some sort of a list of resources allocated by each device.
2765 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2766 struct resource **res)
2770 for (i = 0; rs[i].type != -1; i++)
2772 for (i = 0; rs[i].type != -1; i++) {
2773 res[i] = bus_alloc_resource_any(dev,
2774 rs[i].type, &rs[i].rid, rs[i].flags);
2775 if (res[i] == NULL) {
2776 bus_release_resources(dev, rs, res);
2784 bus_release_resources(device_t dev, const struct resource_spec *rs,
2785 struct resource **res)
2789 for (i = 0; rs[i].type != -1; i++)
2790 if (res[i] != NULL) {
2791 bus_release_resource(
2792 dev, rs[i].type, rs[i].rid, res[i]);
2798 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2799 u_long count, u_int flags)
2801 if (dev->parent == 0)
2803 return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2808 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2810 if (dev->parent == 0)
2812 return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2816 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2818 if (dev->parent == 0)
2820 return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2824 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2826 if (dev->parent == 0)
2828 return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2832 bus_setup_intr(device_t dev, struct resource *r, int flags,
2833 driver_intr_t handler, void *arg,
2834 void **cookiep, lwkt_serialize_t serializer)
2836 if (dev->parent == 0)
2838 return(BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2839 cookiep, serializer));
2843 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2845 if (dev->parent == 0)
2847 return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2851 bus_enable_intr(device_t dev, void *cookie)
2854 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2858 bus_disable_intr(device_t dev, void *cookie)
2861 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2867 bus_set_resource(device_t dev, int type, int rid,
2868 u_long start, u_long count)
2870 return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2875 bus_get_resource(device_t dev, int type, int rid,
2876 u_long *startp, u_long *countp)
2878 return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2883 bus_get_resource_start(device_t dev, int type, int rid)
2885 u_long start, count;
2888 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2896 bus_get_resource_count(device_t dev, int type, int rid)
2898 u_long start, count;
2901 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2909 bus_delete_resource(device_t dev, int type, int rid)
2911 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2915 bus_child_present(device_t child)
2917 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
2921 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
2925 parent = device_get_parent(child);
2926 if (parent == NULL) {
2930 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
2934 bus_child_location_str(device_t child, char *buf, size_t buflen)
2938 parent = device_get_parent(child);
2939 if (parent == NULL) {
2943 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
2947 root_print_child(device_t dev, device_t child)
2953 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
2954 void **cookiep, lwkt_serialize_t serializer)
2957 * If an interrupt mapping gets to here something bad has happened.
2959 panic("root_setup_intr");
2963 * If we get here, assume that the device is permanant and really is
2964 * present in the system. Removable bus drivers are expected to intercept
2965 * this call long before it gets here. We return -1 so that drivers that
2966 * really care can check vs -1 or some ERRNO returned higher in the food
2970 root_child_present(device_t dev, device_t child)
2976 * XXX NOTE! other defaults may be set in bus_if.m
2978 static kobj_method_t root_methods[] = {
2979 /* Device interface */
2980 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
2981 KOBJMETHOD(device_suspend, bus_generic_suspend),
2982 KOBJMETHOD(device_resume, bus_generic_resume),
2985 KOBJMETHOD(bus_add_child, bus_generic_add_child),
2986 KOBJMETHOD(bus_print_child, root_print_child),
2987 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
2988 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
2989 KOBJMETHOD(bus_setup_intr, root_setup_intr),
2990 KOBJMETHOD(bus_child_present, root_child_present),
2995 static driver_t root_driver = {
3002 devclass_t root_devclass;
3005 root_bus_module_handler(module_t mod, int what, void* arg)
3009 TAILQ_INIT(&bus_data_devices);
3010 root_bus = make_device(NULL, "root", 0);
3011 root_bus->desc = "System root bus";
3012 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
3013 root_bus->driver = &root_driver;
3014 root_bus->state = DS_ALIVE;
3015 root_devclass = devclass_find_internal("root", NULL, FALSE);
3020 device_shutdown(root_bus);
3027 static moduledata_t root_bus_mod = {
3029 root_bus_module_handler,
3032 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
3035 root_bus_configure(void)
3043 * handle device_identify based device attachments to the root_bus
3044 * (typically nexus).
3046 bus_generic_probe(root_bus);
3049 * Probe and attach the devices under root_bus.
3051 TAILQ_FOREACH(dev, &root_bus->children, link) {
3052 device_probe_and_attach(dev);
3056 * Wait for all asynchronous attaches to complete. If we don't
3057 * our legacy ISA bus scan could steal device unit numbers or
3061 if (numasyncthreads)
3062 kprintf("Waiting for async drivers to attach\n");
3063 while (numasyncthreads > 0) {
3064 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3066 if (warncount == 0) {
3067 kprintf("Warning: Still waiting for %d "
3068 "drivers to attach\n", numasyncthreads);
3069 } else if (warncount == -30) {
3070 kprintf("Giving up on %d drivers\n", numasyncthreads);
3074 root_bus->state = DS_ATTACHED;
3078 driver_module_handler(module_t mod, int what, void *arg)
3081 struct driver_module_data *dmd;
3082 devclass_t bus_devclass;
3083 kobj_class_t driver;
3084 const char *parentname;
3086 dmd = (struct driver_module_data *)arg;
3087 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3092 if (dmd->dmd_chainevh)
3093 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3095 driver = dmd->dmd_driver;
3096 PDEBUG(("Loading module: driver %s on bus %s",
3097 DRIVERNAME(driver), dmd->dmd_busname));
3100 * If the driver has any base classes, make the
3101 * devclass inherit from the devclass of the driver's
3102 * first base class. This will allow the system to
3103 * search for drivers in both devclasses for children
3104 * of a device using this driver.
3106 if (driver->baseclasses)
3107 parentname = driver->baseclasses[0]->name;
3110 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3113 error = devclass_add_driver(bus_devclass, driver);
3119 PDEBUG(("Unloading module: driver %s from bus %s",
3120 DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3121 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3123 if (!error && dmd->dmd_chainevh)
3124 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3134 * The _short versions avoid iteration by not calling anything that prints
3135 * more than oneliners. I love oneliners.
3139 print_device_short(device_t dev, int indent)
3144 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3145 dev->unit, dev->desc,
3146 (dev->parent? "":"no "),
3147 (TAILQ_EMPTY(&dev->children)? "no ":""),
3148 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3149 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3150 (dev->flags&DF_WILDCARD? "wildcard,":""),
3151 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3152 (dev->ivars? "":"no "),
3153 (dev->softc? "":"no "),
3158 print_device(device_t dev, int indent)
3163 print_device_short(dev, indent);
3165 indentprintf(("Parent:\n"));
3166 print_device_short(dev->parent, indent+1);
3167 indentprintf(("Driver:\n"));
3168 print_driver_short(dev->driver, indent+1);
3169 indentprintf(("Devclass:\n"));
3170 print_devclass_short(dev->devclass, indent+1);
3174 * Print the device and all its children (indented).
3177 print_device_tree_short(device_t dev, int indent)
3184 print_device_short(dev, indent);
3186 TAILQ_FOREACH(child, &dev->children, link)
3187 print_device_tree_short(child, indent+1);
3191 * Print the device and all its children (indented).
3194 print_device_tree(device_t dev, int indent)
3201 print_device(dev, indent);
3203 TAILQ_FOREACH(child, &dev->children, link)
3204 print_device_tree(child, indent+1);
3208 print_driver_short(driver_t *driver, int indent)
3213 indentprintf(("driver %s: softc size = %zu\n",
3214 driver->name, driver->size));
3218 print_driver(driver_t *driver, int indent)
3223 print_driver_short(driver, indent);
3228 print_driver_list(driver_list_t drivers, int indent)
3230 driverlink_t driver;
3232 TAILQ_FOREACH(driver, &drivers, link)
3233 print_driver(driver->driver, indent);
3237 print_devclass_short(devclass_t dc, int indent)
3242 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3246 print_devclass(devclass_t dc, int indent)
3253 print_devclass_short(dc, indent);
3254 indentprintf(("Drivers:\n"));
3255 print_driver_list(dc->drivers, indent+1);
3257 indentprintf(("Devices:\n"));
3258 for (i = 0; i < dc->maxunit; i++)
3260 print_device(dc->devices[i], indent+1);
3264 print_devclass_list_short(void)
3268 kprintf("Short listing of devclasses, drivers & devices:\n");
3269 TAILQ_FOREACH(dc, &devclasses, link) {
3270 print_devclass_short(dc, 0);
3275 print_devclass_list(void)
3279 kprintf("Full listing of devclasses, drivers & devices:\n");
3280 TAILQ_FOREACH(dc, &devclasses, link) {
3281 print_devclass(dc, 0);
3288 * Check to see if a device is disabled via a disabled hint.
3291 resource_disabled(const char *name, int unit)
3295 error = resource_int_value(name, unit, "disabled", &value);
3302 * User-space access to the device tree.
3304 * We implement a small set of nodes:
3306 * hw.bus Single integer read method to obtain the
3307 * current generation count.
3308 * hw.bus.devices Reads the entire device tree in flat space.
3309 * hw.bus.rman Resource manager interface
3311 * We might like to add the ability to scan devclasses and/or drivers to
3312 * determine what else is currently loaded/available.
3316 sysctl_bus(SYSCTL_HANDLER_ARGS)
3318 struct u_businfo ubus;
3320 ubus.ub_version = BUS_USER_VERSION;
3321 ubus.ub_generation = bus_data_generation;
3323 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3325 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3326 "bus-related data");
3329 sysctl_devices(SYSCTL_HANDLER_ARGS)
3331 int *name = (int *)arg1;
3332 u_int namelen = arg2;
3335 struct u_device udev; /* XXX this is a bit big */
3341 if (bus_data_generation_check(name[0]))
3347 * Scan the list of devices, looking for the requested index.
3349 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3357 * Populate the return array.
3359 bzero(&udev, sizeof(udev));
3360 udev.dv_handle = (uintptr_t)dev;
3361 udev.dv_parent = (uintptr_t)dev->parent;
3362 if (dev->nameunit != NULL)
3363 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3364 if (dev->desc != NULL)
3365 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3366 if (dev->driver != NULL && dev->driver->name != NULL)
3367 strlcpy(udev.dv_drivername, dev->driver->name,
3368 sizeof(udev.dv_drivername));
3369 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3370 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3371 udev.dv_devflags = dev->devflags;
3372 udev.dv_flags = dev->flags;
3373 udev.dv_state = dev->state;
3374 error = SYSCTL_OUT(req, &udev, sizeof(udev));
3378 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3379 "system device tree");
3382 bus_data_generation_check(int generation)
3384 if (generation != bus_data_generation)
3387 /* XXX generate optimised lists here? */
3392 bus_data_generation_update(void)
3394 bus_data_generation++;