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
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>
40 #include <machine/bus.h>
42 #include <machine/stdarg.h> /* for device_printf() */
44 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
48 static int bus_debug = 1;
49 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RW, &bus_debug, 0,
52 #define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a, printf("\n");}
53 #define DEVICENAME(d) ((d)? device_get_name(d): "no device")
54 #define DRIVERNAME(d) ((d)? d->name : "no driver")
55 #define DEVCLANAME(d) ((d)? d->name : "no devclass")
57 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to
58 * prevent syslog from deleting initial spaces
60 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0)
62 static void print_device_short(device_t dev, int indent);
63 static void print_device(device_t dev, int indent);
64 void print_device_tree_short(device_t dev, int indent);
65 void print_device_tree(device_t dev, int indent);
66 static void print_driver_short(driver_t *driver, int indent);
67 static void print_driver(driver_t *driver, int indent);
68 static void print_driver_list(driver_list_t drivers, int indent);
69 static void print_devclass_short(devclass_t dc, int indent);
70 static void print_devclass(devclass_t dc, int indent);
71 void print_devclass_list_short(void);
72 void print_devclass_list(void);
75 /* Make the compiler ignore the function calls */
76 #define PDEBUG(a) /* nop */
77 #define DEVICENAME(d) /* nop */
78 #define DRIVERNAME(d) /* nop */
79 #define DEVCLANAME(d) /* nop */
81 #define print_device_short(d,i) /* nop */
82 #define print_device(d,i) /* nop */
83 #define print_device_tree_short(d,i) /* nop */
84 #define print_device_tree(d,i) /* nop */
85 #define print_driver_short(d,i) /* nop */
86 #define print_driver(d,i) /* nop */
87 #define print_driver_list(d,i) /* nop */
88 #define print_devclass_short(d,i) /* nop */
89 #define print_devclass(d,i) /* nop */
90 #define print_devclass_list_short() /* nop */
91 #define print_devclass_list() /* nop */
94 TAILQ_HEAD(,device) bus_data_devices;
95 static int bus_data_generation = 1;
97 kobj_method_t null_methods[] = {
101 DEFINE_CLASS(null, null_methods, 0);
104 * Devclass implementation
107 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);
110 devclass_find_internal(const char *classname, int create)
114 PDEBUG(("looking for %s", classname));
118 TAILQ_FOREACH(dc, &devclasses, link) {
119 if (!strcmp(dc->name, classname))
123 PDEBUG(("%s not found%s", classname, (create? ", creating": "")));
125 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
126 M_BUS, M_NOWAIT|M_ZERO);
129 dc->name = (char*) (dc + 1);
130 strcpy(dc->name, classname);
131 TAILQ_INIT(&dc->drivers);
132 TAILQ_INSERT_TAIL(&devclasses, dc, link);
134 bus_data_generation_update();
141 devclass_create(const char *classname)
143 return (devclass_find_internal(classname, TRUE));
147 devclass_find(const char *classname)
149 return (devclass_find_internal(classname, FALSE));
153 devclass_add_driver(devclass_t dc, driver_t *driver)
158 PDEBUG(("%s", DRIVERNAME(driver)));
160 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO);
165 * Compile the driver's methods. Also increase the reference count
166 * so that the class doesn't get freed when the last instance
167 * goes. This means we can safely use static methods and avoids a
168 * double-free in devclass_delete_driver.
170 kobj_class_compile((kobj_class_t) driver);
173 * Make sure the devclass which the driver is implementing exists.
175 devclass_find_internal(driver->name, TRUE);
178 TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
182 * Call BUS_DRIVER_ADDED for any existing busses in this class.
184 for (i = 0; i < dc->maxunit; i++)
186 BUS_DRIVER_ADDED(dc->devices[i], driver);
188 bus_data_generation_update();
193 devclass_delete_driver(devclass_t busclass, driver_t *driver)
195 devclass_t dc = devclass_find(driver->name);
201 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));
207 * Find the link structure in the bus' list of drivers.
209 TAILQ_FOREACH(dl, &busclass->drivers, link) {
210 if (dl->driver == driver)
215 PDEBUG(("%s not found in %s list", driver->name,
221 * Disassociate from any devices. We iterate through all the
222 * devices in the devclass of the driver and detach any which are
223 * using the driver and which have a parent in the devclass which
224 * we are deleting from.
226 * Note that since a driver can be in multiple devclasses, we
227 * should not detach devices which are not children of devices in
228 * the affected devclass.
230 for (i = 0; i < dc->maxunit; i++) {
231 if (dc->devices[i]) {
232 dev = dc->devices[i];
233 if (dev->driver == driver && dev->parent &&
234 dev->parent->devclass == busclass) {
235 if ((error = device_detach(dev)) != 0)
237 device_set_driver(dev, NULL);
242 TAILQ_REMOVE(&busclass->drivers, dl, link);
246 if (driver->refs == 0)
247 kobj_class_free((kobj_class_t) driver);
249 bus_data_generation_update();
254 devclass_find_driver_internal(devclass_t dc, const char *classname)
258 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));
260 TAILQ_FOREACH(dl, &dc->drivers, link) {
261 if (!strcmp(dl->driver->name, classname))
265 PDEBUG(("not found"));
270 devclass_find_driver(devclass_t dc, const char *classname)
274 dl = devclass_find_driver_internal(dc, classname);
281 devclass_get_name(devclass_t dc)
287 devclass_get_device(devclass_t dc, int unit)
289 if (dc == NULL || unit < 0 || unit >= dc->maxunit)
291 return (dc->devices[unit]);
295 devclass_get_softc(devclass_t dc, int unit)
299 dev = devclass_get_device(dc, unit);
303 return (device_get_softc(dev));
307 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
314 for (i = 0; i < dc->maxunit; i++)
318 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
323 for (i = 0; i < dc->maxunit; i++) {
324 if (dc->devices[i]) {
325 list[count] = dc->devices[i];
337 devclass_get_maxunit(devclass_t dc)
339 return (dc->maxunit);
343 devclass_find_free_unit(devclass_t dc, int unit)
347 while (unit < dc->maxunit && dc->devices[unit] != NULL)
353 devclass_alloc_unit(devclass_t dc, int *unitp)
357 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));
359 /* If we were given a wired unit number, check for existing device */
362 if (unit >= 0 && unit < dc->maxunit &&
363 dc->devices[unit] != NULL) {
364 printf("%s: %s%d already exists; skipping it\n",
365 dc->name, dc->name, *unitp);
369 /* Unwired device, find the next available slot for it */
371 while (unit < dc->maxunit && dc->devices[unit] != NULL)
376 * We've selected a unit beyond the length of the table, so let's
377 * extend the table to make room for all units up to and including
380 if (unit >= dc->maxunit) {
384 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t));
385 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
388 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
389 bzero(newlist + dc->maxunit,
390 sizeof(device_t) * (newsize - dc->maxunit));
392 free(dc->devices, M_BUS);
393 dc->devices = newlist;
394 dc->maxunit = newsize;
396 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));
403 devclass_add_device(devclass_t dc, device_t dev)
407 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
409 buflen = strlen(dc->name) + 5;
410 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO);
414 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
415 free(dev->nameunit, M_BUS);
416 dev->nameunit = NULL;
419 dc->devices[dev->unit] = dev;
421 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);
427 devclass_delete_device(devclass_t dc, device_t dev)
432 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));
434 if (dev->devclass != dc || dc->devices[dev->unit] != dev)
435 panic("devclass_delete_device: inconsistent device class");
436 dc->devices[dev->unit] = NULL;
437 if (dev->flags & DF_WILDCARD)
439 dev->devclass = NULL;
440 free(dev->nameunit, M_BUS);
441 dev->nameunit = NULL;
447 make_device(device_t parent, const char *name, int unit)
452 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));
455 dc = devclass_find_internal(name, TRUE);
457 printf("make_device: can't find device class %s\n",
465 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
469 dev->parent = parent;
470 TAILQ_INIT(&dev->children);
471 kobj_init((kobj_t) dev, &null_class);
473 dev->devclass = NULL;
475 dev->nameunit = NULL;
479 dev->flags = DF_ENABLED;
482 dev->flags |= DF_WILDCARD;
484 dev->flags |= DF_FIXEDCLASS;
485 if (devclass_add_device(dc, dev)) {
486 kobj_delete((kobj_t) dev, M_BUS);
493 dev->state = DS_NOTPRESENT;
495 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink);
496 bus_data_generation_update();
502 device_print_child(device_t dev, device_t child)
506 if (device_is_alive(child))
507 retval += BUS_PRINT_CHILD(dev, child);
509 retval += device_printf(child, " not found\n");
515 device_add_child(device_t dev, const char *name, int unit)
517 return (device_add_child_ordered(dev, 0, name, unit));
521 device_add_child_ordered(device_t dev, int order, const char *name, int unit)
526 PDEBUG(("%s at %s with order %d as unit %d",
527 name, DEVICENAME(dev), order, unit));
529 child = make_device(dev, name, unit);
532 child->order = order;
534 TAILQ_FOREACH(place, &dev->children, link) {
535 if (place->order > order)
541 * The device 'place' is the first device whose order is
542 * greater than the new child.
544 TAILQ_INSERT_BEFORE(place, child, link);
547 * The new child's order is greater or equal to the order of
548 * any existing device. Add the child to the tail of the list.
550 TAILQ_INSERT_TAIL(&dev->children, child, link);
553 bus_data_generation_update();
558 device_delete_child(device_t dev, device_t child)
563 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));
565 /* remove children first */
566 while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
567 error = device_delete_child(child, grandchild);
572 if ((error = device_detach(child)) != 0)
575 devclass_delete_device(child->devclass, child);
576 TAILQ_REMOVE(&dev->children, child, link);
577 TAILQ_REMOVE(&bus_data_devices, child, devlink);
578 device_set_desc(child, NULL);
581 bus_data_generation_update();
586 * Find only devices attached to this bus.
589 device_find_child(device_t dev, const char *classname, int unit)
594 dc = devclass_find(classname);
598 child = devclass_get_device(dc, unit);
599 if (child && child->parent == dev)
605 first_matching_driver(devclass_t dc, device_t dev)
608 return (devclass_find_driver_internal(dc, dev->devclass->name));
609 return (TAILQ_FIRST(&dc->drivers));
613 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
617 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
618 if (!strcmp(dev->devclass->name, dl->driver->name))
622 return (TAILQ_NEXT(last, link));
626 device_probe_child(device_t dev, device_t child)
629 driverlink_t best = 0;
632 int hasclass = (child->devclass != 0);
636 panic("device_probe_child: parent device has no devclass");
638 if (child->state == DS_ALIVE)
641 for (dl = first_matching_driver(dc, child);
643 dl = next_matching_driver(dc, child, dl)) {
644 PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
645 device_set_driver(child, dl->driver);
647 device_set_devclass(child, dl->driver->name);
648 result = DEVICE_PROBE(child);
650 device_set_devclass(child, 0);
653 * If the driver returns SUCCESS, there can be no higher match
663 * The driver returned an error so it certainly doesn't match.
666 device_set_driver(child, 0);
671 * A priority lower than SUCCESS, remember the best matching
672 * driver. Initialise the value of pri for the first match.
674 if (best == 0 || result > pri) {
682 * If we found a driver, change state and initialise the devclass.
685 if (!child->devclass)
686 device_set_devclass(child, best->driver->name);
687 device_set_driver(child, best->driver);
690 * A bit bogus. Call the probe method again to make
691 * sure that we have the right description.
695 child->state = DS_ALIVE;
697 bus_data_generation_update();
705 device_get_parent(device_t dev)
707 return (dev->parent);
711 device_get_children(device_t dev, device_t **devlistp, int *devcountp)
718 TAILQ_FOREACH(child, &dev->children, link) {
722 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO);
727 TAILQ_FOREACH(child, &dev->children, link) {
739 device_get_driver(device_t dev)
741 return (dev->driver);
745 device_get_devclass(device_t dev)
747 return (dev->devclass);
751 device_get_name(device_t dev)
754 return (devclass_get_name(dev->devclass));
759 device_get_nameunit(device_t dev)
761 return (dev->nameunit);
765 device_get_unit(device_t dev)
771 device_get_desc(device_t dev)
777 device_get_flags(device_t dev)
779 return (dev->devflags);
783 device_print_prettyname(device_t dev)
785 const char *name = device_get_name(dev);
788 return (printf("unknown: "));
789 return (printf("%s%d: ", name, device_get_unit(dev)));
793 device_printf(device_t dev, const char * fmt, ...)
798 retval = device_print_prettyname(dev);
800 retval += vprintf(fmt, ap);
806 device_set_desc_internal(device_t dev, const char* desc, int copy)
808 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
809 free(dev->desc, M_BUS);
810 dev->flags &= ~DF_DESCMALLOCED;
815 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
817 strcpy(dev->desc, desc);
818 dev->flags |= DF_DESCMALLOCED;
821 /* Avoid a -Wcast-qual warning */
822 dev->desc = (char *)(uintptr_t) desc;
825 bus_data_generation_update();
829 device_set_desc(device_t dev, const char* desc)
831 device_set_desc_internal(dev, desc, FALSE);
835 device_set_desc_copy(device_t dev, const char* desc)
837 device_set_desc_internal(dev, desc, TRUE);
841 device_set_flags(device_t dev, u_int32_t flags)
843 dev->devflags = flags;
847 device_get_softc(device_t dev)
853 device_set_softc(device_t dev, void *softc)
855 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC))
856 free(dev->softc, M_BUS);
859 dev->flags |= DF_EXTERNALSOFTC;
861 dev->flags &= ~DF_EXTERNALSOFTC;
865 device_get_ivars(device_t dev)
871 device_set_ivars(device_t dev, void * ivars)
882 device_get_state(device_t dev)
888 device_enable(device_t dev)
890 dev->flags |= DF_ENABLED;
894 device_disable(device_t dev)
896 dev->flags &= ~DF_ENABLED;
900 device_busy(device_t dev)
902 if (dev->state < DS_ATTACHED)
903 panic("device_busy: called for unattached device");
904 if (dev->busy == 0 && dev->parent)
905 device_busy(dev->parent);
907 dev->state = DS_BUSY;
911 device_unbusy(device_t dev)
913 if (dev->state != DS_BUSY)
914 panic("device_unbusy: called for non-busy device");
916 if (dev->busy == 0) {
918 device_unbusy(dev->parent);
919 dev->state = DS_ATTACHED;
924 device_quiet(device_t dev)
926 dev->flags |= DF_QUIET;
930 device_verbose(device_t dev)
932 dev->flags &= ~DF_QUIET;
936 device_is_quiet(device_t dev)
938 return ((dev->flags & DF_QUIET) != 0);
942 device_is_enabled(device_t dev)
944 return ((dev->flags & DF_ENABLED) != 0);
948 device_is_alive(device_t dev)
950 return (dev->state >= DS_ALIVE);
954 device_set_devclass(device_t dev, const char *classname)
961 devclass_delete_device(dev->devclass, dev);
966 printf("device_set_devclass: device class already set\n");
970 dc = devclass_find_internal(classname, TRUE);
974 error = devclass_add_device(dc, dev);
976 bus_data_generation_update();
981 device_set_driver(device_t dev, driver_t *driver)
983 if (dev->state >= DS_ATTACHED)
986 if (dev->driver == driver)
989 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) {
990 free(dev->softc, M_BUS);
993 kobj_delete((kobj_t) dev, 0);
994 dev->driver = driver;
996 kobj_init((kobj_t) dev, (kobj_class_t) driver);
997 if (!(dev->flags & DF_EXTERNALSOFTC)) {
998 dev->softc = malloc(driver->size, M_BUS,
1001 kobj_init((kobj_t) dev, &null_class);
1007 kobj_init((kobj_t) dev, &null_class);
1010 bus_data_generation_update();
1015 device_probe_and_attach(device_t dev)
1017 device_t bus = dev->parent;
1019 int hasclass = (dev->devclass != 0);
1021 if (dev->state >= DS_ALIVE)
1024 if (dev->flags & DF_ENABLED) {
1025 error = device_probe_child(bus, dev);
1027 if (!device_is_quiet(dev))
1028 device_print_child(bus, dev);
1029 error = DEVICE_ATTACH(dev);
1031 dev->state = DS_ATTACHED;
1033 printf("device_probe_and_attach: %s%d attach returned %d\n",
1034 dev->driver->name, dev->unit, error);
1035 /* Unset the class; set in device_probe_child */
1037 device_set_devclass(dev, 0);
1038 device_set_driver(dev, NULL);
1039 dev->state = DS_NOTPRESENT;
1042 if (!(dev->flags & DF_DONENOMATCH)) {
1043 BUS_PROBE_NOMATCH(bus, dev);
1044 dev->flags |= DF_DONENOMATCH;
1049 device_print_prettyname(dev);
1050 printf("not probed (disabled)\n");
1058 device_detach(device_t dev)
1062 PDEBUG(("%s", DEVICENAME(dev)));
1063 if (dev->state == DS_BUSY)
1065 if (dev->state != DS_ATTACHED)
1068 if ((error = DEVICE_DETACH(dev)) != 0)
1070 device_printf(dev, "detached\n");
1072 BUS_CHILD_DETACHED(dev->parent, dev);
1074 if (!(dev->flags & DF_FIXEDCLASS))
1075 devclass_delete_device(dev->devclass, dev);
1077 dev->state = DS_NOTPRESENT;
1078 device_set_driver(dev, NULL);
1084 device_shutdown(device_t dev)
1086 if (dev->state < DS_ATTACHED)
1088 return (DEVICE_SHUTDOWN(dev));
1092 device_set_unit(device_t dev, int unit)
1097 dc = device_get_devclass(dev);
1098 if (unit < dc->maxunit && dc->devices[unit])
1100 err = devclass_delete_device(dc, dev);
1104 err = devclass_add_device(dc, dev);
1108 bus_data_generation_update();
1112 /*======================================*/
1114 * Some useful method implementations to make life easier for bus drivers.
1118 resource_list_init(struct resource_list *rl)
1124 resource_list_free(struct resource_list *rl)
1126 struct resource_list_entry *rle;
1128 while ((rle = SLIST_FIRST(rl)) != NULL) {
1130 panic("resource_list_free: resource entry is busy");
1131 SLIST_REMOVE_HEAD(rl, link);
1137 resource_list_add(struct resource_list *rl, int type, int rid,
1138 u_long start, u_long end, u_long count)
1140 struct resource_list_entry *rle;
1142 rle = resource_list_find(rl, type, rid);
1144 rle = malloc(sizeof(struct resource_list_entry), M_BUS,
1147 panic("resource_list_add: can't record entry");
1148 SLIST_INSERT_HEAD(rl, rle, link);
1155 panic("resource_list_add: resource entry is busy");
1162 struct resource_list_entry *
1163 resource_list_find(struct resource_list *rl, int type, int rid)
1165 struct resource_list_entry *rle;
1167 SLIST_FOREACH(rle, rl, link) {
1168 if (rle->type == type && rle->rid == rid)
1175 resource_list_delete(struct resource_list *rl, int type, int rid)
1177 struct resource_list_entry *rle = resource_list_find(rl, type, rid);
1180 if (rle->res != NULL)
1181 panic("resource_list_delete: resource has not been released");
1182 SLIST_REMOVE(rl, rle, resource_list_entry, link);
1188 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child,
1189 int type, int *rid, u_long start, u_long end, u_long count, u_int flags)
1191 struct resource_list_entry *rle = 0;
1192 int passthrough = (device_get_parent(child) != bus);
1193 int isdefault = (start == 0UL && end == ~0UL);
1196 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
1197 type, rid, start, end, count, flags));
1200 rle = resource_list_find(rl, type, *rid);
1203 return (NULL); /* no resource of that type/rid */
1206 panic("resource_list_alloc: resource entry is busy");
1210 count = ulmax(count, rle->count);
1211 end = ulmax(rle->end, start + count - 1);
1214 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
1215 type, rid, start, end, count, flags);
1218 * Record the new range.
1221 rle->start = rman_get_start(rle->res);
1222 rle->end = rman_get_end(rle->res);
1230 resource_list_release(struct resource_list *rl, device_t bus, device_t child,
1231 int type, int rid, struct resource *res)
1233 struct resource_list_entry *rle = 0;
1234 int passthrough = (device_get_parent(child) != bus);
1238 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
1242 rle = resource_list_find(rl, type, rid);
1245 panic("resource_list_release: can't find resource");
1247 panic("resource_list_release: resource entry is not busy");
1249 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
1259 resource_list_print_type(struct resource_list *rl, const char *name, int type,
1262 struct resource_list_entry *rle;
1263 int printed, retval;
1267 /* Yes, this is kinda cheating */
1268 SLIST_FOREACH(rle, rl, link) {
1269 if (rle->type == type) {
1271 retval += printf(" %s ", name);
1273 retval += printf(",");
1275 retval += printf(format, rle->start);
1276 if (rle->count > 1) {
1277 retval += printf("-");
1278 retval += printf(format, rle->start +
1287 * Call DEVICE_IDENTIFY for each driver.
1290 bus_generic_probe(device_t dev)
1292 devclass_t dc = dev->devclass;
1295 TAILQ_FOREACH(dl, &dc->drivers, link) {
1296 DEVICE_IDENTIFY(dl->driver, dev);
1303 bus_generic_attach(device_t dev)
1307 TAILQ_FOREACH(child, &dev->children, link) {
1308 device_probe_and_attach(child);
1315 bus_generic_detach(device_t dev)
1320 if (dev->state != DS_ATTACHED)
1323 TAILQ_FOREACH(child, &dev->children, link) {
1324 if ((error = device_detach(child)) != 0)
1332 bus_generic_shutdown(device_t dev)
1336 TAILQ_FOREACH(child, &dev->children, link) {
1337 device_shutdown(child);
1344 bus_generic_suspend(device_t dev)
1347 device_t child, child2;
1349 TAILQ_FOREACH(child, &dev->children, link) {
1350 error = DEVICE_SUSPEND(child);
1352 for (child2 = TAILQ_FIRST(&dev->children);
1353 child2 && child2 != child;
1354 child2 = TAILQ_NEXT(child2, link))
1355 DEVICE_RESUME(child2);
1363 bus_generic_resume(device_t dev)
1367 TAILQ_FOREACH(child, &dev->children, link) {
1368 DEVICE_RESUME(child);
1369 /* if resume fails, there's nothing we can usefully do... */
1375 bus_print_child_header (device_t dev, device_t child)
1379 if (device_get_desc(child)) {
1380 retval += device_printf(child, "<%s>", device_get_desc(child));
1382 retval += printf("%s", device_get_nameunit(child));
1389 bus_print_child_footer (device_t dev, device_t child)
1391 return (printf(" on %s\n", device_get_nameunit(dev)));
1395 bus_generic_print_child(device_t dev, device_t child)
1399 retval += bus_print_child_header(dev, child);
1400 retval += bus_print_child_footer(dev, child);
1406 bus_generic_read_ivar(device_t dev, device_t child, int index,
1413 bus_generic_write_ivar(device_t dev, device_t child, int index,
1419 struct resource_list *
1420 bus_generic_get_resource_list (device_t dev, device_t child)
1426 bus_generic_driver_added(device_t dev, driver_t *driver)
1430 DEVICE_IDENTIFY(driver, dev);
1431 TAILQ_FOREACH(child, &dev->children, link) {
1432 if (child->state == DS_NOTPRESENT)
1433 device_probe_and_attach(child);
1438 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq,
1439 int flags, driver_intr_t *intr, void *arg, void **cookiep)
1441 /* Propagate up the bus hierarchy until someone handles it. */
1443 return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
1444 intr, arg, cookiep));
1449 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
1452 /* Propagate up the bus hierarchy until someone handles it. */
1454 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
1459 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
1460 u_long start, u_long end, u_long count, u_int flags)
1462 /* Propagate up the bus hierarchy until someone handles it. */
1464 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid,
1465 start, end, count, flags));
1470 bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
1473 /* Propagate up the bus hierarchy until someone handles it. */
1475 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid,
1481 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
1484 /* Propagate up the bus hierarchy until someone handles it. */
1486 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid,
1492 bus_generic_deactivate_resource(device_t dev, device_t child, int type,
1493 int rid, struct resource *r)
1495 /* Propagate up the bus hierarchy until someone handles it. */
1497 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
1503 bus_generic_rl_get_resource (device_t dev, device_t child, int type, int rid,
1504 u_long *startp, u_long *countp)
1506 struct resource_list * rl = NULL;
1507 struct resource_list_entry * rle = NULL;
1509 rl = BUS_GET_RESOURCE_LIST(dev, child);
1513 rle = resource_list_find(rl, type, rid);
1518 *startp = rle->start;
1520 *countp = rle->count;
1526 bus_generic_rl_set_resource (device_t dev, device_t child, int type, int rid,
1527 u_long start, u_long count)
1529 struct resource_list * rl = NULL;
1531 rl = BUS_GET_RESOURCE_LIST(dev, child);
1535 resource_list_add(rl, type, rid, start, (start + count - 1), count);
1541 bus_generic_rl_delete_resource (device_t dev, device_t child, int type, int rid)
1543 struct resource_list * rl = NULL;
1545 rl = BUS_GET_RESOURCE_LIST(dev, child);
1549 resource_list_delete(rl, type, rid);
1555 bus_generic_rl_release_resource (device_t dev, device_t child, int type,
1556 int rid, struct resource *r)
1558 struct resource_list * rl = NULL;
1560 rl = BUS_GET_RESOURCE_LIST(dev, child);
1564 return (resource_list_release(rl, dev, child, type, rid, r));
1568 bus_generic_rl_alloc_resource (device_t dev, device_t child, int type,
1569 int *rid, u_long start, u_long end, u_long count, u_int flags)
1571 struct resource_list * rl = NULL;
1573 rl = BUS_GET_RESOURCE_LIST(dev, child);
1577 return (resource_list_alloc(rl, dev, child, type, rid,
1578 start, end, count, flags));
1582 * Some convenience functions to make it easier for drivers to use the
1583 * resource-management functions. All these really do is hide the
1584 * indirection through the parent's method table, making for slightly
1585 * less-wordy code. In the future, it might make sense for this code
1586 * to maintain some sort of a list of resources allocated by each device.
1589 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
1590 u_long count, u_int flags)
1592 if (dev->parent == 0)
1594 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
1599 bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
1601 if (dev->parent == 0)
1603 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
1607 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
1609 if (dev->parent == 0)
1611 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
1615 bus_release_resource(device_t dev, int type, int rid, struct resource *r)
1617 if (dev->parent == 0)
1619 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r));
1623 bus_setup_intr(device_t dev, struct resource *r, int flags,
1624 driver_intr_t handler, void *arg, void **cookiep)
1626 if (dev->parent == 0)
1628 return (BUS_SETUP_INTR(dev->parent, dev, r, flags,
1629 handler, arg, cookiep));
1633 bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
1635 if (dev->parent == 0)
1637 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
1641 bus_set_resource(device_t dev, int type, int rid,
1642 u_long start, u_long count)
1644 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
1649 bus_get_resource(device_t dev, int type, int rid,
1650 u_long *startp, u_long *countp)
1652 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
1657 bus_get_resource_start(device_t dev, int type, int rid)
1659 u_long start, count;
1662 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
1670 bus_get_resource_count(device_t dev, int type, int rid)
1672 u_long start, count;
1675 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
1683 bus_delete_resource(device_t dev, int type, int rid)
1685 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
1689 root_print_child(device_t dev, device_t child)
1693 retval += bus_print_child_header(dev, child);
1694 retval += printf("\n");
1700 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
1704 * If an interrupt mapping gets to here something bad has happened.
1706 panic("root_setup_intr");
1709 static kobj_method_t root_methods[] = {
1710 /* Device interface */
1711 KOBJMETHOD(device_shutdown, bus_generic_shutdown),
1712 KOBJMETHOD(device_suspend, bus_generic_suspend),
1713 KOBJMETHOD(device_resume, bus_generic_resume),
1716 KOBJMETHOD(bus_print_child, root_print_child),
1717 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar),
1718 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar),
1719 KOBJMETHOD(bus_setup_intr, root_setup_intr),
1724 static driver_t root_driver = {
1731 devclass_t root_devclass;
1734 root_bus_module_handler(module_t mod, int what, void* arg)
1738 TAILQ_INIT(&bus_data_devices);
1739 kobj_class_compile((kobj_class_t) &root_driver);
1740 root_bus = make_device(NULL, "root", 0);
1741 root_bus->desc = "System root bus";
1742 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver);
1743 root_bus->driver = &root_driver;
1744 root_bus->state = DS_ATTACHED;
1745 root_devclass = devclass_find_internal("root", FALSE);
1749 device_shutdown(root_bus);
1756 static moduledata_t root_bus_mod = {
1758 root_bus_module_handler,
1761 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
1764 root_bus_configure(void)
1770 TAILQ_FOREACH(dev, &root_bus->children, link) {
1771 device_probe_and_attach(dev);
1776 driver_module_handler(module_t mod, int what, void *arg)
1779 struct driver_module_data *dmd;
1780 devclass_t bus_devclass;
1782 dmd = (struct driver_module_data *)arg;
1783 bus_devclass = devclass_find_internal(dmd->dmd_busname, TRUE);
1788 if (dmd->dmd_chainevh)
1789 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
1791 for (i = 0; !error && i < dmd->dmd_ndrivers; i++) {
1792 PDEBUG(("Loading module: driver %s on bus %s",
1793 DRIVERNAME(dmd->dmd_drivers[i]), dmd->dmd_busname));
1794 error = devclass_add_driver(bus_devclass,
1795 dmd->dmd_drivers[i]);
1801 * The drivers loaded in this way are assumed to all
1802 * implement the same devclass.
1804 *dmd->dmd_devclass =
1805 devclass_find_internal(dmd->dmd_drivers[0]->name, TRUE);
1809 for (i = 0; !error && i < dmd->dmd_ndrivers; i++) {
1810 PDEBUG(("Unloading module: driver %s from bus %s",
1811 DRIVERNAME(dmd->dmd_drivers[i]),
1813 error = devclass_delete_driver(bus_devclass,
1814 dmd->dmd_drivers[i]);
1817 if (!error && dmd->dmd_chainevh)
1818 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
1827 /* the _short versions avoid iteration by not calling anything that prints
1828 * more than oneliners. I love oneliners.
1832 print_device_short(device_t dev, int indent)
1837 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
1838 dev->unit, dev->desc,
1839 (dev->parent? "":"no "),
1840 (TAILQ_EMPTY(&dev->children)? "no ":""),
1841 (dev->flags&DF_ENABLED? "enabled,":"disabled,"),
1842 (dev->flags&DF_FIXEDCLASS? "fixed,":""),
1843 (dev->flags&DF_WILDCARD? "wildcard,":""),
1844 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
1845 (dev->ivars? "":"no "),
1846 (dev->softc? "":"no "),
1851 print_device(device_t dev, int indent)
1856 print_device_short(dev, indent);
1858 indentprintf(("Parent:\n"));
1859 print_device_short(dev->parent, indent+1);
1860 indentprintf(("Driver:\n"));
1861 print_driver_short(dev->driver, indent+1);
1862 indentprintf(("Devclass:\n"));
1863 print_devclass_short(dev->devclass, indent+1);
1867 print_device_tree_short(device_t dev, int indent)
1868 /* print the device and all its children (indented) */
1875 print_device_short(dev, indent);
1877 TAILQ_FOREACH(child, &dev->children, link) {
1878 print_device_tree_short(child, indent+1);
1883 print_device_tree(device_t dev, int indent)
1884 /* print the device and all its children (indented) */
1891 print_device(dev, indent);
1893 TAILQ_FOREACH(child, &dev->children, link) {
1894 print_device_tree(child, indent+1);
1899 print_driver_short(driver_t *driver, int indent)
1904 indentprintf(("driver %s: softc size = %d\n",
1905 driver->name, driver->size));
1909 print_driver(driver_t *driver, int indent)
1914 print_driver_short(driver, indent);
1919 print_driver_list(driver_list_t drivers, int indent)
1921 driverlink_t driver;
1923 TAILQ_FOREACH(driver, &drivers, link) {
1924 print_driver(driver->driver, indent);
1929 print_devclass_short(devclass_t dc, int indent)
1934 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit));
1938 print_devclass(devclass_t dc, int indent)
1945 print_devclass_short(dc, indent);
1946 indentprintf(("Drivers:\n"));
1947 print_driver_list(dc->drivers, indent+1);
1949 indentprintf(("Devices:\n"));
1950 for (i = 0; i < dc->maxunit; i++)
1952 print_device(dc->devices[i], indent+1);
1956 print_devclass_list_short(void)
1960 printf("Short listing of devclasses, drivers & devices:\n");
1961 TAILQ_FOREACH(dc, &devclasses, link) {
1962 print_devclass_short(dc, 0);
1967 print_devclass_list(void)
1971 printf("Full listing of devclasses, drivers & devices:\n");
1972 TAILQ_FOREACH(dc, &devclasses, link) {
1973 print_devclass(dc, 0);
1980 * User-space access to the device tree.
1982 * We implement a small set of nodes:
1984 * hw.bus Single integer read method to obtain the
1985 * current generation count.
1986 * hw.bus.devices Reads the entire device tree in flat space.
1987 * hw.bus.rman Resource manager interface
1989 * We might like to add the ability to scan devclasses and/or drivers to
1990 * determine what else is currently loaded/available.
1992 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL);
1995 sysctl_bus(SYSCTL_HANDLER_ARGS)
1997 struct u_businfo ubus;
1999 ubus.ub_version = BUS_USER_VERSION;
2000 ubus.ub_generation = bus_data_generation;
2002 return (SYSCTL_OUT(req, &ubus, sizeof(ubus)));
2004 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus,
2005 "bus-related data");
2008 sysctl_devices(SYSCTL_HANDLER_ARGS)
2010 int *name = (int *)arg1;
2011 u_int namelen = arg2;
2014 struct u_device udev; /* XXX this is a bit big */
2020 if (bus_data_generation_check(name[0]))
2026 * Scan the list of devices, looking for the requested index.
2028 TAILQ_FOREACH(dev, &bus_data_devices, devlink) {
2036 * Populate the return array.
2038 udev.dv_handle = (uintptr_t)dev;
2039 udev.dv_parent = (uintptr_t)dev->parent;
2040 if (dev->nameunit == NULL) {
2041 udev.dv_name[0] = 0;
2043 snprintf(udev.dv_name, 32, "%s", dev->nameunit);
2045 if (dev->desc == NULL) {
2046 udev.dv_desc[0] = 0;
2048 snprintf(udev.dv_desc, 32, "%s", dev->desc);
2050 if ((dev->driver == NULL) || (dev->driver->name == NULL)) {
2051 udev.dv_drivername[0] = 0;
2053 snprintf(udev.dv_drivername, 32, "%s", dev->driver->name);
2055 error = SYSCTL_OUT(req, &udev, sizeof(udev));
2059 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices,
2060 "system device tree");
2063 * Sysctl interface for scanning the resource lists.
2065 * We take two input parameters; the index into the list of resource
2066 * managers, and the resource offset into the list.
2069 sysctl_rman(SYSCTL_HANDLER_ARGS)
2071 int *name = (int *)arg1;
2072 u_int namelen = arg2;
2073 int rman_idx, res_idx;
2075 struct resource *res;
2077 struct u_resource ures;
2083 if (bus_data_generation_check(name[0]))
2089 * Find the indexed resource manager
2091 TAILQ_FOREACH(rm, &rman_head, rm_link) {
2092 if (rman_idx-- == 0)
2099 * If the resource index is -1, we want details on the
2102 if (res_idx == -1) {
2103 urm.rm_handle = (uintptr_t)rm;
2104 snprintf(urm.rm_descr, RM_TEXTLEN, "%s", rm->rm_descr);
2105 urm.rm_descr[RM_TEXTLEN - 1] = '\0';
2106 urm.rm_start = rm->rm_start;
2107 urm.rm_size = rm->rm_end - rm->rm_start + 1;
2108 urm.rm_type = rm->rm_type;
2110 error = SYSCTL_OUT(req, &urm, sizeof(urm));
2115 * Find the indexed resource and return it.
2117 TAILQ_FOREACH(res, &rm->rm_list, r_link) {
2118 if (res_idx-- == 0) {
2119 ures.r_handle = (uintptr_t)res;
2120 ures.r_parent = (uintptr_t)res->r_rm;
2121 ures.r_device = (uintptr_t)res->r_dev;
2122 if (res->r_dev != NULL) {
2123 if (device_get_name(res->r_dev) != NULL) {
2124 snprintf(ures.r_devname, RM_TEXTLEN,
2126 device_get_name(res->r_dev),
2127 device_get_unit(res->r_dev));
2129 snprintf(ures.r_devname, RM_TEXTLEN,
2133 ures.r_devname[0] = 0;
2135 ures.r_start = res->r_start;
2136 ures.r_size = res->r_end - res->r_start + 1;
2137 ures.r_flags = res->r_flags;
2139 error = SYSCTL_OUT(req, &ures, sizeof(ures));
2146 SYSCTL_NODE(_hw_bus, OID_AUTO, rman, CTLFLAG_RD, sysctl_rman,
2147 "kernel resource manager");
2150 bus_data_generation_check(int generation)
2152 if (generation != bus_data_generation)
2155 /* XXX generate optimised lists here? */
2160 bus_data_generation_update(void)
2162 bus_data_generation++;