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 $
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/malloc.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/bus_private.h>
38 #include <sys/sysctl.h>
39 #include <sys/systm.h>
42 #include <sys/device.h>
46 #include <sys/filio.h>
47 #include <sys/event.h>
48 #include <sys/signalvar.h>
50 #include <machine/stdarg.h> /* for device_printf() */
52 #include <sys/thread2.h>
53 #include <sys/mplock2.h>
55 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
57 MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
60 #define PDEBUG(a) (kprintf("%s:%d: ", __func__, __LINE__), kprintf a, kprintf("\n"))
61 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
62 #define DRIVERNAME(d) ((d)? d->name : "no driver")
63 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
65 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to
66 * prevent syslog from deleting initial spaces
68 #define indentprintf(p) do { int iJ; kprintf("."); for (iJ=0; iJ<indent; iJ++) kprintf(" "); kprintf p ; } while(0)
70 static void print_device_short(device_t dev, int indent);
71 static void print_device(device_t dev, int indent);
72 void print_device_tree_short(device_t dev, int indent);
73 void print_device_tree(device_t dev, int indent);
74 static void print_driver_short(driver_t *driver, int indent);
75 static void print_driver(driver_t *driver, int indent);
76 static void print_driver_list(driver_list_t drivers, int indent);
77 static void print_devclass_short(devclass_t dc, int indent);
78 static void print_devclass(devclass_t dc, int indent);
79 void print_devclass_list_short(void);
80 void print_devclass_list(void);
83 /* Make the compiler ignore the function calls */
84 #define PDEBUG(a) /* nop */
85 #define DEVICENAME(d) /* nop */
86 #define DRIVERNAME(d) /* nop */
87 #define DEVCLANAME(d) /* nop */
89 #define print_device_short(d,i) /* nop */
90 #define print_device(d,i) /* nop */
91 #define print_device_tree_short(d,i) /* nop */
92 #define print_device_tree(d,i) /* nop */
93 #define print_driver_short(d,i) /* nop */
94 #define print_driver(d,i) /* nop */
95 #define print_driver_list(d,i) /* nop */
96 #define print_devclass_short(d,i) /* nop */
97 #define print_devclass(d,i) /* nop */
98 #define print_devclass_list_short() /* nop */
99 #define print_devclass_list() /* nop */
102 static void device_attach_async(device_t dev);
103 static void device_attach_thread(void *arg);
104 static int device_doattach(device_t dev);
106 static int do_async_attach = 0;
107 static int numasyncthreads;
108 TUNABLE_INT("kern.do_async_attach", &do_async_attach);
111 * /dev/devctl implementation
115 * This design allows only one reader for /dev/devctl. This is not desirable
116 * in the long run, but will get a lot of hair out of this implementation.
117 * Maybe we should make this device a clonable device.
119 * Also note: we specifically do not attach a device to the device_t tree
120 * to avoid potential chicken and egg problems. One could argue that all
121 * of this belongs to the root node. One could also further argue that the
122 * sysctl interface that we have not might more properly be an ioctl
123 * interface, but at this stage of the game, I'm not inclined to rock that
126 * I'm also not sure that the SIGIO support is done correctly or not, as
127 * I copied it from a driver that had SIGIO support that likely hasn't been
128 * tested since 3.4 or 2.2.8!
131 static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS);
132 static int devctl_disable = 0;
133 TUNABLE_INT("hw.bus.devctl_disable", &devctl_disable);
134 SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
135 sysctl_devctl_disable, "I", "devctl disable");
137 static d_open_t devopen;
138 static d_close_t devclose;
139 static d_read_t devread;
140 static d_ioctl_t devioctl;
141 static d_kqfilter_t devkqfilter;
143 static struct dev_ops devctl_ops = {
149 .d_kqfilter = devkqfilter
152 struct dev_event_info
155 TAILQ_ENTRY(dev_event_info) dei_link;
158 TAILQ_HEAD(devq, dev_event_info);
160 static struct dev_softc
167 struct proc *async_proc;
173 make_dev(&devctl_ops, 0, UID_ROOT, GID_WHEEL, 0600, "devctl");
174 lockinit(&devsoftc.lock, "dev mtx", 0, 0);
175 TAILQ_INIT(&devsoftc.devq);
179 devopen(struct dev_open_args *ap)
185 devsoftc.nonblock = 0;
186 devsoftc.async_proc = NULL;
191 devclose(struct dev_close_args *ap)
194 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
196 lockmgr(&devsoftc.lock, LK_RELEASE);
202 * The read channel for this device is used to report changes to
203 * userland in realtime. We are required to free the data as well as
204 * the n1 object because we allocate them separately. Also note that
205 * we return one record at a time. If you try to read this device a
206 * character at a time, you will lose the rest of the data. Listening
207 * programs are expected to cope.
210 devread(struct dev_read_args *ap)
212 struct uio *uio = ap->a_uio;
213 struct dev_event_info *n1;
216 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
217 while (TAILQ_EMPTY(&devsoftc.devq)) {
218 if (devsoftc.nonblock) {
219 lockmgr(&devsoftc.lock, LK_RELEASE);
222 tsleep_interlock(&devsoftc, PCATCH);
223 lockmgr(&devsoftc.lock, LK_RELEASE);
224 rv = tsleep(&devsoftc, PCATCH | PINTERLOCKED, "devctl", 0);
225 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
228 * Need to translate ERESTART to EINTR here? -- jake
230 lockmgr(&devsoftc.lock, LK_RELEASE);
234 n1 = TAILQ_FIRST(&devsoftc.devq);
235 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
236 lockmgr(&devsoftc.lock, LK_RELEASE);
237 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio);
238 kfree(n1->dei_data, M_BUS);
244 devioctl(struct dev_ioctl_args *ap)
249 if (*(int*)ap->a_data)
250 devsoftc.nonblock = 1;
252 devsoftc.nonblock = 0;
255 if (*(int*)ap->a_data)
256 devsoftc.async_proc = curproc;
258 devsoftc.async_proc = NULL;
261 /* (un)Support for other fcntl() calls. */
273 static void dev_filter_detach(struct knote *);
274 static int dev_filter_read(struct knote *, long);
276 static struct filterops dev_filtops =
277 { FILTEROP_ISFD, NULL, dev_filter_detach, dev_filter_read };
280 devkqfilter(struct dev_kqfilter_args *ap)
282 struct knote *kn = ap->a_kn;
286 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
288 switch (kn->kn_filter) {
290 kn->kn_fop = &dev_filtops;
293 ap->a_result = EOPNOTSUPP;
294 lockmgr(&devsoftc.lock, LK_RELEASE);
298 klist = &devsoftc.kq.ki_note;
299 knote_insert(klist, kn);
301 lockmgr(&devsoftc.lock, LK_RELEASE);
307 dev_filter_detach(struct knote *kn)
311 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
312 klist = &devsoftc.kq.ki_note;
313 knote_remove(klist, kn);
314 lockmgr(&devsoftc.lock, LK_RELEASE);
318 dev_filter_read(struct knote *kn, long hint)
322 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
323 if (!TAILQ_EMPTY(&devsoftc.devq))
325 lockmgr(&devsoftc.lock, LK_RELEASE);
332 * @brief Return whether the userland process is running
335 devctl_process_running(void)
337 return (devsoftc.inuse == 1);
341 * @brief Queue data to be read from the devctl device
343 * Generic interface to queue data to the devctl device. It is
344 * assumed that @p data is properly formatted. It is further assumed
345 * that @p data is allocated using the M_BUS malloc type.
348 devctl_queue_data(char *data)
350 struct dev_event_info *n1 = NULL;
353 n1 = kmalloc(sizeof(*n1), M_BUS, M_NOWAIT);
357 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
358 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link);
360 lockmgr(&devsoftc.lock, LK_RELEASE);
361 get_mplock(); /* XXX */
362 KNOTE(&devsoftc.kq.ki_note, 0);
363 rel_mplock(); /* XXX */
364 p = devsoftc.async_proc;
370 * @brief Send a 'notification' to userland, using standard ways
373 devctl_notify(const char *system, const char *subsystem, const char *type,
380 return; /* BOGUS! Must specify system. */
381 if (subsystem == NULL)
382 return; /* BOGUS! Must specify subsystem. */
384 return; /* BOGUS! Must specify type. */
385 len += strlen(" system=") + strlen(system);
386 len += strlen(" subsystem=") + strlen(subsystem);
387 len += strlen(" type=") + strlen(type);
388 /* add in the data message plus newline. */
391 len += 3; /* '!', '\n', and NUL */
392 msg = kmalloc(len, M_BUS, M_NOWAIT);
394 return; /* Drop it on the floor */
396 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n",
397 system, subsystem, type, data);
399 ksnprintf(msg, len, "!system=%s subsystem=%s type=%s\n",
400 system, subsystem, type);
401 devctl_queue_data(msg);
405 * Common routine that tries to make sending messages as easy as possible.
406 * We allocate memory for the data, copy strings into that, but do not
407 * free it unless there's an error. The dequeue part of the driver should
408 * free the data. We don't send data when the device is disabled. We do
409 * send data, even when we have no listeners, because we wish to avoid
410 * races relating to startup and restart of listening applications.
412 * devaddq is designed to string together the type of event, with the
413 * object of that event, plus the plug and play info and location info
414 * for that event. This is likely most useful for devices, but less
415 * useful for other consumers of this interface. Those should use
416 * the devctl_queue_data() interface instead.
419 devaddq(const char *type, const char *what, device_t dev)
428 data = kmalloc(1024, M_BUS, M_NOWAIT);
432 /* get the bus specific location of this device */
433 loc = kmalloc(1024, M_BUS, M_NOWAIT);
437 bus_child_location_str(dev, loc, 1024);
439 /* Get the bus specific pnp info of this device */
440 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
444 bus_child_pnpinfo_str(dev, pnp, 1024);
446 /* Get the parent of this device, or / if high enough in the tree. */
447 if (device_get_parent(dev) == NULL)
448 parstr = "."; /* Or '/' ? */
450 parstr = device_get_nameunit(device_get_parent(dev));
451 /* String it all together. */
452 ksnprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp,
456 devctl_queue_data(data);
466 * A device was added to the tree. We are called just after it successfully
467 * attaches (that is, probe and attach success for this device). No call
468 * is made if a device is merely parented into the tree. See devnomatch
469 * if probe fails. If attach fails, no notification is sent (but maybe
470 * we should have a different message for this).
473 devadded(device_t dev)
478 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
481 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
485 bus_child_pnpinfo_str(dev, pnp, 1024);
486 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
487 devaddq("+", tmp, dev);
497 * A device was removed from the tree. We are called just before this
501 devremoved(device_t dev)
506 pnp = kmalloc(1024, M_BUS, M_NOWAIT);
509 tmp = kmalloc(1024, M_BUS, M_NOWAIT);
513 bus_child_pnpinfo_str(dev, pnp, 1024);
514 ksnprintf(tmp, 1024, "%s %s", device_get_nameunit(dev), pnp);
515 devaddq("-", tmp, dev);
525 * Called when there's no match for this device. This is only called
526 * the first time that no match happens, so we don't keep getitng this
527 * message. Should that prove to be undesirable, we can change it.
528 * This is called when all drivers that can attach to a given bus
529 * decline to accept this device. Other errrors may not be detected.
532 devnomatch(device_t dev)
534 devaddq("?", "", dev);
538 sysctl_devctl_disable(SYSCTL_HANDLER_ARGS)
540 struct dev_event_info *n1;
543 dis = devctl_disable;
544 error = sysctl_handle_int(oidp, &dis, 0, req);
545 if (error || !req->newptr)
547 lockmgr(&devsoftc.lock, LK_EXCLUSIVE);
548 devctl_disable = dis;
550 while (!TAILQ_EMPTY(&devsoftc.devq)) {
551 n1 = TAILQ_FIRST(&devsoftc.devq);
552 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link);
553 kfree(n1->dei_data, M_BUS);
557 lockmgr(&devsoftc.lock, LK_RELEASE);
561 /* End of /dev/devctl code */
563 TAILQ_HEAD(,device) bus_data_devices;
564 static int bus_data_generation = 1;
566 kobj_method_t null_methods[] = {
570 DEFINE_CLASS(null, null_methods, 0);
573 * Devclass implementation
576 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
579 devclass_find_internal(const char *classname, const char *parentname,
584 PDEBUG(("looking for %s", classname));
585 if (classname == NULL)
588 TAILQ_FOREACH(dc, &devclasses, link)
589 if (!strcmp(dc->name, classname))
593 PDEBUG(("creating %s", classname));
594 dc = kmalloc(sizeof(struct devclass) + strlen(classname) + 1,
595 M_BUS, M_INTWAIT | M_ZERO);
599 dc->name = (char*) (dc + 1);
600 strcpy(dc->name, classname);
603 TAILQ_INIT(&dc->drivers);
604 TAILQ_INSERT_TAIL(&devclasses, dc, link);
606 bus_data_generation_update();
609 if (parentname && dc && !dc->parent)
610 dc->parent = devclass_find_internal(parentname, NULL, FALSE);
616 devclass_create(const char *classname)
618 return(devclass_find_internal(classname, NULL, TRUE));
622 devclass_find(const char *classname)
624 return(devclass_find_internal(classname, NULL, FALSE));
628 devclass_find_unit(const char *classname, int unit)
632 if ((dc = devclass_find(classname)) != NULL)
633 return(devclass_get_device(dc, unit));
638 devclass_add_driver(devclass_t dc, driver_t *driver)
644 PDEBUG(("%s", DRIVERNAME(driver)));
646 dl = kmalloc(sizeof *dl, M_BUS, M_INTWAIT | M_ZERO);
651 * Compile the driver's methods. Also increase the reference count
652 * so that the class doesn't get freed when the last instance
653 * goes. This means we can safely use static methods and avoids a
654 * double-free in devclass_delete_driver.
656 kobj_class_instantiate(driver);
659 * Make sure the devclass which the driver is implementing exists.
661 devclass_find_internal(driver->name, NULL, TRUE);
664 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
667 * Call BUS_DRIVER_ADDED for any existing busses in this class,
668 * but only if the bus has already been attached (otherwise we
669 * might probe too early).
671 * This is what will cause a newly loaded module to be associated
672 * with hardware. bus_generic_driver_added() is typically what ends
675 for (i = 0; i < dc->maxunit; i++) {
676 if ((dev = dc->devices[i]) != NULL) {
677 if (dev->state >= DS_ATTACHED)
678 BUS_DRIVER_ADDED(dev, driver);
682 bus_data_generation_update();
687 devclass_delete_driver(devclass_t busclass, driver_t *driver)
689 devclass_t dc = devclass_find(driver->name);
695 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
701 * Find the link structure in the bus' list of drivers.
703 TAILQ_FOREACH(dl, &busclass->drivers, link)
704 if (dl->driver == driver)
708 PDEBUG(("%s not found in %s list", driver->name, busclass->name));
713 * Disassociate from any devices. We iterate through all the
714 * devices in the devclass of the driver and detach any which are
715 * using the driver and which have a parent in the devclass which
716 * we are deleting from.
718 * Note that since a driver can be in multiple devclasses, we
719 * should not detach devices which are not children of devices in
720 * the affected devclass.
722 for (i = 0; i < dc->maxunit; i++)
723 if (dc->devices[i]) {
724 dev = dc->devices[i];
725 if (dev->driver == driver && dev->parent &&
726 dev->parent->devclass == busclass) {
727 if ((error = device_detach(dev)) != 0)
729 device_set_driver(dev, NULL);
733 TAILQ_REMOVE(&busclass->drivers, dl, link);
736 kobj_class_uninstantiate(driver);
738 bus_data_generation_update();
743 devclass_find_driver_internal(devclass_t dc, const char *classname)
747 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
749 TAILQ_FOREACH(dl, &dc->drivers, link)
750 if (!strcmp(dl->driver->name, classname))
753 PDEBUG(("not found"));
758 devclass_find_driver(devclass_t dc, const char *classname)
762 dl = devclass_find_driver_internal(dc, classname);
770 devclass_get_name(devclass_t dc)
776 devclass_get_device(devclass_t dc, int unit)
778 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
780 return(dc->devices[unit]);
784 devclass_get_softc(devclass_t dc, int unit)
788 dev = devclass_get_device(dc, unit);
792 return(device_get_softc(dev));
796 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
803 for (i = 0; i < dc->maxunit; i++)
807 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
812 for (i = 0; i < dc->maxunit; i++)
813 if (dc->devices[i]) {
814 list[count] = dc->devices[i];
825 * @brief Get a list of drivers in the devclass
827 * An array containing a list of pointers to all the drivers in the
828 * given devclass is allocated and returned in @p *listp. The number
829 * of drivers in the array is returned in @p *countp. The caller should
830 * free the array using @c free(p, M_TEMP).
832 * @param dc the devclass to examine
833 * @param listp gives location for array pointer return value
834 * @param countp gives location for number of array elements
838 * @retval ENOMEM the array allocation failed
841 devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp)
848 TAILQ_FOREACH(dl, &dc->drivers, link)
850 list = kmalloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT);
855 TAILQ_FOREACH(dl, &dc->drivers, link) {
856 list[count] = dl->driver;
866 * @brief Get the number of devices in a devclass
868 * @param dc the devclass to examine
871 devclass_get_count(devclass_t dc)
876 for (i = 0; i < dc->maxunit; i++)
883 devclass_get_maxunit(devclass_t dc)
889 devclass_set_parent(devclass_t dc, devclass_t pdc)
895 devclass_get_parent(devclass_t dc)
901 devclass_alloc_unit(devclass_t dc, int *unitp)
905 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
907 /* If we have been given a wired unit number, check for existing device */
909 if (unit >= 0 && unit < dc->maxunit &&
910 dc->devices[unit] != NULL) {
912 kprintf("%s-: %s%d exists, using next available unit number\n",
913 dc->name, dc->name, unit);
914 /* find the next available slot */
915 while (++unit < dc->maxunit && dc->devices[unit] != NULL)
919 /* Unwired device, find the next available slot for it */
921 while (unit < dc->maxunit && dc->devices[unit] != NULL)
926 * We've selected a unit beyond the length of the table, so let's
927 * extend the table to make room for all units up to and including
930 if (unit >= dc->maxunit) {
934 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
935 newlist = kmalloc(sizeof(device_t) * newsize, M_BUS,
939 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
941 kfree(dc->devices, M_BUS);
942 dc->devices = newlist;
943 dc->maxunit = newsize;
945 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
952 devclass_add_device(devclass_t dc, device_t dev)
956 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
958 buflen = strlen(dc->name) + 5;
959 dev->nameunit = kmalloc(buflen, M_BUS, M_INTWAIT | M_ZERO);
963 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
964 kfree(dev->nameunit, M_BUS);
965 dev->nameunit = NULL;
968 dc->devices[dev->unit] = dev;
970 ksnprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
976 devclass_delete_device(devclass_t dc, device_t dev)
981 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
983 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
984 panic("devclass_delete_device: inconsistent device class");
985 dc->devices[dev->unit] = NULL;
986 if (dev->flags & DF_WILDCARD)
988 dev->devclass = NULL;
989 kfree(dev->nameunit, M_BUS);
990 dev->nameunit = NULL;
996 make_device(device_t parent, const char *name, int unit)
1001 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
1004 dc = devclass_find_internal(name, NULL, TRUE);
1006 kprintf("make_device: can't find device class %s\n", name);
1012 dev = kmalloc(sizeof(struct device), M_BUS, M_INTWAIT | M_ZERO);
1016 dev->parent = parent;
1017 TAILQ_INIT(&dev->children);
1018 kobj_init((kobj_t) dev, &null_class);
1020 dev->devclass = NULL;
1022 dev->nameunit = NULL;
1026 dev->flags = DF_ENABLED;
1029 dev->flags |= DF_WILDCARD;
1031 dev->flags |= DF_FIXEDCLASS;
1032 if (devclass_add_device(dc, dev) != 0) {
1033 kobj_delete((kobj_t)dev, M_BUS);
1040 dev->state = DS_NOTPRESENT;
1042 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
1043 bus_data_generation_update();
1049 device_print_child(device_t dev, device_t child)
1053 if (device_is_alive(child))
1054 retval += BUS_PRINT_CHILD(dev, child);
1056 retval += device_printf(child, " not found\n");
1062 device_add_child(device_t dev, const char *name, int unit)
1064 return device_add_child_ordered(dev, 0, name, unit);
1068 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
1073 PDEBUG(("%s at %s with order %d as unit %d", name, DEVICENAME(dev),
1076 child = make_device(dev, name, unit);
1079 child->order = order;
1081 TAILQ_FOREACH(place, &dev->children, link)
1082 if (place->order > order)
1087 * The device 'place' is the first device whose order is
1088 * greater than the new child.
1090 TAILQ_INSERT_BEFORE(place, child, link);
1093 * The new child's order is greater or equal to the order of
1094 * any existing device. Add the child to the tail of the list.
1096 TAILQ_INSERT_TAIL(&dev->children, child, link);
1099 bus_data_generation_update();
1104 device_delete_child(device_t dev, device_t child)
1107 device_t grandchild;
1109 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
1111 /* remove children first */
1112 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
1113 error = device_delete_child(child, grandchild);
1118 if ((error = device_detach(child)) != 0)
1120 if (child->devclass)
1121 devclass_delete_device(child->devclass, child);
1122 TAILQ_REMOVE(&dev->children, child, link);
1123 TAILQ_REMOVE(&bus_data_devices, child, devlink);
1124 device_set_desc(child, NULL);
1125 kobj_delete((kobj_t)child, M_BUS);
1127 bus_data_generation_update();
1132 * @brief Find a device given a unit number
1134 * This is similar to devclass_get_devices() but only searches for
1135 * devices which have @p dev as a parent.
1137 * @param dev the parent device to search
1138 * @param unit the unit number to search for. If the unit is -1,
1139 * return the first child of @p dev which has name
1140 * @p classname (that is, the one with the lowest unit.)
1142 * @returns the device with the given unit number or @c
1143 * NULL if there is no such device
1146 device_find_child(device_t dev, const char *classname, int unit)
1151 dc = devclass_find(classname);
1156 child = devclass_get_device(dc, unit);
1157 if (child && child->parent == dev)
1160 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) {
1161 child = devclass_get_device(dc, unit);
1162 if (child && child->parent == dev)
1170 first_matching_driver(devclass_t dc, device_t dev)
1173 return(devclass_find_driver_internal(dc, dev->devclass->name));
1175 return(TAILQ_FIRST(&dc->drivers));
1179 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
1181 if (dev->devclass) {
1183 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
1184 if (!strcmp(dev->devclass->name, dl->driver->name))
1188 return(TAILQ_NEXT(last, link));
1192 device_probe_child(device_t dev, device_t child)
1195 driverlink_t best = 0;
1197 int result, pri = 0;
1198 int hasclass = (child->devclass != 0);
1202 panic("device_probe_child: parent device has no devclass");
1204 if (child->state == DS_ALIVE)
1207 for (; dc; dc = dc->parent) {
1208 for (dl = first_matching_driver(dc, child); dl;
1209 dl = next_matching_driver(dc, child, dl)) {
1210 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
1211 device_set_driver(child, dl->driver);
1213 device_set_devclass(child, dl->driver->name);
1214 result = DEVICE_PROBE(child);
1216 device_set_devclass(child, 0);
1219 * If the driver returns SUCCESS, there can be
1220 * no higher match for this device.
1229 * The driver returned an error so it
1230 * certainly doesn't match.
1233 device_set_driver(child, 0);
1238 * A priority lower than SUCCESS, remember the
1239 * best matching driver. Initialise the value
1240 * of pri for the first match.
1242 if (best == 0 || result > pri) {
1249 * If we have unambiguous match in this devclass,
1250 * don't look in the parent.
1252 if (best && pri == 0)
1257 * If we found a driver, change state and initialise the devclass.
1260 if (!child->devclass)
1261 device_set_devclass(child, best->driver->name);
1262 device_set_driver(child, best->driver);
1265 * A bit bogus. Call the probe method again to make
1266 * sure that we have the right description.
1268 DEVICE_PROBE(child);
1271 bus_data_generation_update();
1272 child->state = DS_ALIVE;
1280 device_get_parent(device_t dev)
1286 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
1293 TAILQ_FOREACH(child, &dev->children, link)
1296 list = kmalloc(count * sizeof(device_t), M_TEMP, M_INTWAIT | M_ZERO);
1301 TAILQ_FOREACH(child, &dev->children, link) {
1302 list[count] = child;
1313 device_get_driver(device_t dev)
1315 return(dev->driver);
1319 device_get_devclass(device_t dev)
1321 return(dev->devclass);
1325 device_get_name(device_t dev)
1328 return devclass_get_name(dev->devclass);
1333 device_get_nameunit(device_t dev)
1335 return(dev->nameunit);
1339 device_get_unit(device_t dev)
1345 device_get_desc(device_t dev)
1351 device_get_flags(device_t dev)
1353 return(dev->devflags);
1357 device_print_prettyname(device_t dev)
1359 const char *name = device_get_name(dev);
1362 return kprintf("unknown: ");
1364 return kprintf("%s%d: ", name, device_get_unit(dev));
1368 device_printf(device_t dev, const char * fmt, ...)
1373 retval = device_print_prettyname(dev);
1374 __va_start(ap, fmt);
1375 retval += kvprintf(fmt, ap);
1381 device_set_desc_internal(device_t dev, const char* desc, int copy)
1383 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
1384 kfree(dev->desc, M_BUS);
1385 dev->flags &= ~DF_DESCMALLOCED;
1390 dev->desc = kmalloc(strlen(desc) + 1, M_BUS, M_INTWAIT);
1392 strcpy(dev->desc, desc);
1393 dev->flags |= DF_DESCMALLOCED;
1396 /* Avoid a -Wcast-qual warning */
1397 dev->desc = (char *)(uintptr_t) desc;
1400 bus_data_generation_update();
1404 device_set_desc(device_t dev, const char* desc)
1406 device_set_desc_internal(dev, desc, FALSE);
1410 device_set_desc_copy(device_t dev, const char* desc)
1412 device_set_desc_internal(dev, desc, TRUE);
1416 device_set_flags(device_t dev, uint32_t flags)
1418 dev->devflags = flags;
1422 device_get_softc(device_t dev)
1428 device_set_softc(device_t dev, void *softc)
1430 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
1431 kfree(dev->softc, M_BUS);
1434 dev->flags |= DF_EXTERNALSOFTC;
1436 dev->flags &= ~DF_EXTERNALSOFTC;
1440 device_set_async_attach(device_t dev, int enable)
1443 dev->flags |= DF_ASYNCPROBE;
1445 dev->flags &= ~DF_ASYNCPROBE;
1449 device_get_ivars(device_t dev)
1455 device_set_ivars(device_t dev, void * ivars)
1464 device_get_state(device_t dev)
1470 device_enable(device_t dev)
1472 dev->flags |= DF_ENABLED;
1476 device_disable(device_t dev)
1478 dev->flags &= ~DF_ENABLED;
1485 device_busy(device_t dev)
1487 if (dev->state < DS_ATTACHED)
1488 panic("device_busy: called for unattached device");
1489 if (dev->busy == 0 && dev->parent)
1490 device_busy(dev->parent);
1492 dev->state = DS_BUSY;
1499 device_unbusy(device_t dev)
1501 if (dev->state != DS_BUSY)
1502 panic("device_unbusy: called for non-busy device");
1504 if (dev->busy == 0) {
1506 device_unbusy(dev->parent);
1507 dev->state = DS_ATTACHED;
1512 device_quiet(device_t dev)
1514 dev->flags |= DF_QUIET;
1518 device_verbose(device_t dev)
1520 dev->flags &= ~DF_QUIET;
1524 device_is_quiet(device_t dev)
1526 return((dev->flags & DF_QUIET) != 0);
1530 device_is_enabled(device_t dev)
1532 return((dev->flags & DF_ENABLED) != 0);
1536 device_is_alive(device_t dev)
1538 return(dev->state >= DS_ALIVE);
1542 device_is_attached(device_t dev)
1544 return(dev->state >= DS_ATTACHED);
1548 device_set_devclass(device_t dev, const char *classname)
1555 devclass_delete_device(dev->devclass, dev);
1559 if (dev->devclass) {
1560 kprintf("device_set_devclass: device class already set\n");
1564 dc = devclass_find_internal(classname, NULL, TRUE);
1568 error = devclass_add_device(dc, dev);
1570 bus_data_generation_update();
1575 device_set_driver(device_t dev, driver_t *driver)
1577 if (dev->state >= DS_ATTACHED)
1580 if (dev->driver == driver)
1583 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
1584 kfree(dev->softc, M_BUS);
1587 kobj_delete((kobj_t) dev, 0);
1588 dev->driver = driver;
1590 kobj_init((kobj_t) dev, (kobj_class_t) driver);
1591 if (!(dev->flags & DF_EXTERNALSOFTC)) {
1592 dev->softc = kmalloc(driver->size, M_BUS,
1593 M_INTWAIT | M_ZERO);
1595 kobj_delete((kobj_t)dev, 0);
1596 kobj_init((kobj_t) dev, &null_class);
1602 kobj_init((kobj_t) dev, &null_class);
1605 bus_data_generation_update();
1610 device_probe_and_attach(device_t dev)
1612 device_t bus = dev->parent;
1615 if (dev->state >= DS_ALIVE)
1618 if ((dev->flags & DF_ENABLED) == 0) {
1620 device_print_prettyname(dev);
1621 kprintf("not probed (disabled)\n");
1626 error = device_probe_child(bus, dev);
1628 if (!(dev->flags & DF_DONENOMATCH)) {
1629 BUS_PROBE_NOMATCH(bus, dev);
1631 dev->flags |= DF_DONENOMATCH;
1637 * Output the exact device chain prior to the attach in case the
1638 * system locks up during attach, and generate the full info after
1639 * the attach so correct irq and other information is displayed.
1641 if (bootverbose && !device_is_quiet(dev)) {
1644 kprintf("%s", device_get_nameunit(dev));
1645 for (tmp = dev->parent; tmp; tmp = tmp->parent)
1646 kprintf(".%s", device_get_nameunit(tmp));
1649 if (!device_is_quiet(dev))
1650 device_print_child(bus, dev);
1651 if ((dev->flags & DF_ASYNCPROBE) && do_async_attach) {
1652 kprintf("%s: probing asynchronously\n",
1653 device_get_nameunit(dev));
1654 dev->state = DS_INPROGRESS;
1655 device_attach_async(dev);
1658 error = device_doattach(dev);
1664 * Device is known to be alive, do the attach asynchronously.
1665 * However, serialize the attaches with the mp lock.
1668 device_attach_async(device_t dev)
1672 atomic_add_int(&numasyncthreads, 1);
1673 lwkt_create(device_attach_thread, dev, &td, NULL,
1674 0, 0, (dev->desc ? dev->desc : "devattach"));
1678 device_attach_thread(void *arg)
1682 get_mplock(); /* XXX replace with devattach_token later */
1683 (void)device_doattach(dev);
1684 atomic_subtract_int(&numasyncthreads, 1);
1685 wakeup(&numasyncthreads);
1686 rel_mplock(); /* XXX replace with devattach_token later */
1690 * Device is known to be alive, do the attach (synchronous or asynchronous)
1693 device_doattach(device_t dev)
1695 device_t bus = dev->parent;
1696 int hasclass = (dev->devclass != 0);
1699 error = DEVICE_ATTACH(dev);
1701 dev->state = DS_ATTACHED;
1702 if (bootverbose && !device_is_quiet(dev))
1703 device_print_child(bus, dev);
1706 kprintf("device_probe_and_attach: %s%d attach returned %d\n",
1707 dev->driver->name, dev->unit, error);
1708 /* Unset the class that was set in device_probe_child */
1710 device_set_devclass(dev, 0);
1711 device_set_driver(dev, NULL);
1712 dev->state = DS_NOTPRESENT;
1718 device_detach(device_t dev)
1722 PDEBUG(("%s", DEVICENAME(dev)));
1723 if (dev->state == DS_BUSY)
1725 if (dev->state != DS_ATTACHED)
1728 if ((error = DEVICE_DETACH(dev)) != 0)
1731 device_printf(dev, "detached\n");
1733 BUS_CHILD_DETACHED(dev->parent, dev);
1735 if (!(dev->flags & DF_FIXEDCLASS))
1736 devclass_delete_device(dev->devclass, dev);
1738 dev->state = DS_NOTPRESENT;
1739 device_set_driver(dev, NULL);
1745 device_shutdown(device_t dev)
1747 if (dev->state < DS_ATTACHED)
1749 PDEBUG(("%s", DEVICENAME(dev)));
1750 return DEVICE_SHUTDOWN(dev);
1754 device_set_unit(device_t dev, int unit)
1759 dc = device_get_devclass(dev);
1760 if (unit < dc->maxunit && dc->devices[unit])
1762 err = devclass_delete_device(dc, dev);
1766 err = devclass_add_device(dc, dev);
1770 bus_data_generation_update();
1774 /*======================================*/
1776 * Access functions for device resources.
1779 /* Supplied by config(8) in ioconf.c */
1780 extern struct config_device config_devtab[];
1781 extern int devtab_count;
1783 /* Runtime version */
1784 struct config_device *devtab = config_devtab;
1787 resource_new_name(const char *name, int unit)
1789 struct config_device *new;
1791 new = kmalloc((devtab_count + 1) * sizeof(*new), M_TEMP,
1792 M_INTWAIT | M_ZERO);
1795 if (devtab && devtab_count > 0)
1796 bcopy(devtab, new, devtab_count * sizeof(*new));
1797 new[devtab_count].name = kmalloc(strlen(name) + 1, M_TEMP, M_INTWAIT);
1798 if (new[devtab_count].name == NULL) {
1802 strcpy(new[devtab_count].name, name);
1803 new[devtab_count].unit = unit;
1804 new[devtab_count].resource_count = 0;
1805 new[devtab_count].resources = NULL;
1806 if (devtab && devtab != config_devtab)
1807 kfree(devtab, M_TEMP);
1809 return devtab_count++;
1813 resource_new_resname(int j, const char *resname, resource_type type)
1815 struct config_resource *new;
1818 i = devtab[j].resource_count;
1819 new = kmalloc((i + 1) * sizeof(*new), M_TEMP, M_INTWAIT | M_ZERO);
1822 if (devtab[j].resources && i > 0)
1823 bcopy(devtab[j].resources, new, i * sizeof(*new));
1824 new[i].name = kmalloc(strlen(resname) + 1, M_TEMP, M_INTWAIT);
1825 if (new[i].name == NULL) {
1829 strcpy(new[i].name, resname);
1831 if (devtab[j].resources)
1832 kfree(devtab[j].resources, M_TEMP);
1833 devtab[j].resources = new;
1834 devtab[j].resource_count = i + 1;
1839 resource_match_string(int i, const char *resname, const char *value)
1842 struct config_resource *res;
1844 for (j = 0, res = devtab[i].resources;
1845 j < devtab[i].resource_count; j++, res++)
1846 if (!strcmp(res->name, resname)
1847 && res->type == RES_STRING
1848 && !strcmp(res->u.stringval, value))
1854 resource_find(const char *name, int unit, const char *resname,
1855 struct config_resource **result)
1858 struct config_resource *res;
1861 * First check specific instances, then generic.
1863 for (i = 0; i < devtab_count; i++) {
1864 if (devtab[i].unit < 0)
1866 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1867 res = devtab[i].resources;
1868 for (j = 0; j < devtab[i].resource_count; j++, res++)
1869 if (!strcmp(res->name, resname)) {
1875 for (i = 0; i < devtab_count; i++) {
1876 if (devtab[i].unit >= 0)
1878 /* XXX should this `&& devtab[i].unit == unit' be here? */
1879 /* XXX if so, then the generic match does nothing */
1880 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1881 res = devtab[i].resources;
1882 for (j = 0; j < devtab[i].resource_count; j++, res++)
1883 if (!strcmp(res->name, resname)) {
1893 resource_int_value(const char *name, int unit, const char *resname, int *result)
1896 struct config_resource *res;
1898 if ((error = resource_find(name, unit, resname, &res)) != 0)
1900 if (res->type != RES_INT)
1902 *result = res->u.intval;
1907 resource_long_value(const char *name, int unit, const char *resname,
1911 struct config_resource *res;
1913 if ((error = resource_find(name, unit, resname, &res)) != 0)
1915 if (res->type != RES_LONG)
1917 *result = res->u.longval;
1922 resource_string_value(const char *name, int unit, const char *resname,
1926 struct config_resource *res;
1928 if ((error = resource_find(name, unit, resname, &res)) != 0)
1930 if (res->type != RES_STRING)
1932 *result = res->u.stringval;
1937 resource_query_string(int i, const char *resname, const char *value)
1943 for (; i < devtab_count; i++)
1944 if (resource_match_string(i, resname, value) >= 0)
1950 resource_locate(int i, const char *resname)
1956 for (; i < devtab_count; i++)
1957 if (!strcmp(devtab[i].name, resname))
1963 resource_count(void)
1965 return(devtab_count);
1969 resource_query_name(int i)
1971 return(devtab[i].name);
1975 resource_query_unit(int i)
1977 return(devtab[i].unit);
1981 resource_create(const char *name, int unit, const char *resname,
1982 resource_type type, struct config_resource **result)
1985 struct config_resource *res = NULL;
1987 for (i = 0; i < devtab_count; i++)
1988 if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
1989 res = devtab[i].resources;
1993 i = resource_new_name(name, unit);
1996 res = devtab[i].resources;
1998 for (j = 0; j < devtab[i].resource_count; j++, res++)
1999 if (!strcmp(res->name, resname)) {
2003 j = resource_new_resname(i, resname, type);
2006 res = &devtab[i].resources[j];
2012 resource_set_int(const char *name, int unit, const char *resname, int value)
2015 struct config_resource *res;
2017 error = resource_create(name, unit, resname, RES_INT, &res);
2020 if (res->type != RES_INT)
2022 res->u.intval = value;
2027 resource_set_long(const char *name, int unit, const char *resname, long value)
2030 struct config_resource *res;
2032 error = resource_create(name, unit, resname, RES_LONG, &res);
2035 if (res->type != RES_LONG)
2037 res->u.longval = value;
2042 resource_set_string(const char *name, int unit, const char *resname,
2046 struct config_resource *res;
2048 error = resource_create(name, unit, resname, RES_STRING, &res);
2051 if (res->type != RES_STRING)
2053 if (res->u.stringval)
2054 kfree(res->u.stringval, M_TEMP);
2055 res->u.stringval = kmalloc(strlen(value) + 1, M_TEMP, M_INTWAIT);
2056 if (res->u.stringval == NULL)
2058 strcpy(res->u.stringval, value);
2063 resource_cfgload(void *dummy __unused)
2065 struct config_resource *res, *cfgres;
2068 char *name, *resname;
2072 int config_devtab_count;
2074 config_devtab_count = devtab_count;
2078 for (i = 0; i < config_devtab_count; i++) {
2079 name = config_devtab[i].name;
2080 unit = config_devtab[i].unit;
2082 for (j = 0; j < config_devtab[i].resource_count; j++) {
2083 cfgres = config_devtab[i].resources;
2084 resname = cfgres[j].name;
2085 type = cfgres[j].type;
2086 error = resource_create(name, unit, resname, type,
2089 kprintf("create resource %s%d: error %d\n",
2093 if (res->type != type) {
2094 kprintf("type mismatch %s%d: %d != %d\n",
2095 name, unit, res->type, type);
2100 res->u.intval = cfgres[j].u.intval;
2103 res->u.longval = cfgres[j].u.longval;
2106 if (res->u.stringval)
2107 kfree(res->u.stringval, M_TEMP);
2108 stringval = cfgres[j].u.stringval;
2109 res->u.stringval = kmalloc(strlen(stringval) + 1,
2111 if (res->u.stringval == NULL)
2113 strcpy(res->u.stringval, stringval);
2116 panic("unknown resource type %d", type);
2121 SYSINIT(cfgload, SI_BOOT1_POST, SI_ORDER_ANY + 50, resource_cfgload, 0)
2124 /*======================================*/
2126 * Some useful method implementations to make life easier for bus drivers.
2130 resource_list_init(struct resource_list *rl)
2136 resource_list_free(struct resource_list *rl)
2138 struct resource_list_entry *rle;
2140 while ((rle = SLIST_FIRST(rl)) != NULL) {
2142 panic("resource_list_free: resource entry is busy");
2143 SLIST_REMOVE_HEAD(rl, link);
2149 resource_list_add(struct resource_list *rl,
2151 u_long start, u_long end, u_long count)
2153 struct resource_list_entry *rle;
2155 rle = resource_list_find(rl, type, rid);
2157 rle = kmalloc(sizeof(struct resource_list_entry), M_BUS,
2160 panic("resource_list_add: can't record entry");
2161 SLIST_INSERT_HEAD(rl, rle, link);
2168 panic("resource_list_add: resource entry is busy");
2175 struct resource_list_entry*
2176 resource_list_find(struct resource_list *rl,
2179 struct resource_list_entry *rle;
2181 SLIST_FOREACH(rle, rl, link)
2182 if (rle->type == type && rle->rid == rid)
2188 resource_list_delete(struct resource_list *rl,
2191 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
2194 if (rle->res != NULL)
2195 panic("resource_list_delete: resource has not been released");
2196 SLIST_REMOVE(rl, rle, resource_list_entry, link);
2202 resource_list_alloc(struct resource_list *rl,
2203 device_t bus, device_t child,
2205 u_long start, u_long end,
2206 u_long count, u_int flags)
2208 struct resource_list_entry *rle = 0;
2209 int passthrough = (device_get_parent(child) != bus);
2210 int isdefault = (start == 0UL && end == ~0UL);
2213 return(BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2215 start, end, count, flags));
2218 rle = resource_list_find(rl, type, *rid);
2221 return(0); /* no resource of that type/rid */
2224 panic("resource_list_alloc: resource entry is busy");
2228 count = max(count, rle->count);
2229 end = max(rle->end, start + count - 1);
2232 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
2233 type, rid, start, end, count, flags);
2236 * Record the new range.
2239 rle->start = rman_get_start(rle->res);
2240 rle->end = rman_get_end(rle->res);
2248 resource_list_release(struct resource_list *rl,
2249 device_t bus, device_t child,
2250 int type, int rid, struct resource *res)
2252 struct resource_list_entry *rle = 0;
2253 int passthrough = (device_get_parent(child) != bus);
2257 return(BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2261 rle = resource_list_find(rl, type, rid);
2264 panic("resource_list_release: can't find resource");
2266 panic("resource_list_release: resource entry is not busy");
2268 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
2278 resource_list_print_type(struct resource_list *rl, const char *name, int type,
2281 struct resource_list_entry *rle;
2282 int printed, retval;
2286 /* Yes, this is kinda cheating */
2287 SLIST_FOREACH(rle, rl, link) {
2288 if (rle->type == type) {
2290 retval += kprintf(" %s ", name);
2292 retval += kprintf(",");
2294 retval += kprintf(format, rle->start);
2295 if (rle->count > 1) {
2296 retval += kprintf("-");
2297 retval += kprintf(format, rle->start +
2306 * Generic driver/device identify functions. These will install a device
2307 * rendezvous point under the parent using the same name as the driver
2308 * name, which will at a later time be probed and attached.
2310 * These functions are used when the parent does not 'scan' its bus for
2311 * matching devices, or for the particular devices using these functions,
2312 * or when the device is a pseudo or synthesized device (such as can be
2313 * found under firewire and ppbus).
2316 bus_generic_identify(driver_t *driver, device_t parent)
2318 if (parent->state == DS_ATTACHED)
2320 BUS_ADD_CHILD(parent, parent, 0, driver->name, -1);
2325 bus_generic_identify_sameunit(driver_t *driver, device_t parent)
2327 if (parent->state == DS_ATTACHED)
2329 BUS_ADD_CHILD(parent, parent, 0, driver->name, device_get_unit(parent));
2334 * Call DEVICE_IDENTIFY for each driver.
2337 bus_generic_probe(device_t dev)
2339 devclass_t dc = dev->devclass;
2342 TAILQ_FOREACH(dl, &dc->drivers, link) {
2343 DEVICE_IDENTIFY(dl->driver, dev);
2350 * This is an aweful hack due to the isa bus and autoconf code not
2351 * probing the ISA devices until after everything else has configured.
2352 * The ISA bus did a dummy attach long ago so we have to set it back
2353 * to an earlier state so the probe thinks its the initial probe and
2356 * XXX remove by properly defering the ISA bus scan.
2359 bus_generic_probe_hack(device_t dev)
2361 if (dev->state == DS_ATTACHED) {
2362 dev->state = DS_ALIVE;
2363 bus_generic_probe(dev);
2364 dev->state = DS_ATTACHED;
2370 bus_generic_attach(device_t dev)
2374 TAILQ_FOREACH(child, &dev->children, link) {
2375 device_probe_and_attach(child);
2382 bus_generic_detach(device_t dev)
2387 if (dev->state != DS_ATTACHED)
2390 TAILQ_FOREACH(child, &dev->children, link)
2391 if ((error = device_detach(child)) != 0)
2398 bus_generic_shutdown(device_t dev)
2402 TAILQ_FOREACH(child, &dev->children, link)
2403 device_shutdown(child);
2409 bus_generic_suspend(device_t dev)
2412 device_t child, child2;
2414 TAILQ_FOREACH(child, &dev->children, link) {
2415 error = DEVICE_SUSPEND(child);
2417 for (child2 = TAILQ_FIRST(&dev->children);
2418 child2 && child2 != child;
2419 child2 = TAILQ_NEXT(child2, link))
2420 DEVICE_RESUME(child2);
2428 bus_generic_resume(device_t dev)
2432 TAILQ_FOREACH(child, &dev->children, link)
2433 DEVICE_RESUME(child);
2434 /* if resume fails, there's nothing we can usefully do... */
2440 bus_print_child_header(device_t dev, device_t child)
2444 if (device_get_desc(child))
2445 retval += device_printf(child, "<%s>", device_get_desc(child));
2447 retval += kprintf("%s", device_get_nameunit(child));
2449 if (child->state != DS_ATTACHED)
2450 kprintf(" [tentative]");
2452 kprintf(" [attached!]");
2458 bus_print_child_footer(device_t dev, device_t child)
2460 return(kprintf(" on %s\n", device_get_nameunit(dev)));
2464 bus_generic_add_child(device_t dev, device_t child, int order,
2465 const char *name, int unit)
2468 dev = BUS_ADD_CHILD(dev->parent, child, order, name, unit);
2470 dev = device_add_child_ordered(child, order, name, unit);
2476 bus_generic_print_child(device_t dev, device_t child)
2480 retval += bus_print_child_header(dev, child);
2481 retval += bus_print_child_footer(dev, child);
2487 bus_generic_read_ivar(device_t dev, device_t child, int index,
2493 error = BUS_READ_IVAR(dev->parent, child, index, result);
2500 bus_generic_write_ivar(device_t dev, device_t child, int index,
2506 error = BUS_WRITE_IVAR(dev->parent, child, index, value);
2513 * Resource list are used for iterations, do not recurse.
2515 struct resource_list *
2516 bus_generic_get_resource_list(device_t dev, device_t child)
2522 bus_generic_driver_added(device_t dev, driver_t *driver)
2526 DEVICE_IDENTIFY(driver, dev);
2527 TAILQ_FOREACH(child, &dev->children, link) {
2528 if (child->state == DS_NOTPRESENT)
2529 device_probe_and_attach(child);
2534 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
2535 int flags, driver_intr_t *intr, void *arg,
2536 void **cookiep, lwkt_serialize_t serializer)
2538 /* Propagate up the bus hierarchy until someone handles it. */
2540 return(BUS_SETUP_INTR(dev->parent, child, irq, flags,
2541 intr, arg, cookiep, serializer));
2547 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
2550 /* Propagate up the bus hierarchy until someone handles it. */
2552 return(BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
2558 bus_generic_disable_intr(device_t dev, device_t child, void *cookie)
2561 return(BUS_DISABLE_INTR(dev->parent, child, cookie));
2567 bus_generic_enable_intr(device_t dev, device_t child, void *cookie)
2570 BUS_ENABLE_INTR(dev->parent, child, cookie);
2574 bus_generic_config_intr(device_t dev, device_t child, int irq, enum intr_trigger trig,
2575 enum intr_polarity pol)
2577 /* Propagate up the bus hierarchy until someone handles it. */
2579 return(BUS_CONFIG_INTR(dev->parent, child, irq, trig, pol));
2585 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
2586 u_long start, u_long end, u_long count, u_int flags)
2588 /* Propagate up the bus hierarchy until someone handles it. */
2590 return(BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
2591 start, end, count, flags));
2597 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
2600 /* Propagate up the bus hierarchy until someone handles it. */
2602 return(BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, r));
2608 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
2611 /* Propagate up the bus hierarchy until someone handles it. */
2613 return(BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, r));
2619 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
2620 int rid, struct resource *r)
2622 /* Propagate up the bus hierarchy until someone handles it. */
2624 return(BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
2631 bus_generic_get_resource(device_t dev, device_t child, int type, int rid,
2632 u_long *startp, u_long *countp)
2638 error = BUS_GET_RESOURCE(dev->parent, child, type, rid,
2645 bus_generic_set_resource(device_t dev, device_t child, int type, int rid,
2646 u_long start, u_long count)
2652 error = BUS_SET_RESOURCE(dev->parent, child, type, rid,
2659 bus_generic_delete_resource(device_t dev, device_t child, int type, int rid)
2662 BUS_DELETE_RESOURCE(dev, child, type, rid);
2666 bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid,
2667 u_long *startp, u_long *countp)
2669 struct resource_list *rl = NULL;
2670 struct resource_list_entry *rle = NULL;
2672 rl = BUS_GET_RESOURCE_LIST(dev, child);
2676 rle = resource_list_find(rl, type, rid);
2681 *startp = rle->start;
2683 *countp = rle->count;
2689 bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid,
2690 u_long start, u_long count)
2692 struct resource_list *rl = NULL;
2694 rl = BUS_GET_RESOURCE_LIST(dev, child);
2698 resource_list_add(rl, type, rid, start, (start + count - 1), count);
2704 bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid)
2706 struct resource_list *rl = NULL;
2708 rl = BUS_GET_RESOURCE_LIST(dev, child);
2712 resource_list_delete(rl, type, rid);
2716 bus_generic_rl_release_resource(device_t dev, device_t child, int type,
2717 int rid, struct resource *r)
2719 struct resource_list *rl = NULL;
2721 rl = BUS_GET_RESOURCE_LIST(dev, child);
2725 return(resource_list_release(rl, dev, child, type, rid, r));
2729 bus_generic_rl_alloc_resource(device_t dev, device_t child, int type,
2730 int *rid, u_long start, u_long end, u_long count, u_int flags)
2732 struct resource_list *rl = NULL;
2734 rl = BUS_GET_RESOURCE_LIST(dev, child);
2738 return(resource_list_alloc(rl, dev, child, type, rid,
2739 start, end, count, flags));
2743 bus_generic_child_present(device_t bus, device_t child)
2745 return(BUS_CHILD_PRESENT(device_get_parent(bus), bus));
2750 * Some convenience functions to make it easier for drivers to use the
2751 * resource-management functions. All these really do is hide the
2752 * indirection through the parent's method table, making for slightly
2753 * less-wordy code. In the future, it might make sense for this code
2754 * to maintain some sort of a list of resources allocated by each device.
2757 bus_alloc_resources(device_t dev, struct resource_spec *rs,
2758 struct resource **res)
2762 for (i = 0; rs[i].type != -1; i++)
2764 for (i = 0; rs[i].type != -1; i++) {
2765 res[i] = bus_alloc_resource_any(dev,
2766 rs[i].type, &rs[i].rid, rs[i].flags);
2767 if (res[i] == NULL) {
2768 bus_release_resources(dev, rs, res);
2776 bus_release_resources(device_t dev, const struct resource_spec *rs,
2777 struct resource **res)
2781 for (i = 0; rs[i].type != -1; i++)
2782 if (res[i] != NULL) {
2783 bus_release_resource(
2784 dev, rs[i].type, rs[i].rid, res[i]);
2790 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
2791 u_long count, u_int flags)
2793 if (dev->parent == 0)
2795 return(BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
2800 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
2802 if (dev->parent == 0)
2804 return(BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2808 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
2810 if (dev->parent == 0)
2812 return(BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
2816 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
2818 if (dev->parent == 0)
2820 return(BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
2824 bus_setup_intr(device_t dev, struct resource *r, int flags,
2825 driver_intr_t handler, void *arg,
2826 void **cookiep, lwkt_serialize_t serializer)
2828 if (dev->parent == 0)
2830 return(BUS_SETUP_INTR(dev->parent, dev, r, flags, handler, arg,
2831 cookiep, serializer));
2835 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
2837 if (dev->parent == 0)
2839 return(BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
2843 bus_enable_intr(device_t dev, void *cookie)
2846 BUS_ENABLE_INTR(dev->parent, dev, cookie);
2850 bus_disable_intr(device_t dev, void *cookie)
2853 return(BUS_DISABLE_INTR(dev->parent, dev, cookie));
2859 bus_set_resource(device_t dev, int type, int rid,
2860 u_long start, u_long count)
2862 return(BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
2867 bus_get_resource(device_t dev, int type, int rid,
2868 u_long *startp, u_long *countp)
2870 return(BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2875 bus_get_resource_start(device_t dev, int type, int rid)
2877 u_long start, count;
2880 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2888 bus_get_resource_count(device_t dev, int type, int rid)
2890 u_long start, count;
2893 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
2901 bus_delete_resource(device_t dev, int type, int rid)
2903 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
2907 bus_child_present(device_t child)
2909 return (BUS_CHILD_PRESENT(device_get_parent(child), child));
2913 bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen)
2917 parent = device_get_parent(child);
2918 if (parent == NULL) {
2922 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen));
2926 bus_child_location_str(device_t child, char *buf, size_t buflen)
2930 parent = device_get_parent(child);
2931 if (parent == NULL) {
2935 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen));
2939 root_print_child(device_t dev, device_t child)
2945 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
2946 void **cookiep, lwkt_serialize_t serializer)
2949 * If an interrupt mapping gets to here something bad has happened.
2951 panic("root_setup_intr");
2955 * If we get here, assume that the device is permanant and really is
2956 * present in the system. Removable bus drivers are expected to intercept
2957 * this call long before it gets here. We return -1 so that drivers that
2958 * really care can check vs -1 or some ERRNO returned higher in the food
2962 root_child_present(device_t dev, device_t child)
2968 * XXX NOTE! other defaults may be set in bus_if.m
2970 static kobj_method_t root_methods[] = {
2971 /* Device interface */
2972 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
2973 KOBJMETHOD(device_suspend, bus_generic_suspend),
2974 KOBJMETHOD(device_resume, bus_generic_resume),
2977 KOBJMETHOD(bus_add_child, bus_generic_add_child),
2978 KOBJMETHOD(bus_print_child, root_print_child),
2979 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
2980 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
2981 KOBJMETHOD(bus_setup_intr, root_setup_intr),
2982 KOBJMETHOD(bus_child_present, root_child_present),
2987 static driver_t root_driver = {
2994 devclass_t root_devclass;
2997 root_bus_module_handler(module_t mod, int what, void* arg)
3001 TAILQ_INIT(&bus_data_devices);
3002 root_bus = make_device(NULL, "root", 0);
3003 root_bus->desc = "System root bus";
3004 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
3005 root_bus->driver = &root_driver;
3006 root_bus->state = DS_ALIVE;
3007 root_devclass = devclass_find_internal("root", NULL, FALSE);
3012 device_shutdown(root_bus);
3019 static moduledata_t root_bus_mod = {
3021 root_bus_module_handler,
3024 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
3027 root_bus_configure(void)
3035 * handle device_identify based device attachments to the root_bus
3036 * (typically nexus).
3038 bus_generic_probe(root_bus);
3041 * Probe and attach the devices under root_bus.
3043 TAILQ_FOREACH(dev, &root_bus->children, link) {
3044 device_probe_and_attach(dev);
3048 * Wait for all asynchronous attaches to complete. If we don't
3049 * our legacy ISA bus scan could steal device unit numbers or
3053 if (numasyncthreads)
3054 kprintf("Waiting for async drivers to attach\n");
3055 while (numasyncthreads > 0) {
3056 if (tsleep(&numasyncthreads, 0, "rootbus", hz) == EWOULDBLOCK)
3058 if (warncount == 0) {
3059 kprintf("Warning: Still waiting for %d "
3060 "drivers to attach\n", numasyncthreads);
3061 } else if (warncount == -30) {
3062 kprintf("Giving up on %d drivers\n", numasyncthreads);
3066 root_bus->state = DS_ATTACHED;
3070 driver_module_handler(module_t mod, int what, void *arg)
3073 struct driver_module_data *dmd;
3074 devclass_t bus_devclass;
3075 kobj_class_t driver;
3076 const char *parentname;
3078 dmd = (struct driver_module_data *)arg;
3079 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE);
3084 if (dmd->dmd_chainevh)
3085 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3087 driver = dmd->dmd_driver;
3088 PDEBUG(("Loading module: driver %s on bus %s",
3089 DRIVERNAME(driver), dmd->dmd_busname));
3092 * If the driver has any base classes, make the
3093 * devclass inherit from the devclass of the driver's
3094 * first base class. This will allow the system to
3095 * search for drivers in both devclasses for children
3096 * of a device using this driver.
3098 if (driver->baseclasses)
3099 parentname = driver->baseclasses[0]->name;
3102 *dmd->dmd_devclass = devclass_find_internal(driver->name,
3105 error = devclass_add_driver(bus_devclass, driver);
3111 PDEBUG(("Unloading module: driver %s from bus %s",
3112 DRIVERNAME(dmd->dmd_driver), dmd->dmd_busname));
3113 error = devclass_delete_driver(bus_devclass, dmd->dmd_driver);
3115 if (!error && dmd->dmd_chainevh)
3116 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
3126 * The _short versions avoid iteration by not calling anything that prints
3127 * more than oneliners. I love oneliners.
3131 print_device_short(device_t dev, int indent)
3136 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
3137 dev->unit, dev->desc,
3138 (dev->parent? "":"no "),
3139 (TAILQ_EMPTY(&dev->children)? "no ":""),
3140 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
3141 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
3142 (dev->flags&DF_WILDCARD? "wildcard,":""),
3143 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
3144 (dev->ivars? "":"no "),
3145 (dev->softc? "":"no "),
3150 print_device(device_t dev, int indent)
3155 print_device_short(dev, indent);
3157 indentprintf(("Parent:\n"));
3158 print_device_short(dev->parent, indent+1);
3159 indentprintf(("Driver:\n"));
3160 print_driver_short(dev->driver, indent+1);
3161 indentprintf(("Devclass:\n"));
3162 print_devclass_short(dev->devclass, indent+1);
3166 * Print the device and all its children (indented).
3169 print_device_tree_short(device_t dev, int indent)
3176 print_device_short(dev, indent);
3178 TAILQ_FOREACH(child, &dev->children, link)
3179 print_device_tree_short(child, indent+1);
3183 * Print the device and all its children (indented).
3186 print_device_tree(device_t dev, int indent)
3193 print_device(dev, indent);
3195 TAILQ_FOREACH(child, &dev->children, link)
3196 print_device_tree(child, indent+1);
3200 print_driver_short(driver_t *driver, int indent)
3205 indentprintf(("driver %s: softc size = %zu\n",
3206 driver->name, driver->size));
3210 print_driver(driver_t *driver, int indent)
3215 print_driver_short(driver, indent);
3220 print_driver_list(driver_list_t drivers, int indent)
3222 driverlink_t driver;
3224 TAILQ_FOREACH(driver, &drivers, link)
3225 print_driver(driver->driver, indent);
3229 print_devclass_short(devclass_t dc, int indent)
3234 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
3238 print_devclass(devclass_t dc, int indent)
3245 print_devclass_short(dc, indent);
3246 indentprintf(("Drivers:\n"));
3247 print_driver_list(dc->drivers, indent+1);
3249 indentprintf(("Devices:\n"));
3250 for (i = 0; i < dc->maxunit; i++)
3252 print_device(dc->devices[i], indent+1);
3256 print_devclass_list_short(void)
3260 kprintf("Short listing of devclasses, drivers & devices:\n");
3261 TAILQ_FOREACH(dc, &devclasses, link) {
3262 print_devclass_short(dc, 0);
3267 print_devclass_list(void)
3271 kprintf("Full listing of devclasses, drivers & devices:\n");
3272 TAILQ_FOREACH(dc, &devclasses, link) {
3273 print_devclass(dc, 0);
3280 * Check to see if a device is disabled via a disabled hint.
3283 resource_disabled(const char *name, int unit)
3287 error = resource_int_value(name, unit, "disabled", &value);
3294 * User-space access to the device tree.
3296 * We implement a small set of nodes:
3298 * hw.bus Single integer read method to obtain the
3299 * current generation count.
3300 * hw.bus.devices Reads the entire device tree in flat space.
3301 * hw.bus.rman Resource manager interface
3303 * We might like to add the ability to scan devclasses and/or drivers to
3304 * determine what else is currently loaded/available.
3308 sysctl_bus(SYSCTL_HANDLER_ARGS)
3310 struct u_businfo ubus;
3312 ubus.ub_version = BUS_USER_VERSION;
3313 ubus.ub_generation = bus_data_generation;
3315 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
3317 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
3318 "bus-related data");
3321 sysctl_devices(SYSCTL_HANDLER_ARGS)
3323 int *name = (int *)arg1;
3324 u_int namelen = arg2;
3327 struct u_device udev; /* XXX this is a bit big */
3333 if (bus_data_generation_check(name[0]))
3339 * Scan the list of devices, looking for the requested index.
3341 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
3349 * Populate the return array.
3351 bzero(&udev, sizeof(udev));
3352 udev.dv_handle = (uintptr_t)dev;
3353 udev.dv_parent = (uintptr_t)dev->parent;
3354 if (dev->nameunit != NULL)
3355 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name));
3356 if (dev->desc != NULL)
3357 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc));
3358 if (dev->driver != NULL && dev->driver->name != NULL)
3359 strlcpy(udev.dv_drivername, dev->driver->name,
3360 sizeof(udev.dv_drivername));
3361 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo));
3362 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location));
3363 udev.dv_devflags = dev->devflags;
3364 udev.dv_flags = dev->flags;
3365 udev.dv_state = dev->state;
3366 error = SYSCTL_OUT(req, &udev, sizeof(udev));
3370 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
3371 "system device tree");
3374 bus_data_generation_check(int generation)
3376 if (generation != bus_data_generation)
3379 /* XXX generate optimised lists here? */
3384 bus_data_generation_update(void)
3386 bus_data_generation++;
3390 intr_str_polarity(enum intr_polarity pola)
3393 case INTR_POLARITY_LOW:
3396 case INTR_POLARITY_HIGH:
3399 case INTR_POLARITY_CONFORM:
3406 intr_str_trigger(enum intr_trigger trig)
3409 case INTR_TRIGGER_EDGE:
3412 case INTR_TRIGGER_LEVEL:
3415 case INTR_TRIGGER_CONFORM: