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 KNOTE(&devsoftc.sel.si_note, 0);
371 rel_mplock(); /* XXX */
372 p = devsoftc.async_proc;
378 * @brief Send a 'notification' to userland, using standard ways
381 devctl_notify(const char *system, const char *subsystem, const char *type,
388 return; /* BOGUS! Must specify system. */
389 if (subsystem == NULL)
390 return; /* BOGUS! Must specify subsystem. */
392 return; /* BOGUS! Must specify type. */
393 len += strlen(" system=") + strlen(system);
394 len += strlen(" subsystem=") + strlen(subsystem);
395 len += strlen(" type=") + strlen(type);
396 /* add in the data message plus newline. */
399 len += 3; /* '!', '\n', and NUL */
400 msg = kmalloc(len, M_BUS, M_NOWAIT);
402 return; /* Drop it on the floor */
404 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
405 system, subsystem, type, data);
407 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
408 system, subsystem, type);
409 devctl_queue_data(msg);
413 * Common routine that tries to make sending messages as easy as possible.
414 * We allocate memory for the data, copy strings into that, but do not
415 * free it unless there's an error. The dequeue part of the driver should
416 * free the data. We don't send data when the device is disabled. We do
417 * send data, even when we have no listeners, because we wish to avoid
418 * races relating to startup and restart of listening applications.
420 * devaddq is designed to string together the type of event, with the
421 * object of that event, plus the plug and play info and location info
422 * for that event. This is likely most useful for devices, but less
423 * useful for other consumers of this interface. Those should use
424 * the devctl_queue_data() interface instead.
427 devaddq(const char *type, const char *what, device_t dev)
436 data = kmalloc(1024, M_BUS, M_NOWAIT);
440 /* get the bus specific location of this device */
441 loc = kmalloc(1024, M_BUS, M_NOWAIT);
445 bus_child_location_str(dev, loc, 1024);
447 /* Get the bus specific pnp info of this device */
448 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
452 bus_child_pnpinfo_str(dev, pnp, 1024);
454 /* Get the parent of this device, or / if high enough in the tree. */
455 if (device_get_parent(dev) == NULL)
456 parstr = "."; /* Or '/' ? */
458 parstr = device_get_nameunit(device_get_parent(dev));
459 /* String it all together. */
460 ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
464 devctl_queue_data(data);
474 * A device was added to the tree. We are called just after it successfully
475 * attaches (that is, probe and attach success for this device). No call
476 * is made if a device is merely parented into the tree. See devnomatch
477 * if probe fails. If attach fails, no notification is sent (but maybe
478 * we should have a different message for this).
481 devadded(device_t dev)
486 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
489 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
493 bus_child_pnpinfo_str(dev, pnp, 1024);
494 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
495 devaddq("+", tmp, dev);
505 * A device was removed from the tree. We are called just before this
509 devremoved(device_t dev)
514 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
517 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
521 bus_child_pnpinfo_str(dev, pnp, 1024);
522 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
523 devaddq("-", tmp, dev);
533 * Called when there's no match for this device. This is only called
534 * the first time that no match happens, so we don't keep getitng this
535 * message. Should that prove to be undesirable, we can change it.
536 * This is called when all drivers that can attach to a given bus
537 * decline to accept this device. Other errrors may not be detected.
540 devnomatch(device_t dev)
542 devaddq("?", "", dev);
546 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
548 struct dev_event_info *n1;
551 dis = devctl_disable;
552 error = sysctl_handle_int(oidp, &dis, 0, req);
553 if (error || !req->newptr)
555 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
556 devctl_disable = dis;
558 while (!TAILQ_EMPTY(&devsoftc.devq)) {
559 n1 = TAILQ_FIRST(&devsoftc.devq);
560 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
561 kfree(n1->dei_data, M_BUS);
565 lockmgr(&devsoftc.lock, LK_RELEASE);
569 /* End of /dev/devctl code */
571 TAILQ_HEAD(,device) bus_data_devices;
572 static int bus_data_generation = 1;
574 kobj_method_t null_methods[] = {
578 DEFINE_CLASS(null, null_methods, 0);
581 * Devclass implementation
584 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
587 devclass_find_internal(const char *classname, const char *parentname,
592 PDEBUG(("looking for %s", classname));
593 if (classname == NULL)
596 TAILQ_FOREACH(dc, &devclasses, link)
597 if (!strcmp(dc->name, classname))
601 PDEBUG(("creating %s", classname));
602 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
603 M_BUS, M_INTWAIT | M_ZERO);
607 dc->name = (char*) (dc + 1);
608 strcpy(dc->name, classname);
611 TAILQ_INIT(&dc->drivers);
612 TAILQ_INSERT_TAIL(&devclasses, dc, link);
614 bus_data_generation_update();
617 if (parentname && dc && !dc->parent)
618 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
624 devclass_create(const char *classname)
626 return(devclass_find_internal(classname, NULL, TRUE));
630 devclass_find(const char *classname)
632 return(devclass_find_internal(classname, NULL, FALSE));
636 devclass_find_unit(const char *classname, int unit)
640 if ((dc = devclass_find(classname)) != NULL)
641 return(devclass_get_device(dc, unit));
646 devclass_add_driver(devclass_t dc, driver_t *driver)
652 PDEBUG(("%s", DRIVERNAME(driver)));
654 dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
659 * Compile the driver's methods. Also increase the reference count
660 * so that the class doesn't get freed when the last instance
661 * goes. This means we can safely use static methods and avoids a
662 * double-free in devclass_delete_driver.
664 kobj_class_instantiate(driver);
667 * Make sure the devclass which the driver is implementing exists.
669 devclass_find_internal(driver->name, NULL, TRUE);
672 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
675 * Call BUS_DRIVER_ADDED for any existing busses in this class,
676 * but only if the bus has already been attached (otherwise we
677 * might probe too early).
679 * This is what will cause a newly loaded module to be associated
680 * with hardware. bus_generic_driver_added() is typically what ends
683 for (i = 0; i < dc->maxunit; i++) {
684 if ((dev = dc->devices[i]) != NULL) {
685 if (dev->state >= DS_ATTACHED)
686 BUS_DRIVER_ADDED(dev, driver);
690 bus_data_generation_update();
695 devclass_delete_driver(devclass_t busclass, driver_t *driver)
697 devclass_t dc = devclass_find(driver->name);
703 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
709 * Find the link structure in the bus' list of drivers.
711 TAILQ_FOREACH(dl, &busclass->drivers, link)
712 if (dl->driver == driver)
716 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
721 * Disassociate from any devices. We iterate through all the
722 * devices in the devclass of the driver and detach any which are
723 * using the driver and which have a parent in the devclass which
724 * we are deleting from.
726 * Note that since a driver can be in multiple devclasses, we
727 * should not detach devices which are not children of devices in
728 * the affected devclass.
730 for (i = 0; i < dc->maxunit; i++)
731 if (dc->devices[i]) {
732 dev = dc->devices[i];
733 if (dev->driver == driver && dev->parent &&
734 dev->parent->devclass == busclass) {
735 if ((error = device_detach(dev)) != 0)
737 device_set_driver(dev, NULL);
741 TAILQ_REMOVE(&busclass->drivers, dl, link);
744 kobj_class_uninstantiate(driver);
746 bus_data_generation_update();
751 devclass_find_driver_internal(devclass_t dc, const char *classname)
755 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
757 TAILQ_FOREACH(dl, &dc->drivers, link)
758 if (!strcmp(dl->driver->name, classname))
761 PDEBUG(("not found"));
766 devclass_find_driver(devclass_t dc, const char *classname)
770 dl = devclass_find_driver_internal(dc, classname);
778 devclass_get_name(devclass_t dc)
784 devclass_get_device(devclass_t dc, int unit)
786 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
788 return(dc->devices[unit]);
792 devclass_get_softc(devclass_t dc, int unit)
796 dev = devclass_get_device(dc, unit);
800 return(device_get_softc(dev));
804 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
811 for (i = 0; i < dc->maxunit; i++)
815 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
820 for (i = 0; i < dc->maxunit; i++)
821 if (dc->devices[i]) {
822 list[count] = dc->devices[i];
833 * @brief Get a list of drivers in the devclass
835 * An array containing a list of pointers to all the drivers in the
836 * given devclass is allocated and returned in @p *listp. The number
837 * of drivers in the array is returned in @p *countp. The caller should
838 * free the array using @c free(p, M_TEMP).
840 * @param dc the devclass to examine
841 * @param listp gives location for array pointer return value
842 * @param countp gives location for number of array elements
846 * @retval ENOMEM the array allocation failed
849 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
856 TAILQ_FOREACH(dl, &dc->drivers, link)
858 list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
863 TAILQ_FOREACH(dl, &dc->drivers, link) {
864 list[count] = dl->driver;
874 * @brief Get the number of devices in a devclass
876 * @param dc the devclass to examine
879 devclass_get_count(devclass_t dc)
884 for (i = 0; i < dc->maxunit; i++)
891 devclass_get_maxunit(devclass_t dc)
897 devclass_set_parent(devclass_t dc, devclass_t pdc)
903 devclass_get_parent(devclass_t dc)
909 devclass_alloc_unit(devclass_t dc, int *unitp)
913 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
915 /* If we have been given a wired unit number, check for existing device */
917 if (unit >= 0 && unit < dc->maxunit &&
918 dc->devices[unit] != NULL) {
920 kprintf("%s-: %s%d exists, using next available unit number\n",
921 dc->name, dc->name, unit);
922 /* find the next available slot */
923 while (++unit < dc->maxunit && dc->devices[unit] != NULL)
927 /* Unwired device, find the next available slot for it */
929 while (unit < dc->maxunit && dc->devices[unit] != NULL)
934 * We've selected a unit beyond the length of the table, so let's
935 * extend the table to make room for all units up to and including
938 if (unit >= dc->maxunit) {
942 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
943 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
947 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
949 kfree(dc->devices, M_BUS);
950 dc->devices = newlist;
951 dc->maxunit = newsize;
953 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
960 devclass_add_device(devclass_t dc, device_t dev)
964 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
966 buflen = strlen(dc->name) + 5;
967 dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
971 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
972 kfree(dev->nameunit, M_BUS);
973 dev->nameunit = NULL;
976 dc->devices[dev->unit] = dev;
978 ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
984 devclass_delete_device(devclass_t dc, device_t dev)
989 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
991 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
992 panic("devclass_delete_device: inconsistent device class");
993 dc->devices[dev->unit] = NULL;
994 if (dev->flags & DF_WILDCARD)
996 dev->devclass = NULL;
997 kfree(dev->nameunit, M_BUS);
998 dev->nameunit = NULL;
1004 make_device(device_t parent, const char *name, int unit)
1009 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1012 dc = devclass_find_internal(name, NULL, TRUE);
1014 kprintf("make_device: can't find device class %s\n", name);
1020 dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
1024 dev->parent = parent;
1025 TAILQ_INIT(&dev->children);
1026 kobj_init((kobj_t) dev, &null_class);
1028 dev->devclass = NULL;
1030 dev->nameunit = NULL;
1034 dev->flags = DF_ENABLED;
1037 dev->flags |= DF_WILDCARD;
1039 dev->flags |= DF_FIXEDCLASS;
1040 if (devclass_add_device(dc, dev) != 0) {
1041 kobj_delete((kobj_t)dev, M_BUS);
1048 dev->state = DS_NOTPRESENT;
1050 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1051 bus_data_generation_update();
1057 device_print_child(device_t dev, device_t child)
1061 if (device_is_alive(child))
1062 retval += BUS_PRINT_CHILD(dev, child);
1064 retval += device_printf(child, " not found\n");
1070 device_add_child(device_t dev, const char *name, int unit)
1072 return device_add_child_ordered(dev, 0, name, unit);
1076 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1081 PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1084 child = make_device(dev, name, unit);
1087 child->order = order;
1089 TAILQ_FOREACH(place, &dev->children, link)
1090 if (place->order > order)
1095 * The device 'place' is the first device whose order is
1096 * greater than the new child.
1098 TAILQ_INSERT_BEFORE(place, child, link);
1101 * The new child's order is greater or equal to the order of
1102 * any existing device. Add the child to the tail of the list.
1104 TAILQ_INSERT_TAIL(&dev->children, child, link);
1107 bus_data_generation_update();
1112 device_delete_child(device_t dev, device_t child)
1115 device_t grandchild;
1117 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1119 /* remove children first */
1120 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1121 error = device_delete_child(child, grandchild);
1126 if ((error = device_detach(child)) != 0)
1128 if (child->devclass)
1129 devclass_delete_device(child->devclass, child);
1130 TAILQ_REMOVE(&dev->children, child, link);
1131 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1132 device_set_desc(child, NULL);
1133 kobj_delete((kobj_t)child, M_BUS);
1135 bus_data_generation_update();
1140 * @brief Find a device given a unit number
1142 * This is similar to devclass_get_devices() but only searches for
1143 * devices which have @p dev as a parent.
1145 * @param dev the parent device to search
1146 * @param unit the unit number to search for. If the unit is -1,
1147 * return the first child of @p dev which has name
1148 * @p classname (that is, the one with the lowest unit.)
1150 * @returns the device with the given unit number or @c
1151 * NULL if there is no such device
1154 device_find_child(device_t dev, const char *classname, int unit)
1159 dc = devclass_find(classname);
1164 child = devclass_get_device(dc, unit);
1165 if (child && child->parent == dev)
1168 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1169 child = devclass_get_device(dc, unit);
1170 if (child && child->parent == dev)
1178 first_matching_driver(devclass_t dc, device_t dev)
1181 return(devclass_find_driver_internal(dc, dev->devclass->name));
1183 return(TAILQ_FIRST(&dc->drivers));
1187 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1189 if (dev->devclass) {
1191 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1192 if (!strcmp(dev->devclass->name, dl->driver->name))
1196 return(TAILQ_NEXT(last, link));
1200 device_probe_child(device_t dev, device_t child)
1203 driverlink_t best = 0;
1205 int result, pri = 0;
1206 int hasclass = (child->devclass != 0);
1210 panic("device_probe_child: parent device has no devclass");
1212 if (child->state == DS_ALIVE)
1215 for (; dc; dc = dc->parent) {
1216 for (dl = first_matching_driver(dc, child); dl;
1217 dl = next_matching_driver(dc, child, dl)) {
1218 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1219 device_set_driver(child, dl->driver);
1221 device_set_devclass(child, dl->driver->name);
1222 result = DEVICE_PROBE(child);
1224 device_set_devclass(child, 0);
1227 * If the driver returns SUCCESS, there can be
1228 * no higher match for this device.
1237 * The driver returned an error so it
1238 * certainly doesn't match.
1241 device_set_driver(child, 0);
1246 * A priority lower than SUCCESS, remember the
1247 * best matching driver. Initialise the value
1248 * of pri for the first match.
1250 if (best == 0 || result > pri) {
1257 * If we have unambiguous match in this devclass,
1258 * don't look in the parent.
1260 if (best && pri == 0)
1265 * If we found a driver, change state and initialise the devclass.
1268 if (!child->devclass)
1269 device_set_devclass(child, best->driver->name);
1270 device_set_driver(child, best->driver);
1273 * A bit bogus. Call the probe method again to make
1274 * sure that we have the right description.
1276 DEVICE_PROBE(child);
1279 bus_data_generation_update();
1280 child->state = DS_ALIVE;
1288 device_get_parent(device_t dev)
1294 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1301 TAILQ_FOREACH(child, &dev->children, link)
1304 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1309 TAILQ_FOREACH(child, &dev->children, link) {
1310 list[count] = child;
1321 device_get_driver(device_t dev)
1323 return(dev->driver);
1327 device_get_devclass(device_t dev)
1329 return(dev->devclass);
1333 device_get_name(device_t dev)
1336 return devclass_get_name(dev->devclass);
1341 device_get_nameunit(device_t dev)
1343 return(dev->nameunit);
1347 device_get_unit(device_t dev)
1353 device_get_desc(device_t dev)
1359 device_get_flags(device_t dev)
1361 return(dev->devflags);
1365 device_print_prettyname(device_t dev)
1367 const char *name = device_get_name(dev);
1370 return kprintf("unknown: ");
1372 return kprintf("%s%d: ", name, device_get_unit(dev));
1376 device_printf(device_t dev, const char * fmt, ...)
1381 retval = device_print_prettyname(dev);
1382 __va_start(ap, fmt);
1383 retval += kvprintf(fmt, ap);
1389 device_set_desc_internal(device_t dev, const char* desc, int copy)
1391 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1392 kfree(dev->desc, M_BUS);
1393 dev->flags &= ~DF_DESCMALLOCED;
1398 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1400 strcpy(dev->desc, desc);
1401 dev->flags |= DF_DESCMALLOCED;
1404 /* Avoid a -Wcast-qual warning */
1405 dev->desc = (char *)(uintptr_t) desc;
1408 bus_data_generation_update();
1412 device_set_desc(device_t dev, const char* desc)
1414 device_set_desc_internal(dev, desc, FALSE);
1418 device_set_desc_copy(device_t dev, const char* desc)
1420 device_set_desc_internal(dev, desc, TRUE);
1424 device_set_flags(device_t dev, uint32_t flags)
1426 dev->devflags = flags;
1430 device_get_softc(device_t dev)
1436 device_set_softc(device_t dev, void *softc)
1438 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1439 kfree(dev->softc, M_BUS);
1442 dev->flags |= DF_EXTERNALSOFTC;
1444 dev->flags &= ~DF_EXTERNALSOFTC;
1448 device_set_async_attach(device_t dev, int enable)
1451 dev->flags |= DF_ASYNCPROBE;
1453 dev->flags &= ~DF_ASYNCPROBE;
1457 device_get_ivars(device_t dev)
1463 device_set_ivars(device_t dev, void * ivars)
1472 device_get_state(device_t dev)
1478 device_enable(device_t dev)
1480 dev->flags |= DF_ENABLED;
1484 device_disable(device_t dev)
1486 dev->flags &= ~DF_ENABLED;
1493 device_busy(device_t dev)
1495 if (dev->state < DS_ATTACHED)
1496 panic("device_busy: called for unattached device");
1497 if (dev->busy == 0 && dev->parent)
1498 device_busy(dev->parent);
1500 dev->state = DS_BUSY;
1507 device_unbusy(device_t dev)
1509 if (dev->state != DS_BUSY)
1510 panic("device_unbusy: called for non-busy device");
1512 if (dev->busy == 0) {
1514 device_unbusy(dev->parent);
1515 dev->state = DS_ATTACHED;
1520 device_quiet(device_t dev)
1522 dev->flags |= DF_QUIET;
1526 device_verbose(device_t dev)
1528 dev->flags &= ~DF_QUIET;
1532 device_is_quiet(device_t dev)
1534 return((dev->flags & DF_QUIET) != 0);
1538 device_is_enabled(device_t dev)
1540 return((dev->flags & DF_ENABLED) != 0);
1544 device_is_alive(device_t dev)
1546 return(dev->state >= DS_ALIVE);
1550 device_is_attached(device_t dev)
1552 return(dev->state >= DS_ATTACHED);
1556 device_set_devclass(device_t dev, const char *classname)
1563 devclass_delete_device(dev->devclass, dev);
1567 if (dev->devclass) {
1568 kprintf("device_set_devclass: device class already set\n");
1572 dc = devclass_find_internal(classname, NULL, TRUE);
1576 error = devclass_add_device(dc, dev);
1578 bus_data_generation_update();
1583 device_set_driver(device_t dev, driver_t *driver)
1585 if (dev->state >= DS_ATTACHED)
1588 if (dev->driver == driver)
1591 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1592 kfree(dev->softc, M_BUS);
1595 kobj_delete((kobj_t) dev, 0);
1596 dev->driver = driver;
1598 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1599 if (!(dev->flags & DF_EXTERNALSOFTC)) {
1600 dev->softc = kmalloc(driver->size, M_BUS,
1601 M_INTWAIT | M_ZERO);
1603 kobj_delete((kobj_t)dev, 0);
1604 kobj_init((kobj_t) dev, &null_class);
1610 kobj_init((kobj_t) dev, &null_class);
1613 bus_data_generation_update();
1618 device_probe_and_attach(device_t dev)
1620 device_t bus = dev->parent;
1623 if (dev->state >= DS_ALIVE)
1626 if ((dev->flags & DF_ENABLED) == 0) {
1628 device_print_prettyname(dev);
1629 kprintf("not probed (disabled)\n");
1634 error = device_probe_child(bus, dev);
1636 if (!(dev->flags & DF_DONENOMATCH)) {
1637 BUS_PROBE_NOMATCH(bus, dev);
1639 dev->flags |= DF_DONENOMATCH;
1645 * Output the exact device chain prior to the attach in case the
1646 * system locks up during attach, and generate the full info after
1647 * the attach so correct irq and other information is displayed.
1649 if (bootverbose && !device_is_quiet(dev)) {
1652 kprintf("%s", device_get_nameunit(dev));
1653 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1654 kprintf(".%s", device_get_nameunit(tmp));
1657 if (!device_is_quiet(dev))
1658 device_print_child(bus, dev);
1659 if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1660 kprintf("%s: probing asynchronously\n",
1661 device_get_nameunit(dev));
1662 dev->state = DS_INPROGRESS;
1663 device_attach_async(dev);
1666 error = device_doattach(dev);
1672 * Device is known to be alive, do the attach asynchronously.
1674 * The MP lock is held by all threads.
1677 device_attach_async(device_t dev)
1681 atomic_add_int(&numasyncthreads, 1);
1682 lwkt_create(device_attach_thread, dev, &td, NULL,
1683 0, 0, (dev->desc ? dev->desc : "devattach"));
1687 device_attach_thread(void *arg)
1691 (void)device_doattach(dev);
1692 atomic_subtract_int(&numasyncthreads, 1);
1693 wakeup(&numasyncthreads);
1697 * Device is known to be alive, do the attach (synchronous or asynchronous)
1700 device_doattach(device_t dev)
1702 device_t bus = dev->parent;
1703 int hasclass = (dev->devclass != 0);
1706 error = DEVICE_ATTACH(dev);
1708 dev->state = DS_ATTACHED;
1709 if (bootverbose && !device_is_quiet(dev))
1710 device_print_child(bus, dev);
1713 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1714 dev->driver->name, dev->unit, error);
1715 /* Unset the class that was set in device_probe_child */
1717 device_set_devclass(dev, 0);
1718 device_set_driver(dev, NULL);
1719 dev->state = DS_NOTPRESENT;
1725 device_detach(device_t dev)
1729 PDEBUG(("%s", DEVICENAME(dev)));
1730 if (dev->state == DS_BUSY)
1732 if (dev->state != DS_ATTACHED)
1735 if ((error = DEVICE_DETACH(dev)) != 0)
1738 device_printf(dev, "detached\n");
1740 BUS_CHILD_DETACHED(dev->parent, dev);
1742 if (!(dev->flags & DF_FIXEDCLASS))
1743 devclass_delete_device(dev->devclass, dev);
1745 dev->state = DS_NOTPRESENT;
1746 device_set_driver(dev, NULL);
1752 device_shutdown(device_t dev)
1754 if (dev->state < DS_ATTACHED)
1756 PDEBUG(("%s", DEVICENAME(dev)));
1757 return DEVICE_SHUTDOWN(dev);
1761 device_set_unit(device_t dev, int unit)
1766 dc = device_get_devclass(dev);
1767 if (unit < dc->maxunit && dc->devices[unit])
1769 err = devclass_delete_device(dc, dev);
1773 err = devclass_add_device(dc, dev);
1777 bus_data_generation_update();
1781 /*======================================*/
1783 * Access functions for device resources.
1786 /* Supplied by config(8) in ioconf.c */
1787 extern struct config_device config_devtab[];
1788 extern int devtab_count;
1790 /* Runtime version */
1791 struct config_device *devtab = config_devtab;
1794 resource_new_name(const char *name, int unit)
1796 struct config_device *new;
1798 new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1799 M_INTWAIT | M_ZERO);
1802 if (devtab && devtab_count > 0)
1803 bcopy(devtab, new, devtab_count * sizeof(*new));
1804 new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1805 if (new[devtab_count].name == NULL) {
1809 strcpy(new[devtab_count].name, name);
1810 new[devtab_count].unit = unit;
1811 new[devtab_count].resource_count = 0;
1812 new[devtab_count].resources = NULL;
1813 if (devtab && devtab != config_devtab)
1814 kfree(devtab, M_TEMP);
1816 return devtab_count++;
1820 resource_new_resname(int j, const char *resname, resource_type type)
1822 struct config_resource *new;
1825 i = devtab[j].resource_count;
1826 new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1829 if (devtab[j].resources && i > 0)
1830 bcopy(devtab[j].resources, new, i * sizeof(*new));
1831 new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1832 if (new[i].name == NULL) {
1836 strcpy(new[i].name, resname);
1838 if (devtab[j].resources)
1839 kfree(devtab[j].resources, M_TEMP);
1840 devtab[j].resources = new;
1841 devtab[j].resource_count = i + 1;
1846 resource_match_string(int i, const char *resname, const char *value)
1849 struct config_resource *res;
1851 for (j = 0, res = devtab[i].resources;
1852 j < devtab[i].resource_count; j++, res++)
1853 if (!strcmp(res->name, resname)
1854 && res->type == RES_STRING
1855 && !strcmp(res->u.stringval, value))
1861 resource_find(const char *name, int unit, const char *resname,
1862 struct config_resource **result)
1865 struct config_resource *res;
1868 * First check specific instances, then generic.
1870 for (i = 0; i < devtab_count; i++) {
1871 if (devtab[i].unit < 0)
1873 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1874 res = devtab[i].resources;
1875 for (j = 0; j < devtab[i].resource_count; j++, res++)
1876 if (!strcmp(res->name, resname)) {
1882 for (i = 0; i < devtab_count; i++) {
1883 if (devtab[i].unit >= 0)
1885 /* XXX should this `&& devtab[i].unit == unit' be here? */
1886 /* XXX if so, then the generic match does nothing */
1887 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1888 res = devtab[i].resources;
1889 for (j = 0; j < devtab[i].resource_count; j++, res++)
1890 if (!strcmp(res->name, resname)) {
1900 resource_int_value(const char *name, int unit, const char *resname, int *result)
1903 struct config_resource *res;
1905 if ((error = resource_find(name, unit, resname, &res)) != 0)
1907 if (res->type != RES_INT)
1909 *result = res->u.intval;
1914 resource_long_value(const char *name, int unit, const char *resname,
1918 struct config_resource *res;
1920 if ((error = resource_find(name, unit, resname, &res)) != 0)
1922 if (res->type != RES_LONG)
1924 *result = res->u.longval;
1929 resource_string_value(const char *name, int unit, const char *resname,
1933 struct config_resource *res;
1935 if ((error = resource_find(name, unit, resname, &res)) != 0)
1937 if (res->type != RES_STRING)
1939 *result = res->u.stringval;
1944 resource_query_string(int i, const char *resname, const char *value)
1950 for (; i < devtab_count; i++)
1951 if (resource_match_string(i, resname, value) >= 0)
1957 resource_locate(int i, const char *resname)
1963 for (; i < devtab_count; i++)
1964 if (!strcmp(devtab[i].name, resname))
1970 resource_count(void)
1972 return(devtab_count);
1976 resource_query_name(int i)
1978 return(devtab[i].name);
1982 resource_query_unit(int i)
1984 return(devtab[i].unit);
1988 resource_create(const char *name, int unit, const char *resname,
1989 resource_type type, struct config_resource **result)
1992 struct config_resource *res = NULL;
1994 for (i = 0; i < devtab_count; i++)
1995 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1996 res = devtab[i].resources;
2000 i = resource_new_name(name, unit);
2003 res = devtab[i].resources;
2005 for (j = 0; j < devtab[i].resource_count; j++, res++)
2006 if (!strcmp(res->name, resname)) {
2010 j = resource_new_resname(i, resname, type);
2013 res = &devtab[i].resources[j];
2019 resource_set_int(const char *name, int unit, const char *resname, int value)
2022 struct config_resource *res;
2024 error = resource_create(name, unit, resname, RES_INT, &res);
2027 if (res->type != RES_INT)
2029 res->u.intval = value;
2034 resource_set_long(const char *name, int unit, const char *resname, long value)
2037 struct config_resource *res;
2039 error = resource_create(name, unit, resname, RES_LONG, &res);
2042 if (res->type != RES_LONG)
2044 res->u.longval = value;
2049 resource_set_string(const char *name, int unit, const char *resname,
2053 struct config_resource *res;
2055 error = resource_create(name, unit, resname, RES_STRING, &res);
2058 if (res->type != RES_STRING)
2060 if (res->u.stringval)
2061 kfree(res->u.stringval, M_TEMP);
2062 res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2063 if (res->u.stringval == NULL)
2065 strcpy(res->u.stringval, value);
2070 resource_cfgload(void *dummy __unused)
2072 struct config_resource *res, *cfgres;
2075 char *name, *resname;
2079 int config_devtab_count;
2081 config_devtab_count = devtab_count;
2085 for (i = 0; i < config_devtab_count; i++) {
2086 name = config_devtab[i].name;
2087 unit = config_devtab[i].unit;
2089 for (j = 0; j < config_devtab[i].resource_count; j++) {
2090 cfgres = config_devtab[i].resources;
2091 resname = cfgres[j].name;
2092 type = cfgres[j].type;
2093 error = resource_create(name, unit, resname, type,
2096 kprintf("create resource %s%d: error %d\n",
2100 if (res->type != type) {
2101 kprintf("type mismatch %s%d: %d != %d\n",
2102 name, unit, res->type, type);
2107 res->u.intval = cfgres[j].u.intval;
2110 res->u.longval = cfgres[j].u.longval;
2113 if (res->u.stringval)
2114 kfree(res->u.stringval, M_TEMP);
2115 stringval = cfgres[j].u.stringval;
2116 res->u.stringval = kmalloc(strlen(stringval) + 1,
2118 if (res->u.stringval == NULL)
2120 strcpy(res->u.stringval, stringval);
2123 panic("unknown resource type %d", type);
2128 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2131 /*======================================*/
2133 * Some useful method implementations to make life easier for bus drivers.
2137 resource_list_init(struct resource_list *rl)
2143 resource_list_free(struct resource_list *rl)
2145 struct resource_list_entry *rle;
2147 while ((rle = SLIST_FIRST(rl)) != NULL) {
2149 panic("resource_list_free: resource entry is busy");
2150 SLIST_REMOVE_HEAD(rl, link);
2156 resource_list_add(struct resource_list *rl,
2158 u_long start, u_long end, u_long count)
2160 struct resource_list_entry *rle;
2162 rle = resource_list_find(rl, type, rid);
2164 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2167 panic("resource_list_add: can't record entry");
2168 SLIST_INSERT_HEAD(rl, rle, link);
2175 panic("resource_list_add: resource entry is busy");
2182 struct resource_list_entry*
2183 resource_list_find(struct resource_list *rl,
2186 struct resource_list_entry *rle;
2188 SLIST_FOREACH(rle, rl, link)
2189 if (rle->type == type && rle->rid == rid)
2195 resource_list_delete(struct resource_list *rl,
2198 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2201 if (rle->res != NULL)
2202 panic("resource_list_delete: resource has not been released");
2203 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2209 resource_list_alloc(struct resource_list *rl,
2210 device_t bus, device_t child,
2212 u_long start, u_long end,
2213 u_long count, u_int flags)
2215 struct resource_list_entry *rle = 0;
2216 int passthrough = (device_get_parent(child) != bus);
2217 int isdefault = (start == 0UL && end == ~0UL);
2220 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2222 start, end, count, flags));
2225 rle = resource_list_find(rl, type, *rid);
2228 return(0); /* no resource of that type/rid */
2231 panic("resource_list_alloc: resource entry is busy");
2235 count = max(count, rle->count);
2236 end = max(rle->end, start + count - 1);
2239 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2240 type, rid, start, end, count, flags);
2243 * Record the new range.
2246 rle->start = rman_get_start(rle->res);
2247 rle->end = rman_get_end(rle->res);
2255 resource_list_release(struct resource_list *rl,
2256 device_t bus, device_t child,
2257 int type, int rid, struct resource *res)
2259 struct resource_list_entry *rle = 0;
2260 int passthrough = (device_get_parent(child) != bus);
2264 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2268 rle = resource_list_find(rl, type, rid);
2271 panic("resource_list_release: can't find resource");
2273 panic("resource_list_release: resource entry is not busy");
2275 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2285 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2288 struct resource_list_entry *rle;
2289 int printed, retval;
2293 /* Yes, this is kinda cheating */
2294 SLIST_FOREACH(rle, rl, link) {
2295 if (rle->type == type) {
2297 retval += kprintf(" %s ", name);
2299 retval += kprintf(",");
2301 retval += kprintf(format, rle->start);
2302 if (rle->count > 1) {
2303 retval += kprintf("-");
2304 retval += kprintf(format, rle->start +
2313 * Generic driver/device identify functions. These will install a device
2314 * rendezvous point under the parent using the same name as the driver
2315 * name, which will at a later time be probed and attached.
2317 * These functions are used when the parent does not 'scan' its bus for
2318 * matching devices, or for the particular devices using these functions,
2319 * or when the device is a pseudo or synthesized device (such as can be
2320 * found under firewire and ppbus).
2323 bus_generic_identify(driver_t *driver, device_t parent)
2325 if (parent->state == DS_ATTACHED)
2327 BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2332 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2334 if (parent->state == DS_ATTACHED)
2336 BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2341 * Call DEVICE_IDENTIFY for each driver.
2344 bus_generic_probe(device_t dev)
2346 devclass_t dc = dev->devclass;
2349 TAILQ_FOREACH(dl, &dc->drivers, link) {
2350 DEVICE_IDENTIFY(dl->driver, dev);
2357 * This is an aweful hack due to the isa bus and autoconf code not
2358 * probing the ISA devices until after everything else has configured.
2359 * The ISA bus did a dummy attach long ago so we have to set it back
2360 * to an earlier state so the probe thinks its the initial probe and
2363 * XXX remove by properly defering the ISA bus scan.
2366 bus_generic_probe_hack(device_t dev)
2368 if (dev->state == DS_ATTACHED) {
2369 dev->state = DS_ALIVE;
2370 bus_generic_probe(dev);
2371 dev->state = DS_ATTACHED;
2377 bus_generic_attach(device_t dev)
2381 TAILQ_FOREACH(child, &dev->children, link) {
2382 device_probe_and_attach(child);
2389 bus_generic_detach(device_t dev)
2394 if (dev->state != DS_ATTACHED)
2397 TAILQ_FOREACH(child, &dev->children, link)
2398 if ((error = device_detach(child)) != 0)
2405 bus_generic_shutdown(device_t dev)
2409 TAILQ_FOREACH(child, &dev->children, link)
2410 device_shutdown(child);
2416 bus_generic_suspend(device_t dev)
2419 device_t child, child2;
2421 TAILQ_FOREACH(child, &dev->children, link) {
2422 error = DEVICE_SUSPEND(child);
2424 for (child2 = TAILQ_FIRST(&dev->children);
2425 child2 && child2 != child;
2426 child2 = TAILQ_NEXT(child2, link))
2427 DEVICE_RESUME(child2);
2435 bus_generic_resume(device_t dev)
2439 TAILQ_FOREACH(child, &dev->children, link)
2440 DEVICE_RESUME(child);
2441 /* if resume fails, there's nothing we can usefully do... */
2447 bus_print_child_header(device_t dev, device_t child)
2451 if (device_get_desc(child))
2452 retval += device_printf(child, "<%s>", device_get_desc(child));
2454 retval += kprintf("%s", device_get_nameunit(child));
2456 if (child->state != DS_ATTACHED)
2457 kprintf(" [tentative]");
2459 kprintf(" [attached!]");
2465 bus_print_child_footer(device_t dev, device_t child)
2467 return(kprintf(" on %s\n", device_get_nameunit(dev)));
2471 bus_generic_add_child(device_t dev, device_t child, int order,
2472 const char *name, int unit)
2475 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2477 dev = device_add_child_ordered(child, order, name, unit);
2483 bus_generic_print_child(device_t dev, device_t child)
2487 retval += bus_print_child_header(dev, child);
2488 retval += bus_print_child_footer(dev, child);
2494 bus_generic_read_ivar(device_t dev, device_t child, int index,
2500 error = BUS_READ_IVAR(dev->parent, child, index, result);
2507 bus_generic_write_ivar(device_t dev, device_t child, int index,
2513 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2520 * Resource list are used for iterations, do not recurse.
2522 struct resource_list *
2523 bus_generic_get_resource_list(device_t dev, device_t child)
2529 bus_generic_driver_added(device_t dev, driver_t *driver)
2533 DEVICE_IDENTIFY(driver, dev);
2534 TAILQ_FOREACH(child, &dev->children, link) {
2535 if (child->state == DS_NOTPRESENT)
2536 device_probe_and_attach(child);
2541 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2542 int flags, driver_intr_t *intr, void *arg,
2543 void **cookiep, lwkt_serialize_t serializer)
2545 /* Propagate up the bus hierarchy until someone handles it. */
2547 return(BUS_SETUP_INTR(dev->parent, child, irq, flags,
2548 intr, arg, cookiep, serializer));
2554 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2557 /* Propagate up the bus hierarchy until someone handles it. */
2559 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2565 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2568 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2574 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2577 BUS_ENABLE_INTR(dev->parent, child, cookie);
2581 bus_generic_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
2582 enum intr_polarity pol)
2584 /* Propagate up the bus hierarchy until someone handles it. */
2586 return(BUS_CONFIG_INTR(dev->parent, child, irq, trig, pol));
2592 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2593 u_long start, u_long end, u_long count, u_int flags)
2595 /* Propagate up the bus hierarchy until someone handles it. */
2597 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2598 start, end, count, flags));
2604 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2607 /* Propagate up the bus hierarchy until someone handles it. */
2609 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2615 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2618 /* Propagate up the bus hierarchy until someone handles it. */
2620 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2626 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2627 int rid, struct resource *r)
2629 /* Propagate up the bus hierarchy until someone handles it. */
2631 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2638 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2639 u_long *startp, u_long *countp)
2645 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2652 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2653 u_long start, u_long count)
2659 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2666 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2669 BUS_DELETE_RESOURCE(dev, child, type, rid);
2673 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2674 u_long *startp, u_long *countp)
2676 struct resource_list *rl = NULL;
2677 struct resource_list_entry *rle = NULL;
2679 rl = BUS_GET_RESOURCE_LIST(dev, child);
2683 rle = resource_list_find(rl, type, rid);
2688 *startp = rle->start;
2690 *countp = rle->count;
2696 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2697 u_long start, u_long count)
2699 struct resource_list *rl = NULL;
2701 rl = BUS_GET_RESOURCE_LIST(dev, child);
2705 resource_list_add(rl, type, rid, start, (start + count - 1), count);
2711 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2713 struct resource_list *rl = NULL;
2715 rl = BUS_GET_RESOURCE_LIST(dev, child);
2719 resource_list_delete(rl, type, rid);
2723 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2724 int rid, struct resource *r)
2726 struct resource_list *rl = NULL;
2728 rl = BUS_GET_RESOURCE_LIST(dev, child);
2732 return(resource_list_release(rl, dev, child, type, rid, r));
2736 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2737 int *rid, u_long start, u_long end, u_long count, u_int flags)
2739 struct resource_list *rl = NULL;
2741 rl = BUS_GET_RESOURCE_LIST(dev, child);
2745 return(resource_list_alloc(rl, dev, child, type, rid,
2746 start, end, count, flags));
2750 bus_generic_child_present(device_t bus, device_t child)
2752 return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2757 * Some convenience functions to make it easier for drivers to use the
2758 * resource-management functions. All these really do is hide the
2759 * indirection through the parent's method table, making for slightly
2760 * less-wordy code. In the future, it might make sense for this code
2761 * to maintain some sort of a list of resources allocated by each device.
2764 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2765 struct resource **res)
2769 for (i = 0; rs[i].type != -1; i++)
2771 for (i = 0; rs[i].type != -1; i++) {
2772 res[i] = bus_alloc_resource_any(dev,
2773 rs[i].type, &rs[i].rid, rs[i].flags);
2774 if (res[i] == NULL) {
2775 bus_release_resources(dev, rs, res);
2783 bus_release_resources(device_t dev, const struct resource_spec *rs,
2784 struct resource **res)
2788 for (i = 0; rs[i].type != -1; i++)
2789 if (res[i] != NULL) {
2790 bus_release_resource(
2791 dev, rs[i].type, rs[i].rid, res[i]);
2797 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2798 u_long count, u_int flags)
2800 if (dev->parent == 0)
2802 return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2807 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2809 if (dev->parent == 0)
2811 return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2815 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2817 if (dev->parent == 0)
2819 return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2823 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2825 if (dev->parent == 0)
2827 return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2831 bus_setup_intr(device_t dev, struct resource *r, int flags,
2832 driver_intr_t handler, void *arg,
2833 void **cookiep, lwkt_serialize_t serializer)
2835 if (dev->parent == 0)
2837 return(BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2838 cookiep, serializer));
2842 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2844 if (dev->parent == 0)
2846 return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2850 bus_enable_intr(device_t dev, void *cookie)
2853 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2857 bus_disable_intr(device_t dev, void *cookie)
2860 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2866 bus_set_resource(device_t dev, int type, int rid,
2867 u_long start, u_long count)
2869 return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2874 bus_get_resource(device_t dev, int type, int rid,
2875 u_long *startp, u_long *countp)
2877 return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2882 bus_get_resource_start(device_t dev, int type, int rid)
2884 u_long start, count;
2887 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2895 bus_get_resource_count(device_t dev, int type, int rid)
2897 u_long start, count;
2900 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2908 bus_delete_resource(device_t dev, int type, int rid)
2910 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2914 bus_child_present(device_t child)
2916 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
2920 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
2924 parent = device_get_parent(child);
2925 if (parent == NULL) {
2929 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
2933 bus_child_location_str(device_t child, char *buf, size_t buflen)
2937 parent = device_get_parent(child);
2938 if (parent == NULL) {
2942 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
2946 root_print_child(device_t dev, device_t child)
2952 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
2953 void **cookiep, lwkt_serialize_t serializer)
2956 * If an interrupt mapping gets to here something bad has happened.
2958 panic("root_setup_intr");
2962 * If we get here, assume that the device is permanant and really is
2963 * present in the system. Removable bus drivers are expected to intercept
2964 * this call long before it gets here. We return -1 so that drivers that
2965 * really care can check vs -1 or some ERRNO returned higher in the food
2969 root_child_present(device_t dev, device_t child)
2975 * XXX NOTE! other defaults may be set in bus_if.m
2977 static kobj_method_t root_methods[] = {
2978 /* Device interface */
2979 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
2980 KOBJMETHOD(device_suspend, bus_generic_suspend),
2981 KOBJMETHOD(device_resume, bus_generic_resume),
2984 KOBJMETHOD(bus_add_child, bus_generic_add_child),
2985 KOBJMETHOD(bus_print_child, root_print_child),
2986 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
2987 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
2988 KOBJMETHOD(bus_setup_intr, root_setup_intr),
2989 KOBJMETHOD(bus_child_present, root_child_present),
2994 static driver_t root_driver = {
3001 devclass_t root_devclass;
3004 root_bus_module_handler(module_t mod, int what, void* arg)
3008 TAILQ_INIT(&bus_data_devices);
3009 root_bus = make_device(NULL, "root", 0);
3010 root_bus->desc = "System root bus";
3011 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
3012 root_bus->driver = &root_driver;
3013 root_bus->state = DS_ALIVE;
3014 root_devclass = devclass_find_internal("root", NULL, FALSE);
3019 device_shutdown(root_bus);
3026 static moduledata_t root_bus_mod = {
3028 root_bus_module_handler,
3031 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
3034 root_bus_configure(void)
3042 * handle device_identify based device attachments to the root_bus
3043 * (typically nexus).
3045 bus_generic_probe(root_bus);
3048 * Probe and attach the devices under root_bus.
3050 TAILQ_FOREACH(dev, &root_bus->children, link) {
3051 device_probe_and_attach(dev);
3055 * Wait for all asynchronous attaches to complete. If we don't
3056 * our legacy ISA bus scan could steal device unit numbers or
3060 if (numasyncthreads)
3061 kprintf("Waiting for async drivers to attach\n");
3062 while (numasyncthreads > 0) {
3063 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3065 if (warncount == 0) {
3066 kprintf("Warning: Still waiting for %d "
3067 "drivers to attach\n", numasyncthreads);
3068 } else if (warncount == -30) {
3069 kprintf("Giving up on %d drivers\n", numasyncthreads);
3073 root_bus->state = DS_ATTACHED;
3077 driver_module_handler(module_t mod, int what, void *arg)
3080 struct driver_module_data *dmd;
3081 devclass_t bus_devclass;
3082 kobj_class_t driver;
3083 const char *parentname;
3085 dmd = (struct driver_module_data *)arg;
3086 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3091 if (dmd->dmd_chainevh)
3092 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3094 driver = dmd->dmd_driver;
3095 PDEBUG(("Loading module: driver %s on bus %s",
3096 DRIVERNAME(driver), dmd->dmd_busname));
3099 * If the driver has any base classes, make the
3100 * devclass inherit from the devclass of the driver's
3101 * first base class. This will allow the system to
3102 * search for drivers in both devclasses for children
3103 * of a device using this driver.
3105 if (driver->baseclasses)
3106 parentname = driver->baseclasses[0]->name;
3109 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3112 error = devclass_add_driver(bus_devclass, driver);
3118 PDEBUG(("Unloading module: driver %s from bus %s",
3119 DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3120 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3122 if (!error && dmd->dmd_chainevh)
3123 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3133 * The _short versions avoid iteration by not calling anything that prints
3134 * more than oneliners. I love oneliners.
3138 print_device_short(device_t dev, int indent)
3143 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3144 dev->unit, dev->desc,
3145 (dev->parent? "":"no "),
3146 (TAILQ_EMPTY(&dev->children)? "no ":""),
3147 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3148 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3149 (dev->flags&DF_WILDCARD? "wildcard,":""),
3150 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3151 (dev->ivars? "":"no "),
3152 (dev->softc? "":"no "),
3157 print_device(device_t dev, int indent)
3162 print_device_short(dev, indent);
3164 indentprintf(("Parent:\n"));
3165 print_device_short(dev->parent, indent+1);
3166 indentprintf(("Driver:\n"));
3167 print_driver_short(dev->driver, indent+1);
3168 indentprintf(("Devclass:\n"));
3169 print_devclass_short(dev->devclass, indent+1);
3173 * Print the device and all its children (indented).
3176 print_device_tree_short(device_t dev, int indent)
3183 print_device_short(dev, indent);
3185 TAILQ_FOREACH(child, &dev->children, link)
3186 print_device_tree_short(child, indent+1);
3190 * Print the device and all its children (indented).
3193 print_device_tree(device_t dev, int indent)
3200 print_device(dev, indent);
3202 TAILQ_FOREACH(child, &dev->children, link)
3203 print_device_tree(child, indent+1);
3207 print_driver_short(driver_t *driver, int indent)
3212 indentprintf(("driver %s: softc size = %zu\n",
3213 driver->name, driver->size));
3217 print_driver(driver_t *driver, int indent)
3222 print_driver_short(driver, indent);
3227 print_driver_list(driver_list_t drivers, int indent)
3229 driverlink_t driver;
3231 TAILQ_FOREACH(driver, &drivers, link)
3232 print_driver(driver->driver, indent);
3236 print_devclass_short(devclass_t dc, int indent)
3241 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3245 print_devclass(devclass_t dc, int indent)
3252 print_devclass_short(dc, indent);
3253 indentprintf(("Drivers:\n"));
3254 print_driver_list(dc->drivers, indent+1);
3256 indentprintf(("Devices:\n"));
3257 for (i = 0; i < dc->maxunit; i++)
3259 print_device(dc->devices[i], indent+1);
3263 print_devclass_list_short(void)
3267 kprintf("Short listing of devclasses, drivers & devices:\n");
3268 TAILQ_FOREACH(dc, &devclasses, link) {
3269 print_devclass_short(dc, 0);
3274 print_devclass_list(void)
3278 kprintf("Full listing of devclasses, drivers & devices:\n");
3279 TAILQ_FOREACH(dc, &devclasses, link) {
3280 print_devclass(dc, 0);
3287 * Check to see if a device is disabled via a disabled hint.
3290 resource_disabled(const char *name, int unit)
3294 error = resource_int_value(name, unit, "disabled", &value);
3301 * User-space access to the device tree.
3303 * We implement a small set of nodes:
3305 * hw.bus Single integer read method to obtain the
3306 * current generation count.
3307 * hw.bus.devices Reads the entire device tree in flat space.
3308 * hw.bus.rman Resource manager interface
3310 * We might like to add the ability to scan devclasses and/or drivers to
3311 * determine what else is currently loaded/available.
3315 sysctl_bus(SYSCTL_HANDLER_ARGS)
3317 struct u_businfo ubus;
3319 ubus.ub_version = BUS_USER_VERSION;
3320 ubus.ub_generation = bus_data_generation;
3322 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3324 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3325 "bus-related data");
3328 sysctl_devices(SYSCTL_HANDLER_ARGS)
3330 int *name = (int *)arg1;
3331 u_int namelen = arg2;
3334 struct u_device udev; /* XXX this is a bit big */
3340 if (bus_data_generation_check(name[0]))
3346 * Scan the list of devices, looking for the requested index.
3348 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3356 * Populate the return array.
3358 bzero(&udev, sizeof(udev));
3359 udev.dv_handle = (uintptr_t)dev;
3360 udev.dv_parent = (uintptr_t)dev->parent;
3361 if (dev->nameunit != NULL)
3362 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3363 if (dev->desc != NULL)
3364 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3365 if (dev->driver != NULL && dev->driver->name != NULL)
3366 strlcpy(udev.dv_drivername, dev->driver->name,
3367 sizeof(udev.dv_drivername));
3368 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3369 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3370 udev.dv_devflags = dev->devflags;
3371 udev.dv_flags = dev->flags;
3372 udev.dv_state = dev->state;
3373 error = SYSCTL_OUT(req, &udev, sizeof(udev));
3377 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3378 "system device tree");
3381 bus_data_generation_check(int generation)
3383 if (generation != bus_data_generation)
3386 /* XXX generate optimised lists here? */
3391 bus_data_generation_update(void)
3393 bus_data_generation++;